Instance Methods

Method nameDescriptionSyntax
trackSessionStartTrack the intention to start playback. This starts a tracking session on the media tracker instance.trackerInstance.trackSessionStart(mediaInfo, contextData)
trackPlayTrack media play or resume after a previous pause.trackerInstance.trackPlay()
trackPauseTrack media pause.trackerInstance.trackPause()
trackCompleteTrack media complete. Call this method only when the media has been completely viewed.trackerInstance.trackComplete()
trackSessionEndTrack the end of a viewing session. Call this method even if the user does not view the media to completion.trackerInstance.trackSessionEnd()
trackErrorTrack an error that occurred during media playback.trackerInstance.trackError("errorId")
trackEventTrack a custom event.trackerInstance.trackEvent(event, info, contextData)
updatePlayheadUpdate the playhead position.trackerInstance.updatePlayhead(playhead)
updateQoEObjectUpdate the quality of experience.trackerInstance.updateQoEObject(qoe)

Constants

Constant nameDescriptionValue
MediaTypeMedia typeVideo, Audio
StreamTypeStream typeVOD, Live, Linear, Podcast, Audiobook, AOD
VideoMetadataKeysThis defines the standard metadata keys for video streamsShow, Season, Episode, AssetId, Genre, FirstAirDate, FirstDigitalDate, Rating, Originator, Network, ShowType, AdLoad, MVPD, Authorized, DayPart, Feed, StreamFormat
AudioMetadataKeysThis defines the standard metadata keys for audio streams.Artist, Album, Label, Author, Station, Publisher
AdMetadataKeysThis defines the standard metadata keys for ads.Advertiser, CampaignId, CreativeId, PlacementId, SiteId, CreativeUrl
EventThis defines the type of a tracking event.AdBreakStart, AdBreakComplete, AdStart, AdComplete, AdSkip, ChapterStart, ChapterComplete, ChapterSkip, SeekStart, SeekComplete, BufferStart, BufferComplete, BitrateChange, StateStart, StateEnd
PlayerStateThis defines standard values for tracking player state.FullScreen, ClosedCaption, Mute, PictureInPicture, InFocus
Previous pagegetLibraryInfo
Next pagesetConsent

Data Collection