Klasse: CastReceiverContext

cast.framework.CastReceiverContext

class   static

Verwaltet das Laden der zugrunde liegenden Bibliotheken und initialisiert das zugrunde liegende Cast Receiver SDK.

Löst aus

non-null Error Wenn MediaElement nicht im Dokumenttext erstellt wird. Wenn mehrere Medienelemente erstellt werden, sollte der Entwickler die Klasse „castMediaElement“ auf eines davon festlegen. Dieses wird vom CAF-Empfänger verwendet.

Methoden

getInstance

statisch

getInstance() returns cast.framework.CastReceiverContext

Gibt die Singleton-Instanz CastReceiverContext zurück.

Rückgaben

non-null cast.framework.CastReceiverContext 

addCustomMessageListener

addCustomMessageListener(namespace, listener)

Richtet einen Nachrichten-Listener für einen benutzerdefinierten Nachrichtenkanal ein. Für einen Namespace ist mehr als ein Listener zulässig.

Parameter

Namespace

String

Der Namespace. Beachten Sie, dass einem gültigen Namespace der String „urn:x-cast:“ vorangestellt werden muss.

Listener

function(non-null cast.framework.system.Message)
Löst aus

Error Wenn das System nicht bereit ist oder der Namespace von dieser Anwendung nicht unterstützt wird.

addEventListener

addEventListener(type, handler)

Fügen Sie einen Listener zum Streamen von Systemereignissen hinzu.

Parameter

eingeben

cast.framework.system.EventType

Der Wert darf nicht null sein.

Handler

function(non-null cast.framework.system.Event)

canDisplayType

canDisplayType(mimeType, codecs, width, height, framerate) returns boolean

Prüft, ob die angegebenen Medienparameter von Video- oder Audiostreams von der Plattform unterstützt werden.

Parameter

mimeType

String

Medien-MIME-Typ. Sie besteht aus einem Typ und einem Untertyp, die durch einen Schrägstrich (/) getrennt sind. MIME-Typen vom Typ „Video“ oder „Audio“ können verwendet werden.

Codecs

Optional

String

Der String in Anführungszeichen enthält eine durch Kommas getrennte Liste von Formaten, wobei jedes Format einen Medienbeispieltyp angibt, der im Stream vorhanden ist.

width

Optional

Zahl

Beschreibt die horizontale Auflösung des Streams in Pixeln.

height

Optional

Zahl

Beschreibt die vertikale Auflösung des Streams in Pixeln.

Framerate

Optional

Zahl

Beschreibt die Framerate des Streams.
Rückgaben

boolean Ob der Stream über Chromecast wiedergegeben werden kann.

getApplicationData

getApplicationData() gibt cast.framework.system.ApplicationData zurück.

Stellt Anwendungsinformationen bereit, sobald das System bereit ist. Andernfalls ist der Wert null.

Rückgaben

nullable cast.framework.system.ApplicationData Die Anwendungsinformationen oder null, wenn das System nicht bereit ist.

getDeviceCapabilities

getDeviceCapabilities() gibt Objekt zurück

Stellt Informationen zu Gerätefunktionen bereit, sobald das System bereit ist. Andernfalls ist der Wert null. Wenn ein leeres Objekt zurückgegeben wird, legt das Gerät keine Funktionsinformationen offen.

Rückgaben

nullable Object Die Informationen zu den Gerätefunktionen (Schlüssel/Wert-Paare). Der Wert ist null, wenn das System noch nicht bereit ist. Wenn die Plattform keine Informationen zu Gerätefunktionen offenlegt, kann das Objekt leer sein.

getPlayerManager

getPlayerManager() gibt cast.framework.PlayerManager zurück.

Player-Instanz abrufen, die die Medienwiedergabe steuern und überwachen kann

Rückgaben

non-null cast.framework.PlayerManager 

getSender

getSender(senderId) gibt cast.framework.system.Sender zurück.

Absender nach Absender-ID abrufen

Parameter

senderId

String

Die ID des Absenders, der zurückgegeben werden soll.
Rückgaben

nullable cast.framework.system.Sender 

getSenders

getSenders() gibt ein Array von Nicht-Null-Wert cast.framework.system.Sender zurück.

Ruft eine Liste der aktuell verbundenen Absender ab.

Rückgaben

non-null Array of non-null cast.framework.system.Sender 

getStandbyState

getStandbyState() gibt cast.framework.system.StandbyState zurück.

Gibt an, ob sich der HDMI-Eingang der Streaming-App im Stand-by-Modus befindet.

Rückgaben

non-null cast.framework.system.StandbyState Gibt an, ob sich der HDMI-Eingang der Anwendung im Standby-Modus befindet. Wenn sie nicht ermittelt werden kann, weil der Fernseher beispielsweise keine CEC-Befehle unterstützt, wird der Wert UNKNOWN zurückgegeben.

getSystemState

getSystemState() returns cast.framework.system.SystemState

Liefert Anwendungsinformationen über den Systemstatus.

Rückgaben

non-null cast.framework.system.SystemState Systemstatus

getVisibilityState

getViewableState() gibt cast.framework.system.VisibilityState zurück.

Gibt an, ob die Streaming-App der aktive HDMI-Eingang ist.

Rückgaben

non-null cast.framework.system.VisibilityState Gibt an, ob die Anwendung der aktive HDMI-Eingang ist. Wenn sie nicht ermittelt werden kann, weil der Fernseher beispielsweise keine CEC-Befehle unterstützt, wird der Wert UNKNOWN zurückgegeben.

isSystemReady

isSystemReady() gibt einen booleschen Wert zurück

Wenn die Anwendungsaufrufe gestartet werden, sendet das System das Bereitschaftsereignis, um anzugeben, dass die Anwendungsinformationen bereit sind. Die Anwendung kann Nachrichten senden, sobald ein Sender verbunden ist.

Rückgaben

boolean Gibt an, ob das System Nachrichten verarbeiten kann.

loadPlayerLibraries

loadPlayerLibraries(useLegacyDashSupport)

Laden Sie den Player-JS-Code. Damit kann der JS-Code des Players in einer frühen Phase beim Starten des Empfängers vor dem Aufruf von start geladen werden. Diese Funktion ist ein No-Op, wenn Spieler bereits geladen wurden (Start wurde aufgerufen).

Parameter

useLegacyDashSupport

Optional

boolean

Gibt an, dass MPL für DASH-Inhalte verwendet werden soll.

removeCustomMessageListener

removeCustomMessageListener(namespace, listener)

Entfernt einen Nachrichten-Listener, der zuvor bei CastReceiverContext#addCustomMessageListener registriert war.

Parameter

Namespace

String

Der Namespace. Beachten Sie, dass einem gültigen Namespace der String „urn:x-cast:“ vorangestellt werden muss.

Listener

function(non-null cast.framework.system.Message)

Die Nachrichten-Listener-Funktion, deren Registrierung aufgehoben werden soll.
Löst aus

Error Wenn das System nicht bereit ist oder der Namespace von dieser Anwendung nicht unterstützt wird.

removeEventListener

removeEventListener(type, handler)

Entfernen Sie den Listener, um Systemereignisse zu streamen.

Parameter

eingeben

cast.framework.system.EventType

Der Wert darf nicht null sein.

Handler

function(non-null cast.framework.system.Event)

sendCustomMessage

sendCustomMessage(namespace, senderId, data)

Sendet eine Nachricht an einen bestimmten Absender.

Parameter

Namespace

String

Der Namespace. Beachten Sie, dass einem gültigen Namespace der String „urn:x-cast:“ vorangestellt werden muss.

senderId

(String oder nicht definiert)

Die Absender-ID oder nicht definiert für die Übertragung an alle Absender.

daten

Alle Typen

Die Nachrichtennutzlast.

Der Wert darf nicht null sein.
Löst aus

Error Wenn bei der Vorbereitung der Nachricht ein Fehler aufgetreten ist.

sendFeedbackMessage

sendFeedbackMessage(feedbackMessage)

Diese Funktion sollte als Reaktion auf das Ereignis „feedbackstarted“ aufgerufen werden, wenn die Anwendung Informationen zum Fehlerbehebungsstatus hinzufügt, um sich im Feedbackbericht zu protokollieren. Er nimmt den Parameter "message" an, bei dem es sich um einen String handelt, der die Informationen zur Fehlerbehebung darstellt, die die Anwendung protokollieren möchte.

Parameter

feedbackMessage

String
Eingestellte Funktionen
Cast.framework.CastReceiverContext#setFeedbackHandler verwenden

setApplicationState

setApplicationState(statusText)

Legt den Anwendungsstatus fest. Die Anwendung sollte dies aufrufen, wenn sich ihr Status ändert. Ist der Wert nicht definiert oder auf einen leeren String festgelegt, wird der bei der Registrierung der Anwendung festgelegte Wert des Anwendungsnamens standardmäßig für den Anwendungsstatus verwendet.

Parameter

statusText

String

Der Statustext.

setFeedbackHandler

setFeedbackHandler(feedbackHandler)

Legen Sie einen Handler fest, um einem Feedbackbericht zusätzliche Daten zur Verfügung zu stellen. Der Handler wird aufgerufen, wenn ein gemeldetes Feedback erstellt wird, und sollte zusätzliche Daten als String oder als String-Promise zurückgeben. Das Rückgabeversprechen sollte innerhalb von 5 Sekunden aufgelöst werden, damit es in den Bericht aufgenommen wird.

Parameter

feedbackHandler

Funktion()

Der Wert kann null sein.

setInactivityTimeout

setInactivityTimeout(maxInactivity)

Legt das Zeitlimit für die Inaktivität des Empfängers fest. Es wird empfohlen, beim Aufrufen von „Start“ den maximalen Inaktivitätswert festzulegen und ihn nicht zu ändern. Diese API wird nur zu Entwicklungs-/Debugging-Zwecken bereitgestellt.

Parameter

maxInactivity

Zahl

Das Intervall in Sekunden, bevor eine nicht reagierende Verbindung geschlossen wird.

setLoggerLevel

setLoggerLevel(level)

Legt den Ausführlichkeitsgrad des Logs fest.

Parameter

level

cast.framework.LoggerLevel

Die Protokollierungsebene.

Der Wert darf nicht null sein.

start

start(options) gibt cast.framework.CastReceiverContext zurück.

Initialisiert den Systemmanager und den Medienmanager, damit die Empfänger-App Anfragen von Absendern empfangen kann.

Parameter

Optionen

(un-null cast.framework.CastReceiverOptions oder optionales Nicht-Null-Objekt)
Rückgaben

non-null cast.framework.CastReceiverContext 

Zwischenstopp

stop()

Empfängeranwendung herunterfahren.