Classe: StreamManager

StreamManager

class   public

Processa transmissões de inserção de anúncios dinâmicos. Ele gerencia interações com o back-end do DAI e processa pings de rastreamento, além de encaminhar eventos de stream e anúncios para o editor. Esse gerenciador não herda do BaseAdsManager, porque não é um gerenciador de um anúncio específico, mas de todo o fluxo.

Construtor

StreamManager

new StreamManager(videoElement, adUiElement, uiSettings)

Construtor.

Parâmetro
videoElement	O elemento de vídeo HTML em que a reprodução vai ocorrer. O valor não pode ser nulo.
adUiElement	Opcional O elemento HTML a ser usado para armazenar os elementos da interface do anúncio. Esse elemento precisa ter a mesma altura e largura da reprodução do vídeo e ser sobreposto a ele. Se não for fornecido, nenhuma interface será mostrada, e nenhum anúncio que exija interface, como anúncios puláveis, será solicitado.
uiSettings	Opcional As configurações da interface a serem usadas para essa transmissão. O valor não pode ser nulo.

Gera

quando os parâmetros de entrada não atendem aos requisitos.

Propriedades

clickElement

HTMLElement não nulo

clickElement

HTMLElement não nulo

streamMonitor

PodServingStreamMonitor não nulo

Métodos

addEventListener

addEventListener(type, listener) retorna void

Adiciona um listener para o tipo de evento fornecido.

Parâmetro
tipo	string O tipo de evento a ser detectado.
listener	function(non-null StreamEvent) Uma função chamada sempre que um evento desse tipo ocorre.

Retorna

void 

contentTimeForStreamTime

contentTimeForStreamTime(streamTime) retorna número

Retorna o tempo de conteúdo sem anúncios para um determinado tempo de transmissão. Retorna o tempo de transmissão fornecido para transmissões ao vivo.

Parâmetro
streamTime	número o tempo de transmissão com anúncios inseridos (em segundos).

Retorna

number o tempo de conteúdo que corresponde ao tempo de transmissão especificado após a remoção dos anúncios.

foco

focus() retorna nulo

Coloca o foco no botão "Pular", se ele estiver presente. Se não estiver presente, o foco será colocado em elementos interativos, incluindo ícones ou criativos interativos.

Retorna

void 

getAdSkippableState

getAdSkippableState() retorna booleano

Retorna "true" se o anúncio puder ser pulado no momento. Quando esse valor muda, StreamManager dispara um evento StreamEvent.SKIPPABLE_STATE_CHANGED.

Retorna

boolean Verdadeiro se o anúncio pode ser pulado no momento, falso caso contrário.

loadStreamMetadata

loadStreamMetadata() retorna nulo

Solicita que o SDK carregue os metadados do anúncio e transmite StreamEvent.LOADED. Isso precisa ser acionado manualmente depois que o manifesto do stream for recuperado do editor de vídeo de terceiros. Isso é usado apenas para VOD de veiculação de pods com editor de vídeo de terceiros e não é usado para outras solicitações de stream.

Retorna

void 

onTimedMetadata

onTimedMetadata(metadata) retorna void

Transmite um dicionário de metadados processados. O dicionário espera a chave "TXXX" com a string de metadados definida pelo usuário como valor. Se o player fornecer metadados brutos, chame StreamManager.processMetadata.

Parâmetro
metadados	(objeto nulo ou não nulo com propriedades de string) O dicionário de metadados.

Retorna

void 

previousCuePointForStreamTime

previousCuePointForStreamTime(streamTime) returns (null or CuePoint)

Retorna o ponto de inserção anterior para o tempo de transmissão especificado. Retorna nulo se nenhum ponto de referência existir. Ele é usado para implementar recursos como o retorno automático, e é chamado quando o editor detecta que o usuário procurou para retornar a um intervalo de anúncio.

Parâmetro
streamTime	número o tempo do stream que foi procurado.

Retorna

(null or non-null CuePoint) o ponto de referência anterior para o horário de transmissão especificado.

processMetadata

processMetadata(type, data, timestamp) retorna void

Processa metadados programados para transmissões ao vivo. Use se o player de vídeo fornecer metadados não analisados com carimbos de data/hora. Caso contrário, chame StreamManager.onTimedMetadata.

Parâmetro
tipo	string Digite os metadados. Precisa ser "ID3" para HLS ou o URI do esquema de ID da mensagem de evento para DASH.
dados	(string ou Uint8Array não nulo) Dados brutos da tag. Para ID3, precisa ser todos os dados brutos da tag. Para mensagens de eventos DASH, essa é a string de dados da mensagem.
timestamp	número Tempo em segundos em que os dados precisam ser processados. Para o DASH, é o horário de início da mensagem do evento.

Retorna

void 

removeEventListener

removeEventListener(type, listener) retorna void

Remove um listener para o tipo de evento fornecido. A função do listener precisa ser igual por referência à transmitida anteriormente para addEventListener.

Parâmetro
tipo	string O tipo de evento para o qual o listener será removido.
listener	function(non-null StreamEvent) A função a ser removida como um listener.

Retorna

void 

replaceAdTagParameters

replaceAdTagParameters(adTagParameters) retorna void

Substitui todos os parâmetros de tags de anúncio usados em solicitações de anúncios futuras para uma transmissão ao vivo.

Parâmetro
adTagParameters	Objeto com propriedades de string Os novos parâmetros da tag de anúncio. Precisa ter valores de string. O valor não pode ser nulo.

Retorna

void 

requestStream

requestStream(streamRequest) retorna void.

Solicita que um stream seja carregado usando os parâmetros fornecidos.

Parâmetro
streamRequest	StreamRequest contém parâmetros para carregar os metadados do stream. O valor não pode ser nulo.

Retorna

void 

redefinir

reset() retorna nulo

Redefine o gerenciador de transmissão e remove qualquer pesquisa contínua.

Retorna

void 

setClickElement

setClickElement(clickElement) retorna void

Define o elemento de clique nos anúncios. Esse elemento é usado como o receptor de clique ou toque enquanto um anúncio é reproduzido e pode resultar na navegação para fora da página atual. Isso foi descontinuado, e um adUiElement precisa ser transmitido ao StreamManager. Se um adUiElement for fornecido ao construtor StreamManager, esse método se tornará uma operação nula.

Parâmetro
clickElement	(elemento nulo ou não nulo) O elemento usado como clique no anúncio.

Descontinuado

Forneça um adUiElement ao construtor StreamManager.

Retorna

void 

streamTimeForContentTime

streamTimeForContentTime(contentTime) retorna um número

Retorna o tempo de transmissão com anúncios para um determinado conteúdo. Retorna o tempo de conteúdo especificado para transmissões ao vivo.

Parâmetro
contentTime	número o tempo do conteúdo sem anúncios (em segundos).

Retorna

number o tempo de transmissão que corresponde ao tempo de exibição do conteúdo após a inserção de anúncios.