logo

THEOplayer > AdsConfiguration

AdsConfiguration interface

Describes the configuration of advertisement.

Signature:

export interface AdsConfiguration 

Properties

Property

Type

Description

allowedMimeTypes (optional)

string[]

Allows configuring which mime types are allowed during ad playback.

googleIma (optional)

GoogleImaConfiguration

The Google IMA configuration.

preload (optional)

AdPreloadType

Whether media files of mid- and postrolls are preloaded.

showCountdown (optional)

boolean

Whether an advertisement duration countdown will be shown in the UI.

vpaidMode (optional)

VPAIDMode

The iframe policy for VPAID ads.

Property Details

allowedMimeTypes

Allows configuring which mime types are allowed during ad playback.

Signature:

allowedMimeTypes?: string[];

Remarks


- This feature is only available for Google IMA.
- If set to an array, all ads with another mime types will be ignored.
- If set to undefined the ad system will pick media based on the browser's capabilities.

googleIma

The Google IMA configuration.

Signature:

googleIma?: GoogleImaConfiguration;

preload

Whether media files of mid- and postrolls are preloaded.

Signature:

preload?: AdPreloadType;

Remarks


- This feature is only available for Google IMA.

showCountdown

Whether an advertisement duration countdown will be shown in the UI.

Signature:

showCountdown?: boolean;

Remarks


- Available since v2.22.9.
- This feature is only available for Google IMA.

vpaidMode

The iframe policy for VPAID ads.

Signature:

vpaidMode?: VPAIDMode;

Remarks


- This feature is only available for Google IMA and SpotX.

github
Make sure to follow us on GitHub!
THEO-logo-white
twitter
facebook
linkedin
Copyright © 2022. All Rights Reserved.
Leuven
New York
Singapore
Barcelona