Spazio dei nomi: cast

chrome.trasmetti

spazio dei nomi   statico

Questo è lo spazio dei nomi chrome.cast.

Corsi

ApiConfig

Contiene la configurazione dell'API al momento dell'inizializzazione.

CredentialsData

Dati delle credenziali utilizzati per identificare le credenziali del mittente.

DialRequest

Richiesta di avvio di un'app DIAL.

Errore

Descrive un errore restituito dall'API. Solitamente, questi oggetti non devono essere creati dal client.

Immagine

Un'immagine che descrive un'applicazione del destinatario o un elemento multimediale. Potrebbe essere l'icona dell'applicazione, la copertina o una miniatura.

Ricevitore

Descrive il destinatario che esegue un'applicazione. Solitamente, questi oggetti non devono essere creati dal client.

ReceiverDisplayStatus

Stato del destinatario mostrato all'utente nell'interfaccia utente dell'estensione. Valido solo per ricevitori PERSONALIZZATI.

SenderApplication

Descrive un'applicazione del mittente. Solitamente, questi oggetti non devono essere creati dal client.

Sessione

Descrive lo stato di un'applicazione Cast attualmente in esecuzione. Solitamente, questi oggetti non devono essere creati dal client.

SessionRequest

Una richiesta di avvio o connessione a una sessione.

Timeout

Definisce i valori di timeout predefiniti in millisecondi per i metodi API.

Volume

Il volume di un dispositivo o di uno stream multimediale.

Spazio dei nomi

contenuti multimediali

Enumerazioni

AutoJoinPolicy

statica

stringa

Il criterio di unione automatica determina quando l'SDK connetterà automaticamente un'applicazione mittente a una sessione esistente dopo l'inizializzazione dell'API.

Valore
TAB_AND_ORIGIN_SCOPED	stringa Si connette automaticamente quando la sessione è stata avviata con lo stesso appId, nella stessa scheda e nella stessa origine della pagina.
ORIGIN_SCOPED	stringa Si connette automaticamente quando la sessione è stata avviata con lo stesso appId e la stessa origine della pagina (indipendentemente dalla scheda).
PAGE_SCOPED	stringa Nessuna connessione automatica.

Capacità

statica

stringa

Funzionalità supportate dal dispositivo ricevitore.

Valore
VIDEO_OUT	stringa Il ricevitore supporta l'uscita video.
AUDIO_OUT	stringa Il ricevitore supporta l'uscita audio.
VIDEO_IN	stringa Il ricevitore supporta l'input video (videocamera).
AUDIO_IN	stringa Il ricevitore supporta l'input audio (microfono).
MULTIZONE_GROUP	stringa Il ricevitore rappresenta un gruppo multizona.

DefaultActionPolicy

statica

stringa

Il criterio di azione predefinito determina quando l'SDK creerà automaticamente una sessione dopo l'inizializzazione dell'API. Controlla anche l'azione predefinita per la scheda nel popup dell'estensione.

Valore
CREATE_SESSION	stringa Se la scheda contenente l'app viene trasmessa all'inizializzazione dell'API, l'SDK interrompe la trasmissione della scheda e avvia automaticamente l'app. Il popup dell'estensione chiede all'utente di trasmettere l'app.
CAST_THIS_TAB	stringa Dopo l'inizializzazione dell'API, non viene eseguito alcun avvio automatico, anche se la scheda viene trasmessa. Il popup dell'estensione chiede all'utente di trasmettere la scheda.

DialAppState

statica

stringa

Possibili stati di un'applicazione DIAL.

Valore
IN CORSO	stringa
INTERROTTO	stringa
ERRORE	stringa Non fanno parte delle specifiche e sono utilizzate per segnalare errori.

ErrorCode

statica

stringa

Errori che potrebbero essere restituiti dall'SDK.

Valore
ANNULLA	stringa L'operazione è stata annullata dall'utente.
TIMEOUT	stringa Timeout dell'operazione.
API_NOT_INITIALIZED	stringa L'API non è stata inizializzata.
INVALID_PARAMETER	stringa I parametri dell'operazione non erano validi.
EXTENSION_NOT_COMPATIBLE	stringa Lo script API non è compatibile con l'estensione Cast installata.
EXTENSION_MISSING	stringa L'estensione Cast non è disponibile.
RECEIVER_UNAVAILABLE	stringa Nessun destinatario compatibile con la richiesta di sessione.
SESSION_ERROR	stringa Impossibile creare una sessione oppure una sessione non è valida.
CHANNEL_ERROR	stringa Non è disponibile un canale per il destinatario.
LOAD_MEDIA_FAILED	stringa Caricamento dell'elemento multimediale non riuscito.

ReceiverAction

statica

stringa

Azioni che l'utente può eseguire su un destinatario nell'estensione. Questi possono essere utilizzati per mostrare una transizione nell'interfaccia utente dell'applicazione del mittente prima che l'azione di trasmissione sia stata completata (o non riuscita).

Valore
CAST	stringa L'utente ha selezionato un destinatario con l'intento di trasmettervi il messaggio con l'applicazione del mittente. Potrebbe non essere nota l'identità esatta del destinatario.
INTERROMPI	stringa L'utente ha richiesto di interrompere la sessione in esecuzione su un ricevitore.

ReceiverAvailability

statica

stringa

Descrive la disponibilità di un ricevitore di trasmissione.

Valore
AVAILABLE	stringa È disponibile almeno un destinatario compatibile con la richiesta di sessione.
NON DISPONIBILE	stringa Nessun ricevitore disponibile.

ReceiverType

statica

stringa

Valore
CAST	stringa Ricevitore di trasmissione, ad esempio Chromecast
QUADRANTE	stringa Dispositivo DIAL, ad es. smart TV
HANGOUT	stringa Ritrovo
PERSONALIZZATA	stringa Ricevitore personalizzato fornito dal client

SenderPlatform

statica

stringa

Descrive la piattaforma applicativa di un mittente.

Valore
CHROME	stringa
IOS	stringa
ANDROID	stringa

SessionStatus

statica

stringa

Descrive lo stato di una sessione di trasmissione nella relativa applicazione ricevitore.

Valore
CONNESSO	stringa La sessione è connessa all'applicazione del destinatario.
DISCONNESSO	stringa La sessione è disconnessa dall'applicazione del destinatario. L'applicazione destinatario potrebbe essere o non ancora in esecuzione.
INTERROTTO	stringa L'applicazione destinatario è stata arrestata.

VolumeControlType

statica

stringa

Descrive i tipi di controllo del volume.

Valore
ATTENUAZIONE	stringa È possibile modificare il volume del dispositivo di trasmissione.
FISSA	stringa Il volume del dispositivo di trasmissione è fisso e non può essere modificato.
MAESTRO	stringa Controllo del volume del sistema principale, ad esempio il volume della TV o del dispositivo audio viene modificato.

Proprietà

AutoJoinPolicy

statica

stringa

Il criterio di unione automatica determina quando l'SDK connetterà automaticamente un'applicazione mittente a una sessione esistente dopo l'inizializzazione dell'API.

Valore
TAB_AND_ORIGIN_SCOPED	stringa Si connette automaticamente quando la sessione è stata avviata con lo stesso appId, nella stessa scheda e nella stessa origine della pagina.
ORIGIN_SCOPED	stringa Si connette automaticamente quando la sessione è stata avviata con lo stesso appId e la stessa origine della pagina (indipendentemente dalla scheda).
PAGE_SCOPED	stringa Nessuna connessione automatica.

Capacità

statica

stringa

Funzionalità supportate dal dispositivo ricevitore.

Valore
VIDEO_OUT	stringa Il ricevitore supporta l'uscita video.
AUDIO_OUT	stringa Il ricevitore supporta l'uscita audio.
VIDEO_IN	stringa Il ricevitore supporta l'input video (videocamera).
AUDIO_IN	stringa Il ricevitore supporta l'input audio (microfono).
MULTIZONE_GROUP	stringa Il ricevitore rappresenta un gruppo multizona.

DefaultActionPolicy

statica

stringa

Il criterio di azione predefinito determina quando l'SDK creerà automaticamente una sessione dopo l'inizializzazione dell'API. Controlla anche l'azione predefinita per la scheda nel popup dell'estensione.

Valore
CREATE_SESSION	stringa Se la scheda contenente l'app viene trasmessa all'inizializzazione dell'API, l'SDK interrompe la trasmissione della scheda e avvia automaticamente l'app. Il popup dell'estensione chiede all'utente di trasmettere l'app.
CAST_THIS_TAB	stringa Dopo l'inizializzazione dell'API, non viene eseguito alcun avvio automatico, anche se la scheda viene trasmessa. Il popup dell'estensione chiede all'utente di trasmettere la scheda.

DialAppState

statica

stringa

Possibili stati di un'applicazione DIAL.

Valore
IN CORSO	stringa
INTERROTTO	stringa
ERRORE	stringa Non fanno parte delle specifiche e sono utilizzate per segnalare errori.

ErrorCode

statica

stringa

Errori che potrebbero essere restituiti dall'SDK.

Valore
ANNULLA	stringa L'operazione è stata annullata dall'utente.
TIMEOUT	stringa Timeout dell'operazione.
API_NOT_INITIALIZED	stringa L'API non è stata inizializzata.
INVALID_PARAMETER	stringa I parametri dell'operazione non erano validi.
EXTENSION_NOT_COMPATIBLE	stringa Lo script API non è compatibile con l'estensione Cast installata.
EXTENSION_MISSING	stringa L'estensione Cast non è disponibile.
RECEIVER_UNAVAILABLE	stringa Nessun destinatario compatibile con la richiesta di sessione.
SESSION_ERROR	stringa Impossibile creare una sessione oppure una sessione non è valida.
CHANNEL_ERROR	stringa Non è disponibile un canale per il destinatario.
LOAD_MEDIA_FAILED	stringa Caricamento dell'elemento multimediale non riuscito.

isAvailable

statica

boolean

Flag per i client che consente di verificare se l'API è stata caricata.

ReceiverAction

statica

stringa

Azioni che l'utente può eseguire su un destinatario nell'estensione. Questi possono essere utilizzati per mostrare una transizione nell'interfaccia utente dell'applicazione del mittente prima che l'azione di trasmissione sia stata completata (o non riuscita).

Valore
CAST	stringa L'utente ha selezionato un destinatario con l'intento di trasmettervi il messaggio con l'applicazione del mittente. Potrebbe non essere nota l'identità esatta del destinatario.
INTERROMPI	stringa L'utente ha richiesto di interrompere la sessione in esecuzione su un ricevitore.

ReceiverAvailability

statica

stringa

Descrive la disponibilità di un ricevitore di trasmissione.

Valore
AVAILABLE	stringa È disponibile almeno un destinatario compatibile con la richiesta di sessione.
NON DISPONIBILE	stringa Nessun ricevitore disponibile.

ReceiverType

statica

stringa

Valore
CAST	stringa Ricevitore di trasmissione, ad esempio Chromecast
QUADRANTE	stringa Dispositivo DIAL, ad es. smart TV
HANGOUT	stringa Ritrovo
PERSONALIZZATA	stringa Ricevitore personalizzato fornito dal client

SenderPlatform

statica

stringa

Descrive la piattaforma applicativa di un mittente.

Valore
CHROME	stringa
IOS	stringa
ANDROID	stringa

SessionStatus

statica

stringa

Descrive lo stato di una sessione di trasmissione nella relativa applicazione ricevitore.

Valore
CONNESSO	stringa La sessione è connessa all'applicazione del destinatario.
DISCONNESSO	stringa La sessione è disconnessa dall'applicazione del destinatario. L'applicazione destinatario potrebbe essere o non ancora in esecuzione.
INTERROTTO	stringa L'applicazione destinatario è stata arrestata.

timeout

statica

non null chrome.cast.Timeout

Valori di timeout predefiniti in millisecondi per i metodi API.

VERSIONE

costante   statica

non-null Array del numero

La versione dell'API. Il primo numero indica la versione principale e il secondo la versione secondaria.

VolumeControlType

statica

stringa

Descrive i tipi di controllo del volume.

Valore
ATTENUAZIONE	stringa È possibile modificare il volume del dispositivo di trasmissione.
FISSA	stringa Il volume del dispositivo di trasmissione è fisso e non può essere modificato.
MAESTRO	stringa Controllo del volume del sistema principale, ad esempio il volume della TV o del dispositivo audio viene modificato.

Metodi

addReceiverActionListener

statica

addReceiverActionListener(listener)

Aggiunge una funzione listener che verrà richiamata quando l'utente ha avviato o interrotto la trasmissione tramite l'interfaccia utente. L'applicazione del mittente può utilizzare questa impostazione per mostrare una transizione nell'interfaccia utente (ad esempio, mettere in pausa la riproduzione locale di contenuti multimediali) prima che l'azione di trasmissione sia completata o non sia completata.

• Non è garantito che il listener venga richiamato e le applicazioni non devono utilizzarlo per funzionare correttamente.
• Il listener passerà al destinatario su cui è stata eseguita l'azione, se disponibile. Tuttavia, il destinatario potrebbe non essere noto e verrà passato un valore null.
• Il listener verrà chiamato non appena possibile dopo l'azione dell'utente. Deve essere richiamato prima che l'applicazione riceva una notifica della modifica di stato risultante tramite l'API.

Se utilizzi l'API Framework, utilizza invece cast.framework.CastContext#addEventListener e ascolta gli eventi cast.framework.CastContextEventType#CAST_STATE_CHANGED.

Parametro
listener	chrome.cast.ReceiverActionListener La funzione listener da aggiungere. Il primo argomento per l'ascoltatore è il destinatario su cui è stata eseguita l'azione. Il secondo argomento per il listener è l'azione richiesta (vedi chrome.cast.RicevirAction). Il valore non deve essere nullo.

initialize

statica

inizializza(apiConfig, successCallback, errorCallback)

Inizializza l'API. Tieni presente che successCallback ed errorCallback verranno richiamati al termine dell'inizializzazione dell'API. sessioneListener e ricevimentListener possono essere richiamati in qualsiasi momento dopo, e possibilmente più di una volta.

Se usi l'API Framework, usa cast.framework.CastContext#setOptions anziché questa funzione.

Parametro
apiConfig	chrome.cast.ApiConfig L'oggetto con i parametri per inizializzare l'API. Il valore non deve essere nullo.
successCallback	funzione()
errorCallback	function(non-null chrome.cast.Error) Gli errori possibili sono TIMEOUT, INVALID_PARAMETER, EXTENSION_MISSING.

logMessage

statica

logMessage(message)

Registra un messaggio di debug dall'app. Questo messaggio può essere inviato sotto forma di report di feedback a Google se gli utenti scelgono esplicitamente di includere log dettagliati.

Parametro
messaggio	stringa Il messaggio da registrare.

Deprecata

Non supportato con l'SDK Cast basato sull'API Presentation.

pre-memorizzazione nella cache

statica

pre-cache(dati)

Invia una richiesta per pre-memorizzare nella cache i dati. Se una sessione è connessa, invierà una richiesta diretta, altrimenti verrà inviata a tutti i dispositivi nella rete.

Parametro
dati	stringa Dati da pre-memorizzare nella cache.

Deprecata

Non supportata.

removeReceiverActionListener

statica

removeReceiverActionListener(listener)

Rimuove una funzione listener che è stata aggiunta in precedenza con addRicevirActionListener.

Parametro
listener	chrome.cast.ReceiverActionListener La funzione listener da rimuovere. Il valore non deve essere nullo.

requestSession

statica

requestSession(successCallback, errorCallback, sessionRequest)

Richiede la creazione o la partecipazione di una sessione dell'applicazione destinatario. Per impostazione predefinita, viene utilizzata la SessionRequest passata all'API al momento dell'inizializzazione. Questo valore può essere sostituito passando una richiesta di sessione diversa in sessionRequest.

Se usi l'API Framework, usa cast.framework.CastContext#requestSession anziché questa funzione.

Parametro
successCallback	function(non-null chrome.cast.Session)
errorCallback	function(non-null chrome.cast.Error) I possibili errori sono TIMEOUT, INVALID_PARAMETER, API_NOT_INITIALIZED, CANCEL, CHANNEL_ERROR, SESSION_ERROR, RECEIVER_UNAVAILABLE ed EXTENSION_MISSING. Tieni presente che il timer di timeout inizia dopo che gli utenti selezionano un ricevitore. La selezione di un destinatario richiede l'azione dell'utente, che non ha timeout. Se una richiesta di sessione è già in corso, errorCallback viene richiamato con il codice di errore INVALID_PARAMETER e una descrizione che spiega l'errore.
sessionRequest	Facoltativo chrome.cast.SessionRequest Il valore non deve essere nullo.

requestSessionById

statica

requestSessionById(sessionId)

Richieste di partecipare a una sessione esistente con l'ID specificato. Una volta eseguita l'unione, la sessione verrà passata al sessionListener impostato da chrome.cast.initialize.

Se la sessione con il sessionId specificato è già nota quando viene richiamata questa funzione, sessionListener viene chiamato immediatamente. In caso contrario, una volta rilevata una sessione con il sessionId specificato, viene chiamata sessionListener.

Parametro
sessionId	stringa L'ID della sessione a cui partecipare.

setCustomReceivers

statica

setCustomReceivers(receivers, successCallback, errorCallback)

Imposta un elenco di destinatari personalizzato

Parametro
ricevitori	Array di chrome.cast.Receiver con valore non null Il nuovo elenco. Il valore non deve essere nullo.
successCallback	funzione()
errorCallback	function(non-null chrome.cast.Error) Gli errori possibili sono TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR ed EXTENSION_MISSRING.

Deprecata

Non supportato con l'SDK Cast basato sull'API Presentation.

setPageContext

statica

setPageContext(win)

Inizializza la funzionalità Cast per una pagina che carica l'SDK Cast in un iframe. Deve essere chiamato dopo l'inizializzazione dell'SDK.

Parametro
vittoria	Finestra Oggetto finestra pagina. Il valore non deve essere nullo.

setReceiverDisplayStatus

statica

setReceiverDisplayStatus(receiver, successCallback, errorCallback)

Imposta il nome del destinatario e lo stato di visualizzazione. Per mostrare il destinatario come inattivo, imposta displayStatus su null.

Valido solo per ricevitori PERSONALIZZATI. Lo stato display del ricevitore viene ignorato se questo ricevitore è CAST; lo stato del ricevitore di trasmissione viene aggiornato dall'applicazione del ricevitore.

Parametro
ricevitore	chrome.cast.Receiver Il destinatario. Il valore non deve essere nullo.
successCallback	funzione() Richiama quando lo stato dell'impostazione va a buon fine.
errorCallback	function(non-null chrome.cast.Error) Gli errori possibili sono TIMEOUT, INVALID_PARAMETER, API_NOT_INITIALIZED ed EXTENSION_MISSING.

Deprecata

Non supportato con l'SDK Cast basato sull'API Presentation.

unescape

statica

unescape(escape) restituisce stringa

Metodo di utilità per eliminare la sequenza di escape delle stringhe con l'URI. Ad esempio, il nome semplice del destinatario viene restituito come stringa con caratteri di escape URI. Utilizza questo metodo per eliminare il carattere di escape della stringa, se necessario.

Parametro
con escape	stringa Una stringa di cui eliminare la sequenza di escape

Ritorni

string Stringa senza caratteri di escape

Tipo astratto

ReceiverActionListener

statica

ReceiverActionListener()