@videts/vide / vast / playPod
Function: playPod()
playPod(
player,ads,options):Promise<PodResult>
Defined in: vast/pod.ts:70
Play all ads in a pod sequentially. Individual failures or skips advance to the next ad.
Per VAST 3.3.1: when a pod ad fails, a stand-alone ad from standalonePool is substituted before moving to the next pod ad.
Parameters
| Parameter | Type | Description |
|---|---|---|
player | PluginPlayer | - |
ads | PlayableAd[] | - |
options | { adPlugins?: (ad) => AdPlugin[]; onFinish?: (result) => void; source: "vast" | "vmap"; standalonePool?: PlayableAd[]; } | - |
options.adPlugins? | (ad) => AdPlugin[] | - |
options.onFinish? | (result) => void | Called synchronously when the last ad in the pod finishes. |
options.source | "vast" | "vmap" | - |
options.standalonePool? | PlayableAd[] | Stand-alone ads available for substitution when a pod ad fails. Each ad is used at most once. |
Returns
Promise<PodResult>