Espace de noms: cast

chrome.caster

namespace static

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

Classes

Namespace

Énumérations

Stratégie de jointure automatique

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.

Value

TAB_AND_ORIGIN_SCOPED

chaîne

Se connecte automatiquement au démarrage de la session avec le même ID d'application dans le même onglet et la même origine de page.

ORIGIN_SCOPE

chaîne

Se connecte automatiquement au démarrage de la session avec le même ID d'application et la même origine de page (quel que soit l'onglet).

PAGE_SCOPED

chaîne

Aucune connexion automatique.

Capacité

statique

chaîne

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

Value

VIDÉO_SORTIE

chaîne

Le récepteur est compatible avec la sortie vidéo.

AUDIO_OUT

chaîne

Le récepteur est compatible avec la sortie audio.

VIDÉO

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).

GROUPE MULTIZONE

chaîne

Le récepteur représente un groupe multizone.

Stratégie par défaut d'actions

statique

chaîne

Une règle d'action par défaut détermine le moment où le SDK crée automatiquement une session après l'initialisation de l'API. Cette action contrôle également l'action par défaut appliquée à l'onglet dans la fenêtre pop-up de l'extension.

Value

CRÉER_UNE SESSION

chaîne

Si l'onglet contenant l'application est casté lors de l'initialisation de l'API, le SDK arrête la diffusion et lance automatiquement l'application. La fenêtre 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. La fenêtre pop-up de l'extension invite l'utilisateur à caster l'onglet.

DialAppState

statique

chaîne

États possibles d'une application DIAL.

Value

RUNNING

chaîne

ARRÊTÉ

chaîne

ERREUR

chaîne

Ne fait pas partie des spécifications, utilisées pour signaler les erreurs.

ErrorCode

statique

chaîne

Erreurs pouvant être renvoyées par le SDK.

Value

ANNULER

chaîne

L'opération a été annulée par l'utilisateur.

TIMEOUT

chaîne

L'opération a expiré.

API_NOT_INITIALIZED (API_NON_INITIALISÉE)

chaîne

L'API n'est pas initialisée.

PARAMÈTRE INCORRECT

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'est compatible avec la requête de session.

ERREUR_SESSION

chaîne

Impossible de créer une session ou une session n'est pas valide.

CHANNEL_ERROR

chaîne

Un canal vers le récepteur n'est pas disponible.

LOAD_MEDIA_FAILED

chaîne

Échec du chargement du média.

RécepteurAction

statique

chaîne

Actions que l'utilisateur peut effectuer sur un récepteur dans l'extension. Celles-ci permettent d'afficher une transition dans l'interface utilisateur de l'application de l'expéditeur avant la fin (ou l'échec) de la diffusion.

Value

CASTER

chaîne

L'utilisateur a sélectionné un récepteur dans l'intention de le caster avec l'application expéditeur. L'identité exacte du destinataire peut être inconnue.

STOP

chaîne

L'utilisateur a demandé l'arrêt de la session en cours d'exécution sur un récepteur.

Disponibilité du récepteur

statique

chaîne

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

Value

DISPONIBLE

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.

Type de récepteur

statique

chaîne

Value

CASTER

chaîne

Récepteur Cast, par exemple Chromecast

APPEL

chaîne

Appareil DIAL, par exemple smart TV

HANGOUT

chaîne

Détente

PERSONNALISÉE

chaîne

Récepteur personnalisé fourni par le client

Plate-forme d'envoi

statique

chaîne

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

Value

CHROME

chaîne

IOS

chaîne

ANDROID

chaîne

État de la session

statique

chaîne

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

Value

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.

ARRÊTÉ

chaîne

L'application réceptrice a été arrêtée.

Type de contrôle du volume

statique

chaîne

Décrit les types de commandes de volume.

Value

ATTENUATION

chaîne

Le volume de l'appareil Cast peut être modifié.

CORRIGÉ

chaîne

Le volume de l'appareil Cast est fixe et ne peut pas être modifié.

MAÎTRE

chaîne

Le contrôle du volume du système principal (c'est-à-dire le volume du téléviseur ou de l'appareil audio) a été modifié.

Propriétés

Stratégie de jointure automatique

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.

Value

TAB_AND_ORIGIN_SCOPED

chaîne

Se connecte automatiquement au démarrage de la session avec le même ID d'application dans le même onglet et la même origine de page.

ORIGIN_SCOPE

chaîne

Se connecte automatiquement au démarrage de la session avec le même ID d'application et la même origine de page (quel que soit l'onglet).

PAGE_SCOPED

chaîne

Aucune connexion automatique.

Capacité

statique

chaîne

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

Value

VIDÉO_SORTIE

chaîne

Le récepteur est compatible avec la sortie vidéo.

AUDIO_OUT

chaîne

Le récepteur est compatible avec la sortie audio.

VIDÉO

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).

GROUPE MULTIZONE

chaîne

Le récepteur représente un groupe multizone.

Stratégie par défaut d'actions

statique

chaîne

Une règle d'action par défaut détermine le moment où le SDK crée automatiquement une session après l'initialisation de l'API. Cette action contrôle également l'action par défaut appliquée à l'onglet dans la fenêtre pop-up de l'extension.

Value

CRÉER_UNE SESSION

chaîne

Si l'onglet contenant l'application est casté lors de l'initialisation de l'API, le SDK arrête la diffusion et lance automatiquement l'application. La fenêtre 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. La fenêtre pop-up de l'extension invite l'utilisateur à caster l'onglet.

DialAppState

statique

chaîne

États possibles d'une application DIAL.

Value

RUNNING

chaîne

ARRÊTÉ

chaîne

ERREUR

chaîne

Ne fait pas partie des spécifications, utilisées pour signaler les erreurs.

ErrorCode

statique

chaîne

Erreurs pouvant être renvoyées par le SDK.

Value

ANNULER

chaîne

L'opération a été annulée par l'utilisateur.

TIMEOUT

chaîne

L'opération a expiré.

API_NOT_INITIALIZED (API_NON_INITIALISÉE)

chaîne

L'API n'est pas initialisée.

PARAMÈTRE INCORRECT

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'est compatible avec la requête de session.

ERREUR_SESSION

chaîne

Impossible de créer une session ou une session n'est pas valide.

CHANNEL_ERROR

chaîne

Un canal vers le récepteur n'est pas disponible.

LOAD_MEDIA_FAILED

chaîne

Échec du chargement du média.

est disponible

statique

booléen

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

RécepteurAction

statique

chaîne

Actions que l'utilisateur peut effectuer sur un récepteur dans l'extension. Celles-ci permettent d'afficher une transition dans l'interface utilisateur de l'application de l'expéditeur avant la fin (ou l'échec) de la diffusion.

Value

CASTER

chaîne

L'utilisateur a sélectionné un récepteur dans l'intention de le caster avec l'application expéditeur. L'identité exacte du destinataire peut être inconnue.

STOP

chaîne

L'utilisateur a demandé l'arrêt de la session en cours d'exécution sur un récepteur.

Disponibilité du récepteur

statique

chaîne

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

Value

DISPONIBLE

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.

Type de récepteur

statique

chaîne

Value

CASTER

chaîne

Récepteur Cast, par exemple Chromecast

APPEL

chaîne

Appareil DIAL, par exemple smart TV

HANGOUT

chaîne

Détente

PERSONNALISÉE

chaîne

Récepteur personnalisé fourni par le client

Plate-forme d'envoi

statique

chaîne

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

Value

CHROME

chaîne

IOS

chaîne

ANDROID

chaîne

État de la session

statique

chaîne

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

Value

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.

ARRÊTÉ

chaîne

L'application réceptrice a été arrêtée.

timeout

statique

Valeur chrome.cast.Timeout non nulle

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

VERSION

constante statique

Tableau de nombres non nul

Version de l'API. Le premier est la version majeure, et le second la version mineure.

Type de contrôle du volume

statique

chaîne

Décrit les types de commandes de volume.

Value

ATTENUATION

chaîne

Le volume de l'appareil Cast peut être modifié.

CORRIGÉ

chaîne

Le volume de l'appareil Cast est fixe et ne peut pas être modifié.

MAÎTRE

chaîne

Le contrôle du volume du système principal (c'est-à-dire le volume du téléviseur ou de l'appareil audio) a été modifié.

Méthodes

addReceiverActionListener

statique

addReceiverActionListener(listen)

Ajoute une fonction d'écouteur qui est appelée lorsque l'utilisateur est passé à l'interface utilisateur pour démarrer ou arrêter la diffusion. L'application émettrice peut utiliser cette option pour afficher une transition dans son interface utilisateur (c'est-à-dire mettre en pause la lecture de contenus multimédias en local) avant la fin ou l'échec de l'action de diffusion.

  • Il n'est pas garanti que l'écouteur soit appelé et les applications ne doivent pas s'en servir pour fonctionner correctement.
  • Le paramètre "Listener" sera transmis au destinataire qui a été utilisé, le cas échéant. Cependant, le destinataire peut ne pas être connu et la valeur null sera transmise à la place.
  • L'écouteur est appelé dès que possible après que l'utilisateur a agi. Il doit être appelé avant que l'application ne soit informée du changement d'état résultant 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ètre

écouteur

chrome.cast.ReceiverActionListener

Fonction d'écouteur à ajouter. Le premier argument de l'écouteur est le destinataire sur lequel une action a été effectuée. Le deuxième argument de l'écouteur est l'action demandée (voir chrome.cast.ReceiverAction).

La valeur ne doit pas être nulle.

initialize

statique

initialize(apiConfig, successCallback, errorCallback)

Initialise l'API. Notez que la méthode successCallback et errorCallback sont invoquées une fois l'initialisation de l'API terminée. L'écouteur sessionListener et le récepteurListener peuvent être appelés à tout moment par la suite, voire plusieurs fois.

Si vous utilisez l'API Framework, utilisez cast.framework.CastContext#setOptions à la place de cette fonction.

Paramètre

Configuration de l'API

chrome.cast.ApiConfig

Objet avec paramètres pour initialiser l'API.

La valeur ne doit pas être nulle.

successCallback

function()

Erreur de rappel

function(null) chrome.cast.Error

Les erreurs possibles sont TIMEOUT, INVALID_PARAMETER et EXTENSION_MISSING.

logMessage

statique

logMessage(message)

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

Paramètre

message

chaîne

Message à consigner.
Obsolète
Non compatible avec le SDK Cast basé sur l'API Presentation.

pré-cache

statique

precache(données)

Envoyez une requête pour prémettre en cache des données. Si une session est connectée, une requête directe est envoyée. Sinon, elle est envoyée à tous les appareils du réseau.

Paramètre

données

chaîne

Données à prémettre en cache.

removeReceiverActionListener

statique

removeReceiverActionListener(listen)

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

Paramètre

écouteur

chrome.cast.ReceiverActionListener

Fonction d'écouteur à supprimer.

La valeur ne doit pas être nulle.

sessionSession

statique

requestSession(successCallback, errorCallback, sessionRequest) :

Requête de création ou de jointure d'une session d'application réceptrice Par défaut, la session SessionRequest transmise à l'API au moment de l'initialisation est utilisée. Elle peut être remplacée en transmettant une autre requête de session dans sessionRequest.

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

Paramètre

successCallback

function(null) chrome.cast.Session

Erreur de rappel

function(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 la part de l'utilisateur, sans délai avant expiration. Si une requête de session est déjà en cours, la fonction errorCallback est appelée avec le code d'erreur INVALID_PARAMETER et une description de l'erreur.

sessionRequest

Facultative

chrome.cast.SessionRequest.

La valeur ne doit pas être nulle.

requestSessionById

statique

requestSessionById(sessionId)

Requêtes pour participer à une session existante avec l'ID donné. Une fois associée, la session est transmise à l'objet sessionListener défini par chrome.cast.initialize.

Si la session avec l'identifiant sessionId donné est déjà connue lorsque cette fonction est appelée, "sessionListener" est appelé immédiatement. Sinon, lorsqu'une session avec l'identifiant sessionId spécifié est découverte, sessionListener est appelé.

Paramètre

sessionId

chaîne

Identifiant de la session à rejoindre.

setCustomReceivers

statique

setCustomReceivers(receivers, successCallback, errorCallback)

Définit une liste de récepteurs personnalisée

Paramètre

récepteurs

Tableau de valeurs chrome.cast.Receiver non nulles

Nouvelle liste.

La valeur ne doit pas être nulle.

successCallback

function()

Erreur de rappel

function(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ètre

victoire

Window

Objet de fenêtre de page.

La valeur ne doit pas être nulle.

setReceiverDisplayStatus

statique

setReceiverDisplayStatus(receiver, successCallback, errorCallback)

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

Valable uniquement pour les destinataires CUSTOM. L'état d'affichage du récepteur est ignoré s'il s'agit d'un récepteur CAST. L'état du récepteur Cast est mis à jour par l'application réceptrice.

Paramètre

destinataire

chrome.cast.Receiver

Le destinataire.

La valeur ne doit pas être nulle.

successCallback

function()

Rappel lorsque la définition de l'état réussit.

Erreur de rappel

function(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.

échapper

statique

unescape(escaped) renvoie la chaîne

Méthode utilitaire permettant de retirer les chaînes avec échappement de l'URI. Par exemple, le nom descriptif du destinataire est renvoyé sous la forme d'une chaîne avec échappement. Utilisez cette méthode pour annuler l'échappement de cette chaîne si nécessaire.

Paramètre

échappé

chaîne

Chaîne à annuler l'échappement
Retours

string Chaîne sans échappement

Type d'extrait

Récepteur d'actions de récepteur

statique

ReceiverActionListener()