cast. framework. CastSession
Gère une session Cast.
Constructeur
Session de diffusion
new CastSession(sessionObj, state)
Paramètre |
|
---|---|
sessionObj |
Données de session. La valeur ne doit pas être nulle. |
state |
État de la session. La valeur ne doit pas être nulle. |
Méthodes
addEventListener
addEventListener(type, gestionnaire)
Ajoute un écouteur d'événements.
Paramètre |
|
---|---|
type |
cast.framework.SessionEventType Type d'événement La valeur ne doit pas être nulle. |
handler |
(function(non null.cast.framework.ApplicationStatusEventData), function(non nulle) cast.framework.ApplicationMetadataEventData), function(non nulle cast.framework.ActiveInputStateEventData), function(non nulle cast.framework.MediaSessionEventData) ou function(non nul cast.framework.VolumeEventData) |
addMessageListener
addMessageListener(espacede noms, écouteur)
Ajoute un écouteur appelé lorsqu'un message est reçu par l'application réceptrice. L'écouteur est appelé avec l'espace de noms comme premier argument et le message comme deuxième argument.
Paramètre |
|
---|---|
espace de noms |
chaîne Espace de noms sur lequel écouter, par exemple "urn:x-cast:com.example.namespace". |
écouteur |
function(chaîne, chaîne) Paramètre "Listener" à ajouter. |
sessionFin
endSession(stopCaster)
Met fin à la session en cours.
Paramètre |
|
---|---|
arrêter la diffusion |
booléen Si l'application réceptrice est arrêtée à la fin de la session en cours. |
getActiveInputState
getActiveInputState() renvoie cast.framework.ActiveInputState
- Retours
-
non-null cast.framework.ActiveInputState
État de l'entrée active du récepteur.
getApplicationMetadata
La méthode getApplicationMetadata() renvoie cast.framework.ApplicationMetadata.
- Retours
-
non-null cast.framework.ApplicationMetadata
Métadonnées de l'application.
getApplicationStatus
La fonction getApplicationStatus() renvoie la chaîne
- Retours
-
nullable string
Chaîne d'état de la demande.
getCastDevice
La commande getCastDevice() renvoie chrome.cast.Receiver.
- Retours
-
non-null chrome.cast.Receiver
Métadonnées de l'appareil Cast.
Obtenir une session multimédia
La fonction getMediaSession() renvoie chrome.cast.media.Media.
Affiche la session multimédia actuelle, si disponible.
- Retours
-
nullable chrome.cast.media.Media
Session multimédia actuelle.
getSessionId
La méthode getSessionId() renvoie la chaîne
- Retours
-
string
Identifiant unique pour cette session.
getSessionObj
La méthode getSessionObj() renvoie chrome.cast.Session.
- Retours
-
non-null chrome.cast.Session
Données de session.
getSessionState
getSessionState() renvoie cast.framework.SessionState
- Retours
-
cast.framework.SessionState
État actuel de la session.
getVolume
La fonction getVolume() renvoie le numéro
- Retours
-
nullable number
Volume du récepteur, si disponible.
isMute
La fonction isMute() renvoie des valeurs booléennes
- Retours
-
nullable boolean
État "Récepteur" désactivé, si disponible.
loadMedia
loadMedia(loadRequest) renvoie la promesse contenant l'élément chrome.cast.ErrorCode pouvant être vide.
Charge le média dans une application réceptrice en cours d'exécution.
Paramètre |
|
---|---|
loadRequest |
chrome.cast.media.LoadRequest. La valeur ne doit pas être nulle. |
- Retours
-
non-null Promise containing nullable chrome.cast.ErrorCode
Promise pour indiquer que la charge a réussi ou n'a pas pu être envoyée au destinataire (la session est transmise à l'événement media_session).
removeEventListener
removeEventListener(type, gestionnaire)
Supprime un écouteur d'événements.
Paramètre |
|
---|---|
type |
cast.framework.SessionEventType Type d'événement La valeur ne doit pas être nulle. |
handler |
(function(non null.cast.framework.ApplicationStatusEventData), function(non nulle) cast.framework.ApplicationMetadataEventData), function(non nulle cast.framework.ActiveInputStateEventData), function(non nulle cast.framework.MediaSessionEventData) ou function(non nul cast.framework.VolumeEventData) |
removeMessageListener
removeMessageListener(espace de noms, écouteur)
Supprime un écouteur précédemment ajouté pour les messages.
Paramètre |
|
---|---|
espace de noms |
chaîne Espace de noms écouté, par exemple, "urn:x-cast:com.example.namespace". |
écouteur |
function(chaîne, chaîne) Paramètre "Listener" à supprimer. |
envoyer un message
sendMessage(namespace, data) returns Promise contenant nullable chrome.cast.ErrorCode
Envoie un message au destinataire.
Paramètre |
|
---|---|
espace de noms |
chaîne Espace de noms sur lequel envoyer le message, par exemple "urn:x-cast:com.example.namespace". |
données |
(Objet ou chaîne non nul) Données à envoyer. |
- Retours
-
non-null Promise containing nullable chrome.cast.ErrorCode
Promesses résolues lors de l'envoi du message, ou refus avec code d'erreur en cas d'échec.
setMute
La fonction setMute(isMute) renvoie une promesse contenant l'élément chrome.cast.ErrorCode qui peut être vide.
Couper ou couper le son du récepteur
Paramètre |
|
---|---|
isMute |
booléen Nouvel état de désactivation du son. |
- Retours
-
non-null Promise containing nullable chrome.cast.ErrorCode
Le destinataire de la promesse résolue a été mis à jour ou refusé avec un code d'erreur en cas d'échec.
Régler le volume
La fonction setVolume(volume) renvoie la promesse contenant la valeur chrome.cast.ErrorCode pouvant être vide.
Définit le volume du récepteur.
Paramètre |
|
---|---|
volume |
number (nombre) Nouveau niveau de volume entre 0.0 et 1.0. |
- Retours
-
non-null Promise containing nullable chrome.cast.ErrorCode
Le destinataire de la promesse résolue a été mis à jour ou refusé avec un code d'erreur en cas d'échec.