cast. framework. CastSession
Verwaltet eine Streamingsitzung.
Konstruktor
CastSession
new CastSession(sessionObj, state)
Parameter |
|
---|---|
sessionObj |
Sitzungsdaten. Der Wert darf nicht null sein. |
state |
Sitzungsstatus. Der Wert darf nicht null sein. |
Methoden
addEventListener
addEventListener(type, handler)
Fügt einen Event-Listener hinzu.
Parameter |
|
---|---|
eingeben |
cast.framework.SessionEventType Ereignistyp Der Wert darf nicht null sein. |
Handler |
(function(non-null cast.framework.ApplicationStatusEventData), function(non-null cast.framework.ApplicationMetadataEventData), function(non-null cast.framework.ActiveInputStateEventData), function(non-null cast.framework.MediaSessionEventData), or function(non-null cast.framework.VolumeEventData)) |
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. |
endSession
endSession(stopCasting)
Beendet die aktuelle Sitzung.
Parameter |
|
---|---|
stopCasting |
boolean Soll die empfangende Anwendung beim Beenden der aktuellen Sitzung beendet werden. |
getActiveInputState
getActiveInputState() gibt cast.framework.ActiveInputState zurück.
- Rückgaben
-
non-null cast.framework.ActiveInputState
Aktiver Eingangsstatus des Empfängers.
getApplicationMetadata
getApplicationMetadata() gibt cast.framework.ApplicationMetadata zurück.
- Rückgaben
-
non-null cast.framework.ApplicationMetadata
Anwendungsmetadaten.
getApplicationStatus
getApplicationStatus() gibt einen String zurück
- Rückgaben
-
nullable string
String für Anwendungsstatus.
getCastDevice
getCastDevice() gibt chrome.cast.Receiver zurück.
- Rückgaben
-
non-null chrome.cast.Receiver
Metadaten zum Streamen.
getMediaSession
getMediaSession() gibt chrome.cast.media.Media zurück.
Gibt die aktuelle Mediensitzung zurück, falls verfügbar.
- Rückgaben
-
nullable chrome.cast.media.Media
Aktuelle Mediensitzung.
getSessionId
getSessionId() gibt einen String zurück
- Rückgaben
-
string
Eindeutige ID für diese Sitzung.
getSessionObj
getSessionObj() gibt chrome.cast.Session zurück.
- Rückgaben
-
non-null chrome.cast.Session
Sitzungsdaten.
getSessionState
getSessionState() gibt cast.framework.SessionState zurück.
- Rückgaben
-
cast.framework.SessionState
Aktueller Sitzungsstatus.
getVolume
getVolume() gibt eine Zahl zurück
- Rückgaben
-
nullable number
Empfängerlautstärke, falls verfügbar.
isMute
isMute() gibt einen booleschen Wert zurück
- Rückgaben
-
nullable boolean
Stummschaltung des Empfängers, falls verfügbar.
loadMedia
„loadMedia(loadRequest)“ gibt ein Promise zurück, das chrome.cast.ErrorCode enthält, bei dem Nullwerte zulässig sind.
Lädt Medien in eine laufende Empfängeranwendung.
Parameter |
|
---|---|
loadRequest |
Der Wert darf nicht null sein. |
- Rückgaben
-
non-null Promise containing nullable chrome.cast.ErrorCode
Promise, das angibt, dass der Ladevorgang erfolgreich war oder nicht an den Empfänger gesendet werden konnte (die Sitzung wird an das Ereignis „media_session“) übergeben.
removeEventListener
removeEventListener(type, handler)
Entfernt einen Event-Listener.
Parameter |
|
---|---|
eingeben |
cast.framework.SessionEventType Ereignistyp Der Wert darf nicht null sein. |
Handler |
(function(non-null cast.framework.ApplicationStatusEventData), function(non-null cast.framework.ApplicationMetadataEventData), function(non-null cast.framework.ActiveInputStateEventData), function(non-null cast.framework.MediaSessionEventData), or function(non-null cast.framework.VolumeEventData)) |
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. |
sendMessage
sendMessage(namespace, data) gibt ein Promise zurück, das chrome.cast.ErrorCode enthält, für das Nullwerte zulässig sind.
Sendet eine Nachricht an den Empfänger.
Parameter |
|
---|---|
Namespace |
String Der Namespace, an den die Nachricht gesendet werden soll, z.B. „urn:x-cast:com.example.namespace“. |
daten |
(non-null Object or string) Zu sendende Daten. |
- Rückgaben
-
non-null Promise containing nullable chrome.cast.ErrorCode
Versprechen, dass die Nachricht gesendet wurde, behoben bzw. mit Fehlercode abgelehnt, wenn die Nachricht nicht gesendet wurde.
setMute
setMute(isMute) gibt ein Promise zurück, das chrome.cast.ErrorCode enthält, auf dem Nullwerte zulässig sind.
Schalte den Empfänger stumm oder umute.
Parameter |
|
---|---|
isMute |
boolean Der neue stummgeschaltete Status. |
- Rückgaben
-
non-null Promise containing nullable chrome.cast.ErrorCode
Der behobene Promise-Empfänger wurde aktualisiert oder bei Nichterfüllung mit Fehlercode abgelehnt.
setVolume
setVolume(volume) gibt ein Promise zurück, das chrome.cast.ErrorCode enthält, für das Nullwerte zulässig sind.
Stellt die Lautstärke des Empfängers ein.
Parameter |
|
---|---|
Volume |
Zahl Der neue Lautstärkepegel zwischen 0,0 und 1,0. |
- Rückgaben
-
non-null Promise containing nullable chrome.cast.ErrorCode
Der behobene Promise-Empfänger wurde aktualisiert oder bei Nichterfüllung mit Fehlercode abgelehnt.