Clase: Sesión

Constructor

Sesión

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

Parámetro

sessionId

cadena

El identificador de la sesión.

appId

cadena

El identificador de la aplicación receptora.

displayName

cadena

El nombre visible de la aplicación.

appImages

Arreglo de chrome.cast.Image no nulo

Imágenes asociadas a la app.

El valor no debe ser nulo.

receptor

chrome.cast.Receiver

El receptor que ejecuta la app.

El valor no debe ser nulo.

Propiedades

appId

cadena

El identificador de la aplicación de Cast. No se muestran

appImages

no nulo Array de chrome.cast.Image no nulo

Corresponde al conjunto de imágenes disponibles que describen la aplicación.

displayName

cadena

Es el nombre legible de la aplicación de Cast, por ejemplo, "YouTube".

media

no nulo Array de chrome.cast.media.Media no nulo

El contenido multimedia que pertenece a esta sesión de transmisión, incluidos los que cargan otros remitentes

namespaces

Arreglo no nulo de {name: string}

Una lista de los espacios de nombres compatibles con la aplicación receptora.

receptor

chrome.cast.Receiver no nulo

El receptor que ejecuta la aplicación.

senderApps

no nulo Array de chrome.cast.SenderApplication no nulo

Las aplicaciones emisoras compatibles con la aplicación receptora. Se puede usar para solicitarle al usuario que instale o visite la aplicación remitente.

sessionId

cadena

Identifica de forma única esta instancia de la aplicación receptora.

de reconocimiento

chrome.cast.SessionStatus no nulo

Estado de esta sesión de transmisión a la aplicación receptora.

statusText

string anulable

Texto descriptivo para el contenido actual de la aplicación, por ejemplo, "Mi presentación de bodas".

transportId

cadena

Identificador que describe de forma única esta sesión para fines de transporte. Esto es algo interno del canal de comunicación.

Métodos

addMediaListener

addMediaListener(listener)

Agrega un objeto de escucha que se invoca cuando otro remitente crea una sesión multimedia.

Parámetro

objeto de escucha

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

El objeto de escucha que se agregará.

addMessageListener

addMessageListener(namespace, listener)

Agrega un objeto de escucha que se invoca cuando se recibe un mensaje de la aplicación receptora. El objeto de escucha se invoca con el espacio de nombres como primer argumento y el mensaje como segundo argumento.

Parámetro

espacio de nombres

cadena

El espacio de nombres en el que se escuchará, p.ej., "urn:x-cast:com.example.namespace".

objeto de escucha

función(cadena, cadena)

El objeto de escucha que se agregará.

addUpdateListener

addUpdateListener(listener)

Agrega un objeto de escucha que se invoca cuando cambia la sesión. Los cambios en las siguientes propiedades activarán el objeto de escucha: statusText, espacios de nombres, estado y volumen del receptor.

Los objetos de escucha deben verificar la propiedad status de la sesión para determinar el estado de conexión. El parámetro booleano isAlive dejó de estar disponible y se reemplazó por la propiedad de sesión status. El parámetro isAlive todavía se pasa para la retrocompatibilidad y es verdadero, a menos que status = chrome.cast.SessionStatus.STOPPED.

Parámetro

objeto de escucha

function(boolean)

El objeto de escucha que se agregará.

getDialAppInfo

getDialAppInfo(successCallback, errorCallback)

Obtiene la información de la app de DIAL.

Parámetro

successCallback

function(non-null chrome.cast.DialLaunchData)

errorCallback

function(non-null chrome.cast.Error)

sales

sale(successCallback, errorCallback)

Se sale (se desconecta) de la aplicación receptora en ejecución asociada con la sesión.

Se desconectarán los clientes existentes dentro del alcance definido por la AutoJoinPolicy de este cliente. Los clientes futuros no se unirán automáticamente a la sesión que se interrumpió.

Se llamará a los objetos de escucha de actualización de sesión de todos los clientes desconectados con isAlive = true. Los objetos de escucha deben verificar la propiedad status de la sesión para determinar el estado de la conexión, ya que isAlive dejó de estar disponible. En este caso, es status = chrome.cast.SessionStatus.DISCONNECTED.

Parámetro

successCallback

función()

errorCallback

function(non-null chrome.cast.Error)

Los errores posibles son TIMEOUT, API_NOT_INITIALIZED, CHANNEL_ERROR, SESSION_ERROR y EXTENSION_MISSING.

loadMedia

loadMedia(loadRequest, successCallback, errorCallback)

Carga contenido multimedia en una aplicación receptora en ejecución.

Parámetro

loadRequest

chrome.cast.media.LoadRequest

Solicitud para cargar contenido multimedia.

El valor no debe ser nulo.

successCallback

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

Se invoca con el contenido multimedia cargado cuando se realiza de forma correcta.

errorCallback

function(non-null chrome.cast.Error)

Se invocó cuando se produce un error. Los errores posibles son TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR y EXTENSION_MISSING.

queueLoad

queueLoad(queueLoadRequest, successCallback, errorCallback)

Carga y, opcionalmente, inicia la reproducción de una cola nueva de elementos multimedia en una aplicación receptora en ejecución.

Parámetro

queueLoadRequest

chrome.cast.media.QueueLoadRequest

Solicita cargar una nueva cola de elementos multimedia.

El valor no debe ser nulo.

successCallback

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

Se invoca con el contenido multimedia cargado cuando se realiza de forma correcta.

errorCallback

function(non-null chrome.cast.Error)

Se invocó cuando se produce un error. Los errores posibles son TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR y EXTENSION_MISSING.

Funciones obsoletas
Usa cast.framework.CastSession#loadMedia y proporciona chrome.cast.media.LoadRequest#queueData relevante.

removeMediaListener

removeMediaListener(listener)

Quita un objeto de escucha que se agregó previamente con addMediaListener.

Parámetro

objeto de escucha

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

Es el objeto de escucha que se quitará.

removeMessageListener

removeMessageListener(namespace, listener)

Quita un objeto de escucha que se agregó anteriormente para los mensajes.

Parámetro

espacio de nombres

cadena

El espacio de nombres que se escucha, p.ej., "urn:x-cast:com.example.namespace".

objeto de escucha

función(cadena, cadena)

El objeto de escucha que se quitará.

removeUpdateListener

removeUpdateListener(listener)

Quita un objeto de escucha agregado anteriormente para esta sesión.

Parámetro

objeto de escucha

function(boolean)

El objeto de escucha que se quitará.

sendMessage

sendMessage(namespace, message, successCallback, errorCallback)

Envía un mensaje a la aplicación receptora en el espacio de nombres determinado. La exitosa devolución de llamada se invoca cuando el mensaje se envía al canal de mensajería. La entrega a la aplicación receptora representa el mejor esfuerzo y no está garantizada.

Parámetro

espacio de nombres

cadena

El espacio de nombres en el que se enviará el mensaje, p.ej., "urn:x-cast:com.example.namespace".

mensaje

(non-null Object or string)

successCallback

función()

Se invoca cuando se envía el mensaje.

errorCallback

function(non-null chrome.cast.Error)

Se invocó cuando se produce un error. Los errores posibles son TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR y EXTENSION_MISSING.

setReceiverMuted

setReceiverMuted(muted, successCallback, errorCallback)

Establece el volumen del receptor.

Parámetro

silenciado

boolean

El nuevo estado silenciado.

successCallback

función()

errorCallback

function(non-null chrome.cast.Error)

Los errores posibles son TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR y EXTENSION_MISSING.

setReceiverVolumeLevel

setReceiverVolumeLevel(newLevel, successCallback, errorCallback)

Establece el volumen del receptor.

Parámetro

newLevel

número

El nuevo nivel de volumen, entre 0.0 y 1.0.

successCallback

función()

errorCallback

function(non-null chrome.cast.Error)

Los errores posibles son TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR y EXTENSION_MISSING.

escala

stop(successCallback, errorCallback)

Detiene la aplicación receptora en ejecución asociada con la sesión.

Parámetro

successCallback

función()

errorCallback

function(non-null chrome.cast.Error)

Los errores posibles son TIMEOUT, API_NOT_INITIALIZED, CHANNEL_ERROR, SESSION_ERROR y EXTENSION_MISSING.