chrome.
Descreve o estado de um aplicativo do Google Cast em execução no momento. Normalmente, esses objetos não devem ser criados pelo cliente.
Construtor
Sessão
new Session(sessionId, appId, displayName, appImages, receiver)
Parâmetro |
|
|---|---|
|
sessionId |
string O identificador da sessão. |
|
appId |
string O identificador do aplicativo receptor. |
|
displayName |
string O nome de exibição do aplicativo. |
|
appImages |
Matriz de chrome.cast.Image não nulos Imagens associadas ao app. O valor não pode ser nulo. |
|
receptor |
O receptor que está executando o app. O valor não pode ser nulo. |
Propriedades
appId
string
O identificador do app de transmissão. Não serão mostrados.
appImages
não nulo Matriz de chrome.cast.Image não nulo
Matriz de imagens disponíveis que descrevem o aplicativo.
displayName
string
O nome legível do app Google Cast, por exemplo, "YouTube".
mídia
Matriz não nula de chrome.cast.media.Media não nulos
A mídia que pertence à sessão do Google Cast, incluindo as carregadas por outros remetentes.
namespaces
Matriz não nula de {nome: string}
Uma lista dos namespaces suportados pelo aplicativo receptor.
receptor
chrome.cast.Receiver não nulo
O receptor que está executando o aplicativo.
senderApps
não nulo Matriz de chrome.cast.SenderApplication não nulo
Os aplicativos emissores compatíveis com o aplicativo receptor. Pode ser usado para solicitar que o usuário instale ou acesse o app remetente.
sessionId
string
Identifica exclusivamente essa instância do aplicativo receptor.
reconhecimento
chrome.cast.SessionStatus não nulo
Status desta sessão de transmissão para o app receptor.
statusText
string anulável
Texto descritivo para o conteúdo atual do aplicativo, por exemplo, "Minha apresentação de slides do casamento".
transportId
string
Identificador que descreve de forma exclusiva a sessão para fins de transporte. Isso é interno ao canal de comunicação.
Métodos
addMediaListener
addMediaListener(listener)
Adiciona um listener que é invocado quando uma sessão de mídia é criada por outro remetente.
Parâmetro |
|
|---|---|
|
listener |
function(non-null chrome.cast.media.Media) O listener a ser adicionado. |
addMessageListener
addMessageListener(namespace, listener)
Adiciona um listener que é invocado quando uma mensagem é recebida do aplicativo receptor. O listener é invocado com o namespace como o primeiro argumento e a mensagem como o segundo.
Parâmetro |
|
|---|---|
|
namespace |
string O namespace a ser detectado, por exemplo, "urn:x-cast:com.example.namespace". |
|
listener |
função(string; string) O listener a ser adicionado. |
addUpdateListener
addUpdateListener(listener)
Adiciona um listener que é invocado quando a sessão é alterada. Mudanças nas seguintes propriedades acionarão o listener: statusText, namespaces, status e volume do receptor.
Os listeners precisam verificar a propriedade status da sessão para determinar o status da conexão. O parâmetro booleano isAlive foi descontinuado e substituído pela propriedade status
de sessão. O parâmetro isAlive ainda é transmitido para compatibilidade com versões anteriores e é verdadeiro, a menos que status =
chrome.cast.SessionStatus.STOPPED.
Parâmetro |
|
|---|---|
|
listener |
function(boolean) O listener a ser adicionado. |
getDialAppInfo
getDialAppInfo(successCallback, errorCallback)
Recebe as informações do app DIAL.
Parâmetro |
|
|---|---|
|
successCallback |
function(non-null chrome.cast.DialLaunchData) |
|
errorCallback |
function(non-null chrome.cast.Error) |
sair
sai(successCallback, errorCallback)
Sai (desconecta) do aplicativo receptor em execução associado à sessão.
Os clientes atuais no escopo definido pela AutoJoinPolicy deste cliente serão desconectados. Clientes futuros não vão ingressar automaticamente na sessão que foi encerrada.
Todos os clientes desconectados terão os listeners de atualização de sessão chamados
com isAlive = true. Os listeners precisam verificar a propriedade status da sessão para determinar o status da conexão, já que isAlive foi descontinuado. Nesse caso,
status = chrome.cast.SessionStatus.DISCONNECTED.
Parâmetro |
|
|---|---|
|
successCallback |
função() |
|
errorCallback |
function(non-null chrome.cast.Error) Os possíveis erros são TIMEOUT, API_NOT_INITIALIZED, CHANNEL_ERROR, SESSION_ERROR e EXTENSION_MISSING. |
loadMedia
loadMedia(loadRequest, successCallback, errorCallback)
Carrega mídia em um aplicativo receptor em execução.
Parâmetro |
|
|---|---|
|
loadRequest |
Solicitação para carregar mídia. O valor não pode ser nulo. |
|
successCallback |
function(non-null chrome.cast.media.Media) Invocado com a mídia carregada em caso de êxito. |
|
errorCallback |
function(non-null chrome.cast.Error) Invocado em caso de erro. Os erros possíveis são TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR e EXTENSION_MISSING. |
queueLoad
queueLoad(queueLoadRequest, successCallback, errorCallback)
Carrega e, opcionalmente, inicia a reprodução de uma nova fila de itens de mídia em um aplicativo receptor em execução.
Parâmetro |
|
|---|---|
|
queueLoadRequest |
chrome.cast.media.QueueLoadRequest Solicitação para carregar uma nova fila de itens de mídia. O valor não pode ser nulo. |
|
successCallback |
function(non-null chrome.cast.media.Media) Invocado com a mídia carregada em caso de êxito. |
|
errorCallback |
function(non-null chrome.cast.Error) Invocado em caso de erro. Os erros possíveis são TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR e EXTENSION_MISSING. |
- Descontinuado
- Use cast.framework.CastSession#loadMedia e forneça o chrome.cast.media.LoadRequest#queueData relevante.
removeMediaListener
removeMediaListener(listener)
Remove um listener que foi adicionado anteriormente com addMediaListener.
Parâmetro |
|
|---|---|
|
listener |
function(non-null chrome.cast.media.Media) O listener a ser removido. |
removeMessageListener
removeMessageListener(namespace, listener)
Remove um listener adicionado anteriormente para mensagens.
Parâmetro |
|
|---|---|
|
namespace |
string O namespace que é ouvido, por exemplo, "urn:x-cast:com.example.namespace". |
|
listener |
função(string; string) O listener a ser removido. |
removeUpdateListener
removeUpdateListener(listener)
Remove um listener adicionado anteriormente para esta sessão.
Parâmetro |
|
|---|---|
|
listener |
function(boolean) O listener a ser removido. |
sendMessage
sendMessage(namespace, message, successCallback, errorCallback)
Envia uma mensagem ao aplicativo receptor no namespace especificado. O sucessoCallback é invocado quando a mensagem é enviada ao canal de mensagens. A entrega ao aplicativo receptor é o melhor esforço e não é garantida.
Parâmetro |
|
|---|---|
|
namespace |
string O namespace para enviar a mensagem, por exemplo, "urn:x-cast:com.example.namespace". |
|
mensagem |
(non-null Object or string) |
|
successCallback |
função() Invocado quando a mensagem foi enviada. |
|
errorCallback |
function(non-null chrome.cast.Error) Invocado em caso de erro. Os erros possíveis são TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR e EXTENSION_MISSING. |
setReceiverMuted
setReceiverMuted(muted, successCallback, errorCallback)
Define o volume do receptor.
Parâmetro |
|
|---|---|
|
silenciado |
boolean O novo status de som desativado. |
|
successCallback |
função() |
|
errorCallback |
function(non-null chrome.cast.Error) Os possíveis erros são TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR e EXTENSION_MISSING. |
setReceiverVolumeLevel
setReceiverVolumeLevel(newLevel, successCallback, errorCallback)
Define o volume do receptor.
Parâmetro |
|
|---|---|
|
newLevel |
number O novo nível de volume entre 0,0 e 1,0. |
|
successCallback |
função() |
|
errorCallback |
function(non-null chrome.cast.Error) Os possíveis erros são TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR e EXTENSION_MISSING. |
escala
stop(successCallback, errorCallback)
Interrompe o aplicativo receptor em execução associado à sessão.
Parâmetro |
|
|---|---|
|
successCallback |
função() |
|
errorCallback |
function(non-null chrome.cast.Error) Os possíveis erros são TIMEOUT, API_NOT_INITIALIZED, CHANNEL_ERROR, SESSION_ERROR e EXTENSION_MISSING. |