Clase: CastReceiverContext

cast.framework.CastReceiverContext

class   static

Administra la carga de las bibliotecas subyacentes y, además, inicializa el SDK de Cast Receiver subyacente.

Arroja

non-null Error Si no se crea MediaElement en el cuerpo del documento Si se crean varios elementos multimedia, el desarrollador debe establecer la clase "castMediaElement" en uno de ellos, que usará el receptor de CAF.

Métodos

getInstance

static

getInstance() devuelve cast.framework.CastReceiverContext

Muestra la instancia de singleton de CastReceiverContext.

Muestra

non-null cast.framework.CastReceiverContext 

addCustomMessageListener

addCustomMessageListener(namespace, listener)

Configura un objeto de escucha de mensajes para un canal de mensajes personalizado. Se permite más de un objeto de escucha para un espacio de nombres.

Parámetro

espacio de nombres

string

Es el espacio de nombres. Ten en cuenta que un espacio de nombres válido debe tener el prefijo de la cadena "urn:x-cast:".

objeto de escucha

function(non-null cast.framework.system.Message)
Arroja

Error Si el sistema no está listo o la aplicación no admite el espacio de nombres.

addEventListener

addEventListener(type, handler)

Agrega un objeto de escucha para transmitir eventos del sistema.

Parámetro

tipo

cast.framework.system.EventType

El valor no debe ser nulo.

handler

function(non-null cast.framework.system.Event)

canDisplayType

canDisplayType(mimeType, codecs, width, height, framerate) devuelve un valor booleano

Verifica si la plataforma admite los parámetros de contenido multimedia de las transmisiones de audio o video.

Parámetro

mimeType

string

Es el tipo de MIME del contenido multimedia. Consiste en un tipo y un subtipo separados por una barra diagonal (/). Puede ser un tipo de MIME de video o de audio.

códecs

Opcional

string

La cadena entre comillas contiene una lista separada por comas de formatos, en la que cada formato especifica un tipo de muestra de contenido multimedia que está presente en la transmisión.

ancho

Opcional

número

Describe la resolución horizontal de la transmisión en píxeles.

alto

Opcional

número

Describe la resolución vertical de la transmisión en píxeles.

framerate

Opcional

número

Describe la velocidad de fotogramas de la transmisión.
Muestra

boolean Indica si la transmisión se puede reproducir en Chromecast.

getApplicationData

getApplicationData() devuelve cast.framework.system.ApplicationData

Proporciona información de la aplicación una vez que el sistema está listo; de lo contrario, será nulo.

Muestra

nullable cast.framework.system.ApplicationData La información de la aplicación o un valor nulo si el sistema no está listo.

getDeviceCapabilities

getDeviceCapabilities() devuelve cast.framework.system.DeviceCapabilitiesObj

Proporciona información sobre las capacidades del dispositivo una vez que el sistema está listo; de lo contrario, será nulo. Si se devuelve un objeto vacío, el dispositivo no expone ninguna información de capacidades.

Muestra

nullable cast.framework.system.DeviceCapabilitiesObj Es la información de las capacidades del dispositivo (pares clave-valor). Será nulo si el sistema aún no está listo. Puede ser un objeto vacío si la plataforma no expone ninguna información sobre las capacidades del dispositivo.

getDeviceInformation

getDeviceInformation() devuelve cast.framework.system.DeviceInformationObj

Proporciona información de identificación del dispositivo no relacionada con las capacidades una vez que el sistema está listo; de lo contrario, será "null". Si se devuelve un objeto vacío, el dispositivo no expone esa información.

Muestra

nullable cast.framework.system.DeviceInformationObj Es la información del dispositivo (pares clave-valor). Será nulo si el sistema aún no está listo. Puede ser un objeto vacío si la plataforma no expone esta información.

getPlayerManager

getPlayerManager() devuelve cast.framework.PlayerManager

Obtén una instancia de Player que pueda controlar y supervisar la reproducción de contenido multimedia.

Muestra

non-null cast.framework.PlayerManager 

getSender

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

Obtener un remitente por ID de remitente

Parámetro

senderId

string

Es el ID del remitente que se devolverá.
Muestra

nullable cast.framework.system.Sender 

getSenders

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

Obtiene una lista de los remitentes conectados actualmente.

Muestra

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

getStandbyState

getStandbyState() devuelve cast.framework.system.StandbyState

Informa si la entrada HDMI de la aplicación de transmisión está en modo de espera.

Muestra

non-null cast.framework.system.StandbyState Indica si la entrada HDMI de la aplicación está en modo de espera o no. Si no se puede determinar, por ejemplo,porque la TV no admite comandos de CEC, el valor que se muestra es UNKNOWN.

getSystemState

getSystemState() devuelve cast.framework.system.SystemState

Proporciona información de la aplicación sobre el estado del sistema.

Muestra

non-null cast.framework.system.SystemState El estado del sistema.

getVisibilityState

getVisibilityState() devuelve cast.framework.system.VisibilityState

Informa si la aplicación de transmisión es la entrada activa de HDMI.

Muestra

non-null cast.framework.system.VisibilityState Indica si la aplicación es la entrada HDMI activa. Si no se puede determinar, por ejemplo,porque la TV no admite comandos de CEC, el valor que se muestra es UNKNOWN.

isSystemReady

isSystemReady() returns boolean

Cuando se llama al inicio de la aplicación, el sistema envía el evento de listo para indicar que la información de la aplicación está lista y que la aplicación puede enviar mensajes en cuanto haya un remitente conectado.

Muestra

boolean Indica si el sistema está listo para procesar mensajes.

loadPlayerLibraries

loadPlayerLibraries(useLegacyDashSupport)

Comienza a cargar el archivo JS del reproductor. Esto se puede usar para comenzar a cargar el código JS de los reproductores en la etapa inicial de inicio del receptor antes de llamar a start. Esta función no realiza ninguna operación si los reproductores ya se cargaron (se llamó a start).

Parámetro

useLegacyDashSupport

Opcional

booleano

Indica que se debe usar MPL para el contenido de DASH.

removeCustomMessageListener

removeCustomMessageListener(namespace, listener)

Quita un objeto de escucha de mensajes registrado anteriormente con CastReceiverContext#addCustomMessageListener.

Parámetro

espacio de nombres

string

Es el espacio de nombres. Ten en cuenta que un espacio de nombres válido debe tener el prefijo de la cadena "urn:x-cast:".

objeto de escucha

function(non-null cast.framework.system.Message)

Es la función de objeto de escucha de mensajes para la que se cancelará el registro.
Arroja

Error Si el sistema no está listo o la aplicación no admite el espacio de nombres.

removeEventListener

removeEventListener(type, handler)

Quita el objeto de escucha para transmitir eventos del sistema.

Parámetro

tipo

cast.framework.system.EventType

El valor no debe ser nulo.

handler

function(non-null cast.framework.system.Event)

sendCustomMessage

sendCustomMessage(namespace, senderId, data)

Envía un mensaje a un remitente específico.

Parámetro

espacio de nombres

string

Es el espacio de nombres. Ten en cuenta que un espacio de nombres válido debe tener el prefijo de la cadena "urn:x-cast:".

senderId

(cadena o indefinido)

Es el senderId o un valor indefinido para transmitir a todos los remitentes.

datos

Cualquier tipo

Es la carga útil del mensaje.

El valor no debe ser nulo.
Arroja

Error Si se produjo un error cuando se preparaba el mensaje.

sendFeedbackMessage

sendFeedbackMessage(feedbackMessage)

Se debe llamar a esta función en respuesta al evento feedbackstarted si la aplicación agrega información de estado de depuración para registrar en el informe de comentarios. Toma un parámetro "message", que es una cadena que representa la información de depuración que la aplicación desea registrar.

Parámetro

feedbackMessage

string
Obsoleto
Usa cast.framework.CastReceiverContext#setFeedbackHandler

setApplicationState

setApplicationState(statusText)

Establece el estado de la aplicación. La aplicación debe llamar a este método cuando cambia su estado. Si no se define o se establece en una cadena vacía, el valor del nombre de la aplicación establecido durante el registro de la aplicación se usa para el estado de la aplicación de forma predeterminada.

Parámetro

statusText

string

Es el texto del estado.

setFeedbackHandler

setFeedbackHandler(feedbackHandler)

Establece un controlador para proporcionar datos adicionales a un informe de comentarios. Se llamará al controlador cuando se cree un informe de comentarios y debería devolver datos adicionales como una cadena o una promesa de cadena. La promesa de devolución debe resolverse en un plazo de 5 segundos para que se incluya en el informe.

Parámetro

feedbackHandler

function()

El valor puede ser nulo.

setInactivityTimeout

setInactivityTimeout(maxInactivity)

Establece el tiempo de espera de inactividad del receptor. Se recomienda establecer el valor máximo de inactividad cuando se llama a Start y no cambiarlo. Esta API solo se proporciona con fines de desarrollo y depuración.

Parámetro

maxInactivity

número

Es el intervalo en segundos antes de cerrar una conexión que no responde.

setLoggerLevel

setLoggerLevel(level)

Establece el nivel de verbosidad del registro.

Parámetro

level

cast.framework.LoggerLevel

Es el nivel de registro.

El valor no debe ser nulo.

start

start(options) devuelve cast.framework.CastReceiverContext

Inicializa el administrador del sistema y el administrador de contenido multimedia para que la app receptora pueda recibir solicitudes de los remitentes.

Parámetro

opciones

(cast.framework.CastReceiverOptions no nulo o un objeto opcional no nulo)
Muestra

non-null cast.framework.CastReceiverContext 

detener

stop(closeReason)

Cierra la aplicación receptora.

Parámetro

closeReason

Opcional

cast.framework.common.CloseReason

Es el motivo de cierre opcional que indica por qué se detiene la aplicación receptora. Si no se proporciona, el framework inferirá el motivo en función de los eventos recientes del reproductor multimedia o recurrirá a APP_REQUEST. Pasa uno de los siguientes valores numéricos:

  • 13 (APP_CUSTOM_STOP): Se usa para acciones comerciales o de la IU del receptor personalizado (p.ej., el usuario hace clic en un botón "Salir" o "Cerrar" en la app, o bien se produce una navegación del receptor personalizado que se aleja de la transmisión).
  • 15 (APP_ERROR): Errores irrecuperables a nivel de la aplicación (p.ej., fallas de autenticación personalizada, fallas de recuperación de licencias o DRM, fallas de la API de backend) que ocurren fuera de los eventos de error del reproductor integrado de CAF.
  • 14 (APP_PLAYBACK_FINISHED): La app consumió su lista de reproducción o fila, o completó una experiencia multimedia independiente.
  • 6 (APP_REQUEST): Es un resguardo genérico o heredado que se usa cuando una aplicación solicita la finalización sin un motivo más específico.

El valor no debe ser nulo.