Classe: CastReceiverContext

cast.framework.CastReceiverContext

class   statique

Gère le chargement des bibliothèques sous-jacentes et initialise le SDK du récepteur de cast sous-jacent.

Génère

non-null Error Si MediaElement n'est pas créé dans 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'entre eux, qui sera le récepteur CAF.

Méthodes

getInstance

statique

getInstance() returns cast.framework.CastReceiverContext

Renvoie l'instance du singleton CastReceiverContext.

Renvoie

non-null cast.framework.CastReceiverContext 

addCustomMessageListener

addCustomMessageListener(namespace, listener)

Configure un écouteur de message pour un canal de message personnalisé. Plusieurs écouteurs sont autorisés pour un espace de noms.

Paramètres
espace de noms	chaîne 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

Error : le système n'est pas prêt ou l'espace de noms n'est pas compatible avec cette application.

addEventListener

addEventListener(type, handler)

Ajout d'un écouteur pour caster des événements système.

Paramètres
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) returns boolean

Vérifie si les paramètres multimédias donnés des flux vidéo ou audio sont compatibles avec la plate-forme.

Paramètres
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 Une chaîne entre guillemets contient une liste de formats séparés par une virgule, où chaque format spécifie un type d'échantillon de média présent dans le flux.
largeur	Facultatif number Décrit la résolution horizontale du flux, en pixels.
hauteur	Facultatif number Décrit la résolution verticale du flux en pixels.
fréquence d'images	Facultatif number Décrit la fréquence d'images du flux.

Renvoie

boolean Si le flux peut être diffusé 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.ApplicationData Informations sur l'application ou valeur null si le système n'est pas prêt.

getDeviceCapabilities

getDeviceCapabilities() renvoie un objet

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 les fonctionnalités.

Renvoie

nullable Object Informations 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.

getPlayerManager

getPlayerManager() renvoie cast.framework.PlayerManager.

Permet d'obtenir une instance du lecteur qui peut contrôler et surveiller la lecture des contenus multimédias.

Renvoie

non-null cast.framework.PlayerManager 

getSender

getSender(senderId) renvoie cast.framework.system.Sender

Obtenir un expéditeur par son ID

Paramètres
senderId	chaîne Identifiant de l'expéditeur à renvoyer.

Renvoie

nullable cast.framework.system.Sender 

getSenders

getSenders() renvoie un tableau de valeurs non nulles 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 Cast est en veille.

Renvoie

non-null cast.framework.system.StandbyState Indique si l'entrée HDMI de l'application est en veille ou non. Si cela est impossible (par exemple, parce que le téléviseur n'est pas compatible avec les commandes CEC), la valeur renvoyée est UNKNOWN.

getSystemState

getSystemState() returns cast.framework.system.SystemState

Fournit des informations sur l'application sur l'état du système.

Renvoie

non-null cast.framework.system.SystemState État du système.

getVisibilityState

getVisibilityState() renvoie cast.framework.system.VisibilityState

Indique si l'application Cast est l'entrée HDMI active.

Renvoie

non-null cast.framework.system.VisibilityState Indique si l'application est l'entrée HDMI active. Si cela n'est pas possible (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 les appels de l'application démarrent, le système envoie l'événement "ready" pour indiquer que les informations de l'application sont prêtes et que l'application peut envoyer des messages dès qu'un expéditeur est connecté.

Renvoie

boolean Indique si le système est prêt à traiter les messages.

loadPlayerLibraries

loadPlayerLibraries(useLegacyDashSupport)

Lancez le chargement du lecteur js. Cela permet de lancer le chargement du code js du lecteur au début du démarrage du récepteur avant l'appel de "start". Il s'agit d'une fonction no-op si les joueurs ont déjà été chargés (l'appel start a été appelé).

Paramètres
useLegacyDashSupport	Facultatif boolean Indiquez que MPL doit être utilisé pour le contenu DASH.

removeCustomMessageListener

removeCustomMessageListener(namespace, listener)

Supprime un écouteur de message précédemment enregistré avec CastReceiverContext#addCustomMessageListener.

Paramètres
espace de noms	chaîne 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 du message dont l'enregistrement doit être annulé.

Génère

Error : le système n'est pas prêt ou l'espace de noms n'est pas compatible avec cette application.

removeEventListener

removeEventListener(type, handler)

Suppression de l'écouteur pour caster des événements système.

Paramètres
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ètres
espace de noms	chaîne 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 une 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 pour consigner dans le rapport de commentaires. Elle utilise un paramètre "message" qui est une chaîne représentant les informations de débogage que l'application souhaite consigner.

Paramètres
feedbackMessage	chaîne

Obsolète

Utiliser cast.framework.CastReceiverContext#setFeedbackHandler

setApplicationState

setApplicationState(statusText)

Définit l'état de l'application. L'application doit appeler cette méthode lorsque son état change. Si cette valeur n'est pas définie ou si elle est définie sur une chaîne vide, la valeur du nom d'application établie lors de l'enregistrement de l'application est utilisée par défaut pour l'état de l'application.

Paramètres
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 est appelé lors de la création d'un commentaire signalé. Il doit renvoyer des données supplémentaires sous forme de chaîne ou de promesse de chaîne. La promesse de retour devrait être résolue dans les cinq secondes pour qu'elle soit incluse dans le rapport.

Paramètres
feedbackHandler	fonction() 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 lorsque vous appelez Start et de ne pas la modifier. Cette API n'est fournie qu'à des fins de développement/débogage.

Paramètres
maxInactivity	number Intervalle en secondes avant la fermeture d'une connexion qui ne répond pas.

setLoggerLevel

setLoggerLevel(level)

Définit le niveau de verbosité du journal.

Paramètres
level	cast.framework.LoggerLevel 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ètres
options	(cast.framework.CastReceiverOptions non nul ou objet non nul facultatif)

Renvoie

non-null cast.framework.CastReceiverContext 

escale

stop()

Arrêt de l'application du récepteur.