Interface UplynkPingConfiguration

Describes the configuration of Uplynk Ping features.

interface UplynkPingConfiguration {
    adImpressions?: boolean;
    freeWheelVideoViews?: boolean;
    linearAdData?: boolean;
}

Properties

adImpressions? freeWheelVideoViews? linearAdData?

Properties

OptionaladImpressions

adImpressions?: boolean

Whether to increase the accuracy of ad events by passing the current playback time in Ping requests.

Remarks


- Only available when UplynkSource.assetType is 'asset'.

Default Value

false

OptionalfreeWheelVideoViews

freeWheelVideoViews?: boolean

Whether to enable FreeWheel's Video View by Callback feature to send content impressions to the FreeWheel server.

Remarks


- Only available when UplynkSource.assetType is 'asset'.

Default Value

false

OptionallinearAdData

linearAdData?: boolean

Whether to request information about upcoming ad breaks in the Ping responses.

Remarks


- This feature will update the exposed ads found on player.uplynk.ads.
- Only available when UplynkSource.assetType is 'event' or 'channel'.

Default Value

true if UplynkSource.assetType is 'event' or 'channel', otherwise false.

Settings

Member Visibility

On This Page

Properties