Classe: StreamRequest

ima.StreamRequest

class   static

Construtor

StreamRequest

novo StreamRequest()

Usado para especificar propriedades da solicitação de stream.

Propriedades

adTagParameters

static

String

Opcional. Você pode substituir um conjunto limitado de parâmetros da tag de anúncio na sua solicitação de fluxo. Fornecer parâmetros de direcionamento para seu fluxo fornece mais informações. Você também pode usar os parâmetros dai-ot e dai-ov para preferência de variante de fluxo. Consulte Substituir parâmetros de variante de fluxo para obter mais informações.

adUiNode

static

roSGNode

Um nó do grafo de cena onde a interface do usuário do anúncio é exibida. IMA coloca elementos como botões Por que este anúncio e Pular neste elemento durante os anúncios. O elemento deve sobrepor-se completamente ao elemento de vídeo.

apiKey

static

String

Opcional. Essas chaves podem ser usadas para autenticar solicitações de fluxo. As chaves de autenticação DAI devem ser configuradas na interface do usuário do DFP.

assetKey

static

String

Necessário para transmissões ao vivo. Isso é usado para determinar qual stream 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

static

String

O token de autorização da solicitação de transmissão. Utilizado em substituição da chave de API para uma autorização de conteúdo mais rigorosa. O editor pode controlar as autorizações de fluxos de conteúdo individuais com base nesse token.

contentSourceId

static

String

Obrigatório para transmissões sob demanda. O cmsid vem da origem de conteúdo de vídeo do DFP na interface do DFP.

customAssetKey

static

String

A chave de recurso personalizada é usada para determinar qual fluxo deve ser reproduzido. São necessárias chaves de recursos personalizadas para que o pod atenda às solicitações de fluxo.

formato

static

ima.StreamFormat

O formato da transmissão. O valor padrão é ima.StreamFormat.HLS.

networkCode

static

String

O código de rede do editor que está fazendo a solicitação de fluxo. Os códigos de rede são necessários para que o Pod atenda às solicitações de transmissão feitas com createPodLiveStreamRequest ou createPodVodStreamRequest. Esses códigos também são necessários para solicitações de transmissão em nuvem feitas com createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest ou createVideoStitcherVodStreamRequestWithVodConfig. Esses códigos são opcionais e recomendados para solicitações de transmissão de serviço completo feitas com createLiveStreamRequest ou createVodStreamRequest. A adição do código de rede aplica as configurações selecionadas na interface do Ad Manager, como a ativação de anúncios programáticos limitados. Para o serviço de Pods e a integração com a nuvem, a adição do código de rede localiza e reproduz o fluxo de dados. Para encontrar o código de rede, consulte este artigo.

jogador

static

(ima.Player ou inválido)

Uma implementação da interface do jogador.

ppid

static

String

Obsoleto. Use adTagParameters. Opcional. Um identificador fornecido pelo editor DFP Audience .

streamActivityMonitorId

static

String

O ID a ser usado para depurar o fluxo com o monitor de atividade do fluxo. Isso é usado para fornecer uma maneira conveniente para os editores encontrarem um registro de fluxo na ferramenta de monitoramento de atividades de fluxo.

videoId

static

String

Necessário para transmissões sob demanda. Identificador da fonte do conteúdo de vídeo.

videoObject

static

(roVideo ou inválido)

O objeto de vídeo (como o roSGNode de vídeo) responsável pela reprodução de vídeo no aplicativo cliente. Este objeto será consultado para obter diversos dados que serão usados no sincronismo correto de eventos ID3 do Live HLS.

videoStitcherSessionOptions

static

Conjunto de V

As opções de sessão são usadas para definir parâmetros específicos do VideoStitcher para solicitações de fluxo (streamRequests).

Métodos

createLiveStreamRequest

static

createLiveStreamRequest(assetKey, apiKey, networkCode) retorna ima.StreamRequest

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, o registro de erros vai ocorrer e a API vai retornar um StreamRequest genérico, sem propriedades ignoradas.

Parâmetro
assetKey	string
apiKey	string Parâmetro atribuído à propriedade ima.StreamRequest.apiKey do ima.StreamRequest retornado. Caso não exista uma chave de API, passe uma string vazia.
networkCode	string Código de rede do publisher que faz a solicitação de stream. Incluir o código de rede é opcional, mas recomendado.

Retorna

ima.StreamRequest ima.StreamRequest objeto com propriedades Live necessárias.

createPodLiveStreamRequest

static

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey) returns StreamRequest

Inicializa as propriedades obrigatórias de um ima.StreamRequest do Pod Live. O uso dessa API faz com que outras propriedades específicas de ima.StreamType sejam ignoradas. Se algum parâmetro obrigatório for uma string vazia, o registro de erros vai ocorrer e a API vai retornar um StreamRequest genérico, sem propriedades ignoradas.

Parâmetro
customAssetKey	string
networkCode	string
apiKey	string Parâmetro opcional atribuído à propriedade ima.StreamRequest.apiKey do ima.StreamRequest retornado; o padrão é uma string vazia.

Retorna

StreamRequest ima.StreamRequest objeto com propriedades PodLive necessárias.

createPodVodStreamRequest

static

createPodVodStreamRequest(networkCode) retorna StreamRequest

Inicializa as propriedades necessárias de um ima.StreamRequest para registrar um fluxo VOD ao usar o serviço DAI Pod com um editor de vídeo de terceiros. Esta 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 registrarão um erro no console de depuração.

Parâmetro
networkCode	string o código de rede do Google Ad Manager

Retorna

StreamRequest um objeto ima.StreamRequest. Se todas as propriedades necessárias forem especificadas, o tipo de solicitação será definido como ima.StreamType.POD_VOD.

createStreamRequest

static

createStreamRequest() retorna ima.StreamRequest

Retorna

ima.StreamRequest Um objeto ima.StreamRequest vazio.

createVideoStitcherLiveStreamRequest

static

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken) retorna ima.StreamRequest

Inicializa as propriedades necessárias de um Video Stitcher Live StreamRequest. O uso desta API faz com que quaisquer outras propriedades específicas de StreamType sejam ignoradas. Se algum parâmetro obrigatório for uma string vazia, ocorrerá um registro de erro e a API retornará um valor genérico StreamRequest, sem que nenhuma propriedade seja ignorada.

Parâmetro
customAssetKey	string
networkCode	string
liveConfigId	string
região	string
projectNumber	string
oAuthToken	string

Retorna

ima.StreamRequest ima.StreamRequest objeto com as propriedades VideoStitcherLive necessárias.

createVideoStitcherVodStreamRequest

static

createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken) retorna ima.StreamRequest

Inicializa as propriedades obrigatórias de um StreamRequest de VOD do Video Stitcher. 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, o registro de erros vai ocorrer e a API vai retornar um StreamRequest genérico, sem propriedades ignoradas.

Parâmetro
adTagUrl	string
networkCode	string
contentSourceUrl	string
região	string
projectNumber	string
oAuthToken	string

Retorna

Objeto ima.StreamRequest ima.StreamRequest com propriedades VideoStitcherVod obrigatórias.

createVideoStitcherVodStreamRequestWithVodConfig

static

createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken) retorna ima.StreamRequest

Inicializa as propriedades necessárias de um Video Stitcher VOD StreamRequest usando vodConfigId criado a partir do Cloud Video Stitcher. O uso desta API faz com que quaisquer outras propriedades específicas de StreamType sejam ignoradas. Se algum parâmetro obrigatório for uma string vazia, ocorrerá um registro de erro e a API retornará um valor genérico StreamRequest, sem que nenhuma propriedade seja ignorada.

Parâmetro
vodConfigId	string
networkCode	string
região	string
projectNumber	string
oAuthToken	string

Retorna

Objeto ima.StreamRequest ima.StreamRequest com propriedades VideoStitcherVod obrigatórias.

createVodStreamRequest

static

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode) returns ima.StreamRequest

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, o registro de erros vai ocorrer e a API vai retornar um StreamRequest genérico, sem propriedades ignoradas.

Parâmetro
contentSourceId	string
videoId	string
apiKey	string Parâmetro atribuído à propriedade ima.StreamRequest.apiKey do ima.StreamRequest retornado. Caso não exista uma chave de API, passe uma string vazia.
networkCode	string Código de rede do publisher que faz a solicitação de stream. Incluir o código de rede é opcional, mas recomendado.

Retorna

ima.StreamRequest ima.StreamRequest objeto com propriedades VOD necessárias.