JavaScript Constants and Metadata

The following page contains links to the constants and metadata used to integrate the JavaScript SDK.

Constants for Pre-defined Video and Content Metadata

Conviva.Constants.ASSET_NAME

Conviva.Constants.IS_LIVE

Conviva.Constants.PLAYER_NAME

Conviva.Constants.VIEWER_ID

Conviva.Constants.STREAM_URL

Conviva.Constants.DEFAULT_RESOURCE

Conviva.Constants.DURATION

Conviva.Constants.ENCODED_FRAMERATE

Conviva.Constants.FRAMEWORK_NAME

Conviva.Constants.FRAMEWORK_VERSION

c3.app.version

c3.cm.contentType

c3.cm.channel

c3.cm.brand

c3.cm.affiliate

c3.cm.categoryType

c3.cm.name

c3.cm.id

c3.app.version

c3.cm.seriesName

c3.cm.seasonNumber

c3.cm.showTitle

c3.cm.episodeNumber

c3.cm.genre

c3.cm.genreList

c3.cm.utmTrackingUrl

Device Metadata

BRAND

MANUFACTURER

MODEL

TYPE

OS_NAME

OS_VERSION

CATEGORY

SCREEN_RESOLUTION_WIDTH

SCREEN_RESOLUTION_HEIGHT

SCREEN_RESOLUTION_SCALE_FACTOR

HTML5 VideoElement

Monitored Events

videoAnalytics.reportPlaybackError() **(VSF/VPF)

Conviva.Constants.Playback.PLAYER_STATE

Conviva.Constants.Playback.BITRATE

Conviva.Constants.Playback.SEEK_STARTED

Conviva.Constants.Playback.SEEK_ENDED

Conviva.Constants.Playback.PLAY_HEAD_TIME

Conviva.Constants.Playback.BUFFER_LENGTH

Conviva.Constants.Playback.RENDERED_FRAMERATE

Conviva.Constants.Playback.CDN_IP

Metadata

Conviva.Constants.DURATION

Conviva.Constants.FRAMEWORK_NAME

Conviva.Constants.FRAMEWORK_VERSION

Custom Integration

Implement Events

Conviva.Constants.Playback.PLAYER_STATE

Conviva.Constants.Playback.BITRATE

Conviva.Constants.Playback.AVG_BITRATE

Conviva.Constants.Playback.SEEK_STARTED

Conviva.Constants.Playback.SEEK_ENDED

Conviva.Constants.Playback.PLAY_HEAD_TIME

Conviva.Constants.Playback.BUFFER_LENGTH

Conviva.Constants.Playback.RENDERED_FRAMERATE

Conviva.Constants.Playback.CDN_IP

Conviva.Constants.Playback.DROPPED_FRAMES_TOTAL

Conviva.Constants.Playback.DROPPED_FRAMES_COUNT

Conviva.Constants.Playback.AUDIO_LANGUAGE

Conviva.Constants.Playback.SUBTITLES_LANGUAGE

Conviva.Constants.Playback.CLOSED_CAPTIONS_LANGUAGE

Video.js

Monitored Events

videoAnalytics.reportPlaybackError()(VSF/VPF)

Conviva.Constants.Playback.PLAYER_STATE

Conviva.Constants.Playback.BITRATE

Conviva.Constants.Playback.AVG_BITRATE

Conviva.Constants.Playback.SEEK_STARTED

Conviva.Constants.Playback.SEEK_ENDED

Conviva.Constants.Playback.PLAY_HEAD_TIME

Conviva.Constants.Playback.BUFFER_LENGTH

Conviva.Constants.Playback.RENDERED_FRAMERATE

Conviva.Constants.Playback.CDN_IP

Conviva.Constants.Playback.DROPPED_FRAMES_TOTAL

Conviva.Constants.Playback.AUDIO_LANGUAGE

Conviva.Constants.Playback.SUBTITLES_LANGUAGE

Conviva.Constants.Playback.CLOSED_CAPTIONS_LANGUAGE

Metadata

Conviva.Constants.STREAM_URL

Conviva.Constants.IS_LIVE

Conviva.Constants.DURATION

Conviva.Constants.FRAMEWORK_NAME

Conviva.Constants.FRAMEWORK_VERSION

Conviva.Constants.DeviceMetadata.SCREEN_RESOLUTION_WIDTH

Conviva.Constants.DeviceMetadata.SCREEN_RESOLUTION_HEIGHT

Conviva.Constants.DeviceMetadata.SCREEN_RESOLUTION_SCALE_FACTOR

Chromecast CAF

Monitored Events

videoAnalytics.reportPlaybackError() (VSF/VPF)

Conviva.Constants.Playback.PLAYER_STATE

Conviva.Constants.Playback.BITRATE

Conviva.Constants.Playback.SEEK_STARTED

Conviva.Constants.Playback.SEEK_ENDED

Conviva.Constants.Playback.PLAY_HEAD_TIME

Conviva.Constants.Playback.BUFFER_LENGTH

Conviva.Constants.Playback.RENDERED_FRAMERATE

Conviva.Constants.Playback.CDN_IP

Conviva.Constants.Playback.DROPPED_FRAMES_TOTAL

Metadata

Conviva.Constants.STREAM_URL

Conviva.Constants.DURATION

Conviva.Constants.FRAMEWORK_NAME

Conviva.Constants.FRAMEWORK_VERSION

Conviva.Constants.DeviceMetadata.BRAND

Conviva.Constants.DeviceMetadata.MANUFACTURER

Conviva.Constants.DeviceMetadata.MODEL

Conviva.Constants.DeviceMetadata.TYPE

Conviva.Constants.DeviceMetadata.OS_NAME

Conviva.Constants.DeviceMetadata.OS_VERSION

Conviva.Constants.DeviceMetadata.CATEGORY

Conviva.Constants.DeviceMetadata.SCREEN_RESOLUTION_WIDTH

Conviva.Constants.DeviceMetadata.SCREEN_RESOLUTION_HEIGHT

Conviva.Constants.DeviceMetadata.SCREEN_RESOLUTION_SCALE_FACTOR

Samsung TV Tizen AVplay

Monitored Events

videoAnalytics.reportPlaybackError() (VSF/VPF)

Conviva.Constants.Playback.PLAYER_STATE

Conviva.Constants.Playback.BITRATE

Conviva.Constants.Playback.SEEK_STARTED

Conviva.Constants.Playback.SEEK_ENDED

Conviva.Constants.Playback.PLAY_HEAD_TIME

Conviva.Constants.Playback.BUFFER_LENGTH

Conviva.Constants.Playback.RENDERED_FRAMERATE

Conviva.Constants.Playback.CDN_IP

Metadata

Conviva.Constants.DURATION

Conviva.Constants.FRAMEWORK_NAME

Conviva.Constants.FRAMEWORK_VERSION

Conviva.Constants.APPLICATION_VERSION

Conviva.Constants.DeviceMetadata.BRAND

Conviva.Constants.DeviceMetadata.MANUFACTURER

Conviva.Constants.DeviceMetadata.MODEL

Conviva.Constants.DeviceMetadata.TYPE

Conviva.Constants.DeviceMetadata.OS_NAME

Conviva.Constants.DeviceMetadata.OS_VERSION

Conviva.Constants.DeviceMetadata.CATEGORY

Conviva.Constants.DeviceMetadata.SCREEN_RESOLUTION_WIDTH

Conviva.Constants.DeviceMetadata.SCREEN_RESOLUTION_HEIGHT

Conviva.Constants.DeviceMetadata.SCREEN_RESOLUTION_SCALE_FACTOR

PlayStation Trilithium

Monitored Events

videoAnalytics.reportPlaybackError() (VSF/VPF)

Conviva.Constants.Playback.PLAYER_STATE

Conviva.Constants.Playback.BITRATE

Conviva.Constants.Playback.SEEK_STARTED

Conviva.Constants.Playback.SEEK_ENDED

Conviva.Constants.Playback.PLAY_HEAD_TIME

Conviva.Constants.Playback.BUFFER_LENGTH

Conviva.Constants.Playback.RENDERED_FRAMERATE

Conviva.Constants.Playback.CDN_IP

Metadata

Conviva.Constants.DURATION

Conviva.Constants.FRAMEWORK_NAME

Conviva.Constants.FRAMEWORK_VERSION

Conviva.Constants.APPLICATION_VERSION

Conviva.Constants.DeviceMetadata.MANUFACTURER

Conviva.Constants.DeviceMetadata.MODEL

Conviva.Constants.DeviceMetadata.TYPE

Conviva.Constants.DeviceMetadata.OS_NAME

Conviva.Constants.DeviceMetadata.OS_VERSION

Conviva.Constants.DeviceMetadata.CATEGORY

Conviva.Constants.DeviceMetadata.SCREEN_RESOLUTION_WIDTH

Conviva.Constants.DeviceMetadata.SCREEN_RESOLUTION_HEIGHT

PlayStation WebMAF

Monitored Events

videoAnalytics.reportPlaybackError() (VSF/VPF)

Conviva.Constants.Playback.PLAYER_STATE

Conviva.Constants.Playback.BITRATE

Conviva.Constants.Playback.SEEK_STARTED

Conviva.Constants.Playback.SEEK_ENDED

Conviva.Constants.Playback.PLAY_HEAD_TIME

Conviva.Constants.Playback.BUFFER_LENGTH

Conviva.Constants.Playback.RENDERED_FRAMERATE

Conviva.Constants.Playback.CDN_IP

Conviva.Constants.DROPPED_FRAMES_TOTAL

Conviva.Constants.Playback.DROPPED_FRAMES_COUNT

Metadata

Conviva.Constants.DURATION

Conviva.Constants.FRAMEWORK_NAME

Conviva.Constants.FRAMEWORK_VERSION

Conviva.Constants.DeviceMetadata.MANUFACTURER

Conviva.Constants.DeviceMetadata.MODEL

Conviva.Constants.DeviceMetadata.TYPE

Conviva.Constants.DeviceMetadata.OS_NAME

Conviva.Constants.DeviceMetadata.OS_VERSION

Conviva.Constants.DeviceMetadata.CATEGORY

Conviva.Constants.DeviceMetadata.SCREEN_RESOLUTION_WIDTH

Conviva.Constants.DeviceMetadata.SCREEN_RESOLUTION_HEIGHT

Google IMA

Autocollected Metrics

Errors(ASF/APF)

Conviva.Constants.Playback.PLAYER_STATE

Conviva.Constants.Playback.BITRATE

Conviva.Constants.Playback.SEEK_STARTED

Conviva.Constants.Playback.SEEK_ENDED

Conviva.Constants.Playback.PLAY_HEAD_TIME

Conviva.Constants.Playback.BUFFER_LENGTH

Conviva.Constants.Playback.RENDERED_FRAMERATE

Conviva.Constants.Playback.CDN_IP

Ad Metadata

Conviva.Constants.STREAM_URL

Conviva.Constants.ASSET_NAME

Conviva.Constants.IS_LIVE

Conviva.Constants.PLAYER_NAME

Conviva.Constants.VIEWER_ID

Conviva.Constants.DURATION

Conviva.Constants.ENCODED_FRAMERATE

Conviva.Constants.FRAMEWORK_NAME

Conviva.Constants.FRAMEWORK_VERSION

Conviva.Constants.APPLICATION_VERSION

Pre-defined Ad Metadata Key

"c3.ad.technology"

"c3.ad.id"

"c3.ad.system"

"c3.ad.position"

"c3.ad.isSlate"

"c3.ad.mediaFileApiFramework"

"c3.ad.adStitcher"

"c3.ad.firstAdSystem"

"c3.ad.firstAdId"

"c3.ad.firstCreativeId"

"c3.ad.creativeId"

IMA DAI Module

Ad Metrics

Errors(ASF/APF)

Conviva.Constants.Playback.PLAYER_STATE

Conviva.Constants.Playback.BITRATE

Conviva.Constants.Playback.SEEK_STARTED

Conviva.Constants..SEPlayback.SEEK_ENDED

Conviva.Constants.Playback.PLAY_HEAD_TIME

Conviva.Constants.Playback.BUFFER_LENGTH

Conviva.Constants.Playback.RENDERED_FRAMERATE

Conviva.Constants.Playback.CDN_IP

Ad Metadata

Conviva.Constants.STREAM_URL

Conviva.Constants.ASSET_NAME

Conviva.Constants.IS_LIVE

Conviva.Constants.PLAYER_NAME

Conviva.Constants.VIEWER_ID

Conviva.Constants.DURATION

Conviva.Constants.ENCODED_FRAMERATE

Conviva.Constants.FRAMEWORK_NAME

Conviva.Constants.FRAMEWORK_VERSION

Conviva.Constants.APPLICATION_VERSION

Pre-defined Ad Metadata Key

"c3.ad.technology"

"c3.ad.id"

"c3.ad.system"

"c3.ad.position"

"c3.ad.isSlate"

"c3.ad.mediaFileApiFramework"

"c3.ad.adStitcher"

"c3.ad.firstAdSystem"

"c3.ad.firstAdId"

"c3.ad.firstCreativeId"

"c3.ad.creativeId"

Custom Ad Manager

Ad Metadata

Conviva.Constants.STREAM_URL

Conviva.Constants.ASSET_NAME

Conviva.Constants.IS_LIVE

Conviva.Constants.PLAYER_NAME

Conviva.Constants.VIEWER_ID

Conviva.Constants.DURATION

Conviva.Constants.ENCODED_FRAMERATE

Conviva.Constants.FRAMEWORK_NAME

Conviva.Constants.FRAMEWORK_VERSION

Conviva.Constants.APPLICATION_VERSION

Pre-defined Ad Metadata Key

"c3.ad.technology"

"c3.ad.id"

"c3.ad.system"

"c3.ad.position"

"c3.ad.isSlate"

"c3.ad.mediaFileApiFramework"

"c3.ad.adStitcher"

"c3.ad.firstAdSystem"

"c3.ad.firstAdId"

"c3.ad.firstCreativeId"

"c3.ad.creativeId"

Ad Metrics

Errors(ASF/APF)

Conviva.Constants.Playback.PLAYER_STATE

Conviva.Constants.Playback.BITRATE

Conviva.Constants.Playback.SEEK_STARTED

Conviva.Constants.Playback.SEEK_ENDED

Conviva.Constants.Playback.PLAY_HEAD_TIME

Conviva.Constants.Playback.BUFFER_LENGTH

Conviva.Constants.Playback.RENDERED_FRAMERATE

Conviva.Constants.Playback.CDN_IP