Questa pagina è stata tradotta dall'API Cloud Translation.

Integra l'SDK Cast nella tua app Web Sender

Questa guida per gli sviluppatori descrive come aggiungere il supporto di Google Cast alla tua app Web Sender utilizzando l'SDK Cast.

Terminologia

Il dispositivo mobile o browser è il mittente, che controlla la riproduzione; il dispositivo Google Cast è il ricevitore, che visualizza i contenuti sullo schermo per la riproduzione.

L'SDK Web Sender è costituito da due parti: l'API Framework (cast.framework) e l'API Base (chrome.cast). In generale, si effettuano chiamate sull'API Framework di livello superiore più semplice, che vengono poi elaborate dall'API di base di livello inferiore.

Il framework mittente si riferisce all'API Framework, al modulo e alle risorse associate che forniscono un wrapper per le funzionalità di livello inferiore. L'app mittente o l'app Google Cast per Chrome si riferisce a un'app web (HTML/JavaScript) in esecuzione all'interno di un browser Chrome su un dispositivo mittente. Con app ricevitore web si intende un'app HTML/JavaScript in esecuzione su Chromecast o su un dispositivo Google Cast.

Il framework del mittente utilizza un design asincrono di callback per informare l'app del mittente degli eventi e di passare tra i vari stati del ciclo di vita dell'app Cast.

Carica la libreria

Affinché la tua app possa implementare le funzionalità di Google Cast, deve conoscere la posizione dell'SDK Google Cast Web Sender, come mostrato di seguito. Aggiungi il parametro di query dell'URL loadCastFramework per caricare anche l'API Web Sender Framework. Tutte le pagine della tua app devono fare riferimento alla raccolta come segue:

<script src="https://www.gstatic.com/cv/js/sender/v1/cast_sender.js?loadCastFramework=1"></script>

Framework

L'SDK Web Sender utilizza lo spazio dei nomi cast.framework.*. Lo spazio dei nomi rappresenta quanto segue:

Metodi o funzioni che richiamano operazioni sull'API
Listener di eventi per le funzioni listener nell'API

Il framework è costituito dai seguenti componenti principali:

CastContext è un oggetto singleton che fornisce informazioni sullo stato di trasmissione attuale e attiva eventi per le modifiche dello stato e della sessione di trasmissione.
L'oggetto CastSession gestisce la sessione, fornisce informazioni sullo stato e attiva eventi, come le modifiche al volume del dispositivo, lo stato di disattivazione audio e i metadati dell'app.
L'elemento pulsante Trasmetti, un semplice elemento HTML personalizzato che estende il pulsante HTML. Se il pulsante Trasmetti fornito non è sufficiente, puoi utilizzare lo stato di trasmissione per implementare un pulsante Trasmetti.
Il RemotePlayerController fornisce l'associazione di dati per semplificare l'implementazione del player remoto.

Consulta il riferimento API Google Cast Web Sender per una descrizione completa dello spazio dei nomi.

Pulsante Trasmetti

Il componente del pulsante Trasmetti nella tua app è gestito interamente dal framework. Ciò include la gestione della visibilità e la gestione degli eventi di clic.

<google-cast-launcher></google-cast-launcher>

In alternativa, puoi creare il pulsante in modo programmatico:

document.createElement("google-cast-launcher");

Se necessario, puoi applicare all'elemento qualsiasi stile aggiuntivo, come dimensioni o posizionamento. Utilizza l'attributo --connected-color per scegliere il colore per lo stato del ricevitore web connesso e --disconnected-color per lo stato disconnesso.

Inizializzazione

Dopo aver caricato l'API framework, l'app chiama il gestore window.__onGCastApiAvailable. Devi assicurarti che l'app imposti questo gestore su window prima di caricare la libreria del mittente.

All'interno di questo gestore, puoi inizializzare l'interazione con la trasmissione chiamando il metodo setOptions(options) di CastContext.

Ad esempio:

<script>
window['__onGCastApiAvailable'] = function(isAvailable) {
  if (isAvailable) {
    initializeCastApi();
  }
};
</script>

Quindi, inizializza l'API come segue:

initializeCastApi = function() {
  cast.framework.CastContext.getInstance().setOptions({
    receiverApplicationId: applicationId,
    autoJoinPolicy: chrome.cast.AutoJoinPolicy.ORIGIN_SCOPED
  });
};

Innanzitutto, l'app recupera l'istanza singleton dell'oggetto CastContext fornito dal framework. Quindi utilizza setOptions(options) con un oggetto CastOptions per impostare applicationID.

Se utilizzi il Ricevitore multimediale predefinito, che non richiede la registrazione, utilizzi una costante predefinita dall'SDK Web Sender, come mostrato di seguito, anziché applicationID:

cast.framework.CastContext.getInstance().setOptions({
  receiverApplicationId: chrome.cast.media.DEFAULT_MEDIA_RECEIVER_APP_ID
});

Controllo dei contenuti multimediali

Una volta inizializzato CastContext, l'app può recuperare l'attuale CastSession corrente in qualsiasi momento utilizzando getCurrentSession().

var castSession = cast.framework.CastContext.getInstance().getCurrentSession();

CastSession può essere utilizzato per caricare contenuti multimediali sul dispositivo di trasmissione connesso tramite loadMedia(loadRequest). Per prima cosa, crea un elemento MediaInfo, utilizzando contentId e contentType ed eventuali altre informazioni correlate ai contenuti. Quindi, crea un LoadRequest, impostando tutte le informazioni pertinenti per la richiesta. Infine, chiama il numero loadMedia(loadRequest) sul tuo CastSession.

var mediaInfo = new chrome.cast.media.MediaInfo(currentMediaURL, contentType);
var request = new chrome.cast.media.LoadRequest(mediaInfo);
castSession.loadMedia(request).then(
  function() { console.log('Load succeed'); },
  function(errorCode) { console.log('Error code: ' + errorCode); });

Il metodo loadMedia restituirà una promessa che può essere utilizzata per eseguire le operazioni necessarie per un risultato riuscito. Se la promessa viene rifiutata, l'argomento della funzione sarà un chrome.cast.ErrorCode.

Puoi accedere alle variabili di stato del player in RemotePlayer. Tutte le interazioni con l'elemento RemotePlayer, inclusi i comandi e i callback di eventi multimediali, vengono gestite con RemotePlayerController.

var player = new cast.framework.RemotePlayer();
var playerController = new cast.framework.RemotePlayerController(player);

L'RemotePlayerController consente all'app di controllare completamente i contenuti multimediali caricati in base a PLAY, PAUSE, STOP e SEEK per i contenuti multimediali caricati.

RIPRODUZIONE/PAUSA: playerController.playOrPause();
INTERROMPI: playerController.stop();
CERCA: playerController.seek();

RemotePlayer e RemotePlayerController possono essere utilizzati con framework di associazione di dati, come Polymer o Angular, per implementare un player remoto.

Di seguito è riportato uno snippet di codice per Angular:

<button id="playPauseButton" class="playerButton"
  ng-disabled="!player.canPause"
  ng-click="controller.playOrPause()">
    {{player.isPaused ? 'Play' : 'Pause'}}
</button>
<script>
var player = new cast.framework.RemotePlayer();
var controller = new cast.framework.RemotePlayerController(player);
// Listen to any player update, and trigger angular data binding
update.controller.addEventListener(
  cast.framework.RemotePlayerEventType.ANY_CHANGE,
  function(event) {
    if (!$scope.$$phase) $scope.$apply();
  });
</script>

Stato dei contenuti multimediali

Durante la riproduzione di contenuti multimediali, si verificano vari eventi che possono essere acquisiti impostando ascoltatori per vari eventi cast.framework.RemotePlayerEventType sull'oggetto RemotePlayerController.

Per ottenere informazioni sullo stato dei contenuti multimediali, utilizza l'evento cast.framework.RemotePlayerEventType.MEDIA_INFO_CHANGED, che si attiva quando cambia la riproduzione e quando cambia l'elemento CastSession.getMediaSession().media.

playerController.addEventListener(
  cast.framework.RemotePlayerEventType.MEDIA_INFO_CHANGED, function() {
    // Use the current session to get an up to date media status.
    let session = cast.framework.CastContext.getInstance().getCurrentSession();

    if (!session) {
        return;
    }

    // Contains information about the playing media including currentTime.
    let mediaStatus = session.getMediaSession();
    if (!mediaStatus) {
        return;
    }

    // mediaStatus also contains the mediaInfo containing metadata and other
    // information about the in progress content.
    let mediaInfo = mediaStatus.media;
  });

Quando si verificano eventi quali la messa in pausa, la riproduzione, la ripresa o la ricerca, l'app deve intervenire su questi eventi e sincronizzarsi tra se stessa e l'app ricevitore web sul dispositivo di trasmissione. Per ulteriori informazioni, consulta la sezione Aggiornamenti dello stato.

Come funziona la gestione delle sessioni

L'SDK Cast introduce il concetto di sessione di trasmissione, la cui procedura combina i passaggi per la connessione a un dispositivo, l'avvio (o l'unione) di un'app web ricevitore, la connessione a tale app e l'inizializzazione di un canale di controllo dei contenuti multimediali. Consulta la guida al ciclo di vita delle applicazioni del ricevitore web per ulteriori informazioni sulle sessioni di trasmissione e sul ciclo di vita del ricevitore web.

Le sessioni sono gestite dalla classe CastContext, che la tua app può recuperare tramite cast.framework.CastContext.getInstance(). Le singole sessioni sono rappresentate da sottoclassi del corso Session. Ad esempio, CastSession rappresenta le sessioni con dispositivi di trasmissione. La tua app può accedere alla sessione di trasmissione attualmente attiva tramite CastContext.getCurrentSession().

Per monitorare lo stato della sessione, aggiungi un listener a CastContext per il tipo di evento CastContextEventType.SESSION_STATE_CHANGED.

var context = cast.framework.CastContext.getInstance();
context.addEventListener(
  cast.framework.CastContextEventType.SESSION_STATE_CHANGED,
  function(event) {
    switch (event.sessionState) {
      case cast.framework.SessionState.SESSION_STARTED:
      case cast.framework.SessionState.SESSION_RESUMED:
        break;
      case cast.framework.SessionState.SESSION_ENDED:
        console.log('CastContext: CastSession disconnected');
        // Update locally as necessary
        break;
    }
  })

Per la disconnessione, ad esempio quando l'utente fa clic sul pulsante "Interrompi trasmissione" nella finestra di dialogo Trasmetti, puoi aggiungere un listener per il tipo di evento RemotePlayerEventType.IS_CONNECTED_CHANGED nel tuo listener. Nel listener, controlla se RemotePlayer è disconnesso. In questo caso, aggiorna lo stato locale del player secondo necessità. Ad esempio:

playerController.addEventListener(
  cast.framework.RemotePlayerEventType.IS_CONNECTED_CHANGED, function() {
    if (!player.isConnected) {
      console.log('RemotePlayerController: Player disconnected');
      // Update local player to disconnected state
    }
  });

Sebbene l'utente possa controllare direttamente la fine della trasmissione tramite il pulsante Trasmetti del framework, il mittente stesso può interrompere la trasmissione utilizzando l'oggetto CastSession corrente.

function stopCasting() {
  var castSession = cast.framework.CastContext.getInstance().getCurrentSession();
  // End the session and pass 'true' to indicate
  // that Web Receiver app should be stopped.
  castSession.endSession(true);
}

Trasferimento dello streaming

La conservazione dello stato della sessione è alla base del trasferimento dello streaming, in cui gli utenti possono spostare stream audio e video esistenti su più dispositivi utilizzando i comandi vocali, l'app Google Home o gli smart display. La riproduzione dei contenuti multimediali viene interrotta su un dispositivo (la sorgente) e continua su un altro (la destinazione). Qualsiasi dispositivo di trasmissione con il firmware più recente può essere utilizzato come origine o destinazione in un trasferimento dello streaming.

Per ottenere il nuovo dispositivo di destinazione durante il trasferimento dello streaming, chiama CastSession#getCastDevice() quando viene richiamato l'evento cast.framework.SessionState.SESSION_RESUMED.

Per ulteriori informazioni, consulta Trasferimento dello streaming sul ricevitore web.

Indietro

Configurazione

Avanti

Aggiungi funzionalità avanzate