Namespace: Cast

chrome.cast

namespace   statisch

Dies ist der chrome.cast-Namespace.

Kurse

Namespace

Aufzählungen

AutoJoinPolicy

statisch

String

Die Richtlinie für die automatische Verknüpfung legt fest, wann das SDK eine Senderanwendung nach der API-Initialisierung automatisch mit einer vorhandenen Sitzung verbindet.

Wert

TAB_AND_ORIGIN_SCOPED

String

Stellt automatisch eine Verbindung her, wenn die Sitzung mit derselben appId im selben Tab und auf derselben Seite gestartet wurde.

ORIGIN_SCOPED

String

Stellt automatisch eine Verbindung her, wenn die Sitzung mit derselben App-ID und demselben Seitenursprung gestartet wurde (unabhängig vom Tab).

PAGE_SCOPED

String

Keine automatische Verbindung.

Funktion

statisch

String

Funktionen, die vom Empfängergerät unterstützt werden.

Wert

VIDEO_OUT

String

Der Empfänger unterstützt die Videoausgabe.

AUDIO_OUT

String

Der Empfänger unterstützt die Audioausgabe.

VIDEO_IN

String

Der Empfänger unterstützt die Videoeingabe (Kamera).

AUDIO_IN

String

Der Empfänger unterstützt die Audioeingabe (Mikrofon).

MULTIZONE_GROUP

String

Der Empfänger stellt eine Mehrzonengruppe dar.

DefaultActionPolicy

statisch

String

Die Standardaktionsrichtlinie legt fest, wann das SDK nach der Initialisierung der API automatisch eine Sitzung erstellt. Damit wird auch die Standardaktion für den Tab im Pop-up der Erweiterung festgelegt.

Wert

CREATE_SESSION

String

Wenn beim Initialisieren der API der Tab mit der App gestreamt wird, stoppt das SDK die Tab-Übertragung und startet automatisch die App. Im Pop-up-Fenster der Erweiterung wird der Nutzer aufgefordert, die App zu streamen.

CAST_THIS_TAB

String

Nach der Initialisierung der API wird nichts automatisch gestartet, auch wenn der Tab gerade gestreamt wird. Im Pop-up der Erweiterung wird der Nutzer aufgefordert, den Tab zu streamen.

DialAppState

statisch

String

Mögliche Zustände einer DIAL-Anwendung.

Wert

RUNNING

String

ANGEHALTEN

String

FEHLER

String

Nicht Teil der Spezifikation; wird verwendet, um Fehler zu signalisieren.

ErrorCode

statisch

String

Fehler, die vom SDK zurückgegeben werden können.

Wert

ABBRECHEN

String

Der Vorgang wurde vom Nutzer abgebrochen.

TIMEOUT

String

Zeitüberschreitung beim Vorgang.

API_NOT_INITIALIZED

String

Die API ist nicht initialisiert.

INVALID_PARAMETER

String

Die Parameter für den Vorgang waren ungültig.

EXTENSION_NOT_COMPATIBLE

String

Das API-Skript ist nicht mit der installierten Cast-Erweiterung kompatibel.

EXTENSION_MISSING

String

Die Cast-Erweiterung ist nicht verfügbar.

RECEIVER_UNAVAILABLE

String

Mit der Sitzungsanfrage war kein Empfänger kompatibel.

SESSION_ERROR

String

Eine Sitzung konnte nicht erstellt werden oder war ungültig.

CHANNEL_ERROR

String

Es ist kein Kanal zum Empfänger verfügbar.

LOAD_MEDIA_FAILED

String

Fehler beim Laden der Medien.

ReceiverAction

statisch

String

Aktionen, die der Nutzer für einen Empfänger in der Erweiterung ausführen kann. Sie können verwendet werden, um einen Übergang in der Benutzeroberfläche der Senderanwendung anzuzeigen, bevor die Umwandlungsaktion vollständig abgeschlossen (oder fehlgeschlagen) ist.

Wert

CAST

String

Der Nutzer hat einen Empfänger ausgewählt, um mit der Absenderanwendung etwas dorthin zu streamen. Die genaue Identität des Empfängers ist möglicherweise nicht bekannt.

STOPPEN

String

Der Nutzer hat das Beenden der Sitzung auf einem Empfänger angefordert.

ReceiverAvailability

statisch

String

Beschreibt die Verfügbarkeit eines Streamingempfängers.

Wert

AVAILABLE

String

Es ist mindestens ein Empfänger verfügbar, der mit der Sitzungsanfrage kompatibel ist.

NICHT VERFÜGBAR

String

Es sind keine Empfänger verfügbar.

ReceiverType

statisch

String

Wert

CAST

String

Streamingempfänger, z.B. Chromecast

Wählscheibe

String

DIAL-Gerät, z.B. Smart-TV

Hangout

String

Hangout

BENUTZERDEFINIERT

String

Vom Client bereitgestellter benutzerdefinierter Empfänger

SenderPlatform

statisch

String

Beschreibt eine Sender-Anwendungsplattform.

Wert

CHROME

String

iOS

String

ANDROID

String

SessionStatus

statisch

String

Beschreibt den Status einer Streaming-Sitzung für die Empfänger-App.

Wert

VERBUNDEN

String

Die Sitzung ist mit der Empfängeranwendung verbunden.

NICHT VERBUNDEN

String

Die Sitzung wird von der Empfängeranwendung getrennt. Die Empfängeranwendung wird möglicherweise noch ausgeführt.

ANGEHALTEN

String

Die Empfänger-App wurde beendet.

VolumeControlType

statisch

String

Beschreibt verschiedene Arten der Lautstärkeregelung.

Wert

ATTENUATION

String

Die Lautstärke des Übertragungsgeräts kann geändert werden.

BEHOBEN

String

Die Lautstärke des Übertragungsgeräts wurde korrigiert und kann nicht geändert werden.

MASTER

String

Lautstärkeregelung des Mastersystems, d.h., die Lautstärke des Fernsehers oder Audiogeräts wird geändert.

Attribute

AutoJoinPolicy

statisch

String

Die Richtlinie für die automatische Verknüpfung legt fest, wann das SDK eine Senderanwendung nach der API-Initialisierung automatisch mit einer vorhandenen Sitzung verbindet.

Wert

TAB_AND_ORIGIN_SCOPED

String

Stellt automatisch eine Verbindung her, wenn die Sitzung mit derselben appId im selben Tab und auf derselben Seite gestartet wurde.

ORIGIN_SCOPED

String

Stellt automatisch eine Verbindung her, wenn die Sitzung mit derselben App-ID und demselben Seitenursprung gestartet wurde (unabhängig vom Tab).

PAGE_SCOPED

String

Keine automatische Verbindung.

Funktion

statisch

String

Funktionen, die vom Empfängergerät unterstützt werden.

Wert

VIDEO_OUT

String

Der Empfänger unterstützt die Videoausgabe.

AUDIO_OUT

String

Der Empfänger unterstützt die Audioausgabe.

VIDEO_IN

String

Der Empfänger unterstützt die Videoeingabe (Kamera).

AUDIO_IN

String

Der Empfänger unterstützt die Audioeingabe (Mikrofon).

MULTIZONE_GROUP

String

Der Empfänger stellt eine Mehrzonengruppe dar.

DefaultActionPolicy

statisch

String

Die Standardaktionsrichtlinie legt fest, wann das SDK nach der Initialisierung der API automatisch eine Sitzung erstellt. Damit wird auch die Standardaktion für den Tab im Pop-up der Erweiterung festgelegt.

Wert

CREATE_SESSION

String

Wenn beim Initialisieren der API der Tab mit der App gestreamt wird, stoppt das SDK die Tab-Übertragung und startet automatisch die App. Im Pop-up-Fenster der Erweiterung wird der Nutzer aufgefordert, die App zu streamen.

CAST_THIS_TAB

String

Nach der Initialisierung der API wird nichts automatisch gestartet, auch wenn der Tab gerade gestreamt wird. Im Pop-up der Erweiterung wird der Nutzer aufgefordert, den Tab zu streamen.

DialAppState

statisch

String

Mögliche Zustände einer DIAL-Anwendung.

Wert

RUNNING

String

ANGEHALTEN

String

FEHLER

String

Nicht Teil der Spezifikation; wird verwendet, um Fehler zu signalisieren.

ErrorCode

statisch

String

Fehler, die vom SDK zurückgegeben werden können.

Wert

ABBRECHEN

String

Der Vorgang wurde vom Nutzer abgebrochen.

TIMEOUT

String

Zeitüberschreitung beim Vorgang.

API_NOT_INITIALIZED

String

Die API ist nicht initialisiert.

INVALID_PARAMETER

String

Die Parameter für den Vorgang waren ungültig.

EXTENSION_NOT_COMPATIBLE

String

Das API-Skript ist nicht mit der installierten Cast-Erweiterung kompatibel.

EXTENSION_MISSING

String

Die Cast-Erweiterung ist nicht verfügbar.

RECEIVER_UNAVAILABLE

String

Mit der Sitzungsanfrage war kein Empfänger kompatibel.

SESSION_ERROR

String

Eine Sitzung konnte nicht erstellt werden oder war ungültig.

CHANNEL_ERROR

String

Es ist kein Kanal zum Empfänger verfügbar.

LOAD_MEDIA_FAILED

String

Fehler beim Laden der Medien.

isAvailable

statisch

boolean

Flag, mit dem Clients prüfen können, ob die API geladen ist.

ReceiverAction

statisch

String

Aktionen, die der Nutzer für einen Empfänger in der Erweiterung ausführen kann. Sie können verwendet werden, um einen Übergang in der Benutzeroberfläche der Senderanwendung anzuzeigen, bevor die Umwandlungsaktion vollständig abgeschlossen (oder fehlgeschlagen) ist.

Wert

CAST

String

Der Nutzer hat einen Empfänger ausgewählt, um mit der Absenderanwendung etwas dorthin zu streamen. Die genaue Identität des Empfängers ist möglicherweise nicht bekannt.

STOPPEN

String

Der Nutzer hat das Beenden der Sitzung auf einem Empfänger angefordert.

ReceiverAvailability

statisch

String

Beschreibt die Verfügbarkeit eines Streamingempfängers.

Wert

AVAILABLE

String

Es ist mindestens ein Empfänger verfügbar, der mit der Sitzungsanfrage kompatibel ist.

NICHT VERFÜGBAR

String

Es sind keine Empfänger verfügbar.

ReceiverType

statisch

String

Wert

CAST

String

Streamingempfänger, z.B. Chromecast

Wählscheibe

String

DIAL-Gerät, z.B. Smart-TV

Hangout

String

Hangout

BENUTZERDEFINIERT

String

Vom Client bereitgestellter benutzerdefinierter Empfänger

SenderPlatform

statisch

String

Beschreibt eine Sender-Anwendungsplattform.

Wert

CHROME

String

iOS

String

ANDROID

String

SessionStatus

statisch

String

Beschreibt den Status einer Streaming-Sitzung für die Empfänger-App.

Wert

VERBUNDEN

String

Die Sitzung ist mit der Empfängeranwendung verbunden.

NICHT VERBUNDEN

String

Die Sitzung wird von der Empfängeranwendung getrennt. Die Empfängeranwendung wird möglicherweise noch ausgeführt.

ANGEHALTEN

String

Die Empfänger-App wurde beendet.

Time-out

statisch

Nicht null: chrome.cast.Timeout

Standardzeitüberschreitungswerte für API-Methoden in Millisekunden.

VERSION

konstante   statisch

Nicht-Null-Array von Zahlen

Die API-Version. Die erste Zahl ist die Hauptversion, die zweite die Nebenversion.

VolumeControlType

statisch

String

Beschreibt verschiedene Arten der Lautstärkeregelung.

Wert

ATTENUATION

String

Die Lautstärke des Übertragungsgeräts kann geändert werden.

BEHOBEN

String

Die Lautstärke des Übertragungsgeräts wurde korrigiert und kann nicht geändert werden.

MASTER

String

Lautstärkeregelung des Mastersystems, d.h., die Lautstärke des Fernsehers oder Audiogeräts wird geändert.

Methoden

addReceiverActionListener

statisch

addReceiverActionListener(listener)

Fügt eine Listener-Funktion hinzu, die aufgerufen wird, wenn der Nutzer das Streaming über die UI gestartet oder beendet hat. Die Senderanwendung kann damit auf der Benutzeroberfläche einen Übergang anzeigen (z.B. das Pausieren der lokalen Medienwiedergabe), bevor das Streaming abgeschlossen ist oder fehlgeschlagen ist.

  • Es kann nicht garantiert werden, dass der Listener aufgerufen wird, und Anwendungen sollten sich nicht darauf verlassen, dass er ordnungsgemäß funktioniert.
  • An den Listener wird der Empfänger übergeben, auf den reagiert wurde, sofern verfügbar. Allerdings ist der Empfänger möglicherweise nicht bekannt. Stattdessen wird null übergeben.
  • Der Listener wird so bald wie möglich aufgerufen, nachdem der Nutzer eine Aktion ausgeführt hat. Sie sollte aufgerufen werden, bevor die Anwendung über die API über die resultierende Statusänderung benachrichtigt wird.

Wenn Sie die Framework API nutzen, verwenden Sie stattdessen cast.framework.CastContext#addEventListener und warten Sie auf Cast.framework.CastContextEventType#CAST_STATE_CHANGED-Ereignisse.

Parameter

Listener

chrome.cast.ReceiverActionListener

Die hinzuzufügende Listener-Funktion. Das erste Argument für den Listener ist der Empfänger, auf den die Aktion ausgeführt wurde. Das zweite Argument für den Listener ist die angeforderte Aktion (siehe chrome.cast.ReceiverAction).

Der Wert darf nicht null sein.

initialize

statisch

initial(apiConfig, successCallback, errorCallback)

Initialisiert die API. Sobald die API-Initialisierung abgeschlossen ist, wird entweder successCallback oder errorCallback aufgerufen. „sessionListener“ und „receiverListener“ können jederzeit und möglicherweise mehrmals aufgerufen werden.

Wenn Sie die Framework API nutzen, verwenden Sie cast.framework.CastContext#setOptions anstelle dieser Funktion.

Parameter

apiConfig

chrome.cast.ApiConfig

Das Objekt mit den Parametern zum Initialisieren der API.

Der Wert darf nicht null sein.

successCallback

Funktion()

errorCallback

function(non-null chrome.cast.Error)

Mögliche Fehler sind TIMEOUT, INVALID_PARAMETER, EXTENSION_MISSING.

logMessage

statisch

logMessage(message)

Protokolliert eine Debug-Nachricht in der App. Diese Nachricht kann in einem Feedbackbericht an Google gesendet werden, wenn Nutzer sich ausdrücklich dafür entscheiden, detaillierte Protokolle hinzuzufügen.

Parameter

Nachricht

String

Die zu protokollierende Nachricht.
Eingestellte Funktionen
Nicht unterstützt mit dem auf der Presentation API basierenden Cast SDK.

Precache

statisch

Precache(Daten)

Senden Sie eine Anfrage, um Daten vorab im Cache zu speichern. Wenn eine Sitzung verbunden ist, wird eine direkte Anfrage gesendet. Andernfalls wird sie an alle Geräte im Netzwerk gesendet.

Parameter

daten

String

Daten, die vorab im Cache gespeichert werden sollen.
Eingestellte Funktionen
Nicht unterstützt.

removeReceiverActionListener

statisch

removeReceiverActionListener(listener)

Entfernt eine Listener-Funktion, die zuvor mit addReceiverActionListener hinzugefügt wurde.

Parameter

Listener

chrome.cast.ReceiverActionListener

Die zu entfernende Listener-Funktion.

Der Wert darf nicht null sein.

requestSession

statisch

requestSession(successCallback, errorCallback, sessionRequest)

Fordert an, dass eine Anwendungssitzung eines Empfängers erstellt oder ihr beigetreten ist. Standardmäßig wird die bei der Initialisierung an die API übergebene SessionRequest verwendet. Sie kann überschrieben werden, indem in sessionRequest eine andere Sitzungsanfrage übergeben wird.

Wenn Sie die Framework API nutzen, verwenden Sie cast.framework.CastContext#requestSession anstelle dieser Funktion.

Parameter

successCallback

function(non-null chrome.cast.Session)

errorCallback

function(non-null chrome.cast.Error)

Mögliche Fehler sind TIMEOUT, INVALID_PARAMETER, API_NOT_INITIALIZED, CANCEL, CHANNEL_ERROR, SESSION_ERROR, RECEIVER_UNAVAILABLE und EXTENSION_MISSING. Beachten Sie, dass der Zeitüberschreitungs-Timer startet, nachdem der Nutzer einen Empfänger ausgewählt hat. Zur Auswahl eines Empfängers ist eine Aktion des Nutzers ohne Zeitüberschreitung erforderlich. Wenn bereits eine Sitzungsanfrage läuft, wird errorCallback mit dem Fehlercode INVALID_PARAMETER und einer Fehlerbeschreibung aufgerufen.

sessionRequest

Optional

chrome.cast.SessionRequest

Der Wert darf nicht null sein.

requestSessionById

statisch

requestSessionById(sessionId)

Anfragen zum Beitritt zu einer vorhandenen Sitzung mit der angegebenen ID. Nach dem Beitreten wird die Sitzung an den durch „chrome.cast.initial“ festgelegten sessionListener übergeben.

Wenn die Sitzung mit der angegebenen sessionId beim Aufruf dieser Funktion bereits bekannt ist, wird sessionListener sofort aufgerufen. Andernfalls wird sessionListener aufgerufen, sobald eine Sitzung mit der angegebenen sessionId erkannt wurde.

Parameter

sessionId

String

Die ID der Sitzung, an der Sie teilnehmen möchten.

setCustomReceivers

statisch

setCustomReceivers(receivers, successCallback, errorCallback)

Legt benutzerdefinierte Empfängerliste fest

Parameter

Empfänger

Array von Nicht-Null-Wert chrome.cast.Receiver

Die neue Liste.

Der Wert darf nicht null sein.

successCallback

Funktion()

errorCallback

function(non-null chrome.cast.Error)

Mögliche Fehler sind TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR und EXTENSION_MISSRING.
Eingestellte Funktionen
Nicht unterstützt mit dem auf der Presentation API basierenden Cast SDK.

setPageContext

statisch

setPageContext(win)

Initialisiert die Cast-Funktion für eine Seite, auf der das Cast SDK in einem iFrame geladen wird. Sollte aufgerufen werden, nachdem das SDK initialisiert wurde.

Parameter

Sieg

Fenster

Seitenfensterobjekt.

Der Wert darf nicht null sein.

setReceiverDisplayStatus

statisch

setReceiverDisplayStatus(receiver, successCallback, errorCallback)

Legt den Namen des Empfängers und den Anzeigestatus fest. Wenn der Empfänger als inaktiv angezeigt werden soll, setzen Sie displayStatus auf null.

Nur gültig für BENUTZERDEFINIERTE Empfänger. Der displayStatus des Empfängers wird ignoriert, wenn dieser Empfänger CAST ist. Der Status des Übertragungsempfängers wird von der Empfängeranwendung aktualisiert.

Parameter

Empfänger

chrome.cast.Receiver

Der Empfänger.

Der Wert darf nicht null sein.

successCallback

Funktion()

Callback, wenn der Status festgelegt wurde.

errorCallback

function(non-null chrome.cast.Error)

Mögliche Fehler sind TIMEOUT, INVALID_PARAMETER, API_NOT_INITIALIZED und EXTENSION_MISSING.
Eingestellte Funktionen
Nicht unterstützt mit dem auf der Presentation API basierenden Cast SDK.

unescape

statisch

unescape(Escape) gibt einen String zurück

Entspricht einer Hilfsprogrammmethode für URI-maskierte Strings. Der Anzeigename für den Empfänger wird beispielsweise als URI-maskierter String zurückgegeben. Verwenden Sie diese Methode, um die Maskierung dieses Strings bei Bedarf aufzuheben.

Parameter

entkommen

String

Ein String, dessen Escapezeichen entfernt werden soll
Rückgaben

string Nicht maskierter String

Art der Zusammenfassung

ReceiverActionListener

statisch

ReceiverActionListener()