Classe: CastReceiverContext

cast.framework.CastReceiverContext

class static.

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, que le récepteur CAF utilisera.

Méthodes

getInstance

statique

La méthode getInstance() renvoie cast.framework.CastReceiverContext.

Renvoie l'instance du singleton CastReceiverContext.

Retours

non-null cast.framework.CastReceiverContext 

addCustomMessageListener

addCustomMessageListener(espacede noms, écouteur)

Définit l'écouteur de messages sur le canal de message personnalisé.

Paramètre
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 nulle cast.framework.system.Event)

Génère

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

addEventListener

addEventListener(type, gestionnaire)

Ajoutez un écouteur pour les événements système Cast.

Paramètre
type	cast.framework.system.EventType La valeur ne doit pas être nulle.
handler	function(non nulle cast.framework.system.Event)

canDisplayType (type d'affichage du canal)

canDisplayType(mimeType, codecs, width, height, framerate) renvoie une valeur booléenne

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

Paramètre
Type MIME	chaîne Type MIME 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	Facultative 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.
largeur	Facultative number (nombre) Décrit la résolution horizontale du flux en pixels.
hauteur	Facultative number (nombre) Décrit la résolution verticale du flux en pixels.
fréquence d'images	Facultative number (nombre) Décrit la fréquence d'images du flux.

Retours

boolean Si le flux peut être lu sur Chromecast.

getApplicationData

La fonction 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.

Retours

nullable cast.framework.system.ApplicationData Les informations sur l'application ou la valeur "null" si le système n'est pas prêt.

getDeviceCapabilities

getDeviceCapabilities() renvoie l'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.

Retours

nullable Object Informations sur les fonctionnalités de l'appareil (paires clé/valeur). Elle sera 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

La fonction getPlayerManager() renvoie cast.framework.PlayerManager

Obtenir une instance de lecteur capable de contrôler et de surveiller la lecture de contenus multimédias

Retours

non-null cast.framework.PlayerManager 

getSender

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

Obtenir un expéditeur par ID d'expéditeur

Paramètre
id_expéditeur	chaîne Identifiant de l'expéditeur à renvoyer.

Retours

nullable cast.framework.system.Sender 

getSenders

getSenders() renvoie un tableau de valeurs cast.framework.system.Sender non nulles.

Récupère la liste des expéditeurs actuellement connectés.

Retours

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.

Retours

non-null cast.framework.system.StandbyState Indique si l'entrée HDMI de l'application est en veille ou non. Si cela n'est pas possible, car le téléviseur n'accepte pas les commandes CEC. Par exemple, la valeur renvoyée est UNKNOWN.

getSystemState

getSystemState() renvoie cast.framework.system.SystemState

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

Retours

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

getVisibilityState

getVisibilityState() renvoie cast.framework.system.VisibilityState

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

Retours

non-null cast.framework.system.VisibilityState Indique si l'application est l'entrée active HDMI. Si cela n'est pas possible, car le téléviseur n'accepte pas les commandes CEC. Par exemple, la valeur renvoyée est UNKNOWN.

Prêt

isSystemReady() renvoie des valeurs booléennes

Lorsque l'appel de l'application démarre, le système envoie l'événement "ready" pour indiquer que les informations sur l'application sont prêtes. L'application peut envoyer des messages dès qu'un expéditeur est connecté.

Retours

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

loadPlayerLibraries

loadPlayerLibraries(useLegacyDashSupport)

Commencez à charger le lecteur js. Cela permet de lancer le chargement du code js des joueurs au début du démarrage du récepteur avant d'appeler. Cette fonction est une opération no-op si les joueurs ont déjà été chargés (appel lancé).

Paramètre
utiliserLegacyDashSupport	Facultative booléen Indique que la MPL doit être utilisée pour le contenu DASH.

removeCustomMessageListener

removeCustomMessageListener(espacede noms, écouteur)

Supprimer un écouteur de message sur un canal de message personnalisé

Paramètre
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(cast.framework.system.Event)

Génère

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

removeEventListener

removeEventListener(type, gestionnaire)

Supprimez l'é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 nulle cast.framework.system.Event)

envoyer un message personnalisé

sendCustomMessage(namespace, SenderId, message)

Envoie un message à un expéditeur spécifique.

Paramètre
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:".
id_expéditeur	(chaîne ou non définie) Identifiant "SenderId" ou non défini pour la diffusion à tous les expéditeurs.
message	tous les types 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.

envoyer un commentaire

sendFeedbackMessage(feedbackMessage)

Cette fonction doit être appelée en réponse à l'événement "feedbackstarted" si l'application ajoute des informations sur l'état de débogage pour se connecter au rapport de commentaires. Elle intègre un paramètre "message" qui est une chaîne qui représente les informations de débogage que l'application souhaite consigner.

Paramètre
feedbackMessage	chaîne

Obsolète

Utiliser 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 est utilisée par défaut pour l'état de l'application.

Paramètre
étatTexte	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é lorsqu'un commentaire rapporté est créé et doit 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 qu'elle soit incluse dans le rapport.

Paramètre
gestionnaire de commentaires	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 lorsque vous appelez "Démarrer" sans la modifier. Cette API est uniquement fournie à des fins de développement/débogage.

Paramètre
max.inactivité	number (nombre) Intervalle en secondes avant de fermer une connexion qui ne répond pas.

setLoggerLevel

setLoggerLevel(level)

Définit le niveau de verbosité du journal.

Paramètre
level	cast.framework.LoggerLevel Niveau de journalisation La valeur ne doit pas être nulle.

début

start(options) renvoie cast.framework.CastReceiverContext.

Initialise le responsable système et le gestionnaire multimédia afin que l'application réceptrice puisse recevoir les requêtes des expéditeurs.

Paramètre
options	(valeur non nulle cast.framework.CastReceiverOptions ou objet facultatif non nul)

Retours

non-null cast.framework.CastReceiverContext 

stop

stop()

Arrêter l'application réceptrice