cast. framework: PlayerManager
Steuert die Medienwiedergabe und überwacht sie.
- Löst aus
-
non-null Error
: Wenn der Konstruktor direkt verwendet wird AufPlayerManager
sollte nur durch Aufrufen von cast.framework.CastReceiverContext#getPlayerManager zugegriffen werden.
Methoden
addEventListener
addEventListener(eventType, eventListener)
Fügt einen Ereignis-Listener hinzu, der Wiedergabeereignisse erfasst
Parameter |
|
---|---|
eventType |
(nicht-null cast.framework.events.EventType oder Nicht-Null-Array von cast.framework.events.EventType) Ein Ereignistyp oder ein Array von Ereignistypen |
EventListener |
function(non-null cast.framework.events.Event) |
- Löst aus
-
non-null Error
Wenn die angegebenen Argumente ungültig sind.
addSupportedMediaCommands
addSupportedMediaCommands(supportedMediaCommands, BroadcastStatus)
Fügt der Liste der unterstützten Medienbefehle neue unterstützte Befehle hinzu.
Parameter |
|
---|---|
Unterstützte Medienbefehle |
Zahl Eine Bitmaske von Medienbefehlen, die von der Anwendung unterstützt werden. |
Übertragungsstatus |
Optional boolean
|
- Weitere Informationen
- cast.framework.messages.Command
Übertragungsstatus
BroadcastStatus(includeMedia, requestId, customData, includeQueueItems)
Sendet eine Medienstatusnachricht an alle Absender (Broadcast). Anwendungen verwenden diese Option, um eine benutzerdefinierte Statusänderung zu senden.
Parameter |
|
---|---|
Medien einschließen |
Optional boolean
|
requestId |
Optional Zahl Die ID der eingehenden Anfrage, die diese Antwort verursacht hat. |
CustomData |
Optional Objekt Die anwendungsspezifischen benutzerdefinierten Daten für die Statusmeldung. Wert kann null sein. |
IncludeQueueItems |
Optional boolean Gibt an, ob Warteschlangenelemente in die Statusmeldung aufgenommen werden. Standardmäßig sind sie nicht enthalten. |
getAbsoluteTimeForMediaTime
getAbsoluteTimeForMediaTime(mediaTime) gibt Zahl zurück
Wandelt die Medienzeit in die absolute Zeit der Medien um. Die absolute Zeit gilt nur für Livestreams.
Parameter |
|
---|---|
mediaTime (Medienzeit) |
Zahl Medienzeit. |
- Gibt Folgendes zurück:
-
nullable number
Absolute Zeit odernull
, falls nicht verfügbar.
getAudioTracksManager
getAudioTracksManager() gibt cast.framework.AudioTracksManager zurück.
Ruft die AudioTracksManager
-Instanz ab.
- Gibt Folgendes zurück:
-
non-null cast.framework.AudioTracksManager
getBreakClipCurrentTimeSec
getBreakClipCurrentTimeSec() gibt Zahl zurück
Gibt die aktuelle Zeit des aktuell wiedergegebenen Clips in Sekunden an.
- Gibt Folgendes zurück:
-
nullable number
Aktuelle Zeit in Sekunden im aktuellen Break-Clip.null
, wenn derPlayer
keinen Break-Clip abspielt.
getBreakClipDurationSec
getBreakClipDurationSec() gibt Nummer zurück
Gibt die Dauer des aktuell wiedergegebenen Clips in Sekunden an.
- Gibt Folgendes zurück:
-
nullable number
Dauer des aktuellen Unterbrechungsclips.null
, wenn dasPlayer
keinen Break-Clip abspielt.
getBreakManager
getBreakManager() gibt cast.framework.breaks.BreakManager zurück.
Ruft die BreakManager
-Instanz ab.
- Gibt Folgendes zurück:
-
non-null cast.framework.breaks.BreakManager
getBreaks
getBreaks() gibt ein Array von Nicht-Null-cast.framework.messages.Break zurück.
Gibt eine Liste von Werbeunterbrechungen zurück.
- Gibt Folgendes zurück:
-
non-null Array of non-null cast.framework.messages.Break
getCurrentSupportedMediaCommands
getCurrentSupportedMediaCommands() gibt eine Zahl zurück
Ruft die Medienbefehle des aktuellen Empfängers ab.
Anders als bei getSupportedMediaCommands()
ändert sich der zurückgegebene Wert dieser Methode dynamisch basierend auf dem aktuellen Wiedergabestatus. Während der Wiedergabe der Anzeige wird der Befehl SEEK
möglicherweise nicht unterstützt.
Diese Methode sollte erst aufgerufen werden, nachdem der Empfänger CastReceiverContext#start
aufgerufen wurde. Andernfalls wird 0
zurückgegeben.
- Weitere Informationen
- cast.framework.messages.Command
- Gibt Folgendes zurück:
-
number
Eine Bitmaske von Medienbefehlen, die von der Anwendung unterstützt werden.
AktuellsteZeit (Sek.)
getCurrentTimeSec() gibt Nummer zurück
Ruft die verstrichene Wiedergabe der aktuellen Medien ab.
- Gibt Folgendes zurück:
-
number
Die verstrichene Zeit in Sekunden Der Wert ist0
, wenn keine Medien abgespielt werden.
getDurationSec
getDurationSec() gibt Zahl zurück
Ruft die Dauer der aktuell wiedergegebenen Medien in Sekunden ab.
- Gibt Folgendes zurück:
-
number
Dauer der Medien.NaN
, wenn keine Medien abgespielt werden.
getLiveSeekableRange
getLiveSeekableRange() gibt cast.framework.messages.LiveSeekableRange zurück
Gibt den Live-Suchbereich mit Start- und Endzeit in Sekunden zurück. Die Werte basieren auf der Medienzeit.
- Gibt Folgendes zurück:
getMediaInformation
getMediaInformation() gibt cast.framework.messages.MediaInformation zurück.
Ruft Medieninformationen zu den aktuellen Medien ab.
- Gibt Folgendes zurück:
getMediaTimeForAbsoluteTimes
getMediaTimeForAbsoluteTime(absoluteTime) gibt eine Zahl zurück
Wandelt die absolute Zeit der Medien in die Medienzeit um. Die absolute Zeit gilt nur für Livestreams.
Parameter |
|
---|---|
absoluteZeit |
Zahl Die absolute Zeit des Mediums als UNIX-Epochenzeit (Sekunden seit der Unix-Epoche). |
- Gibt Folgendes zurück:
-
nullable number
Medienzeit odernull
, falls nicht verfügbar.
getPlaybackConfig
getPlaybackConfig() gibt cast.framework.PlaybackConfig zurück.
Gibt die Wiedergabekonfiguration zurück.
- Gibt Folgendes zurück:
-
nullable cast.framework.PlaybackConfig
Wiedergabewiedergaberate
getPlaybackRate() gibt Zahl zurück
Gibt die aktuelle Wiedergaberate zurück.
Gibt 1
zurück, bevor der Empfänger CastRecevierContext#start
aufgerufen wird.
- Gibt Folgendes zurück:
-
number
Aktuelle Wiedergaberate.
Spielerstatus abrufen
getPlayerState() gibt cast.framework.messages.PlayerState zurück
Ruft den Status Player
ab.
- Gibt Folgendes zurück:
-
non-null cast.framework.messages.PlayerState
Der Status des aktuellenPlayer
.
Rate für bevorzugte Wiedergabe
getPreferredPlaybackRate() gibt Zahl zurück
Bevorzugte Wiedergaberate abrufen Kann beim Herunterfahren verwendet werden, um die neueste bevorzugte Wiedergaberate im nichtflüchtigen Speicher zu speichern, damit es in der nächsten Sitzung in den Streamingoptionen verwendet werden kann.
- Gibt Folgendes zurück:
-
number
GetPreferredTextLanguage
getPreferredTextLanguage() String
Ruft die bevorzugte Sprache für den Texttrack ab.
- Gibt Folgendes zurück:
-
nullable string
BevorzugterTextstil
getPreferredTextStyle() gibt cast.framework.messages.TextTrackStyle zurück
Ruft den bevorzugten Stil des Texttracks ab.
- Gibt Folgendes zurück:
getQueueManager
getQueueManager() gibt zurück (cast.framework.QueueManager oder undefiniert)
Ruft die QueueManager
-Instanz ab.
- Gibt Folgendes zurück:
-
(non-null cast.framework.QueueManager or undefined)
GetRawCurrentTimeSec
getRawCurrentTimeSec() gibt Nummer zurück
Ruft die verstrichene Wiedergabezeit des aktuellen Mediums ab, ohne die Werbeunterbrechung zu subtrahieren.
- Gibt Folgendes zurück:
-
number
Die verstrichene Zeit in Sekunden Der Wert ist0
, wenn keine Medien abgespielt werden.
getStartAbsoluteTime (StartzeitAbsolutzeit)
getStartAbsoluteTime() gibt Zahl zurück
Ruft die absolute Medienstartzeit als UNIX-Epochenzeit in Sekunden seit der Unix-Epoche ab. Die absolute Zeit gilt nur für Livestreams.
- Gibt Folgendes zurück:
-
nullable number
getStats
getStats() gibt cast.framework.Stats zurück.
Gibt Wiedergabestatistiken zurück. Die Statistiken werden gegebenenfalls während der gesamten Wiedergabesitzung zusammengefasst.
- Gibt Folgendes zurück:
-
non-null cast.framework.Stats
getSupportedMediaCommands
getSupportedMediaCommands() gibt Zahl zurück
Ruft Medienempfängerbefehle auf, die vom Empfänger unterstützt werden. Sollte erst nach dem Aufruf von CastReceiverContext#start()
aufgerufen werden. Andernfalls wird 0
zurückgegeben. Der unterstützte Wert für Medienbefehle wird ausschließlich von der Empfängeranwendung gesteuert .
Sie wird nicht automatisch basierend auf einem MediaStatus
aktualisiert.
- Weitere Informationen
- cast.framework.messages.Command
- Gibt Folgendes zurück:
-
number
Eine Bitmaske von Medienbefehlen, die von der Anwendung unterstützt werden.
getTextTracksManager
getTextTracksManager() gibt cast.framework.TextTracksManager zurück.
Ruft die TextTracksManager
-Instanz ab.
- Gibt Folgendes zurück:
-
non-null cast.framework.TextTracksManager
getTimedMetadaten
getTimedMetadata() gibt ein Array von Nicht-Null-cast.framework.TimedMetadata zurück.
Gibt zeitgesteuerte Metadaten zurück, die beim Parsen des Manifests gefunden wurden. Dies ist #EXT-X-DATERANGE
in HLS und EventStream
in DASH.
- Gibt Folgendes zurück:
-
non-null Array of non-null cast.framework.TimedMetadata
Ladung
„load(loadRequest)“ gibt ein Promise zurück, das „void“ enthält
Initiiert eine Anfrage zum Laden von Medien.
Parameter |
|
---|---|
Anfrage laden |
cast.framework.messages.LoadRequestData Eine Anfrage zum Laden von Medien. Der Wert darf nicht null sein. |
- Gibt Folgendes zurück:
-
non-null Promise containing void
Das Versprechen wird gelöst, wenn der Vorgang erfolgreich war, oder wurde abgelehnt, wenn der Vorgang fehlgeschlagen ist.
Pausieren
Pause()
Pausiert die aktuell wiedergegebenen Medien.
Wiedergabe
play()
Gibt die aktuell pausierten Medien wieder.
removeEventListener
removeEventListener(eventType, eventListener)
Entfernt den Ereignis-Listener, der für ein bestimmtes Wiedergabeereignis hinzugefügt wurde. Wenn kein übereinstimmender Ereignis-Listener vorhanden ist, wird dieser Aufruf ignoriert.
Parameter |
|
---|---|
eventType |
(nicht-null cast.framework.events.EventType oder Nicht-Null-Array von cast.framework.events.EventType) Ein Ereignistyp oder ein Array von Ereignistypen |
EventListener |
function(non-null cast.framework.events.Event) |
removeSupportedMediaCommands
removeSupportedMediaCommands(supportedMediaCommands, BroadcastStatus)
Entfernen Sie Befehle aus der Liste der unterstützten Medienbefehle.
Parameter |
|
---|---|
Unterstützte Medienbefehle |
Zahl Eine Bitmaske von Medienbefehlen, die von der Anwendung unterstützt werden. |
Übertragungsstatus |
Optional boolean
|
- Weitere Informationen
- cast.framework.messages.Command
seek
see(Timek)
Sucht in den aktuellen Medien.
Parameter |
|
---|---|
Suchzeit |
Zahl |
sendCustomState
sendCustomState(Bundesstaat)
Sendet einen benutzerdefinierten Status von einer Logik für die Anwendungswiedergabe an die Logik der Benutzeroberfläche.
Diese Methode ermöglicht die Trennung von Wiedergabelogik und Benutzeroberfläche.
Wenn die Logik von der UI getrennt ist, kann dieselbe für die lokale Wiedergabe und die Fernbedienung verwendet werden.
Der von dieser Methode gesendete benutzerdefinierte Zustand ist über PlayerData
auf der Benutzeroberfläche verfügbar.
Parameter |
|
---|---|
Bundesland |
Objekt Benutzerdefiniertes Statusobjekt. Der Wert darf nicht null sein. |
- Weitere Informationen
- cast.framework.ui.PlayerData#customState
sendError (Fehler senden)
sendError(senderId, requestId, type, reason, customData)
Sendet einen Fehler an einen bestimmten Absender.
Parameter |
|
---|---|
Absender-ID |
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. Wert kann null sein. |
CustomData |
Optional Objekt Die anwendungsspezifischen benutzerdefinierten Fehlermeldungen. Wert kann null sein. |
sendLocalMediaRequest
sendLocalMediaRequest(Anfrage)
Sendet eine lokale Medienanfrage.
Parameter |
|
---|---|
Anfrage |
cast.framework.messages.RequestData Der Wert darf nicht null sein. |
Sendestatus
sendStatus(senderId, requestId, includeMedia, customData, includeQueueItems)
Sendet eine Medienstatusnachricht an einen bestimmten Absender.
Parameter |
|
---|---|
Absender-ID |
String Die Absender-ID. |
requestId |
Zahl Die ID der eingehenden Anfrage, die diese Antwort verursacht hat. |
Medien einschließen |
Optional boolean
|
CustomData |
Optional Objekt Die anwendungsspezifischen benutzerdefinierten Daten für die Statusmeldung. Wert kann null sein. |
IncludeQueueItems |
Optional boolean Gibt an, ob Warteschlangenelemente in die Statusmeldung aufgenommen werden. Standardmäßig sind sie nicht enthalten. |
setIdleGrund
setIdleReason(idleReason)
Legt den Grund dafür fest, dass sich der Player im Status IDLE
befindet.
Dadurch können Anwendungen, die den Status IDLE
erzwingen möchten, den Grund dafür angeben (z. B. ein benutzerdefinierter Fehler).
Der Grund für die Inaktivität wird in der nächsten Statusmeldung gesendet.
Hinweis: Bei den meisten Anwendungen muss dieser Wert nicht festgelegt werden. Sie ist nur erforderlich, wenn die Anwendung Player
unter besonderen Umständen in den Status IDLE
versetzen muss und die Standardeinstellung „Grund für Inaktivität“ nicht das beabsichtigte Verhalten widerspiegelt.
Parameter |
|
---|---|
Inaktivitätsgrund |
cast.framework.messages.IdleReason Der Grund für den Status Der Wert darf nicht null sein. |
setMediaElement
setMediaElement(mediaElement)
Legt die zu verwendende HTMLMediaElement
fest. Wenn Promise
von HTMLMediaElement
festgelegt ist, beginnt die Wiedergabe der Medien, nachdem Promise
aufgelöst wurde.
Parameter |
|
---|---|
mediaElement |
(HTMLMediaElement oder Nicht-Null-Promise, das Nicht-Null-HTMLMediaElement enthält)
|
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 LoadRequestData
und Standard-PlaybackConfig
für den Empfänger (in CastReceiverOptions
angegeben). Der Handler sollte eine geänderte Wiedergabekonfiguration zurückgeben oder null
, um zu verhindern, dass die Medien wiedergegeben werden. Der Rückgabewert kann auch ein Promise
sein, um das Warten auf Daten vom Server zuzulassen.
Parameter |
|
---|---|
Handler |
function(non-null cast.framework.messages.LoadRequestData, nicht null cast.framework.PlaybackConfig) Eine Funktion zum Bereitstellen einer anfragespezifischen Wiedergabekonfiguration. Wert kann null sein. |
setMediaUrlResolver
setMediaUrlResolver(Auflösung)
Legt einen Handler fest, der die Medien-URL für eine LOAD
-Anfrage zurückgibt.
Mit diesem Handler kann verhindert werden, dass die URL für Medieninhalte im Rahmen des Medienstatus veröffentlicht wird. Standardmäßig wird das Medium contentId
als Inhalts-URL verwendet.
Parameter |
|
---|---|
Resolver |
function(non-null cast.framework.messages.LoadRequestData) Eine Funktion zum Auflösen der URL für Medieninhalte. Wert kann null sein. |
setMessageInterceptor
setMessageInterceptor(Typ, Interceptor)
Legt einen Listener für eingehende und ausgehende Nachrichten fest.
Der Interceptor kann die Anfragedaten aktualisieren und sollte entweder aktualisierte Daten, einen 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
-Abfang für Nachrichten angegeben ist, aber kein separater PRELOAD
-Abfangdienst, wird dieser 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) Wert kann null sein. |
setPlaybackConfig
setPlaybackConfig(playbackConfig)
Legt die Wiedergabekonfiguration für PlayerManager
fest.
Parameter |
|
---|---|
Wiedergabekonfiguration |
Der Wert darf nicht null sein. |
setSupportedMediaCommands
setSupportedMediaCommands(supportedMediaCommands, BroadcastStatus)
Legt die vom Empfänger unterstützten Medienbefehle fest.
Parameter |
|
---|---|
Unterstützte Medienbefehle |
Zahl Eine Bitmaske von Medienbefehlen, die von der Anwendung unterstützt werden. |
Übertragungsstatus |
Optional boolean
|
- Weitere Informationen
- cast.framework.messages.Command
stoppen
stop()
Beendet die Wiedergabe des gerade abgespielten Mediums.