Techdocs

AMP Web SDK

AMP player

HeartbeatConfig

See Video Heartbeat MediaSDK 2.x Configuration Variables Documentation. Important note. MediaSDK requires an instance of AppMeasurement to send calls to Adobe Analytics and also Visitor.js please check out VisitorAPI Finally, Please checkout MediaSDK API reference for JS MediaSDK API

Members

appMeasurement

:akamai.amp.heartbeat.AppMeasurementConfig

AppMeasurement configuration.

channel

:string

The name of the syndication channel. AdobeAnalyticsPlugin configuration

contextData

:object

Adobe Analytics context data passed to the reporting server and used in processing rules. ContextData definition

debug

:boolean

Enables MediaSDK debugLoggin.

liveLinear

:akamai.amp.heartbeat.HeartbeatLiveLinear

For Live playback tracking

metadata

:object

Metadata passed to MediaInfo as MediaObjectKey.StandardMediaMetadata or MediaObjectKey.StandardAdMetadata for ads metadata i.e VideoMetadataKeys.SEASON, VideoMetadataKeys.EPISODE, AdMetadataKeys.ADVERTISER StandardAdMetadata docs

ovp

:string

online video platform name.

pageName

:string

AppMeasurement: The page in which player is hosted (Optional).

playerName

:string

Video Heartbeat Player Name i.e 'AMP Player'

publisher

:string

The name of the publisher.

resources

:array

The required resources such as MediaSDK.js and AppMeasurement.js, if these are being provided on page level therefore can be omitted.

ssl

:boolean

Enables SSL tracking mode.

trackingServer

:string

Video Heartbeat Tracking Server i.e 'hb.omtrdc.net'

visitor

:akamai.amp.heartbeat.VisitorConfig

VisitorAPI configuration.