Classe: CastReceiverContext

cast.framework.CastReceiverContext

class   static

Gère le chargement des bibliothèques sous-jacentes et initialise le SDK Cast Receiver 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'eux, que le récepteur CAF utilisera.

Méthodes

getInstance

static

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

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 Si le système n'est pas prêt ou si l'espace de noms n'est pas pris en charge par cette application.

addEventListener

addEventListener(type, handler)

Ajoutez un écouteur aux é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)

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 acceptés par la plate-forme.

Paramètre

mimeType

chaîne

Type MIME du contenu multimédia. Il se compose d'un type et d'un sous-type séparés par un "/". 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 des virgules, où chaque format spécifie un type d'échantillon multimédia présent dans le flux.

largeur

Facultatif

Total

Décrit la résolution horizontale du flux en pixels.

hauteur

Facultatif

Total

Décrit la résolution verticale du flux en pixels.

framerate

Facultatif

Total

Décrit la fréquence d'images du flux.
Renvoie

boolean Si le flux peut être lu sur Chromecast.

getApplicationData

getApplicationData() renvoie cast.framework.system.ApplicationData

Fournit des informations sur l'application une fois le système prêt, sinon la valeur est nulle.

Renvoie

nullable cast.framework.system.ApplicationData Informations sur l'application ou valeur nulle si le système n'est pas prêt.

getDeviceCapabilities

getDeviceCapabilities() renvoie cast.receiver.CastReceiverManager.DeviceCapabilitiesObj

Fournit des informations sur les capacité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 cast.receiver.CastReceiverManager.DeviceCapabilitiesObj Informations sur les fonctionnalités de l'appareil (paires clé/valeur). La valeur 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.

getDeviceInformation

getDeviceInformation() renvoie cast.receiver.CastReceiverManager.DeviceInformationObj

Fournit des informations d'identification de l'appareil non liées aux fonctionnalités une fois le système prêt, sinon la valeur est "null". Si un objet vide est renvoyé, cela signifie que l'appareil n'expose aucune information de ce type.

Renvoie

nullable cast.receiver.CastReceiverManager.DeviceInformationObj Informations sur l'appareil (paires clé/valeur). La valeur 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 pas ces informations.

getPlayerManager

getPlayerManager() renvoie cast.framework.PlayerManager

Obtenez une instance Player qui peut contrôler et 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 à retourner.
Renvoie

nullable cast.framework.system.Sender 

getSenders

getSenders() returns Array of non-null cast.framework.system.Sender

Obtient la liste des expéditeurs actuellement associé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 elle ne peut pas être déterminée, car le téléviseur ne prend pas en charge 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.

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 elle ne peut pas être déterminée, car le téléviseur ne prend pas en charge les commandes CEC,par exemple, la valeur renvoyée est UNKNOWN.

isSystemReady

isSystemReady() renvoie une valeur booléenne.

Lorsque les appels d'application démarrent, le système envoie l'événement prêt 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)

Commencez à charger le fichier JS du lecteur. Cela peut être utilisé pour commencer à charger le code JS des lecteurs au début du démarrage du récepteur avant d'appeler "start". Cette fonction est une opération sans effet si les lecteurs ont déjà été chargés (le démarrage 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 message précédemment enregistré avec CastReceiverContext#addCustomMessageListener.

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-null cast.framework.system.Message)

Fonction d'écouteur de message à annuler.
Génère

Error Si le système n'est pas prêt ou si l'espace de noms n'est pas pris en charge par cette application.

removeEventListener

removeEventListener(type, handler)

Supprime l'écouteur des événements système de diffusion.

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

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 indéfini)

senderId ou undefined 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 sur l'état de débogage au journal du 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 appeler cette méthode 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 signalement de commentaire 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 les 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

Total

Intervalle en secondes avant la fermeture d'une connexion ne répondant 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.

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 émetteurs.

Paramètre

options

(cast.framework.CastReceiverOptions non nul ou objet non nul facultatif)
Renvoie

non-null cast.framework.CastReceiverContext 

stop

stop()

Arrête l'application réceptrice.