Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
StreamManager
classpublic
Processa transmissões de inserção de anúncios dinâmicos. Ele gerencia interações com o back-end do DAI e processa pings de rastreamento, além de encaminhar eventos de stream e
anúncios para o editor. Integração com a API CAF para a interface de anúncios.
Construtor
StreamManager
new
StreamManager(mediaElement)
Parâmetro
mediaElement
Opcional
O elemento de mídia HTML em que a reprodução vai ocorrer. Forneça apenas se estiver usando um player personalizado.
Gera
quando os parâmetros obrigatórios não são fornecidos.
Propriedade
streamMonitor
PodServingStreamMonitor não nulo
Métodos
addEventListener
addEventListener(type, listener) retorna void
Adiciona um listener para o tipo de evento fornecido.
Uma função chamada sempre que um evento desse tipo ocorre.
Retorna
void
getStreamId
getStreamId() retorna (null ou string)
Retorna o ID do stream atual.
Retorna
(null or string)
loadStreamMetadata
loadStreamMetadata() retorna nulo
Solicita que o SDK carregue os metadados do anúncio e transmite o StreamEvent.LOADED.
Isso precisa ser acionado manualmente depois que o manifesto do stream for recuperado
do editor de vídeo de terceiros. Isso é usado apenas para VOD de veiculação de pods com
editor de vídeo de terceiros e não é usado para outras solicitações de stream.
Retorna
void
removeEventListener
removeEventListener(type, listener) retorna void
Remove um listener para o tipo de evento fornecido. A função do listener precisa
ser igual por referência à transmitida anteriormente para addEventListener.
Parâmetro
tipo
string
O tipo de evento para o qual o listener será removido.
[null,null,["Última atualização 2025-08-21 UTC."],[[["\u003cp\u003eThe StreamManager class handles dynamic ad insertion streams, managing interactions with the DAI backend, tracking pings, and forwarding events.\u003c/p\u003e\n"],["\u003cp\u003eIt integrates with the CAF API for ad UI and requires a media element for playback only when using a custom player.\u003c/p\u003e\n"],["\u003cp\u003eKey methods include \u003ccode\u003egetStreamId\u003c/code\u003e, \u003ccode\u003eloadStreamMetadata\u003c/code\u003e, \u003ccode\u003ereplaceAdTagParameters\u003c/code\u003e, \u003ccode\u003erequestStream\u003c/code\u003e, and \u003ccode\u003ereset\u003c/code\u003e for stream management.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003erequestStream\u003c/code\u003e initiates stream loading using provided parameters, while \u003ccode\u003ereplaceAdTagParameters\u003c/code\u003e updates ad tag parameters for live streams.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003ereset\u003c/code\u003e halts the stream manager and any ongoing polling processes, ensuring a clean state.\u003c/p\u003e\n"]]],[],null,["# Class: StreamManager\n\nStreamManager\n=============\n\nclass public\n\nHandles dynamic ad insertion streams. It manages interactions with the\nDAI backend and handles tracking pings as well as forwarding stream and\nad events to the publisher. Integrates with the CAF API for ad UI.\n\nConstructor\n-----------\n\n### StreamManager\n\nnew\nStreamManager(mediaElement)\n\n| #### Parameter ||\n|--------------|---------------------------------------------------------------------------------------------------|\n| mediaElement | Optional The HTML media element where playback will occur. Only provide if using a custom player. |\n\nThrows\n\n: when required parameters are not supplied.\n\nProperty\n--------\n\n### streamMonitor\n\nnon-null PodServingStreamMonitor\n\nMethods\n-------\n\n### addEventListener\n\naddEventListener(type, listener) returns void\n\nAdds a listener for the given event type.\n\n| #### Parameter ||\n|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| type | string The type of event to listen for. |\n| listener | function(non-null [StreamEvent](/ad-manager/dynamic-ad-insertion/sdk/cast/reference/js/StreamEvent)) A function called each time an event of this type occurs. |\n\nReturns\n\n: `void`\n\n### getStreamId\n\ngetStreamId() returns (null or string)\n\nReturns the stream id for the current stream.\n\nReturns\n\n: `(null or string)`\n\n### loadStreamMetadata\n\nloadStreamMetadata() returns void\n\nRequests SDK to load ad metadata and then broadcasts StreamEvent.LOADED.\nThis should be manually trigger once the stream manifest has been retrieved\nfrom 3rd party video stitcher. This is only used for Pod Serving VOD with\n3rd party video stitcher, and is no-op for other stream request.\n\nReturns\n\n: `void`\n\n### removeEventListener\n\nremoveEventListener(type, listener) returns void\n\nRemoves a listener for the given event type. The listener function must\nbe equal by reference to the one previously passed to `addEventListener`.\n\n| #### Parameter ||\n|----------|--------------------------------------------------------------------------------------------------------------------------------------------|\n| type | string The type of event for which to remove the listener. |\n| listener | function(non-null [StreamEvent](/ad-manager/dynamic-ad-insertion/sdk/cast/reference/js/StreamEvent)) The function to remove as a listener. |\n\nReturns\n\n: `void`\n\n### replaceAdTagParameters\n\nreplaceAdTagParameters(adTagParameters) returns void\n\nReplaces all of the ad tag parameters used for upcoming ad requests for a\nlive stream.\n\n| #### Parameter ||\n|-----------------|-----------------------------------------------------------------------------------------------------------|\n| adTagParameters | Object with string properties The new ad tag parameters. Must have string values. Value must not be null. |\n\nReturns\n\n: `void`\n\n### requestStream\n\nrequestStream(loadRequest, streamRequest) returns Promise containing (null, non-null cast.framework.messages.LoadRequestData, or non-null cast.framework.messages.ErrorData)\n\nRequests a stream to be loaded using provided stream parameters. Populates\nthe loadRequest with the loaded stream data.\n\n| #### Parameter ||\n|---------------|---------------------------------------------------------------------------------------------------------------|\n| loadRequest | cast.framework.messages.LoadRequestData Value must not be null. |\n| streamRequest | [StreamRequest](/ad-manager/dynamic-ad-insertion/sdk/cast/reference/js/StreamRequest) Value must not be null. |\n\nReturns\n\n: `non-null Promise containing (null, non-null cast.framework.messages.LoadRequestData, or non-null cast.framework.messages.ErrorData)`\n\n### reset\n\nreset() returns void\n\nResets the stream manager and removes any continuous polling.\n\nReturns\n\n: `void`"]]
