chrome.cast. Sitzung
Beschreibt den Status einer aktuell ausgeführten Cast-App. Normalerweise sollten diese Objekte nicht vom Client erstellt werden.
Konstruktor
Sitzung
new Session(sessionId, appId, displayName, appImages, resultr)
Parameter |
|
|---|---|
|
sessionId |
String Die Sitzungs-ID. |
|
appId |
String Die Anwendungskennung des Empfängers. |
|
displayName |
String Der Anzeigename der Anwendung. |
|
appImages |
Array von Nicht-Null-Wert chrome.cast.Image Mit der App verknüpfte Bilder. Der Wert darf nicht null sein. |
|
Empfänger |
Der Empfänger, auf dem die Anwendung ausgeführt wird. Der Wert darf nicht null sein. |
Attribute
appId
String
Die ID der Cast-App. Nicht zur Anzeige vorgesehen.
appImages
Non-null Array von Nicht-Null chrome.cast.Image
Array der verfügbaren Bilder zur Beschreibung der Anwendung.
displayName
String
Der visuell lesbare Name der Cast-App, z. B. "YouTube".
medien
non-null Array von nicht null chrome.cast.media.Media
Die Medien, die zu dieser Streamingsitzung gehören, einschließlich der Medien, die von anderen Absendern geladen wurden.
namespaces
Nicht-Null-Array von {name: string}
Eine Liste der Namespaces, die von der Empfängeranwendung unterstützt werden.
Empfänger
Nicht-Null chrome.cast.Receiver
Der Empfänger, der die Anwendung ausführt.
senderApps
non-null Array von nicht null chrome.cast.SenderApplication
Die von der Empfängeranwendung unterstützten Senderanwendungen. Damit kann der Nutzer aufgefordert werden, die Senderanwendung zu installieren oder aufzurufen.
sessionId
String
Identifiziert diese Instanz der Empfängeranwendung eindeutig.
Status
ungleich chrome.cast.SessionStatus
Status dieser Übertragungssitzung an die Empfänger-App.
statusText
String, für den Nullwerte zulässig sind
Beschreibender Text für den aktuellen Inhalt der Anwendung, z. B. „Meine Hochzeitspräsentation“.
transportId
String
Kennung, die diese Sitzung zu Transportzwecken eindeutig beschreibt. Dies ist ein interner Kommunikationskanal.
Methoden
addMediaListener
addMediaListener(listener)
Fügt einen Listener hinzu, der beim Erstellen einer Mediensitzung von einem anderen Sender aufgerufen wird.
Parameter |
|
|---|---|
|
Listener |
function(non-null chrome.cast.media.Media) Der hinzuzufügende Listener. |
addMessageListener
addMessageListener(namespace, listener)
Fügt einen Listener hinzu, der aufgerufen wird, wenn eine Nachricht von der Empfängeranwendung empfangen wird. Der Listener wird mit dem Namespace als erstes Argument und der Nachricht als zweitem Argument aufgerufen.
Parameter |
|
|---|---|
|
Namespace |
String Der Namespace, der überwacht werden soll, z.B. „urn:x-cast:com.example.namespace“. |
|
Listener |
Funktion(String; Zeichenfolge) Der hinzuzufügende Listener. |
addUpdateListener
addUpdateListener(listener)
Fügt einen Listener hinzu, der bei einer Änderung der Sitzung aufgerufen wird. Änderungen an den folgenden Attributen lösen den Listener aus: statusText, Namespaces, Status und Volume des Empfängers.
Listener sollten das Attribut status der Sitzung prüfen, um den Verbindungsstatus zu ermitteln. Der boolesche Parameter isAlive wird zugunsten des Sitzungsattributs status eingestellt. Der isAlive-Parameter wird aus Gründen der Abwärtskompatibilität weiterhin übergeben und ist „true“, sofern nicht status =
chrome.cast.SessionStatus.STOPPED.
Parameter |
|
|---|---|
|
Listener |
function(boolean) Der hinzuzufügende Listener. |
getDialAppInfo
getDialAppInfo(successCallback, errorCallback)
Ruft die Informationen zur DIAL-Anwendung ab.
Parameter |
|
|---|---|
|
successCallback |
function(non-null chrome.cast.DialLaunchData) |
|
errorCallback |
function(non-null chrome.cast.Error) |
leave
left(successCallback, errorCallback)
Beendet (trennt die Verbindung) von der laufenden Empfängeranwendung, die mit der Sitzung verknüpft ist.
Die Verbindung für bestehende Clients innerhalb des in der AutoJoinPolicy dieses Clients definierten Bereichs wird getrennt. Zukünftige Clients nehmen nicht automatisch an der verlassenen Sitzung teil.
Die Listener für alle nicht verbundenen Clients rufen die Listener für Sitzungsaktualisierungen mit isAlive = true auf. Listener sollten das Attribut status der Sitzung prüfen, um den Verbindungsstatus zu bestimmen, da isAlive eingestellt wurde. In diesem Fall: status = chrome.cast.SessionStatus.DISCONNECTED.
Parameter |
|
|---|---|
|
successCallback |
Funktion() |
|
errorCallback |
function(non-null chrome.cast.Error) Mögliche Fehler sind TIMEOUT, API_NOT_INITIALIZED, CHANNEL_ERROR, SESSION_ERROR und EXTENSION_MISSING. |
loadMedia
loadMedia(loadRequest, successCallback, errorCallback)
Lädt Medien in eine laufende Empfängeranwendung.
Parameter |
|
|---|---|
|
loadRequest |
Anfrage zum Laden von Medien Der Wert darf nicht null sein. |
|
successCallback |
function(non-null chrome.cast.media.Media) Wird bei Erfolg mit den geladenen Medien aufgerufen. |
|
errorCallback |
function(non-null chrome.cast.Error) Bei Fehler aufgerufen. Mögliche Fehler sind TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR und EXTENSION_MISSING. |
queueLoad
queueLoad(queueLoadRequest, successCallback, errorCallback)
Lädt eine neue Warteschlange von Medienelementen in eine laufende Empfängeranwendung und startet sie optional.
Parameter |
|
|---|---|
|
queueLoadRequest |
chrome.cast.media.QueueLoadRequest Anfrage zum Laden einer neuen Warteschlange von Medienelementen. Der Wert darf nicht null sein. |
|
successCallback |
function(non-null chrome.cast.media.Media) Wird bei Erfolg mit den geladenen Medien aufgerufen. |
|
errorCallback |
function(non-null chrome.cast.Error) Bei Fehler aufgerufen. Mögliche Fehler sind TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR und EXTENSION_MISSING. |
- Eingestellte Funktionen
- Verwenden Sie cast.framework.CastSession#loadMedia und geben Sie die entsprechenden chrome.cast.media.LoadRequest#queueData an.
removeMediaListener
removeMediaListener(listener)
Entfernt einen Listener, der zuvor mit addMediaListener hinzugefügt wurde.
Parameter |
|
|---|---|
|
Listener |
function(non-null chrome.cast.media.Media) Der zu entfernende Listener. |
removeMessageListener
removeMessageListener(namespace, listener)
Entfernt einen zuvor hinzugefügten Listener für Nachrichten.
Parameter |
|
|---|---|
|
Namespace |
String Der Namespace, der überwacht wird, z.B. „urn:x-cast:com.example.namespace“. |
|
Listener |
Funktion(String; Zeichenfolge) Der zu entfernende Listener. |
removeUpdateListener
removeUpdateListener(listener)
Entfernt einen zuvor hinzugefügten Listener für diese Sitzung.
Parameter |
|
|---|---|
|
Listener |
function(boolean) Der zu entfernende Listener. |
sendMessage
sendMessage(namespace, message, successCallback, errorCallback)
Sendet eine Nachricht an die Empfängeranwendung für den angegebenen Namespace. ErfolgsCallback wird aufgerufen, wenn die Nachricht an den Messaging-Kanal gesendet wurde. Die Zustellung an die Empfängeranwendung erfolgt bestmöglich und nicht garantiert.
Parameter |
|
|---|---|
|
Namespace |
String Der Namespace, an den die Nachricht gesendet werden soll, z.B. „urn:x-cast:com.example.namespace“. |
|
Nachricht |
(non-null Object or string) |
|
successCallback |
Funktion() Wird aufgerufen, wenn die Nachricht gesendet wurde |
|
errorCallback |
function(non-null chrome.cast.Error) Bei Fehler aufgerufen. Mögliche Fehler sind TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR und EXTENSION_MISSING. |
setReceiverMuted
setReceiverMuted(muted, successCallback, errorCallback)
Stellt die Lautstärke des Empfängers ein.
Parameter |
|
|---|---|
|
stummgeschaltet |
boolean Der neue stummgeschaltete Status. |
|
successCallback |
Funktion() |
|
errorCallback |
function(non-null chrome.cast.Error) Mögliche Fehler sind TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR und EXTENSION_MISSING. |
setReceiverVolumeLevel
setReceiverVolumeLevel(newLevel, successCallback, errorCallback)
Stellt die Lautstärke des Empfängers ein.
Parameter |
|
|---|---|
|
newLevel |
Zahl Der neue Lautstärkepegel zwischen 0,0 und 1,0. |
|
successCallback |
Funktion() |
|
errorCallback |
function(non-null chrome.cast.Error) Mögliche Fehler sind TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR und EXTENSION_MISSING. |
Zwischenstopp
stop(successCallback, errorCallback)
Beendet die laufende Empfängeranwendung, die mit der Sitzung verknüpft ist.
Parameter |
|
|---|---|
|
successCallback |
Funktion() |
|
errorCallback |
function(non-null chrome.cast.Error) Mögliche Fehler sind TIMEOUT, API_NOT_INITIALIZED, CHANNEL_ERROR, SESSION_ERROR und EXTENSION_MISSING. |