sdk/com.brightcove.player.event/EventType

EventType

class EventType

Maintains a list of Event types that the system is aware of. New events introduced to the system should be located here.

However, because we're really just passing around strings, it's fully possible for users to create and use their own events.

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
val ACCOUNT: String = "account"
Indicates that the account has been set.
Link copied to clipboard
val ACTIVITY_CREATED: String = "activityCreated"
Indicates the activity has been created.
Link copied to clipboard
val ACTIVITY_DESTROYED: String = "activityDestroyed"
Indicates the activity has been destroyed.
Link copied to clipboard
val ACTIVITY_PAUSED: String = "activityPaused"
Indicates the activity has been paused.
Link copied to clipboard
val ACTIVITY_RESTARTED: String = "activityRestarted"
Indicates the activity has been restarted.
Link copied to clipboard
val ACTIVITY_RESUMED: String = "activityResumed"
Indicates the activity is about to save state.
Link copied to clipboard
val ACTIVITY_SAVE_INSTANCE_STATE: String = "activitySaveInstanceState"
Indicates the activity is about to save state.
Link copied to clipboard
val ACTIVITY_STARTED: String = "activityStarted"
Indicates the activity has been started.
Link copied to clipboard
val ACTIVITY_STOPPED: String = "activityStopped"
Indicates the activity has been stopped.
Link copied to clipboard
val AD_BREAK_COMPLETED: String = "adBreakCompleted"
After a plugin finishes an advertisement break, it will emit this event.
Link copied to clipboard
val AD_BREAK_STARTED: String = "adBreakStarted"
After a plugin starts an advertisement break, it will emit this event.
Link copied to clipboard
val AD_COMPLETED: String = "adCompleted"
After a plugin finishes an advertisement, it will emit this event.
Link copied to clipboard
val AD_ERROR: String = "adError"
When a plugin encounters an error while playing an advertisement, it will emit this event.
Link copied to clipboard
val AD_PAUSED: String = "adPaused"
After a plugin pauses an advertisement, it will emit this event.
Link copied to clipboard
val AD_PROGRESS: String = "adProgress"
As a plugin plays an advertisement, it will emit this event periodically.
Link copied to clipboard
val AD_RESUMED: String = "adResumed"
After a plugin resumes an advertisement, it will emit this event.
Link copied to clipboard
val AD_STARTED: String = "adStarted"
After a plugin starts an advertisement, it will emit this event.
Link copied to clipboard
val AD_VIEWABLE_IMPRESSION: String = "adViewableImpression"
When the ad has been shown to the user for at least two seconds and is visible on the screen.
Link copied to clipboard
val ADD_ANALYTICS_BASE_PARAMS: String = "addAnalyticsBaseParams"
Indicates additional base parameters for the Analytics component are available.
Link copied to clipboard
val ANALYTICS_CATALOG_REQUEST: String = "analyticsCatalogRequest"
Indicates that a catalog request has been made.
Link copied to clipboard
val ANALYTICS_CATALOG_RESPONSE: String = "analyticsCatalogResponse"
Indicates that a catalog response was received.
Link copied to clipboard
val ANALYTICS_METRICS_REQUEST: String = "analyticsMetricsRequest"
Indicates that an Analytics metrics request was sent.
Link copied to clipboard
val ANALYTICS_VIDEO_ENGAGEMENT: String = "analyticsVideoEngagement"
Indicates that video_engagement event data was received.
Link copied to clipboard
val ANY: String = "*"
ANY is a special event in that the Default Implementation of EventEmitter will process all listeners for ANY before every event.
Link copied to clipboard
val AUDIO_TRACKS: String = "audioTracks"
Indicates that there is at least one audio track for the user to choose from.
Link copied to clipboard
val AUDIO_TRACKS_DIALOG_OK: String = "audioTracksDialogOk"
Indications the audio tracks dialog ok button has been pressed.
Link copied to clipboard
val AUDIO_TRACKS_DIALOG_SETTINGS: String = "audioTracksDialogSettings"
Indications the audio tracks dialog settings button has been pressed.
Link copied to clipboard
val BUFFERED_UPDATE: String = "bufferedUpdate"
As a progressive download video is downloaded, the VideoDisplayComponent will emit updates indicating how much of the video has been buffered.
Link copied to clipboard
val BUFFERING_COMPLETED: String = "bufferingCompleted"
Indicates that a player has finished buffering content.
Link copied to clipboard
val BUFFERING_STARTED: String = "bufferingStarted"
Indicates that a player has started buffering content.
Link copied to clipboard
val BUMPER_COMPLETED: String = "bumperCompleted"
Indicates that bumper playback has completed
Link copied to clipboard
val BUMPER_DID_PLAY: String = "bumperDidPlay"
Indicates that bumper playback has started
Link copied to clipboard
val BUMPER_DID_SET_VIDEO: String = "bumperDidSetVideo"
Indicates the bumper video has been set.
Link copied to clipboard
val BUMPER_ERROR: String = "bumperError"
Indicates that a bumper error has been found.
Link copied to clipboard
val BUMPER_PLAY: String = "bumperPlay"
Indicates bumper playback should begin.
Link copied to clipboard
val CAPTION: String = "caption"
Indicates that a caption should be rendered.
Link copied to clipboard
val CAPTIONS_AVAILABLE: String = "captionsAvailable"
Indicates that closed captioning information is available for use.
Link copied to clipboard
val CAPTIONS_DIALOG_OK: String = "captionsDialogOk"
Indications the captions dialog ok button has been pressed.
Link copied to clipboard
val CAPTIONS_DIALOG_SETTINGS: String = "captionsDialogSettings"
Indications the captions dialog settings button has been pressed.
Link copied to clipboard
val CAPTIONS_LANGUAGES: String = "captionsLanguages"
Indicates that there is at least one caption language for the user to choose from.
Link copied to clipboard
val CHANGE_ORIENTATION: String = "changeOrientation"
The player is requesting orientation change
Link copied to clipboard
val CLOSED_CAPTIONING_ERROR: String = "closedCaptioningError"
Indicates that there was an error processing closed captioning information.
Link copied to clipboard
val COMPLETED: String = "completed"
Indicates video playback has completed (i.e., played entire media).
Link copied to clipboard
val CONFIGURATION_CHANGED: String = "configurationChanged"
Indicates that a configuration change has occurred in the Activity.
Link copied to clipboard
val CUE_POINT: String = "cuePoint"
Indicates a cue point has been fired at a specific time position.
Link copied to clipboard
val DEBUG: String = "debug"
Indicates debug logging should be enabled or disabled
Link copied to clipboard
val DID_CHANGE_LIST: String = "didChangeList"
Indicates that the list of videos changed.
Link copied to clipboard
val DID_ENTER_FULL_SCREEN: String = "didEnterFullScreen"
The player entered full screen.
Link copied to clipboard
val DID_ENTER_PICTURE_IN_PICTURE_MODE: String = "didEnterPictureInPictureMode"
The player entered Picture-in-Picture mode.
Link copied to clipboard
val DID_EXIT_FULL_SCREEN: String = "didExitFullScreen"
The player exited full screen.
Link copied to clipboard
val DID_EXIT_PICTURE_IN_PICTURE_MODE: String = "didExitPictureInPictureMode"
The player exited Picture-in-Picture mode.
Link copied to clipboard
val DID_FAST_FORWARD: String = "didFastForward"
Indicates a fast forward operation should begin.
Link copied to clipboard
val DID_GO_LIVE: String = "didGoLive"
Indicates that the video has gone live.
Link copied to clipboard
val DID_INTERRUPT_CONTENT: String = "didInterruptContent"
Indicates that content was interrupted.
Link copied to clipboard
val DID_LOAD_CLOSED_CAPTIONS: String = "didLoadClosedCaptions"
Indicates that a closed captioning document has been loaded.
Link copied to clipboard
val DID_PAUSE: String = "didPause"
Indicates playback just stopped, in response to PAUSE.
Link copied to clipboard
val DID_PLAY: String = "didPlay"
Indicates playback just began, in response to PLAY.
Link copied to clipboard
val DID_REMOVE_VIDEO_STILL: String = "didRemoveVideoStill"
Indicates a Video Still image has been successfully removed.
Link copied to clipboard
val DID_RESUME_CONTENT: String = "didResumeContent"
Indicates that content was resumed.
Link copied to clipboard
val DID_REWIND: String = "didRewind"
Indicates a rewind operation has completed.
Link copied to clipboard
val DID_SEEK_TO: String = "didSeekTo"
Indicates a previously requested seek action completed, in response to SEEK_TO.
Link copied to clipboard
val DID_SELECT_SOURCE: String = "didSelectSource"
Indicates a Source rendition was selected, in response to SELECT_SOURCE.
Link copied to clipboard
val DID_SET_ANALYTICS_BASE_PARAMS: String = "didSetAnalyticsBaseParams"
Indicates that the Analytics component received base parameter changes and has applied them
Link copied to clipboard
val DID_SET_SOURCE: String = "didSetSource"
Indicates a Source has been successfully loaded, in response to SET_SOURCE.
Link copied to clipboard
val DID_SET_VIDEO: String = "didSetVideo"
Indicates a Video loaded successfully, in response to SET_VIDEO.
Link copied to clipboard
val DID_SET_VIDEO_STILL: String = "didSetVideoStill"
Indicates a Video Still image has been successfully loaded, in response to SET_VIDEO_STILL.
Link copied to clipboard
val DID_SET_VIDEO_STILL_ERROR: String = "didSetVideoStillError"
Indicates a Video Still image has NOT been successfully loaded, in response to SET_VIDEO_STILL.
Link copied to clipboard
val DID_STOP: String = "didStop"
Indicates playback just stopped, in response to STOP.
Link copied to clipboard
val ENTER_FULL_SCREEN: String = "enterFullScreen"
The player will enter full screen mode.
Link copied to clipboard
val ENTER_PICTURE_IN_PICTURE_MODE: String = "enterPictureInPictureMode"
The player will enter Picture-in-Picture mode.
Link copied to clipboard
val ENTER_TV_MODE: String = "enterTvMode"
The player will enter tv mode.
Link copied to clipboard
val ENTERED_VR_MODE: String = "enteredVrMode"
The player has entered Google VR mode.
Link copied to clipboard
val ERROR: String = "error"
Indicates an error occurred in a component in the course of processing an earlier event.
Link copied to clipboard
val EXIT_FULL_SCREEN: String = "exitFullScreen"
The player will exit full screen mode.
Link copied to clipboard
val EXIT_PICTURE_IN_PICTURE_MODE: String = "exitPictureInPictureMode"
The player will exit Picture-in-Picture mode.
Link copied to clipboard
val EXITED_VR_MODE: String = "exitedVrMode"
The player has exited Google VR mode.
Link copied to clipboard
val FAST_FORWARD: String = "fastForward"
Indicates a fast forward operation should begin.
Link copied to clipboard
val FIND_PLAYLIST: String = "findPlaylist"
Request to find a playlist via the Catalog.
Link copied to clipboard
val FIND_VIDEO: String = "findVideo"
Request to find a video via the Catalog.
Link copied to clipboard
val FRAGMENT_ACTIVITY_CREATED: String = "fragmentActivityCreated"
Link copied to clipboard
val FRAGMENT_CREATED_VIEW: String = "fragmentCreatedView"
Link copied to clipboard
val FRAGMENT_DESTROYED: String = "fragmentDestroyed"
Link copied to clipboard
val FRAGMENT_DESTROYED_VIEW: String = "fragmentDestroyedView"
Link copied to clipboard
val FRAGMENT_DETACHED: String = "fragmentDetached"
Link copied to clipboard
val FRAGMENT_PAUSED: String = "fragmentPaused"
Link copied to clipboard
val FRAGMENT_RESUMED: String = "fragmentResumed"
Link copied to clipboard
val FRAGMENT_SAVE_INSTANCE_STATE: String = "fragmentSaveInstanceState"
Link copied to clipboard
val FRAGMENT_STARTED: String = "fragmentStarted"
Link copied to clipboard
val FRAGMENT_STOPPED: String = "fragmentStopped"
Link copied to clipboard
val FRAGMENT_VIEW_STATE_RESTORED: String = "fragmentViewStateRestored"
Link copied to clipboard
val GO_LIVE: String = "goLive"
Indicates that the video should go to the live position.
Link copied to clipboard
val GSC_ERROR: String = "gscError"
Indicates that generic stream concurrency error has been found.
Link copied to clipboard
val GSC_HEARTBEAT_STOPPED: String = "gscHeartbeatStopped"
Indicates that generic stream concurrency heartbeat has been stopped.
Link copied to clipboard
val GSC_MAX_CONCURRENCY_REACHED: String = "gscMaxConcurrencyReached"
Indicates that generic stream concurrency has reached the max of devices allowed to playback content.
Link copied to clipboard
val HIDE_PLAYER_OPTIONS: String = "hidePlayerOptions"
The player will hide the player extra options as audio tracks and captions.
Link copied to clipboard
val HIDE_SEEK_CONTROLS: String = "hideSeekControls"
Hide the player controls
Link copied to clipboard
val ODRM_LICENSE_ACQUIRED: String = "odrmLicenseAcquired"
This event will be fired when an offline playback license was successfully acquired.
Link copied to clipboard
val ODRM_LICENSE_ERROR: String = "odrmLicenseError"
This event will be fired when an offline playback license could not be acquired because of an error that occurred during the license retrieval process.
Link copied to clipboard
val ODRM_LICENSE_NOT_AVAILABLE: String = "odrmLicenseNotAvailable"
This event will be fired when an offline playback license was not provided by the license server.
Link copied to clipboard
val ODRM_LICENSE_RELEASED: String = "odrmLicenseReleased"
This event will be fired when an offline playback license was successfully released.
Link copied to clipboard
val ODRM_LICENSE_RENEWED: String = "odrmLicenseRenewed"
This event will be fired when an offline playback license was successfully renewed.
Link copied to clipboard
val ODRM_PLAYBACK_NOT_ALLOWED: String = "odrmPlaybackNotAllowed"
This event will be fired when download is requested for a video that is not eligible for offline playback.
Link copied to clipboard
val ODRM_SOURCE_NOT_FOUND: String = "odrmSourceNotFound"
This event will be fired when download is requested for a video that does not include any com.brightcove.player.model.Source suitable of offline playback.
Link copied to clipboard
val ON_FRAME_AVAILABLE: String = "on360FrameAvailable"
This event is sent when the frame to draw a 360 video is available
Link copied to clipboard
val PAUSE: String = "pause"
Indicates playback should be paused.
Link copied to clipboard
val PLAY: String = "play"
Indicates playback should begin.
Link copied to clipboard
val PREBUFFER_NEXT_VIDEO: String = "prebufferNextVideo"
Indicates the video specified by the source property should be prepared to play next.
Link copied to clipboard
val PROGRESS: String = "progress"
As a player plays a video, it will emit progress events.
Link copied to clipboard
val PROJECTION_FORMAT_CHANGED: String = "projectionFormatChanged"
The player has changed the projection format for the video player
Link copied to clipboard
val READY_TO_PLAY: String = "readyToPlay"
Indicates the VideoDisplayComponent is ready to receive video content.
Link copied to clipboard
val REGISTER_PLUGIN: String = "registerPlugin"
Indicates that a plugin is ready to be registered
Link copied to clipboard
val REMOVE_CUE_POINT: String = "removeCuePoint"
Removes a cue point.
Link copied to clipboard
val REMOVE_VIDEO_STILL: String = "removeVideoStill"
Indicates a Video Still image will be removed and hidden from any component that makes use of one.
Link copied to clipboard
val RESPONSE: String = "response"
RESPONSE is a special event; EventEmitter implementations will use this to indicate an event that is a direct response to a previous event, issued by EventEmitter.request().
Link copied to clipboard
val RESTORE_DEFAULT_MEDIA_CONTROLLER: String = "restoreDefaultMediaController"
Restores the default com.brightcove.player.mediacontroller.BrightcoveMediaController values.
Link copied to clipboard
val RESUME_FROM_CAST_SESSION: String = "resumeFromCastSession"
Indicates that the player should resume from a cast session.
Link copied to clipboard
val REWIND: String = "rewind"
Indicates a rewind operation should begin.
Link copied to clipboard
val SEEK_CONTROLLER_CONFIGURATION: String = "seekControllerConfiguration"
Configure the Rewind and Fast-forward buttons.
Link copied to clipboard
val SEEK_TO: String = "seekTo"
Instructs player to seek to a specific position on the timeline.
Link copied to clipboard
val SEEK_TO_INCORRECT_TARGET_VALUE: String = "seekToIncorrectTargetValue"
Indicates an incorrect target value was used to do a seek.
Link copied to clipboard
val SEEKBAR_DRAGGING_PROGRESS: String = "seekbarDraggingProgress"
Starts dragging the seek bar by sending the SEEK_PROGRESS_LONG property.
Link copied to clipboard
val SEEKBAR_DRAGGING_START: String = "seekbarDraggingStart"
Starts dragging the seek bar
Link copied to clipboard
val SEEKBAR_DRAGGING_STOP: String = "seekbarDraggingStop"
Stops dragging the seek bar
Link copied to clipboard
val SELECT_AUDIO_TRACK: String = "selectAudioTrack"
Indicates that a certain audio track should be selected.
Link copied to clipboard
val SELECT_CLOSED_CAPTION_TRACK: String = "selectClosedCaptionTrack"
Indicates that a closed caption track has been selected
Link copied to clipboard
val SELECT_SOURCE: String = "selectSource"
Indicates any SourceSelector components should select a Source rendition.
Link copied to clipboard
val SET_ANALYTICS_BASE_PARAMS: String = "setAnalyticsBaseParams"
Indicates that base parameters for the Analytics component are available
Link copied to clipboard
val SET_CAPTIONS_STATE: String = "setCaptionsState"
Indicates that the caption state has been set to enabled or disabled.
Link copied to clipboard
val SET_CUE_POINT: String = "setCuePoint"
Adds a cue point.
Link copied to clipboard
val SET_CUE_POINTS: String = "setCuePoints"
Replaces the current cue points with a new list of cue points.
Link copied to clipboard
Link copied to clipboard
val SET_SOURCE: String = "setSource"
Indicates a Source is available for any component that requires a Source to function.
Link copied to clipboard
val SET_VIDEO: String = "setVideo"
Indicates a Video is available for any component that can use one.
Link copied to clipboard
val SET_VIDEO_STILL: String = "setVideoStill"
Indicates a Video Still image is available for any component that makes use of one.
Link copied to clipboard
val SET_VOLUME: String = "setVolume"
Set the player volume
Link copied to clipboard
val SHOW_PLAYER_OPTIONS: String = "showPlayerOptions"
The player will show the player extra options as audio tracks and captions.
Link copied to clipboard
val SHOW_SEEK_CONTROLS: String = "showSeekControls"
Show the player controls
Link copied to clipboard
val SOURCE_NOT_FOUND: String = "sourceNotFound"
Indicates a Source rendition was not found, in response to SELECT_SOURCE.
Link copied to clipboard
val SOURCE_NOT_PLAYABLE: String = "sourceNotPlayable"
Indicates a Source is not playable by the current player.
Link copied to clipboard
val STOP: String = "stop"
Indicates the current media will not be played any more and that resources related to the current media should be released.
Link copied to clipboard
val TEST: String = "test"
Link copied to clipboard
val TOGGLE_CLOSED_CAPTIONS: String = "toggleClosedCaptions"
Indicates the toggling of closed captions between on and off (view-wise).
Link copied to clipboard
val VERSION: String = "version"
The player version string.
Link copied to clipboard
val VIDEO_DOWNLOAD_CANCELLED: String = "videoDownloadCancelled"
This event will be fired when a Video download is successfully cancelled.
Link copied to clipboard
val VIDEO_DOWNLOAD_COMPLETED: String = "videoDownloadCompleted"
This event will be fired when a Video download is successfully completed.
Link copied to clipboard
val VIDEO_DOWNLOAD_FAILED: String = "videoDownloadFailed"
This event will be fired when a Video download fails.
Link copied to clipboard
val VIDEO_DOWNLOAD_STARTED: String = "videoDownloadStarted"
This event will be fired when a request to download a Video has started.
Link copied to clipboard
val VIDEO_DURATION_CHANGED: String = "videoDurationChanged"
Indicates that a video's duration has changed.
Link copied to clipboard
val VIDEO_SIZE_KNOWN: String = "videoSizeKnown"
Once a player discovers the video size, it should emit the dimensions so that the view can adjust.
Link copied to clipboard
val VOLUME_CHANGE: String = "volumeChange"
The player volume changed.
Link copied to clipboard
val WILL_CHANGE_VIDEO: String = "willChangeVideo"
Indicates the current video will change to the next video in the list.
Link copied to clipboard
val WILL_INTERRUPT_CONTENT: String = "willInterruptContent"
Indicates that content will be interrupted.
Link copied to clipboard
val WILL_RESUME_CONTENT: String = "willResumeContent"
Indicates that content will be resumed.