Agrega funciones principales a tu receptor web personalizado

Esta página contiene fragmentos de código y descripciones de las funciones disponibles para una app de recepción web personalizada.

Nota: Te recomendamos que pruebes lo siguiente:

• Instructivo sobre el receptor web de Cast: Obtén una explicación paso a paso para compilar una app compatible con Cast compatible con Cast con el SDK de Google Cast que puede recibir transmisiones de video.
• App de ejemplo de CastReceiver (GitHub): Ejecuta, navega y observa esta app de ejemplo que cumple con los lineamientos de UX y la lista de tareas de diseño.

1. Un elemento cast-media-player que representa la IU del reproductor integrado que se proporciona con el receptor web.
2. Estilo personalizado de CSS para el elemento cast-media-player a fin de diseñar varios elementos de la IU, como background-image, splash-image y font-family.
3. Un elemento de secuencia de comandos para cargar el framework del receptor web.
4. Código JavaScript para interceptar mensajes y controlar eventos.
5. En fila para reproducción automática.
6. Opciones para configurar la reproducción.
7. Opciones para establecer el contexto del receptor web.
8. Opciones para configurar comandos que son compatibles con la app de receptor web.
9. Una llamada de JavaScript para iniciar la aplicación Receptor web.

Nota: Se recomienda usar el elemento HTML cast-media-player, ya que controla todo el estado de la IU del reproductor junto con su estilo.

Configuración y opciones de la aplicación

CastReceiverContext es la clase más externa que se expone al desarrollador, y administra la carga de bibliotecas subyacentes y controla la inicialización del SDK de Web Receiver.

Si la API de Web Receiver detecta que un remitente está desconectado, generará el evento SENDER_DISCONNECTED. Si el receptor web no ha podido comunicarse con el remitente por lo que describimos como maxInactivity segundos, también generará el evento SENDER_DISCONNECTED. Durante el desarrollo, se recomienda configurar maxInactivity como un valor alto para que la app del receptor web no se cierre cuando se depura la app con el Depurador remoto de Chrome:

const context = cast.framework.CastReceiverContext.getInstance();
const options = new cast.framework.CastReceiverOptions();
options.maxInactivity = 3600; //Development only
context.start(options);

Sin embargo, para una aplicación publicada de receptor web, es mejor no configurar maxInactivity y, en su lugar, depender del valor predeterminado. Ten en cuenta que las opciones del receptor web se configuran solo una vez en la aplicación.

La otra es el cast.framework.PlaybackConfig. Esto se puede configurar de la siguiente manera:

const playbackConfig = new cast.framework.PlaybackConfig();
playbackConfig.manifestRequestHandler = requestInfo => {
  requestInfo.withCredentials = true;
};
context.start({playbackConfig: playbackConfig});

Esta configuración afecta la reproducción de contenido y, básicamente, proporciona un comportamiento de anulación. Para obtener una lista de los comportamientos que los desarrolladores pueden anular, consulta la definición de cast.framework.PlaybackConfig. Si quieres cambiar la configuración entre el contenido, puedes usar PlayerManager para obtener su playbackConfig actual, modificar o agregar una anulación y restablecer el playbackConfig de la siguiente manera:

const playerManager =
    cast.framework.CastReceiverContext.getInstance().getPlayerManager();
const playbackConfig = (Object.assign(
            new cast.framework.PlaybackConfig(), playerManager.getPlaybackConfig()));
playbackConfig.autoResumeNumberOfSegments = 1;
playerManager.setPlaybackConfig(playbackConfig);

Ten en cuenta que, si no se anuló PlaybackConfig, getPlaybackConfig() muestra un objeto nulo. Y cualquier propiedad en PlaybackConfig that es undefined usará los valores predeterminados.

Objeto de escucha de eventos

El SDK de receptor web permite que tu app de receptor web maneje los eventos del reproductor. El objeto de escucha de eventos toma un parámetro cast.framework.events.EventType (o un array de estos parámetros) que especifica los eventos que deben activar el objeto de escucha. En cast.framework.events.category, puedes encontrar arrays preconfigurados de cast.framework.events.EventType que son útiles para la depuración. El parámetro del evento proporciona información adicional sobre el evento.

Por ejemplo, si deseas saber cuándo se emite un cambio mediaStatus, puedes usar la siguiente lógica para controlar el evento:

const playerManager =
    cast.framework.CastReceiverContext.getInstance().getPlayerManager();
playerManager.addEventListener(
    cast.framework.events.EventType.MEDIA_STATUS, (event) => {
      // Write your own event handling code, for example
      // using the event.mediaStatus value
});

Nota: El framework del receptor web hace un seguimiento automático cuando un remitente se conecta o desconecta de él y no requiere un objeto de escucha de eventos SENDER_DISCONNECTED explícito en tu propia lógica del receptor web.

Intercepción de mensajes

El SDK de Web Receiver permite que tu app de Web Receiver intercepte mensajes y ejecute código personalizado en esos mensajes. El interceptor de mensajes toma un parámetro cast.framework.messages.MessageType que especifica qué tipo de mensaje debe interceptarse.

El interceptor debe mostrar la solicitud modificada o una promesa que se resuelva con el valor de la solicitud modificado. Si se muestra null, no se llamará al controlador de mensajes predeterminado. Consulta Carga de contenido multimedia para obtener más información.

Por ejemplo, si deseas cambiar los datos de la solicitud de carga, puedes usar la siguiente lógica para interceptarlos y modificarlos:

Precaución: No agregues ni modifiques la propiedad queueData del elemento LoadRequestData en el interceptor LOAD. No tendrá efecto en la reproducción porque el queueData ya se leyó y se aplicó a la cola. Para obtener más información, consulta la guía de colas.

const context = cast.framework.CastReceiverContext.getInstance();
const playerManager = context.getPlayerManager();

playerManager.setMessageInterceptor(
    cast.framework.messages.MessageType.LOAD, loadRequestData => {
      const error = new cast.framework.messages.ErrorData(
                      cast.framework.messages.ErrorType.LOAD_FAILED);
      if (!loadRequestData.media) {
        error.reason = cast.framework.messages.ErrorReason.INVALID_PARAM;
        return error;
      }

      if (!loadRequestData.media.entity) {
        return loadRequestData;
      }

      return thirdparty.fetchAssetAndAuth(loadRequestData.media.entity,
                                          loadRequestData.credentials)
        .then(asset => {
          if (!asset) {
            throw cast.framework.messages.ErrorReason.INVALID_REQUEST;
          }

          loadRequestData.media.contentUrl = asset.url;
          loadRequestData.media.metadata = asset.metadata;
          loadRequestData.media.tracks = asset.tracks;
          return loadRequestData;
        }).catch(reason => {
          error.reason = reason; // cast.framework.messages.ErrorReason
          return error;
        });
    });

context.start();

Manejo de errores

Cuando se producen errores en el interceptor de mensajes, la app receptora de la Web debe mostrar un cast.framework.messages.ErrorType y un cast.framework.messages.ErrorReason adecuados.

playerManager.setMessageInterceptor(
    cast.framework.messages.MessageType.LOAD, loadRequestData => {
      const error = new cast.framework.messages.ErrorData(
                      cast.framework.messages.ErrorType.LOAD_CANCELLED);
      if (!loadRequestData.media) {
        error.reason = cast.framework.messages.ErrorReason.INVALID_PARAM;
        return error;
      }

      ...

      return fetchAssetAndAuth(loadRequestData.media.entity,
                               loadRequestData.credentials)
        .then(asset => {
          ...
          return loadRequestData;
        }).catch(reason => {
          error.reason = reason; // cast.framework.messages.ErrorReason
          return error;
        });
    });

Intercepción de mensajes frente a objeto de escucha de eventos

Estas son algunas diferencias clave entre la intercepción de mensajes y el objeto de escucha de eventos:

• Un objeto de escucha de eventos no te permite modificar los datos de la solicitud.
• Un objeto de escucha de eventos se usa mejor para activar estadísticas o una función personalizada.

Nota: También se puede usar un objeto de escucha de eventos para escuchar un grupo de eventos mediante las enumeraciones CORE, DEBUG o FINE.

playerManager.addEventListener(cast.framework.events.category.CORE,
    event => {
        console.log(event);
    });

• La interceptación de mensajes te permite escuchar un mensaje, interceptarlo y modificar los datos de la solicitud.
• La interceptación de mensajes se usa mejor para controlar la lógica personalizada con respecto a los datos de la solicitud.

Carga de contenido multimedia

MediaInformation proporciona varias propiedades para cargar contenido multimedia en el mensaje cast.framework.messages.MessageType.LOAD, incluidos entity, contentUrl y contentId.

entity es la propiedad sugerida que se usará en tu implementación para apps de remitente y receptor. La propiedad es una URL de vínculo directo que puede ser una lista de reproducción o un contenido multimedia específico.

contentUrl está diseñada para una URL reproducible y se puede usar una vez que esté disponible.

contentId dejó de estar disponible debido a la ambigüedad de si el valor es una URL del contenido multimedia, un ID real o un parámetro clave para la búsqueda personalizada.

La sugerencia es usar entity a fin de almacenar el ID real o los parámetros clave, y usar contentUrl para la URL del contenido multimedia. Un ejemplo de esto se muestra en el siguiente fragmento, en el que entity está presente en la solicitud LOAD y se recupera la contentUrl reproducible:

playerManager.setMessageInterceptor(
    cast.framework.messages.MessageType.LOAD, loadRequestData => {
      ...

      if (!loadRequestData.media.entity) {
        // Copy the value from contentId for legacy reasons if needed
        loadRequestData.media.entity = loadRequestData.media.contentId;
      }

      return thirdparty.fetchAssetAndAuth(loadRequestData.media.entity,
                                          loadRequestData.credentials)
        .then(asset => {
          loadRequestData.media.contentUrl = asset.url;
          ...
          return loadRequestData;
        });
    });

Funciones del dispositivo

El método getDeviceCapabilities proporciona información sobre el dispositivo de transmisión conectado y el dispositivo de audio o video conectado a él. El método getDeviceCapabilities proporciona información de asistencia para el Asistente de Google, Bluetooth y los dispositivos de pantalla y audio conectados.

Este método muestra un objeto que puedes consultar pasando una de las enumeraciones especificadas para obtener la capacidad de dispositivo de esa enumeración. Las enumeraciones se definen en cast.framework.system.DeviceCapabilities.

En este ejemplo, se verifica si el dispositivo receptor web es capaz de reproducir HDR y DolbyVision (DV) con las claves IS_HDR_SUPPORTED y IS_DV_SUPPORTED, respectivamente.

const context = cast.framework.CastReceiverContext.getInstance();
context.addEventListener(cast.framework.system.EventType.READY, () => {
  const deviceCapabilities = context.getDeviceCapabilities();
  if (deviceCapabilities &&
      deviceCapabilities[cast.framework.system.DeviceCapabilities.IS_HDR_SUPPORTED]) {
    // Write your own event handling code, for example
    // using the deviceCapabilities[cast.framework.system.DeviceCapabilities.IS_HDR_SUPPORTED] value
  }
  if (deviceCapabilities &&
      deviceCapabilities[cast.framework.system.DeviceCapabilities.IS_DV_SUPPORTED]) {
    // Write your own event handling code, for example
    // using the deviceCapabilities[cast.framework.system.DeviceCapabilities.IS_DV_SUPPORTED] value
  }
});
context.start();

Cómo controlar la interacción del usuario

Un usuario puede interactuar con tu aplicación de recepción web a través de aplicaciones de remitente (Web, iOS y Android), comandos por voz en dispositivos compatibles con Asistente, controles de tacto en pantallas inteligentes y controles remotos en dispositivos Android TV. El SDK de Cast proporciona varias API a fin de permitir que la app del receptor web maneje estas interacciones, actualice la IU de la aplicación mediante los estados de acción del usuario y, de manera opcional, envíe los cambios para actualizar cualquier servicio de backend.

Comandos de contenido multimedia compatibles

Los estados de los controles de la IU están controlados por el MediaStatus.supportedMediaCommands para las apps de control expandido del remitente, iOS y Android que se ejecutan en dispositivos táctiles y las apps receptoras en dispositivos Android TV. Cuando se habilita un objeto Command específico a nivel de bits en la propiedad, se habilitan los botones relacionados con esa acción. Si no estableces el valor, se inhabilitará el botón. Estos valores se pueden cambiar en el receptor web de las siguientes maneras:

1. Usar PlayerManager.setSupportedMediaCommands para establecer el Commands específico
2. Cómo agregar un comando nuevo con addSupportedMediaCommands
3. Quita un comando existente con removeSupportedMediaCommands.

playerManager.setSupportedMediaCommands(cast.framework.messages.Command.SEEK |
  cast.framework.messages.Command.PAUSE);

Cuando el receptor prepare el MediaStatus actualizado, incluirá los cambios en la propiedad supportedMediaCommands. Cuando se transmita el estado, las apps emisoras conectadas actualizarán los botones según corresponda.

Nota: Realizar cambios en supportedMediaCommands no cambiará el tipo de botón que se muestra. Se configuran directamente en las apps emisoras (iOS y Android) y la API de Controls del receptor. La única excepción que usa supportedMediaCommands para controlar estos cambios son las tarjetas de reproducción de contenido multimedia en la pantalla principal de las pantallas inteligentes.

Para obtener más información sobre los comandos de contenido multimedia compatibles y los dispositivos táctiles, consulta la guía de Accessing UI controls.

Cómo administrar estados de acción del usuario

Cuando los usuarios interactúan con la IU o envían comandos por voz, pueden controlar la reproducción del contenido y las propiedades relacionadas con el elemento que se reproduce. El SDK controla automáticamente las solicitudes que controlan la reproducción. Las solicitudes que modifican propiedades del elemento actual que se está reproduciendo, como un comando LIKE, requieren que la aplicación receptora las controle. El SDK proporciona una serie de API para controlar estos tipos de solicitudes. Para admitir estas solicitudes, se debe hacer lo siguiente:

• ¿Quieres interceptar mensajes de USER_ACTION y determinar la acción solicitada?
• Actualiza UserActionState de MediaInformation para actualizar la IU.

Nota: Si es necesario, puedes POST la acción a cualquier backend relevante para conservar la preferencia del usuario.

El siguiente fragmento intercepta el mensaje USER_ACTION y controla la llamada al backend con el cambio solicitado. Luego, realiza una llamada para actualizar UserActionState en el receptor.

playerManager.setMessageInterceptor(cast.framework.messages.MessageType.USER_ACTION,
  (userActionRequestData) => {
    // Obtain the media information of the current content to associate the action to.
    let mediaInfo = playerManager.getMediaInformation();

    // If there is no media info return an error and ignore the request.
    if (!mediaInfo) {
        console.error('Not playing media, user action is not supported');
        return new cast.framework.messages.ErrorData(messages.ErrorType.BAD_REQUEST);
    }

    // Reach out to backend services to store user action modifications. See sample below.
    return sendUserAction(userActionRequestData, mediaInfo)

    // Upon response from the backend, update the client's UserActionState.
    .then(backendResponse => updateUserActionStates(backendResponse))

    // If any errors occurred in the backend return them to the cast receiver.
    .catch((error) => {
      console.error(error);
      return error;
    });
});

El siguiente fragmento simula una llamada a un servicio de backend. La función verifica el UserActionRequestData para ver el tipo de cambio que solicitó el usuario y solo realiza una llamada de red si el backend admite la acción.

function sendUserAction(userActionRequestData, mediaInfo) {
  return new Promise((resolve, reject) => {
    switch (userActionRequestData.userAction) {
      // Handle user action changes supported by the backend.
      case cast.framework.messages.UserAction.LIKE:
      case cast.framework.messages.UserAction.DISLIKE:
      case cast.framework.messages.UserAction.FOLLOW:
      case cast.framework.messages.UserAction.UNFOLLOW:
      case cast.framework.messages.UserAction.FLAG:
      case cast.framework.messages.UserAction.SKIP_AD:
        let backendResponse = {userActionRequestData: userActionRequestData, mediaInfo: mediaInfo};
        setTimeout(() => {resolve(backendResponse)}, 1000);
        break;
      // Reject all other user action changes.
      default:
        reject(
          new cast.framework.messages.ErrorData(cast.framework.messages.ErrorType.INVALID_REQUEST));
    }
  });
}

El siguiente fragmento toma el UserActionRequestData y agrega o quita el UserActionState del MediaInformation. La actualización de UserActionState de MediaInformation cambia el estado del botón que está asociado con la acción solicitada. Este cambio se refleja en la IU de los controles de pantalla inteligente, la app de control remoto y la IU de Android TV. También se transmite a través de mensajes MediaStatus salientes a fin de actualizar la IU del controlador expandido para remitentes iOS y Android.

function updateUserActionStates(backendResponse) {
  // Unwrap the backend response.
  let mediaInfo = backendResponse.mediaInfo;
  let userActionRequestData = backendResponse.userActionRequestData;

  // If the current item playing has changed, don't update the UserActionState for the current item.
  if (playerManager.getMediaInformation().entity !== mediaInfo.entity) {
    return;
  }

  // Check for existing userActionStates in the MediaInformation.
  // If none, initialize a new array to populate states with.
  let userActionStates = mediaInfo.userActionStates || [];

  // Locate the index of the UserActionState that will be updated in the userActionStates array.
  let index = userActionStates.findIndex((currUserActionState) => {
    return currUserActionState.userAction == userActionRequestData.userAction;
  });

  if (userActionRequestData.clear) {
    // Remove the user action state from the array if cleared.
    if (index >= 0) {
      userActionStates.splice(index, 1);
    }
    else {
      console.warn("Could not find UserActionState to remove in MediaInformation");
    }
  } else {
    // Add the UserActionState to the array if enabled.
    userActionStates.push(
      new cast.framework.messages.UserActionState(userActionRequestData.userAction));
  }

  // Update the UserActionState array and set the new MediaInformation
  mediaInfo.userActionStates = userActionStates;
  playerManager.setMediaInformation(mediaInfo, true);
  return;
}

Comandos por voz

Actualmente, se admiten los siguientes comandos multimedia en el SDK de Receptor web para dispositivos compatibles con Asistente. Las implementaciones predeterminadas de estos comandos se encuentran en cast.framework.PlayerManager.

Comando	Descripción
Reproducir	Reproducir o reanudar la reproducción desde el estado de pausa
Pausar	Pausa el contenido que se está reproduciendo.
Anterior	Ir al elemento multimedia anterior de la fila multimedia.
Siguiente	Pasa al siguiente elemento multimedia de tu fila de medios.
Detener	Detén el contenido multimedia que se está reproduciendo.
No repetir ninguno	Inhabilitar la repetición de elementos multimedia en la cola una vez que el último elemento de la cola termine de reproducirse
Repetir una vez	Repite el contenido multimedia que se está reproduciendo de forma indefinida.
Repetir todo	Repite todos los elementos de la cola una vez que se reproduzca el último.
Repetir todo y Shuffle	Una vez que se termine de reproducir el último elemento de la cola, redistribuye la fila y repite los demás.
Reproducción aleatoria	Reproduce aleatoriamente los elementos multimedia de la fila de contenido multimedia. Nota: También puedes usar la marca shuffle para reproducir aleatoriamente el contenido multimedia si está configurado en el elemento loadRequestData del mensaje LOAD.
Subtítulos activados / DESACTIVADOS	Habilita o inhabilita los subtítulos para el contenido multimedia. Habilitar / Inhabilitar también está disponible según el idioma.
Intervalo de búsqueda a tiempo absoluta	Salta al tiempo absoluto especificado.
Búsqueda a tiempo relativo a la hora actual	Permite avanzar o retroceder en el período especificado en relación con la reproducción actual.
Volver a jugar	Reinicia el contenido multimedia que se está reproduciendo o reproduce el último elemento si no se está reproduciendo contenido.
Configura la velocidad de reproducción	Varía la velocidad de reproducción del contenido multimedia. Esto se debe controlar de forma predeterminada. Puedes usar el interceptor de mensajes SET_PLAYBACK_RATE para anular las solicitudes de tarifa entrantes.

Comandos multimedia compatibles con la voz

Para evitar que un comando por voz active un comando multimedia en un dispositivo compatible con el Asistente, primero debes configurar los comandos multimedia compatibles que quieras admitir. Luego, debes habilitar esos comandos habilitando la propiedad CastReceiverOptions.enforceSupportedCommands. La IU de los remitentes de SDK de Cast y de los dispositivos táctiles será capaz de reflejar estas configuraciones. Si la marca no está habilitada, se ejecutarán los comandos de voz entrantes.

Por ejemplo, si permites PAUSE desde tus aplicaciones emisoras y dispositivos táctiles, también debes configurar tu receptor para que refleje esos parámetros de configuración. Cuando se configure, se descartarán los comandos de voz entrantes si no se incluyen en la lista de comandos compatibles.

En el siguiente ejemplo, proporcionamos el CastReceiverOptions cuando se inicia el CastReceiverContext. Agregamos compatibilidad con el comando PAUSE y aplicamos el reproductor de manera que solo admita ese comando. Ahora, si un comando por voz solicita otra operación, como SEEK, se rechazará. Se le notificará al usuario que aún no se admite el comando.

const context = cast.framework.CastReceiverContext.getInstance();

context.start({
  enforceSupportedCommands: true,
  supportedCommands: cast.framework.messages.Command.PAUSE
});

Puedes aplicar una lógica separada para cada comando que desees restringir. Quita la marca enforceSupportedCommands y, para cada comando que quieras restringir, puedes interceptar el mensaje entrante. Aquí interceptamos la solicitud que proporciona el SDK para que los comandos de SEEK emitidos a dispositivos habilitados para Asistente no activen una búsqueda en tu aplicación de receptor web.

Para los comandos multimedia que no son compatibles con tu aplicación, muestra un motivo de error apropiado, como NOT_SUPPORTED.

playerManager.setMessageInterceptor(cast.framework.messages.MessageType.SEEK,
  seekData => {
    // Block seeking if the SEEK supported media command is disabled
    if (!(playerManager.getSupportedMediaCommands() & cast.framework.messages.Command.SEEK)) {
      let e = new cast.framework.messages.ErrorData(cast.framework.messages.ErrorType
      .INVALID_REQUEST);
      e.reason = cast.framework.messages.ErrorReason.NOT_SUPPORTED;
      return e;
    }

    return seekData;
  });

Fondos de la actividad de voz

Si la plataforma de transmisión en segundo plano reproduce el sonido de tu aplicación debido a la actividad de Asistente, como la escucha del habla del usuario o la respuesta, se envía un mensaje FocusState de NOT_IN_FOCUS a la aplicación Receptor web cuando se inicia la actividad. Se envía otro mensaje con IN_FOCUS cuando finaliza la actividad. Según tu aplicación y el contenido multimedia que se reproduzca, es posible que quieras detener el contenido multimedia cuando el FocusState sea NOT_IN_FOCUS mediante la interceptación del tipo de mensaje FOCUS_STATE.

Por ejemplo, es una buena experiencia del usuario pausar la reproducción del audiolibro si Asistente responde a su consulta.

playerManager.setMessageInterceptor(cast.framework.messages.MessageType.FOCUS_STATE,
  focusStateRequestData => {
    // Pause content when the app is out of focus. Resume when focus is restored.
    if (focusStateRequestData.state == cast.framework.messages.FocusState.NOT_IN_FOCUS) {
      playerManager.pause();
    } else {
      playerManager.play();
    }

    return focusStateRequestData;
  });

Idioma de subtítulos especificado por voz

Cuando un usuario no indica explícitamente el idioma de los subtítulos, el idioma utilizado es el mismo idioma en el que se pronunció el subtítulo. En estas situaciones, el parámetro isSuggestedLanguage del mensaje entrante indica si el usuario sugirió o solicitó explícitamente el idioma asociado.

Por ejemplo, isSuggestedLanguage se configura como true para el comando "Hey Google, activa los subtítulos" porque el idioma en el que se pronunció se infirió. Si el idioma se solicita de manera explícita, como en "Hey Google, activa los subtítulos en inglés", isSuggestedLanguage se establece en false.

Metadatos y transmisión de voz

Si bien el receptor web controla los comandos por voz de forma predeterminada, debes asegurarte de que los metadatos del contenido estén completos y sean precisos. De esta manera, te aseguras de que el Asistente maneje correctamente los comandos por voz y de que los metadatos aparezcan correctamente en nuevos tipos de interfaces, como la app de Google Home y pantallas inteligentes, como Google Home Hub.

Transferencia de transmisión

Nota: Los receptores web de audio admiten la expansión de transmisión de forma predeterminada, en la que se agregan dispositivos compatibles con Cast adicionales a la sesión. Los receptores web de videos deben realizar los pasos de esta sección para admitir la transferencia de transmisión.

Preservar el estado de la sesión es la base de la transferencia de transmisión, en la que los usuarios pueden mover transmisiones de audio y video existentes entre dispositivos mediante comandos por voz, la app de Google Home o pantallas inteligentes. El contenido multimedia deja de reproducirse en un dispositivo (la fuente) y continúa en otro (el destino). Cualquier dispositivo de transmisión con el firmware más reciente puede funcionar como fuentes o destinos en una transferencia de transmisión.

El flujo de eventos para la transferencia de transmisión es el siguiente:

1. En el dispositivo de origen:
   1. El contenido multimedia deja de reproducirse.
   2. La aplicación receptora web recibe un comando para guardar el estado multimedia actual.
   3. Se cerró la aplicación Receptor web.
2. En el dispositivo de destino:
   1. Se cargó la aplicación Receptor web.
   2. La aplicación Receptor web recibe un comando para restablecer el estado del contenido multimedia guardado.
   3. Se reanudará la reproducción del contenido multimedia.

Los elementos del estado del contenido multimedia incluyen lo siguiente:

• La posición o la marca de tiempo específicas de la canción, el video o el elemento multimedia
• Se coloca en una fila más amplia (como una lista de reproducción o la radio del artista).
• El usuario autenticado.
• Estado de reproducción (por ejemplo, reproduciendo o pausando)

Habilita la transferencia de transmisión

Para implementar la transferencia de transmisión para tu receptor web, haz lo siguiente:

1. Actualiza supportedMediaCommands con el comando STREAM_TRANSFER:

   playerManager.addSupportedMediaCommands(
   cast.framework.messages.Command.STREAM_TRANSFER, true);

2. De manera opcional, anula los interceptores de mensajes SESSION_STATE y RESUME_SESSION como se describe en Preserva el estado de la sesión. Anula estas opciones solo si los datos personalizados deben almacenarse como parte de la instantánea de la sesión. De lo contrario, la implementación predeterminada para preservar los estados de sesión admitirá la transferencia de transmisión.

Preservando el estado de la sesión

El SDK de Web Receiver proporciona una implementación predeterminada para que las apps de la app reciban el resumen del estado multimedia actual, conviertan el estado en una solicitud de carga y reanuden la sesión con esta.

La solicitud de carga generada por el receptor web se puede anular en el interceptor de mensajes SESSION_STATE si es necesario. Si deseas agregar datos personalizados a la solicitud de carga, te sugerimos que los coloques en loadRequestData.customData.

playerManager.setMessageInterceptor(
    cast.framework.messages.MessageType.SESSION_STATE,
    function (sessionState) {
        // Override sessionState.loadRequestData if needed.
        const newCredentials = updateCredentials_(sessionState.loadRequestData.credentials);
        sessionState.loadRequestData.credentials = newCredentials;

        // Add custom data if needed.
        sessionState.loadRequestData.customData = {
            'membership': 'PREMIUM'
        };

        return sessionState;
    });

Los datos personalizados se pueden recuperar de loadRequestData.customData en el interceptor de mensajes RESUME_SESSION.

let cred_ = null;
let membership_ = null;

playerManager.setMessageInterceptor(
    cast.framework.messages.MessageType.RESUME_SESSION,
    function (resumeSessionRequest) {
        let sessionState = resumeSessionRequest.sessionState;

        // Modify sessionState.loadRequestData if needed.
        cred_ = sessionState.loadRequestData.credentials;

        // Retrieve custom data.
        membership_ = sessionState.loadRequestData.customData.membership;

        return resumeSessionRequest;
    });

Precarga de contenido

El receptor web admite la precarga de elementos multimedia después del elemento de reproducción actual en la cola.

La operación de precarga descarga varios segmentos de los siguientes elementos. La especificación se realiza en el valor preloadTime en el objeto QueueItem (el valor predeterminado es 20 segundos si no se proporciona). El tiempo se expresa en segundos, en relación con el final del elemento que se está reproduciendo . Solo son válidos los valores positivos. Por ejemplo, si el valor es 10 segundos, este elemento se precargará 10 segundos antes de que finalice el elemento anterior. Si el tiempo de precarga es mayor que el tiempo restante en currentItem, la precarga ocurrirá lo antes posible. Por lo tanto, si se especifica un valor muy grande de precarga en el itemItem, es posible que, cuando se esté reproduciendo el elemento actual, se precargue el siguiente elemento. Sin embargo, dejamos la configuración y la elección de esto al desarrollador, ya que este valor puede afectar el ancho de banda y el rendimiento de transmisión del elemento de reproducción actual.

La carga previa funcionará para el contenido de transmisión HLS, DASH y Smooth Streaming de forma predeterminada.

Los archivos normales de video y audio MP4, como MP3, no se precargarán, ya que los dispositivos de transmisión solo admiten un elemento multimedia y no se pueden usar para precargar mientras se reproduce un elemento de contenido existente.

Mensajes personalizados

El intercambio de mensajes es el método de interacción clave para las aplicaciones de recepción web.

Un remitente emite mensajes a un receptor web mediante las API del remitente de la plataforma que se ejecuta (Android, iOS o la Web). El objeto de evento (que es la manifestación de un mensaje) que se pasa a los objetos de escucha de eventos tiene un elemento de datos (event.data) en el que los datos adquieren las propiedades del tipo de evento específico.

Una aplicación receptora web puede optar por escuchar los mensajes en un espacio de nombres específico. Debido a esto, se dice que la aplicación del receptor web es compatible con ese protocolo de espacio de nombres. Luego, depende de los remitentes conectados que deseen comunicarse en ese espacio de nombres utilizar el protocolo adecuado.

Todos los espacios de nombres se definen mediante una string y deben comenzar con “urn:x-cast:” seguido de cualquier string. Por ejemplo, “urn:x-cast:com.example.cast.mynamespace”.

Nota: El espacio de nombres del mensaje multimedia “urn:x-cast:com.google.cast.media” está reservado. Los mensajes multimedia enviados con las API de Cast del remitente y del receptor web usan el protocolo de espacio de nombres multimedia por convención. Consulta Contenido multimedia y reproductores para obtener más información sobre los mensajes multimedia.

A continuación, se muestra un fragmento de código para que el receptor web escuche mensajes personalizados de remitentes conectados:

const context = cast.framework.CastReceiverContext.getInstance();

const CUSTOM_CHANNEL = 'urn:x-cast:com.example.cast.mynamespace';
context.addCustomMessageListener(CUSTOM_CHANNEL, function(customEvent) {
  // handle customEvent.
});

context.start();

Del mismo modo, las aplicaciones del receptor web pueden mantener a los remitentes informados sobre el estado del receptor web mediante el envío de mensajes a los remitentes conectados. Una aplicación receptora web puede enviar mensajes mediante sendCustomMessage(namespace, senderId, message) en CastReceiverContext. Un receptor web puede enviar mensajes a un remitente individual, ya sea en respuesta a un mensaje recibido o debido a un cambio de estado de la aplicación. Además de la mensajería de punto a punto (con un límite de 64 KB), un receptor web también puede transmitir mensajes a todos los remitentes conectados.

Transmitir para dispositivos de audio

Consulta la guía de Google Cast para dispositivos de audio a fin de obtener asistencia sobre la reproducción de audio.

Android TV

En esta sección, se explica cómo Google Web Receiver usa tus entradas como reproducción y compatibilidad con Android TV.

Integrar tu aplicación en el control remoto

El receptor web de Google que se ejecuta en el dispositivo Android TV traduce la entrada de las entradas del control del dispositivo (es decir, el control remoto manual) como mensajes de reproducción de contenido multimedia definidos para el espacio de nombres urn:x-cast:com.google.cast.media, como se describe en Mensajes de reproducción de contenido multimedia. Tu aplicación debe admitir estos mensajes para controlar la reproducción de contenido multimedia de la aplicación a fin de permitir el control de reproducción básica desde las entradas de control de Android TV.

Lineamientos para la compatibilidad con Android TV

Estas son algunas recomendaciones y errores comunes que debes evitar para asegurarte de que tu aplicación sea compatible con Android TV:

• Ten en cuenta que la string de usuario-agente contiene "Android" y "CrKey". Algunos sitios pueden redireccionar a un sitio solo para dispositivos móviles porque detectan la etiqueta "Android". No supongas que "Android" en la string de usuario-agente siempre indica un usuario de dispositivo móvil.
• La pila de medios de Android puede usar GZIP transparente para recuperar datos. Asegúrate de que tus datos multimedia puedan responder a Accept-Encoding: gzip.
• Los eventos multimedia HTML5 de Android TV pueden activarse en momentos diferentes a los de Chromecast, lo que puede revelar problemas que estaban ocultos en Chromecast.
• Cuando actualices el contenido multimedia, usa eventos relacionados que se activen por elementos <audio>/<video>, como timeupdate, pause y waiting. Evita usar eventos relacionados con la red, como progress, suspend y stalled, ya que estos suelen depender de la plataforma. Consulta Eventos multimedia para obtener más información sobre el manejo de eventos multimedia en el receptor.
• Cuando configures los certificados HTTPS del sitio del receptor, asegúrate de incluir certificados de CA intermedios. Consulta la página de prueba de SSL de Qualsys para verificar: si la ruta de certificación de confianza de tu sitio incluye un certificado de CA etiquetado como "descarga adicional", es posible que no se cargue en las plataformas basadas en Android.
• Mientras que Chromecast muestra la página del receptor en un plano gráfico de 720p, otras plataformas de transmisión, incluida Android TV, pueden mostrar la página en hasta 1080p. Asegúrate de que la página receptora se escale de forma correcta en diferentes resoluciones.