Namespace: Constants

Constants

Constants defined by Conviva SDK.

Members

(static) AD_TYPE

The constant AD_TYPE

(static, constant) AdPlayer :string

Video player in charge of rendering video advertisement.
Type:
  • string
Properties:
Name Type Description
CONTENT string Ads and content are played using the same video player instance.
SEPARATE string Ads and content are played using separate video player instances.

(static, constant) AdPosition :string

Position of video advertisement relative to content.
Type:
  • string
Properties:
Name Type Description
PREROLL string The ad is a preroll, kicking in before content.
MIDROLL string The ad is a midroll, kicking in during content.
POSTROLL string The ad is a postroll, kicking in after content.

(static, constant) AdServingType :string

Possible types of ad serving type.
Type:
  • string
Properties:
Name Type Description
INLINE string
WRAPPER string

(static, constant) AdSlates :string

Possible types of ad slates.
Type:
  • string
Properties:
Name Type Description
BLACKOUT_SLATE string
TECHNICAL_DIFFICULTIES_SLATE string
COMMERCIAL_SLATE string
OTHER_SLATE string
VPAID string
REGULAR string

(static, constant) AdType :string

Possible types of ad type.
Type:
  • string
Properties:
Name Type Description
CLIENT_SIDE string Client Side.
SERVER_SIDE string Server Side.

(static) APPLICATION_VERSION

The constant APPLICATION_VERSION.

(static) ASSET_NAME

The constant ASSET_NAME.

(static, constant) CallbackFunctions :string

Possible types of Callback Functions to be implemented.
Type:
  • string
Properties:
Name Type Description
CONSOLE_LOG string Logging Utility Function Callback
MAKE_REQUEST string HTTP Utility Function Callback
SAVE_DATA string Storage Save Utility Function Callback
LOAD_DATA string Storage Load Utility Function Callback
GET_EPOCH_TIME_IN_MS string Epoch/Unix Timestamp (in milliseconds) Utility Function Callback
CREATE_TIMER string Timer Utility Function Callback
GENERATE_HASH string Hash Utility Function Callback
BASE64_ENCODE string Base64 Encoding Utility Function Callback

(static) CUSTOMER_KEY

The constant CUSTOMER_KEY.

(static) DEFAULT_RESOURCE

The constant DEFAULT_RESOURCE.

(static, constant) DeviceCategory :string

Possible device categories reported to Conviva.
Type:
  • string
Properties:
Name Type Description
ANDROID_DEVICE string The device is a Android Device like Samsung Galaxy or Amazon Fire TV or Android TV or Android Tablet.
APPLE_DEVICE string The device is a Apple device like iPhone or Apple TV.
CHROMECAST string The device is a Google Chromecast STB or Android TV with built-in Chromecast.
DESKTOP_APP string The device is a desktop computer(including notebook) with Video is played in the app installed, as opposed to playing in browser.
DEVICE_SIMULATOR string The device is a simulated device video session for testing.
LG_TV string The device is a LG smart TV including NetCast and webOS.
NINTENDO string The device is a Nintendo games console including Wii and Switch.
PLAYSTATION string The device is a PlayStation games console including PS3 and PS4.
ROKU string The device is a Roku device.
SAMSUNG_TV string The device is a Samsung Smart TV including Orsay and Tizen.
SMART_TV string The device is a Smart TV not covered by other categories. Includes Hisense, Panasonic, Philips, Sony and others. Does not include Android-based, Apple TV, Chromecast-based, Roku, LG TV and Samsung TV.
SET_TOP_BOX string The device is a custom Set Top Box not covered by other categories. Includes Humax, Netgem, Sagemcom, SkyQ, Xfinity X1 and others. Does not include Android-based, Apple TV, Chromecast-based, Roku and TiVo.
TIVO string The device is a TiVo device.
WEB string The device can any device with in-browser HTML5-based players. Always means that video is playing in the browser using player based on HTML5. Any Browser can be chosen by viewer out of many choices, including Chrome, Edge, Firefox, Internet Explorer, Opera and Safari. Browser can be opened/used on any hardware - Desktop, Set Top Box, Game Console, Mobile Phone, Tablet etc. As long as it is any commercial browser and HTML5 technology - it should be categorized as 'WEB'.
WINDOWS_DEVICE string The device is a Windows OS - based handheld device, like Windows Phone or Windows Tablet.
XBOX string The device is a Xbox games console including Xbox 360 and Xbox One.
KAIOS_DEVICE string The device is a Phone or other device based on KaiOS OS, like Lyf Jio F30C.
LINUX string The devices are running in browsers on a Linux-based operating system.

(static, constant) DeviceMetadata :string

Possible types of Device Metadata.
Type:
  • string
Properties:
Name Type Description
BRAND string Brand of the device.
Ex: "iPhone", "Samsung SmartTV"
MANUFACTURER string Manufacturer of the device.
Ex: "Samsung", "Apple"
MODEL string Model of the device.
Ex: "iPhone 6 Plus", "HTC One", "Roku 3", "Samsung SmartTV 2015"
TYPE string Brand of the device.
Ex: "iPhone", "Samsung SmartTV"
VERSION string Type of the device.
Only allows the Constants.DeviceType values and discards any other string values.
Please get in touch with Conviva, if the Device Type you are looking for is not listed.
OS_NAME string Name of the operating system used by the device, in uppercase.
Ex: "WINDOWS", "LINUX", "IOS", "MAC", ANDROID", "FIREOS", "ROKU", "PLAYSTATION", "CHROMEOS".
OS_VERSION string Version of the operating system used by the device.
Ex: "10.10.1", "8.1", "T-INFOLINK2012-1012", "Fire OS 5"
CATEGORY string Device Category to which the used device belongs to.
Only allows the Constants.DeviceCategory values and discards any other string values.
Please get in touch with Conviva, if the Device Category you are looking for is not listed.
SCREEN_RESOLUTION_WIDTH string Device Screen Width. Ex: 1920
SCREEN_RESOLUTION_HEIGHT string Device Screen Height. Ex: 1080
SCREEN_RESOLUTION_SCALE_FACTOR string Device Screen Resolution Scale Factor. Ex: 1

(static, constant) DeviceType :string

Possible device types reported to Conviva. It _roughly_ corresponds to a "Primary Hardware Type" as defined by DeviceAtlas and adopted by Conviva in https://github.com/Conviva-Internal/dag-x-m3dv-spec/blob/master/spec-source/m3dv/defined-values/hwt.xml where you can find a complete and up-to-date list of all Hardware Types. Device types listed here is a small subset of all Hardware Types, and in case of a device with a type not on the list, please select "OTHER". For main use of these constants, see `Client.DeviceType` in src/core/sdk/api/Client.js Also see `ConvivaConstants.DeviceType` in src/core-typescript/conviva-core-sdk.d.ts
Type:
  • string
Properties:
Name Type Description
DESKTOP string The device is a "Desktop". Case is different in backend for this one. Match it for now. FIXME: We should replace it with a "Desktop" string.
CONSOLE string The device is a "Games Console".
SETTOP string The device is a "Set Top Box".
MOBILE string The device is a "Mobile Phone".
TABLET string The device is a "Tablet".
SMARTTV string The device is a "TV".
VEHICLE string The device is a "Vehicle Multimedia System".
OTHER string The device is a type that is not on the list above. Note that this is not a case of an unknown device type: device type is known but it just happens not to be listed above.

(static) DURATION

The constant DURATION.

(static) ENCODED_FRAMERATE

The constant ENCODED_FRAMERATE.

(static, constant) ErrorSeverity :integer

Severity of errors reported to Conviva.
Type:
  • integer
Properties:
Name Type Description
FATAL integer The error could prevent playback altogether. When in doubt, use this as default.
WARNING integer The error should not affect playback.

(static, constant) ErrorType :string

Possible types of Error Event attributes.
Type:
  • string
Properties:
Name Type Description
ERROR_UNKNOWN string ERROR_UNKNOWN
ERROR_IO string ERROR_IO
ERROR_TIMEOUT string ERROR_TIMEOUT
ERROR_NULL_ASSET string ERROR_NULL_ASSET
ERROR_MISSING_PARAMETER string ERROR_MISSING_PARAMETER
ERROR_NO_AD_AVAILABLE string ERROR_NO_AD_AVAILABLE
ERROR_PARSE string ERROR_PARSE
ERROR_INVALID_VALUE string ERROR_INVALID_VALUE
ERROR_INVALID_SLOT string ERROR_INVALID_SLOT
ERROR_3P_COMPONENT string ERROR_3P_COMPONENT
ERROR_UNSUPPORTED_3P_FEATURE string ERROR_UNSUPPORTED_3P_FEATURE
ERROR_DEVICE_LIMIT string ERROR_DEVICE_LIMIT
ERROR_UNMATCHED_SLOT_SIZE string ERROR_UNMATCHED_SLOT_SIZE

(static, constant) Events :string

Possible types ad and content events.
Type:
  • string
Properties:
Name Type Description
USER_WAIT_STARTED string User Wait Started
USER_WAIT_ENDED string User Wait Ended
BUMPER_VIDEO_STARTED string Bumper/Logo video started
BUMPER_VIDEO_ENDED string Bumper/Logo Video Ended
AD_REQUESTED string Ad Requested
AD_RESPONSE string Ad Response
AD_SLOT_STARTED string Slot Started
AD_ATTEMPTED string Ad Attempted
AD_SLOT_ENDED string Slot Ended
AD_IMPRESSION_START string Ad Impression
AD_START string Ad Start
AD_FIRST_QUARTILE string Ad First Quartile
AD_MID_QUARTILE string Ad Mid Quartile
AD_THIRD_QUARTILE string Ad Third Quartile
AD_COMPLETE string Ad Complete
AD_END string Ad End
AD_IMPRESSION_END string Ad Impression End
AD_SKIPPED string Ad Skipped
AD_ERROR string Ad Error
AD_PROGRESS string Ad Progress
AD_CLOSE string Ad Close
CONTENT_PAUSED string Pause Content
CONTENT_RESUMED string Resume Content
POD_START string Pod Start
POD_END string Pod End

(static) GATEWAY_URL

The constant GATEWAY_URL.

(static) IS_LIVE

The constant IS_LIVE.

(static) LOG_LEVEL

The constant LOG_LEVEL.

(static, constant) LogLevel :integer

Possible log level settings for Conviva components.
Type:
  • integer
Properties:
Name Type Description
DEBUG integer Will display all log messages.
INFO integer Will display all log messages except debugging messages.
WARNING integer Will only display warning and error log messages.
ERROR integer Will only display error log messages.
NONE integer Will not display any log messages.

(static, constant) Network :string

List of supported Conviva Network Metric Keys.
Type:
  • string
Properties:
Name Type Description
SIGNAL_STRENGTH string SIGNAL_STRENGTH
LINK_ENCRYPTION string LINK_ENCRYPTION
CONNECTION_TYPE string CONNECTION_TYPE

(static, constant) NO_SESSION_KEY :integer

A default sessionKey to use for the Analytics#reportAppEvent API if you do not yet have a Conviva session.
Type:
  • integer

(static, constant) Playback :string

List of supported Conviva Playback Metric Keys.
Type:
  • string
Properties:
Name Type Description
BITRATE string BITRATE
AVG_BITRATE string AVG_BITRATE
PLAY_HEAD_TIME string PLAY_HEAD_TIME
RESOLUTION string RESOLUTION
BUFFER_LENGTH string BUFFER_LENGTH
PLAYER_STATE string PLAYER_STATE
RENDERED_FRAMERATE string RENDERED_FRAMERATE
SEEK_STARTED string SEEK_STARTED
SEEK_ENDED string SEEK_ENDED
CDN_IP string CDN_IP
DROPPED_FRAMES_TOTAL string DROPPED_FRAMES_TOTAL
DROPPED_FRAMES_COUNT string DROPPED_FRAMES_COUNT
AUDIO_LANGUAGE string AUDIO_LANGUAGE
SUBTITLES_LANGUAGE string SUBTITLES_LANGUAGE
CLOSED_CAPTIONS_LANGUAGE string CLOSED_CAPTIONS_LANGUAGE

(static) PLAYER_NAME

The constant PLAYER_NAME.

(static, constant) PlayerState :string

Possible player states during video playback.
Type:
  • string
Properties:
Name Type Description
STOPPED string Report this state when you can confirm that the player is currently inactive/idle.
PLAYING string Report this state when you can confirm that the player is actively rendering video content for the viewer.
This should never be reported for unavailable/blocked content.
BUFFERING string Report this state when you can confirm that the player is stalled due to lack of video data in the buffer.
It may show a spinner, or it may simply present a freeze frame.
PAUSED string Report this state when you can confirm that the player is paused, generally upon viewer request.
UNKNOWN string Report this state when no other recognized Conviva player states apply.
NOT_MONITORED string Reserved state. Do not use.

(static) POD_DURATION

The constant POD_DURATION

(static) POD_INDEX

The constant POD_INDEX

(static) POD_POSITION

The constant POD_POSITION

(static) STREAM_URL

The constant STREAM_URL.

(static, constant) StreamType :string

Possible types of streaming video.
Type:
  • string
Properties:
Name Type Description
UNKNOWN string It is not yet known what the type of streaming is.
LIVE string Content for this session is streamed live.
VOD string Content for this session is streamed on demand.

(static) UTM_TRACKING_URL

The constant UTM_TRACKING_URL.

(static) version

The current version of the Conviva SDK.

(static) VIEWER_ID

The constant VIEWER_ID.