Cours: Session

Constructeur

Session

new Session(sessionId, appId, displayName, appImages, receiver)

Paramètres

sessionId

chaîne

Identifiant de session.

appId

chaîne

Identifiant de l'application du récepteur.

displayName

chaîne

Nom à afficher de l'application.

appImages

Tableau de chrome.cast.Image non nuls

Images associées à l'application.

La valeur ne doit pas être nulle.

destinataire

chrome.cast.Receiver

Récepteur qui exécute l'application.

La valeur ne doit pas être nulle.

Propriétés

appId

chaîne

Identifiant de l'application Cast. Elle ne sera pas affichée.

appImages

Tableau non nul de chrome.cast.Image non nuls

Tableau d'images disponibles décrivant l'application.

displayName

chaîne

Nom lisible de l'application Cast, par exemple "YouTube".

media

Tableau non nul de chrome.cast.media.Media non nuls

Contenus multimédias appartenant à cette session Cast, y compris ceux chargés par d'autres expéditeurs.

namespaces

Tableau non nul de {name: string}

Liste des espaces de noms acceptés par l'application réceptrice.

destinataire

chrome.cast.Receiver non nul

Récepteur qui exécute l'application.

senderApps

Tableau non nul de chrome.cast.SenderApplication non nul

Applications émettrices compatibles avec l'application destinataire. Elle peut être utilisée pour inviter l'utilisateur à installer l'application émettrice ou à y accéder.

sessionId

chaîne

Identifie de manière unique cette instance de l'application réceptrice.

reconnu

chrome.cast.SessionStatus non nul

État de cette session de diffusion dans l'application du récepteur.

statusText

chaîne pouvant avoir une valeur nulle

Texte descriptif du contenu de l'application actuelle, par exemple "Mon diaporama de mariage".

transportId

chaîne

Identifiant qui décrit de manière unique cette session à des fins de transport. Cette fonction est interne au canal de communication.

Méthodes

addMediaListener

addMediaListener(listener)

Ajoute un écouteur appelé lorsqu'une session multimédia est créée par un autre expéditeur.

Paramètres

écouteur

function(non-null chrome.cast.media.Media)

Écouteur à ajouter.

addMessageListener

addMessageListener(namespace, listener)

Ajoute un écouteur appelé lorsqu'un message est reçu de l'application réceptrice. L'écouteur est appelé avec l'espace de noms comme premier argument et le message comme deuxième argument.

Paramètres

espace de noms

chaîne

Espace de noms à écouter, par exemple "urn:x-cast:com.example.namespace".

écouteur

fonction(chaîne, chaîne)

Écouteur à ajouter.

addUpdateListener

addUpdateListener(listener)

Ajoute un écouteur appelé lorsque la session a été modifiée. Les modifications apportées aux propriétés suivantes déclenchent l'écouteur: statusText, espaces de noms, état et volume du récepteur.

Les écouteurs doivent vérifier la propriété status de la session pour déterminer l'état de la connexion. Le paramètre booléen isAlive est obsolète et a été remplacé par la propriété de session status. Le paramètre isAlive est toujours transmis pour des raisons de rétrocompatibilité. Il est défini sur "true", sauf si status = chrome.cast.SessionStatus.STOPPED.

Paramètres

écouteur

function(boolean)

Écouteur à ajouter.

getDialAppInfo

getDialAppInfo(successCallback, errorCallback)

Récupère les informations de l'application DIAL.

Paramètres

successCallback

function(non-null chrome.cast.DialLaunchData)

errorCallback

function(non-null chrome.cast.Error)

partez

laisser(successCallback, errorCallback)

Elle se déconnecte de l'application réceptrice en cours d'exécution associée à la session.

Les clients existants compris dans le champ d'application défini par la règle AutoJoinPolicy de ce client seront déconnectés. Les futurs clients ne rejoindront pas automatiquement la session qui a été quittée.

Les écouteurs de mise à jour de session de tous les clients déconnectés seront appelés avec isAlive = true. Les écouteurs doivent vérifier la propriété status de la session pour déterminer l'état de sa connexion, car isAlive est obsolète. Dans ce cas, status = chrome.cast.SessionStatus.DISCONNECTED.

Paramètres

successCallback

fonction()

errorCallback

function(non-null chrome.cast.Error)

Les erreurs possibles sont TIMEOUT, API_NOT_INITIALIZED, CHANNEL_ERROR, SESSION_ERROR et EXTENSION_MISSING.

loadMedia

loadMedia(loadRequest, successCallback, errorCallback)

Charge du contenu multimédia dans une application réceptrice en cours d'exécution.

Paramètres

loadRequest

chrome.cast.media.LoadRequest

Requête de chargement des contenus multimédias.

La valeur ne doit pas être nulle.

successCallback

function(non-null chrome.cast.media.Media)

Appelée avec le contenu multimédia chargé en cas de réussite.

errorCallback

function(non-null chrome.cast.Error)

Appelée en cas d'erreur. Les erreurs possibles sont TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR et EXTENSION_MISSING.

queueLoad

queueLoad(queueLoadRequest, successCallback, errorCallback)

Charge et lance éventuellement la lecture d'une nouvelle file d'attente d'éléments multimédias dans une application réceptrice en cours d'exécution.

Paramètres

queueLoadRequest

chrome.cast.media.QueueLoadRequest

Requête pour charger une nouvelle file d'attente d'éléments multimédias.

La valeur ne doit pas être nulle.

successCallback

function(non-null chrome.cast.media.Media)

Appelée avec le contenu multimédia chargé en cas de réussite.

errorCallback

function(non-null chrome.cast.Error)

Appelée en cas d'erreur. Les erreurs possibles sont TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR et EXTENSION_MISSING.

Obsolète
Utilisez cast.framework.CastSession#loadMedia et fournissez les données chrome.cast.media.LoadRequest#queueData appropriées.

removeMediaListener

removeMediaListener(listener)

Supprime un écouteur précédemment ajouté avec addMediaListener.

Paramètres

écouteur

function(non-null chrome.cast.media.Media)

Écouteur à supprimer.

removeMessageListener

removeMessageListener(namespace, listener)

Supprime un écouteur précédemment ajouté pour les messages.

Paramètres

espace de noms

chaîne

Espace de noms écouté, par exemple "urn:x-cast:com.example.namespace".

écouteur

fonction(chaîne, chaîne)

Écouteur à supprimer.

removeUpdateListener

removeUpdateListener(listener)

Supprime un écouteur précédemment ajouté à cette session.

Paramètres

écouteur

function(boolean)

Écouteur à supprimer.

sendMessage

sendMessage(namespace, message, successCallback, errorCallback)

Envoie un message à l'application destinataire dans l'espace de noms donné. Le successCallback est invoqué lorsque le message a été envoyé au canal de messagerie. La distribution vers l'application réceptrice est la méthode la plus optimale possible et n'est pas garantie.

Paramètres

espace de noms

chaîne

Espace de noms à utiliser pour envoyer le message, par exemple "urn:x-cast:com.example.namespace".

message

(non-null Object or string)

successCallback

fonction()

Appelée lorsque le message a été envoyé.

errorCallback

function(non-null chrome.cast.Error)

Appelée en cas d'erreur. Les erreurs possibles sont TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR et EXTENSION_MISSING.

setReceiverMuted

setReceiverMuted(muted, successCallback, errorCallback)

Règle le volume du récepteur.

Paramètres

son coupé

boolean

Nouvel état "Son coupé".

successCallback

fonction()

errorCallback

function(non-null chrome.cast.Error)

Les erreurs possibles sont TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR et EXTENSION_MISSING.

setReceiverVolumeLevel

setReceiverVolumeLevel(newLevel, successCallback, errorCallback)

Règle le volume du récepteur.

Paramètres

newLevel

number

Nouveau niveau de volume, compris entre 0 et 1.

successCallback

fonction()

errorCallback

function(non-null chrome.cast.Error)

Les erreurs possibles sont TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR et EXTENSION_MISSING.

escale

stop(successCallback, errorCallback)

Arrête l'application réceptrice en cours d'exécution associée à la session.

Paramètres

successCallback

fonction()

errorCallback

function(non-null chrome.cast.Error)

Les erreurs possibles sont TIMEOUT, API_NOT_INITIALIZED, CHANNEL_ERROR, SESSION_ERROR et EXTENSION_MISSING.