Bitmovin-specific advertising module configuration
BitmovinAdBreak
Interface
Hierarchy
-
↳
BitmovinAdBreak
Properties
ads
• Optional ads: Ad[]
The ads scheduled for this AdBreak.
Inherited from
discardAfterPlayback
• Optional discardAfterPlayback: boolean
Specifies whether ad breaks are discarded after they are played back, played over or tried to be played back but
failed due to some condition.
When set to false, ad breaks are played again when seeking back to a previous ad break position and never
discarded in any of the above cases.
The flag will be ignored when ImaAdTagConfig.passthroughMode
is set to ImaPassthroughMode.VastAndVmap
Default is true.
Inherited from
AdBreakConfig.discardAfterPlayback
fallbackTags
• Optional fallbackTags: AdTag[]
Defines a list of fallback ad tags which will be tried one after the other if the original ad tag does not
provide a valid response. The fallback ad tags need to have the same AdTagType as the main tag.
Inherited from
id
• id: string
The id of the corresponding AdBreakConfig.
If the AdBreak was generated out of a VMAP tag, then the ID present in the
VMAP tag will be taken. If none is present in the VMAP tag, it will be generated.
Inherited from
linearAdUiConfig
• Optional linearAdUiConfig: LinearAdUiConfig
Holds relevant information for the advertising UI.
Inherited from
AdBreakConfig.linearAdUiConfig
persistent
• Optional persistent: boolean
If set, the ad tag will be processed and rescheduled automatically when a new source is loaded.
Inherited from
position
• position: string
Defines when the ad break shall be started. Default is 'pre'.
Allowed values are:
- 'pre': pre-roll ad
- 'post': post-roll ad
- fractional seconds: '10', '12.5' (mid-roll ad)
- percentage of the entire video duration: '25%', '50%' (mid-roll ad)
- timecode [hh:mm:ss.mmm]: '00:10:30.000', '01:00:00.000' (mid-roll ad)
Inherited from
preloadOffset
• Optional preloadOffset: number
Specifies how many seconds before the ad break would start playing should the ad tag (and if possible the media
files of the resulting ad response) start pre-loading.
Default is 0.
Inherited from
replaceContentDuration
• Optional replaceContentDuration: number
Specifies how many seconds the ad break(s) should replace of the main video content.
Inherited from
AdBreakConfig.replaceContentDuration
scheduleTime
• scheduleTime: number
The time in seconds in the media timeline the AdBreak is scheduled for.
Inherited from
tag
• tag: AdTag
Defines the url and type of the ad manifest. If the tag is a VAST or VPAID manifest, then more specific
scheduling options can be defined in the AdBreakConfig.
Inherited from
BitmovinAdData
Interface
Holds various additional ad data. Refer to ImaAdData or
BitmovinAdData for more information on what
additional data is available when using our Google IMA SDK implementation or our native VAST implementation.
Hierarchy
-
↳
BitmovinAdData
Properties
adDescription
• Optional adDescription: string
A longer description of the ad. Specified in InLine.Description in the VAST response.
Inherited from
adSystem
• Optional adSystem: AdSystem
The ad system that returned the ad. Specified in InLine.AdSystem in the VAST response.
Inherited from
adTitle
• Optional adTitle: string
A common name for the ad. Specified in InLine.AdTitle in the VAST response.
Inherited from
advertiser
• Optional advertiser: Advertiser
The advertiser as defined by the ad serving party. Specified in InLine.Advertiser in the VAST response.
Inherited from
apiFramework
• Optional apiFramework: string
Identifies the API needed to execute an interactive media file or communicate with the creative. Specified in
MediaFile.apiFramework for linear ads or NonLinear.apiFramework for non-linear ads in the VAST response.
Inherited from
bitrate
• Optional bitrate: number
The average bitrate of the progressive media file as defined in the VAST response.
Inherited from
codec
• Optional codec: string
The codec used to encode the file which can take values as specified by https://tools.ietf.org/html/rfc4281.
Specified in MediaFile.codec in the VAST response.
Inherited from
creative
• Optional creative: Creative
Contains various data about the Creative. Specified in InLine.Creative or Wrapper.Creative in the
VAST Response.
Inherited from
delivery
• Optional delivery: string
Either 'progressive' for progressive download protocols or 'streaming' for streaming protocols. Specified in
MediaFile.delivery in the VAST response.
Inherited from
maxBitrate
• Optional maxBitrate: number
The maximum bitrate of the streaming media file as defined in the VAST response.
Inherited from
mediaFileId
• Optional mediaFileId: string
The media file ID. Specified in MediaFile.id in the VAST response.
Inherited from
mimeType
• Optional mimeType: string
The MIME type of the media file or creative as defined in the VAST response.
Inherited from
minBitrate
• Optional minBitrate: number
The minimum bitrate of the streaming media file as defined in the VAST response.
Inherited from
minSuggestedDuration
• Optional minSuggestedDuration: number
The minimum suggested duration that the creative should be displayed. Specified in NonLinear.minSuggestedDuration
in the VAST response.
Inherited from
VastAdData.minSuggestedDuration
pricing
• Optional pricing: AdPricing
Used to provide a value that represents a price that can be used by real-time bidding (RTB) systems. Specified
in Inline.Pricing in the VAST response.
Inherited from
survey
• Optional survey: AdSurvey
URI to any resource relating to an integrated survey. Specified in InLine.Survey in the VAST response.
Inherited from
wrapperAdIds
• Optional wrapperAdIds: string[]
The IDs of the Wrapper ads, starting at the InLine ad and ending at the outermost Wrapper ad. Contains an
empty array if there are no Wrapper ads.
Inherited from
BitmovinAdvertisingConfig
Interface
Configuration used when the BitmovinModule is used for Advertising
Hierarchy
-
↳
BitmovinAdvertisingConfig
Properties
adBreaks
• Optional adBreaks: AdConfig[]
Defines a collection of ad breaks which will be played at the specified position in each AdBreakConfig.
Inherited from
adContainer
• Optional adContainer: () => HTMLElement
Defines a function which returns a container that is used for displaying ads.
Type declaration
▸ (): HTMLElement
Returns
HTMLElement
Inherited from
companionAdContainers
• Optional companionAdContainers: () => HTMLElement[]
Defines a function which returns an array of containers for the ad module to fill with companion ads.
Type declaration
▸ (): HTMLElement[]
Returns
HTMLElement[]
Inherited from
AdvertisingConfig.companionAdContainers
disableStorageApi
• Optional disableStorageApi: boolean
When set to true, the ad module will be prohibited from using the browser's localStorage.
Defaults to disableStorageApi, if present, and falls back to false.
Since: v8.91.0
Inherited from
AdvertisingConfig.disableStorageApi
onSelectAdQuality
• Optional onSelectAdQuality: (suggested: AdMediaFileQuality, available: AdMediaFileQuality[]) => AdMediaFileQuality
Receives quality that would be picked by player and list of all available
qualities and returns selected quality.
Type declaration
▸ (suggested, available): AdMediaFileQuality
Parameters
| Name | Type |
|---|---|
suggested | AdMediaFileQuality |
available | AdMediaFileQuality[] |
Returns
placeholders
• Optional placeholders: AdTagPlaceholders
List of placeholder strings that will be replaced in the ad manifest URL with the corresponding values.
Since: 8.1.0
Inherited from
AdvertisingConfig.placeholders
strategy
• Optional strategy: RestrictStrategy
Defines an object with two functions which will be called if an ad break is about to start or when ads are seeked
over. If this property is not set manually, then only the last ad that was seeked over will be played.
Inherited from
trackers
• Optional trackers: Trackers
Defines tracker configurations for the relevant packages such
as the Open measurement which will be loaded to provide
additional tracking information for ads.
Inherited from
videoLoadTimeout
• Optional videoLoadTimeout: number
Specifies the amount of milliseconds before the loading of an ad from a given ad manifest times out.
Default is 8000.
Inherited from
AdvertisingConfig.videoLoadTimeout
withCredentials
• Optional withCredentials: boolean
Specifies whether to send credentials such as cookies or authorization headers along with the ad requests. The
server needs to explicitly accept them for CORS requests, otherwise the request will fail.
Default is true.
Inherited from
AdvertisingConfig.withCredentials
BitmovinModuleErrorCode
Enum
Bitmovin advertising module error codes. These are in addition to the error codes found in
AdvertisingModuleErrorCode and VastErrorCode.