cast. framework. breaks. BreakManager
Classe para gerenciar intervalos.
Métodos
addBreak
addBreak(breakData, breakClips, generalCastMediaStatus) retorna booleano.
Adiciona clipes dinâmicos de pausa e interrupção. Os clipes de intervalo vão ser associados à pausa (break.breakClipIds e break.duration serão atualizados de acordo com os clipes).
Parâmetro |
|
---|---|
breakData |
O valor não pode ser nulo. |
breakClips |
Matriz de cast.framework.messages.BreakClip não nulo O valor não pode ser nulo. |
broadCastMediaStatus |
Opcional boolean Define se o CAF deve verificar se o status de interrupção atual foi alterado. Isso pode não ser desejável antes do início da reprodução, já que o receptor ainda pode precisar adicionar mais intervalos (por exemplo, durante a conclusão do carregamento). |
- Retorna
-
boolean
Verdadeiro se o intervalo foi adicionado.
getBreakById
getBreakById(id) retorna cast.framework.messages.Break
Recebe a quebra de mídia atual por ID.
Parâmetro |
|
---|---|
id |
string ID da quebra. |
- Retorna
-
nullable cast.framework.messages.Break
getBreakClipById
getBreakClipById(id) returns cast.framework.messages.BreakClip
Recebe o clipe de intervalo de mídia atual por ID.
Parâmetro |
|
---|---|
id |
string ID do clipe. |
- Retorna
-
nullable cast.framework.messages.BreakClip
getBreakClipCurrentTimeSec
getBreakClipCurrentTimeSec() retorna o número
Retorna o tempo atual em segundos no clipe de intervalo em reprodução no momento.
- Retorna
-
nullable number
Tempo atual em segundos dentro do clipe de intervalo atual. Nulo, se o jogador não estiver reproduzindo o clipe de intervalo.
getBreakClipDurationSec
getBreakClipDurationSec() retorna o número
Retorna a duração em segundos do clipe de intervalo em reprodução no momento.
- Retorna
-
nullable number
Duração do clipe de intervalo atual. Nulo, se o player não estiver reproduzindo o clipe de intervalo.
getBreakClips
getBreakClips() retorna a matriz de cast.framework.messages.BreakClip não nulos.
Recebe os clipes de interrupção de mídia atuais.
- Retorna
-
non-null Array of non-null cast.framework.messages.BreakClip
getBreaks
getBreaks() retorna Matriz do valor não nulo cast.framework.messages.Break
Recebe as pausas de mídia atuais.
- Retorna
-
non-null Array of non-null cast.framework.messages.Break
getCreativeInfoByClipId
getCreativeInfoByClipId(breakClipId) retorna cast.framework.breaks.CreativeInformation
Recebe informações do criativo associadas ao breakclip por ID.
Parâmetro |
|
---|---|
breakClipId |
string ID do clipe. |
- Retorna
getPlayWatchedBreak
getPlayWatchedBreak() retorna um booleano.
Retorna verdadeiro se os intervalos assistidos precisarem ser reproduzidos.
- Retorna
-
boolean
removeBreakById
removeBreakById(breakId) retorna booleano
Remove um intervalo e os clipes de intervalo associados.
Parâmetro |
|
---|---|
breakId |
string ID de intervalo |
- Retorna
-
boolean
Verdadeiro se o intervalo foi removido.
setBreakClipLoadInterceptor
setBreakClipLoadInterceptor(interceptor)
Fornece um interceptador para permitir que o desenvolvedor insira mais clipes de interrupção ou modifique o clipe de interrupção atual antes do início de um intervalo.
Se o interceptador for "null", ele será redefinido para o padrão. Por padrão, a lógica de busca e análise do VAST no interceptador padrão. Portanto, se o interceptador personalizado for definido pelo desenvolvedor, a lógica VAST vai ser substituída, e os desenvolvedores precisarão implementar a própria lógica de busca e análise do VAST no interceptador fornecido.
Parâmetro |
|
---|---|
interceptador |
function(non-null cast.framework.messages.BreakClip, optional non-null cast.framework.breaks.BreakClipLoadInterceptorContext) O interceptador de carga de clipe de interrupção padrão vai retornar o mesmo clipe de intervalo como entrada. O valor pode ser nulo. |
setBreakSeekInterceptor
setBreakSeekInterceptor(seekInterceptor)
Fornece um interceptador para o desenvolvedor especificar quais intervalos eles querem jogar após a busca.
Parâmetro |
|
---|---|
seekInterceptor |
function(non-null cast.framework.breaks.BreakSeekData) Interceptor ou "null" se o desenvolvedor quiser redefini-lo para o padrão. O interceptador de busca de interrupção padrão vai retornar o intervalo mais próximo do valor de fetchTo. O valor pode ser nulo. |
setPlayWatchedBreak
setPlayWatchedBreak(playWatchedBreak)
Define uma sinalização para controlar se a pausa de agrupamento observada do cliente precisa ser reproduzida.
Parâmetro |
|
---|---|
playWatchedBreak |
boolean |
setVastTrackingInterceptor
setVastTrackingInterceptor(interceptor)
Fornece um interceptador para modificar o URL de rastreamento VAST antes de enviar ao servidor. A entrada do interceptador é uma string do URL de rastreamento. O interceptador pode retornar uma string modificada de URL ou uma promessa de string modificada de URL. O interceptador também poderá retornar "nulo" se você quiser enviar o URL de rastreamento pelo seu próprio código, e não pelo CAF.
Parâmetro |
|
---|---|
interceptador |
função(string) Um interceptador que modifica o URL antes de ser enviado. O valor pode ser nulo. |