Stay organized with collections
Save and categorize content based on your preferences.
AdPodInfo
classpublic
A class representing an ad pod info object during dynamic ad insertion.
Methods
getAdPosition
getAdPosition() returns number
Returns
number
getMaxDuration
getMaxDuration() returns number
Returns
number
getPodIndex
getPodIndex() returns number
Returns the index of the ad pod.
DAI VOD: For a preroll pod, returns 0. For midrolls, returns 1, 2,...,N.
For a postroll pod, returns -1. Defaults to 0 if this ad is not part of a
pod, or this pod is not part of a playlist.
DAI live stream: For a preroll pod, returns 0. For midrolls, returns the
break ID. Returns -2 if pod index cannot be determined (internal error).
[null,null,["Last updated 2025-08-20 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eAdPodInfo\u003c/code\u003e class provides information about ad pods during dynamic ad insertion.\u003c/p\u003e\n"],["\u003cp\u003eIt includes methods to access the ad position, maximum duration, pod index, time offset, and total number of ads within the pod.\u003c/p\u003e\n"]]],["The `AdPodInfo` class provides information about an ad pod during dynamic ad insertion. Key methods include: `getAdPosition`, which returns the ad's position within the pod; `getMaxDuration`, which returns the maximum duration of the pod; `getPodIndex`, which returns the index of the pod; `getTimeOffset`, returning the pod's time offset; and `getTotalAds`, which provides the total number of ads in the pod. Each method returns a numerical value.\n"],null,["# Class: AdPodInfo\n\nAdPodInfo\n=========\n\nclass public\n\nA class representing an ad pod info object during dynamic ad insertion.\n\nMethods\n-------\n\n### getAdPosition\n\ngetAdPosition() returns number\n\nReturns\n\n: `number`\n\n### getMaxDuration\n\ngetMaxDuration() returns number\n\nReturns\n\n: `number`\n\n### getPodIndex\n\ngetPodIndex() returns number\n\nReturns the index of the ad pod.\n\nDAI VOD: For a preroll pod, returns 0. For midrolls, returns 1, 2,...,N.\nFor a postroll pod, returns -1. Defaults to 0 if this ad is not part of a\npod, or this pod is not part of a playlist.\n\nDAI live stream: For a preroll pod, returns 0. For midrolls, returns the\nbreak ID. Returns -2 if pod index cannot be determined (internal error).\n\nReturns\n\n: `number`\n\n### getTimeOffset\n\ngetTimeOffset() returns number\n\nReturns\n\n: `number`\n\n### getTotalAds\n\ngetTotalAds() returns number\n\nReturns\n\n: `number`"]]
