Lezione: Sessione

Costruttore

Sessione

new Session(sessionId, appId, displayName, appImages, ricevitore)

Parametro

sessionId

stringa

L'identificatore di sessione.

appId

stringa

L'identificatore dell'applicazione destinatario.

displayName

stringa

Il nome visualizzato dell'applicazione.

appImages

Array di chrome.cast.Image con valore non null

Immagini associate all'app.

Il valore non deve essere nullo.

ricevitore

chrome.cast.Receiver

Il destinatario che esegue l'app.

Il valore non deve essere nullo.

Proprietà

appId

stringa

L'identificatore dell'applicazione Cast. Non da visualizzare.

appImages

non-null Array di chrome.cast.Image non-null

Array di immagini disponibili che descrivono l'applicazione.

displayName

stringa

Il nome leggibile dell'applicazione Cast, ad esempio "YouTube".

media

non-null Array di chrome.cast.media.Media con valore non null

I contenuti multimediali appartenenti a questa sessione di trasmissione, inclusi quelli caricati da altri mittenti.

namespaces

non-null Array di {name: string}

Un elenco degli spazi dei nomi supportati dall'applicazione destinatario.

ricevitore

chrome.cast.Receiver non null

Il destinatario che esegue l'applicazione.

senderApps

non-null Array di chrome.cast.SenderApplication non null

Le applicazioni del mittente supportate dall'applicazione del destinatario. Può essere utilizzato per richiedere all'utente di installare o visitare l'applicazione del mittente.

sessionId

stringa

Identifica in modo univoco questa istanza dell'applicazione destinatario.

riconosciuto

non null chrome.cast.SessionStatus

Stato di questa sessione di trasmissione per l'applicazione del destinatario.

statusText

stringa con valore null

Testo descrittivo per il contenuto dell'applicazione corrente, ad esempio "La mia presentazione di nozze".

transportId

stringa

Identificatore che descrive in modo univoco questa sessione ai fini del trasporto. È interno al canale di comunicazione.

Metodi

addMediaListener

addMediaListener(listener)

Aggiunge un listener che viene richiamato quando un altro mittente crea una sessione multimediale.

Parametro

listener

function(non-null chrome.cast.media.Media)

Il listener da aggiungere.

addMessageListener

addMessageListener(namespace, listener)

Aggiunge un listener che viene richiamato quando viene ricevuto un messaggio dall'applicazione destinatario. Il listener viene richiamato con lo spazio dei nomi come primo argomento e il messaggio come secondo argomento.

Parametro

spazio dei nomi

stringa

Lo spazio dei nomi su cui rimanere in ascolto, ad esempio "urn:x-cast:com.example.namespace".

listener

funzione(stringa, stringa)

Il listener da aggiungere.

addUpdateListener

addUpdateListener(listener)

Aggiunge un listener che viene richiamato quando la sessione è stata modificata. Le modifiche alle seguenti proprietà attiveranno il listener: statusText, spazi dei nomi, stato e volume del destinatario.

I listener devono controllare la proprietà status della sessione per determinare lo stato della connessione. Il parametro booleano isAlive è deprecato a favore della proprietà della sessione status. Il parametro isAlive viene comunque trasmesso per la compatibilità con le versioni precedenti ed è true, a meno che status = chrome.cast.SessionStatus.STOPPED.

Parametro

listener

function(boolean)

Il listener da aggiungere.

getDialAppInfo

getDialAppInfo(successCallback, errorCallback)

Recupera le informazioni sull'app DIAL.

Parametro

successCallback

function(non-null chrome.cast.DialLaunchData)

errorCallback

function(non-null chrome.cast.Error)

se parti

lascia(successCallback, errorCallback)

Esce (disconnette) dall'applicazione ricevitore in esecuzione associata alla sessione.

I client esistenti nell'ambito definito da AutojoinPolicy di questo client verranno disconnessi. I futuri clienti non parteciperanno automaticamente alla sessione interrotta.

I listener di aggiornamento della sessione di tutti i client disconnessi verranno chiamati con isAlive = true. I listener devono controllare la proprietà status della sessione per determinare lo stato della connessione poiché isAlive è deprecato. In questo caso, status = chrome.cast.SessionStatus.DISCONNECTED.

Parametro

successCallback

funzione()

errorCallback

function(non-null chrome.cast.Error)

I possibili errori sono TIMEOUT, API_NOT_INITIALIZED, CHANNEL_ERROR, SESSION_ERROR ed EXTENSION_MISSING.

loadMedia

loadMedia(loadRequest, successCallback, errorCallback)

Carica contenuti multimediali in un'applicazione ricevitore in esecuzione.

Parametro

loadRequest

chrome.cast.media.LoadRequest

Richiedi il caricamento dei contenuti multimediali.

Il valore non deve essere nullo.

successCallback

function(non-null chrome.cast.media.Media)

Richiamato con il file multimediale caricato in caso di esito positivo.

errorCallback

function(non-null chrome.cast.Error)

Richiamato in caso di errore. Gli errori possibili sono TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR ed EXTENSION_MISSING.

queueLoad

queueLoad(queueLoadRequest, successCallback, errorCallback)

Carica e, facoltativamente, avvia la riproduzione di una nuova coda di elementi multimediali in un'applicazione ricevitore in esecuzione.

Parametro

queueLoadRequest

chrome.cast.media.QueueLoadRequest

Richiedi il caricamento di una nuova coda di elementi multimediali.

Il valore non deve essere nullo.

successCallback

function(non-null chrome.cast.media.Media)

Richiamato con il file multimediale caricato in caso di esito positivo.

errorCallback

function(non-null chrome.cast.Error)

Richiamato in caso di errore. Gli errori possibili sono TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR ed EXTENSION_MISSING.

Deprecata
Utilizza cast.framework.CastSession#loadMedia e fornisci gli elementi chrome.cast.media.LoadRequest#queueData pertinenti.

removeMediaListener

removeMediaListener(listener)

Rimuove un listener aggiunto in precedenza con addMediaListener.

Parametro

listener

function(non-null chrome.cast.media.Media)

Il listener da rimuovere.

removeMessageListener

removeMessageListener(namespace, listener)

Rimuove un listener aggiunto in precedenza per i messaggi.

Parametro

spazio dei nomi

stringa

Lo spazio dei nomi in ascolto, ad esempio "urn:x-cast:com.example.namespace".

listener

funzione(stringa, stringa)

Il listener da rimuovere.

removeUpdateListener

removeUpdateListener(listener)

Rimuove un listener aggiunto in precedenza per questa sessione.

Parametro

listener

function(boolean)

Il listener da rimuovere.

sendMessage

sendMessage(namespace, message, successCallback, errorCallback)

Invia un messaggio all'applicazione destinatario nello spazio dei nomi specificato. La funzionalità successCallback viene richiamata quando il messaggio è stato inviato al canale di messaggistica. La consegna all'applicazione del destinatario è la soluzione migliore e non è garantita.

Parametro

spazio dei nomi

stringa

Lo spazio dei nomi per cui inviare il messaggio, ad esempio "urn:x-cast:com.example.namespace".

messaggio

(non-null Object or string)

successCallback

funzione()

Richiamato quando il messaggio è stato inviato.

errorCallback

function(non-null chrome.cast.Error)

Richiamato in caso di errore. Gli errori possibili sono TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR ed EXTENSION_MISSING.

setReceiverMuted

setReceiverMuted(muted, successCallback, errorCallback)

Imposta il volume del ricevitore.

Parametro

audio disattivato

boolean

Il nuovo stato disattivato.

successCallback

funzione()

errorCallback

function(non-null chrome.cast.Error)

Gli errori possibili sono TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR ed EXTENSION_MISSING.

setReceiverVolumeLevel

setReceiverVolumeLevel(newLevel, successCallback, errorCallback)

Imposta il volume del ricevitore.

Parametro

newLevel

numero

Il nuovo livello di volume compreso tra 0,0 e 1,0.

successCallback

funzione()

errorCallback

function(non-null chrome.cast.Error)

Gli errori possibili sono TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR ed EXTENSION_MISSING.

Scalo

stop(successCallback, errorCallback)

Arresta l'esecuzione dell'applicazione ricevitore associata alla sessione.

Parametro

successCallback

funzione()

errorCallback

function(non-null chrome.cast.Error)

I possibili errori sono TIMEOUT, API_NOT_INITIALIZED, CHANNEL_ERROR, SESSION_ERROR ed EXTENSION_MISSING.