Classe ima
Métodos
Funções globais que controlam o SDK do IMA.
disableLogging()
Desativa a geração de registros do SDK. O registro fica ativado por padrão.
getStreamManager()
Retorna um gerenciador de stream, se disponível.
Se o gerenciador de transmissões ainda não estiver disponível, "Inválido" será retornado.
Se houver um erro ao criar o gerenciador de stream, um objeto de erro será
retornado.
Retorna object
:o gerenciador de stream ou o objeto de erro.
initSdk(settings)
Inicializa o SDK.
Parâmetro | Tipo | Descrição |
---|---|---|
settings |
object |
Objeto opcional de configurações do IMA. |
requestStream(streamRequest)
Inicia uma solicitação de stream assíncrona.
O controle retorna imediatamente ao player depois de chamar esse método.
Retorna object
: um erro ou "inválido" se não houver erro.
Parâmetro | Tipo | Descrição |
---|---|---|
streamRequest |
object |
Classe ima.AdBreakInfo
Campos
Métodos
Contém informações sobre um intervalo de anúncio. Transmitido aos callbacks de eventos pelo SDK.
Propriedades
Nome | Tipo | Descrição |
---|---|---|
adPosition |
|
O índice do anúncio no intervalo de anúncio. Será 1 para anúncios independentes. |
duration |
|
A duração máxima do intervalo em segundos, ou -1 se for desconhecida. |
podIndex |
|
Para transmissões ao vivo, sempre retorna -1. Para vídeo on demand (VOD), retorna o índice do conjunto de anúncios. Para um conjunto de anúncios precedentes, retorna 0. Para anúncios intermediários, retorna 1, 2, ..., n. Para um conjunto de anúncios finais, retorna n+1...n+x. O padrão será 0 se o anúncio não fizer parte de um conjunto ou se este conjunto não fizer parte de uma playlist. |
timeOffset |
|
É a posição do conjunto no conteúdo em segundos. Os anúncios precedentes retornam 0, os finais retornam -1 e os anúncios intermediários retornam o horário programado do conjunto. |
totalAds |
|
O número total de anúncios contidos neste intervalo. Será 1 para anúncios independentes. |
createAdBreakInfo()
Retorna ima.AdBreakInfo
:
Classe ima.AdEvent
Campos
Eventos acionados pelo gerenciador de anúncios.
Propriedades
Nome | Tipo | Descrição |
---|---|---|
AD_PERIOD_ENDED |
|
Disparado toda vez que a transmissão muda de publicidade ou barreira para conteúdo. Será acionado mesmo quando um anúncio for reproduzido uma segunda vez ou ao buscar um anúncio. |
AD_PERIOD_STARTED |
|
Disparado toda vez que a transmissão muda de conteúdo para publicidade ou barreira. Será acionado mesmo quando um anúncio for reproduzido uma segunda vez ou ao buscar um anúncio. |
COMPLETE |
|
Disparado quando a reprodução do anúncio é concluída. |
ERROR |
|
Disparado quando ocorre um erro. |
FIRST_QUARTILE |
|
Disparado quando o marcador do anúncio cruza o primeiro quartil. |
MIDPOINT |
|
Disparado quando o marcador do anúncio cruza o ponto médio. |
PROGRESS |
|
Disparado quando há uma atualização no progresso de um anúncio. |
SKIPPABLE_STATE_CHANGED |
|
Disparado quando o estado de um anúncio pulável muda. |
SKIPPED |
|
Disparado quando um anúncio é ignorado. |
START |
|
Disparado quando um anúncio começa a ser reproduzido. |
THIRD_QUARTILE |
|
Disparado quando o marcador do anúncio cruza o terceiro quartil. |
Classe ima.AdInfo
Campos
Métodos
Contém informações sobre um anúncio. Transmitido aos callbacks de eventos pelo SDK.
Propriedades
Nome | Tipo | Descrição |
---|---|---|
adBreakInfo |
|
Informações relacionadas a todo o intervalo em que o anúncio está. |
adDescription |
|
Descrição do anúncio. |
adId |
|
O ID do anúncio ou uma string vazia, se for desconhecida. |
adSystem |
|
O sistema de anúncios que fornece o criativo. |
adTitle |
|
O título do anúncio. |
advertiserName |
|
O nome do anunciante, conforme definido pela parte de veiculação. |
companions |
|
Os anúncios complementares especificados na resposta VAST. |
currentTime |
|
A hora atual de um anúncio em segundos ou -1, se for desconhecida. |
duration |
|
A duração deste anúncio único em segundos ou -1, se for desconhecida. |
universalAdIDRegistry |
|
Uma string usada para identificar o URL do site de registro em que o ID universal do anúncio do criativo selecionado é catalogado. |
universalAdIDValue |
|
O ID universal do anúncio do criativo selecionado para o anúncio. |
wrappers |
|
Uma matriz de ima.WrapperInfo com informações do wrapper para este anúncio. A ordem será do wrapper externo para o interno. |
createAdInfo()
Retorna ima.AdInfo
:
Classe ima.Companion
Campos
Métodos
Contém informações sobre complementares de um anúncio.
Propriedades
Nome | Tipo | Descrição |
---|---|---|
apiFramework |
|
A API necessária para executar este anúncio ou inválida, se indisponível. |
creativeType |
|
Representa o tipo de criativo, normalmente um tipo MIME. |
height |
|
A altura do complementar, em pixels. 0 se indisponível. |
trackingEvents |
|
Um mapa de eventos de rastreamento em que a chave é o evento e o valor é uma lista de URLs para dar ping nesse evento. |
url |
|
O URL do recurso estático desse complementar. |
width |
|
A largura do complementar em pixels. 0 se indisponível. |
createCompanion()
Retorna ima.Companion
:
Classe ima.CuePoint
Campos
Métodos
Contém informações sobre um ponto de inserção.
Propriedades
Nome | Tipo | Descrição |
---|---|---|
end |
|
É o horário de término de um marcador em segundos. Isso corresponde a um intervalo de anúncio. |
hasPlayed |
|
Um booleano indicando que o marcador já foi reproduzido. |
start |
|
É o horário de início de um marcador em segundos. Isso corresponde a um intervalo de anúncio. |
createCuePoint()
Retorna ima.CuePoint
:
Classe ima.Error
Campos
Métodos
Objeto transmitido para o gerenciador de erros caso haja um erro.
Propriedades
Nome | Tipo | Descrição |
---|---|---|
id |
|
ID do erro. Consulte a constante ErrorEvent para obter uma lista de códigos de erro. |
info |
|
Outras informações sobre o erro. |
type |
|
Sempre defina como erro para indicar o tipo desse objeto. |
createError()
Retorna ima.Error
:
Classe ima.ErrorEvent
Campos
Todos os erros que o SDK pode enviar de volta.
Propriedades
Nome | Tipo | Descrição |
---|---|---|
BAD_STREAM_REQUEST |
|
A solicitação de stream não foi preenchida corretamente. |
COULD_NOT_LOAD_STREAM |
|
Não foi possível carregar o stream. |
ERROR |
|
Um erro desconhecido. |
INVALID_RESPONSE |
|
A resposta do servidor não era válida. |
STREAM_API_KEY_NOT_VALID |
|
A chave de API fornecida não foi aceita pelo servidor. |
Classe ima.Player
Métodos
adBreakEnded(adBreakInfo)
Opcional. Chamado quando um intervalo de anúncio terminou.
Parâmetro | Tipo | Descrição |
---|---|---|
adBreakInfo |
ima.AdBreakInfo |
Contém informações sobre o intervalo de anúncio. |
adBreakStarted(adBreakInfo)
Opcional. Chamado quando um intervalo de anúncio é iniciado.
Parâmetro | Tipo | Descrição |
---|---|---|
adBreakInfo |
ima.AdBreakInfo |
Contém informações sobre o intervalo de anúncio. |
allVideoComplete()
Opcional. Chamado quando todo o vídeo é concluído.
createPlayer()
Cria um objeto Player
do IMA vazio. Implemente a
função loadUrl
para reproduzir anúncios. Outras funções são opcionais.
Retorna ima.Player
:
loadUrl(streamInfo)
Chamado quando o player deve começar a reproduzir um URL. Implemente
esse método para carregar o stream.
Parâmetro | Tipo | Descrição |
---|---|---|
streamInfo |
ima.StreamInfo |
Contém informações necessárias para reproduzir o conteúdo. |
Classe ima.StreamFormat
Campos
Define o formato do fluxo.
Propriedades
Nome | Tipo | Descrição |
---|---|---|
DASH |
|
|
HLS |
|
Classe ima.StreamInfo
Campos
Métodos
Informações transmitidas do SDK para o player sobre a transmissão.
Propriedades
Nome | Tipo | Descrição |
---|---|---|
format |
|
Formato do vídeo: hls ou travessão. Definido em ima.StreamFormat. |
manifest |
|
URL do stream. |
streamId |
|
Um código exclusivo para o fluxo. |
streamType |
|
O tipo de vídeo: ao vivo ou sob demanda. Definido em ima.StreamType. |
subtitles |
|
Legendas, se disponíveis. Caso contrário, será inválido. |
createStreamInfo()
Retorna ima.StreamInfo
:
Classe ima.StreamManager
Métodos
Objeto para gerenciar a reprodução da transmissão.
addEventListener(event, callback)
Adiciona um listener para o evento especificado. Consulte a constante AdEvents para
eventos suportados.
Parâmetro | Tipo | Descrição |
---|---|---|
event |
string |
|
callback |
function |
createStreamManager(streamRequest, streamInitResponse)
Retorna ima.StreamManager
:
Parâmetro | Tipo | Descrição |
---|---|---|
streamRequest |
ima.StreamRequest |
|
streamInitResponse |
ima.StreamInitResponse |
enableInteractiveAds()
Incompatível. Em vez disso, transmita os dados do anúncio complementar diretamente ao RAF.
Agora não há nenhuma operação.
getContentTime(streamTime)
Recebe um tempo em milissegundos para um stream de VOD, representando o tempo no
conteúdo sem anúncios.
Acesse: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq
Para ver o tempo do conteúdo do tempo de transmissão atual, passe -1.
Retorna Integer
: o horário do conteúdo correspondente ao tempo de transmissão especificado.
Parâmetro | Tipo | Descrição |
---|---|---|
streamTime |
Integer |
A hora no stream. |
getCuePoints()
Retorna todos os pontos de inserção correspondentes a todos os intervalos de anúncio. Isso só é
válido para conteúdo de vídeo on demand em que todos os intervalos de anúncio sejam conhecidos
com antecedência. Todos os horários representam o tempo de stream em segundos.
Retorna Object
: uma matriz com todos os pontos de inserção.
getPreviousCuePoint(time)
Retorna o ponto de inserção anterior a esse tempo. O ponto de inserção indica um intervalo
comercial. Todos os horários representam o tempo de stream em segundos.
Retorna ima.CuePoint
:um objeto com start, end e hasPlayed. Retorna "Inválido" se nenhum ponto de inserção está disponível.
Parâmetro | Tipo | Descrição |
---|---|---|
time |
Float |
O tempo para procurar, -1 indica o horário atual. |
getStreamTime(contentTime)
Recebe o tempo do stream de um tempo do conteúdo para VOD em milissegundos.
Acesse: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq
Retorna Integer
: o horário da transmissão correspondente ao horário do conteúdo especificado.
Parâmetro | Tipo | Descrição |
---|---|---|
contentTime |
Integer |
A hora do conteúdo. |
loadThirdPartyStream(streamManifest, streamSubtitle)
Carrega os metadados do anúncio e chama a função loadUrl
com os dados streamManifestUrl
e streamSubtitle
fornecidos. Esta função só funciona quando o tipo de solicitação de stream é
ima.StreamType.POD_VOD
.
Parâmetro | Tipo | Descrição |
---|---|---|
streamManifest |
string |
O URL do manifesto de stream com anúncios agrupados. |
streamSubtitle |
ifArray |
As legendas
associam à transmissão ou |
onMessage(msg)
Processa todas as mensagens provenientes do objeto de vídeo.
Precisa ser chamado para cada mensagem recebida na roMessagePort.
Parâmetro | Tipo | Descrição |
---|---|---|
msg |
object |
A mensagem da porta roVideo. |
replaceAdTagParameters(adTagParameters)
Substitui todos os parâmetros da tag de anúncio a serem usados nas próximas solicitações de anúncios de uma transmissão ao vivo. Essa chamada é um ambiente autônomo para transmissões de VOD.
Parâmetro | Tipo | Descrição |
---|---|---|
adTagParameters |
string |
Os novos parâmetros da tag de anúncio. |
start()
Inicia a reprodução da transmissão.
Classe ima.StreamRequest
Campos
Métodos
Usado para especificar as propriedades da solicitação de stream.
Propriedades
Nome | Tipo | Descrição |
---|---|---|
adTagParameters |
|
Opcional. É possível modificar um conjunto limitado de parâmetros de tags de anúncio na solicitação de stream. Para mais informações, consulte Fornecer parâmetros de segmentação ao fluxo. Também é possível usar os parâmetros dai-ot e dai-ov para preferência de variante de stream. Consulte Modificar os parâmetros de variantes do stream para mais informações. |
adUiNode |
|
Um nó do gráfico de cena em que a interface do anúncio é exibida. O IMA coloca elementos como os botões Por que esse anúncio? e Pular nesse elemento durante os anúncios. Ele precisa se sobrepor a todo o elemento de vídeo. |
apiKey |
|
Opcional. Essas chaves podem ser usadas para autenticar solicitações de stream. As chaves de autenticação da DAI precisam ser configuradas na interface do DFP. |
assetKey |
|
Obrigatório para transmissões ao vivo. Isso é usado para determinar qual transmissão deve ser reproduzida. A chave de recurso da solicitação de transmissão ao vivo é um identificador que pode ser encontrado na interface do DFP. |
authToken |
|
O token de autorização de solicitação de stream. Usada no lugar da chave de API para uma autorização de conteúdo mais rigorosa. O editor pode controlar autorizações de streams de conteúdo individual com base nesse token. |
contentSourceId |
|
Obrigatório para transmissões sob demanda. O cmsid vem da origem do conteúdo de vídeo do DFP na IU do DFP. |
customAssetKey |
|
A chave de recurso personalizado é usada para determinar qual transmissão deve ser reproduzida. As chaves de recursos personalizadas são necessárias para solicitações de stream de veiculação de conjuntos. |
format |
|
O formato do stream. O valor padrão é |
networkCode |
|
O código de rede do editor que fez a solicitação de stream. Os códigos de rede são necessários para solicitações de stream de veiculação por pod. |
player |
|
Uma implementação da interface do player. |
ppid |
|
Obsoleto. Usa adTagParameters. Opcional. Um identificador fornecido pelo editor do DFP Audience. |
streamActivityMonitorId |
|
O ID a ser usado para depurar o stream com o monitoramento de atividade de stream. Isso é usado para fornecer uma maneira conveniente de permitir que os editores encontrem um registro de stream na ferramenta de monitoramento da atividade de streaming. |
videoId |
|
Obrigatório para transmissões sob demanda. Identificador da origem do conteúdo em vídeo. |
videoObject |
|
O objeto de vídeo (como o Video roSGNode) responsável pela reprodução de vídeo no app cliente. Esse objeto vai ser pesquisado em busca de vários dados a serem usados no tempo adequado para eventos HLS ID3 ao vivo. |
createLiveStreamRequest(assetKey, apiKey)
Inicializa as propriedades obrigatórias de um StreamRequest
ativo. O uso
dessa API faz com que todas as outras propriedades específicas de StreamType
sejam
ignoradas.
Se algum parâmetro obrigatório for uma string vazia, a geração de registros de erros vai ocorrer e a API
vai retornar um StreamRequest
genérico, sem propriedades ignoradas.
Retorna ima.StreamRequest
: o objeto ima.StreamRequest
com
as propriedades ativas necessárias.
Parâmetro | Tipo | Descrição |
---|---|---|
assetKey |
string |
|
apiKey |
string |
Parâmetro opcional que será atribuído à propriedade |
createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)
Inicializa as propriedades necessárias de um ima.StreamRequest
do Pod Live.
O uso dessa API faz com que todas as outras propriedades específicas de ima.StreamType
sejam ignoradas.
Se algum parâmetro obrigatório for uma string vazia, a geração de registros de erros vai ocorrer e a API
vai retornar um StreamRequest
genérico, sem propriedades ignoradas.
Retorna StreamRequest
: o objeto ima.StreamRequest
com as propriedades
de PodLive obrigatórias.
Parâmetro | Tipo | Descrição |
---|---|---|
customAssetKey |
string |
|
networkCode |
string |
|
apiKey |
string |
Parâmetro opcional que será atribuído à propriedade |
createPodVodStreamRequest(networkCode)
Inicializa as propriedades necessárias de um ima.StreamRequest
para registrar um stream de VOD ao usar a veiculação do pod da DAI com um integrador de vídeos de terceiros. Essa função define o tipo de solicitação como ima.StreamType.POD_VOD
e valida todas as propriedades necessárias para dados ausentes. As validações com falha vão registrar um erro no console de
depuração.
Retorna StreamRequest
: um objeto ima.StreamRequest
. Se todas as propriedades obrigatórias forem especificadas, o tipo de solicitação será definido como ima.StreamType.POD_VOD
.
Parâmetro | Tipo | Descrição |
---|---|---|
networkCode |
string |
o código de rede do Google Ad Manager |
createStreamRequest()
Retorna ima.StreamRequest
: um objeto ima.StreamRequest
vazio.
createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken)
Inicializa as propriedades necessárias de um editor de vídeos ao vivo
StreamRequest
. O uso dessa API faz com que todas as outras
propriedades específicas de StreamType
sejam ignoradas.
Se algum parâmetro obrigatório for uma string vazia, a geração de registros de erros vai ocorrer e a API
vai retornar um StreamRequest
genérico, sem propriedades ignoradas.
Retorna ima.StreamRequest
: o objeto ima.StreamRequest
com
as propriedades necessárias de VideoStitcherLive.
Parâmetro | Tipo | Descrição |
---|---|---|
customAssetKey |
string |
|
networkCode |
string |
|
liveConfigId |
string |
|
region |
string |
|
projectNumber |
string |
|
oAuthToken |
string |
createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken)
Inicializa as propriedades necessárias de um StreamRequest
de editor de vídeo
VOD. O uso dessa API faz com que todas as outras
propriedades específicas de StreamType
sejam ignoradas.
Se algum parâmetro obrigatório for uma string vazia, a geração de registros de erros vai ocorrer e a API
vai retornar um StreamRequest
genérico, sem propriedades ignoradas.
Retorna ima.StreamRequest
: o objeto ima.StreamRequest
com
as propriedades necessárias de VideoStitcherVod.
Parâmetro | Tipo | Descrição |
---|---|---|
adTagUrl |
string |
|
networkCode |
string |
|
contentSourceUrl |
string |
|
region |
string |
|
projectNumber |
string |
|
oAuthToken |
string |
createVodStreamRequest(contentSourceId, videoId, apiKey)
Inicializa as propriedades obrigatórias de um ima.StreamRequest
de VOD. O uso
dessa API faz com que todas as outras propriedades específicas de ima.StreamType
sejam
ignoradas.
Se algum parâmetro obrigatório for uma string vazia, a geração de registros de erros vai ocorrer e a API
vai retornar um StreamRequest
genérico, sem propriedades ignoradas.
Retorna ima.StreamRequest
: o objeto ima.StreamRequest
com as propriedades de VOD obrigatórias.
Parâmetro | Tipo | Descrição |
---|---|---|
contentSourceId |
string |
|
videoId |
string |
|
apiKey |
string |
Parâmetro opcional que será atribuído à propriedade |
Classe ima.StreamType
Campos
Define o tipo de transmissão que o player é solicitado a reproduzir. Os anúncios precedentes e o VOD devem ser reproduzidos desde o início da transmissão.
Propriedades
Nome | Tipo | Descrição |
---|---|---|
LIVE |
|
O vídeo foi publicado. |
VOD |
|
O vídeo está on demand. |
Classe ima.WrapperInfo
Campos
Métodos
Contém informações sobre um wrapper.
Propriedades
Nome | Tipo | Descrição |
---|---|---|
adId |
|
O ID do anúncio ou uma string vazia, se for desconhecida. |
adSystem |
|
O nome declarado do sistema de anúncios ou uma string vazia, se for desconhecida. |
creativeAdId |
|
O ID do anúncio no criativo ou uma string vazia, se for desconhecida. |
creativeId |
|
O ID do criativo ou uma string vazia, se for desconhecida. |
dealId |
|
O ID da transação ou uma string vazia, se for desconhecido. |
createWrapperInfo()
Retorna ima.WrapperInfo
: