Interface AdCuePoints

  • This reference page follows the TypeScript documentation structure, with feedback encouraged via the IMA technical forum.

  • The cue point list outlines the schedule of ad breaks within the content timeline.

  • The getCuePoints method provides a list of time offsets indicating when ad breaks are scheduled.

  • Preroll and postroll ad breaks are denoted by special values: google.ima.AdCuePoints.PREROLL and google.ima.AdCuePoints.POSTROLL, respectively.

  • The getCuePoints method returns a number array that contains the time offsets at which ads are scheduled to be played.


The cue point list represents a time-schedule of ad breaks. Note that individual ads in the ad break are not included in the schedule.
Methods
getCuePoints
List of time offsets from the beginning of the content at which ad breaks are scheduled.

Methods


getCuePoints

getCuePoints(): number[]
List of time offsets from the beginning of the content at which ad breaks are scheduled. Preroll and postroll ad break times have special values. Preroll ad break offset value is represented by google.ima.AdCuePoints.PREROLL, postroll break by google.ima.AdCuePoints.POSTROLL.
Returns
number[] List of time offsets at which the ads are scheduled to play.