Klasse: CastReceiverContext

cast.framework.CastReceiverContext

class   static

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

Löst

non-null Error Wenn MediaElement nicht im Dokumentbody erstellt wird. Wenn mehrere Media-Elemente erstellt werden, sollte der Entwickler die Klasse „castMediaElement“ für eines der Elemente festlegen, das vom CAF-Receiver verwendet wird.

Methoden

getInstance

static

getInstance() gibt cast.framework.CastReceiverContext zurück.

Gibt die Singleton-Instanz von CastReceiverContext zurück.

Ausgabe

non-null cast.framework.CastReceiverContext 

addCustomMessageListener

addCustomMessageListener(namespace, listener)

Richtet einen Nachrichtenlistener für einen benutzerdefinierten Nachrichtenkanal ein. Für einen Namespace sind mehrere Listener zulässig.

Parameter

Namespace

String

Der Namespace. Ein gültiger Namespace muss mit dem String „urn:x-cast:“ beginnen.

Listener

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

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

addEventListener

addEventListener(type, handler)

Listener für Cast-Systemereignisse hinzufügen

Parameter

Typ

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 Media-Parameter von Video- oder Audio-Streams von der Plattform unterstützt werden.

Parameter

mimeType

String

MIME-Typ der Media. Sie besteht aus einem Typ und einem Untertyp, die durch ein „/“ getrennt sind. Es kann sich entweder um Video- oder Audio-MIME-Typen handeln.

Codecs

Optional

String

„Quoted-string“ enthält eine durch Kommas getrennte Liste von Formaten, wobei jedes Format einen Mediaprobe-Typ angibt, der im Stream vorhanden ist.

Breite

Optional

Zahl

Beschreibt die horizontale Auflösung des Streams in Pixeln.

Höhe

Optional

Zahl

Beschreibt die vertikale Auflösung des Streams in Pixeln.

framerate

Optional

Zahl

Beschreibt die Framerate des Streams.
Ausgabe

boolean Gibt an, ob der Stream auf Chromecast abgespielt werden kann.

getApplicationData

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

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

Ausgabe

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

getDeviceCapabilities

getDeviceCapabilities() gibt cast.receiver.CastReceiverManager.DeviceCapabilitiesObj zurück.

Stellt Informationen zu den Gerätefunktionen bereit, sobald das System bereit ist. Andernfalls ist der Wert „null“. Wenn ein leeres Objekt zurückgegeben wird, stellt das Gerät keine Informationen zu Funktionen bereit.

Ausgabe

nullable cast.receiver.CastReceiverManager.DeviceCapabilitiesObj Informationen zu den Gerätefunktionen (Schlüssel/Wert-Paare). Sie ist „null“, wenn das System noch nicht bereit ist. Es kann ein leeres Objekt sein, wenn die Plattform keine Informationen zu Gerätefunktionen bereitstellt.

getDeviceInformation

getDeviceInformation() gibt cast.receiver.CastReceiverManager.DeviceInformationObj zurück

Stellt nicht fähigkeitsbezogene Geräteidentifikationsinformationen bereit, sobald das System bereit ist. Andernfalls ist der Wert „null“. Wenn ein leeres Objekt zurückgegeben wird, stellt das Gerät keine solchen Informationen zur Verfügung.

Ausgabe

nullable cast.receiver.CastReceiverManager.DeviceInformationObj Die Geräteinformationen (Schlüssel/Wert-Paare). Sie ist null, wenn das System noch nicht bereit ist. Es kann ein leeres Objekt sein, wenn die Plattform diese Informationen nicht zur Verfügung stellt.

getPlayerManager

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

Ruft eine Player-Instanz ab, mit der die Medienwiedergabe gesteuert und überwacht werden kann.

Ausgabe

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 zurückzugebenden Absenders.
Ausgabe

nullable cast.framework.system.Sender 

getSenders

getSenders() returns Array of non-null cast.framework.system.Sender

Ruft eine Liste der aktuell verbundenen Absender ab.

Ausgabe

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 Cast-Anwendung im Stand-by-Modus befindet.

Ausgabe

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

getSystemState

getSystemState() gibt cast.framework.system.SystemState zurück.

Stellt Anwendungsinformationen zum Systemstatus bereit.

Ausgabe

non-null cast.framework.system.SystemState Der Systemstatus.

getVisibilityState

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

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

Ausgabe

non-null cast.framework.system.VisibilityState Gibt an, ob die Anwendung der aktive HDMI-Eingang ist. Wenn der Status 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 Anwendungsanrufe gestartet werden, sendet das System das Ereignis „Bereit“, um anzugeben, dass die Anwendungsinformationen bereit sind und die Anwendung Nachrichten senden kann, sobald ein Absender verbunden ist.

Ausgabe

boolean Ob das System bereit ist, Nachrichten zu verarbeiten.

loadPlayerLibraries

loadPlayerLibraries(useLegacyDashSupport)

Laden von Player-JS starten Damit kann der JavaScript-Code des Players in einer frühen Phase des Startens des Receivers geladen werden, bevor „start“ aufgerufen wird. Diese Funktion ist managementfrei, wenn die Player 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 mit CastReceiverContext#addCustomMessageListener registriert wurde.

Parameter

Namespace

String

Der Namespace. Ein gültiger Namespace muss mit dem String „urn:x-cast:“ beginnen.

Listener

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

Die Funktion zum Abmelden des Nachrichten-Listeners.
Löst

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 für das Übertragen von Systemereignissen.

Parameter

Typ

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. Ein gültiger Namespace muss mit dem String „urn:x-cast:“ beginnen.

senderId

(String oder nicht definiert)

Die senderId oder „undefined“ für Broadcast an alle Absender.

Daten

Alle Typen

Die Nutzlast der Nachricht.

Der Wert darf nicht null sein.
Löst

Error Wenn beim Vorbereiten der Nachricht ein Fehler aufgetreten ist.

sendFeedbackMessage

sendFeedbackMessage(feedbackMessage)

Diese Funktion sollte als Reaktion auf das Ereignis „feedbackstarted“ aufgerufen werden, wenn die Anwendung dem Feedbackbericht Debugging-Statusinformationen hinzufügen soll. Sie akzeptiert einen Parameter „message“, der ein String ist, der die Debugging-Informationen darstellt, die die Anwendung protokollieren möchte.

Parameter

feedbackMessage

String
Verworfen
cast.framework.CastReceiverContext#setFeedbackHandler verwenden

setApplicationState

setApplicationState(statusText)

Legt den Anwendungsstatus fest. Die Anwendung sollte diese Methode aufrufen, wenn sich ihr Status ändert. Wenn der Wert nicht definiert oder auf eine leere Zeichenfolge festgelegt ist, wird standardmäßig der Wert von „Application Name“ (Anwendungsname) verwendet, der bei der Anwendungsregistrierung festgelegt wurde.

Parameter

statusText

String

Der Statustext.

setFeedbackHandler

setFeedbackHandler(feedbackHandler)

Legen Sie einen Handler fest, um einem Feedbackbericht zusätzliche Daten hinzuzufügen. Der Handler wird aufgerufen, wenn ein Feedbackbericht erstellt wird, und sollte zusätzliche Daten als String oder String-Promise zurückgeben. Das Rückgabeversprechen muss innerhalb von 5 Sekunden beantwortet werden, damit es in den Bericht aufgenommen wird.

Parameter

feedbackHandler

function()

Der Wert kann null sein.

setInactivityTimeout

setInactivityTimeout(maxInactivity)

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

Parameter

maxInactivity

Zahl

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

setLoggerLevel

setLoggerLevel(level)

Legt die Ausführlichkeitsstufe für das Logging fest.

Parameter

Level

cast.framework.LoggerLevel

Die Logging-Ebene.

Der Wert darf nicht null sein.

start

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

Initialisiert den Systemmanager und den Media Manager, damit die Receiver-App Anfragen von Absendern empfangen kann.

Parameter

Optionen

(nicht null cast.framework.CastReceiverOptions oder optionales nicht null-Objekt)
Ausgabe

non-null cast.framework.CastReceiverContext 

stop

stop()

Empfängeranwendung herunterfahren