THEOplayer > FreeWheelAdDescription

FreeWheelAdDescription interface

Inherits from AdDescription . See parent page for inherited properties and methods.

Describes a FreeWheel ad break request.

Signature:

export interface FreeWheelAdDescription extends AdDescription 

Remarks

- Available since v2.42.0.

Properties

Property	Type	Description
adServerUrl	string	The FreeWheel ad server URL.
assetDuration (optional)	number	The duration of the asset, in seconds.
assetId (optional)	string	The identifier of the asset.
cuePoints (optional)	FreeWheelCue[]	List of cue points.
customData (optional)	Record<string, string>	A record of query string parameters added to the FreeWheel ad break request. Each entry contains the parameter name with associated value.
integration	'freewheel'	The integration of this ad break.
networkId	number	The network identifier which is associated with a FreeWheel customer.
profile	string	The server side configuration profile.
siteSectionId (optional)	string	The identifier of the video player's location.

Property Details

adServerUrl

The FreeWheel ad server URL.

Signature:

adServerUrl: string;

assetDuration

The duration of the asset, in seconds.

Signature:

assetDuration?: number;

Remarks

- Optional for live assets.

assetId

The identifier of the asset.

Signature:

assetId?: string;

Remarks

- Generated by FreeWheel CMS when an asset is uploaded.

cuePoints

List of cue points.

Signature:

cuePoints?: FreeWheelCue[];

Remarks

- Not available in all FreeWheel modes.

customData

A record of query string parameters added to the FreeWheel ad break request. Each entry contains the parameter name with associated value.

Signature:

customData?: Record<string, string>;

integration

The integration of this ad break.

Signature:

integration: 'freewheel';

networkId

The network identifier which is associated with a FreeWheel customer.

Signature:

networkId: number;

profile

The server side configuration profile.

Signature:

profile: string;

Remarks

- Used to indicate desired player capabilities.

siteSectionId

The identifier of the video player's location.

Signature:

siteSectionId?: string;