Configuration data for the ads player

Properties

assetId:Null<String>

Identifies the video the ad request is being made for

breakTimeout:Null<Int>

If an ad break has no activity within this value in milliseconds, the ad playback will be stopped.

Default is 5000

fallbackId:Null<Int>

FreeWheel has a mechanism for failing over to back up ads

impressionTimeout:Null<Int>

If an ad impression is not detected within this value in milliseconds, the creative will be skipped.

Default is 5000

kvps:Null<Dynamic>

Extra metadata to send on ad requests

Note: Freewheel requires that values must be of type String. For example:

kvps: { _fw_ar : "your value", _fw_ae : "your value" }

muted:Null<Bool>

If ads should be muted

Default is false, unless user value persisted or content is forced to auto play

networkId:Null<Int>

FreeWheel assigned ID identifying the partner making the ad request

profile:Null<String>

Typically identifies the Turner brand making the ad request

section:Null<String>

Site Section ID (SSID), typically identifies the location on the site the ad request is coming from

serverBaseUrl:Null<String>

Ad server url

useNativeControls:Null<Bool>

If native controls should be used for the ads player

Default is false

volume:Null<ApiVolumeValue>

Ads volume, with values between 0 and 1

Default is 1, unless user value persisted