cast. framework. PlayerManager
Controla e monitora a reprodução de mídia.
- Gera
-
non-null ErrorSe o construtor for usado diretamente.PlayerManagersó 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) Um tipo de evento ou matriz de tipos de evento |
|
eventListener |
function(non-null cast.framework.events.Event) |
- Gera
-
non-null Errorse os argumentos fornecidos não forem válidos.
addSupportedMediaCommands
addSupportedMediaCommands(supportedMediaCommands, broadcastStatus)
Adiciona novos comandos compatíveis à lista atual de comandos de mídia compatíveis.
Parâmetro |
|
|---|---|
|
supportedMediaCommands |
número Uma máscara de bits de comandos de mídia compatíveis com o aplicativo. |
|
broadcastStatus |
Opcional booleano
|
- Consulte 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 booleano
|
|
requestId |
Opcional número O ID da solicitação de entrada que causou esta resposta. |
|
customData |
Opcional Objeto A mensagem de status contém dados personalizados específicos do aplicativo. O valor pode ser nulo. |
|
includeQueueItems |
Opcional booleano Indica se os itens da fila serão incluídos na mensagem de status. Por padrão, elas não são incluídas. |
getAbsoluteTimeForMediaTime
getAbsoluteTimeForMediaTime(mediaTime) retorna number
Converte o tempo da mídia em tempo absoluto da mídia. O tempo absoluto é aplicável apenas a transmissões ao vivo.
Parâmetro |
|
|---|---|
|
mediaTime |
número Hora de ver um filme. |
- Retorna
-
nullable numberTempo absoluto ounullse 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 número
Retorna o tempo atual do clipe de intervalo em reprodução, em segundos.
- Retorna
-
nullable numberTempo atual em segundos dentro do clipe de intervalo atual.nullquando oPlayernão está reproduzindo um clipe de intervalo.
getBreakClipDurationSec
getBreakClipDurationSec() retorna number
Retorna a duração do clipe de intervalo em reprodução no momento, em segundos.
- Retorna
-
nullable numberDuração do clipe do intervalo atual.nullquando oPlayernão está 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() returns Array of non-null cast.framework.messages.Break
Retorna uma lista de interrupções.
- Retorna
-
non-null Array of non-null cast.framework.messages.Break
getCurrentSupportedMediaCommands
getCurrentSupportedMediaCommands() retorna 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 compatível.
Esse método só pode ser chamado depois de chamar o receptor
CastReceiverContext#start. Caso contrário, ele vai retornar 0.
- Consulte também
- cast.framework.messages.Command
- Retorna
-
numberUma máscara de bits de comandos de mídia compatíveis com o aplicativo.
getCurrentTimeSec
getCurrentTimeSec() retorna número
Recebe o tempo de reprodução decorrido da mídia atual.
- Retorna
-
numberO tempo decorrido, em segundos. Esse valor será0se nenhuma mídia estiver sendo reproduzida.
getDurationSec
getDurationSec() retorna número
Recebe a duração da mídia em reprodução, em segundos.
- Retorna
-
numberDuração da mídia.NaNse não houver mídia tocando.
getLiveSeekableRange
getLiveSeekableRange() retorna cast.framework.messages.LiveSeekableRange
Retorna o intervalo pesquisável ao vivo com horários de início e término em segundos. Os valores são baseados no tempo de mídia.
- Retorna
getMediaInformation
getMediaInformation() retorna cast.framework.messages.MediaInformation
Recebe informações da mídia atual.
- Retorna
getMediaTimeForAbsoluteTime
getMediaTimeForAbsoluteTime(absoluteTime) retorna number
Converte o tempo absoluto da mídia em tempo da mídia. O tempo absoluto é aplicável apenas a transmissões ao vivo.
Parâmetro |
|
|---|---|
|
absoluteTime |
número O tempo absoluto da mídia, como tempo da época UNIX (segundos desde a época do Unix). |
- Retorna
-
nullable numberTempo de mídia ounullse 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 número
Retorna a velocidade de reprodução atual.
Retorna 1 antes de chamar o receptor CastReceiverContext#start.
- Retorna
-
numberTaxa de reprodução atual.
getPlayerState
getPlayerState() retorna cast.framework.messages.PlayerState
Recebe o estado do Player.
- Retorna
-
non-null cast.framework.messages.PlayerStateO estado doPlayeratual.
getPreferredPlaybackRate
getPreferredPlaybackRate() retorna número
Recebe a taxa de reprodução preferida. Pode ser usado no evento de desligamento para salvar a taxa de reprodução preferida mais recente no armazenamento permanente, para que possa ser usada na próxima sessão nas opções de transmissão.
- Retorna
-
number
getPreferredTextLanguage
getPreferredTextLanguage() retorna 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 número
Recebe o tempo de reprodução decorrido da mídia atual, sem subtrair o tempo do intervalo de anúncio.
- Retorna
-
numberO tempo decorrido, em segundos. Esse valor será0se nenhuma mídia estiver sendo reproduzida.
getRawSeekableRange
getRawSeekableRange() retorna cast.framework.messages.Range
Retorna o intervalo de busca de mídia atual.
OBSERVAÇÃO: isso corresponde às unidades de getRawCurrentTimeSec(), mas não de seek(). Isso não considera anúncios nem outros ajustes de mídia.
A menos que você tenha certeza de que precisa dos valores brutos, use
getLiveSeekableRange().
- Retorna
-
nullable cast.framework.messages.Range
getStartAbsoluteTime
getStartAbsoluteTime() retorna número
Recebe o horário de início absoluto da mídia como horário da época UNIX (segundos desde a época Unix). O tempo absoluto é aplicável apenas a transmissões ao vivo.
- Retorna
-
nullable number
getStats
getStats() retorna cast.framework.stats.Stats
Retorna estatísticas de reprodução. As estatísticas são agregadas em toda a sessão de reprodução, quando apropriado.
- Retorna
-
non-null cast.framework.stats.Stats
getSupportedMediaCommands
getSupportedMediaCommands() retorna number
Recebe comandos de mídia compatíveis com o receptor. Só deve ser chamado depois de CastReceiverContext#start(). Caso contrário, retorna 0. O valor dos comandos de mídia compatíveis é controlado apenas pelo aplicativo receptor .
Ele não é atualizado automaticamente com base em um MediaStatus.
- Consulte também
- cast.framework.messages.Command
- Retorna
-
numberUma máscara de bits 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 uma matriz de cast.framework.TimedMetadata não nulos.
Retorna metadados com carimbo de data/hora encontrados durante a análise do manifesto. Isso é
#EXT-X-DATERANGE em HLS e EventStream em DASH.
- Retorna
-
non-null Array of non-null cast.framework.TimedMetadata
autoinfligida
load(loadRequest) retorna Promise contendo void
Inicia uma solicitação para carregar mídia.
Parâmetro |
|
|---|---|
|
loadRequest |
cast.framework.messages.LoadRequestData Uma solicitação para carregar uma mídia. O valor não pode ser nulo. |
- Retorna
-
Promessa
non-null Promise containing voidque é resolvida quando a operação é bem-sucedida ou rejeitada em caso de falha.
pause
pause()
Pausa a mídia em reprodução.
reproduzir
play()
Reproduz a mídia pausada no momento.
removeEventListener
removeEventListener(eventType, eventListener)
Remove o listener de eventos adicionado para um determinado evento de reprodução. Se não houver um listener de eventos correspondente, essa 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) Um eventType ou uma matriz de tipos de evento |
|
eventListener |
function(non-null cast.framework.events.Event) |
removeSupportedMediaCommands
removeSupportedMediaCommands(supportedMediaCommands, broadcastStatus)
Remova comandos da lista de comandos de mídia compatíveis.
Parâmetro |
|
|---|---|
|
supportedMediaCommands |
número Uma máscara de bits de comandos de mídia compatíveis com o aplicativo. |
|
broadcastStatus |
Opcional booleano
|
- Consulte também
- cast.framework.messages.Command
procurar
seek(seekTime)
Procura na mídia atual.
Parâmetro |
|
|---|---|
|
seekTime |
número |
sendCustomState
sendCustomState(state)
Envia um estado personalizado de uma lógica de reprodução de aplicativo para a lógica da interface.
Esse método ajuda a separar a lógica de reprodução e a interface.
Manter a separação entre a lógica e a interface permite usar a mesma lógica de interface para reprodução local e controle remoto.
O estado personalizado enviado por esse método está disponível para a interface usando
PlayerData.
Parâmetro |
|
|---|---|
|
estado |
Objeto Objeto de estado personalizado. O valor não pode ser nulo. |
- Consulte também
- cast.framework.ui.PlayerData#customState
sendError
sendError(senderId, requestId, type, reason, customData)
Envia um erro para um remetente específico.
Parâmetro |
|
|---|---|
|
senderId |
string O ID do remetente. |
|
requestId |
número O ID da solicitação recebida que causou esse erro. |
|
tipo |
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 A mensagem de erro específica do aplicativo dados personalizados. O valor pode ser nulo. |
sendLocalMediaRequest
sendLocalMediaRequest(request)
Envia uma solicitação de mídia local.
Parâmetro |
|
|---|---|
|
solicitação |
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 |
número O ID da solicitação de entrada que causou esta resposta. |
|
includeMedia |
Opcional booleano
|
|
customData |
Opcional Objeto A mensagem de status contém dados personalizados específicos do aplicativo. O valor pode ser nulo. |
|
includeQueueItems |
Opcional booleano Indica se os itens da fila serão incluídos na mensagem de status. Por padrão, elas não são incluídas. |
setIdleReason
setIdleReason(idleReason)
Define o motivo de o player estar no estado IDLE.
Isso permite que aplicativos que querem forçar o estado IDLE
indiquem o motivo (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. Ele só é necessário
se o app precisar fazer com que o Player entre no estado IDLE em circunstâncias
especiais e o idleReason padrão não refletir o comportamento
pretendido.
Parâmetro |
|
|---|---|
|
idleReason |
cast.framework.messages.IdleReason O motivo de estar no estado O valor não pode ser nulo. |
setMediaElement
setMediaElement(mediaElement)
Define o HTMLMediaElement a ser usado. Se um Promise de um HTMLMediaElement for definido, a mídia começará a ser reproduzida depois que o Promise for resolvido.
Parâmetro |
|
|---|---|
|
mediaElement |
(HTMLMediaElement não nulo ou Promise não nula que contém HTMLMediaElement não nulo)
|
setMediaInformation
setMediaInformation(mediaInformation, opt_broadcast)
Define informações de mídia.
Parâmetro |
|
|---|---|
|
mediaInformation |
cast.framework.messages.MediaInformation O valor não pode ser nulo. |
|
opt_broadcast |
Opcional booleano |
setMediaPlaybackInfoHandler
setMediaPlaybackInfoHandler(handler)
Define um manipulador para retornar ou modificar cast.framework.PlaybackConfig,
para uma solicitação de carregamento específica. Os parâmetros do manipulador são o
LoadRequestData e o PlaybackConfig padrão para o receptor (fornecidos
no CastReceiverOptions). O manipulador precisa retornar uma configuração de
reprodução modificada ou null para impedir a reprodução da mídia. O valor de retorno também pode ser um Promise para permitir a espera de dados do servidor.
Parâmetro |
|
|---|---|
|
handler |
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 manipulador para retornar o URL da mídia para uma solicitação LOAD.
Esse manipulador 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 do conteúdo.
Parâmetro |
|
|---|---|
|
resolvedor |
function(non-null cast.framework.messages.LoadRequestData) Uma função para resolver o URL do conteúdo de mídia. O valor pode ser nulo. |
setMessageInterceptor
setMessageInterceptor(type, interceptor)
Define um interceptador de mensagens de entrada e saída.
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 interceptador PRELOAD separado, o interceptador LOAD será chamado para mensagens PRELOAD.
Parâmetro |
|
|---|---|
|
tipo |
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 compatíveis com o receptor.
Parâmetro |
|
|---|---|
|
supportedMediaCommands |
número Uma máscara de bits de comandos de mídia compatíveis com o aplicativo. |
|
broadcastStatus |
Opcional booleano
|
- Consulte também
- cast.framework.messages.Command
parar
stop()
Interrompe a mídia em reprodução.