Instance Methods
Method name | Description | Syntax |
---|---|---|
trackSessionStart | Track the intention to start playback. This starts a tracking session on the media tracker instance. | trackerInstance.trackSessionStart(mediaInfo, contextData) |
trackPlay | Track media play or resume after a previous pause. | trackerInstance.trackPlay() |
trackPause | Track media pause. | trackerInstance.trackPause() |
trackComplete | Track media complete. Call this method only when the media has been completely viewed. | trackerInstance.trackComplete() |
trackSessionEnd | Track the end of a viewing session. Call this method even if the user does not view the media to completion. | trackerInstance.trackSessionEnd() |
trackError | Track an error that occurred during media playback. | trackerInstance.trackError("errorId") |
trackEvent | Track a custom event. | trackerInstance.trackEvent(event, info, contextData) |
updatePlayhead | Update the playhead position. | trackerInstance.updatePlayhead(playhead) |
updateQoEObject | Update the quality of experience. | trackerInstance.updateQoEObject(qoe) |
Constants
Constant name | Description | Value |
---|---|---|
MediaType | Media type | Video , Audio |
StreamType | Stream type | VOD , Live , Linear , Podcast , Audiobook , AOD |
VideoMetadataKeys | This defines the standard metadata keys for video streams | Show , Season , Episode , AssetId , Genre , FirstAirDate , FirstDigitalDate , Rating , Originator , Network , ShowType , AdLoad , MVPD , Authorized , DayPart , Feed , StreamFormat |
AudioMetadataKeys | This defines the standard metadata keys for audio streams. | Artist , Album , Label , Author , Station , Publisher |
AdMetadataKeys | This defines the standard metadata keys for ads. | Advertiser , CampaignId , CreativeId , PlacementId , SiteId , CreativeUrl |
Event | This defines the type of a tracking event. | AdBreakStart , AdBreakComplete , AdStart , AdComplete , AdSkip , ChapterStart , ChapterComplete , ChapterSkip , SeekStart , SeekComplete , BufferStart , BufferComplete , BitrateChange , StateStart , StateEnd |
PlayerState | This defines standard values for tracking player state. | FullScreen , ClosedCaption , Mute , PictureInPicture , InFocus |
Previous pagegetLibraryInfo
Next pagesetConsent