Klasse: PlayerManager

Methoden

addEventListener

addEventListener(eventType, eventListener)

Fügt einen Event-Listener hinzu, der auf Wiedergabeereignisse wartet.

Parameter

eventType

(nicht null cast.framework.events.EventType oder nicht null Array von nicht null cast.framework.events.EventType)

Ein Ereignistyp oder ein Array von Ereignistypen

eventListener

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

Löst

non-null Error Wenn die angegebenen Argumente ungültig sind.

addSupportedMediaCommands

addSupportedMediaCommands(supportedMediaCommands, broadcastStatus)

Fügt der vorhandenen Liste unterstützter Medienbefehle neue unterstützte Befehle hinzu.

Parameter

supportedMediaCommands

Zahl

Eine Bitmaske der von der Anwendung unterstützten Medienbefehle.

broadcastStatus

Optional

boolean

true gibt an, dass die Absender über die Änderung benachrichtigt werden sollen. Wenn dieser Wert nicht angegeben ist, werden die Absender benachrichtigt.

Weitere Informationen
cast.framework.messages.Command

broadcastStatus

broadcastStatus(includeMedia, requestId, customData, includeQueueItems)

Sendet eine Medienstatusnachricht an alle Absender (Broadcast). Anwendungen verwenden dies, um eine benutzerdefinierte Statusänderung zu senden.

Parameter

includeMedia

Optional

boolean

true gibt an, dass die Nachricht Medieninformationen enthalten soll.

requestId

Optional

Zahl

Die ID der eingehenden Anfrage, die diese Antwort ausgelöst hat.

customData

Optional

Objekt

Die Statusmeldung enthält anwendungsspezifische benutzerdefinierte Daten.

Der Wert kann null sein.

includeQueueItems

Optional

boolean

Gibt an, ob Warteschlangenelemente in die Statusmeldung aufgenommen werden sollen. Standardmäßig sind sie nicht enthalten.

getAbsoluteTimeForMediaTime

getAbsoluteTimeForMediaTime(mediaTime) returns number

Konvertiert die Media-Zeit in die absolute Media-Zeit. Die absolute Zeit gilt nur für Livestreams.

Parameter

mediaTime

Zahl

Media-Zeit.

Ausgabe

nullable number Absolute Zeit oder null, falls nicht verfügbar.

getAudioTracksManager

getAudioTracksManager() gibt cast.framework.AudioTracksManager zurück.

Gibt die AudioTracksManager-Instanz zurück.

Ausgabe

non-null cast.framework.AudioTracksManager 

getBreakClipCurrentTimeSec

getBreakClipCurrentTimeSec() gibt „number“ zurück

Gibt die aktuelle Zeit des aktuell wiedergegebenen Pausenclips in Sekunden zurück.

Ausgabe

nullable number Aktuelle Zeit in Sekunden im aktuellen Unterbrechungsclip. null, wenn Player nicht als Pausenclip abgespielt wird.

getBreakClipDurationSec

getBreakClipDurationSec() gibt „number“ zurück

Gibt die Dauer des aktuell wiedergegebenen Pausenclips in Sekunden zurück.

Ausgabe

nullable number Dauer des aktuellen Pausenclips. null, wenn auf dem Player kein Pausenclip abgespielt wird.

getBreakManager

getBreakManager() gibt cast.framework.breaks.BreakManager zurück.

Gibt die BreakManager-Instanz zurück.

Ausgabe

non-null cast.framework.breaks.BreakManager 

getBreaks

getBreaks() returns Array of non-null cast.framework.messages.Break

Gibt eine Liste von Pausen zurück.

Ausgabe

non-null Array of non-null cast.framework.messages.Break 

getCurrentSupportedMediaCommands

getCurrentSupportedMediaCommands() gibt eine Zahl zurück

Ruft die aktuellen vom Empfänger unterstützten Medienbefehle ab. Im Gegensatz zu getSupportedMediaCommands() ändert sich der zurückgegebene Wert dieser Methode dynamisch basierend auf dem aktuellen Wiedergabestatus. Beispiel: Während der Anzeigenwiedergabe wird der Befehl SEEK möglicherweise nicht unterstützt. Diese Methode sollte nur nach dem Aufrufen von CastReceiverContext#start aufgerufen werden. Andernfalls wird 0 zurückgegeben.

Weitere Informationen
cast.framework.messages.Command
Ausgabe

number Eine Bitmaske der von der Anwendung unterstützten Medienbefehle.

getCurrentTimeSec

getCurrentTimeSec() gibt eine Zahl zurück

Ruft die verstrichene Wiedergabezeit der aktuellen Medien ab.

Ausgabe

number Die verstrichene Zeit in Sekunden. Dieser Wert ist 0, wenn keine Medien wiedergegeben werden.

getDurationSec

getDurationSec() gibt „number“ zurück

Ruft die Dauer der aktuell wiedergegebenen Medien in Sekunden ab.

Ausgabe

number Dauer des Mediums. NaN, wenn keine Medien abgespielt werden.

getLiveSeekableRange

getLiveSeekableRange() gibt cast.framework.messages.LiveSeekableRange zurück.

Gibt den durchsuchbaren Bereich des Livestreams mit Start- und Endzeit in Sekunden zurück. Die Werte basieren auf der Media-Zeit.

Ausgabe

nullable cast.framework.messages.LiveSeekableRange 

getMediaInformation

getMediaInformation() gibt cast.framework.messages.MediaInformation zurück.

Ruft Medieninformationen zu den aktuellen Medien ab.

Ausgabe

nullable cast.framework.messages.MediaInformation 

getMediaTimeForAbsoluteTime

getMediaTimeForAbsoluteTime(absoluteTime) returns number

Konvertiert die absolute Zeit des Mediums in die Media-Zeit. Die absolute Zeit gilt nur für Livestreams.

Parameter

absoluteTime

Zahl

Die absolute Zeit des Mediums als UNIX-Epochenzeit (Sekunden seit der UNIX-Epoche).

Ausgabe

nullable number Media-Zeit oder null, falls nicht verfügbar.

getPlaybackConfig

getPlaybackConfig() gibt cast.framework.PlaybackConfig zurück.

Gibt die Wiedergabekonfiguration oder null zurück, wenn die Standardeinstellungen nicht überschrieben wurden.

Ausgabe

nullable cast.framework.PlaybackConfig 

getPlaybackRate

getPlaybackRate() gibt „number“ zurück

Gibt die aktuelle Wiedergabegeschwindigkeit zurück. Gibt 1 zurück, bevor der Empfänger CastReceiverContext#start aufgerufen wird.

Ausgabe

number Aktuelle Wiedergaberate.

getPlayerState

getPlayerState() gibt cast.framework.messages.PlayerState zurück.

Ruft den Player-Status ab.

Ausgabe

non-null cast.framework.messages.PlayerState Der Status des aktuellen Player.

getPreferredPlaybackRate

getPreferredPlaybackRate() gibt eine Zahl zurück

Die bevorzugte Wiedergabegeschwindigkeit wird abgerufen. Kann beim Herunterfahren verwendet werden, um die zuletzt bevorzugte Wiedergaberate im permanenten Speicher zu speichern, damit sie in der nächsten Sitzung in den Cast-Optionen verwendet werden kann.

Ausgabe

number 

getPreferredTextLanguage

getPreferredTextLanguage() gibt String zurück

Ruft die bevorzugte Sprache für Text-Tracks ab.

Ausgabe

nullable string 

getPreferredTextStyle

getPreferredTextStyle() gibt cast.framework.messages.TextTrackStyle zurück.

Ruft den bevorzugten Text-Track-Stil ab.

Ausgabe

nullable cast.framework.messages.TextTrackStyle 

getQueueManager

getQueueManager() returns (cast.framework.QueueManager or undefined)

Gibt die QueueManager-Instanz zurück.

Ausgabe

(non-null cast.framework.QueueManager or undefined) 

getRawCurrentTimeSec

getRawCurrentTimeSec() gibt „number“ zurück

Gibt die verstrichene Wiedergabezeit der aktuellen Media zurück, ohne die Zeit der Werbeunterbrechung abzuziehen.

Ausgabe

number Die verstrichene Zeit in Sekunden. Dieser Wert ist 0, wenn keine Medien wiedergegeben werden.

getRawSeekableRange

getRawSeekableRange() returns cast.framework.messages.Range

Gibt den aktuellen suchbaren Bereich für Media zurück.

HINWEIS: Dies entspricht den Einheiten von getRawCurrentTimeSec(), aber nicht seek(). Anzeigen oder andere Media-Offsets werden nicht berücksichtigt. Sofern Sie nicht sicher sind, dass Sie die Rohwerte benötigen, sollten Sie stattdessen getLiveSeekableRange() verwenden.

Ausgabe

nullable cast.framework.messages.Range 

getStartAbsoluteTime

getStartAbsoluteTime() returns number

Gibt die absolute Startzeit des Mediums als UNIX-Epochenzeit (Sekunden seit der UNIX-Epoche) zurück. Die absolute Zeit gilt nur für Livestreams.

Ausgabe

nullable number 

getStats

getStats() gibt cast.framework.stats.Stats zurück.

Gibt Wiedergabestatistiken zurück. Statistiken werden gegebenenfalls für die gesamte Wiedergabesitzung zusammengefasst.

Ausgabe

non-null cast.framework.stats.Stats 

getSupportedMediaCommands

getSupportedMediaCommands() gibt „number“ zurück

Ruft die vom Empfänger unterstützten Medienbefehle ab. Sollte nur nach dem Aufrufen von CastReceiverContext#start() aufgerufen werden. Andernfalls wird 0 zurückgegeben. Der Wert für unterstützte Media-Befehle wird ausschließlich von der Empfängeranwendung gesteuert . Sie wird nicht automatisch auf Grundlage einer MediaStatus aktualisiert.

Weitere Informationen
cast.framework.messages.Command
Ausgabe

number Eine Bitmaske der von der Anwendung unterstützten Medienbefehle.

getTextTracksManager

getTextTracksManager() gibt cast.framework.TextTracksManager zurück.

Gibt die TextTracksManager-Instanz zurück.

Ausgabe

non-null cast.framework.TextTracksManager 

getTimedMetadata

getTimedMetadata() gibt ein Array von nicht leeren cast.framework.TimedMetadata zurück.

Gibt Zeitmetadaten zurück, die beim Parsen des Manifests gefunden wurden. Dies ist #EXT-X-DATERANGE in HLS und EventStream in DASH.

Ausgabe

non-null Array of non-null cast.framework.TimedMetadata 

load

load(loadRequest) gibt Promise mit „void“ zurück

Leitet eine Anfrage zum Laden von Media ein.

Parameter

loadRequest

cast.framework.messages.LoadRequestData

Ein Request zum Laden von Media.

Der Wert darf nicht null sein.

Ausgabe

non-null Promise containing void Promise, das aufgelöst wird, wenn der Vorgang erfolgreich war, oder abgelehnt wird, wenn er fehlgeschlagen ist.

Pause

pause()

Pausiert die aktuelle Medienwiedergabe.

play

play()

Spielt die aktuell pausierten Medien ab.

removeEventListener

removeEventListener(eventType, eventListener)

Entfernt den Event-Listener, der für ein bestimmtes Wiedergabeereignis hinzugefügt wurde. Wenn kein passender Event-Listener vorhanden ist, wird dieser Aufruf ignoriert.

Parameter

eventType

(nicht null cast.framework.events.EventType oder nicht null Array von nicht null cast.framework.events.EventType)

Ein eventType oder ein Array von Ereignistypen

eventListener

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

removeSupportedMediaCommands

removeSupportedMediaCommands(supportedMediaCommands, broadcastStatus)

Befehle aus der Liste der unterstützten Medienbefehle entfernen

Parameter

supportedMediaCommands

Zahl

Eine Bitmaske der von der Anwendung unterstützten Medienbefehle.

broadcastStatus

Optional

boolean

true gibt an, dass die Absender über die Änderung benachrichtigt werden sollen. Wenn dieser Wert nicht angegeben ist, werden die Absender benachrichtigt.

Weitere Informationen
cast.framework.messages.Command

Community

seek(seekTime)

Sucht im aktuellen Medium.

Parameter

seekTime

Zahl

sendCustomState

sendCustomState(state)

Sendet einen benutzerdefinierten Status von der Wiedergabelogik einer Anwendung an die UI-Logik. Diese Methode trägt dazu bei, die Wiedergabelogik und die Benutzeroberfläche zu trennen. Durch die Trennung von Logik und Benutzeroberfläche kann dieselbe UI-Logik sowohl für die lokale Wiedergabe als auch für die Fernbedienung verwendet werden. Der benutzerdefinierte Status, der mit dieser Methode gesendet wird, ist über PlayerData in der Benutzeroberfläche verfügbar.

Parameter

Bundesstaat

Objekt

Benutzerdefiniertes Statusobjekt.

Der Wert darf nicht null sein.

Weitere Informationen
cast.framework.ui.PlayerData#customState

sendError

sendError(senderId, requestId, type, reason, customData)

Sendet eine Fehlermeldung an einen bestimmten Absender.

Parameter

senderId

String

Die Absender-ID.

requestId

Zahl

Die ID der eingehenden Anfrage, die diesen Fehler verursacht hat.

Typ

cast.framework.messages.ErrorType

Der Fehlertyp.

Der Wert darf nicht null sein.

reason

Optional

cast.framework.messages.ErrorReason

Die Fehlerursache.

Der Wert kann null sein.

customData

Optional

Objekt

Die Fehlermeldung enthält anwendungsspezifische benutzerdefinierte Daten.

Der Wert kann null sein.

sendLocalMediaRequest

sendLocalMediaRequest(request)

Sendet eine Anfrage für lokale Medien.

Parameter

Anfrage

cast.framework.messages.RequestData

Der Wert darf nicht null sein.

sendStatus

sendStatus(senderId, requestId, includeMedia, customData, includeQueueItems)

Sendet eine Medienstatusnachricht an einen bestimmten Absender.

Parameter

senderId

String

Die Absender-ID.

requestId

Zahl

Die ID der eingehenden Anfrage, die diese Antwort ausgelöst hat.

includeMedia

Optional

boolean

true gibt an, dass die Nachricht eine MediaInformation-Instanz enthalten sollte.

customData

Optional

Objekt

Die Statusmeldung enthält anwendungsspezifische benutzerdefinierte Daten.

Der Wert kann null sein.

includeQueueItems

Optional

boolean

Gibt an, ob Warteschlangenelemente in die Statusmeldung aufgenommen werden sollen. Standardmäßig sind sie nicht enthalten.

setIdleReason

setIdleReason(idleReason)

Legt den Grund dafür fest, dass sich der Player im Status IDLE befindet. Dadurch können Anwendungen, die den IDLE-Status erzwingen möchten, den Grund dafür angeben, z. B. einen benutzerdefinierten Fehler. Der Grund für den Leerlauf wird in der nächsten Statusmeldung gesendet. Hinweis: Bei den meisten Anwendungen muss dieser Wert nicht festgelegt werden. Sie ist nur erforderlich, wenn die App unter besonderen Umständen in den Status IDLE wechseln muss und der Standardwert für „idleReason“ nicht dem beabsichtigten Verhalten entspricht.Player

Parameter

idleReason

cast.framework.messages.IdleReason

Der Grund für den Status IDLE.

Der Wert darf nicht null sein.

setMediaElement

setMediaElement(mediaElement)

Legt den zu verwendenden HTMLMediaElement fest. Wenn ein Promise einer HTMLMediaElement festgelegt ist, beginnt die Medienwiedergabe, nachdem der Promise aufgelöst wurde.

Parameter

mediaElement

(nicht null HTMLMediaElement oder nicht null Promise mit nicht null HTMLMediaElement)

MediaElement, die vom Player verwendet werden.

setMediaInformation

setMediaInformation(mediaInformation, opt_broadcast)

Legt Medieninformationen fest.

Parameter

mediaInformation

cast.framework.messages.MediaInformation

Der Wert darf nicht null sein.

opt_broadcast

Optional

boolean

setMediaPlaybackInfoHandler

setMediaPlaybackInfoHandler(handler)

Legt einen Handler fest, der cast.framework.PlaybackConfig für eine bestimmte Ladeanfrage zurückgibt oder ändert. Die Handler-Parameter sind die LoadRequestData und die Standard-PlaybackConfig für den Empfänger (im CastReceiverOptions angegeben). Der Handler sollte eine geänderte Wiedergabekonfiguration oder null zurückgeben, um die Wiedergabe der Medien zu verhindern. Der Rückgabewert kann auch ein Promise sein, damit auf Daten vom Server gewartet werden kann.

Parameter

Handler

function(non-null cast.framework.messages.LoadRequestData, non-null cast.framework.PlaybackConfig)

Eine Funktion, die eine anfragespezifische Wiedergabekonfiguration bereitstellt.

Der Wert kann null sein.

setMediaUrlResolver

setMediaUrlResolver(resolver)

Legt einen Handler fest, der die Media-URL für eine LOAD-Anfrage zurückgibt. Mit diesem Handler kann verhindert werden, dass die Media-Content-URL als Teil des Media-Status veröffentlicht wird. Standardmäßig wird das Media-contentId als Content-URL verwendet.

Parameter

Resolver

function(non-null cast.framework.messages.LoadRequestData)

Eine Funktion zum Auflösen der URL für Medieninhalte.

Der Wert kann null sein.

setMessageInterceptor

setMessageInterceptor(type, interceptor)

Legt einen Interceptor für eingehende und ausgehende Nachrichten fest. Der Interceptor kann die Anfragedaten aktualisieren und sollte entweder aktualisierte Daten, ein Promise mit aktualisierten Daten (wenn Daten nicht sofort zurückgegeben werden können) oder null zurückgeben, wenn die Anfrage nicht verarbeitet werden soll. Hinweis: Wenn ein LOAD-Nachrichten-Interceptor bereitgestellt wird, aber kein separater PRELOAD-Interceptor, wird der LOAD-Interceptor für PRELOAD-Nachrichten aufgerufen.

Parameter

Typ

cast.framework.messages.MessageType

Der Wert darf nicht null sein.

Interceptor

function(non-null cast.framework.messages.RequestData)

Der Wert kann null sein.

setPlaybackConfig

setPlaybackConfig(playbackConfig)

Legt die Wiedergabekonfiguration für PlayerManager fest.

Parameter

playbackConfig

cast.framework.PlaybackConfig

Der Wert darf nicht null sein.

setSupportedMediaCommands

setSupportedMediaCommands(supportedMediaCommands, broadcastStatus)

Legt die vom Empfänger unterstützten Medienbefehle fest.

Parameter

supportedMediaCommands

Zahl

Eine Bitmaske der von der Anwendung unterstützten Medienbefehle.

broadcastStatus

Optional

boolean

true gibt an, dass die Absender über die Änderung benachrichtigt werden sollen. Wenn dieser Wert nicht angegeben ist, werden die Absender benachrichtigt.

Weitere Informationen
cast.framework.messages.Command

stop

stop()

Stoppt die aktuelle Medienwiedergabe.