StreamManager
Processa streams de Inserção de anúncios dinâmicos. Ele gerencia interações com o back-end da DAI e processa pings de rastreamento, bem como o stream de eventos e o encaminhamento de eventos de anúncios para o editor. Este gerenciador não herda do Basecado, já que não é um gerenciador de um anúncio específico, mas sim de todo o fluxo
Construtor
StreamManager
new StreamManager(videoElement, adUiElement, uiSettings)
Parâmetro |
|
---|---|
videoElement |
O elemento de vídeo HTML em que a reprodução ocorrerá. O valor não pode ser nulo. |
adUiElement |
Opcional O elemento HTML a ser usado para conter os elementos da interface do anúncio. Esse elemento precisa ter a mesma altura e largura que a reprodução de vídeo e deve se sobrepor diretamente a ele. Se não for fornecido, nenhuma interface será mostrada, e nenhum anúncio que precisa de interface, como os puláveis, será solicitado. O valor não pode ser nulo. |
uiSettings |
Opcional As configurações de interface a serem usadas para o stream. O valor não pode ser nulo. |
- Gera
-
quando os parâmetros de entrada não atendem aos requisitos.
Métodos
contentTimeForStreamTime
contentTimeForStreamTime(streamTime) retorna o número
Retorna o tempo do conteúdo sem anúncios em um determinado momento de transmissão. Retorna o tempo de transmissão especificado para transmissões ao vivo.
Parâmetro |
|
---|---|
streamTime |
number o tempo de transmissão com anúncios inseridos (em segundos). |
- Retorna
-
number
: o tempo do conteúdo correspondente ao tempo de stream determinado quando os anúncios são removidos.
foco
Foco()
Coloca o foco no botão "Pular", se houver. Se não estiverem presentes, o foco será colocado nos elementos interativos, incluindo ícones ou criativos interativos.
getAdSkippableState
getAdskipState() retorna booleano
Retorna "true" se o anúncio puder ser ignorado. Quando esse valor muda, o StreamManager
dispara um evento StreamEvent.SKIPPABLE_STATE_CHANGED
.
- Retorna
-
boolean
Verdadeiro se o anúncio puder ser ignorado. Caso contrário, será falso.
loadStreamMetadata
loadStreamMetadata()
Solicita que o SDK carregue os metadados do anúncio e, em seguida, transmite StreamEvent.LOADED. Ele precisará ser acionado manualmente assim que o manifesto de transmissão for recuperado do integrador de vídeos terceirizado. Isso é usado apenas para VOD de veiculação de pods com integrador de vídeos de terceiros e não opera para outras solicitações de stream.
onTimedMetadata
onTimedMetadata(metadata)
Cartões em um dicionário de metadados processados. O dicionário espera a chave "TXXX" com a string de metadados definida pelo usuário como o valor. Se o player fornecer metadados brutos, chame StreamManager.processMetadata.
Parâmetro |
|
---|---|
metadados |
Objeto O dicionário de metadados. O valor não pode ser nulo. |
previousCuePointForStreamTime
anteriorCuePointForStreamTime(streamTime) retorna CuePoint
Retorna o marcador anterior para o tempo de stream especificado. Retornará nulo se esse marcador não existir. Ele é usado para implementar recursos como ajuste e é chamado quando o editor detecta que o usuário buscou para retornar o usuário a um intervalo de anúncio.
Parâmetro |
|
---|---|
streamTime |
number o tempo de stream que foi buscado. |
- Retorna
-
nullable CuePoint
: o marcador anterior para o tempo de stream especificado.
processMetadata
processMetadata(type, data, timestamp)
Processa metadados com marcação de tempo 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 Tipo de metadados. Precisa ser "ID3" para HLS ou o URI do ID do esquema da mensagem de evento para DASH. |
dados |
(Uint8Array ou string não nulo) Dados brutos da tag. Para ID3, precisam ser todos os dados brutos da tag. Para mensagens de eventos DASH, é a string de dados da mensagem. |
carimbo de data/hora |
number Tempo em segundos em que os dados devem ser processados. Para DASH, é o horário de início da mensagem do evento. |
replaceAdTagParameters
replaceAdTagParameters(adTagParameters)
Substitui todos os parâmetros de tag de anúncio usados nas próximas solicitações de anúncios de 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. |
requestStream
requestStream(streamRequest)
Solicita um stream a ser carregado usando os parâmetros de stream fornecidos.
Parâmetro |
|
---|---|
streamRequest |
contém parâmetros para carregar os metadados do stream. O valor não pode ser nulo. |
redefina
reset()
Redefine o gerenciador de transmissão e remove qualquer pesquisa contínua.
setClickElement
setClickElement(clickElement)
Define o elemento de clique dos anúncios. Esse elemento é usado como o receptor de clique ou toque durante a reprodução de um anúncio e pode resultar na navegação para fora da página atual. O uso desse recurso foi descontinuado, e um adUiElement precisa ser transmitido para o StreamManager. Se um adUiElement for fornecido ao construtor do StreamManager, esse método se tornará um ambiente autônomo.
Parâmetro |
|
---|---|
clickElement |
Elemento O elemento usado como o anúncio de clique. O valor pode ser nulo. |
- Descontinuado
- Forneça um adUiElement ao construtor do StreamManager.
streamTimeForContentTime
streamTimeForContentTime(contentTime) retorna o número
Retorna o horário de stream com anúncios para um determinado tempo de conteúdo. Retorna o tempo de conteúdo especificado para transmissões ao vivo.
Parâmetro |
|
---|---|
contentTime |
number o tempo do conteúdo sem anúncios (em segundos). |
- Retorna
-
number
: o tempo de stream que corresponde ao tempo de conteúdo especificado quando os anúncios são inseridos.