chrome.
To jest przestrzeń nazw chrome.cast.
Zajęcia
ApiConfig
Przechowuje konfigurację interfejsu API po zainicjowaniu.
CredentialsData
Dane uwierzytelniające używane do identyfikowania danych logowania nadawcy.
DialRequest
Żądanie uruchomienia aplikacji DIAL.
Błąd
Opisuje błąd zwrócony przez interfejs API. Normalnie te obiekty nie powinny być tworzone przez klienta.
Image
Obraz opisujący aplikację odbiorcy lub element multimedialny. Może to być ikona aplikacji, okładka lub miniatura.
Odbiornik
Opisuje odbiorcę uruchamiającego aplikację. Normalnie te obiekty nie powinny być tworzone przez klienta.
ReceiverDisplayStatus
Stan odbiornika jest widoczny dla użytkownika w interfejsie rozszerzenia. Dotyczy tylko niestandardowych odbiorców.
SenderApplication
Opisuje aplikację nadawcy. Normalnie te obiekty nie powinny być tworzone przez klienta.
Sesja
Opisuje stan uruchomionej aktualnie aplikacji Cast. Normalnie te obiekty nie powinny być tworzone przez klienta.
SessionRequest
Prośba o rozpoczęcie sesji lub połączenie z nią.
Limit czasu
Określa domyślne wartości limitu czasu dla metod interfejsu API w milisekundach.
Głośność
Głośność urządzenia lub strumienia multimediów.
Przestrzeń nazw
media
Wyliczenia
AutoJoinPolicy
ciąg znaków
Zasada automatycznego łączenia określa, kiedy pakiet SDK automatycznie połączy aplikację nadawcy z istniejącą sesją po zainicjowaniu interfejsu API.
Wartość |
|
|---|---|
|
TAB_AND_ORIGIN_SCOPED |
ciąg znaków Łączy się automatycznie po rozpoczęciu sesji z tym samym identyfikatorem appId w tej samej karcie i w tym samym źródle strony. |
|
ORIGIN_SCOPED |
ciąg znaków Łączy się automatycznie po rozpoczęciu sesji z tym samym identyfikatorem appId i tym samym źródłem strony (niezależnie od karty). |
|
PAGE_SCOPED |
ciąg znaków Brak automatycznego połączenia. |
Funkcja
ciąg znaków
Funkcje obsługiwane przez urządzenie odbierające.
Wartość |
|
|---|---|
|
VIDEO_OUT |
ciąg znaków Odbiornik obsługuje wyjście wideo. |
|
AUDIO_OUT |
ciąg znaków Odbiornik obsługuje wyjście audio. |
|
VIDEO_IN |
ciąg znaków Aparat obsługuje wejście wideo (kamera). |
|
AUDIO_IN |
ciąg znaków Odbiornik obsługuje wejście audio (mikrofon). |
|
MULTIZONE_GROUP |
ciąg znaków Odbiornik reprezentuje grupę wielostrefową. |
DefaultActionPolicy
ciąg znaków
Domyślne zasady działań określają, kiedy pakiet SDK automatycznie utworzy sesję po zainicjowaniu interfejsu API. Określa to też domyślne działanie karty w wyskakującym okienku rozszerzenia.
Wartość |
|
|---|---|
|
CREATE_SESSION |
ciąg znaków Jeśli podczas inicjowania interfejsu API jest przesyłana karta zawierająca aplikację, pakiet SDK zatrzymuje przesyłanie kart i automatycznie uruchamia aplikację. Wyskakujące okienko rozszerzenia zachęca użytkownika do przesyłania aplikacji. |
|
CAST_THIS_TAB |
ciąg znaków Po zainicjowaniu interfejsu API nie następuje automatyczne uruchamianie, nawet jeśli karta jest rzutowana. Wyskakujące okienko rozszerzenia zachęca użytkownika do przesyłania karty. |
DialAppState
ciąg znaków
Możliwe stany aplikacji DIAL.
Wartość |
|
|---|---|
|
BIEGANIE |
ciąg znaków |
|
ZATRZYMANO |
ciąg znaków |
|
BŁĄD |
ciąg znaków Nie są częścią specyfikacji, służą do sygnalizowania błędów. |
ErrorCode
ciąg znaków
Błędy, które może zwrócić pakiet SDK.
Wartość |
|
|---|---|
|
ANULUJ |
ciąg znaków Operacja została anulowana przez użytkownika. |
|
PRZEJDŹ NA CZAS TRWANIA |
ciąg znaków Operacja przekroczyła limit czasu. |
|
API_NOT_INITIALIZED |
ciąg znaków Interfejs API nie został zainicjowany. |
|
INVALID_PARAMETER |
ciąg znaków Parametry operacji były nieprawidłowe. |
|
EXTENSION_NOT_COMPATIBLE |
ciąg znaków Skrypt interfejsu API jest niezgodny z zainstalowanym rozszerzeniem Cast. |
|
EXTENSION_MISSING |
ciąg znaków Rozszerzenie Cast jest niedostępne. |
|
RECEIVER_UNAVAILABLE |
ciąg znaków Żaden odbiornik nie był zgodny z żądaniem sesji. |
|
SESSION_ERROR |
ciąg znaków Nie udało się utworzyć sesji lub była ona nieprawidłowa. |
|
CHANNEL_ERROR |
ciąg znaków Kanał do odbiornika jest niedostępny. |
|
LOAD_MEDIA_FAILED |
ciąg znaków Nie udało się wczytać multimediów. |
ReceiverAction
ciąg znaków
Działania, które użytkownik może wykonać na odbiorniku w rozszerzeniu. Pozwalają one pokazać przejście w interfejsie aplikacji nadawcy, zanim działanie przesyłania zostanie ukończone (lub nieudane).
Wartość |
|
|---|---|
|
CAST |
ciąg znaków Użytkownik wybrał odbiornik z zamiarem przesyłania do niego za pomocą aplikacji nadawcy. Dokładna tożsamość odbiorcy może być nieznana. |
|
STOP |
ciąg znaków Użytkownik poprosił o zatrzymanie sesji na odbiorniku. |
ReceiverAvailability
ciąg znaków
Opisuje dostępność odbiornika.
Wartość |
|
|---|---|
|
DOSTĘPNE |
ciąg znaków Dostępny jest co najmniej 1 odbiornik zgodny z żądaniem sesji. |
|
PRODUKT NIEDOSTĘPNY |
ciąg znaków Brak dostępnych odbiorników. |
ReceiverType
ciąg znaków
Wartość |
|
|---|---|
|
CAST |
ciąg znaków Odbiornik Cast, np. Chromecast |
|
DIAL |
ciąg znaków Urządzenie DIAL, np. telewizor smart TV |
|
HANGOUT |
ciąg znaków Spotkanie |
|
NIESTANDARDOWA |
ciąg znaków Niestandardowy odbiornik dostarczony przez klienta |
SenderPlatform
ciąg znaków
Opis platformy aplikacji nadawcy.
Wartość |
|
|---|---|
|
CHROME |
ciąg znaków |
|
IOS |
ciąg znaków |
|
ANDROID |
ciąg znaków |
SessionStatus
ciąg znaków
Opisuje stan sesji przesyłania do aplikacji odbierającej.
Wartość |
|
|---|---|
|
POŁĄCZONY |
ciąg znaków Sesja jest połączona z aplikacją odbierającą. |
|
ODŁĄCZONY |
ciąg znaków Sesja została odłączona od aplikacji odbierającej. Aplikacja odbierająca może być nadal uruchomiona, ale nie musi. |
|
ZATRZYMANO |
ciąg znaków Aplikacja odbierająca została zatrzymana. |
VolumeControlType
ciąg znaków
Opisuje typy regulacji głośności.
Wartość |
|
|---|---|
|
ZWRACANIE UWAGI |
ciąg znaków Głośność urządzenia przesyłającego można zmienić. |
|
NAPRAWO |
ciąg znaków Głośność urządzenia przesyłającego jest stała i nie można jej zmienić. |
|
MASTER |
ciąg znaków Główna regulacja głośności, tj. zmiana głośności telewizora lub urządzenia audio. |
Właściwości
AutoJoinPolicy
ciąg znaków
Zasada automatycznego łączenia określa, kiedy pakiet SDK automatycznie połączy aplikację nadawcy z istniejącą sesją po zainicjowaniu interfejsu API.
Wartość |
|
|---|---|
|
TAB_AND_ORIGIN_SCOPED |
ciąg znaków Łączy się automatycznie po rozpoczęciu sesji z tym samym identyfikatorem appId w tej samej karcie i w tym samym źródle strony. |
|
ORIGIN_SCOPED |
ciąg znaków Łączy się automatycznie po rozpoczęciu sesji z tym samym identyfikatorem appId i tym samym źródłem strony (niezależnie od karty). |
|
PAGE_SCOPED |
ciąg znaków Brak automatycznego połączenia. |
Funkcja
ciąg znaków
Funkcje obsługiwane przez urządzenie odbierające.
Wartość |
|
|---|---|
|
VIDEO_OUT |
ciąg znaków Odbiornik obsługuje wyjście wideo. |
|
AUDIO_OUT |
ciąg znaków Odbiornik obsługuje wyjście audio. |
|
VIDEO_IN |
ciąg znaków Aparat obsługuje wejście wideo (kamera). |
|
AUDIO_IN |
ciąg znaków Odbiornik obsługuje wejście audio (mikrofon). |
|
MULTIZONE_GROUP |
ciąg znaków Odbiornik reprezentuje grupę wielostrefową. |
DefaultActionPolicy
ciąg znaków
Domyślne zasady działań określają, kiedy pakiet SDK automatycznie utworzy sesję po zainicjowaniu interfejsu API. Określa to też domyślne działanie karty w wyskakującym okienku rozszerzenia.
Wartość |
|
|---|---|
|
CREATE_SESSION |
ciąg znaków Jeśli podczas inicjowania interfejsu API jest przesyłana karta zawierająca aplikację, pakiet SDK zatrzymuje przesyłanie kart i automatycznie uruchamia aplikację. Wyskakujące okienko rozszerzenia zachęca użytkownika do przesyłania aplikacji. |
|
CAST_THIS_TAB |
ciąg znaków Po zainicjowaniu interfejsu API nie następuje automatyczne uruchamianie, nawet jeśli karta jest rzutowana. Wyskakujące okienko rozszerzenia zachęca użytkownika do przesyłania karty. |
DialAppState
ciąg znaków
Możliwe stany aplikacji DIAL.
Wartość |
|
|---|---|
|
BIEGANIE |
ciąg znaków |
|
ZATRZYMANO |
ciąg znaków |
|
BŁĄD |
ciąg znaków Nie są częścią specyfikacji, służą do sygnalizowania błędów. |
ErrorCode
ciąg znaków
Błędy, które może zwrócić pakiet SDK.
Wartość |
|
|---|---|
|
ANULUJ |
ciąg znaków Operacja została anulowana przez użytkownika. |
|
PRZEJDŹ NA CZAS TRWANIA |
ciąg znaków Operacja przekroczyła limit czasu. |
|
API_NOT_INITIALIZED |
ciąg znaków Interfejs API nie został zainicjowany. |
|
INVALID_PARAMETER |
ciąg znaków Parametry operacji były nieprawidłowe. |
|
EXTENSION_NOT_COMPATIBLE |
ciąg znaków Skrypt interfejsu API jest niezgodny z zainstalowanym rozszerzeniem Cast. |
|
EXTENSION_MISSING |
ciąg znaków Rozszerzenie Cast jest niedostępne. |
|
RECEIVER_UNAVAILABLE |
ciąg znaków Żaden odbiornik nie był zgodny z żądaniem sesji. |
|
SESSION_ERROR |
ciąg znaków Nie udało się utworzyć sesji lub była ona nieprawidłowa. |
|
CHANNEL_ERROR |
ciąg znaków Kanał do odbiornika jest niedostępny. |
|
LOAD_MEDIA_FAILED |
ciąg znaków Nie udało się wczytać multimediów. |
isAvailable
boolean
Oznacz do klientów, aby sprawdzić, czy interfejs API został załadowany.
ReceiverAction
ciąg znaków
Działania, które użytkownik może wykonać na odbiorniku w rozszerzeniu. Pozwalają one pokazać przejście w interfejsie aplikacji nadawcy, zanim działanie przesyłania zostanie ukończone (lub nieudane).
Wartość |
|
|---|---|
|
CAST |
ciąg znaków Użytkownik wybrał odbiornik z zamiarem przesyłania do niego za pomocą aplikacji nadawcy. Dokładna tożsamość odbiorcy może być nieznana. |
|
STOP |
ciąg znaków Użytkownik poprosił o zatrzymanie sesji na odbiorniku. |
ReceiverAvailability
ciąg znaków
Opisuje dostępność odbiornika.
Wartość |
|
|---|---|
|
DOSTĘPNE |
ciąg znaków Dostępny jest co najmniej 1 odbiornik zgodny z żądaniem sesji. |
|
PRODUKT NIEDOSTĘPNY |
ciąg znaków Brak dostępnych odbiorników. |
ReceiverType
ciąg znaków
Wartość |
|
|---|---|
|
CAST |
ciąg znaków Odbiornik Cast, np. Chromecast |
|
DIAL |
ciąg znaków Urządzenie DIAL, np. telewizor smart TV |
|
HANGOUT |
ciąg znaków Spotkanie |
|
NIESTANDARDOWA |
ciąg znaków Niestandardowy odbiornik dostarczony przez klienta |
SenderPlatform
ciąg znaków
Opis platformy aplikacji nadawcy.
Wartość |
|
|---|---|
|
CHROME |
ciąg znaków |
|
IOS |
ciąg znaków |
|
ANDROID |
ciąg znaków |
SessionStatus
ciąg znaków
Opisuje stan sesji przesyłania do aplikacji odbierającej.
Wartość |
|
|---|---|
|
POŁĄCZONY |
ciąg znaków Sesja jest połączona z aplikacją odbierającą. |
|
ODŁĄCZONY |
ciąg znaków Sesja została odłączona od aplikacji odbierającej. Aplikacja odbierająca może być nadal uruchomiona, ale nie musi. |
|
ZATRZYMANO |
ciąg znaków Aplikacja odbierająca została zatrzymana. |
przerwa w grze
nie null chrome.cast.Timeout
Domyślne wartości czasu oczekiwania dla metod interfejsu API w milisekundach.
WERSJA
Tablica liczb niepustych
Wersja interfejsu API. Pierwsza cyfra to wersja główna, a druga wersja podrzędna.
VolumeControlType
ciąg znaków
Opisuje typy regulacji głośności.
Wartość |
|
|---|---|
|
ZWRACANIE UWAGI |
ciąg znaków Głośność urządzenia przesyłającego można zmienić. |
|
NAPRAWO |
ciąg znaków Głośność urządzenia przesyłającego jest stała i nie można jej zmienić. |
|
MASTER |
ciąg znaków Główna regulacja głośności, tj. zmiana głośności telewizora lub urządzenia audio. |
Metody
addReceiverActionListener
addReceiverActionListener(listener)
Dodaje funkcję detektora, która będzie wywoływana, gdy użytkownik wykona działanie w interfejsie użytkownika w celu rozpoczęcia lub zatrzymania przesyłania. Aplikacja nadawcy może użyć tych informacji, aby wyświetlić w interfejsie użytkownika przejście (np. wstrzymać lokalnie odtwarzanie multimediów) przed zakończeniem lub niepowodzeniem przesyłania.
- Nie ma gwarancji, że odbiornik zostanie wywołany i aplikacje nie powinny korzystać z niego do poprawnego działania.
- Odbiorca, na którym wykonano czynność, jest przekazywany do odbiornika, jeśli jest dostępny. Jednak odbiorca może nie być znany, a zamiast niego będzie przekazywana wartość null.
- Detektor zostanie wywołany jak najszybciej po wykonaniu działania przez użytkownika. Należy je wywołać, zanim aplikacja otrzyma powiadomienie o ostatecznej zmianie stanu za pomocą interfejsu API.
Jeśli korzystasz z interfejsu Framework API, użyj funkcji cast.framework.CastContext#addEventListener i nasłuchuj zdarzeń cast.framework.CastContextEventType#CAST_STATE_CHANGED.
Parametr |
|
|---|---|
|
detektor |
chrome.cast.ReceiverActionListener Funkcja odbiornika, która ma zostać dodana. Pierwszym argumentem dla odbiornika jest odbiornik, na którym zastosowano działanie. Drugi argument odbiornika to żądane działanie (patrz: chrome.cast.ReceivedrAction). Wartość nie może być wartością null. |
initialize
zainicjować(apiConfig, successfulCallback, errorCallback)
Inicjuje interfejs API. Pamiętaj, że po zakończeniu inicjowania interfejsu API zostaną wywołane zarówno sukcesyCallback, jak i errorCallback. Metody sessionListener i sendrListener można wywołać w dowolnym momencie później, a nawet więcej niż raz.
Jeśli korzystasz z interfejsu Framework API, zamiast tej funkcji użyj cast.framework.CastContext#setOptions.
Parametr |
|
|---|---|
|
apiConfig |
Obiekt z parametrami do zainicjowania interfejsu API. Wartość nie może być wartością null. |
|
successCallback |
function() |
|
errorCallback |
function(non-null chrome.cast.Error) Możliwe błędy: TIMEOUT, TRUE_PARAMETER, EXTENSION_MISSING. |
logMessage
logMessage(message)
Rejestruje wiadomość debugowania z aplikacji. Ta wiadomość może zostać wysłana do Google w formie raportu opinii, jeśli użytkownik wyraźnie zdecyduje się dołączyć szczegółowe dzienniki.
Parametr |
|
|---|---|
|
wiadomość |
ciąg znaków Wiadomość do zapisania. |
- Wycofano
- Nieobsługiwane w połączeniu z pakietem SDK Cast opartym na interfejsie Prezentacja API.
buforować w pamięci podręcznej
precache(dane)
Wyślij żądanie wstępnego buforowania danych. Jeśli sesja zostanie połączona, wyśle żądanie bezpośrednie. W przeciwnym razie zostanie wysłane do wszystkich urządzeń w sieci.
Parametr |
|
|---|---|
|
dane |
ciąg znaków Dane do wstępnego buforowania. |
- Wycofano
- Nieobsługiwane.
removeReceiverActionListener
removeReceiverActionListener(listener)
Usuwa funkcję odbiornika, która została wcześniej dodana za pomocą parametru addpickuprActionListener.
Parametr |
|
|---|---|
|
detektor |
chrome.cast.ReceiverActionListener Funkcja odbiornika, która ma zostać usunięta. Wartość nie może być wartością null. |
requestSession
requestSession(successCallback, errorCallback, sessionRequest)
Pyta o utworzenie lub dołączenie do sesji aplikacji odbierającej. Domyślnie używane jest żądanie SessionRequest przekazane do interfejsu API podczas inicjowania. Można to zastąpić, przekazując inne żądanie sesji w sessionRequest.
Jeśli korzystasz z interfejsu Framework API, zamiast tej funkcji użyj cast.framework.CastContext#requestSession.
Parametr |
|
|---|---|
|
successCallback |
function(non-null chrome.cast.Session) |
|
errorCallback |
function(non-null chrome.cast.Error) Możliwe błędy to: TIMEOUT, Część [NIEPRAWIDŁOWY], API_NOT_INITIALIZED, ANULUJ, CHANNEL_ERROR, SESSION_ERROR, RECEIVER_UNAVAILABLE i EXTENSION_MISSING. Pamiętaj, że licznik czasu oczekiwania zaczyna działać, gdy użytkownik wybierze odbiornik. Wybór odbiorcy wymaga działania użytkownika, które nie ma limitu czasu. Jeśli żądanie sesji jest już przetwarzane, wywoływana jest metoda errorCallback z kodem błędu FAILED_PARAMETER i opisem błędu. |
|
sessionRequest |
Opcjonalnie Wartość nie może być wartością null. |
requestSessionById
requestSessionById(sessionId)
Prośby o dołączenie do istniejącej sesji o podanym identyfikatorze. Po dołączeniu sesja jest przekazywana do elementu sessionListener ustawionego przez chrome.cast.initialize.
Jeśli sesja o danym identyfikatorze sesji jest już znana po wywołaniu tej funkcji, wywoływana jest natychmiast sessionListener. W przeciwnym razie po wykryciu sesji o danym identyfikatorze sesji zostanie wywołana funkcja sessionListener.
Parametr |
|
|---|---|
|
sessionId |
ciąg znaków Identyfikator sesji, do której chcesz dołączyć. |
setCustomReceivers
setCustomReceivers(receivers, successCallback, errorCallback)
Ustawia niestandardową listę odbiorców
Parametr |
|
|---|---|
|
odbiorcy |
Tablica chrome.cast.Receiver, która nie ma wartości pustej Nowa lista. Wartość nie może być wartością null. |
|
successCallback |
function() |
|
errorCallback |
function(non-null chrome.cast.Error) Możliwe błędy to TIMEOUT, API_NOT_INITIALIZED, blogspot_PARAMETER, CHANNEL_ERROR i EXTENSION_MISSRING. |
- Wycofano
- Nieobsługiwane w połączeniu z pakietem SDK Cast opartym na interfejsie Prezentacja API.
setPageContext
setPageContext(win)
Inicjuje funkcję przesyłania w przypadku strony, która wczytuje pakiet SDK Cast w elemencie iframe. Należy wywoływać po zainicjowaniu pakietu SDK.
Parametr |
|
|---|---|
|
wygrana |
Okno Obiekt w oknie strony. Wartość nie może być wartością null. |
setReceiverDisplayStatus
setReceiverDisplayStatus(receiver, successCallback, errorCallback)
Ustawia nazwę odbiorcy i stan wyświetlania. Aby wyświetlić odbiornik jako nieaktywny, ustaw wartość displayStatus na null.
Dotyczy tylko niestandardowych odbiorców. Wartość displayStatus odbiornika jest ignorowana, jeśli odbiornik to CAST. Stan odbiornika jest aktualizowany przez aplikację odbiorcy.
Parametr |
|
|---|---|
|
odbiornik |
Odbiorca. Wartość nie może być wartością null. |
|
successCallback |
function() Oddzwoń po pomyślnym ustawieniu stanu. |
|
errorCallback |
function(non-null chrome.cast.Error) Możliwe błędy to TIMEOUT, FAILED_PARAMETER, API_NOT_INITIALIZED i EXTENSION_MISSING. |
- Wycofano
- Nieobsługiwane w połączeniu z pakietem SDK Cast opartym na interfejsie Prezentacja API.
unescape
unescape(escape) zwraca ciąg znaków
Metoda cofania zmiany znaczenia ciągów znaków URI zawierających zmianę znaczenia. Na przykład przyjazna nazwa odbiorcy jest zwracana jako ciąg znaków ze zmianą znaczenia dla identyfikatora URI. Użyj tej metody, aby w razie potrzeby cofnąć zmianę znaczenia tego ciągu.
Parametr |
|
|---|---|
|
uciekł |
ciąg znaków Ciąg znaków, którego znaczenie ma być cofnięte |
- Akcje powrotne
-
stringCiąg znaków bez zmiany znaczenia
Typ abstrakcyjny
ReceiverActionListener
ReceiverActionListener()