Klasse: CastReceiverContext

cast.framework.CastReceiverContext

class   static

Verwaltet das Laden der zugrunde liegenden Bibliotheken und initialisiert das zugrunde liegende Cast-Empfänger-SDK.

Löst

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

Methoden

getInstance

static

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

Gibt die Singleton-Instanz „CastReceiverContext“ zurück.

Ausgabe

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. Beachte, dass einem gültigen Namespace der String „urn:x-cast:“ vorangestellt werden muss.
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) gibt einen booleschen Wert zurück

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

Parameter
mimeType	String MIME-Typ des Mediums. Er besteht aus einem Typ und einem Untertyp, die durch ein „/“ getrennt sind. Es kann sich entweder um einen Video- oder einen Audio-MIME-Typ handeln.
Codecs	Optional String Der String in Anführungszeichen enthält eine durch Kommas getrennte Liste von Formaten, wobei jedes Format einen im Stream vorhandenen Medienbeispieltyp angibt.
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.framework.system.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 den Funktionen bereit.

Ausgabe

nullable cast.framework.system.DeviceCapabilitiesObj Die Informationen zu den Gerätefunktionen (Schlüssel/Wert-Paare). Der Wert 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.framework.system.DeviceInformationObj zurück.

Stellt nicht funktionsbezogene Identifikationsinformationen zum Gerät 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 bereit.

Ausgabe

nullable cast.framework.system.DeviceInformationObj Die Geräteinformationen (Schlüssel/Wert-Paare). Der Wert ist null, wenn das System noch nicht bereit ist. Es kann ein leeres Objekt sein, wenn die Plattform diese Informationen nicht bereitstellt.

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 Absenders, die zurückgegeben werden soll.

Ausgabe

nullable cast.framework.system.Sender 

getSenders

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

Ruft eine Liste der derzeit verbundenen Absender ab.

Ausgabe

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

getStandbyState

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

Meldet, 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 oder nicht. Wenn dies nicht möglich ist, weil der Fernseher beispielsweise keine CEC-Befehle unterstützt, wird der Wert 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-Anwendung der aktive HDMI-Eingang ist.

Ausgabe

non-null cast.framework.system.VisibilityState Gibt an, ob die Anwendung der aktive HDMI-Eingang ist. Wenn dies nicht möglich ist, 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 beginnen, sendet das System das Ereignis „ready“, um anzugeben, dass die Anwendungsinformationen bereit sind und die Anwendung Nachrichten senden kann, sobald ein Absender verbunden ist.

Ausgabe

boolean Gibt an, ob das System bereit ist, Nachrichten zu verarbeiten.

loadPlayerLibraries

loadPlayerLibraries(useLegacyDashSupport)

Laden der Player-JS starten. Damit kann der JS-Code des Players in einer frühen Phase des Startens des Empfängers geladen werden, bevor „start“ aufgerufen wird. Diese Funktion ist ein No-Op, wenn die Player bereits geladen wurden (Start wurde aufgerufen).

Parameter
useLegacyDashSupport	Optional boolean Geben Sie an, dass MPL für DASH-Inhalte verwendet werden soll.

removeCustomMessageListener

removeCustomMessageListener(namespace, listener)

Entfernt einen zuvor mit CastReceiverContext#addCustomMessageListener registrierten Nachrichten-Listener.

Parameter
Namespace	String Der Namespace. Beachte, dass einem gültigen Namespace der String „urn:x-cast:“ vorangestellt werden muss.
Listener	function(non-null cast.framework.system.Message) Die Funktion des Nachrichten-Listeners, die abgemeldet werden soll.

Löst

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

removeEventListener

removeEventListener(type, handler)

Listener für Cast-Systemereignisse entfernen.

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. Beachte, dass einem gültigen Namespace der String „urn:x-cast:“ vorangestellt werden muss.
senderId	(String oder nicht definiert) Die senderId oder „undefined“ für die Übertragung an alle Absender.
Daten	Alle Typen Die Nachrichtennutzlast. 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 Informationen zum Debug-Status hinzufügt. Sie verwendet den Parameter „message“, einen String, der die Debugging-Informationen darstellt, die die Anwendung protokollieren soll.

Parameter
feedbackMessage	String

Verworfen

Verwende cast.framework.CastReceiverContext#setFeedbackHandler

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 einen leeren String festgelegt ist, wird standardmäßig der Wert des Anwendungsnamens verwendet, der bei der Anwendungsregistrierung für den Anwendungsstatus festgelegt wurde.

Parameter
statusText	String Der Statustext.

setFeedbackHandler

setFeedbackHandler(feedbackHandler)

Legen Sie einen Handler fest, um zusätzliche Daten für einen Feedbackbericht bereitzustellen. Der Handler wird aufgerufen, wenn ein Feedbackbericht erstellt wird, und sollte zusätzliche Daten als String oder String-Promise zurückgeben. Das Rückgabe-Promise sollte innerhalb von 5 Sekunden aufgelöst werden, damit es in den Bericht aufgenommen wird.

Parameter
feedbackHandler	function() Der Wert kann null sein.

setInactivityTimeout

setInactivityTimeout(maxInactivity)

Legt das Zeitlimit für die 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 für Entwicklungs- und Debugging-Zwecke bereitgestellt.

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

setLoggerLevel

setLoggerLevel(level)

Legt den Ausführlichkeitsgrad für 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 System- und den Media-Manager, damit die Empfänger-App Anfragen von Absendern empfangen kann.

Parameter
Optionen	(cast.framework.CastReceiverOptions, nicht null, oder optionales Objekt, nicht null)

Ausgabe

non-null cast.framework.CastReceiverContext 

stop

stop(closeReason)

Empfänger-App herunterfahren.

Parameter

closeReason

Optional cast.framework.common.CloseReason Der optionale Grund für das Schließen, der angibt, warum die Empfänger-App beendet wird. Wenn kein Grund angegeben wird, leitet das Framework den Grund aus den letzten Mediaplayer-Ereignissen ab oder greift auf APP_REQUEST zurück. Übergeben Sie einen der folgenden numerischen Werte: 13 (APP_CUSTOM_STOP): Für benutzerdefinierte Empfänger-UI-/Geschäftsaktionen (z.B. wenn der Nutzer auf eine In-App-Schaltfläche „Beenden“ oder „Schließen“ klickt, benutzerdefinierte Empfängernavigation weg vom Streamen). 15 (APP_ERROR): Schwerwiegende Fehler auf Anwendungsebene (z.B. benutzerdefinierte Authentifizierungsfehler, Fehler beim Abrufen von DRM/Lizenzen, Abstürze der Backend-API), die außerhalb der integrierten Player-Fehlerereignisse von CAF auftreten. 14 (APP_PLAYBACK_FINISHED): Die App hat ihre Playlist/Wiedergabeliste abgespielt oder eine eigenständige Medienwiedergabe abgeschlossen. 6 (APP_REQUEST): Allgemeiner/Legacy-Fallback, wenn eine Anwendung die Beendigung ohne einen spezifischeren Grund anfordert. Der Wert darf nicht null sein.