Espace de noms: cast

chrome.cast

namespace   statique

Il s'agit de l'espace de noms chrome.cast.

Classes

ApiConfig

Contient la configuration de l'API une fois initialisée.

CredentialsData

Données d'identification utilisées pour identifier les identifiants de l'expéditeur.

DialRequest

Requête permettant de démarrer une application DIAL.

Error

Décrit une erreur renvoyée par l'API. Normalement, ces objets ne doivent pas être créés par le client.

Image

Image qui décrit une application ou un élément multimédia récepteur. Il peut s'agir d'une icône d'application, d'une image de couverture ou d'une miniature.

Destinataire

Décrit le récepteur exécutant une application. Normalement, ces objets ne doivent pas être créés par le client.

ReceiverDisplayStatus

État du destinataire affiché dans l'interface utilisateur de l'extension. Uniquement valide pour les destinataires PERSONNALISÉS.

SenderApplication

Décrit une application émettrice. Normalement, ces objets ne doivent pas être créés par le client.

Session

Décrit l'état d'une application Cast en cours d'exécution. Normalement, ces objets ne doivent pas être créés par le client.

SessionRequest

Requête permettant de démarrer une session ou de s'y connecter.

Délai avant expiration

Définit les valeurs de délai avant expiration par défaut en millisecondes pour les méthodes API.

Volume

Volume d'un appareil ou d'un flux multimédia.

Espace de noms

media

Énumérations

AutoJoinPolicy

statique

chaîne

La règle de jointure automatique détermine à quel moment le SDK connecte automatiquement une application émettrice à une session existante après l'initialisation de l'API.

Valeur
TAB_AND_ORIGIN_SCOPED	chaîne Se connecte automatiquement lorsque la session a démarré avec le même appId, dans le même onglet et la même origine de page.
ORIGIN_SCOPED	chaîne Se connecte automatiquement lorsque la session a démarré avec le même appId et la même origine de page (quel que soit l'onglet).
PAGE_SCOPED	chaîne Pas d'association automatique.

Capacité

statique

chaîne

Fonctionnalités compatibles avec l'appareil récepteur.

Valeur
VIDEO_OUT	chaîne Le récepteur prend en charge la sortie vidéo.
AUDIO_OUT	chaîne Le récepteur est compatible avec la sortie audio.
VIDEO_IN	chaîne Le récepteur est compatible avec l'entrée vidéo (caméra).
AUDIO_IN	chaîne Le récepteur est compatible avec l'entrée audio (micro).
MULTIZONE_GROUP	chaîne Le récepteur représente un groupe multizone.

DefaultActionPolicy

statique

chaîne

La règle d'action par défaut détermine le moment auquel le SDK crée automatiquement une session après avoir initialisé l'API. Cela permet également de contrôler l'action par défaut pour l'onglet dans le pop-up de l'extension.

Valeur
CREATE_SESSION	chaîne Si l'onglet contenant l'application est casté lors de l'initialisation de l'API, le SDK arrête la diffusion de l'onglet et lance automatiquement l'application. Le pop-up de l'extension invite l'utilisateur à caster l'application.
CAST_THIS_TAB	chaîne Aucun lancement automatique n'est effectué après l'initialisation de l'API, même si l'onglet est en cours de diffusion. Le pop-up de l'extension invite l'utilisateur à caster l'onglet.

DialAppState

statique

chaîne

États possibles d'une application DIAL.

Valeur
RUNNING	chaîne
ARRÊTÉ	chaîne
ERREUR	chaîne Ne fait pas partie des spécifications. Elle est utilisée pour signaler des erreurs.

ErrorCode

statique

chaîne

Erreurs pouvant être renvoyées par le SDK.

Valeur
ANNULER	chaîne L'opération a été annulée par l'utilisateur.
TIMEOUT	chaîne L'opération a expiré.
API_NOT_INITIALIZED	chaîne L'API n'est pas initialisée.
INVALID_PARAMETER	chaîne Les paramètres de l'opération n'étaient pas valides.
EXTENSION_NOT_COMPATIBLE	chaîne Le script de l'API n'est pas compatible avec l'extension Cast installée.
EXTENSION_MISSING	chaîne L'extension Cast n'est pas disponible.
RECEIVER_UNAVAILABLE	chaîne Aucun récepteur n'était compatible avec la requête de session.
SESSION_ERROR	chaîne Impossible de créer une session, ou une session n'est pas valide.
CHANNEL_ERROR	chaîne Aucun canal vers le récepteur n'est disponible.
LOAD_MEDIA_FAILED	chaîne Échec du chargement du média.

ReceiverAction

statique

chaîne

Actions que l'utilisateur peut effectuer sur un récepteur de l'extension. Ils permettent d'afficher une transition dans l'interface utilisateur de l'application émettrice avant la fin (ou l'échec) de l'action de diffusion.

Valeur
CAST	chaîne L'utilisateur a sélectionné un récepteur dans le but de caster du contenu vers celui-ci avec l'application émettrice. L'identité exacte du destinataire peut être inconnue.
ARRÊTEZ LÀ.	chaîne L'utilisateur a demandé l'arrêt de la session en cours d'exécution sur un récepteur.

ReceiverAvailability

statique

chaîne

Décrit la disponibilité d'un récepteur Cast.

Valeur
DISPONIBLES	chaîne Vous disposez d'au moins un récepteur compatible avec la requête de session.
NON DISPONIBLE	chaîne Aucun récepteur disponible.

ReceiverType

statique

chaîne

Valeur
CAST	chaîne Récepteur Cast (Chromecast, par exemple)
APPELER	chaîne Appeler l'appareil (smart TV, par exemple)
HANGOUT	chaîne Détente
PERSONNALISÉE	chaîne Destinataire personnalisé fourni par le client

SenderPlatform

statique

chaîne

Décrit une plate-forme d'application émettrice.

Valeur
CHROME	chaîne
IOS	chaîne
ANDROID	chaîne

SessionStatus

statique

chaîne

Décrit l'état d'une session Cast à son application réceptrice.

Valeur
CONNECTÉ	chaîne La session est connectée à l'application réceptrice.
DÉCONNECTÉ	chaîne La session est déconnectée de l'application réceptrice. Il est possible que l'application réceptrice soit toujours en cours d'exécution ou non.
ARRÊTÉ	chaîne L'application du récepteur a été arrêtée.

VolumeControlType

statique

chaîne

Décrit les types de contrôle du volume.

Valeur
ATTENUATION	chaîne Vous pouvez modifier le volume de l'appareil Cast.
CORRECTION	chaîne Le volume de l'appareil Cast est fixe et ne peut pas être modifié.
MAÎTRE	chaîne Contrôle du volume général du système, c'est-à-dire que le volume du téléviseur ou de l'appareil audio a été modifié.

Propriétés

AutoJoinPolicy

statique

chaîne

La règle de jointure automatique détermine à quel moment le SDK connecte automatiquement une application émettrice à une session existante après l'initialisation de l'API.

Valeur
TAB_AND_ORIGIN_SCOPED	chaîne Se connecte automatiquement lorsque la session a démarré avec le même appId, dans le même onglet et la même origine de page.
ORIGIN_SCOPED	chaîne Se connecte automatiquement lorsque la session a démarré avec le même appId et la même origine de page (quel que soit l'onglet).
PAGE_SCOPED	chaîne Pas d'association automatique.

Capacité

statique

chaîne

Fonctionnalités compatibles avec l'appareil récepteur.

Valeur
VIDEO_OUT	chaîne Le récepteur prend en charge la sortie vidéo.
AUDIO_OUT	chaîne Le récepteur est compatible avec la sortie audio.
VIDEO_IN	chaîne Le récepteur est compatible avec l'entrée vidéo (caméra).
AUDIO_IN	chaîne Le récepteur est compatible avec l'entrée audio (micro).
MULTIZONE_GROUP	chaîne Le récepteur représente un groupe multizone.

DefaultActionPolicy

statique

chaîne

La règle d'action par défaut détermine le moment auquel le SDK crée automatiquement une session après avoir initialisé l'API. Cela permet également de contrôler l'action par défaut pour l'onglet dans le pop-up de l'extension.

Valeur
CREATE_SESSION	chaîne Si l'onglet contenant l'application est casté lors de l'initialisation de l'API, le SDK arrête la diffusion de l'onglet et lance automatiquement l'application. Le pop-up de l'extension invite l'utilisateur à caster l'application.
CAST_THIS_TAB	chaîne Aucun lancement automatique n'est effectué après l'initialisation de l'API, même si l'onglet est en cours de diffusion. Le pop-up de l'extension invite l'utilisateur à caster l'onglet.

DialAppState

statique

chaîne

États possibles d'une application DIAL.

Valeur
RUNNING	chaîne
ARRÊTÉ	chaîne
ERREUR	chaîne Ne fait pas partie des spécifications. Elle est utilisée pour signaler des erreurs.

ErrorCode

statique

chaîne

Erreurs pouvant être renvoyées par le SDK.

Valeur
ANNULER	chaîne L'opération a été annulée par l'utilisateur.
TIMEOUT	chaîne L'opération a expiré.
API_NOT_INITIALIZED	chaîne L'API n'est pas initialisée.
INVALID_PARAMETER	chaîne Les paramètres de l'opération n'étaient pas valides.
EXTENSION_NOT_COMPATIBLE	chaîne Le script de l'API n'est pas compatible avec l'extension Cast installée.
EXTENSION_MISSING	chaîne L'extension Cast n'est pas disponible.
RECEIVER_UNAVAILABLE	chaîne Aucun récepteur n'était compatible avec la requête de session.
SESSION_ERROR	chaîne Impossible de créer une session, ou une session n'est pas valide.
CHANNEL_ERROR	chaîne Aucun canal vers le récepteur n'est disponible.
LOAD_MEDIA_FAILED	chaîne Échec du chargement du média.

isAvailable

statique

boolean

Indicateur permettant aux clients de vérifier si l'API est chargée.

ReceiverAction

statique

chaîne

Actions que l'utilisateur peut effectuer sur un récepteur de l'extension. Ils permettent d'afficher une transition dans l'interface utilisateur de l'application émettrice avant la fin (ou l'échec) de l'action de diffusion.

Valeur
CAST	chaîne L'utilisateur a sélectionné un récepteur dans le but de caster du contenu vers celui-ci avec l'application émettrice. L'identité exacte du destinataire peut être inconnue.
ARRÊTEZ LÀ.	chaîne L'utilisateur a demandé l'arrêt de la session en cours d'exécution sur un récepteur.

ReceiverAvailability

statique

chaîne

Décrit la disponibilité d'un récepteur Cast.

Valeur
DISPONIBLES	chaîne Vous disposez d'au moins un récepteur compatible avec la requête de session.
NON DISPONIBLE	chaîne Aucun récepteur disponible.

ReceiverType

statique

chaîne

Valeur
CAST	chaîne Récepteur Cast (Chromecast, par exemple)
APPELER	chaîne Appeler l'appareil (smart TV, par exemple)
HANGOUT	chaîne Détente
PERSONNALISÉE	chaîne Destinataire personnalisé fourni par le client

SenderPlatform

statique

chaîne

Décrit une plate-forme d'application émettrice.

Valeur
CHROME	chaîne
IOS	chaîne
ANDROID	chaîne

SessionStatus

statique

chaîne

Décrit l'état d'une session Cast à son application réceptrice.

Valeur
CONNECTÉ	chaîne La session est connectée à l'application réceptrice.
DÉCONNECTÉ	chaîne La session est déconnectée de l'application réceptrice. Il est possible que l'application réceptrice soit toujours en cours d'exécution ou non.
ARRÊTÉ	chaîne L'application du récepteur a été arrêtée.

pause

statique

Valeur non nulle chrome.cast.Timeout

Valeurs de délai avant expiration par défaut en millisecondes pour les méthodes API.

VERSION

constante   statique

Tableau de nombres non nuls

Version de l'API. Le premier numéro correspond à la version majeure et le second à la version mineure.

VolumeControlType

statique

chaîne

Décrit les types de contrôle du volume.

Valeur
ATTENUATION	chaîne Vous pouvez modifier le volume de l'appareil Cast.
CORRECTION	chaîne Le volume de l'appareil Cast est fixe et ne peut pas être modifié.
MAÎTRE	chaîne Contrôle du volume général du système, c'est-à-dire que le volume du téléviseur ou de l'appareil audio a été modifié.

Méthodes

addReceiverActionListener

statique

addReceiverActionListener(listener)

Ajoute une fonction d'écouteur qui sera appelée lorsque l'utilisateur a interagi via l'interface utilisateur pour démarrer ou arrêter la diffusion. L'application émettrice peut s'en servir pour afficher une transition dans son interface utilisateur (par exemple, mettre en pause la lecture locale du contenu multimédia) avant que l'action de diffusion ne se termine ou échoue.

• Il n'est pas garanti que l'écouteur soit appelé, et les applications ne doivent pas s'appuyer dessus pour fonctionner correctement.
• L'écouteur reçoit le récepteur ayant fait l'objet d'une action, le cas échéant. Toutefois, le destinataire peut ne pas être connu, et la valeur "null" est transmise à la place.
• L'écouteur est appelé dès que possible après une action de l'utilisateur. Elle doit être appelée avant que l'application ne soit informée du changement d'état qui en résulte via l'API.

Si vous utilisez l'API Framework, utilisez plutôt cast.framework.CastContext#addEventListener et écoutez les événements cast.framework.CastContextEventType#CAST_STATE_CHANGED.

Paramètres
écouteur	chrome.cast.ReceiverActionListener Fonction d'écouteur à ajouter. Le premier argument de l'écouteur est le récepteur sur lequel l'action a été effectuée. Le deuxième argument de l'écouteur correspond à l'action demandée (voir chrome.cast.ReceiverAction). La valeur ne doit pas être nulle.

initialize

statique

initialis(apiConfig, successCallback, errorCallback)

Initialise l'API. Notez que successCallback et errorCallback seront appelés une fois l'initialisation de l'API terminée. Les écouteurs sessionListener et receiverListener peuvent être appelés à tout moment par la suite, et éventuellement plusieurs fois.

Si vous utilisez l'API Framework, utilisez cast.framework.CastContext#setOptions au lieu de cette fonction.

Paramètres
apiConfig	chrome.cast.ApiConfig Objet avec les paramètres permettant d'initialiser l'API. La valeur ne doit pas être nulle.
successCallback	fonction()
errorCallback	function(non-null chrome.cast.Error) Les erreurs possibles sont TIMEOUT, INVALID_PARAMETER et EXTENSION_MISSING.

logMessage

statique

logMessage(message)

Consigne un message de débogage de l'application. Ce message peut être envoyé sous forme de rapport de commentaires à Google si les utilisateurs choisissent explicitement d'inclure des journaux détaillés.

Paramètres
message	chaîne Message à consigner.

Obsolète

Non compatible avec le SDK Cast basé sur l'API Presentation.

effectuer une mise en cache préalable

statique

pré-cache(données)

Envoyez une requête de mise en cache préalable des données. Si une session est connectée, elle envoie une requête directe, sinon elle est envoyée à tous les appareils du réseau.

Paramètres
données	chaîne Données à mettre en cache en amont.

Obsolète

Non compatible.

removeReceiverActionListener

statique

removeReceiverActionListener(listener)

Supprime une fonction d'écouteur précédemment ajoutée avec addReceiverActionListener.

Paramètres
écouteur	chrome.cast.ReceiverActionListener Fonction d'écouteur à supprimer. La valeur ne doit pas être nulle.

requestSession

statique

requestSession(successCallback, errorCallback, sessionRequest)

Demande la création ou la jonction d'une session d'application réceptrice. Par défaut, la requête SessionRequest transmise à l'API au moment de l'initialisation est utilisée. Vous pouvez la remplacer en transmettant une requête de session différente dans sessionRequest.

Si vous utilisez l'API Framework, utilisez cast.framework.CastContext#requestSession au lieu de cette fonction.

Paramètres
successCallback	function(non-null chrome.cast.Session)
errorCallback	function(non-null chrome.cast.Error) Les erreurs possibles sont TIMEOUT, INVALID_PARAMETER, API_NOT_INITIALIZED, CANCEL, CHANNEL_ERROR, SESSION_ERROR, RECEIVER_UNAVAILABLE et EXTENSION_MISSING. Notez que le délai avant expiration démarre une fois que les utilisateurs ont sélectionné un destinataire. La sélection d'un destinataire nécessite une action de l'utilisateur, qui est sans délai d'inactivité. Si une requête de session est déjà en cours, errorCallback est invoqué avec le code d'erreur INVALID_PARAMETER et une description expliquant l'erreur.
sessionRequest	Facultatif chrome.cast.SessionRequest La valeur ne doit pas être nulle.

requestSessionById

statique

requestSessionById(sessionId)

Demandes de participation à une session existante avec l'ID donné. Une fois la session rejointe, la session est transmise à l'écouteur de session défini par chrome.cast.initial.

Si la session avec le sessionId donnée est déjà connue lorsque cette fonction est appelée, sessionListener est appelé immédiatement. Sinon, dès qu'une session associée à l'identifiant de session donné est découverte, sessionListener est appelé.

Paramètres
sessionId	chaîne Identifiant de la session à laquelle participer.

setCustomReceivers

statique

setCustomReceivers(receivers, successCallback, errorCallback)

Définit une liste de destinataires personnalisée

Paramètres
destinataires	Tableau de chrome.cast.Receiver non nul Nouvelle liste. La valeur ne doit pas être nulle.
successCallback	fonction()
errorCallback	function(non-null chrome.cast.Error) Les erreurs possibles sont TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR et EXTENSION_MISSRING.

Obsolète

Non compatible avec le SDK Cast basé sur l'API Presentation.

setPageContext

statique

setPageContext(win)

Initialise la fonctionnalité Cast pour une page qui charge le SDK Cast dans un iFrame. Doit être appelé après l'initialisation du SDK.

Paramètres
victoire	Fenêtre Objet fenêtre de page. La valeur ne doit pas être nulle.

setReceiverDisplayStatus

statique

setReceiverDisplayStatus(receiver, successCallback, errorCallback)

Définit le nom du destinataire et l'état d'affichage. Pour afficher le récepteur comme inactif, définissez displayStatus sur "null".

Uniquement valide pour les destinataires PERSONNALISÉS. L'état displayStatus du récepteur est ignoré si ce récepteur est CAST. L'état du récepteur Cast est mis à jour par l'application du récepteur.

Paramètres
destinataire	chrome.cast.Receiver Destinataire. La valeur ne doit pas être nulle.
successCallback	fonction() Rappel lors de la définition de l'état avec succès.
errorCallback	function(non-null chrome.cast.Error) Les erreurs possibles sont TIMEOUT, INVALID_PARAMETER, API_NOT_INITIALIZED et EXTENSION_MISSING.

Obsolète

Non compatible avec le SDK Cast basé sur l'API Presentation.

unescape

statique

unescape(échappement) renvoie une chaîne.

Méthode utilitaire permettant de déséchapper les chaînes avec échappement pour l'URI. Par exemple, le nom convivial du récepteur est renvoyé sous la forme d'une chaîne avec échappement dans l'URI. Utilisez cette méthode pour supprimer l'échappement de cette chaîne si nécessaire.

Paramètres
échappé	chaîne Chaîne à décoder

Renvoie

string Chaîne sans échappement

Type abstrait

ReceiverActionListener

statique

ReceiverActionListener()