Classe: CastRicevirContext

cast.framework.CastReceiverContext

class   static

Gestisce il caricamento delle librerie sottostanti e inizializza l'SDK del ricevitore Cast sottostante.

Genera

non-null Error Se MediaElement non viene creato nel corpo del documento. Se vengono creati più elementi multimediali, lo sviluppatore deve impostare la classe "castMediaElement" su uno di questi, che verrà utilizzato dal ricevitore CAF.

Metodi

getInstance

static

getInstance() restituisce cast.framework.CastReceiverContext

Restituisce l'istanza singleton CastReceiverContext.

Resi

non-null cast.framework.CastReceiverContext 

addCustomMessageListener

addCustomMessageListener(namespace, listener)

Configura un listener di messaggi per un canale di messaggi personalizzato. È consentito più di un listener per uno spazio dei nomi.

Parametro
spazio dei nomi	stringa Lo spazio dei nomi. Tieni presente che uno spazio dei nomi valido deve essere preceduto dalla stringa "urn:x-cast:".
listener	function(non-null cast.framework.system.Message)

Genera

Error Se il sistema non è pronto o lo spazio dei nomi non è supportato da questa applicazione.

addEventListener

addEventListener(type, handler)

Aggiungi un listener per trasmettere gli eventi di sistema.

Parametro
tipo	cast.framework.system.EventType Il valore non deve essere null.
handler	function(non-null cast.framework.system.Event)

canDisplayType

canDisplayType(mimeType, codecs, width, height, framerate) restituisce un valore booleano

Controlla se i parametri multimediali specificati degli stream video o audio sono supportati dalla piattaforma.

Parametro
mimeType	stringa Tipo MIME dei contenuti multimediali. È costituito da un tipo e da un sottotipo separati da "/". Può essere un tipo MIME video o audio.
codec	Facoltativo stringa La stringa tra virgolette contiene un elenco separato da virgole di formati, in cui ogni formato specifica un tipo di campione multimediale presente nello stream.
larghezza	Facoltativo numero Descrive la risoluzione orizzontale dello stream in pixel.
altezza	Facoltativo numero Descrive la risoluzione verticale dello stream in pixel.
framerate	Facoltativo numero Descrive la frequenza fotogrammi dello stream.

Resi

boolean Se lo stream può essere riprodotto su Chromecast.

getApplicationData

getApplicationData() restituisce cast.framework.system.ApplicationData

Fornisce informazioni sull'applicazione quando il sistema è pronto, altrimenti sarà null.

Resi

nullable cast.framework.system.ApplicationData Le informazioni sull'applicazione o null se il sistema non è pronto.

getDeviceCapabilities

getDeviceCapabilities() restituisce cast.framework.system.DeviceCapabilitiesObj

Fornisce informazioni sulle funzionalità del dispositivo quando il sistema è pronto, altrimenti sarà null. Se viene restituito un oggetto vuoto, il dispositivo non espone alcuna informazione sulle funzionalità.

Resi

nullable cast.framework.system.DeviceCapabilitiesObj Le informazioni sulle funzionalità del dispositivo (coppie chiave/valore). Sarà null se il sistema non è ancora pronto. Potrebbe essere un oggetto vuoto se la piattaforma non espone informazioni sulle funzionalità del dispositivo.

getDeviceInformation

getDeviceInformation() restituisce cast.framework.system.DeviceInformationObj

Fornisce informazioni di identificazione del dispositivo non correlate alle funzionalità una volta che il sistema è pronto, altrimenti sarà "null". Se viene restituito un oggetto vuoto, il dispositivo non espone queste informazioni.

Resi

nullable cast.framework.system.DeviceInformationObj Le informazioni sul dispositivo (coppie chiave/valore). Sarà null se il sistema non è ancora pronto. Potrebbe essere un oggetto vuoto se la piattaforma non espone queste informazioni.

getPlayerManager

getPlayerManager() restituisce cast.framework.PlayerManager

Ottieni l'istanza Player che può controllare e monitorare la riproduzione dei contenuti multimediali.

Resi

non-null cast.framework.PlayerManager 

getSender

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

Recupera un mittente in base all'ID mittente

Parametro
senderId	stringa L'ID del mittente da restituire.

Resi

nullable cast.framework.system.Sender 

getSenders

getSenders() returns Array of non-null cast.framework.system.Sender

Recupera un elenco dei mittenti attualmente connessi.

Resi

non-null Array of non-null cast.framework.system.Sender 

getStandbyState

getStandbyState() restituisce cast.framework.system.StandbyState

Segnala se l'ingresso HDMI dell'applicazione di trasmissione è in standby.

Resi

non-null cast.framework.system.StandbyState Indica se l'ingresso HDMI dell'applicazione è in standby o meno. Se non è possibile determinarlo, ad esempio perché la TV non supporta i comandi CEC, il valore restituito è UNKNOWN.

getSystemState

getSystemState() restituisce cast.framework.system.SystemState

Fornisce informazioni sull'applicazione relative allo stato del sistema.

Resi

non-null cast.framework.system.SystemState Lo stato del sistema.

getVisibilityState

getVisibilityState() restituisce cast.framework.system.VisibilityState

Segnala se l'applicazione di trasmissione è l'ingresso HDMI attivo.

Resi

non-null cast.framework.system.VisibilityState Indica se l'applicazione è l'ingresso HDMI attivo. Se non è possibile determinarlo, ad esempio perché la TV non supporta i comandi CEC, il valore restituito è UNKNOWN.

isSystemReady

isSystemReady() restituisce un valore booleano

Quando l'applicazione chiama start, il sistema invia l'evento ready per indicare che le informazioni sull'applicazione sono pronte e l'applicazione può inviare messaggi non appena viene connesso un mittente.

Resi

boolean Indica se il sistema è pronto o meno per elaborare i messaggi.

loadPlayerLibraries

loadPlayerLibraries(useLegacyDashSupport)

Inizia a caricare il file js del player. Può essere utilizzato per iniziare a caricare il codice JS dei player nella fase iniziale di avvio del ricevitore prima di chiamare start. Questa funzione non esegue alcuna operazione se i player sono già stati caricati (è stato chiamato start).

Parametro
useLegacyDashSupport	Facoltativo booleano Indica che MPL deve essere utilizzato per i contenuti DASH.

removeCustomMessageListener

removeCustomMessageListener(namespace, listener)

Rimuove un listener di messaggi precedentemente registrato con CastReceiverContext#addCustomMessageListener.

Parametro
spazio dei nomi	stringa Lo spazio dei nomi. Tieni presente che uno spazio dei nomi valido deve essere preceduto dalla stringa "urn:x-cast:".
listener	function(non-null cast.framework.system.Message) La funzione listener di messaggi di cui annullare la registrazione.

Genera

Error Se il sistema non è pronto o lo spazio dei nomi non è supportato da questa applicazione.

removeEventListener

removeEventListener(type, handler)

Rimuovi il listener per trasmettere gli eventi di sistema.

Parametro
tipo	cast.framework.system.EventType Il valore non deve essere null.
handler	function(non-null cast.framework.system.Event)

sendCustomMessage

sendCustomMessage(namespace, senderId, data)

Invia un messaggio a un mittente specifico.

Parametro
spazio dei nomi	stringa Lo spazio dei nomi. Tieni presente che uno spazio dei nomi valido deve essere preceduto dalla stringa "urn:x-cast:".
senderId	(stringa o non definito) senderId o undefined per la trasmissione a tutti i mittenti.
dati	qualsiasi tipo Il payload del messaggio. Il valore non deve essere null.

Genera

Error Se si è verificato un errore durante la preparazione del messaggio.

sendFeedbackMessage

sendFeedbackMessage(feedbackMessage)

Questa funzione deve essere chiamata in risposta all'evento feedbackstarted se l'applicazione aggiunge informazioni sullo stato di debug per accedere al report di feedback. Accetta un parametro "message", ovvero una stringa che rappresenta le informazioni di debug che l'applicazione vuole registrare.

Parametro
feedbackMessage	stringa

Deprecato

Utilizza cast.framework.CastReceiverContext#setFeedbackHandler

setApplicationState

setApplicationState(statusText)

Imposta lo stato dell'applicazione. L'applicazione deve chiamare questo metodo quando il suo stato cambia. Se non è definito o è impostato su una stringa vuota, per impostazione predefinita viene utilizzato il valore del nome dell'applicazione stabilito durante la registrazione dell'applicazione per lo stato dell'applicazione.

Parametro
statusText	stringa Il testo dello stato.

setFeedbackHandler

setFeedbackHandler(feedbackHandler)

Imposta un gestore per fornire dati aggiuntivi a un report di feedback. Il gestore verrà chiamato quando viene creato un feedback segnalato e deve restituire dati aggiuntivi sotto forma di stringa o di promessa di stringa. La promessa di ritorno deve essere risolta entro 5 secondi per essere inclusa nel report.

Parametro
feedbackHandler	function() Il valore può essere null.

setInactivityTimeout

setInactivityTimeout(maxInactivity)

Imposta il timeout di inattività del ricevitore. Si consiglia di impostare il valore massimo di inattività quando si chiama Start e di non modificarlo. Questa API viene fornita solo per scopi di sviluppo/debug.

Parametro
maxInactivity	numero Intervallo in secondi prima di chiudere una connessione che non risponde.

setLoggerLevel

setLoggerLevel(level)

Imposta il livello di dettaglio dei log.

Parametro
livello	cast.framework.LoggerLevel Il livello di logging. Il valore non deve essere null.

start

start(options) restituisce cast.framework.CastReceiverContext

Inizializza il gestore di sistema e il gestore di contenuti multimediali, in modo che l'app ricevitore possa ricevere richieste dai mittenti.

Parametro
opzioni	(cast.framework.CastReceiverOptions non null o oggetto non null facoltativo)

Resi

non-null cast.framework.CastReceiverContext 

interrompi

stop(closeReason)

Arresta l'applicazione del ricevitore.

Parametro

closeReason

Facoltativo cast.framework.common.CloseReason Il motivo facoltativo della chiusura che indica perché l'applicazione ricevitore è stata interrotta. Se non viene fornito, il framework dedurrà il motivo in base agli eventi recenti del media player o utilizzerà APP_REQUEST. Passa uno dei seguenti valori numerici: 13 (APP_CUSTOM_STOP): per azioni aziendali/UI del ricevitore personalizzato (ad es. l'utente fa clic su un pulsante "Esci" o "Chiudi" in-app, navigazione del ricevitore personalizzato al di fuori della trasmissione). 15 (APP_ERROR): errori irreversibili a livello di applicazione (ad es. errori di autenticazione personalizzata, errori di recupero di DRM/licenze, arresti anomali dell'API di backend) che si verificano al di fuori degli eventi di errore del player integrato di CAF. 14 (APP_PLAYBACK_FINISHED): l'app ha consumato la playlist/coda o ha completato un'esperienza multimediale autonoma. 6 (APP_REQUEST): fallback generico/legacy quando un'applicazione richiede la terminazione senza un motivo più specifico. Il valore non deve essere null.