cast. framework. PlayerManager
Controla e monitora a reprodução de mídia.
- Gera
-
non-null Error
Se o construtor for usado diretamente.PlayerManager
só pode ser acessado chamando cast.framework.CastReceiverContext#getPlayerManager.
Métodos
addEventListener
addEventListener(eventType, eventListener)
Adiciona um listener de eventos que detecta eventos de reprodução.
Parâmetro |
|
---|---|
eventType |
(cast.framework.events.EventType não nulo ou matriz não nula de cast.framework.events.EventType não nulo) Tipo de evento ou matriz de tipos de evento |
eventListener |
function(non-null cast.framework.events.Event) |
- Gera
-
non-null Error
Se os argumentos fornecidos não forem válidos.
addSupportedMediaCommands
addSupportedMediaCommands(supportedMediaCommands, broadcastStatus)
Adiciona novos comandos compatíveis à lista existente de comandos de mídia compatíveis.
Parâmetro |
|
---|---|
supportedMediaCommands |
number Um bitmask de comandos de mídia com suporte do aplicativo. |
broadcastStatus |
Opcional boolean
|
- Veja também
- cast.framework.messages.Command
broadcastStatus
broadcastStatus(includeMedia, requestId, customData, includeQueueItems)
Envia uma mensagem de status de mídia para todos os remetentes (transmissão). Os aplicativos usam isso para enviar uma mudança de estado personalizada.
Parâmetro |
|
---|---|
includeMedia |
Opcional boolean
|
requestId |
Opcional number O ID da solicitação recebida que causou essa resposta. |
customData |
Opcional Objeto Os dados personalizados específicos do aplicativo da mensagem de status. O valor pode ser nulo. |
includeQueueItems |
Opcional boolean Se itens da fila serão incluídos na mensagem de status. Por padrão, eles não são incluídos. |
getAbsoluteTimeForMediaTime
getAbsoluteTimeForMediaTime(mediaTime) retorna o número
Converte o tempo de mídia em tempo absoluto da mídia. O tempo absoluto é aplicável apenas a transmissões ao vivo.
Parâmetro |
|
---|---|
mediaTime |
number Tempo de mídia. |
- Retorna
-
nullable number
Tempo absoluto ounull
se não estiver disponível.
getAudioTracksManager
getAudioTracksManager() retorna cast.framework.AudioTracksManager.
Recebe a instância AudioTracksManager
.
- Retorna
-
non-null cast.framework.AudioTracksManager
getBreakClipCurrentTimeSec
getBreakClipCurrentTimeSec() retorna o número
Retorna o tempo atual, em segundos, do clipe de intervalo em reprodução no momento.
- Retorna
-
nullable number
Tempo atual em segundos dentro do clipe de intervalo atual.null
quando oPlayer
não está reproduzindo o clipe de intervalo.
getBreakClipDurationSec
getBreakClipDurationSec() retorna o número
Retorna a duração do clipe de intervalo em reprodução no momento em segundos.
- Retorna
-
nullable number
Duração do clipe de intervalo atual.null
quando oPlayer
não estiver reproduzindo um clipe de intervalo.
getBreakManager
getBreakManager() retorna cast.framework.breaks.BreakManager.
Recebe a instância BreakManager
.
- Retorna
-
non-null cast.framework.breaks.BreakManager
getBreaks
getBreaks() retorna Matriz do valor não nulo cast.framework.messages.Break
Retorna uma lista de quebras.
- Retorna
-
non-null Array of non-null cast.framework.messages.Break
getCurrentSupportedMediaCommands
getCurrentSupportedMediaCommands() retorna o número
Recebe os comandos de mídia compatíveis com o receptor atual.
Ao contrário de getSupportedMediaCommands()
, o valor retornado desse método
muda dinamicamente com base no status de reprodução atual. Por exemplo,
durante a reprodução de anúncios, o comando SEEK
pode não ser aceito.
Esse método só precisa ser chamado depois de chamar o receptor
CastReceiverContext#start
. Caso contrário, ele retornará 0
.
- Veja também
- cast.framework.messages.Command
- Retorna
-
number
Um bitmask de comandos de mídia compatíveis com o aplicativo.
getCurrentTimeSec
getCurrentTimeSec() retorna o número
Extrai o tempo de reprodução decorrido da mídia atual.
- Retorna
-
number
O tempo decorrido em segundos. Esse valor será0
se nenhuma mídia estiver tocando.
getDurationSec
getDurationSec() retorna o número
Recebe a duração, em segundos, da mídia que está sendo reproduzida no momento.
- Retorna
-
number
Duração da mídia.NaN
se não houver mídia tocando.
getLiveSeekableRange
getLiveSeekableRange() retorna cast.framework.messages.LiveSeekableRange.
Retorna o intervalo pesquisável em tempo real com horário de início e término em segundos. Os valores são baseados no tempo da mídia.
- Retorna
getMediaInformation
getMediaInformation() retorna cast.framework.messages.MediaInformation.
Extrai informações de mídia da mídia atual.
- Retorna
getMediaTimeForAbsoluteTime
getMediaTimeForAbsoluteTime(absoluteTime) retorna o número
Converte o tempo absoluto da mídia em tempo de mídia. O tempo absoluto é aplicável apenas a transmissões ao vivo.
Parâmetro |
|
---|---|
absoluteTime |
number O tempo absoluto da mídia, como a era UNIX (segundos desde a época do Unix). |
- Retorna
-
nullable number
Tempo de mídia ounull
se não estiver disponível.
getPlaybackConfig
getPlaybackConfig() retorna cast.framework.PlaybackConfig
Retorna a configuração de reprodução ou null
se os padrões não tiverem sido
substituídos.
- Retorna
-
nullable cast.framework.PlaybackConfig
getPlaybackRate
getPlaybackRate() retorna o número
Retorna a taxa de reprodução atual.
Retorna 1
antes que o receptor CastReceiverContext#start
seja chamado.
- Retorna
-
number
Taxa de reprodução atual.
getPlayerState
getPlayerState() retorna cast.framework.messages.PlayerState.
Recebe o estado Player
.
- Retorna
-
non-null cast.framework.messages.PlayerState
O estado doPlayer
atual.
getPreferredPlaybackRate
getPreferredPlaybackRate() retorna o número
Acessa a taxa de reprodução preferida. Pode ser usado no evento de encerramento para salvar a taxa de reprodução preferencial mais recente no armazenamento permanente. Assim, ela pode ser usada na próxima sessão nas opções de transmissão.
- Retorna
-
number
getPreferredTextLanguage
getPreferredTextLanguage() retorna a string
Recebe o idioma preferido da faixa de texto.
- Retorna
-
nullable string
getPreferredTextStyle
getPreferredTextStyle() retorna cast.framework.messages.TextTrackStyle.
Recebe o estilo de faixa de texto preferido.
- Retorna
getQueueManager
getQueueManager() returns (cast.framework.QueueManager or undefined)
Recebe a instância QueueManager
.
- Retorna
-
(non-null cast.framework.QueueManager or undefined)
getRawCurrentTimeSec
getRawCurrentTimeSec() retorna o número
Extrai o tempo de reprodução decorrido da mídia atual, sem subtrair o tempo do intervalo de anúncio.
- Retorna
-
number
O tempo decorrido em segundos. Esse valor será0
se nenhuma mídia estiver tocando.
getStartAbsoluteTime
getStartAbsoluteTime() retorna o número
Recebe o horário de início absoluto da mídia, como tempo da era UNIX (segundos desde a época do Unix). O tempo absoluto é aplicável apenas a transmissões ao vivo.
- Retorna
-
nullable number
getStats
getStats() returns cast.framework.stats.Stats
Retorna estatísticas de reprodução. As estatísticas são agregadas ao longo de toda a sessão de reprodução, quando apropriado.
- Retorna
-
non-null cast.framework.stats.Stats
getSupportedMediaCommands
getSupportedMediaCommands() retorna o número.
Recebe comandos de mídia compatíveis com o receptor. Só precisa ser chamado depois de chamar CastReceiverContext#start()
. Caso contrário, ele retorna 0
. O valor dos comandos de mídia compatíveis é controlado exclusivamente pelo aplicativo receptor .
Ele não é atualizado automaticamente com base em um MediaStatus
.
- Veja também
- cast.framework.messages.Command
- Retorna
-
number
Um bitmask de comandos de mídia compatíveis com o aplicativo.
getTextTracksManager
getTextTracksManager() retorna cast.framework.TextTracksManager.
Recebe a instância TextTracksManager
.
- Retorna
-
non-null cast.framework.TextTracksManager
getTimedMetadata
getTimedMetadata() retorna a matriz de cast.framework.TimedMetadata não nulos.
Retorna metadados com marcação de tempo encontrados durante a análise do manifesto. Ou seja, #EXT-X-DATERANGE
em HLS e EventStream
em DASH.
- Retorna
-
non-null Array of non-null cast.framework.TimedMetadata
load
load(loadRequest) retorna a promessa que contém um valor nulo
Inicia uma solicitação para carregar mídia.
Parâmetro |
|
---|---|
loadRequest |
cast.framework.messages.LoadRequestData Solicitação para carregar uma mídia. O valor não pode ser nulo. |
- Retorna
-
non-null Promise containing void
Promessa que é resolvida quando a operação é bem-sucedida ou rejeitada em caso de falha.
pausa
Função pause()
Pausa a mídia em reprodução no momento.
Reproduzir
Função play()
Reproduz a mídia pausada no momento.
removeEventListener
removeEventListener(eventType, eventListener)
Remove o listener de eventos adicionado a um determinado evento de reprodução. Se não houver nenhum listener de eventos correspondente, a chamada será ignorada.
Parâmetro |
|
---|---|
eventType |
(cast.framework.events.EventType não nulo ou matriz não nula de cast.framework.events.EventType não nulo) EventType ou matriz de tipos de evento |
eventListener |
function(non-null cast.framework.events.Event) |
removeSupportedMediaCommands
removeSupportedMediaCommands(supportedMediaCommands, broadcastStatus)
Remova os comandos da lista de comandos de mídia compatíveis.
Parâmetro |
|
---|---|
supportedMediaCommands |
number Um bitmask de comandos de mídia com suporte do aplicativo. |
broadcastStatus |
Opcional boolean
|
- Veja também
- cast.framework.messages.Command
procurar
fetch(seekTime)
Procura na mídia atual.
Parâmetro |
|
---|---|
seekTime |
number |
sendCustomState
sendCustomState(state)
Envia um estado personalizado de uma lógica de reprodução do app para a lógica da interface.
Esse método ajuda a ativar a separação da lógica de reprodução e da interface.
Manter a separação entre a lógica e a IU permite que se use a mesma
lógica da IU para a reprodução local e o controle remoto.
O estado personalizado enviado por esse método está disponível para a interface pelo
PlayerData
.
Parâmetro |
|
---|---|
state |
Objeto Objeto de estado personalizado. O valor não pode ser nulo. |
- Veja também
- cast.framework.ui.PlayerData#customState
sendError
sendError(senderId, requestId, type, reason, customData)
Envia um erro a um remetente específico.
Parâmetro |
|
---|---|
senderId |
string O ID do remetente. |
requestId |
number O ID da solicitação recebida que causou esse erro. |
digitar |
cast.framework.messages.ErrorType O tipo de erro. O valor não pode ser nulo. |
reason |
Opcional cast.framework.messages.ErrorReason O motivo do erro. O valor pode ser nulo. |
customData |
Opcional Objeto Os dados personalizados específicos do aplicativo da mensagem de erro. O valor pode ser nulo. |
sendLocalMediaRequest
sendLocalMediaRequest(request)
Envia uma solicitação de mídia local.
Parâmetro |
|
---|---|
request |
cast.framework.messages.RequestData O valor não pode ser nulo. |
sendStatus
sendStatus(senderId, requestId, includeMedia, customData, includeQueueItems)
Envia uma mensagem de status de mídia para um remetente específico.
Parâmetro |
|
---|---|
senderId |
string O ID do remetente. |
requestId |
number O ID da solicitação recebida que causou essa resposta. |
includeMedia |
Opcional boolean
|
customData |
Opcional Objeto Os dados personalizados específicos do aplicativo da mensagem de status. O valor pode ser nulo. |
includeQueueItems |
Opcional boolean Se itens da fila serão incluídos na mensagem de status. Por padrão, eles não são incluídos. |
setIdleReason
setIdleReason(idleReason)
Define o motivo pelo qual o player está no estado IDLE
.
Isso permite que os aplicativos que querem forçar o estado IDLE
indique o motivo disso (por exemplo, um erro personalizado).
O motivo da inatividade é enviado na próxima mensagem de status.
Observação: a maioria dos aplicativos não precisa definir esse valor. Ela só será necessária
se o app precisar fazer com que Player
vá para o estado IDLE
em circunstâncias
especiais e o initialReason padrão não reflita o
comportamento pretendido.
Parâmetro |
|
---|---|
idleReason |
cast.framework.messages.IdleReason O motivo para estar no estado O valor não pode ser nulo. |
setMediaElement
setMediaElement(mediaElement)
Define o HTMLMediaElement
a ser usado. Se um Promise
de
HTMLMediaElement
for definido, a mídia vai começar a reprodução depois que o Promise
for
resolvido.
Parâmetro |
|
---|---|
mediaElement |
(HTMLMediaElement não nulo ou promessa não nula contendo HTMLMediaElement não nulo)
|
setMediaInformation
setMediaInformation(mediaInformation, opt_broadcast)
Define as informações de mídia.
Parâmetro |
|
---|---|
mediaInformation |
cast.framework.messages.MediaInformation O valor não pode ser nulo. |
opt_broadcast |
Opcional boolean |
setMediaPlaybackInfoHandler
setMediaPlaybackInfoHandler(handler)
Define um gerenciador para retornar ou modificar cast.framework.PlaybackConfig,
para uma solicitação de carregamento específica. Os parâmetros do gerenciador são o LoadRequestData
e a PlaybackConfig
padrão do receptor (fornecidos no CastReceiverOptions
). O gerenciador precisa retornar uma configuração de reprodução modificada ou null
para evitar que a mídia seja reproduzida. O valor de retorno também pode ser um Promise
para permitir a espera de dados do servidor.
Parâmetro |
|
---|---|
gerenciador |
function(non-null cast.framework.messages.LoadRequestData, non-null cast.framework.PlaybackConfig) Uma função para fornecer uma configuração de reprodução específica da solicitação. O valor pode ser nulo. |
setMediaUrlResolver
setMediaUrlResolver(resolver)
Define um gerenciador para retornar o URL de mídia de uma solicitação LOAD
.
Esse gerenciador pode ser usado para evitar que o URL do conteúdo de mídia seja publicado como parte do status da mídia. Por padrão, a mídia contentId
é
usada como o URL de conteúdo.
Parâmetro |
|
---|---|
resolvedor |
function(non-null cast.framework.messages.LoadRequestData) Uma função para resolver URL de conteúdo de mídia. O valor pode ser nulo. |
setMessageInterceptor
setMessageInterceptor(type, interceptor)
Define um interceptador de mensagens recebidas e enviadas.
O interceptador pode atualizar os dados da solicitação e precisa retornar dados atualizados, um Promise
com dados atualizados (se os dados não puderem ser retornados
imediatamente) ou null
se a solicitação não puder ser processada.
Observação: se um interceptador de mensagens LOAD
for fornecido, mas nenhum outro
interceptador PRELOAD
for fornecido, o interceptador LOAD
será chamado
para mensagens PRELOAD
.
Parâmetro |
|
---|---|
digitar |
cast.framework.messages.MessageType O valor não pode ser nulo. |
interceptador |
function(non-null cast.framework.messages.RequestData) O valor pode ser nulo. |
setPlaybackConfig
setPlaybackConfig(playbackConfig)
Define a configuração de reprodução no PlayerManager
.
Parâmetro |
|
---|---|
playbackConfig |
O valor não pode ser nulo. |
setSupportedMediaCommands
setSupportedMediaCommands(supportedMediaCommands, broadcastStatus)
Define os comandos de mídia com suporte no receptor.
Parâmetro |
|
---|---|
supportedMediaCommands |
number Um bitmask de comandos de mídia com suporte do aplicativo. |
broadcastStatus |
Opcional boolean
|
- Veja também
- cast.framework.messages.Command
escala
Função stop()
Interrompe a mídia em reprodução no momento.