Classe: CastReceiverContext

cast.framework.CastReceiverContext

class   static

Gerencia o carregamento de bibliotecas e inicializa o SDK do receptor do Cast.

Gera

non-null Error Se o MediaElement não for criado no corpo do documento. Se vários elementos de mídia forem criados, o desenvolvedor precisará definir a classe "castMediaElement" como um deles, que será usado pelo receptor do CAF.

Métodos

getInstance

static

getInstance() retorna cast.framework.CastReceiverContext

Retorna a instância singleton CastReceiverContext.

Retorna

non-null cast.framework.CastReceiverContext 

addCustomMessageListener

addCustomMessageListener(namespace, listener)

Configura um listener de mensagens para um canal de mensagens personalizado. É permitido mais de um listener para um namespace.

Parâmetro

namespace

string

O namespace. Um namespace válido precisa ter o prefixo "urn:x-cast:".

listener

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

Error Se o sistema não estiver pronto ou o namespace não for compatível com este aplicativo.

addEventListener

addEventListener(type, handler)

Adicione um listener para transmitir eventos do sistema.

Parâmetro

tipo

cast.framework.system.EventType

O valor não pode ser nulo.

handler

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

canDisplayType

canDisplayType(mimeType, codecs, width, height, framerate) retorna booleano

Verifica se os parâmetros de mídia fornecidos de streams de vídeo ou áudio são compatíveis com a plataforma.

Parâmetro

mimeType

string

Tipo MIME de mídia. Ele consiste em um tipo e um subtipo separados por uma barra (/). Pode ser um tipo MIME de vídeo ou áudio.

codecs

Opcional

string

A string entre aspas contém uma lista separada por vírgulas de formatos, em que cada formato especifica um tipo de amostra de mídia presente no stream.

largura

Opcional

número

Descreve a resolução horizontal do stream em pixels.

altura

Opcional

número

Descreve a resolução vertical do stream em pixels.

framerate

Opcional

número

Descreve a taxa de frames do stream.
Retorna

boolean Se o stream pode ser reproduzido no Chromecast.

getApplicationData

getApplicationData() retorna cast.framework.system.ApplicationData

Fornece informações do aplicativo quando o sistema estiver pronto. Caso contrário, será nulo.

Retorna

nullable cast.framework.system.ApplicationData As informações do aplicativo ou nulo se o sistema não estiver pronto.

getDeviceCapabilities

getDeviceCapabilities() retorna cast.framework.system.DeviceCapabilitiesObj

Fornece informações sobre os recursos do dispositivo quando o sistema estiver pronto. Caso contrário, será nulo. Se um objeto vazio for retornado, o dispositivo não vai expor nenhuma informação de recursos.

Retorna

nullable cast.framework.system.DeviceCapabilitiesObj As informações de recursos do dispositivo (pares de chave-valor). Ele será nulo se o sistema ainda não estiver pronto. Pode ser um objeto vazio se a plataforma não expor nenhuma informação sobre os recursos do dispositivo.

getDeviceInformation

getDeviceInformation() retorna cast.framework.system.DeviceInformationObj

Fornece informações de identificação do dispositivo não relacionadas à capacidade quando o sistema estiver pronto. Caso contrário, será "null". Se um objeto vazio for retornado, o dispositivo não vai expor nenhuma informação desse tipo.

Retorna

nullable cast.framework.system.DeviceInformationObj As informações do dispositivo (pares de chave-valor). Ele será nulo se o sistema ainda não estiver pronto. Pode ser um objeto vazio se a plataforma não expor essas informações.

getPlayerManager

getPlayerManager() retorna cast.framework.PlayerManager

Receba uma instância do Player que pode controlar e monitorar a reprodução de mídia.

Retorna

non-null cast.framework.PlayerManager 

getSender

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

Receber um remetente pelo ID

Parâmetro

senderId

string

O ID do remetente a ser retornado.
Retorna

nullable cast.framework.system.Sender 

getSenders

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

Recebe uma lista de remetentes conectados no momento.

Retorna

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

getStandbyState

getStandbyState() retorna cast.framework.system.StandbyState

Informa se a entrada HDMI do aplicativo de transmissão está em espera.

Retorna

non-null cast.framework.system.StandbyState Se a entrada HDMI do aplicativo está em espera ou não. Se não for possível determinar, por exemplo,porque a TV não é compatível com comandos CEC, o valor retornado será UNKNOWN.

getSystemState

getSystemState() retorna cast.framework.system.SystemState

Fornece informações do aplicativo sobre o estado do sistema.

Retorna

non-null cast.framework.system.SystemState O estado do sistema.

getVisibilityState

getVisibilityState() retorna cast.framework.system.VisibilityState

Informa se o aplicativo de transmissão é a entrada HDMI ativa.

Retorna

non-null cast.framework.system.VisibilityState Define se o aplicativo é a entrada HDMI ativa. Se não for possível determinar, por exemplo,porque a TV não oferece suporte a comandos CEC, o valor retornado será UNKNOWN.

isSystemReady

isSystemReady() retorna um booleano

Quando o aplicativo chama start, o sistema envia o evento ready para indicar que as informações do aplicativo estão prontas e que ele pode enviar mensagens assim que houver um remetente conectado.

Retorna

boolean Se o sistema está pronto para processar mensagens.

loadPlayerLibraries

loadPlayerLibraries(useLegacyDashSupport)

Comece a carregar o JS do player. Isso pode ser usado para começar a carregar o código JS dos players no estágio inicial de inicialização do receptor antes de chamar start. Essa função não faz nada se os jogadores já tiverem sido carregados (start foi chamado).

Parâmetro

useLegacyDashSupport

Opcional

booleano

Indica que a MPL precisa ser usada para conteúdo DASH.

removeCustomMessageListener

removeCustomMessageListener(namespace, listener)

Remove um listener de mensagens registrado anteriormente com CastReceiverContext#addCustomMessageListener.

Parâmetro

namespace

string

O namespace. Um namespace válido precisa ter o prefixo "urn:x-cast:".

listener

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

A função de listener de mensagens para cancelar o registro.
Gera

Error Se o sistema não estiver pronto ou o namespace não for compatível com este aplicativo.

removeEventListener

removeEventListener(type, handler)

Remova o listener para transmitir eventos do sistema.

Parâmetro

tipo

cast.framework.system.EventType

O valor não pode ser nulo.

handler

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

sendCustomMessage

sendCustomMessage(namespace, senderId, data)

Envia uma mensagem para um remetente específico.

Parâmetro

namespace

string

O namespace. Um namespace válido precisa ter o prefixo "urn:x-cast:".

senderId

(string ou indefinido)

O senderId ou indefinido para transmissão a todos os remetentes.

dados

qualquer tipo

O payload da mensagem.

O valor não pode ser nulo.
Gera

Error Se houver um erro ao preparar a mensagem.

sendFeedbackMessage

sendFeedbackMessage(feedbackMessage)

Essa função precisa ser chamada em resposta ao evento feedbackstarted se o aplicativo adicionar informações de estado de depuração para registrar no relatório de feedback. Ele usa um parâmetro "message", que é uma string que representa as informações de depuração que o aplicativo quer registrar.

Parâmetro

feedbackMessage

string
Descontinuado
Use cast.framework.CastReceiverContext#setFeedbackHandler

setApplicationState

setApplicationState(statusText)

Define o estado do aplicativo. O aplicativo precisa chamar isso quando o estado mudar. Se não for definido ou for definido como uma string vazia, o valor do nome do aplicativo estabelecido durante o registro do aplicativo será usado para o estado do aplicativo por padrão.

Parâmetro

statusText

string

O texto do status.

setFeedbackHandler

setFeedbackHandler(feedbackHandler)

Defina um gerenciador para fornecer dados adicionais a um relatório de feedback. O gerenciador será chamado quando um feedback for criado e vai retornar dados extras como uma string ou uma promessa de string. A promessa de retorno precisa ser resolvida em até 5 segundos para ser incluída no relatório.

Parâmetro

feedbackHandler

function()

O valor pode ser nulo.

setInactivityTimeout

setInactivityTimeout(maxInactivity)

Define o tempo limite de inatividade do receptor. É recomendável definir o valor máximo de inatividade ao chamar Start e não alterá-lo. Essa API é fornecida apenas para fins de desenvolvimento/depuração.

Parâmetro

maxInactivity

número

Intervalo em segundos antes de fechar uma conexão que não responde.

setLoggerLevel

setLoggerLevel(level)

Define o nível de detalhamento do registro.

Parâmetro

level

cast.framework.LoggerLevel

O nível de registro.

O valor não pode ser nulo.

start

start(options) retorna cast.framework.CastReceiverContext

Inicializa o gerenciador do sistema e o gerenciador de mídia para que o app receptor possa receber solicitações dos remetentes.

Parâmetro

opções

(cast.framework.CastReceiverOptions não nulo ou objeto opcional não nulo)
Retorna

non-null cast.framework.CastReceiverContext 

parar

stop(closeReason)

Encerra o aplicativo receptor.

Parâmetro

closeReason

Opcional

cast.framework.common.CloseReason

O motivo opcional de encerramento que indica por que o aplicativo receptor está sendo interrompido. Se não for fornecido, o framework vai inferir o motivo com base em eventos recentes do player de mídia ou vai usar APP_REQUEST como substituto. Transmita um dos seguintes valores numéricos:

  • 13 (APP_CUSTOM_STOP): para ações de negócios/interface do receptor personalizado (por exemplo, o usuário clica em um botão "Sair" ou "Fechar" no app, navegação do receptor personalizado para fora da transmissão).
  • 15 (APP_ERROR): erros fatais no nível do aplicativo (por exemplo, falhas de autenticação personalizada, falhas de recuperação de DRM/licença, falhas de API de back-end) que acontecem fora dos eventos de erro do player integrado do CAF.
  • 14 (APP_PLAYBACK_FINISHED): o app consumiu a playlist/fila ou concluiu uma experiência de mídia independente.
  • 6 (APP_REQUEST): substituto genérico / legado quando um aplicativo solicita o encerramento sem um motivo mais específico.

O valor não pode ser nulo.