Event

open class Event : AbstractEvent<PropertyValueType>

Represents a single Event, that is designed to be passed down a chain of listeners.

Constructors

Event

constructor(type: String)

Creates an Event with the given type.

Properties

ACTIVITY

val ACTIVITY: String = "activity"

The key for Activity on the FRAGMENT_ATTACHED lifecycle event.

AD_ID

val AD_ID: String = "adId"

The key for ad id used in advertising events.

AD_INSIGHTS

val AD_INSIGHTS: String = "adInsights"

Key for the Ad Insights parameters map

AD_TITLE

val AD_TITLE: String = "adTitle"

The key for ad title used in advertising events.

ALIGNMENT

val ALIGNMENT: String = "alignment"

The alignment property of a CAPTION event.

ANDROID_VIEW

val ANDROID_VIEW: String = "androidView"

The event property that specifies android.view.

AUDIO_TRACKS_STATE

val AUDIO_TRACKS_STATE: String = "audioTracksState"

The key for events accessing audio tracks state.

AUDIO_VARIANT

val AUDIO_VARIANT: String = "audioVariant"

The key for the list of audio variants in AUDIO_TRACKS events.

BOOLEAN

val BOOLEAN: String = "boolean"

The key for a general boolean property.

BRIGHTCOVE_CONTROL_BAR

val BRIGHTCOVE_CONTROL_BAR: String = "brightcoveControlBar"

The event property that specifies the com.brightcove.player.mediacontroller.BrightcoveControlBar.

BRIGHTCOVE_MEDIA_CONTROLLER

val BRIGHTCOVE_MEDIA_CONTROLLER: String = "brightcoveMediaController"

The event property that specifies the com.brightcove.player.mediacontroller.BrightcoveMediaController.

BUILD_VERSION

val BUILD_VERSION: String = "buildVersion"

CAPTION_FORMAT

val CAPTION_FORMAT: String = "captionFormat"

The key containing the com.brightcove.player.captioning.BrightcoveCaptionFormat selected.

CAPTION_URI

val CAPTION_URI: String = "captionUri"

The key containing the uri for the com.brightcove.player.captioning.BrightcoveCaptionFormat selected.

CAPTIONS_STATE

val CAPTIONS_STATE: String = "captionsState"

The key for events accessing caption state.

CATALOG_URL

val CATALOG_URL: String = "catalogUrl"

The key for catalog urls used in the Analytics catalog request and response events.

CEA608_DOCUMENT

val CEA608_DOCUMENT: String = "cea608Document"

The key for events carrying CEA-608 data.

CEA708_DOCUMENT

val CEA708_DOCUMENT: String = "cea708Document"

The key for events carrying CEA-708 data.

CONFIGURATION

val CONFIGURATION: String = "configuration"

Key for Events that carry a configuration in their payload.

CUE_POINT

val CUE_POINT: String = "cue_point"

Key for Events that carry a single Cue Point.

CUE_POINTS

val CUE_POINTS: String = "cue_points"

Key for Events that carry a list of Cue Points.

CURRENT_VIDEO

val CURRENT_VIDEO: String = "currentVideo"

Video for Events that carry a current Video.

DEBUG

val DEBUG: String = "debug"

Whether components should emit additional debug information.

EMITTER

val EMITTER: String = "emitter"

The simple name of the source component for an event when running in debug mode

END_TIME

val ~~END_TIME~~: String = "endTime"

The end of the time range of a list of cue points

END_TIME_LONG

val END_TIME_LONG: String = "endTimeLong"

The end of the time range of a list of cue points

ERROR

val ERROR: String = "error"

Key for an actual exception associated with a playback error

ERROR_CODE

val ERROR_CODE: String = "errorCode"

Key for the error code sent for a non-playable source

ERROR_EXTRA

val ERROR_EXTRA: String = "errorExtra"

Key for the extra code sent during an error for non-playable source

ERROR_MESSAGE

val ERROR_MESSAGE: String = "errorMessage"

Used to transmit an error message when an error occurs

ERROR_SUBCODE

val ERROR_SUBCODE: String = "errorSubcode"

Key for the error subcode sent for a non-playable source

ERRORS

val ERRORS: String = "errors"

Key for list of error messages in a response.

EVENT_SOURCE

val EVENT_SOURCE: String = "eventSource"

Property that specifies the source class where the event originated.

FORWARD_BUFFER_SECONDS

val FORWARD_BUFFER_SECONDS: String = "forwardBufferSeconds"

The key for forward buffer seconds used in the Analytics class.

FRAGMENT

val FRAGMENT: String = "fragment"

The key for the Fragment object on FRAGMENT_ACTIVITY_CREATED event.

FROM_SEEK_POSITION

val ~~FROM_SEEK_POSITION~~: String = "fromSeekPosition"

Position from which a seek began.

FROM_SEEK_POSITION_LONG

val FROM_SEEK_POSITION_LONG: String = "fromSeekPositionLong"

Position from which a seek began.

GSC_HEARTBEAT_STOPPED_MESSAGE

val GSC_HEARTBEAT_STOPPED_MESSAGE: String = "gscHeartbeatStoppedMessage"

Key for the heartbeat stopped message

GSC_MAX_CONCURRENCY_REACHED_MESSAGE

val GSC_MAX_CONCURRENCY_REACHED_MESSAGE: String = "gscMaxConcurrencyReachedMessage"

Key for the max concurrency reached message

val ID: String = "id"

The property name of the unique identifier.

INDEX

val INDEX: String = "index"

Video for Events that carry a video index.

INSTANCE_STATE

val INSTANCE_STATE: String = "instanceState"

The key for saving and restoring instance state on a lifecycle event.

LANGUAGES

val LANGUAGES: String = "languages"

The key for the list of languages in CAPTIONS_LANGUAGES events.

LEFT_VOLUME

val LEFT_VOLUME: String = "leftVolume"

The setting of the left channel volume for a player (as float: 0.0f-1.0f inclusive).

LINE

val LINE: String = "line"

The line property of a CAPTION event.

LINE_ANCHOR

val LINE_ANCHOR: String = "lineAnchor"

The line anchor property of a CAPTION event.

LINE_TYPE

val LINE_TYPE: String = "lineType"

The line type property of a CAPTION event.

LIST

val LIST: String = "list"

The name of the property for video list.

LIVE_WINDOW_DURATION

val ~~LIVE_WINDOW_DURATION~~: String = "liveWindowDuration"

The absolute playable window duration for a live video.

LIVE_WINDOW_DURATION_LONG

val LIVE_WINDOW_DURATION_LONG: String = "liveWindowDurationLong"

The absolute playable window duration for a live video.

LOCALE_CODE

val LOCALE_CODE: String = "localeCode"

The key for events carrying a locale code for subtitle tracks.

MAX_POSITION

val ~~MAX_POSITION~~: String = "maxPosition"

The maximum position for which a seek will be successful.

MAX_POSITION_LONG

val MAX_POSITION_LONG: String = "maxPositionLong"

The maximum position for which a seek will be successful.

MEASURED_BPS

val MEASURED_BPS: String = "measuredBps"

The key for measured bps used in the Analytics class.

MEDIA_BYTES_TRANSFERRED

val MEDIA_BYTES_TRANSFERRED: String = "mediaBytesTransferred"

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

MEDIA_CONTROLLER_CONFIG

val MEDIA_CONTROLLER_CONFIG: String = "mediaControllerConfig"

MIN_POSITION

val ~~MIN_POSITION~~: String = "minPosition"

The minimum position for which a seek will be successful.

MIN_POSITION_LONG

val MIN_POSITION_LONG: String = "minPositionLong"

The minimum position for which a seek will be successful.

NEXT_VIDEO

val NEXT_VIDEO: String = "nextVideo"

Video for Events that carry a next Video.

ORIGINAL_EVENT

val ORIGINAL_EVENT: String = "original"

Original event used in situations where default behavior is prevented and the original event needs to be re-emitted.

ORIGINAL_PLAYHEAD_POSITION

val ~~ORIGINAL_PLAYHEAD_POSITION~~: String = "originalPlayheadPosition"

The unmapped current playhead position.

ORIGINAL_PLAYHEAD_POSITION_LONG

val ORIGINAL_PLAYHEAD_POSITION_LONG: String = "originalPlayheadPositionLong"

The unmapped current playhead position.

ORIGINAL_SEEK_POSITION

val ~~ORIGINAL_SEEK_POSITION~~: String = "originalSeekPosition"

The unmapped seek position.

ORIGINAL_SEEK_POSITION_LONG

val ORIGINAL_SEEK_POSITION_LONG: String = "originalSeekPositionLong"

The unmapped seek position.

PERCENT_COMPLETE

val PERCENT_COMPLETE: String = "percentComplete"

Percentage of the video that has buffered so far.

PICTURE_IN_PICTURE_STATE

val PICTURE_IN_PICTURE_STATE: String = "pictureInPictureState"

The key for events accessing Picture-in-Picture state.

PLAYBACK_LOCATION

val PLAYBACK_LOCATION: String = "playbackLocation"

The event property key that specifies the com.brightcove.player.model.PlaybackLocation.

PLAYHEAD_POSITION

val ~~PLAYHEAD_POSITION~~: String = "playheadPosition"

Current playhead position in milliseconds.

PLAYHEAD_POSITION_LONG

val PLAYHEAD_POSITION_LONG: String = "playheadPositionLong"

Current playhead position in milliseconds.

PLAYLIST

val PLAYLIST: String = "playlist"

Video for Events that carry a single Playlist.

PLUGIN_NAME

val PLUGIN_NAME: String = "pluginName"

The name of a plugin registered to the SDK.

POSITION

val POSITION: String = "position"

The position property of a CAPTION event.

POSITION_ANCHOR

val POSITION_ANCHOR: String = "positionAnchor"

The position anchor property of a CAPTION event.

PROGRESS_BAR_PLAYHEAD_POSITION

val ~~PROGRESS_BAR_PLAYHEAD_POSITION~~: String = "progressBarPlayheadPosition"

Current playhead position in milliseconds, as shown in the Progress Bar.

PROGRESS_BAR_PLAYHEAD_POSITION_LONG

val PROGRESS_BAR_PLAYHEAD_POSITION_LONG: String = "progressBarPlayheadPositionLong"

Current playhead position in milliseconds, as shown in the Progress Bar.

PROJECTION_FORMAT

val PROJECTION_FORMAT: String = "projectionFormat"

The key for the projection format sent in the Event PROJECTION_FORMAT_CHANGED.

properties

val properties: Map<String, Any>

A dynamic set of properties containing data that accompanies specific Events.

RENDITION_HEIGHT

val RENDITION_HEIGHT: String = "renditionHeight"

The key for rendition height used in the Analytics class.

RENDITION_INDICATED_BPS

val RENDITION_INDICATED_BPS: String = "renditionIndicatedBps"

The key for rendition indicated bps used in the Analytics class.

RENDITION_MIME_TYPE

val RENDITION_MIME_TYPE: String = "renditionMimeType"

The key for rendition mime type used in the Analytics class.

RENDITION_URL

val RENDITION_URL: String = "renditionUrl"

The key for rendition urls used in the Analytics class.

RENDITION_WIDTH

val RENDITION_WIDTH: String = "renditionWidth"

The key for rendition width used in the Analytics class.

REQUEST_TOKEN

val REQUEST_TOKEN: String = "requestToken"

Used by the Request/Response setup; marks the id of the listener to get the response.

REQUESTED_ORIENTATION

val REQUESTED_ORIENTATION: String = "requestedOrientation"

The key for the orientation type sent in the Event CHANGE_ORIENTATION.

RESPONSE_TIME_MS

val RESPONSE_TIME_MS: String = "responseTimeMs"

The key for response times in milliseconds used in the Analytics catalog response events.

RESTORE_SEEK_POSITION

val ~~RESTORE_SEEK_POSITION~~: String = "restoreSeekPosition"

Position to which a seek action brings the playhead, after the player has been restored.

RESTORE_SEEK_POSITION_LONG

val RESTORE_SEEK_POSITION_LONG: String = "restoreSeekPositionLong"

Position to which a seek action brings the playhead, after the player has been restored.

RIGHT_VOLUME

val RIGHT_VOLUME: String = "rightVolume"

The setting of the right channel volume for a player (as float: 0.0f-1.0f inclusive).

SEEK_CONTROLS_VISIBILITY

val SEEK_CONTROLS_VISIBILITY: String = "seekControlsVisibility"

The key for accessing a visibility map associating seek controls with visibility state from the event properties.

SEEK_DEFAULT

val ~~SEEK_DEFAULT~~: String = "seekDefault"

The setting for the default seek time.

SEEK_DEFAULT_LONG

val SEEK_DEFAULT_LONG: String = "seekDefaultLong"

The setting for the default seek time.

SEEK_ON_HOLD_UPDATE_FREQ

val SEEK_ON_HOLD_UPDATE_FREQ: String = "seekOnHoldUpdateFreq"

The setting to determine the speed we're seeking when holding down either the rewind or fast-forward button.

SEEK_ON_HOLD_WAIT_TIME

val SEEK_ON_HOLD_WAIT_TIME: String = "seekOnHoldWaitTime"

The setting to determine when the rewind or fast-forward buttons are been long-pressed and held.

SEEK_PERCENTAGE

val SEEK_PERCENTAGE: String = "seekPercentage"

The setting used if the seek relative is enabled.

SEEK_POSITION

val ~~SEEK_POSITION~~: String = "seekPosition"

Position to which a seek action brings the playhead.

SEEK_POSITION_LONG

val SEEK_POSITION_LONG: String = "seekPositionLong"

Position to which a seek action brings the playhead.

SEEK_PROGRESS

val ~~SEEK_PROGRESS~~: String = "seekProgress"

The setting that has the amount of time (milliseconds) where the seek indicator must be positioned.

SEEK_PROGRESS_LONG

val SEEK_PROGRESS_LONG: String = "seekProgressLong"

The setting that has the amount of time (milliseconds) where the seek indicator must be positioned.

SEEK_RELATIVE_ENABLED

val SEEK_RELATIVE_ENABLED: String = "seekRelativeEabled"

The setting to enable to seek relatively to the video duration and not by a fixed time.

SEGMENT_DURATION

val SEGMENT_DURATION: String = "segmentDuration"

The video segment's duration in milliseconds.

SELECTED_TRACK

val SELECTED_TRACK: String = "track"

The key for the selected track in AUDIO_TRACKS and SELECT_AUDIO_TRACK events.

SEND_VIDEO_RESUMED_ANALYTICS

val SEND_VIDEO_RESUMED_ANALYTICS: String = "sendVideoResumed"

Key for the conditional delivery of the analytics video_resumed.

SIZE

val SIZE: String = "size"

The SIZE property of a CAPTION event.

SKIP_CUE_POINTS

val SKIP_CUE_POINTS: String = "skipCuePoints"

When added as a key to PLAY/SEEK/VIDEO_COMPLETED events, cue points will be skipped

SOURCE

val SOURCE: String = "source"

Source for Events that carry a single Source.

START_TIME

val ~~START_TIME~~: String = "startTime"

The beginning of the time range of a list of cue points

START_TIME_LONG

val START_TIME_LONG: String = "startTimeLong"

The beginning of the time range of a list of cue points

STITCHED_POSITION

val STITCHED_POSITION: String = "stitchedPosition"

The stitched position.

SUPPORT_FRAGMENT

val SUPPORT_FRAGMENT: String = "supportFragment"

The key for the Support Fragment object on FRAGMENT_ACTIVITY_CREATED event.

TEXT

val TEXT: String = "text"

The text property of a CAPTION event.

TRACKS

val TRACKS: String = "tracks"

The key for the list of tracks in AUDIO_TRACKS events.

TTML_DOCUMENT

val TTML_DOCUMENT: String = "ttmlDocument"

The key for events carrying DFXP/TTML data.

UUID

val UUID: String = "uuid"

The property name of the universally unique identifier.

VALUE

val VALUE: String = "value"

VIDEO

val VIDEO: String = "video"

Video for Events that carry a single Video.

VIDEO_DURATION

val ~~VIDEO_DURATION~~: String = "duration"

The video's duration in milliseconds.

VIDEO_DURATION_LONG

val VIDEO_DURATION_LONG: String = "durationLong"

The video's duration in milliseconds.

VIDEO_HEIGHT

val VIDEO_HEIGHT: String = "height"

Height of video.

VIDEO_STILL

val VIDEO_STILL: String = "video_still"

URL for Events that carry a Video still image URL.

VIDEO_WIDTH

val VIDEO_WIDTH: String = "width"

Width of video.

VOLUME

val VOLUME: String = "volume"

The single setting volume for a player that doesn't use channels.

WEBVTT_DOCUMENT

val WEBVTT_DOCUMENT: String = "webvttDocument"

The key for events carrying WebVTT data.

Functions

getId

open fun getId(): Int

getIntegerProperty

open fun getIntegerProperty(propertyName: String): Int

Convenience method for accessing a property with an integer value

getLongProperty

open fun getLongProperty(propertyName: String): Long

Convenience method for accessing a property with an long value

getNextId

open fun getNextId(): Int

getProperties

open fun getProperties(): Map<String, Any>

getProperty

open fun getProperty(propertyName: String): PropertyValueType

open fun <T> getProperty(eventPropertyId: String, type: Class<T>): T

Returns the casted value of the eventPropertyId.

getType

open fun getType(): String

The event type, typically specified from a constant value defined in EventType.

isPrevented

open fun isPrevented(): Boolean

Indicates that a participant of the current Event activity has prevented the default behavior for the current Event.

isStopped

open fun isStopped(): Boolean

Indicates that a participant of the current Event activity has stopped the processing of any additional Events.

preventDefault

open fun preventDefault()

Causes the Event handling framework to not execute any default behavior that may be defined for a given Event.

stopPropagation

open fun stopPropagation()

Causes the Event handling framework to stop processing any additional Events.

toString

open fun toString(): String