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\u003e\u003ccode\u003eAdPodInfo\u003c/code\u003e provides details about ad pods during dynamic ad insertion, including position, maximum duration, and total ads.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003egetPodIndex()\u003c/code\u003e method returns the index of the ad pod, varying for pre-roll, mid-roll, and post-roll placements in VOD and live streams.\u003c/p\u003e\n"],["\u003cp\u003eOther methods within the \u003ccode\u003eAdPodInfo\u003c/code\u003e class allow access to the ad position within the pod, the maximum allowed duration for ads, and the time offset for ad insertion.\u003c/p\u003e\n"]]],["The `AdPodInfo` class provides information about ad pods in dynamic ad insertion. Key actions include retrieving: the ad's position within the pod (`getAdPosition`), the maximum duration of the pod (`getMaxDuration`), and the ad pod's index (`getPodIndex`). `getPodIndex` returns different values for VOD and live streams, indicating preroll, midroll, and postroll status. Additionally, the class allows access to the time offset (`getTimeOffset`) and the total number of ads in the pod (`getTotalAds`).\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`"]]
