Klasa: PlayerManager

Metody

addEventListener

addEventListener(eventType, eventListener)

Dodaje detektor zdarzeń, który nasłuchuje zdarzeń odtwarzania.

Parametr

eventType

(niepusta wartość cast.framework.events.EventType lub niepusta tablica niepustych wartości cast.framework.events.EventType)

Typ zdarzenia lub tablica typów zdarzeń.

eventListener

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

Rzuty

non-null Error Jeśli podane argumenty są nieprawidłowe.

addSupportedMediaCommands

addSupportedMediaCommands(supportedMediaCommands, broadcastStatus)

Dodaje nowe obsługiwane polecenia do istniejącej listy obsługiwanych poleceń multimedialnych.

Parametr

supportedMediaCommands

liczba

Bitmaska poleceń multimedialnych obsługiwanych przez aplikację.

broadcastStatus

Opcjonalny

Wartość logiczna

Symbol true oznacza, że nadawcy powinni zostać powiadomieni o zmianie (jeśli nie zostanie podany, nadawcy nie otrzymają powiadomienia).

Zobacz też
cast.framework.messages.Command

broadcastStatus

broadcastStatus(includeMedia, requestId, customData, includeQueueItems)

Wysyła wiadomość o stanie multimediów do wszystkich nadawców (broadcast). Aplikacje używają tego do wysyłania niestandardowej zmiany stanu.

Parametr

includeMedia

Opcjonalny

Wartość logiczna

true oznacza, że wiadomość powinna zawierać informacje o multimediach.

requestId

Opcjonalny

liczba

Identyfikator przychodzącego żądania, które spowodowało tę odpowiedź.

customData

Opcjonalny

Obiekt

Komunikat o stanie zawiera dane niestandardowe specyficzne dla aplikacji.

Wartość może być pusta.

includeQueueItems

Opcjonalny

Wartość logiczna

Określa, czy w komunikacie o stanie mają być uwzględniane elementy kolejki. Domyślnie nie są one uwzględniane.

getAbsoluteTimeForMediaTime

getAbsoluteTimeForMediaTime(mediaTime) zwraca liczbę

Konwertuje czas multimediów na bezwzględny czas multimediów. Czas bezwzględny ma zastosowanie tylko w przypadku transmisji na żywo.

Parametr

mediaTime

liczba

Czas na multimedia.

Zwroty

nullable number Czas bezwzględny lub null, jeśli nie jest dostępny.

getAudioTracksManager

getAudioTracksManager() zwraca cast.framework.AudioTracksManager

Pobiera instancję AudioTracksManager.

Zwroty

non-null cast.framework.AudioTracksManager 

getBreakClipCurrentTimeSec

getBreakClipCurrentTimeSec() zwraca wartość number

Zwraca bieżący czas odtwarzania klipu przerwy w sekundach.

Zwroty

nullable number Bieżący czas w sekundach w bieżącym klipie przerwy. null, gdy Player nie odtwarza klipu z przerwą.

getBreakClipDurationSec

getBreakClipDurationSec() zwraca wartość number

Zwraca czas trwania aktualnie odtwarzanego klipu z przerwą w sekundach.

Zwroty

nullable number Czas trwania bieżącego klipu z przerwą. null, gdy Player nie odtwarza klipu z przerwą.

getBreakManager

getBreakManager() zwraca cast.framework.breaks.BreakManager

Pobiera instancję BreakManager.

Zwroty

non-null cast.framework.breaks.BreakManager 

getBreaks

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

Zwraca listę przerw.

Zwroty

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

getCurrentSupportedMediaCommands

getCurrentSupportedMediaCommands() zwraca wartość typu number

Pobiera bieżące polecenia multimedialne obsługiwane przez odbiornik. W przeciwieństwie do metody getSupportedMediaCommands() zwrócona wartość tej metody zmienia się dynamicznie w zależności od bieżącego stanu odtwarzania. Na przykład podczas odtwarzania reklam polecenie SEEK może nie być obsługiwane. Tę metodę należy wywołać tylko po wywołaniu metody odbiornika CastReceiverContext#start. W przeciwnym razie zwróci ona wartość 0.

Zobacz też
cast.framework.messages.Command
Zwroty

number Maska bitowa poleceń multimedialnych obsługiwanych przez aplikację.

getCurrentTimeSec

getCurrentTimeSec() zwraca liczbę

Pobiera czas odtwarzania bieżących multimediów.

Zwroty

number Czas, który upłynął, w sekundach. Jeśli nie są odtwarzane żadne multimedia, będzie to 0.

getDurationSec

getDurationSec() zwraca liczbę

Pobiera czas trwania aktualnie odtwarzanych multimediów w sekundach.

Zwroty

number Czas trwania multimediów. NaN jeśli nic nie jest odtwarzane.

getLiveSeekableRange

getLiveSeekableRange() zwraca cast.framework.messages.LiveSeekableRange

Zwraca zakres, w którym można przewijać transmisję na żywo, z czasem rozpoczęcia i zakończenia w sekundach. Wartości są obliczane na podstawie czasu spędzonego na oglądaniu treści.

Zwroty

nullable cast.framework.messages.LiveSeekableRange 

getMediaInformation

Funkcja getMediaInformation() zwraca wartość cast.framework.messages.MediaInformation.

Pobiera informacje o bieżącym pliku multimedialnym.

Zwroty

nullable cast.framework.messages.MediaInformation 

getMediaTimeForAbsoluteTime

getMediaTimeForAbsoluteTime(absoluteTime) zwraca liczbę

Konwertuje bezwzględny czas multimediów na czas multimediów. Czas bezwzględny ma zastosowanie tylko w przypadku transmisji na żywo.

Parametr

absoluteTime

liczba

Czas bezwzględny multimediów w formacie czasu uniksowego (sekundy od początku epoki systemu Unix).

Zwroty

nullable number Czas odtwarzania lub null, jeśli nie jest dostępny.

getPlaybackConfig

getPlaybackConfig() zwraca cast.framework.PlaybackConfig

Zwraca konfigurację odtwarzania lub null, jeśli ustawienia domyślne nie zostały zastąpione.

Zwroty

nullable cast.framework.PlaybackConfig 

getPlaybackRate

getPlaybackRate() zwraca liczbę

Zwraca bieżącą szybkość odtwarzania. Zwraca wartość 1 przed wywołaniem odbiorcy CastReceiverContext#start.

Zwroty

number Obecna szybkość odtwarzania.

getPlayerState

getPlayerState() zwraca cast.framework.messages.PlayerState

Pobiera stan Player.

Zwroty

non-null cast.framework.messages.PlayerState Stan bieżącego Player.

getPreferredPlaybackRate

getPreferredPlaybackRate() zwraca liczbę

uzyskać preferowaną szybkość odtwarzania, Można go użyć w zdarzeniu wyłączenia, aby zapisać ostatnią preferowaną szybkość odtwarzania w pamięci trwałej. Dzięki temu będzie można jej użyć w następnej sesji w opcjach przesyłania.

Zwroty

number 

getPreferredTextLanguage

getPreferredTextLanguage() zwraca ciąg znaków

Pobiera preferowany język ścieżki tekstowej.

Zwroty

nullable string 

getPreferredTextStyle

getPreferredTextStyle() zwraca cast.framework.messages.TextTrackStyle

Pobiera preferowany styl ścieżki tekstowej.

Zwroty

nullable cast.framework.messages.TextTrackStyle 

getQueueManager

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

Pobiera instancję QueueManager.

Zwroty

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

getRawCurrentTimeSec

Funkcja getRawCurrentTimeSec() zwraca liczbę.

Zwraca czas odtwarzania bieżącego elementu multimedialnego bez odejmowania czasu trwania przerwy na reklamę.

Zwroty

number Czas, który upłynął, w sekundach. Jeśli nie są odtwarzane żadne multimedia, będzie to 0.

getRawSeekableRange

getRawSeekableRange() zwraca cast.framework.messages.Range

Zwraca bieżący zakres, w którym można przewijać media.

UWAGA: ta wartość jest zgodna z jednostkami getRawCurrentTimeSec(), ale nie z jednostkami seek()!. Nie uwzględnia reklam ani żadnych innych przesunięć multimediów. Jeśli nie masz pewności, czy potrzebujesz wartości surowych, używaj zamiast tego funkcji getLiveSeekableRange().

Zwroty

nullable cast.framework.messages.Range 

getStartAbsoluteTime

getStartAbsoluteTime() zwraca liczbę

Pobiera bezwzględny czas rozpoczęcia odtwarzania multimediów jako czas uniksowy (sekundy od początku epoki systemu Unix). Czas bezwzględny ma zastosowanie tylko w przypadku transmisji na żywo.

Zwroty

nullable number 

getStats

getStats() zwraca cast.framework.stats.Stats

Zwraca statystyki odtwarzania. Statystyki są agregowane w całej sesji odtwarzania, jeśli jest to odpowiednie.

Zwroty

non-null cast.framework.stats.Stats 

getSupportedMediaCommands

Metoda getSupportedMediaCommands() zwraca wartość number

Pobiera polecenia multimedialne obsługiwane przez odbiornik. Należy go wywoływać tylko po wywołaniu funkcji CastReceiverContext#start(). W przeciwnym razie zwraca wartość 0. Obsługiwana wartość poleceń multimedialnych jest kontrolowana wyłącznie przez aplikację odbiornika . Nie jest automatycznie aktualizowany na podstawie MediaStatus.

Zobacz też
cast.framework.messages.Command
Zwroty

number Maska bitowa poleceń multimedialnych obsługiwanych przez aplikację.

getTextTracksManager

getTextTracksManager() zwraca cast.framework.TextTracksManager

Pobiera instancję TextTracksManager.

Zwroty

non-null cast.framework.TextTracksManager 

getTimedMetadata

getTimedMetadata() zwraca tablicę niepustych obiektów cast.framework.TimedMetadata.

Zwraca metadane czasowe napotkane podczas analizowania pliku manifestu. W przypadku HLS jest to #EXT-X-DATERANGE, a w przypadku DASH – EventStream.

Zwroty

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

ładunek

load(loadRequest) zwraca Promise zawierający void

Inicjuje żądanie wczytania multimediów.

Parametr

loadRequest

cast.framework.messages.LoadRequestData

Prośba o wczytanie multimediów.

Wartość nie może być pusta.

Zwroty

non-null Promise containing void Obietnica, która jest spełniana, gdy operacja się powiedzie, lub odrzucana, gdy się nie powiedzie.

wstrzymaj

pause()

Wstrzymuje odtwarzanie bieżących multimediów.

odtwórz

play()

Odtwarza aktualnie wstrzymane multimedia.

removeEventListener

removeEventListener(eventType, eventListener)

Usuwa detektor zdarzeń dodany dla danego zdarzenia odtwarzania. Jeśli nie ma pasującego detektora zdarzeń, to wywołanie jest ignorowane.

Parametr

eventType

(niepusta wartość cast.framework.events.EventType lub niepusta tablica niepustych wartości cast.framework.events.EventType)

eventType lub tablica typów zdarzeń.

eventListener

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

removeSupportedMediaCommands

removeSupportedMediaCommands(supportedMediaCommands, broadcastStatus)

Usuń polecenia z listy obsługiwanych poleceń multimedialnych.

Parametr

supportedMediaCommands

liczba

Bitmaska poleceń multimedialnych obsługiwanych przez aplikację.

broadcastStatus

Opcjonalny

Wartość logiczna

Symbol true oznacza, że nadawcy powinni zostać powiadomieni o zmianie (jeśli nie zostanie podany, nadawcy nie otrzymają powiadomienia).

Zobacz też
cast.framework.messages.Command

przewijać

seek(seekTime)

Przewija bieżący element multimedialny.

Parametr

seekTime

liczba

sendCustomState

sendCustomState(state)

Wysyła niestandardowy stan z logiki odtwarzania aplikacji do logiki interfejsu. Ta metoda pomaga oddzielić logikę odtwarzania od interfejsu. Zachowanie rozdzielenia logiki i interfejsu użytkownika umożliwia używanie tej samej logiki interfejsu użytkownika zarówno w przypadku odtwarzania lokalnego, jak i zdalnego sterowania. Stan niestandardowy wysłany tą metodą jest dostępny w interfejsie za pomocą parametru PlayerData.

Parametr

stan

Obiekt

Obiekt stanu niestandardowego.

Wartość nie może być pusta.

Zobacz też
cast.framework.ui.PlayerData#customState

sendError

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

Wysyła błąd do określonego nadawcy.

Parametr

senderId

ciąg znaków

Identyfikator nadawcy.

requestId

liczba

Identyfikator żądania przychodzącego, które spowodowało ten błąd.

typ

cast.framework.messages.ErrorType

Typ błędu.

Wartość nie może być pusta.

przyczyna,

Opcjonalny

cast.framework.messages.ErrorReason

Przyczyna błędu.

Wartość może być pusta.

customData

Opcjonalny

Obiekt

Komunikat o błędzie dotyczący danych niestandardowych specyficznych dla aplikacji.

Wartość może być pusta.

sendLocalMediaRequest

sendLocalMediaRequest(request)

Wysyła żądanie dotyczące lokalnych multimediów.

Parametr

żądanie

cast.framework.messages.RequestData

Wartość nie może być pusta.

sendStatus

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

Wysyła wiadomość o stanie multimediów do określonego nadawcy.

Parametr

senderId

ciąg znaków

Identyfikator nadawcy.

requestId

liczba

Identyfikator przychodzącego żądania, które spowodowało tę odpowiedź.

includeMedia

Opcjonalny

Wartość logiczna

Symbol true oznacza, że wiadomość powinna zawierać instancję MediaInformation.

customData

Opcjonalny

Obiekt

Komunikat o stanie zawiera dane niestandardowe specyficzne dla aplikacji.

Wartość może być pusta.

includeQueueItems

Opcjonalny

Wartość logiczna

Określa, czy w komunikacie o stanie mają być uwzględniane elementy kolejki. Domyślnie nie są one uwzględniane.

setIdleReason

setIdleReason(idleReason)

Ustawia przyczynę, dla której odtwarzacz jest w stanie IDLE. Umożliwia to aplikacjom, które chcą wymusić stan IDLE, podanie przyczyny takiego działania (np. błąd niestandardowy). Przyczyna braku aktywności jest wysyłana w następnej wiadomości o stanie. Uwaga: większość aplikacji nie musi ustawiać tej wartości. Jest on potrzebny tylko wtedy, gdy w szczególnych okolicznościach aplikacja musi przejść do stanu Player, a domyślny argument idleReason nie odzwierciedla zamierzonego działania.IDLE

Parametr

idleReason

cast.framework.messages.IdleReason

Powód, dla którego urządzenie jest w stanie IDLE.

Wartość nie może być pusta.

setMediaElement

setMediaElement(mediaElement)

Ustawia HTMLMediaElement do użycia. Jeśli ustawiono Promise elementu HTMLMediaElement, odtwarzanie multimediów rozpocznie się po rozwiązaniu Promise.

Parametr

mediaElement

(niepusty element HTMLMediaElement lub niepusta obietnica zawierająca niepusty element HTMLMediaElement)

MediaElement, z którego będzie korzystać Player.

setMediaInformation

setMediaInformation(mediaInformation, opt_broadcast)

Ustawia informacje o multimediach.

Parametr

mediaInformation

cast.framework.messages.MediaInformation

Wartość nie może być pusta.

opt_broadcast

Opcjonalny

Wartość logiczna

setMediaPlaybackInfoHandler

setMediaPlaybackInfoHandler(handler)

Ustawia moduł obsługi, który zwraca lub modyfikuje obiekt cast.framework.PlaybackConfig w przypadku konkretnego żądania wczytania. Parametry modułu obsługi to LoadRequestData i domyślny PlaybackConfig odbiornika (podany w CastReceiverOptions). Moduł obsługi powinien zwracać zmodyfikowaną konfigurację odtwarzania lub null, aby zapobiec odtwarzaniu multimediów. Wartość zwracana może być też obiektem Promise, aby umożliwić oczekiwanie na dane z serwera.

Parametr

moduł obsługi

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

Funkcja umożliwiająca podanie konfiguracji odtwarzania odpowiedniej dla danego żądania.

Wartość może być pusta.

setMediaUrlResolver

setMediaUrlResolver(resolver)

Ustawia moduł obsługi, który zwraca adres URL multimediów dla żądania LOAD. Ten moduł obsługi może służyć do unikania publikowania adresu URL treści multimedialnych w ramach stanu multimediów. Domyślnie jako adres URL treści używany jest element contentId.

Parametr

resolver

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

Funkcja do rozpoznawania adresu URL treści multimedialnych.

Wartość może być pusta.

setMessageInterceptor

setMessageInterceptor(type, interceptor)

Ustawia przechwytywacz wiadomości przychodzących i wychodzących. Interceptor może zaktualizować dane żądania i powinien zwrócić zaktualizowane dane, obiekt Promise ze zaktualizowanymi danymi (jeśli danych nie można zwrócić od razu) lub null, jeśli żądanie nie powinno być obsługiwane. Uwaga: jeśli podano przechwytujący wiadomości LOAD, ale nie podano oddzielnego przechwytującego wiadomości PRELOAD, przechwytujący LOAD będzie wywoływany w przypadku wiadomości PRELOAD.

Parametr

typ

cast.framework.messages.MessageType

Wartość nie może być pusta.

interceptor

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

Wartość może być pusta.

setPlaybackConfig

setPlaybackConfig(playbackConfig)

Ustawia konfigurację odtwarzania na urządzeniu PlayerManager.

Parametr

playbackConfig

cast.framework.PlaybackConfig

Wartość nie może być pusta.

setSupportedMediaCommands

setSupportedMediaCommands(supportedMediaCommands, broadcastStatus)

Określa polecenia multimedialne obsługiwane przez odbiornik.

Parametr

supportedMediaCommands

liczba

Bitmaska poleceń multimedialnych obsługiwanych przez aplikację.

broadcastStatus

Opcjonalny

Wartość logiczna

Symbol true oznacza, że nadawcy powinni zostać powiadomieni o zmianie (jeśli nie zostanie podany, nadawcy nie otrzymają powiadomienia).

Zobacz też
cast.framework.messages.Command

zatrzymaj

stop()

Zatrzymuje odtwarzanie bieżących multimediów.