Klasa: CastpickuprContext

cast.framework.CastReceiverContext

class   static

Zarządza wczytywaniem bibliotek i inicjuje pakiet SDK odbiornika Cast.

Rzuty

non-null Error Jeśli element MediaElement nie został utworzony w treści dokumentu. Jeśli utworzysz kilka elementów multimedialnych, ustaw klasę „castMediaElement” na jeden z nich, którego będzie używać odbiornik CAF.

Metody

getInstance

static

getInstance() zwraca cast.framework.CastReceiverContext

Zwraca instancję singletonu CastReceiverContext.

Zwroty

non-null cast.framework.CastReceiverContext 

addCustomMessageListener

addCustomMessageListener(namespace, listener)

Konfiguruje detektor wiadomości dla niestandardowego kanału wiadomości. W przypadku przestrzeni nazw dozwolony jest więcej niż 1 detektor.

Parametr

przestrzeń nazw

tekst

Przestrzeń nazw. Pamiętaj, że prawidłowa przestrzeń nazw musi mieć prefiks „urn:x-cast:”.

detektor

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

Error Jeśli system nie jest gotowy lub przestrzeń nazw nie jest obsługiwana przez tę aplikację.

addEventListener

addEventListener(type, handler)

Dodaj detektor do zdarzeń systemowych Cast.

Parametr

typ

cast.framework.system.EventType

Wartość nie może być pusta.

witryna

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

canDisplayType

canDisplayType(mimeType, codecs, width, height, framerate) zwraca wartość logiczną

Sprawdza, czy podane parametry multimediów strumieni wideo lub audio są obsługiwane przez platformę.

Parametr

mimeType

tekst

Typ MIME multimediów. Składa się z typu i podtypu oddzielonych znakiem „/”. Może to być typ MIME wideo lub audio.

kodeki

Opcjonalny

tekst

Ciąg znaków w cudzysłowie zawiera listę formatów rozdzielonych przecinkami, gdzie każdy format określa typ próbki multimedialnej, która jest obecna w strumieniu.

szerokość

Opcjonalny

liczba

Opisuje rozdzielczość poziomą strumienia w pikselach.

wysokość

Opcjonalny

liczba

Opisuje rozdzielczość pionową strumienia w pikselach.

framerate

Opcjonalny

liczba

Określa liczbę klatek transmisji.
Zwroty

boolean Jeśli strumień można odtworzyć na Chromecaście.

getApplicationData

getApplicationData() zwraca cast.framework.system.ApplicationData

Dostarcza informacje o aplikacji, gdy system jest gotowy. W przeciwnym razie ma wartość null.

Zwroty

nullable cast.framework.system.ApplicationData Informacje o aplikacji lub wartość null, jeśli system nie jest gotowy.

getDeviceCapabilities

getDeviceCapabilities() zwraca cast.framework.system.DeviceCapabilitiesObj

Udostępnia informacje o możliwościach urządzenia, gdy system jest gotowy. W przeciwnym razie będzie mieć wartość null. Jeśli zwracany jest pusty obiekt, urządzenie nie udostępnia żadnych informacji o możliwościach.

Zwroty

nullable cast.framework.system.DeviceCapabilitiesObj Informacje o możliwościach urządzenia (pary klucz-wartość). Jeśli system nie jest jeszcze gotowy, będzie mieć wartość null. Może to być pusty obiekt, jeśli platforma nie udostępnia żadnych informacji o możliwościach urządzenia.

getDeviceInformation

getDeviceInformation() zwraca cast.framework.system.DeviceInformationObj

Udostępnia informacje identyfikujące urządzenie, które nie są związane z jego możliwościami, gdy system jest gotowy. W przeciwnym razie zwraca wartość „null”. Jeśli zwracany jest pusty obiekt, urządzenie nie udostępnia takich informacji.

Zwroty

nullable cast.framework.system.DeviceInformationObj Informacje o urządzeniu (pary klucz-wartość). Jeśli system nie jest jeszcze gotowy, będzie mieć wartość null. Może to być pusty obiekt, jeśli platforma nie udostępnia tych informacji.

getPlayerManager

getPlayerManager() zwraca cast.framework.PlayerManager

Pobierz instancję odtwarzacza, która może sterować odtwarzaniem multimediów i je monitorować.

Zwroty

non-null cast.framework.PlayerManager 

getSender

getSender(senderId) zwraca cast.framework.system.Sender

Pobieranie nadawcy według identyfikatora nadawcy

Parametr

senderId

tekst

Identyfikator nadawcy, który ma zostać zwrócony.
Zwroty

nullable cast.framework.system.Sender 

getSenders

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

Pobiera listę aktualnie połączonych nadawców.

Zwroty

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

getStandbyState

getStandbyState() zwraca cast.framework.system.StandbyState

Informuje, czy wejście HDMI aplikacji do przesyłania jest w trybie gotowości.

Zwroty

non-null cast.framework.system.StandbyState Określa, czy wejście HDMI aplikacji jest w trybie gotowości. Jeśli nie można tego określić, na przykład dlatego,że telewizor nie obsługuje poleceń CEC, zwracana jest wartość UNKNOWN.

getSystemState

getSystemState() zwraca cast.framework.system.SystemState

Dostarcza aplikacji informacji o stanie systemu.

Zwroty

non-null cast.framework.system.SystemState Stan systemu.

getVisibilityState

getVisibilityState() zwraca cast.framework.system.VisibilityState

Raportuje, czy aplikacja do przesyłania jest aktywnym wejściem HDMI.

Zwroty

non-null cast.framework.system.VisibilityState Określa, czy aplikacja jest aktywnym wejściem HDMI. Jeśli nie można tego określić, na przykład dlatego,że telewizor nie obsługuje poleceń CEC, zwracana jest wartość UNKNOWN.

isSystemReady

isSystemReady() zwraca wartość logiczną

Gdy rozpocznie się wywołanie aplikacji, system wyśle zdarzenie gotowości, aby wskazać, że informacje o aplikacji są gotowe i aplikacja może wysyłać wiadomości, gdy tylko zostanie połączony jeden nadawca.

Zwroty

boolean Określa, czy system jest gotowy do przetwarzania wiadomości.

loadPlayerLibraries

loadPlayerLibraries(useLegacyDashSupport)

Rozpocznij wczytywanie pliku js odtwarzacza. Można go użyć do rozpoczęcia wczytywania kodu JS odtwarzacza na wczesnym etapie uruchamiania odbiornika przed wywołaniem metody start. Ta funkcja nie działa, jeśli odtwarzacze zostały już wczytane (wywołano start).

Parametr

useLegacyDashSupport

Opcjonalny

wartość logiczna

Wskazuje, że w przypadku treści DASH należy używać MPL.

removeCustomMessageListener

removeCustomMessageListener(namespace, listener)

Usuwa detektor wiadomości zarejestrowany wcześniej za pomocą CastReceiverContext#addCustomMessageListener.

Parametr

przestrzeń nazw

tekst

Przestrzeń nazw. Pamiętaj, że prawidłowa przestrzeń nazw musi mieć prefiks „urn:x-cast:”.

detektor

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

Funkcja detektora wiadomości, którą chcesz wyrejestrować.
Rzuty

Error Jeśli system nie jest gotowy lub przestrzeń nazw nie jest obsługiwana przez tę aplikację.

removeEventListener

removeEventListener(type, handler)

Usuń detektor zdarzeń systemowych Cast.

Parametr

typ

cast.framework.system.EventType

Wartość nie może być pusta.

witryna

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

sendCustomMessage

sendCustomMessage(namespace, senderId, data)

Wysyła wiadomość do określonego nadawcy.

Parametr

przestrzeń nazw

tekst

Przestrzeń nazw. Pamiętaj, że prawidłowa przestrzeń nazw musi mieć prefiks „urn:x-cast:”.

senderId

(ciąg znaków lub niezdefiniowany)

Identyfikator nadawcy lub wartość undefined w przypadku transmisji do wszystkich nadawców.

dane

dowolny typ

Ładunek wiadomości.

Wartość nie może być pusta.
Rzuty

Error Jeśli podczas przygotowywania wiadomości wystąpił błąd.

sendFeedbackMessage

sendFeedbackMessage(feedbackMessage)

Tę funkcję należy wywołać w odpowiedzi na zdarzenie feedbackstarted, jeśli aplikacja dodaje informacje o stanie debugowania do dziennika w raporcie opinii. Przyjmuje parametr „message”, który jest ciągiem znaków reprezentującym informacje na potrzeby debugowania, które aplikacja chce zarejestrować.

Parametr

feedbackMessage

tekst
Wycofano
Użyj cast.framework.CastReceiverContext#setFeedbackHandler

setApplicationState

setApplicationState(statusText)

Ustawia stan aplikacji. Aplikacja powinna wywołać tę metodę, gdy zmieni się jej stan. Jeśli nie jest zdefiniowana lub jest ustawiona na pusty ciąg znaków, domyślnie jako stan aplikacji jest używana wartość Nazwa aplikacji określona podczas rejestracji aplikacji.

Parametr

statusText

tekst

Tekst stanu.

setFeedbackHandler

setFeedbackHandler(feedbackHandler)

Ustaw moduł obsługi, aby podać dodatkowe dane do raportu z opinią. Moduł obsługi zostanie wywołany po utworzeniu zgłoszenia opinii i powinien zwrócić dodatkowe dane w postaci ciągu znaków lub obietnicy ciągu znaków. Obiekt Promise powinien zostać rozwiązany w ciągu 5 sekund, aby został uwzględniony w raporcie.

Parametr

feedbackHandler

function()

Wartość może być pusta.

setInactivityTimeout

setInactivityTimeout(maxInactivity)

Ustawia czas bezczynności odbiornika. Zalecamy ustawienie maksymalnej wartości braku aktywności podczas wywoływania metody Start i nie zmienianie jej. Ten interfejs API jest udostępniany wyłącznie do celów programistycznych i debugowania.

Parametr

maxInactivity

liczba

Odstęp w sekundach przed zamknięciem nieodpowiadającego połączenia.

setLoggerLevel

setLoggerLevel(level)

Ustawia poziom szczegółowości logu.

Parametr

poziom

cast.framework.LoggerLevel

Poziom logowania.

Wartość nie może być pusta.

rozpocznij

start(options) zwraca cast.framework.CastReceiverContext

Inicjuje menedżera systemu i menedżera multimediów, aby aplikacja odbiornika mogła odbierać żądania od nadawców.

Parametr

Opcje

(niepusty obiekt cast.framework.CastReceiverOptions lub opcjonalny niepusty obiekt)
Zwroty

non-null cast.framework.CastReceiverContext 

zatrzymaj

stop(closeReason)

Wyłącz aplikację odbiornika.

Parametr

closeReason

Opcjonalny

cast.framework.common.CloseReason

Opcjonalny powód zamknięcia wskazujący, dlaczego aplikacja odbiornika została zatrzymana. Jeśli nie zostanie podany, platforma wywnioskuje przyczynę na podstawie ostatnich zdarzeń odtwarzacza multimedialnego lub użyje wartości APP_REQUEST. Przekaż jedną z tych wartości liczbowych:

  • 13 (APP_CUSTOM_STOP): w przypadku niestandardowych działań interfejsu lub działań biznesowych odbiornika (np. użytkownik klika w aplikacji przycisk „Wyjdź” lub „Zamknij”, niestandardowy odbiornik przechodzi z przesyłania do innego działania).
  • 15 (APP_ERROR): błędy krytyczne na poziomie aplikacji (np. błędy uwierzytelniania niestandardowego, błędy pobierania licencji lub DRM, awarie interfejsu API backendu), które występują poza wbudowanymi zdarzeniami błędów odtwarzacza CAF.
  • 14 (APP_PLAYBACK_FINISHED): aplikacja odtworzyła całą playlistę lub kolejkę albo zakończyła odtwarzanie samodzielnych multimediów.
  • 6 (APP_REQUEST): ogólny lub starszy komunikat zastępczy, gdy aplikacja żąda zakończenia bez podania konkretnego powodu.

Wartość nie może być pusta.