chrome. reparto
Este es el espacio de nombres chrome.cast.
Clases
ApiConfig
Contiene la configuración de la API cuando se inicializa.
CredentialsData
Datos de credenciales usados para identificar las credenciales del remitente.
DialRequest
Una solicitud para iniciar una app DIAL.
Error
Describe un error que muestra la API. Normalmente, el cliente no debe crear estos objetos.
Image
Una imagen que describe una aplicación receptora o un elemento multimedia. Puede ser un ícono de la aplicación, una portada o una miniatura.
Receptor
Describe el receptor que ejecuta una aplicación. Normalmente, el cliente no debe crear estos objetos.
ReceiverDisplayStatus
Estado del receptor que se muestra al usuario en la IU de la extensión. Solo es válido para receptores personalizados.
SenderApplication
Describe una aplicación emisora. Normalmente, el cliente no debe crear estos objetos.
Sesión
Describe el estado de una aplicación de transmisión en ejecución. Normalmente, el cliente no debe crear estos objetos.
SessionRequest
Una solicitud para iniciar una sesión o conectarse a ella.
Tiempo de espera
Define los valores de tiempo de espera predeterminados en milisegundos para los métodos de la API.
Volume
El volumen de un dispositivo o una transmisión multimedia.
Espacio de nombres
media
Enumeraciones
Política de unión automática
string
La política de unión automática determina cuándo el SDK conectará de forma automática una aplicación emisora a una sesión existente después de la inicialización de la API.
Valor |
|
---|---|
TAB_AND_ORIGIN_SCOPED |
string Se conecta automáticamente cuando se inicia la sesión con el mismo appId, en el mismo origen de página y pestaña. |
ORIGIN_SCOPED |
string 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). |
COPIA DE LA PÁGINA |
string Sin conexión automática. |
Función
string
Funciones compatibles con el dispositivo receptor
Valor |
|
---|---|
VIDEO_OUT |
string El receptor admite salida de video. |
AUDIO_OUT |
string El receptor admite salida de audio. |
ENTRADA DE VIDEO |
string El receptor admite entrada de video (cámara). |
AUDIO_IN |
string El receptor admite entrada de audio (micrófono). |
MULTIZONE_GROUP |
string El receptor representa un grupo multizona. |
Política de acción predeterminada
string
La política de acción 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 para la pestaña en la ventana emergente de la extensión.
Valor |
|
---|---|
CREAR_SESIÓN |
string Si se transmite la pestaña que contiene la app cuando se inicializa la API, el SDK detiene la transmisión de pestañas y, luego, inicia automáticamente la app. La ventana emergente de la extensión solicita al usuario que transmita la app. |
CAST_THIS_TAB |
string No se realiza ninguna ejecución automática después de inicializar la API, incluso si la pestaña se está transmitiendo. La ventana emergente de la extensión solicita al usuario que transmita la pestaña. |
DialAppState
string
Estados posibles de una aplicación DIAL.
Valor |
|
---|---|
EN EJECUCIÓN |
string |
DETENIDO |
string |
ERROR |
string No forma parte de la especificación, ya que se utiliza para indicar errores. |
ErrorCode
string
Errores que el SDK puede mostrar
Valor |
|
---|---|
CANCELAR |
string El usuario canceló la operación. |
agotar tiempo de espera |
string Se agotó el tiempo de espera de la operación. |
API_NOT_INITIALIZED |
string No se inicializó la API. |
INVALID_PARAMETER |
string Los parámetros de la operación no eran válidos. |
EXTENSION_NOT_COMPATIBLE |
string La secuencia de comandos de la API no es compatible con la extensión de Cast instalada. |
EXTENSIÓN |
string La extensión de Google Cast no está disponible. |
NO DISPONIBLE |
string Ningún receptor era compatible con la solicitud de sesión. |
SESSION_ERROR |
string No se pudo crear una sesión o esta no es válida. |
ERROR_DE CANAL |
string No hay un canal disponible para el receptor. |
LOAD_MEDIA_FAILED |
string No se pudieron cargar los medios. |
Acción del receptor
string
Acciones que el usuario puede realizar en un receptor de la extensión. Estos se pueden usar para mostrar una transición en la IU de la aplicación emisora antes de que se complete por completo (o no) la acción de transmisión.
Valor |
|
---|---|
TRANSMITIR |
string El usuario seleccionó un receptor con la intención de transmitirle mediante la aplicación emisora. Es posible que no se conozca la identidad exacta del receptor. |
DETENER |
string El usuario solicitó detener la sesión que se ejecuta en un receptor. |
Disponibilidad del receptor
string
Describe la disponibilidad de un receptor de Cast.
Valor |
|
---|---|
DISPONIBLES |
string Al menos un receptor disponible que sea compatible con la solicitud de sesión. |
NO DISPONIBLE |
string No hay receptores disponibles. |
Tipo de receptor
string
Valor |
|
---|---|
TRANSMITIR |
string Receptor de transmisión, p.ej., Chromecast |
DIAL |
string Dispositivo DIAL, p.ej., televisor inteligente |
INICIAR UN HANGOUT |
string Relajado |
PERSONALIZADO |
string Receptor personalizado proporcionado por el cliente |
Plataforma del remitente
string
Describe una plataforma de aplicación emisora.
Valor |
|
---|---|
CHROME; |
string |
iOS |
string |
ANDROID |
string |
Estado de la sesión
string
Describe el estado de una sesión de transmisión a la aplicación receptora.
Valor |
|
---|---|
CONEXIÓN ESTABLECIDA |
string La sesión está conectada a la aplicación receptora. |
DESCONECTADO |
string La sesión se desconecta de la aplicación receptora. Es posible que la aplicación receptora se esté ejecutando o no. |
DETENIDO |
string Se detuvo la aplicación receptora. |
Tipo de control de volumen
string
Describe los tipos de control de volumen.
Valor |
|
---|---|
ATENCIÓN |
string Puedes cambiar el volumen del dispositivo de transmisión. |
corregidas |
string El volumen del dispositivo de transmisión es fijo y no se puede cambiar. |
MASTER |
string Control de volumen del sistema principal, es decir, cambia el volumen del dispositivo de TV o audio. |
Propiedades
Política de unión automática
string
La política de unión automática determina cuándo el SDK conectará de forma automática una aplicación emisora a una sesión existente después de la inicialización de la API.
Valor |
|
---|---|
TAB_AND_ORIGIN_SCOPED |
string Se conecta automáticamente cuando se inicia la sesión con el mismo appId, en el mismo origen de página y pestaña. |
ORIGIN_SCOPED |
string 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). |
COPIA DE LA PÁGINA |
string Sin conexión automática. |
Función
string
Funciones compatibles con el dispositivo receptor
Valor |
|
---|---|
VIDEO_OUT |
string El receptor admite salida de video. |
AUDIO_OUT |
string El receptor admite salida de audio. |
ENTRADA DE VIDEO |
string El receptor admite entrada de video (cámara). |
AUDIO_IN |
string El receptor admite entrada de audio (micrófono). |
MULTIZONE_GROUP |
string El receptor representa un grupo multizona. |
Política de acción predeterminada
string
La política de acción 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 para la pestaña en la ventana emergente de la extensión.
Valor |
|
---|---|
CREAR_SESIÓN |
string Si se transmite la pestaña que contiene la app cuando se inicializa la API, el SDK detiene la transmisión de pestañas y, luego, inicia automáticamente la app. La ventana emergente de la extensión solicita al usuario que transmita la app. |
CAST_THIS_TAB |
string No se realiza ninguna ejecución automática después de inicializar la API, incluso si la pestaña se está transmitiendo. La ventana emergente de la extensión solicita al usuario que transmita la pestaña. |
DialAppState
string
Estados posibles de una aplicación DIAL.
Valor |
|
---|---|
EN EJECUCIÓN |
string |
DETENIDO |
string |
ERROR |
string No forma parte de la especificación, ya que se utiliza para indicar errores. |
ErrorCode
string
Errores que el SDK puede mostrar
Valor |
|
---|---|
CANCELAR |
string El usuario canceló la operación. |
agotar tiempo de espera |
string Se agotó el tiempo de espera de la operación. |
API_NOT_INITIALIZED |
string No se inicializó la API. |
INVALID_PARAMETER |
string Los parámetros de la operación no eran válidos. |
EXTENSION_NOT_COMPATIBLE |
string La secuencia de comandos de la API no es compatible con la extensión de Cast instalada. |
EXTENSIÓN |
string La extensión de Google Cast no está disponible. |
NO DISPONIBLE |
string Ningún receptor era compatible con la solicitud de sesión. |
SESSION_ERROR |
string No se pudo crear una sesión o esta no es válida. |
ERROR_DE CANAL |
string No hay un canal disponible para el receptor. |
LOAD_MEDIA_FAILED |
string No se pudieron cargar los medios. |
Está disponible.
boolean
Marca para que los clientes verifiquen si se cargó la API.
Acción del receptor
string
Acciones que el usuario puede realizar en un receptor de la extensión. Estos se pueden usar para mostrar una transición en la IU de la aplicación emisora antes de que se complete por completo (o no) la acción de transmisión.
Valor |
|
---|---|
TRANSMITIR |
string El usuario seleccionó un receptor con la intención de transmitirle mediante la aplicación emisora. Es posible que no se conozca la identidad exacta del receptor. |
DETENER |
string El usuario solicitó detener la sesión que se ejecuta en un receptor. |
Disponibilidad del receptor
string
Describe la disponibilidad de un receptor de Cast.
Valor |
|
---|---|
DISPONIBLES |
string Al menos un receptor disponible que sea compatible con la solicitud de sesión. |
NO DISPONIBLE |
string No hay receptores disponibles. |
Tipo de receptor
string
Valor |
|
---|---|
TRANSMITIR |
string Receptor de transmisión, p.ej., Chromecast |
DIAL |
string Dispositivo DIAL, p.ej., televisor inteligente |
INICIAR UN HANGOUT |
string Relajado |
PERSONALIZADO |
string Receptor personalizado proporcionado por el cliente |
Plataforma del remitente
string
Describe una plataforma de aplicación emisora.
Valor |
|
---|---|
CHROME; |
string |
iOS |
string |
ANDROID |
string |
Estado de la sesión
string
Describe el estado de una sesión de transmisión a la aplicación receptora.
Valor |
|
---|---|
CONEXIÓN ESTABLECIDA |
string La sesión está conectada a la aplicación receptora. |
DESCONECTADO |
string La sesión se desconecta de la aplicación receptora. Es posible que la aplicación receptora se esté ejecutando o no. |
DETENIDO |
string Se detuvo la aplicación receptora. |
timeout
no nulo chrome.cast.Timeout
Valores de tiempo de espera predeterminados en milisegundos para los métodos de API.
VERSIÓN
arreglo de número no nulo
La versión de la API. El primero es la versión principal y la segunda versión secundaria.
Tipo de control de volumen
string
Describe los tipos de control de volumen.
Valor |
|
---|---|
ATENCIÓN |
string Puedes cambiar el volumen del dispositivo de transmisión. |
corregidas |
string El volumen del dispositivo de transmisión es fijo y no se puede cambiar. |
MASTER |
string Control de volumen del sistema principal, es decir, cambia el volumen del dispositivo de TV o audio. |
Métodos
addReceiverActionListener
addReceiverActionListener(oyente)
Agrega una función de objeto de escucha que se invocará cuando el usuario haya actuado a través de la IU para iniciar o detener la transmisión. La aplicación emisora puede usarla para mostrar una transición en su interfaz de usuario (es decir, pausar la reproducción de contenido multimedia de manera local) antes de que se complete o falle la acción de transmisión.
- No se garantiza que se invoque el objeto de escucha, y las aplicaciones no deben depender de él para funcionar correctamente.
- Si está disponible, se le pasará al receptor sobre el que se realizó una acción. Sin embargo, es posible que no se conozca el receptor y, en su lugar, se pasará el valor nulo.
- Se llamará al objeto de escucha lo antes posible una vez que el usuario haya actuado. Debe invocarse antes de que la aplicación reciba una notificación sobre el cambio de estado resultante a través de la API.
Si usas la API de marco de trabajo, usa cast.framework.CastContext#addEventListener y, en su lugar, escucha eventos de 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 en el que se realizó una acción. 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
inicializa(apiConfig, successCallback, errorCallback)
Inicializa la API. Ten en cuenta que invocación y errorCallback se invocarán una vez que la API haya terminado de inicializarse. Los sessionListener y receptorListener pueden invocarse en cualquier momento posterior y, posiblemente, más de una vez.
Si usas la API de marco de trabajo, usa cast.framework.CastContext#setOptions en lugar de esta función.
Parámetro |
|
---|---|
apiConfig. |
El objeto con parámetros para inicializar la API. El valor no debe ser nulo. |
devolución de llamada exitosa |
función() |
error_callback |
function(no nulo chrome.cast.Error) Los posibles errores son TIMEOUT, INVALID_PARAMETER, EXTENSION_MISSING. |
logMessage
logMessage(mensaje)
Registra un mensaje de depuración desde la app. Es posible que se envíe en un informe de comentarios a Google si los usuarios optan explícitamente por incluir registros precisos.
Parámetro |
|
---|---|
mensaje |
string 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é
precaché(datos)
Envía una solicitud para almacenar en caché los datos. Si hay una sesión conectada, se enviará una solicitud directa. De lo contrario, se enviará a todos los dispositivos de la red.
Parámetro |
|
---|---|
datos |
string Datos a precaché. |
removeReceiverActionAction
removeReceiverActionListener(listener)
Quita una función de objeto de escucha que se había agregado con addReceiverActionListener.
Parámetro |
|
---|---|
objeto de escucha |
chrome.cast.ReceiverActionListener La función de objeto de escucha que se quitará. El valor no debe ser nulo. |
requestSession
requestSession(successCallback, errorCallback, sessionRequest)
Solicita que se cree una sesión de aplicación receptora o se una a ella. De forma predeterminada, se usa la SessionRequest que se pasa a la API en el momento de la inicialización, la cual puede anularse si pasas una solicitud de sesión diferente en sessionRequest.
Si usas la API de marco de trabajo, usa cast.framework.CastContext#requestSession en lugar de esta función.
Parámetro |
|
---|---|
devolución de llamada exitosa |
function(no nulo chrome.cast.Session) |
error_callback |
function(no nulo chrome.cast.Error) Los posibles errores 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 comienza 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 una solicitud de sesión ya está en curso, errorCallback se invoca con el código de error INVALID_PARAMETER y una descripción que explica el error. |
Solicitud de sesión |
Opcional El valor no debe ser nulo. |
requestSessionById
requestSessionById(sessionId)
Solicitudes para unirse a una sesión existente con el ID especificado. Una vez unida, la sesión se pasará al sessionListener configurado por chrome.cast.initialize.
Si la sesión con el sessionId dado ya es conocida cuando se llama a esta función, se llama a sessionListener de inmediato. De lo contrario, una vez que se descubra una sesión con el sessionId determinado, se llamará a sessionListener.
Parámetro |
|
---|---|
sessionId |
string Es el ID de la sesión a la que deseas unirte. |
setCustomReceivers
setCustomReceivers(receptores, SuccessCallback, errorCallback)
Configura la lista de receptores personalizados
Parámetro |
|
---|---|
receptores |
Matriz de chrome.cast.non no nula La nueva lista. El valor no debe ser nulo. |
devolución de llamada exitosa |
función() |
error_callback |
function(no nulo chrome.cast.Error) Los posibles errores 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.
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 página. El valor no debe ser nulo. |
setReceiverDisplayStatus
setReceiverDisplayStatus(receiver, SuccessCallback, errorCallback)
Establece el nombre del receptor y el estado de visualización. Para mostrar el receptor como inactivo, establece displayStatus como nulo.
Solo es válido para receptores personalizados. Se ignora el displayStatus del receptor si este es CAST. La aplicación receptora actualiza el estado del receptor de Cast.
Parámetro |
|
---|---|
receptor |
El receptor. El valor no debe ser nulo. |
devolución de llamada exitosa |
función() Es la devolución de llamada cuando la configuración del estado es correcta. |
error_callback |
function(no nulo chrome.cast.Error) Los posibles errores 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.
sin escape
sin escape(con escape) muestra la string
Método de utilidad para escapar las strings de escape de URI. Por ejemplo, el nombre descriptivo del receptor se muestra como una string con escape de URI. Usa este método para escapar esa string si es necesario.
Parámetro |
|
---|---|
escapó |
string Una string para escapar sin escape |
- Resultado que se muestra
-
string
string sin escape
Tipo abstracto
ReceiverActionAction
ReceiverActionListener()