Espacio de nombres: cast

castchrome

namespace   estático

Este es el espacio de nombres chrome.cast.

Clases

ApiConfig

Contiene la configuración de la API cuando se inicializa.

CredentialsData

Los datos de credenciales que se usan para identificar las credenciales del remitente.

DialRequest

Una solicitud para iniciar una app de DIAL.

Error

Describe un error que muestra la API. Por lo general, el cliente no debe crear estos objetos.

Imagen

Es una imagen que describe una aplicación receptora o un elemento multimedia. Puede ser un ícono de la app, una portada o una miniatura.

Receptor

Describe el receptor que ejecuta una aplicación. Por lo general, el cliente no debe crear estos objetos.

ReceiverDisplayStatus

Estado del receptor que se muestra al usuario en la IU de la extensión. Válido solo para receptores CUSTOM.

SenderApplication

Describe una aplicación emisora. Por lo general, el cliente no debe crear estos objetos.

Sesión

Describe el estado de una aplicación de Cast que se encuentra en ejecución. Por lo general, el cliente no debe crear estos objetos.

SessionRequest

Es una solicitud para iniciar una sesión o conectarse a ella.

Tiempo de espera

Define los valores predeterminados de tiempo de espera en milisegundos para los métodos de la API.

Volume

Es el volumen de un dispositivo o transmisión de contenido multimedia.

Espacio de nombres

media

Enumeraciones

AutoJoinPolicy

estática

cadena

La política de unión automática determina cuándo el SDK conectará automáticamente una aplicación remitente a una sesión existente después de que se inicializa la API.

Valor
TAB_AND_ORIGIN_SCOPED	cadena Se conecta automáticamente cuando se inicia la sesión con el mismo appId, en el mismo origen de pestaña y página.
ORIGIN_SCOPED	cadena Se conecta automáticamente cuando se inicia la sesión con el mismo appId y el mismo origen de página (independientemente de la pestaña).
PAGE_SCOPED	cadena No hay conexión automática.

Capacidades

estática

cadena

Funciones que admite el dispositivo receptor

Valor
VIDEO_OUT	cadena El receptor admite la salida de video.
AUDIO_OUT	cadena El receptor admite la salida de audio.
VIDEO_IN	cadena El receptor admite la entrada de video (cámara).
AUDIO_IN	cadena El receptor admite la entrada de audio (micrófono).
MULTIZONE_GROUP	cadena El receptor representa un grupo multizona.

DefaultActionPolicy

estática

cadena

La política de acciones predeterminada determina cuándo el SDK creará automáticamente una sesión después de inicializar la API. Esto también controla la acción predeterminada de la pestaña en la ventana emergente de la extensión.

Valor
CREATE_SESSION	cadena Si se transmite la pestaña que contiene la app cuando se inicializa la API, el SDK detiene la transmisión de pestañas e inicia automáticamente la app. La ventana emergente de la extensión solicita al usuario que transmita la app.
CAST_THIS_TAB	cadena No se realiza ningún inicio automático después de inicializar la API, incluso si se está transmitiendo la pestaña. La ventana emergente de la extensión le solicitará al usuario que transmita la pestaña.

DialAppState

estática

cadena

Posibles estados de una aplicación DIAL

Valor
EN EJECUCIÓN	cadena
DETENIDO	cadena
ERROR	cadena No forma parte de la especificación; se usa para indicar errores.

ErrorCode

estática

cadena

Errores que puede mostrar el SDK.

Valor
CANCELAR	cadena El usuario canceló la operación.
agotar tiempo de espera	cadena Se agotó el tiempo de espera de la operación.
API_NOT_INITIALIZED	cadena No se inicializó la API.
INVALID_PARAMETER	cadena Los parámetros de la operación no eran válidos.
EXTENSION_NOT_COMPATIBLE	cadena La secuencia de comandos de la API no es compatible con la extensión Cast instalada.
EXTENSION_MISSING	cadena La extensión Cast no está disponible.
RECEIVER_UNAVAILABLE	cadena Ningún receptor era compatible con la solicitud de sesión.
SESSION_ERROR	cadena No se pudo crear una sesión o una sesión no es válida.
CHANNEL_ERROR	cadena No hay un canal disponible para el receptor.
LOAD_MEDIA_FAILED	cadena No se pudieron cargar los medios.

ReceiverAction

estática

cadena

Acciones que el usuario puede realizar en un receptor en la extensión Se pueden usar para mostrar una transición en la IU de la aplicación emisora antes de que la acción de transmisión se complete (o falle).

Valor
CAST	cadena El usuario seleccionó un receptor con la intención de transmitirle con la aplicación emisora. Es posible que no se conozca la identidad exacta del receptor.
DETENER	cadena El usuario solicitó detener la sesión que se ejecuta en un receptor.

ReceiverAvailability

estática

cadena

Describe la disponibilidad de un receptor de transmisiones.

Valor
DISPONIBLES	cadena Hay al menos un receptor disponible que es compatible con la solicitud de sesión.
NO DISPONIBLE	cadena No hay receptores disponibles.

ReceiverType

estática

cadena

Valor
CAST	cadena Receptor de transmisiones, p.ej., Chromecast
DIAL	cadena DIAL dispositivo (p.ej., smart TV)
HANGOUT	cadena Relajado
PERSONALIZADO	cadena Receptor personalizado proporcionado por el cliente

SenderPlatform

estática

cadena

Describe una plataforma de aplicación emisora.

Valor
CHROME	cadena
iOS	cadena
ANDROID	cadena

SessionStatus

estática

cadena

Describe el estado de una sesión de transmisión a la aplicación receptora.

Valor
CONEXIÓN ESTABLECIDA	cadena La sesión está conectada a la aplicación receptora.
DESCONECTADO	cadena La sesión se desconecta de la aplicación receptora. La aplicación receptora puede o no estar en ejecución.
DETENIDO	cadena Se detuvo la aplicación receptora.

VolumeControlType

estática

cadena

Describe los tipos de control de volumen.

Valor
ATENCIÓN	cadena Se puede cambiar el volumen del dispositivo de transmisión.
corregidas	cadena El volumen del dispositivo de transmisión es fijo y no se puede cambiar.
MAESTRO	cadena Se cambió el control de volumen principal del sistema, p.ej., se cambió el volumen del dispositivo de audio o la TV.

Propiedades

AutoJoinPolicy

estática

cadena

La política de unión automática determina cuándo el SDK conectará automáticamente una aplicación remitente a una sesión existente después de que se inicializa la API.

Valor
TAB_AND_ORIGIN_SCOPED	cadena Se conecta automáticamente cuando se inicia la sesión con el mismo appId, en el mismo origen de pestaña y página.
ORIGIN_SCOPED	cadena Se conecta automáticamente cuando se inicia la sesión con el mismo appId y el mismo origen de página (independientemente de la pestaña).
PAGE_SCOPED	cadena No hay conexión automática.

Capacidades

estática

cadena

Funciones que admite el dispositivo receptor

Valor
VIDEO_OUT	cadena El receptor admite la salida de video.
AUDIO_OUT	cadena El receptor admite la salida de audio.
VIDEO_IN	cadena El receptor admite la entrada de video (cámara).
AUDIO_IN	cadena El receptor admite la entrada de audio (micrófono).
MULTIZONE_GROUP	cadena El receptor representa un grupo multizona.

DefaultActionPolicy

estática

cadena

La política de acciones predeterminada determina cuándo el SDK creará automáticamente una sesión después de inicializar la API. Esto también controla la acción predeterminada de la pestaña en la ventana emergente de la extensión.

Valor
CREATE_SESSION	cadena Si se transmite la pestaña que contiene la app cuando se inicializa la API, el SDK detiene la transmisión de pestañas e inicia automáticamente la app. La ventana emergente de la extensión solicita al usuario que transmita la app.
CAST_THIS_TAB	cadena No se realiza ningún inicio automático después de inicializar la API, incluso si se está transmitiendo la pestaña. La ventana emergente de la extensión le solicitará al usuario que transmita la pestaña.

DialAppState

estática

cadena

Posibles estados de una aplicación DIAL

Valor
EN EJECUCIÓN	cadena
DETENIDO	cadena
ERROR	cadena No forma parte de la especificación; se usa para indicar errores.

ErrorCode

estática

cadena

Errores que puede mostrar el SDK.

Valor
CANCELAR	cadena El usuario canceló la operación.
agotar tiempo de espera	cadena Se agotó el tiempo de espera de la operación.
API_NOT_INITIALIZED	cadena No se inicializó la API.
INVALID_PARAMETER	cadena Los parámetros de la operación no eran válidos.
EXTENSION_NOT_COMPATIBLE	cadena La secuencia de comandos de la API no es compatible con la extensión Cast instalada.
EXTENSION_MISSING	cadena La extensión Cast no está disponible.
RECEIVER_UNAVAILABLE	cadena Ningún receptor era compatible con la solicitud de sesión.
SESSION_ERROR	cadena No se pudo crear una sesión o una sesión no es válida.
CHANNEL_ERROR	cadena No hay un canal disponible para el receptor.
LOAD_MEDIA_FAILED	cadena No se pudieron cargar los medios.

isAvailable

estática

boolean

Marca para que los clientes verifiquen si la API está cargada.

ReceiverAction

estática

cadena

Acciones que el usuario puede realizar en un receptor en la extensión Se pueden usar para mostrar una transición en la IU de la aplicación emisora antes de que la acción de transmisión se complete (o falle).

Valor
CAST	cadena El usuario seleccionó un receptor con la intención de transmitirle con la aplicación emisora. Es posible que no se conozca la identidad exacta del receptor.
DETENER	cadena El usuario solicitó detener la sesión que se ejecuta en un receptor.

ReceiverAvailability

estática

cadena

Describe la disponibilidad de un receptor de transmisiones.

Valor
DISPONIBLES	cadena Hay al menos un receptor disponible que es compatible con la solicitud de sesión.
NO DISPONIBLE	cadena No hay receptores disponibles.

ReceiverType

estática

cadena

Valor
CAST	cadena Receptor de transmisiones, p.ej., Chromecast
DIAL	cadena DIAL dispositivo (p.ej., smart TV)
HANGOUT	cadena Relajado
PERSONALIZADO	cadena Receptor personalizado proporcionado por el cliente

SenderPlatform

estática

cadena

Describe una plataforma de aplicación emisora.

Valor
CHROME	cadena
iOS	cadena
ANDROID	cadena

SessionStatus

estática

cadena

Describe el estado de una sesión de transmisión a la aplicación receptora.

Valor
CONEXIÓN ESTABLECIDA	cadena La sesión está conectada a la aplicación receptora.
DESCONECTADO	cadena La sesión se desconecta de la aplicación receptora. La aplicación receptora puede o no estar en ejecución.
DETENIDO	cadena Se detuvo la aplicación receptora.

tiempo de espera

estática

no nulo chrome.cast.Timeout

Valores predeterminados de tiempo de espera en milisegundos para los métodos de la API.

VERSIÓN

constante   estática

no nulo Array de número

Es la versión de la API. El primer número es la versión principal y el segundo es la versión secundaria.

VolumeControlType

estática

cadena

Describe los tipos de control de volumen.

Valor
ATENCIÓN	cadena Se puede cambiar el volumen del dispositivo de transmisión.
corregidas	cadena El volumen del dispositivo de transmisión es fijo y no se puede cambiar.
MAESTRO	cadena Se cambió el control de volumen principal del sistema, p.ej., se cambió el volumen del dispositivo de audio o la TV.

Métodos

addReceiverActionListener

estática

addReceiverActionListener(listener)

Agrega una función de objeto de escucha que se invocará cuando el usuario realice una acción a través de la IU para iniciar o detener la transmisión. La aplicación emisora puede usar esto para mostrar una transición en su interfaz de usuario (es decir, pausar el contenido multimedia que se reproduce de manera local) antes de que la acción de transmisión se complete o falle.

• No se garantiza que se invoque el objeto de escucha, y las aplicaciones no deberían depender de él para funcionar correctamente.
• El objeto de escucha recibirá el receptor sobre el que se actuó, si está disponible. Sin embargo, es posible que no se conozca el receptor y, en su lugar, se pasará un valor nulo.
• Se llamará al objeto de escucha en cuanto sea posible después de que el usuario realice una acción. Se debe invocar antes de que se notifique a la aplicación sobre el cambio de estado resultante a través de la API.

Si usas la API de Framework, usa cast.framework.CastContext#addEventListener en su lugar y escucha los eventos cast.framework.CastContextEventType#CAST_STATE_CHANGED.

Parámetro
objeto de escucha	chrome.cast.ReceiverActionListener La función de objeto de escucha que se agregará. El primer argumento para el objeto de escucha es el receptor sobre el que se actuó. El segundo argumento del objeto de escucha es la acción que se solicitó (consulta chrome.cast.ReceiverAction). El valor no debe ser nulo.

initialize

estática

inicializa(apiConfig, successCallback, errorCallback)

Inicializa la API. Ten en cuenta que se invocaránsuccessCallback y errorCallback una vez que la API haya finalizado la inicialización. Se pueden invocar los sessionListener yReceiverListener en cualquier momento posterior, y posiblemente más de una vez.

Si usas la API de Framework, usa cast.framework.CastContext#setOptions en lugar de esta función.

Parámetro
apiConfig	chrome.cast.ApiConfig Es el objeto con parámetros para inicializar la API. El valor no debe ser nulo.
successCallback	función()
errorCallback	function(non-null chrome.cast.Error) Los errores posibles son TIMEOUT, INVALID_PARAMETER, EXTENSION_MISSING.

logMessage

estática

logMessage(message)

Registra un mensaje de depuración de la app. Es posible que este mensaje se envíe en un informe de comentarios a Google si los usuarios eligen explícitamente incluir registros detallados.

Parámetro
mensaje	cadena El mensaje que se registrará.

Funciones obsoletas

No es compatible con el SDK de Cast basado en la API de Presentación.

almacenamiento previo en caché

estática

almacenamiento previo en caché(datos)

Envía una solicitud para almacenar datos en caché previamente. Si se conecta una sesión, se enviará una solicitud directa; de lo contrario, se enviará a todos los dispositivos de la red.

Parámetro
datos	cadena Datos que se almacenarán en caché.

Funciones obsoletas

No es compatible.

removeReceiverActionListener

estática

removeReceiverActionListener(listener)

Quita una función de objeto de escucha que se agregó previamente con addReceiverActionListener.

Parámetro
objeto de escucha	chrome.cast.ReceiverActionListener Es la función de objeto de escucha que se quitará. El valor no debe ser nulo.

requestSession

estática

requestSession(successCallback, errorCallback, sessionRequest)

Solicita que se cree o se una una sesión de la aplicación receptora. De forma predeterminada, se usa el objeto SessionRequest que se pasa a la API en el momento de la inicialización. Esto se puede anular si se pasa una solicitud de sesión diferente en sessionRequest.

Si usas la API de Framework, usa cast.framework.CastContext#requestSession en lugar de esta función.

Parámetro
successCallback	function(non-null chrome.cast.Session)
errorCallback	function(non-null chrome.cast.Error) Los errores posibles son TIMEOUT, INVALID_PARAMETER, API_NOT_INITIALIZED, CANCEL, CHANNEL_ERROR, SESSION_ERROR, RECEIVER_UNAVAILABLE y EXTENSION_MISSING. Ten en cuenta que el temporizador de tiempo de espera se inicia después de que los usuarios seleccionan un receptor. Para seleccionar un receptor, se requiere la acción del usuario, que no tiene tiempo de espera. Si ya hay una solicitud de sesión en curso, se invoca errorCallback con el código de error INVALID_PARAMETER y una descripción que explica el error.
sessionRequest	Opcional chrome.cast.SessionRequest El valor no debe ser nulo.

requestSessionById

estática

requestSessionById(sessionId)

Solicita unirse a una sesión existente con el ID especificado. Una vez unida, la sesión se pasará al sessionListener configurado por chrome.cast.inicializar.

Si ya se conoce la sesión con el sessionId específico cuando se llama a esta función, se llama inmediatamente a sessionListener. De lo contrario, una vez que se descubra una sesión con el sessionId determinado, se llamará a sessionListener.

Parámetro
sessionId	cadena El ID de la sesión a la que se va a unir.

setCustomReceivers

estática

setCustomReceivers(receivers, successCallback, errorCallback)

Establece la lista de receptores personalizados

Parámetro
receptores	Arreglo de chrome.cast.Receiver no nulo La lista nueva. El valor no debe ser nulo.
successCallback	función()
errorCallback	function(non-null chrome.cast.Error) Los errores posibles son TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR y EXTENSION_MISSRING.

Funciones obsoletas

No es compatible con el SDK de Cast basado en la API de Presentación.

setPageContext

estática

setPageContext(win)

Inicializa la funcionalidad de Cast para una página que carga el SDK de Cast en un iframe. Se debe llamar después de que se inicialice el SDK.

Parámetro
victoria	Window Objeto de ventana de la página. El valor no debe ser nulo.

setReceiverDisplayStatus

estática

setReceiverDisplayStatus(receiver, successCallback, errorCallback)

Establece el nombre del receptor y el estado de visualización. Para mostrar el receptor como inactivo, establece displayStatus en nulo.

Válido solo para receptores CUSTOM. El displayStatus del receptor se ignora si este es CAST; la aplicación del receptor actualiza el estado del receptor de transmisión.

Parámetro
receptor	chrome.cast.Receiver El receptor. El valor no debe ser nulo.
successCallback	función() Es la devolución de llamada cuando se realiza correctamente la configuración del estado.
errorCallback	function(non-null chrome.cast.Error) Los errores posibles son TIMEOUT, INVALID_PARAMETER, API_NOT_INITIALIZED y EXTENSION_MISSING.

Funciones obsoletas

No es compatible con el SDK de Cast basado en la API de Presentación.

unescape

estática

unescape(escaped) muestra una cadena

Método de utilidad para evitar las strings con escape de URI. Por ejemplo, el nombre descriptivo del receptor se muestra como una string escapada de URI. Usa este método para quitar el escape de esa string si es necesario.

Parámetro
escapado	cadena Una string para anular el escape

Devuelve

string Cadena sin escape

Tipo abstracto

ReceiverActionListener

estática

ReceiverActionListener()