cast. framework. CastReceiverContext
Gère le chargement des bibliothèques sous-jacentes et initialise le SDK du récepteur Cast sous-jacent.
- Génère
-
non-null ErrorSi MediaElement n'est pas créé sur le corps du document. Si plusieurs éléments multimédias sont créés, le développeur doit définir la classe "castMediaElement" sur l'un d'eux, qui sera utilisé par le récepteur CAF.
Méthodes
getInstance
getInstance() renvoie cast.framework.CastReceiverContext
Renvoie l'instance singleton CastReceiverContext.
- Renvoie
-
non-null cast.framework.CastReceiverContext
addCustomMessageListener
addCustomMessageListener(namespace, listener)
Configure un écouteur de messages pour un canal de messages personnalisé. Plusieurs écouteurs sont autorisés pour un espace de noms.
Paramètre |
|
|---|---|
|
espace de noms |
chaîne L'espace de noms. Notez qu'un espace de noms valide doit être précédé de la chaîne "urn:x-cast:". |
|
écouteur |
function(non-null cast.framework.system.Message) |
- Génère
-
ErrorSi le système n'est pas prêt ou si l'espace de noms n'est pas compatible avec cette application.
addEventListener
addEventListener(type, handler)
Ajoutez un écouteur pour caster les événements système.
Paramètre |
|
|---|---|
|
type |
cast.framework.system.EventType La valeur ne doit pas être nulle. |
|
handler |
function(non-null cast.framework.system.Event) |
canDisplayType
canDisplayType(mimeType, codecs, width, height, framerate) renvoie une valeur booléenne
Vérifie si les paramètres multimédias donnés des flux vidéo ou audio sont compatibles avec la plate-forme.
Paramètre |
|
|---|---|
|
mimeType |
chaîne Type MIME du média. Il se compose d'un type et d'un sous-type séparés par une barre oblique (/). Il peut s'agir de types MIME vidéo ou audio. |
|
codecs |
Facultatif chaîne La chaîne entre guillemets contient une liste de formats séparés par une virgule, où chaque format spécifie un type d'échantillon multimédia présent dans le flux. |
|
width |
Facultatif nombre Décrit la résolution horizontale du flux en pixels. |
|
height |
Facultatif nombre Décrit la résolution verticale du flux en pixels. |
|
framerate |
Facultatif nombre Décrit la fréquence d'images du flux. |
- Renvoie
-
booleanSi le flux peut être lu sur Chromecast.
getApplicationData
getApplicationData() renvoie cast.framework.system.ApplicationData
Fournit des informations sur l'application une fois que le système est prêt. Sinon, la valeur est nulle.
- Renvoie
-
nullable cast.framework.system.ApplicationDataInformations sur l'application ou valeur nulle si le système n'est pas prêt.
getDeviceCapabilities
getDeviceCapabilities() renvoie cast.framework.system.DeviceCapabilitiesObj
Fournit des informations sur les fonctionnalités de l'appareil une fois que le système est prêt. Sinon, la valeur est nulle. Si un objet vide est renvoyé, l'appareil n'expose aucune information sur ses fonctionnalités.
- Renvoie
-
nullable cast.framework.system.DeviceCapabilitiesObjInformations sur les fonctionnalités de l'appareil (paires clé/valeur). La valeur est nulle si le système n'est pas encore prêt. Il peut s'agir d'un objet vide si la plate-forme n'expose aucune information sur les fonctionnalités de l'appareil.
getDeviceInformation
getDeviceInformation() renvoie cast.framework.system.DeviceInformationObj
Fournit des informations d'identification de l'appareil non liées aux fonctionnalités une fois que le système est prêt. Sinon, la valeur est "null". Si un objet vide est renvoyé, l'appareil n'expose aucune information de ce type.
- Renvoie
-
nullable cast.framework.system.DeviceInformationObjInformations sur l'appareil (paires clé/valeur). La valeur est nulle si le système n'est pas encore prêt. Il peut s'agir d'un objet vide si la plate-forme n'expose pas ces informations.
getPlayerManager
getPlayerManager() renvoie cast.framework.PlayerManager
Obtenez une instance Player capable de contrôler et de surveiller la lecture de contenus multimédias.
- Renvoie
-
non-null cast.framework.PlayerManager
getSender
getSender(senderId) renvoie cast.framework.system.Sender
Obtenir un expéditeur par ID d'expéditeur
Paramètre |
|
|---|---|
|
senderId |
chaîne ID de l'expéditeur à renvoyer. |
- Renvoie
-
nullable cast.framework.system.Sender
getSenders
getSenders() returns Array of non-null cast.framework.system.Sender
Récupère la liste des expéditeurs actuellement connectés.
- Renvoie
-
non-null Array of non-null cast.framework.system.Sender
getStandbyState
getStandbyState() renvoie cast.framework.system.StandbyState
Indique si l'entrée HDMI de l'application de diffusion est en veille.
- Renvoie
-
non-null cast.framework.system.StandbyStateIndique si l'entrée HDMI de l'application est en veille ou non. Si elle ne peut pas être déterminée, par exemple parce que le téléviseur n'est pas compatible avec les commandes CEC, la valeur renvoyée est UNKNOWN.
getSystemState
getSystemState() renvoie cast.framework.system.SystemState
Fournit des informations sur l'état du système à l'application.
- Renvoie
-
non-null cast.framework.system.SystemStateÉtat du système.
getVisibilityState
getVisibilityState() renvoie cast.framework.system.VisibilityState
Indique si l'application de diffusion est l'entrée HDMI active.
- Renvoie
-
non-null cast.framework.system.VisibilityStateIndique si l'application est l'entrée HDMI active. Si elle ne peut pas être déterminée, par exemple parce que le téléviseur n'est pas compatible avec les commandes CEC, la valeur renvoyée est UNKNOWN.
isSystemReady
isSystemReady() renvoie une valeur booléenne
Lorsque l'application appelle start, le système envoie l'événement ready pour indiquer que les informations sur l'application sont prêtes et que l'application peut envoyer des messages dès qu'un expéditeur est connecté.
- Renvoie
-
booleanIndique si le système est prêt à traiter les messages.
loadPlayerLibraries
loadPlayerLibraries(useLegacyDashSupport)
Démarrer le chargement du lecteur JS. Cela peut être utilisé pour commencer à charger le code JS du lecteur au début du démarrage du récepteur avant d'appeler start. Cette fonction est sans effet si les lecteurs ont déjà été chargés (start a été appelé).
Paramètre |
|
|---|---|
|
useLegacyDashSupport |
Facultatif booléen Indiquez que MPL doit être utilisé pour le contenu DASH. |
removeCustomMessageListener
removeCustomMessageListener(namespace, listener)
Supprime un écouteur de messages précédemment enregistré avec CastReceiverContext#addCustomMessageListener.
Paramètre |
|
|---|---|
|
espace de noms |
chaîne L'espace de noms. Notez qu'un espace de noms valide doit être précédé de la chaîne "urn:x-cast:". |
|
écouteur |
function(non-null cast.framework.system.Message) Fonction d'écouteur de messages à désenregistrer. |
- Génère
-
ErrorSi le système n'est pas prêt ou si l'espace de noms n'est pas compatible avec cette application.
removeEventListener
removeEventListener(type, handler)
Supprimez l'écouteur des événements système Cast.
Paramètre |
|
|---|---|
|
type |
cast.framework.system.EventType La valeur ne doit pas être nulle. |
|
handler |
function(non-null cast.framework.system.Event) |
sendCustomMessage
sendCustomMessage(namespace, senderId, data)
Envoie un message à un expéditeur spécifique.
Paramètre |
|
|---|---|
|
espace de noms |
chaîne L'espace de noms. Notez qu'un espace de noms valide doit être précédé de la chaîne "urn:x-cast:". |
|
senderId |
(chaîne ou non défini) senderId, ou non défini pour la diffusion à tous les expéditeurs. |
|
données |
tous les types Charge utile du message. La valeur ne doit pas être nulle. |
- Génère
-
Error: si une erreur s'est produite lors de la préparation du message.
sendFeedbackMessage
sendFeedbackMessage(feedbackMessage)
Cette fonction doit être appelée en réponse à l'événement feedbackstarted si l'application ajoute des informations d'état de débogage à consigner dans le rapport de commentaires. Il accepte un paramètre "message", qui est une chaîne représentant les informations de débogage que l'application souhaite consigner.
Paramètre |
|
|---|---|
|
feedbackMessage |
chaîne |
- Obsolète
- Utilisez cast.framework.CastReceiverContext#setFeedbackHandler
setApplicationState
setApplicationState(statusText)
Définit l'état de l'application. L'application doit l'appeler lorsque son état change. Si elle n'est pas définie ou si elle est définie sur une chaîne vide, la valeur du nom de l'application établie lors de l'enregistrement de l'application est utilisée par défaut pour l'état de l'application.
Paramètre |
|
|---|---|
|
statusText |
chaîne Texte de l'état. |
setFeedbackHandler
setFeedbackHandler(feedbackHandler)
Définissez un gestionnaire pour fournir des données supplémentaires à un rapport de commentaires. Le gestionnaire sera appelé lorsqu'un rapport de commentaires sera créé et devra renvoyer des données supplémentaires sous forme de chaîne ou de promesse de chaîne. La promesse de retour doit être résolue dans un délai de cinq secondes pour être incluse dans le rapport.
Paramètre |
|
|---|---|
|
feedbackHandler |
function() La valeur peut être nulle. |
setInactivityTimeout
setInactivityTimeout(maxInactivity)
Définit le délai d'inactivité du récepteur. Il est recommandé de définir la valeur d'inactivité maximale lors de l'appel de Start et de ne pas la modifier. Cette API n'est fournie qu'à des fins de développement/débogage.
Paramètre |
|
|---|---|
|
maxInactivity |
nombre Intervalle en secondes avant la fermeture d'une connexion qui ne répond pas. |
setLoggerLevel
setLoggerLevel(level)
Définit le niveau de verbosité de la journalisation.
Paramètre |
|
|---|---|
|
niveau |
Niveau de journalisation. La valeur ne doit pas être nulle. |
start
start(options) renvoie cast.framework.CastReceiverContext
Initialise le gestionnaire système et le gestionnaire multimédia afin que l'application réceptrice puisse recevoir les requêtes des expéditeurs.
Paramètre |
|
|---|---|
|
options |
(cast.framework.CastReceiverOptions non nul ou objet non nul facultatif) |
- Renvoie
-
non-null cast.framework.CastReceiverContext
stop
stop(closeReason)
Arrêtez l'application réceptrice.
Paramètre |
|
|---|---|
|
closeReason |
Facultatif cast.framework.common.CloseReason Motif de fermeture facultatif indiquant pourquoi l'application réceptrice est arrêtée. Si aucune valeur n'est fournie, le framework déduit la raison en fonction des événements récents du lecteur multimédia ou utilise la valeur APP_REQUEST par défaut. Transmettez l'une des valeurs numériques suivantes :
La valeur ne doit pas être nulle. |