Package com.brightcove.player.analytics

Class Analytics.Fields

java.lang.Object

com.brightcove.player.analytics.Analytics.Fields

Enclosing class:

Analytics

public static class Analytics.Fields
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ACCOUNT
static final String	APPLICATION_ID	Key value to set the Application Id
static final String	BASE_PARAMS
protected static final String	CATALOG_URL
static final String	DELIVERY_TYPE	The delivery type of current playback (LIVE or ON DEMAND)
protected static final String	DESTINATION
protected static final String	DEVICE
protected static final String	DEVICE_CPU
protected static final String	DEVICE_HARDWARE
protected static final String	DEVICE_MANUFACTURER
protected static final String	DEVICE_MODEL
protected static final String	DEVICE_OS
protected static final String	DEVICE_OS_VERSION
protected static final String	DEVICE_PRODUCT
protected static final String	DEVICE_TYPE
protected static final String	DOMAIN
static final String	DOWNLOAD_CANCEL_TIME	The name of the property specifies the date and time when the download request was cancelled as number of milliseconds since January 1, 1970, 00:00:00 GMT.
static final String	DOWNLOAD_COMPLETION_TIME	The name of the property specifies the date and time when the download request completed as number of milliseconds since January 1, 1970, 00:00:00 GMT.
static final String	DOWNLOAD_FAILURE_TIME	The name of the property specifies the date and time when the download request failed as number of milliseconds since January 1, 1970, 00:00:00 GMT.
static final String	DOWNLOAD_ID	The name of the property specifies the globally unique download identifier for the offline copy of the video.
static final String	DOWNLOAD_REQUEST_TIME	The name of the property specifies that date and time when the download request was initiated as the number of milliseconds since January 1, 1970, 00:00:00 GMT.
static final String	DOWNLOAD_SIZE	The name of the property specifies the total size of the download as number of bytes.
protected static final String	ERROR_CODE
protected static final String	ERROR_DESCRIPTION
protected static final String	EVENT
protected static final String	EVENT_AD_END	ad_end event property.
static final String	EVENT_AD_RELATED	Involves all ad related analytics events.
protected static final String	EVENT_AD_START	ad_start event property.
protected static final String	EVENT_CATALOG_REQUEST	catalog_request event property and associated fields.
protected static final String	EVENT_CATALOG_RESPONSE	catalog_response event property and associated fields.
static final String	EVENT_DOWNLOAD_CANCEL	This event will be sent when a Video download is successfully cancelled.
static final String	EVENT_DOWNLOAD_COMPLETE	This event will be sent when a Video download is successfully completed.
static final String	EVENT_DOWNLOAD_FAIL	This event will be sent when a Video download fails.
protected static final String	EVENT_DOWNLOAD_PREFIX	The prefix that will be used identify all ODRM download related events..
static final String	EVENT_DOWNLOAD_REQUESTED	This event will be sent to the analytics server when a request to download a Video is received.
static final String	EVENT_DOWNLOAD_START	This event will be sent when a Video download starts the first time.
protected static final String	EVENT_ERROR	error event property and associated fields.
protected static final String	EVENT_PLAY_REQUEST	play_request event property.
protected static final String	EVENT_VIDEO_COMPLETE	video_complete event property.
protected static final String	EVENT_VIDEO_ENGAGEMENT	video_engagement event property and associated fields.
protected static final String	EVENT_VIDEO_IMPRESSION	video_impression event property.
protected static final String	EVENT_VIDEO_RESUMED	video_resumed event property sent when content playback has resumed.
protected static final String	EVENT_VIDEO_VIEW	video_view event property and associated fields.
protected static final String	FORWARD_BUFFER_SECONDS
protected static final String	LOAD_TIME_MS
protected static final String	MEASURED_BPS
protected static final String	MEDIA_BYTES_TRANSFERRED	The key for total number of bytes transferred by the video player.
static final String	MEDIA_TYPE	The media type of current playback (AUDIO or VIDEO)
protected static final String	PLATFORM
protected static final String	PLATFORM_VERSION
static final List<String>	PLAYBACK_EVENTS
protected static final String	PLAYER_HEIGHT
protected static final String	PLAYER_ID
protected static final String	PLAYER_NAME
protected static final String	PLAYER_WIDTH
protected static final String	RANGE
protected static final String	REBUFFERING_COUNT
protected static final String	REBUFFERING_SECONDS
protected static final String	RENDITION_HEIGHT
protected static final String	RENDITION_INDICATED_BPS
protected static final String	RENDITION_MIME_TYPE
protected static final String	RENDITION_URL
protected static final String	RENDITION_WIDTH
protected static final String	RESPONSE_TIME_MS
protected static final String	SESSION	Required
protected static final String	SOURCE
protected static final String	START_TIME_MS
protected static final String	TIME
static final String	USER	Key value to set the User
protected static final String	VIDEO_DURATION
protected static final String	VIDEO_ID
protected static final String	VIDEO_NAME	Optional
protected static final String	VIDEO_SECONDS_VIEWED

Constructor Summary

Constructors

Constructor	Description
Fields()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

BASE_PARAMS

public static final String BASE_PARAMS

See Also:

• Constant Field Values

SESSION

protected static final String SESSION

Required

See Also:

• Constant Field Values

EVENT

protected static final String EVENT

See Also:

• Constant Field Values

DOMAIN

protected static final String DOMAIN

See Also:

• Constant Field Values

DEVICE

protected static final String DEVICE

See Also:

• Constant Field Values

DEVICE_CPU

protected static final String DEVICE_CPU

See Also:

• Constant Field Values

DEVICE_OS

protected static final String DEVICE_OS

See Also:

• Constant Field Values

DEVICE_OS_VERSION

protected static final String DEVICE_OS_VERSION

See Also:

• Constant Field Values

DEVICE_TYPE

protected static final String DEVICE_TYPE

See Also:

• Constant Field Values

DEVICE_HARDWARE

protected static final String DEVICE_HARDWARE

See Also:

• Constant Field Values

DEVICE_MANUFACTURER

protected static final String DEVICE_MANUFACTURER

See Also:

• Constant Field Values

DEVICE_MODEL

protected static final String DEVICE_MODEL

See Also:

• Constant Field Values

DEVICE_PRODUCT

protected static final String DEVICE_PRODUCT

See Also:

• Constant Field Values

TIME

protected static final String TIME

See Also:

• Constant Field Values

VIDEO_ID

protected static final String VIDEO_ID

See Also:

• Constant Field Values

ACCOUNT

protected static final String ACCOUNT

See Also:

• Constant Field Values

DESTINATION

protected static final String DESTINATION

See Also:

• Constant Field Values

SOURCE

protected static final String SOURCE

See Also:

• Constant Field Values

PLAYER_NAME

protected static final String PLAYER_NAME

See Also:

• Constant Field Values

PLAYER_ID

protected static final String PLAYER_ID

See Also:

• Constant Field Values

PLATFORM

protected static final String PLATFORM

See Also:

• Constant Field Values

PLATFORM_VERSION

protected static final String PLATFORM_VERSION

See Also:

• Constant Field Values

USER

public static final String USER

Key value to set the User

See Also:

• Constant Field Values

APPLICATION_ID

public static final String APPLICATION_ID

Key value to set the Application Id

See Also:

• Constant Field Values

VIDEO_NAME

protected static final String VIDEO_NAME

Optional

See Also:

• Constant Field Values

VIDEO_DURATION

protected static final String VIDEO_DURATION

See Also:

• Constant Field Values

EVENT_VIDEO_ENGAGEMENT

protected static final String EVENT_VIDEO_ENGAGEMENT

video_engagement event property and associated fields.

See Also:

• Constant Field Values

RANGE

protected static final String RANGE

See Also:

• Constant Field Values

VIDEO_SECONDS_VIEWED

protected static final String VIDEO_SECONDS_VIEWED

See Also:

• Constant Field Values

RENDITION_URL

protected static final String RENDITION_URL

See Also:

• Constant Field Values

RENDITION_INDICATED_BPS

protected static final String RENDITION_INDICATED_BPS

See Also:

• Constant Field Values

RENDITION_MIME_TYPE

protected static final String RENDITION_MIME_TYPE

See Also:

• Constant Field Values

RENDITION_HEIGHT

protected static final String RENDITION_HEIGHT

See Also:

• Constant Field Values

RENDITION_WIDTH

protected static final String RENDITION_WIDTH

See Also:

• Constant Field Values

REBUFFERING_SECONDS

protected static final String REBUFFERING_SECONDS

See Also:

• Constant Field Values

REBUFFERING_COUNT

protected static final String REBUFFERING_COUNT

See Also:

• Constant Field Values

FORWARD_BUFFER_SECONDS

protected static final String FORWARD_BUFFER_SECONDS

See Also:

• Constant Field Values

MEASURED_BPS

protected static final String MEASURED_BPS

See Also:

• Constant Field Values

PLAYER_WIDTH

protected static final String PLAYER_WIDTH

See Also:

• Constant Field Values

PLAYER_HEIGHT

protected static final String PLAYER_HEIGHT

See Also:

• Constant Field Values

MEDIA_BYTES_TRANSFERRED

protected static final String MEDIA_BYTES_TRANSFERRED

The key for total number of bytes transferred by the video player.

See Also:

• Constant Field Values

EVENT_VIDEO_VIEW

protected static final String EVENT_VIDEO_VIEW

video_view event property and associated fields.

See Also:

• Constant Field Values

EVENT_VIDEO_RESUMED

protected static final String EVENT_VIDEO_RESUMED

video_resumed event property sent when content playback has resumed.

See Also:

• Constant Field Values

LOAD_TIME_MS

protected static final String LOAD_TIME_MS

See Also:

• Constant Field Values

START_TIME_MS

protected static final String START_TIME_MS

See Also:

• Constant Field Values

EVENT_CATALOG_REQUEST

protected static final String EVENT_CATALOG_REQUEST

catalog_request event property and associated fields. Sent when a request to the videocloud catalog api is made.

See Also:

• Constant Field Values

CATALOG_URL

protected static final String CATALOG_URL

See Also:

• Constant Field Values

EVENT_CATALOG_RESPONSE

protected static final String EVENT_CATALOG_RESPONSE

catalog_response event property and associated fields. Send when a reponse to a prior catalog_request is received. This event also uses the CATALOG_URL field defined in the catalog_request event property.

See Also:

• Constant Field Values

RESPONSE_TIME_MS

protected static final String RESPONSE_TIME_MS

See Also:

• Constant Field Values

EVENT_PLAY_REQUEST

protected static final String EVENT_PLAY_REQUEST

play_request event property. Sent when the playback is initiated either by the user expressly clicking the play button, or automatically when the platform triggers playback in an auto-play scenario.

See Also:

• Constant Field Values

EVENT_AD_START

protected static final String EVENT_AD_START

ad_start event property. Sent when control is handed over to an advertising agency by the playback plaform.

See Also:

• Constant Field Values

EVENT_AD_END

protected static final String EVENT_AD_END

ad_end event property. Sent when control is handed back from the advertising agent to the playback platform.

See Also:

• Constant Field Values

EVENT_ERROR

protected static final String EVENT_ERROR

error event property and associated fields. Sent when fatal errors which disrupt the playback experience are encountered.

See Also:

• Constant Field Values

ERROR_CODE

protected static final String ERROR_CODE

See Also:

• Constant Field Values

ERROR_DESCRIPTION

protected static final String ERROR_DESCRIPTION

See Also:

• Constant Field Values

EVENT_VIDEO_IMPRESSION

protected static final String EVENT_VIDEO_IMPRESSION

video_impression event property.

See Also:

• Constant Field Values

EVENT_VIDEO_COMPLETE

protected static final String EVENT_VIDEO_COMPLETE

video_complete event property.

See Also:

• Constant Field Values

EVENT_DOWNLOAD_PREFIX

protected static final String EVENT_DOWNLOAD_PREFIX

The prefix that will be used identify all ODRM download related events..

See Also:

• Constant Field Values

EVENT_DOWNLOAD_REQUESTED

public static final String EVENT_DOWNLOAD_REQUESTED

This event will be sent to the analytics server when a request to download a Video is received.

See Also:

• Constant Field Values

EVENT_DOWNLOAD_START

public static final String EVENT_DOWNLOAD_START

This event will be sent when a Video download starts the first time.

See Also:

• Constant Field Values

EVENT_DOWNLOAD_COMPLETE

public static final String EVENT_DOWNLOAD_COMPLETE

This event will be sent when a Video download is successfully completed.

See Also:

• Constant Field Values

EVENT_DOWNLOAD_CANCEL

public static final String EVENT_DOWNLOAD_CANCEL

This event will be sent when a Video download is successfully cancelled.

See Also:

• Constant Field Values

EVENT_DOWNLOAD_FAIL

public static final String EVENT_DOWNLOAD_FAIL

This event will be sent when a Video download fails.

See Also:

• Constant Field Values

DOWNLOAD_ID

public static final String DOWNLOAD_ID

The name of the property specifies the globally unique download identifier for the offline copy of the video.

See Also:

• Constant Field Values

DOWNLOAD_REQUEST_TIME

public static final String DOWNLOAD_REQUEST_TIME

The name of the property specifies that date and time when the download request was initiated as the number of milliseconds since January 1, 1970, 00:00:00 GMT.

See Also:

• Constant Field Values

DOWNLOAD_CANCEL_TIME

public static final String DOWNLOAD_CANCEL_TIME

The name of the property specifies the date and time when the download request was cancelled as number of milliseconds since January 1, 1970, 00:00:00 GMT.

See Also:

• Constant Field Values

DOWNLOAD_COMPLETION_TIME

public static final String DOWNLOAD_COMPLETION_TIME

The name of the property specifies the date and time when the download request completed as number of milliseconds since January 1, 1970, 00:00:00 GMT.

See Also:

• Constant Field Values

DOWNLOAD_FAILURE_TIME

public static final String DOWNLOAD_FAILURE_TIME

The name of the property specifies the date and time when the download request failed as number of milliseconds since January 1, 1970, 00:00:00 GMT.

See Also:

• Constant Field Values

DOWNLOAD_SIZE

public static final String DOWNLOAD_SIZE

The name of the property specifies the total size of the download as number of bytes.

See Also:

• Constant Field Values

EVENT_AD_RELATED

public static final String EVENT_AD_RELATED

Involves all ad related analytics events.

See Also:

• Constant Field Values

MEDIA_TYPE

public static final String MEDIA_TYPE

The media type of current playback (AUDIO or VIDEO)

See Also:

• Constant Field Values

DELIVERY_TYPE

public static final String DELIVERY_TYPE

The delivery type of current playback (LIVE or ON DEMAND)

See Also:

• Constant Field Values

PLAYBACK_EVENTS

public static final List<String> PLAYBACK_EVENTS

Constructor Details

Fields

public Fields()