Processa streams de inserção de anúncios dinâmicos. Essa classe gerencia interações com servidores da DAI,
processa pings de rastreamento e emite eventos de stream e de anúncio.
| Construtores | |
|---|---|
constructor
|
|
| Métodos | |
|---|---|
add
|
Adiciona um listener para o tipo de evento especificado. |
content
|
Retorna o tempo de conteúdo sem anúncios para um determinado tempo de stream. |
focus
|
Coloca o foco no botão "Pular", se ele estiver presente. |
get
|
Retorna um valor
true se o usuário puder pular o anúncio atual. |
load
|
Solicita que o SDK da DAI carregue metadados de anúncios e emita um evento de fluxo
LOADED.
|
on
|
Transmite um dicionário de metadados processados. |
previous
|
Retorna o ponto de sinalização anterior para o tempo de stream especificado. |
process
|
Processa metadados com carimbo de data/hora para streams. |
remove
|
Remove um listener para o tipo de evento StreamEvent especificado.
|
replace
|
Substitui todos os parâmetros de tags de anúncio usados em solicitações de anúncios futuros em uma transmissão ao vivo.
|
request
|
Solicita um stream para a DAI do IMA carregar usando os parâmetros de stream fornecidos.
|
reset
|
Redefine o gerenciador de streams e remove qualquer pesquisa contínua. |
stream
|
Retorna o tempo total de transmissão com anúncios para um determinado período de conteúdo. |
Construtores
constructor
new StreamManager(videoElement: HTMLVideoElement, adUiElement?: HTMLElement, uiSettings?: UiSettings): StreamManager
| Parâmetros | |
|---|---|
videoElement: HTMLVideoElement
|
O elemento de vídeo HTML em que a reprodução ocorre. |
|
O elemento em que a interface do anúncio é renderizada. |
|
As configurações da interface a serem usadas para essa transmissão. |
| Retorna | |
|---|---|
StreamManager
|
|
Métodos
addEventListener
addEventListener(type: Type | Type[], listener: ((event: StreamEvent) => void)): void
Adiciona um listener para o tipo de evento especificado.
| Parâmetros | |
|---|---|
type:
Type | Type[]
|
O tipo de evento de anúncio ou uma matriz de tipos de evento. |
listener: ((event: StreamEvent) => void)
|
Uma função de callback para o listener de anúncios. |
contentTimeForStreamTime
contentTimeForStreamTime(streamTime: number): number
Retorna o tempo de conteúdo sem anúncios para um determinado tempo de stream. Retorna o tempo de transmissão
especificado para transmissões ao vivo.
| Parâmetros | |
|---|---|
streamTime: number
|
o tempo de transmissão em segundos, combinando conteúdo e anúncios. |
| Retorna | |
|---|---|
number
|
o tempo de conteúdo para o tempo de stream especificado, sem incluir anúncios. |
foco
focus(): void
Coloca o foco no botão "Pular", se ele estiver presente. Se não estiver presente, o foco volta para
o elemento interativo.
getAdSkippableState
getAdSkippableState(): boolean
Retorna um valor
true se o usuário puder pular o anúncio atual. Quando esse valor muda, a classe StreamManager emite um evento de fluxo SKIPPABLE_STATE_CHANGED.
| Retorna | |
|---|---|
boolean
|
true se o usuário puder pular o anúncio atual ou false caso contrário.
|
loadStreamMetadata
loadStreamMetadata(): void
Solicita que o SDK da DAI carregue metadados de anúncios e emita um evento de fluxo
LOADED.
Chame esse método manualmente ao recuperar o manifesto de stream do seu combinador de vídeo de terceiros. Esse método é apenas para veiculação de VODs de pods com um integrador de vídeo de terceiros.
onTimedMetadata
onTimedMetadata(metadata: {
[key: string]: string;
}): void
Transmite um dicionário de metadados processados. O dicionário espera a chave exata
"TXXX" com a string de metadados definida pelo usuário como valor. Se o player fornecer metadados brutos, chame o método StreamManager.processMetadata.
| Parâmetros | |
|---|---|
metadata: {
|
O dicionário de metadados. |
previousCuePointForStreamTime
previousCuePointForStreamTime(streamTime: number): CuePoint
Retorna o ponto de sinalização anterior para o tempo de stream especificado. Se não houver um ponto de
referência anterior, vai retornar
null. Use esse método para implementar recursos como snapback
chamando o método quando o usuário tenta retornar a um intervalo de anúncio.
| Parâmetros | |
|---|---|
streamTime: number
|
o tempo de stream que o usuário procura. |
| Retorna | |
|---|---|
CuePoint
|
o ponto de sinalização anterior para o tempo de transmissão especificado. |
processMetadata
processMetadata(type: string, data: string | Uint8Array, timestamp: number): void
Processa metadados com carimbo de data/hora para streams. Use esse método se o player de vídeo fornecer metadados não analisados com carimbos de data/hora. Caso contrário, chame
StreamManager.onTimedMetadata.
| Parâmetros | |
|---|---|
type: string
|
Tipo para metadados. Precisa ser a string 'ID3' para HLS ou o URI do ID do esquema de mensagem de evento para DASH.
|
data: string | Uint8Array
|
Dados brutos de tag. Para ID3, precisa ser todos os dados brutos da tag. Para mensagens de eventos DASH, é a string de dados da mensagem. |
timestamp: number
|
Tempo em segundos para processar os dados. Para DASH, esse parâmetro é o horário de início da mensagem do evento. |
removeEventListener
removeEventListener(type: Type, listener: ((event: StreamEvent) => void)): void
Remove um listener para o tipo de evento
StreamEvent
especificado. Para remover um listener, o parâmetro transmitido a esse método precisa ser igual por referência ao que foi transmitido anteriormente ao método
addEventListener.
| Parâmetros | |
|---|---|
type:
Type
|
O tipo de evento para remover o listener. |
listener: ((event: StreamEvent) => void)
|
A função a ser removida como listener. |
replaceAdTagParameters
replaceAdTagParameters(adTagParameters: {
[key:
string]: string;
}): void
Substitui todos os parâmetros de tags de anúncio usados em solicitações de anúncios futuros em uma transmissão ao vivo.
| Parâmetros | |
|---|---|
adTagParameters: {
|
Os parâmetros de substituição da tag de anúncio. Precisa ter valores de string. |
requestStream
requestStream(streamRequest: StreamRequest): void
Solicita um stream para a DAI do IMA carregar usando os parâmetros de stream fornecidos.
| Parâmetros | |
|---|---|
streamRequest:
StreamRequest
|
contém parâmetros para carregar os metadados do stream. |
reset
reset(): void
Redefine o gerenciador de streams e remove qualquer pesquisa contínua.
streamTimeForContentTime
streamTimeForContentTime(contentTime: number): number
Retorna o tempo total de transmissão com anúncios para um determinado período de conteúdo. Retorna o tempo de conteúdo
especificado para transmissões ao vivo.
| Parâmetros | |
|---|---|
contentTime: number
|
o tempo de conteúdo sem anúncios em segundos. |
| Retorna | |
|---|---|
number
|
o tempo total de stream que corresponde ao tempo de conteúdo especificado depois que a DAI insere anúncios. |