Spazio dei nomi: cast

Chrome.Trasmetti

spazio dei nomi   statico

Questo è lo spazio dei nomi chrome.cast.

Corsi

APIConfig

Mantiene la configurazione per l'API quando viene inizializzata.

Credenziali

I 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. In genere, questi oggetti non devono essere creati dal client.

Immagine

Un'immagine che descrive un'applicazione o un elemento multimediale del ricevitore. ad esempio l'icona di un'applicazione, la copertina o una miniatura.

Destinatario

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

Stato ricevitore Display

Stato del destinatario mostrato all'utente nella UI delle estensioni. Valido solo per i ricevitori CUSTOM.

SenderApplication

Descrive un'applicazione mittente. In genere, questi oggetti non devono essere creati dal client.

Sessione

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

Richiesta di sessione

Una richiesta per avviare o connettersi a una sessione.

Timeout

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

Volume

Il volume di un dispositivo o stream multimediale.

Spazio dei nomi

contenuti multimediali

Enumerazioni

Criterio unione automatica

statico

stringa

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

Valore
TAB_AND_ORIGIN_SCOPED	stringa Si connette automaticamente all'avvio della sessione con lo stesso ID app, nella stessa scheda e nella stessa origine della pagina.
CAMPO DI ORIGINE	stringa Si connette automaticamente all'avvio della sessione con lo stesso ID app e la stessa origine della pagina (indipendentemente dalla scheda).
AMBITO_PAGINA	stringa Nessuna connessione automatica.

Capacità

statico

stringa

Funzionalità supportate dal dispositivo di ricezione.

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'ingresso video (videocamera).
AUDIO_IN	stringa Il ricevitore supporta l'ingresso audio (microfono).
MULTIZONE_GRUPPO	stringa Il ricevitore rappresenta un gruppo multizona.

CriterioAzione predefinito

statico

stringa

Il criterio di azione predefinito determina quando l'SDK crea automaticamente una sessione dopo l'inizializzazione dell'API. Viene inoltre controllata l'azione predefinita per la scheda nel popup dell'estensione.

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

DialAppState

statico

stringa

Possibili stati di un'applicazione DIAL.

Valore
CORSA	stringa
INTERROTTO	stringa
ERRORE	stringa Non fa parte della specifica, utilizzata per segnalare errori.

ErrorCode

statico

stringa

Errori che potrebbero essere restituiti dall'SDK.

Valore
ANNULLA	stringa L'operazione è stata annullata dall'utente.
Timeout	stringa L'operazione è scaduta.
API_NOT_INITIALIZED	stringa L'API non è stata inizializzata.
VALORE_NON VALIDO	stringa I parametri dell'operazione non erano validi.
ESTENSIONE_NON_COMPATIBILE	stringa Lo script API non è compatibile con l'estensione di trasmissione installata.
ESTENSIONE_MANCANTE	stringa L'estensione Cast non è disponibile.
RICEVITORE_NON DISPONIBILE	stringa Nessun ricevitore compatibile con la richiesta di sessione.
SESSION_ERROR	stringa Impossibile creare una sessione. Sessione non valida.
CANALE_ERROR	stringa Non è disponibile un canale per il destinatario.
LOAD_MEDIA_FAILED	stringa Caricamento dei contenuti multimediali non riuscito.

Ricevitore azione

statico

stringa

Azioni che l'utente può eseguire su un ricevitore nell'estensione. Possono essere utilizzati per mostrare una transizione nell'UI dell'applicazione mittente prima che l'azione di trasmissione venga completata (o non vada a buon fine).

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

Ricevitore disponibilità

statico

stringa

Descrive la disponibilità di un ricevitore di trasmissione.

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

Tipo destinatario

statico

stringa

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

MittentePiattaforma

statico

stringa

Descrive una piattaforma dell'applicazione del mittente.

Valore
CHROME	stringa
IOS	stringa
ANDROID	stringa

Stato sessione

statico

stringa

Descrive lo stato di una sessione di trasmissione all'applicazione di ricezione.

Valore
CONNESSO	stringa La sessione è collegata all'applicazione ricevitore.
DISCONNESSO	stringa La sessione è disconnessa dall'applicazione ricevente. L'applicazione del destinatario potrebbe essere in esecuzione o meno.
INTERROTTO	stringa L'applicazione del ricevitore è stata interrotta.

Tipo controllo volume

statico

stringa

Descrive i tipi di controllo del volume.

Valore
ATTENUAZIONE	stringa Il volume del dispositivo di trasmissione può essere regolato.
CORRETTO	stringa Il volume del dispositivo di trasmissione è fisso e non può essere modificato.
MAESTRO	stringa Il controllo del volume dell'impianto principale, ad esempio il volume della TV o del dispositivo audio, viene modificato.

Proprietà

Criterio unione automatica

statico

stringa

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

Valore
TAB_AND_ORIGIN_SCOPED	stringa Si connette automaticamente all'avvio della sessione con lo stesso ID app, nella stessa scheda e nella stessa origine della pagina.
CAMPO DI ORIGINE	stringa Si connette automaticamente all'avvio della sessione con lo stesso ID app e la stessa origine della pagina (indipendentemente dalla scheda).
AMBITO_PAGINA	stringa Nessuna connessione automatica.

Capacità

statico

stringa

Funzionalità supportate dal dispositivo di ricezione.

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'ingresso video (videocamera).
AUDIO_IN	stringa Il ricevitore supporta l'ingresso audio (microfono).
MULTIZONE_GRUPPO	stringa Il ricevitore rappresenta un gruppo multizona.

CriterioAzione predefinito

statico

stringa

Il criterio di azione predefinito determina quando l'SDK crea automaticamente una sessione dopo l'inizializzazione dell'API. Viene inoltre controllata l'azione predefinita per la scheda nel popup dell'estensione.

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

DialAppState

statico

stringa

Possibili stati di un'applicazione DIAL.

Valore
CORSA	stringa
INTERROTTO	stringa
ERRORE	stringa Non fa parte della specifica, utilizzata per segnalare errori.

ErrorCode

statico

stringa

Errori che potrebbero essere restituiti dall'SDK.

Valore
ANNULLA	stringa L'operazione è stata annullata dall'utente.
Timeout	stringa L'operazione è scaduta.
API_NOT_INITIALIZED	stringa L'API non è stata inizializzata.
VALORE_NON VALIDO	stringa I parametri dell'operazione non erano validi.
ESTENSIONE_NON_COMPATIBILE	stringa Lo script API non è compatibile con l'estensione di trasmissione installata.
ESTENSIONE_MANCANTE	stringa L'estensione Cast non è disponibile.
RICEVITORE_NON DISPONIBILE	stringa Nessun ricevitore compatibile con la richiesta di sessione.
SESSION_ERROR	stringa Impossibile creare una sessione. Sessione non valida.
CANALE_ERROR	stringa Non è disponibile un canale per il destinatario.
LOAD_MEDIA_FAILED	stringa Caricamento dei contenuti multimediali non riuscito.

È disponibile

statico

booleano

Segnala ai client di verificare se l'API è stata caricata.

Ricevitore azione

statico

stringa

Azioni che l'utente può eseguire su un ricevitore nell'estensione. Possono essere utilizzati per mostrare una transizione nell'UI dell'applicazione mittente prima che l'azione di trasmissione venga completata (o non vada a buon fine).

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

Ricevitore disponibilità

statico

stringa

Descrive la disponibilità di un ricevitore di trasmissione.

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

Tipo destinatario

statico

stringa

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

MittentePiattaforma

statico

stringa

Descrive una piattaforma dell'applicazione del mittente.

Valore
CHROME	stringa
IOS	stringa
ANDROID	stringa

Stato sessione

statico

stringa

Descrive lo stato di una sessione di trasmissione all'applicazione di ricezione.

Valore
CONNESSO	stringa La sessione è collegata all'applicazione ricevitore.
DISCONNESSO	stringa La sessione è disconnessa dall'applicazione ricevente. L'applicazione del destinatario potrebbe essere in esecuzione o meno.
INTERROTTO	stringa L'applicazione del ricevitore è stata interrotta.

timeout

statico

chrome.cast.Timeout non null

Valori di timeout predefiniti in millisecondi per i metodi API.

VERSIONE

costante   statico

Array di numeri non null

La versione API. Il primo numero è la versione principale e la seconda la versione secondaria.

Tipo controllo volume

statico

stringa

Descrive i tipi di controllo del volume.

Valore
ATTENUAZIONE	stringa Il volume del dispositivo di trasmissione può essere regolato.
CORRETTO	stringa Il volume del dispositivo di trasmissione è fisso e non può essere modificato.
MAESTRO	stringa Il controllo del volume dell'impianto principale, ad esempio il volume della TV o del dispositivo audio, viene modificato.

Metodi

addiceraction listener

statico

addRicevirAction listener(ascoltatore)

Aggiunge una funzione listener che viene richiamata quando l'utente ha agito tramite l'interfaccia utente per avviare o interrompere la trasmissione. L'applicazione del mittente può utilizzare questa opzione per mostrare la transizione nella sua interfaccia utente (ad es. mettere in pausa la riproduzione di contenuti multimediali localmente) prima che l'azione di trasmissione venga completata o non vada a buon fine.

• Non è garantito che il listener venga richiamato e le applicazioni non devono affidarsi al comando per funzionare correttamente.
• Se disponibile, il listener trasmetterà il destinatario su cui è stato eseguito. Tuttavia, il destinatario potrebbe non essere noto e verrà restituito un valore null.
• Il listener verrà chiamato il prima possibile dopo che l'utente ha eseguito un'azione. Deve essere richiamato prima che l'applicazione riceva una notifica della modifica dello stato risultante tramite l'API.

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

Parametro
listener	chrome.cast.RicevitoreActionAction La funzione listener da aggiungere. Il primo argomento per il listener è il destinatario su cui è stato eseguito un'azione. Il secondo argomento per il listener è l'azione richiesta (vedi chrome.cast.RicevirAction). Il valore non deve essere null.

initialize

statico

inizializzare(apiConfig, successoCallback, errorCallback)

Inizializza l'API. Nota che SuccessCallback ed errorCallback verranno richiamati al termine dell'inizializzazione dell'API. Il sessionggette e il listener listener possono essere richiamati in qualsiasi momento successivo e possibilmente più di una volta.

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

Parametro
apiConfig	chrome.cast.ApiConfig L'oggetto con parametri per inizializzare l'API. Il valore non deve essere null.
chiamata di successo	funzione()
erroreChiamata	function(non-null chrome.cast.Error) I possibili errori sono TIMEOUT, INVALID_PARAMETER, EXTENSION_MISSING.

logMessage

statico

logMessage(messaggio)

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

Parametro
messaggio	stringa Il messaggio da registrare.

Deprecato

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

pre-memorizzazione nella cache

statico

precache(dati)

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

Parametro
dati	stringa Dati da pre-memorizzare nella cache.

Deprecato

Non supportato.

removericeraction listener

statico

removeRicezionerAction listener(ascoltatore)

Rimuove una funzione listener aggiunta in precedenza con addRicevirAction listener.

Parametro
listener	chrome.cast.RicevitoreActionAction La funzione listener da rimuovere. Il valore non deve essere null.

richiestaSessione

statico

requestSession(successCallback, errorCallback, sessionRequest)

Richieste di creazione o partecipazione a una sessione di applicazione di ricezione. Per impostazione predefinita, viene utilizzato l'API SessionRequest al momento dell'inizializzazione. Questa operazione può essere sostituita passando in una richiesta di sessione diversa in sessionRequest.

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

Parametro
chiamata di successo	function(non-null chrome.cast.Session)
erroreChiamata	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 hanno selezionato un destinatario. La selezione di un destinatario richiede l'intervento dell'utente, senza timeout. Se è già in corso una richiesta di sessione, errorCallback viene richiamato con il codice di errore INVALID_PARAMETER e una descrizione che spiega l'errore.
Richiesta di sessione	Facoltativo chrome.cast.SessionRequest Il valore non deve essere null.

requestSessionById

statico

requestSessionById(sessionId)

Richieste di partecipazione a una sessione esistente con l'ID specificato. Una volta raggiunta la sessione, la sessione verrà passata allo sessionsession impostato da chrome.cast.inizializzazione.

Se la sessione con il sessionId specificato è già nota quando questa funzione viene chiamata, sessionsession viene chiamata immediatamente. In caso contrario, una volta scoperta una sessione con il dato sessionId, sessioncall sarà chiamato.

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

impostaCustomRicevitori

statico

setCustomRecipientrs(recipients, SuccessCallback, errorCallback)

Consente di impostare l'elenco personalizzato di destinatari

Parametro
ricevitori	Array di chrome.cast.Ricezioneto non null Il nuovo elenco. Il valore non deve essere null.
chiamata di successo	funzione()
erroreChiamata	function(non-null chrome.cast.Error) I possibili errori sono TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR ed EXTENSION_MISSRING.

Deprecato

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

contesto pagina

statico

setPageContext(win)

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

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

ImpostaRicevitoreStatoStato

statico

setReceivedrDisplayStatus(ricevitore, chiamata di successo, erroreChiamata)

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

Valido solo per i ricevitori CUSTOM. Lo stato di ricezione del display viene ignorato se il ricevitore è CAST; lo stato del ricevitore di trasmissione viene aggiornato dall'applicazione del ricevitore.

Parametro
ricevitore	chrome.cast.Ricezione Il destinatario. Il valore non deve essere null.
chiamata di successo	funzione() Callback quando l'impostazione dello stato ha esito positivo.
erroreChiamata	function(non-null chrome.cast.Error) I possibili errori sono TIMEOUT, INVALID_PARAMETER, API_NOT_INITIALIZED ed EXTENSION_MISSING.

Deprecato

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

unescape

statico

unescape(escape) restituisce stringa

Metodo di utilità per annullare l'escape delle stringhe con escape. Ad esempio, il nome ottimizzato per il destinatario viene restituito come stringa con escape URI. Utilizza questo metodo per annullare l'escape della stringa, se necessario.

Parametro
con escape	stringa Una stringa per annullare l'escape

Valori restituiti

string Stringa senza caratteri di escape

Tipo astratto

Ricevitore Azione Ascoltatore

statico

RicevitoreAzione Ascolta()