ScheduleAdOptions | Bitmovin Player API 7.8.21

Options for scheduling an ad through PlayerAPI.scheduleAd.

Hierarchy

ScheduleAdOptions

Index

Properties

Optional adMessage

adMessage: string

Defines a custom message that will be displayed to the user instead of the progress bar during ad playback.

Has the placeholders '{remainingTime[formatString]}', '{playedTime[formatString]}' and '{adDuration[formatString]}', which are replaced by the remaining time until the ad can be skipped, the current time or the ad duration. The format string is optional. If not specified, the placeholder is replaced by the time in seconds. If specified, it must be of the following format:

%d - Inserts the time as an integer.
%0Nd - Inserts the time as an integer with leading zeroes, if the length of the time string is smaller than N.
%f - Inserts the time as a float.
%0Nf - Inserts the time as a float with leading zeroes.
%.Mf - Inserts the time as a float with M decimal places. Can be combined with %0Nf, e.g. %04.2f (the time 10.123 would be printed as 0010.12).
%hh:mm:ss
%mm:ss

Optional persistent

persistent: boolean

If set, the ad will be rescheduled automatically when a new source is loaded.

Optional skipMessage

skipMessage: SkipMessage

The message that is displayed on the 'skip ad' button.

Optional skipOffset

skipOffset: number

Specifies the time in seconds until the ad can be skipped. If set, overwrites the skip offset specified in the ad manifest (VAST and VPAID, not IMA)

Optional timeOffset

timeOffset: any

The offset for the ad, may be 'pre', 'post', seconds, percent, or a string in the format hh:mm:ss