AdPodInfo

public interface AdPodInfo

An ad may be part of a pod of ads. This object exposes metadata related to that pod, such as the number of ads in the pod and the ad position within the pod.

Public Method Summary

abstract int
getAdPosition()
Returns the position of the ad within the pod.
abstract double
getMaxDuration()
Returns the maximum duration of the pod in seconds.
abstract int
getPodIndex()
Client side: Returns the index of the ad pod.
abstract double
getTimeOffset()
Returns the content time offset at which the current ad pod was scheduled.
abstract int
getTotalAds()
Returns the total number of ads contained within this pod, including bumpers.
abstract boolean
isBumper()
Returns true if the ad is a bumper ad.

Public Methods

public abstract int getAdPosition ()

Returns the position of the ad within the pod. The value returned is one-based, i.e. 1 of 2, 2 of 2, etc. If the ad is not part of a pod, this will return 1.

public abstract double getMaxDuration ()

Returns the maximum duration of the pod in seconds. For unknown duration, -1 is returned.

public abstract int getPodIndex ()

Client side: Returns the index of the ad pod. 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: Always returns -1. DAI VOD: Returns the index of the ad pod. For a preroll pod, returns 0. For midrolls, returns 1, 2,...,N. For a postroll pod, returns N+1...N+X. Defaults to 0 if this ad is not part of a pod, or this pod is not part of a playlist.

public abstract double getTimeOffset ()

Returns the content time offset at which the current ad pod was scheduled. For preroll pod, 0 is returned. For midrolls, the scheduled time is returned in seconds. For postroll, -1 is returned. Defaults to 0 if this ad is not part of a pod, or the pod is not part of an ad playlist.

public abstract int getTotalAds ()

Returns the total number of ads contained within this pod, including bumpers. If the ad is not part of a pod, this will return 1.

public abstract boolean isBumper ()

Returns true if the ad is a bumper ad. If the ad is not part of a pod, this returns false.

Send feedback about...

IMA DAI SDK for Android
Need help? Visit our support page.