Klasa: CastpickuprContext

cast.framework.CastReceiverContext

class   static

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

Rzuty

non-null Error Jeśli element MediaElement nie został utworzony w treści dokumentu. Jeśli utworzono wiele elementów multimedialnych, deweloper powinien ustawić klasę „castMediaElement” dla jednego z nich, którego będzie używać odbiornik CAF.

Metody

getInstance

static

getInstance() zwraca cast.framework.CastReceiverContext

Zwraca pojedynczą instancję CastReceiverContext.

Zwroty

non-null cast.framework.CastReceiverContext 

addCustomMessageListener

addCustomMessageListener(namespace, listener)

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

Parametr

przestrzeń nazw

ciąg znaków

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)

Dodawanie detektora do zdarzeń systemowych przesyłania.

Parametr

typ

cast.framework.system.EventType

Wartość nie może być pusta.

moduł obsługi

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

ciąg znaków

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

kodeki,

Opcjonalny

ciąg znaków

Ciąg 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 pionową rozdzielczość strumienia w pikselach.

framerate

Opcjonalny

liczba

Opisuje liczbę klatek strumienia.
Zwroty

boolean Czy strumień można odtworzyć na urządzeniu Chromecast.

getApplicationData

Funkcja getApplicationData() zwraca wartość cast.framework.system.ApplicationData.

Gdy system będzie gotowy, podaje informacje o aplikacji. W przeciwnym razie zwraca 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 zwraca wartość null. Jeśli zwrócony zostanie pusty obiekt, urządzenie nie udostępnia żadnych informacji o funkcjach.

Zwroty

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

getDeviceInformation

Funkcja getDeviceInformation() zwraca obiekt 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 zwrócony zostanie 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, wartość będzie wynosić null. Jeśli platforma nie udostępnia tych informacji, może to być pusty obiekt.

getPlayerManager

Funkcja getPlayerManager() zwraca obiekt cast.framework.PlayerManager.

Uzyskaj instancję odtwarzacza, która umożliwia sterowanie odtwarzaniem multimediów i monitorowanie go.

Zwroty

non-null cast.framework.PlayerManager 

getSender

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

Pobieranie nadawcy według identyfikatora nadawcy

Parametr

senderId

ciąg znaków

Identyfikator nadawcy do zwrócenia.
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 ustalić, ponieważ telewizor nie obsługuje na przykład poleceń CEC, zwracana wartość to UNKNOWN.

getSystemState

getSystemState() zwraca cast.framework.system.SystemState

Zawiera informacje o aplikacji dotyczące stanu systemu.

Zwroty

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

getVisibilityState

Funkcja getVisibilityState() zwraca wartość cast.framework.system.VisibilityState.

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

Zwroty

non-null cast.framework.system.VisibilityState Czy aplikacja jest aktywnym wejściem HDMI. Jeśli nie można tego ustalić, ponieważ telewizor nie obsługuje poleceń CEC, zwracana jest wartość UNKNOWN.

isSystemReady

isSystemReady() zwraca wartość logiczną

Gdy rozpoczną się połączenia 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 połączy się z nią nadawca.

Zwroty

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

loadPlayerLibraries

loadPlayerLibraries(useLegacyDashSupport)

Rozpocznij ładowanie pliku js odtwarzacza. Można go użyć do rozpoczęcia wczytywania kodu JavaScript odtwarzaczy na wczesnym etapie uruchamiania odbiornika przed wywołaniem funkcji start. Jeśli odtwarzacze zostały już wczytane (wywołano funkcję start), ta funkcja nie wykonuje żadnych działań.

Parametr

useLegacyDashSupport

Opcjonalny

Wartość logiczna

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

removeCustomMessageListener

removeCustomMessageListener(namespace, listener)

Usuwa odbiorcę wiadomości zarejestrowanego wcześniej za pomocą funkcji CastReceiverContext#addCustomMessageListener.

Parametr

przestrzeń nazw

ciąg znaków

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

detektor

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

Funkcja odbiornika wiadomości do wyrejestrowania.
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.

Parametr

typ

cast.framework.system.EventType

Wartość nie może być pusta.

moduł obsługi

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

sendCustomMessage

sendCustomMessage(namespace, senderId, data)

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

Parametr

przestrzeń nazw

ciąg znaków

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

senderId

(ciąg znaków lub wartość nieokreślona)

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 ma dodać informacje o stanie debugowania do dziennika w raporcie z opinią. Przyjmuje parametr „message”, który jest ciągiem znaków reprezentującym informacje debugowania, które aplikacja chce zarejestrować.

Parametr

feedbackMessage

ciąg znaków
Wycofano
Użyj cast.framework.CastReceiverContext#setFeedbackHandler

setApplicationState

setApplicationState(statusText)

Ustawia stan aplikacji. Aplikacja powinna wywoływać tę funkcję, gdy zmieni się jej stan. Jeśli wartość jest niezdefiniowana lub ustawiona na pusty ciąg znaków, domyślnie używana jest nazwa aplikacji ustalona podczas rejestracji aplikacji.

Parametr

statusText

ciąg znaków

Tekst stanu.

setFeedbackHandler

setFeedbackHandler(feedbackHandler)

Ustawienie procedury obsługi, która będzie dostarczać dodatkowe dane do raportu z opinią. Funkcja obsługi zostanie wywołana po utworzeniu zgłoszenia opinii i powinna zwrócić dodatkowe dane w postaci ciągu znaków lub obietnicy ciągu znaków. Obietnica zwrotu powinna zostać zrealizowana w ciągu 5 sekund, aby została uwzględniona w raporcie.

Parametr

feedbackHandler

function()

Wartość może być pusta.

setInactivityTimeout

setInactivityTimeout(maxInactivity)

Ustawia limit czasu nieaktywności odbiornika. Zalecamy ustawienie maksymalnej wartości bezczynności podczas wywoływania funkcji Start i niezmienianie jej. Ten interfejs API jest udostępniany tylko na potrzeby programowania i debugowania.

Parametr

maxInactivity

liczba

Interwał w sekundach przed zamknięciem połączenia, które nie odpowiada.

setLoggerLevel

setLoggerLevel(level)

Ustawia poziom szczegółowości logów.

Parametr

poziom

cast.framework.LoggerLevel

Poziom rejestrowania.

Wartość nie może być pusta.

rozpocznij

start(options) zwraca cast.framework.CastReceiverContext

Inicjuje menedżera systemu i menedżera multimediów, aby aplikacja odbiorcy 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()

Zamknij aplikację odbiorczą.