Package com.brightcove.player.event

Class EventType

java.lang.Object
com.brightcove.player.event.EventType
public final class EventType extends Object
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.

  • Field Details

    • ANY

      public static final String ANY
      ANY is a special event in that the Default Implementation of EventEmitter will process all listeners for ANY before every event. Be careful with this one.
      See Also:

    • RESPONSE

      public static final 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().
      See Also:

    • ODRM_PLAYBACK_NOT_ALLOWED

      public static final String ODRM_PLAYBACK_NOT_ALLOWED
      This event will be fired when download is requested for a video that is not eligible for offline playback. Please use Video.isOfflinePlaybackAllowed() to check if video is eligible for offline playback. The event property AbstractEvent.VIDEO will point the Video.
      See Also:

    • ODRM_SOURCE_NOT_FOUND

      public static final String ODRM_SOURCE_NOT_FOUND
      This event will be fired when download is requested for a video that does not include any Source suitable of offline playback. The event property AbstractEvent.VIDEO will point to the Video.
      See Also:

    • ODRM_LICENSE_NOT_AVAILABLE

      public static final String ODRM_LICENSE_NOT_AVAILABLE
      This event will be fired when an offline playback license was not provided by the license server. The event property AbstractEvent.VIDEO will point to the Video.
      See Also:

    • ODRM_LICENSE_ERROR

      public static final String ODRM_LICENSE_ERROR
      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. The event property AbstractEvent.VIDEO will point to the Video. Please inspect the property AbstractEvent.ERROR for the actual cause of the failure.
      See Also:

    • ODRM_LICENSE_ACQUIRED

      public static final String ODRM_LICENSE_ACQUIRED
      This event will be fired when an offline playback license was successfully acquired. The event property AbstractEvent.VIDEO will point to the Video.
      See Also:

    • ODRM_LICENSE_RENEWED

      public static final String ODRM_LICENSE_RENEWED
      This event will be fired when an offline playback license was successfully renewed. The event property AbstractEvent.VIDEO will point to the Video.
      See Also:

    • ODRM_LICENSE_RELEASED

      public static final String ODRM_LICENSE_RELEASED
      This event will be fired when an offline playback license was successfully released. The event property AbstractEvent.VIDEO will point to the Video.
      See Also:

    • VIDEO_DOWNLOAD_STARTED

      public static final String VIDEO_DOWNLOAD_STARTED
      This event will be fired when a request to download a Video has started.
      See Also:

    • VIDEO_DOWNLOAD_COMPLETED

      public static final String VIDEO_DOWNLOAD_COMPLETED
      This event will be fired when a Video download is successfully completed.
      See Also:

    • VIDEO_DOWNLOAD_CANCELLED

      public static final String VIDEO_DOWNLOAD_CANCELLED
      This event will be fired when a Video download is successfully cancelled.
      See Also:

    • VIDEO_DOWNLOAD_FAILED

      public static final String VIDEO_DOWNLOAD_FAILED
      This event will be fired when a Video download fails.
      See Also:

    • PLAY

      public static final String PLAY
      Indicates playback should begin.
      See Also:

    • DID_PLAY

      public static final String DID_PLAY
      Indicates playback just began, in response to PLAY.
      See Also:

    • PAUSE

      public static final String PAUSE
      Indicates playback should be paused.
      See Also:

    • DID_PAUSE

      public static final String DID_PAUSE
      Indicates playback just stopped, in response to PAUSE.
      See Also:

    • STOP

      public static final String STOP
      Indicates the current media will not be played any more and that resources related to the current media should be released.
      See Also:

    • DID_STOP

      public static final String DID_STOP
      Indicates playback just stopped, in response to STOP.
      See Also:

    • REWIND

      public static final String REWIND
      Indicates a rewind operation should begin.
      See Also:

    • DID_REWIND

      public static final String DID_REWIND
      Indicates a rewind operation has completed.
      See Also:

    • FAST_FORWARD

      public static final String FAST_FORWARD
      Indicates a fast forward operation should begin.
      See Also:

    • DID_FAST_FORWARD

      public static final String DID_FAST_FORWARD
      Indicates a fast forward operation should begin.
      See Also:

    • COMPLETED

      public static final String COMPLETED
      Indicates video playback has completed (i.e., played entire media).
      See Also:

    • SEEK_TO

      public static final String SEEK_TO
      Instructs player to seek to a specific position on the timeline.
      See Also:

    • DID_SEEK_TO

      public static final String DID_SEEK_TO
      Indicates a previously requested seek action completed, in response to SEEK_TO.
      See Also:

    • SEEK_TO_INCORRECT_TARGET_VALUE

      public static final String SEEK_TO_INCORRECT_TARGET_VALUE
      Indicates an incorrect target value was used to do a seek.
      See Also:

    • PROGRESS

      public static final String PROGRESS
      As a player plays a video, it will emit progress events.
      See Also:

    • AD_BREAK_STARTED

      public static final String AD_BREAK_STARTED
      After a plugin starts an advertisement break, it will emit this event.
      See Also:

    • AD_STARTED

      public static final String AD_STARTED
      After a plugin starts an advertisement, it will emit this event.
      See Also:

    • AD_PAUSED

      public static final String AD_PAUSED
      After a plugin pauses an advertisement, it will emit this event.
      See Also:

    • AD_RESUMED

      public static final String AD_RESUMED
      After a plugin resumes an advertisement, it will emit this event.
      See Also:

    • AD_PROGRESS

      public static final String AD_PROGRESS
      As a plugin plays an advertisement, it will emit this event periodically.
      See Also:

    • AD_COMPLETED

      public static final String AD_COMPLETED
      After a plugin finishes an advertisement, it will emit this event.
      See Also:

    • AD_BREAK_COMPLETED

      public static final String AD_BREAK_COMPLETED
      After a plugin finishes an advertisement break, it will emit this event.
      See Also:

    • AD_ERROR

      public static final String AD_ERROR
      When a plugin encounters an error while playing an advertisement, it will emit this event.
      See Also:

    • AD_VIEWABLE_IMPRESSION

      public static final String AD_VIEWABLE_IMPRESSION
      When the ad has been shown to the user for at least two seconds and is visible on the screen.
      See Also:

    • FIND_VIDEO

      public static final String FIND_VIDEO
      Request to find a video via the Catalog.
      See Also:

    • FIND_PLAYLIST

      public static final String FIND_PLAYLIST
      Request to find a playlist via the Catalog.
      See Also:

    • ACTIVITY_CREATED

      public static final String ACTIVITY_CREATED
      Indicates the activity has been created.
      See Also:

    • ACTIVITY_DESTROYED

      public static final String ACTIVITY_DESTROYED
      Indicates the activity has been destroyed.
      See Also:

    • ACTIVITY_PAUSED

      public static final String ACTIVITY_PAUSED
      Indicates the activity has been paused.
      See Also:

    • ACTIVITY_RESTARTED

      public static final String ACTIVITY_RESTARTED
      Indicates the activity has been restarted.
      See Also:

    • ACTIVITY_RESUMED

      public static final String ACTIVITY_RESUMED
      Indicates the activity is about to save state.
      See Also:

    • ACTIVITY_SAVE_INSTANCE_STATE

      public static final String ACTIVITY_SAVE_INSTANCE_STATE
      Indicates the activity is about to save state.
      See Also:

    • ACTIVITY_STARTED

      public static final String ACTIVITY_STARTED
      Indicates the activity has been started.
      See Also:

    • ACTIVITY_STOPPED

      public static final String ACTIVITY_STOPPED
      Indicates the activity has been stopped.
      See Also:

    • CONFIGURATION_CHANGED

      public static final String CONFIGURATION_CHANGED
      Indicates that a configuration change has occurred in the Activity.
      See Also:

    • FRAGMENT_ACTIVITY_CREATED

      public static final String FRAGMENT_ACTIVITY_CREATED
      See Also:

    • FRAGMENT_CREATED_VIEW

      public static final String FRAGMENT_CREATED_VIEW
      See Also:

    • FRAGMENT_DESTROYED

      public static final String FRAGMENT_DESTROYED
      See Also:

    • FRAGMENT_DESTROYED_VIEW

      public static final String FRAGMENT_DESTROYED_VIEW
      See Also:

    • FRAGMENT_DETACHED

      public static final String FRAGMENT_DETACHED
      See Also:

    • FRAGMENT_PAUSED

      public static final String FRAGMENT_PAUSED
      See Also:

    • FRAGMENT_RESUMED

      public static final String FRAGMENT_RESUMED
      See Also:

    • FRAGMENT_SAVE_INSTANCE_STATE

      public static final String FRAGMENT_SAVE_INSTANCE_STATE
      See Also:

    • FRAGMENT_STARTED

      public static final String FRAGMENT_STARTED
      See Also:

    • FRAGMENT_STOPPED

      public static final String FRAGMENT_STOPPED
      See Also:

    • FRAGMENT_VIEW_STATE_RESTORED

      public static final String FRAGMENT_VIEW_STATE_RESTORED
      See Also:

    • READY_TO_PLAY

      public static final String READY_TO_PLAY
      Indicates the VideoDisplayComponent is ready to receive video content.
      See Also:

    • SET_VIDEO

      public static final String SET_VIDEO
      Indicates a Video is available for any component that can use one.
      See Also:

    • DID_SET_VIDEO

      public static final String DID_SET_VIDEO
      Indicates a Video loaded successfully, in response to SET_VIDEO.
      See Also:

    • SELECT_SOURCE

      public static final String SELECT_SOURCE
      Indicates any SourceSelector components should select a Source rendition.
      See Also:

    • DID_SELECT_SOURCE

      public static final String DID_SELECT_SOURCE
      Indicates a Source rendition was selected, in response to SELECT_SOURCE.
      See Also:

    • SOURCE_NOT_FOUND

      public static final String SOURCE_NOT_FOUND
      Indicates a Source rendition was not found, in response to SELECT_SOURCE.
      See Also:

    • SET_SOURCE

      public static final String SET_SOURCE
      Indicates a Source is available for any component that requires a Source to function.
      See Also:

    • DID_SET_SOURCE

      public static final String DID_SET_SOURCE
      Indicates a Source has been successfully loaded, in response to SET_SOURCE.
      See Also:

    • SET_VIDEO_STILL

      public static final String SET_VIDEO_STILL
      Indicates a Video Still image is available for any component that makes use of one.
      See Also:

    • DID_SET_VIDEO_STILL

      public static final String DID_SET_VIDEO_STILL
      Indicates a Video Still image has been successfully loaded, in response to SET_VIDEO_STILL.
      See Also:

    • DID_SET_VIDEO_STILL_ERROR

      public static final String DID_SET_VIDEO_STILL_ERROR
      Indicates a Video Still image has NOT been successfully loaded, in response to SET_VIDEO_STILL.
      See Also:

    • REMOVE_VIDEO_STILL

      public static final String REMOVE_VIDEO_STILL
      Indicates a Video Still image will be removed and hidden from any component that makes use of one.
      See Also:

    • DID_REMOVE_VIDEO_STILL

      public static final String DID_REMOVE_VIDEO_STILL
      Indicates a Video Still image has been successfully removed. The VideoStillDisplayComponent reacts to different events to remove it automatically, but you can call REMOVE_VIDEO_STILL at any point to do it.
      See Also:

    • BUFFERED_UPDATE

      public static final String BUFFERED_UPDATE
      As a progressive download video is downloaded, the VideoDisplayComponent will emit updates indicating how much of the video has been buffered.
      See Also:

    • VIDEO_SIZE_KNOWN

      public static final String VIDEO_SIZE_KNOWN
      Once a player discovers the video size, it should emit the dimensions so that the view can adjust. Required params: Event.VIDEO_HEIGHT and Event.VIDEO_WIDTH
      See Also:

    • VIDEO_DURATION_CHANGED

      public static final String VIDEO_DURATION_CHANGED
      Indicates that a video's duration has changed.
      See Also:

    • BUFFERING_STARTED

      public static final String BUFFERING_STARTED
      Indicates that a player has started buffering content.
      See Also:

    • BUFFERING_COMPLETED

      public static final String BUFFERING_COMPLETED
      Indicates that a player has finished buffering content.
      See Also:

    • RESUME_FROM_CAST_SESSION

      public static final String RESUME_FROM_CAST_SESSION
      Indicates that the player should resume from a cast session.
      See Also:

    • CUE_POINT

      public static final String CUE_POINT
      Indicates a cue point has been fired at a specific time position.
      See Also:

    • REMOVE_CUE_POINT

      public static final String REMOVE_CUE_POINT
      Removes a cue point. Expects a CuePoint object specified in the Event using the key below.
      See Also:

    • SET_CUE_POINT

      public static final String SET_CUE_POINT
      Adds a cue point. Expects a CuePoint object specified in the Event using the key below.
      See Also:

    • SET_CUE_POINTS

      public static final String SET_CUE_POINTS
      Replaces the current cue points with a new list of cue points. Expects a List of CuePoint objects specified in the Event using the key below.
      See Also:

    • WILL_INTERRUPT_CONTENT

      public static final String WILL_INTERRUPT_CONTENT
      Indicates that content will be interrupted.
      See Also:

    • DID_INTERRUPT_CONTENT

      public static final String DID_INTERRUPT_CONTENT
      Indicates that content was interrupted.
      See Also:

    • WILL_RESUME_CONTENT

      public static final String WILL_RESUME_CONTENT
      Indicates that content will be resumed.
      See Also:

    • DID_RESUME_CONTENT

      public static final String DID_RESUME_CONTENT
      Indicates that content was resumed.
      See Also:

    • ERROR

      public static final String ERROR
      Indicates an error occurred in a component in the course of processing an earlier event.
      See Also:

    • SOURCE_NOT_PLAYABLE

      public static final String SOURCE_NOT_PLAYABLE
      Indicates a Source is not playable by the current player.
      See Also:

    • TEST

      public static final String TEST
      See Also:

    • DEBUG

      public static final String DEBUG
      Indicates debug logging should be enabled or disabled
      See Also:

    • DID_CHANGE_LIST

      public static final String DID_CHANGE_LIST
      Indicates that the list of videos changed.
      See Also:

    • WILL_CHANGE_VIDEO

      public static final String WILL_CHANGE_VIDEO
      Indicates the current video will change to the next video in the list.
      See Also:

    • PREBUFFER_NEXT_VIDEO

      public static final String PREBUFFER_NEXT_VIDEO
      Indicates the video specified by the source property should be prepared to play next.
      See Also:

    • ADD_ANALYTICS_BASE_PARAMS

      public static final String ADD_ANALYTICS_BASE_PARAMS
      Indicates additional base parameters for the Analytics component are available. Null values will be removed and not be sent.
      See Also:

    • SET_ANALYTICS_BASE_PARAMS

      public static final String SET_ANALYTICS_BASE_PARAMS
      Indicates that base parameters for the Analytics component are available
      See Also:

    • DID_SET_ANALYTICS_BASE_PARAMS

      public static final String DID_SET_ANALYTICS_BASE_PARAMS
      Indicates that the Analytics component received base parameter changes and has applied them
      See Also:

    • ACCOUNT

      public static final String ACCOUNT
      Indicates that the account has been set.
      See Also:

    • ANALYTICS_CATALOG_REQUEST

      public static final String ANALYTICS_CATALOG_REQUEST
      Indicates that a catalog request has been made.
      See Also:

    • ANALYTICS_CATALOG_RESPONSE

      public static final String ANALYTICS_CATALOG_RESPONSE
      Indicates that a catalog response was received.
      See Also:

    • ANALYTICS_VIDEO_ENGAGEMENT

      public static final String ANALYTICS_VIDEO_ENGAGEMENT
      Indicates that video_engagement event data was received.
      See Also:

    • ANALYTICS_METRICS_REQUEST

      public static final String ANALYTICS_METRICS_REQUEST
      Indicates that an Analytics metrics request was sent.
      See Also:

    • REGISTER_PLUGIN

      public static final String REGISTER_PLUGIN
      Indicates that a plugin is ready to be registered
      See Also:

    • SET_VOLUME

      public static final String SET_VOLUME
      Set the player volume
      See Also:

    • VOLUME_CHANGE

      public static final String VOLUME_CHANGE
      The player volume changed.
      See Also:

    • HIDE_SEEK_CONTROLS

      public static final String HIDE_SEEK_CONTROLS
      Hide the player controls
      See Also:

    • SHOW_SEEK_CONTROLS

      public static final String SHOW_SEEK_CONTROLS
      Show the player controls
      See Also:

    • VERSION

      public static final String VERSION
      The player version string.
      See Also:

    • DID_ENTER_FULL_SCREEN

      public static final String DID_ENTER_FULL_SCREEN
      The player entered full screen.
      See Also:

    • DID_EXIT_FULL_SCREEN

      public static final String DID_EXIT_FULL_SCREEN
      The player exited full screen.
      See Also:

    • ENTER_FULL_SCREEN

      public static final String ENTER_FULL_SCREEN
      The player will enter full screen mode.
      See Also:

    • EXIT_FULL_SCREEN

      public static final String EXIT_FULL_SCREEN
      The player will exit full screen mode.
      See Also:

    • ENTERED_VR_MODE

      public static final String ENTERED_VR_MODE
      The player has entered Google VR mode.
      See Also:

    • EXITED_VR_MODE

      public static final String EXITED_VR_MODE
      The player has exited Google VR mode.
      See Also:

    • ENTER_TV_MODE

      public static final String ENTER_TV_MODE
      The player will enter tv mode.
      See Also:

    • SHOW_PLAYER_OPTIONS

      public static final String SHOW_PLAYER_OPTIONS
      The player will show the player extra options as audio tracks and captions.
      See Also:

    • HIDE_PLAYER_OPTIONS

      public static final String HIDE_PLAYER_OPTIONS
      The player will hide the player extra options as audio tracks and captions.
      See Also:

    • ENTER_PICTURE_IN_PICTURE_MODE

      public static final String ENTER_PICTURE_IN_PICTURE_MODE
      The player will enter Picture-in-Picture mode.
      See Also:

    • EXIT_PICTURE_IN_PICTURE_MODE

      public static final String EXIT_PICTURE_IN_PICTURE_MODE
      The player will exit Picture-in-Picture mode.
      See Also:

    • DID_ENTER_PICTURE_IN_PICTURE_MODE

      public static final String DID_ENTER_PICTURE_IN_PICTURE_MODE
      The player entered Picture-in-Picture mode.
      See Also:

    • DID_EXIT_PICTURE_IN_PICTURE_MODE

      public static final String DID_EXIT_PICTURE_IN_PICTURE_MODE
      The player exited Picture-in-Picture mode.
      See Also:

    • PROJECTION_FORMAT_CHANGED

      public static final String PROJECTION_FORMAT_CHANGED
      The player has changed the projection format for the video player
      See Also:

    • ON_FRAME_AVAILABLE

      public static final String ON_FRAME_AVAILABLE
      This event is sent when the frame to draw a 360 video is available
      See Also:

    • CHANGE_ORIENTATION

      public static final String CHANGE_ORIENTATION
      The player is requesting orientation change
      See Also:

    • SEEK_CONTROLLER_CONFIGURATION

      public static final String SEEK_CONTROLLER_CONFIGURATION
      Configure the Rewind and Fast-forward buttons.
      See Also:

    • SEEKBAR_DRAGGING_PROGRESS

      public static final String SEEKBAR_DRAGGING_PROGRESS
      Starts dragging the seek bar by sending the AbstractEvent.SEEK_PROGRESS_LONG property.
      See Also:

    • SEEKBAR_DRAGGING_START

      public static final String SEEKBAR_DRAGGING_START
      Starts dragging the seek bar
      See Also:

    • SEEKBAR_DRAGGING_STOP

      public static final String SEEKBAR_DRAGGING_STOP
      Stops dragging the seek bar
      See Also:

    • SET_MEDIA_CONTROLLER_CONFIG

      public static final String SET_MEDIA_CONTROLLER_CONFIG
      Sets the MediaControllerConfig.
      See Also:

    • RESTORE_DEFAULT_MEDIA_CONTROLLER

      public static final String RESTORE_DEFAULT_MEDIA_CONTROLLER
      Restores the default BrightcoveMediaController values. It only has an effect when SET_MEDIA_CONTROLLER_CONFIG was used. To check the values restored, check the parameters available in MediaControllerConfig.
      See Also:

    • CAPTION

      public static final String CAPTION
      Indicates that a caption should be rendered.
      See Also:

    • DID_LOAD_CLOSED_CAPTIONS

      public static final String DID_LOAD_CLOSED_CAPTIONS
      Indicates that a closed captioning document has been loaded.
      See Also:

    • CAPTIONS_AVAILABLE

      public static final String CAPTIONS_AVAILABLE
      Indicates that closed captioning information is available for use.
      See Also:

    • CAPTIONS_LANGUAGES

      public static final String CAPTIONS_LANGUAGES
      Indicates that there is at least one caption language for the user to choose from.
      See Also:

    • CLOSED_CAPTIONING_ERROR

      public static final String CLOSED_CAPTIONING_ERROR
      Indicates that there was an error processing closed captioning information.
      See Also:

    • TOGGLE_CLOSED_CAPTIONS

      public static final String TOGGLE_CLOSED_CAPTIONS
      Indicates the toggling of closed captions between on and off (view-wise).
      See Also:

    • SELECT_CLOSED_CAPTION_TRACK

      public static final String SELECT_CLOSED_CAPTION_TRACK
      Indicates that a closed caption track has been selected
      See Also:

    • SET_CAPTIONS_STATE

      @Deprecated public static final String SET_CAPTIONS_STATE
      Deprecated.
      As of 4.7.1, no longer used.
      Indicates that the caption state has been set to enabled or disabled.
      See Also:

    • CAPTIONS_DIALOG_OK

      public static final String CAPTIONS_DIALOG_OK
      Indications the captions dialog ok button has been pressed.
      See Also:

    • CAPTIONS_DIALOG_SETTINGS

      public static final String CAPTIONS_DIALOG_SETTINGS
      Indications the captions dialog settings button has been pressed.
      See Also:

    • GO_LIVE

      public static final String GO_LIVE
      Indicates that the video should go to the live position.
      See Also:

    • DID_GO_LIVE

      public static final String DID_GO_LIVE
      Indicates that the video has gone live.
      See Also:

    • AUDIO_TRACKS

      public static final String AUDIO_TRACKS
      Indicates that there is at least one audio track for the user to choose from.
      See Also:

    • AUDIO_TRACKS_DIALOG_OK

      public static final String AUDIO_TRACKS_DIALOG_OK
      Indications the audio tracks dialog ok button has been pressed.
      See Also:

    • AUDIO_TRACKS_DIALOG_SETTINGS

      public static final String AUDIO_TRACKS_DIALOG_SETTINGS
      Indications the audio tracks dialog settings button has been pressed.
      See Also:

    • SELECT_AUDIO_TRACK

      public static final String SELECT_AUDIO_TRACK
      Indicates that a certain audio track should be selected.
      See Also:

    • GSC_MAX_CONCURRENCY_REACHED

      public static final String GSC_MAX_CONCURRENCY_REACHED
      Indicates that generic stream concurrency has reached the max of devices allowed to playback content.
      See Also:

    • GSC_HEARTBEAT_STOPPED

      public static final String GSC_HEARTBEAT_STOPPED
      Indicates that generic stream concurrency heartbeat has been stopped.
      See Also:

    • GSC_ERROR

      public static final String GSC_ERROR
      Indicates that generic stream concurrency error has been found.
      See Also:

  • Constructor Details

    • EventType

      public EventType()