Namespace: cast

chrome.transmitir

namespace   estático

Este é o namespace chrome.cast.

Aulas

Namespace

Enumerações

AutoJoinPolicy

estática

string

A política de mesclagem automática determina quando o SDK conectará automaticamente um aplicativo remetente a uma sessão existente após a inicialização da API.

Valor

TAB_AND_ORIGIN_SCOPED

string

Conecta-se automaticamente quando a sessão foi iniciada com o mesmo appId, na mesma guia e origem da página.

ORIGIN_SCOPED

string

Conecta-se automaticamente quando a sessão foi iniciada com o mesmo appId e a mesma origem de página (independentemente da guia).

PAGE_SCOPED

string

Nenhuma conexão automática.

Capacidade

estática

string

Recursos com suporte do dispositivo receptor.

Valor

VIDEO_OUT

string

O receptor oferece suporte à saída de vídeo.

AUDIO_OUT

string

O receptor oferece suporte à saída de áudio.

VIDEO_IN

string

O receptor oferece suporte à entrada de vídeo (câmera).

AUDIO_IN

string

O receptor é compatível com a entrada de áudio (microfone).

MULTIZONE_GROUP

string

O receptor representa um grupo de várias zonas.

DefaultActionPolicy

estática

string

A política de ação padrão determina quando o SDK criará automaticamente uma sessão após inicializar a API. Isso também controla a ação padrão da guia no pop-up da extensão.

Valor

CREATE_SESSION

string

Se a guia que contém o app estiver sendo transmitida quando a API for inicializada, o SDK interromperá a transmissão da guia e iniciará automaticamente o app. O pop-up da extensão solicita que o usuário transmita o app.

CAST_THIS_TAB

string

Nenhuma inicialização automática é feita após a inicialização da API, mesmo que a guia esteja sendo transmitida. O pop-up da extensão solicita que o usuário transmita a guia.

DialAppState

estática

string

Estados possíveis de um aplicativo DIAL.

Valor

EM EXECUÇÃO

string

PARADO

string

ERROR

string

Não faz parte da especificação, é usado para sinalizar erros.

ErrorCode

estática

string

Erros que podem ser retornados pelo SDK.

Valor

CANCELAR

string

A operação foi cancelada pelo usuário.

TIMEOUT

string

A operação expirou.

API_NOT_INITIALIZED

string

A API não foi inicializada.

INVALID_PARAMETER

string

Os parâmetros da operação não eram válidos.

EXTENSION_NOT_COMPATIBLE

string

O script da API não é compatível com a extensão Google Cast instalada.

EXTENSION_MISSING

string

A extensão do Google Cast não está disponível.

RECEIVER_UNAVAILABLE

string

Nenhum receptor era compatível com a solicitação de sessão.

SESSION_ERROR

string

Não foi possível criar uma sessão ou ela foi inválida.

CHANNEL_ERROR

string

Um canal não está disponível para o receptor.

LOAD_MEDIA_FAILED

string

Falha ao carregar a mídia.

ReceiverAction

estática

string

Ações que o usuário pode realizar em um receptor na extensão. Eles podem ser usados para mostrar uma transição na interface do aplicativo remetente antes que a ação de transmissão seja totalmente concluída ou falhe.

Valor

CAST

string

O usuário selecionou um receptor com a intenção de transmitir para ele com o app remetente. A identidade exata do destinatário pode não ser conhecida.

PARE

string

O usuário solicitou a interrupção da execução da sessão em um receptor.

ReceiverAvailability

estática

string

Descreve a disponibilidade de um receptor do Cast.

Valor

AVAILABLE

string

Pelo menos um receptor compatível com a solicitação de sessão está disponível.

INDISPONÍVEL

string

Nenhum receptor disponível.

ReceiverType

estática

string

Valor

CAST

string

Receptor de transmissão (por exemplo, Chromecast)

DIAL

string

Dispositivo DIAL, por exemplo, smart TV

HANGOUT

string

Ponto de encontro

PERSONALIZADO

string

Receptor personalizado fornecido pelo cliente

SenderPlatform

estática

string

Descreve uma plataforma de aplicativo remetente.

Valor

CHROME

string

IOS

string

ANDROID

string

SessionStatus

estática

string

Descreve o status de uma sessão do Google Cast para o aplicativo receptor.

Valor

CONECTADO

string

A sessão é conectada ao aplicativo receptor.

DESCONECTADO

string

A sessão é desconectada do aplicativo receptor. O aplicativo receptor pode ou não estar em execução.

PARADO

string

O aplicativo receptor foi interrompido.

VolumeControlType

estática

string

Descreve os tipos de controle de volume.

Valor

ATENÇÃO

string

O volume do dispositivo de transmissão pode ser alterado.

CORRIGIDOS

string

O volume do dispositivo de transmissão é fixo e não pode ser alterado.

MESTRE

string

Controle de volume do sistema principal, isto é, o volume do dispositivo de TV ou áudio foi alterado.

Propriedades

AutoJoinPolicy

estática

string

A política de mesclagem automática determina quando o SDK conectará automaticamente um aplicativo remetente a uma sessão existente após a inicialização da API.

Valor

TAB_AND_ORIGIN_SCOPED

string

Conecta-se automaticamente quando a sessão foi iniciada com o mesmo appId, na mesma guia e origem da página.

ORIGIN_SCOPED

string

Conecta-se automaticamente quando a sessão foi iniciada com o mesmo appId e a mesma origem de página (independentemente da guia).

PAGE_SCOPED

string

Nenhuma conexão automática.

Capacidade

estática

string

Recursos com suporte do dispositivo receptor.

Valor

VIDEO_OUT

string

O receptor oferece suporte à saída de vídeo.

AUDIO_OUT

string

O receptor oferece suporte à saída de áudio.

VIDEO_IN

string

O receptor oferece suporte à entrada de vídeo (câmera).

AUDIO_IN

string

O receptor é compatível com a entrada de áudio (microfone).

MULTIZONE_GROUP

string

O receptor representa um grupo de várias zonas.

DefaultActionPolicy

estática

string

A política de ação padrão determina quando o SDK criará automaticamente uma sessão após inicializar a API. Isso também controla a ação padrão da guia no pop-up da extensão.

Valor

CREATE_SESSION

string

Se a guia que contém o app estiver sendo transmitida quando a API for inicializada, o SDK interromperá a transmissão da guia e iniciará automaticamente o app. O pop-up da extensão solicita que o usuário transmita o app.

CAST_THIS_TAB

string

Nenhuma inicialização automática é feita após a inicialização da API, mesmo que a guia esteja sendo transmitida. O pop-up da extensão solicita que o usuário transmita a guia.

DialAppState

estática

string

Estados possíveis de um aplicativo DIAL.

Valor

EM EXECUÇÃO

string

PARADO

string

ERROR

string

Não faz parte da especificação, é usado para sinalizar erros.

ErrorCode

estática

string

Erros que podem ser retornados pelo SDK.

Valor

CANCELAR

string

A operação foi cancelada pelo usuário.

TIMEOUT

string

A operação expirou.

API_NOT_INITIALIZED

string

A API não foi inicializada.

INVALID_PARAMETER

string

Os parâmetros da operação não eram válidos.

EXTENSION_NOT_COMPATIBLE

string

O script da API não é compatível com a extensão Google Cast instalada.

EXTENSION_MISSING

string

A extensão do Google Cast não está disponível.

RECEIVER_UNAVAILABLE

string

Nenhum receptor era compatível com a solicitação de sessão.

SESSION_ERROR

string

Não foi possível criar uma sessão ou ela foi inválida.

CHANNEL_ERROR

string

Um canal não está disponível para o receptor.

LOAD_MEDIA_FAILED

string

Falha ao carregar a mídia.

isAvailable

estática

boolean

Sinalização para os clientes verificarem se a API está carregada.

ReceiverAction

estática

string

Ações que o usuário pode realizar em um receptor na extensão. Eles podem ser usados para mostrar uma transição na interface do aplicativo remetente antes que a ação de transmissão seja totalmente concluída ou falhe.

Valor

CAST

string

O usuário selecionou um receptor com a intenção de transmitir para ele com o app remetente. A identidade exata do destinatário pode não ser conhecida.

PARE

string

O usuário solicitou a interrupção da execução da sessão em um receptor.

ReceiverAvailability

estática

string

Descreve a disponibilidade de um receptor do Cast.

Valor

AVAILABLE

string

Pelo menos um receptor compatível com a solicitação de sessão está disponível.

INDISPONÍVEL

string

Nenhum receptor disponível.

ReceiverType

estática

string

Valor

CAST

string

Receptor de transmissão (por exemplo, Chromecast)

DIAL

string

Dispositivo DIAL, por exemplo, smart TV

HANGOUT

string

Ponto de encontro

PERSONALIZADO

string

Receptor personalizado fornecido pelo cliente

SenderPlatform

estática

string

Descreve uma plataforma de aplicativo remetente.

Valor

CHROME

string

IOS

string

ANDROID

string

SessionStatus

estática

string

Descreve o status de uma sessão do Google Cast para o aplicativo receptor.

Valor

CONECTADO

string

A sessão é conectada ao aplicativo receptor.

DESCONECTADO

string

A sessão é desconectada do aplicativo receptor. O aplicativo receptor pode ou não estar em execução.

PARADO

string

O aplicativo receptor foi interrompido.

pedido de tempo

estática

chrome.cast.Timeout não nulo

Valores de tempo limite padrão em milissegundos para métodos de API.

VERSÃO

constante   estática

não nulo Matriz de números

A versão da API. O primeiro número é a versão principal e o segundo a versão secundária.

VolumeControlType

estática

string

Descreve os tipos de controle de volume.

Valor

ATENÇÃO

string

O volume do dispositivo de transmissão pode ser alterado.

CORRIGIDOS

string

O volume do dispositivo de transmissão é fixo e não pode ser alterado.

MESTRE

string

Controle de volume do sistema principal, isto é, o volume do dispositivo de TV ou áudio foi alterado.

Métodos

addReceiverActionListener

estática

addReceiverActionListener(listener)

Adiciona uma função de listener que será invocada quando o usuário agir por meio da interface para iniciar ou interromper a transmissão. O app remetente pode usar isso para mostrar uma transição na interface do usuário (ou seja, pausar a reprodução de mídia localmente) antes que a ação de transmissão seja concluída ou falhe.

  • Não há garantia de que o listener será invocado, e os aplicativos não podem depender dele para funcionar corretamente.
  • O listener será passado para o receptor que recebeu a ação, se disponível. No entanto, o receptor pode não ser conhecido, e o valor nulo será transmitido.
  • O listener será chamado o mais rápido possível depois que o usuário agir. Ele precisa ser invocado antes que o aplicativo seja notificado sobre a mudança de estado resultante pela API.

Se você estiver usando a API Framework, use cast.framework.CastContext#addEventListener e detecte eventos cast.framework.CastContextEventType#CAST_STATE_CHANGED.

Parâmetro

listener

chrome.cast.ReceiverActionListener

A função de listener a ser adicionada. O primeiro argumento para o listener é o receiver que recebeu a ação. O segundo argumento para o listener é a ação que foi solicitada (consulte chrome.cast.ReceiverAction).

O valor não pode ser nulo.

initialize

estática

initial(apiConfig, SuccessCallback, errorCallback)

Inicializa a API. O sucessoCallback e o errorCallback serão invocados quando a API terminar a inicialização. O sessionListener e o receiverListener podem ser invocados a qualquer momento depois e possivelmente mais de uma vez.

Se estiver usando a API Framework, use cast.framework.CastContext#setOptions em vez dessa função.

Parâmetro

apiConfig

chrome.cast.ApiConfig

O objeto com parâmetros para inicializar a API.

O valor não pode ser nulo.

successCallback

função()

errorCallback

function(non-null chrome.cast.Error)

Os possíveis erros são TIMEOUT, INVALID_PARAMETER, EXTENSION_MISSING.

logMessage

estática

logMessage(message)

Registra uma mensagem de depuração do app. Essa mensagem pode ser enviada em um relatório de feedback para o Google se os usuários optarem explicitamente por incluir registros detalhados.

Parâmetro

mensagem

string

A mensagem a ser registrada.
Descontinuado
Não é compatível com o SDK do Cast baseado na API Apresentação.

pré-cache

estática

pré-cache(dados)

Envie uma solicitação para pré-armazenar dados em cache. Se uma sessão estiver conectada, ele enviará uma solicitação direta. Caso contrário, ele será enviado para todos os dispositivos na rede.

Parâmetro

dados

string

Dados para pré-cache.
Descontinuado
Incompatível.

removeReceiverActionListener

estática

removeReceiverActionListener(listener)

Remove uma função de listener que foi adicionada anteriormente com addReceiverActionListener.

Parâmetro

listener

chrome.cast.ReceiverActionListener

A função de listener a ser removida.

O valor não pode ser nulo.

requestSession

estática

requestSession(successCallback, errorCallback, sessionRequest)

Solicita que uma sessão de aplicativo receptor seja criada ou participada. Por padrão, o SessionRequest transmitido para a API no momento da inicialização é usado. Isso pode ser substituído transmitindo uma solicitação de sessão diferente em sessionRequest.

Se você estiver usando a API Framework, use cast.framework.CastContext#requestSession em vez dessa função.

Parâmetro

successCallback

function(non-null chrome.cast.Session)

errorCallback

function(non-null chrome.cast.Error)

Os possíveis erros são TIMEOUT, INVALID_PARAMETER, API_NOT_INITIALIZED, CANCEL, CHANNEL_ERROR, SESSION_ERROR, RECEIVER_UNAVAILABLE e EXTENSION_MISSING. Observe que o timer de tempo limite começa depois que os usuários selecionam um receptor. A seleção de um receptor requer uma ação do usuário, que não tem tempo limite. Se uma solicitação de sessão já estiver em andamento, o errorCallback será invocado com o código do erro INVALID_PARAMETER e uma descrição explicando o erro.

sessionRequest

Opcional

chrome.cast.SessionRequest

O valor não pode ser nulo.

requestSessionById

estática

requestSessionById(sessionId)

Solicitações para participar de uma sessão existente com o ID fornecido. Depois de conectada, a sessão será transmitida para o sessionListener definido por chrome.cast.Initialize.

Se a sessão com o sessionId fornecido já for conhecido quando essa função for chamada, a sessionListener será chamado imediatamente. Caso contrário, quando uma sessão com o sessionId especificado for descoberta, sessionListener será chamado.

Parâmetro

sessionId

string

O ID da sessão de que você quer participar.

setCustomReceivers

estática

setCustomReceivers(receivers, successCallback, errorCallback)

Define a lista personalizada de receptores

Parâmetro

receptores

Matriz de chrome.cast.Receiver não nulo

A nova lista.

O valor não pode ser nulo.

successCallback

função()

errorCallback

function(non-null chrome.cast.Error)

Os possíveis erros são TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR e EXTENSION_MISSRING.
Descontinuado
Não é compatível com o SDK do Cast baseado na API Apresentação.

setPageContext

estática

setPageContext(win)

Inicializa a funcionalidade do Google Cast para uma página que carrega o SDK do Cast em um iframe. Precisa ser chamado após a inicialização do SDK.

Parâmetro

ganhar

Janela

Objeto da janela de página.

O valor não pode ser nulo.

setReceiverDisplayStatus

estática

setReceiverDisplayStatus(receiver, successCallback, errorCallback)

Define o nome do receptor e o status de exibição. Para mostrar o receptor como inativo, defina displayStatus como nulo.

Válido apenas para receptores PERSONALIZADOS. O displayStatus do receptor será ignorado se ele for CAST. O status do receptor da transmissão será atualizado pelo aplicativo receptor.

Parâmetro

receptor

chrome.cast.Receiver

O destinatário.

O valor não pode ser nulo.

successCallback

função()

Callback quando o status é definido.

errorCallback

function(non-null chrome.cast.Error)

Os possíveis erros são TIMEOUT, INVALID_PARAMETER, API_NOT_INITIALIZED e EXTENSION_MISSING.
Descontinuado
Não é compatível com o SDK do Cast baseado na API Apresentação.

unescape

estática

unescape(escape) retorna string:

Método utilitário para remover o escape de strings com escape de URI. Por exemplo, o nome compatível com o receptor é retornado como uma string com escape de URI. Use esse método para retirar o escape da string, se necessário.

Parâmetro

escapou

string

Uma string para retirar o escape
Retorna

string String sem escape

Tipo abstrato

ReceiverActionListener

estática

ReceiverActionListener()