public abstract class AbstractEvent<PropertyValueType>
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ACTIVITY
The key for Activity on the FRAGMENT_ATTACHED lifecycle event.
|
static java.lang.String |
AD_ID
The key for ad id used in advertising events.
|
static java.lang.String |
AD_TITLE
The key for ad title used in advertising events.
|
static java.lang.String |
ALIGNMENT
The alignment property of a CAPTION event.
|
static java.lang.String |
ANDROID_VIEW
The event property that specifies
View . |
static java.lang.String |
AUDIO_TRACKS_STATE
The key for events accessing audio tracks state.
|
static java.lang.String |
AUDIO_VARIANT
The key for the list of audio variants in AUDIO_TRACKS events.
|
static java.lang.String |
BOOLEAN
The key for a general boolean property.
|
static java.lang.String |
BRIGHTCOVE_CONTROL_BAR
The event property that specifies the
BrightcoveControlBar . |
static java.lang.String |
BRIGHTCOVE_MEDIA_CONTROLLER
The event property that specifies the
BrightcoveMediaController . |
static java.lang.String |
BUILD_VERSION |
static java.lang.String |
CAPTION_FORMAT
The key containing the
BrightcoveCaptionFormat selected. |
static java.lang.String |
CAPTION_URI
The key containing the uri for the
BrightcoveCaptionFormat selected. |
static java.lang.String |
CAPTIONS_STATE
The key for events accessing caption state.
|
static java.lang.String |
CATALOG_URL
The key for catalog urls used in the Analytics catalog request and response events.
|
static java.lang.String |
CONFIGURATION
Key for Events that carry a configuration in their payload.
|
static java.lang.String |
CUE_POINT
Key for Events that carry a single Cue Point.
|
static java.lang.String |
CUE_POINTS
Key for Events that carry a list of Cue Points.
|
static java.lang.String |
CURRENT_VIDEO
Video for Events that carry a current Video.
|
static java.lang.String |
DEBUG
Whether components should emit additional debug information.
|
static java.lang.String |
EMITTER
The simple name of the source component for an event when running in debug mode
|
static java.lang.String |
END_TIME
The end of the time range of a list of cue points
|
static java.lang.String |
ERROR
Key for an actual exception associated with a playback error
|
static java.lang.String |
ERROR_CODE
Key for the error code sent for a non-playable source
|
static java.lang.String |
ERROR_EXTRA
Key for the extra code sent during an error for non-playable source
|
static java.lang.String |
ERROR_MESSAGE
Used to transmit an error message when an error occurs
|
static java.lang.String |
ERROR_SUBCODE
Key for the error subcode sent for a non-playable source
|
static java.lang.String |
ERRORS
Key for list of error messages in a response.
|
static java.lang.String |
EVENT_SOURCE
Property that specifies the source class where the event originated.
|
static java.lang.String |
FORWARD_BUFFER_SECONDS
The key for forward buffer seconds used in the Analytics class.
|
static java.lang.String |
FRAGMENT
The key for the Fragment object on FRAGMENT_ACTIVITY_CREATED event.
|
static java.lang.String |
FROM_SEEK_POSITION
Position from which a seek began.
|
static java.lang.String |
ID
The property name of the unique identifier.
|
static java.lang.String |
INDEX
Video for Events that carry a video index.
|
static java.lang.String |
INSTANCE_STATE
The key for saving and restoring instance state on a lifecycle event.
|
protected boolean |
isPrevented |
protected boolean |
isStopped |
static java.lang.String |
LANGUAGES
The key for the list of languages in CAPTIONS_LANGUAGES events.
|
static java.lang.String |
LEFT_VOLUME
The setting of the left channel volume for a player (as float: 0.0f-1.0f inclusive).
|
static java.lang.String |
LINE
The line property of a CAPTION event.
|
static java.lang.String |
LINE_ANCHOR
The line anchor property of a CAPTION event.
|
static java.lang.String |
LINE_TYPE
The line type property of a CAPTION event.
|
static java.lang.String |
LIST
The name of the property for video list.
|
static java.lang.String |
LIVE_WINDOW_DURATION
The absolute playable window duration for a live video.
|
static java.lang.String |
LOCALE_CODE
The key for events carrying a locale code for subtitle tracks.
|
static java.lang.String |
MAX_POSITION
The maximum position for which a seek will be successful.
|
static java.lang.String |
MEASURED_BPS
The key for measured bps used in the Analytics class.
|
static java.lang.String |
MEDIA_BYTES_TRANSFERRED
The key for total number of bytes transferred by the video player.
|
static java.lang.String |
MEDIA_CONTROLLER_CONFIG |
static java.lang.String |
MIN_POSITION
The minimum position for which a seek will be successful.
|
static java.lang.String |
NEXT_VIDEO
Video for Events that carry a next Video.
|
static java.lang.String |
ORIGINAL_EVENT
Original event used in situations where default behavior is prevented and the original event
needs to be re-emitted.
|
static java.lang.String |
ORIGINAL_PLAYHEAD_POSITION
The unmapped current playhead position.
|
static java.lang.String |
ORIGINAL_SEEK_POSITION
The unmapped seek position.
|
static java.lang.String |
PERCENT_COMPLETE
Percentage of the video that has buffered so far.
|
static java.lang.String |
PICTURE_IN_PICTURE_STATE
The key for events accessing Picture-in-Picture state.
|
static java.lang.String |
PLAYBACK_LOCATION
The event property key that specifies the
PlaybackLocation . |
static java.lang.String |
PLAYHEAD_POSITION
Current playhead position in milliseconds.
|
static java.lang.String |
PLAYLIST
Video for Events that carry a single Playlist.
|
static java.lang.String |
PLUGIN_NAME
The name of a plugin registered to the SDK.
|
static java.lang.String |
POSITION
The position property of a CAPTION event.
|
static java.lang.String |
POSITION_ANCHOR
The position anchor property of a CAPTION event.
|
static java.lang.String |
PROGRESS_BAR_PLAYHEAD_POSITION
Current playhead position in milliseconds, as shown in the Progress Bar.
|
static java.lang.String |
PROJECTION_FORMAT
The key for the projection format sent in the Event
EventType.PROJECTION_FORMAT_CHANGED . |
static java.lang.String |
RENDITION_HEIGHT
The key for rendition height used in the Analytics class.
|
static java.lang.String |
RENDITION_INDICATED_BPS
The key for rendition indicated bps used in the Analytics class.
|
static java.lang.String |
RENDITION_MIME_TYPE
The key for rendition mime type used in the Analytics class.
|
static java.lang.String |
RENDITION_URL
The key for rendition urls used in the Analytics class.
|
static java.lang.String |
RENDITION_WIDTH
The key for rendition width used in the Analytics class.
|
static java.lang.String |
REQUEST_TOKEN
Used by the Request/Response setup; marks the id of the listener to get the response.
|
static java.lang.String |
REQUESTED_ORIENTATION
The key for the orientation type sent in the Event
EventType.CHANGE_ORIENTATION . |
static java.lang.String |
RESPONSE_TIME_MS
The key for response times in milliseconds used in the Analytics catalog response events.
|
static java.lang.String |
RESTORE_SEEK_POSITION
Position to which a seek action brings the playhead, after the player has been restored.
|
static java.lang.String |
RIGHT_VOLUME
The setting of the right channel volume for a player (as float: 0.0f-1.0f inclusive).
|
static java.lang.String |
SEEK_CONTROLS_VISIBILITY
The key for accessing a visibility map associating seek controls with visibility state
from the event properties.
|
static java.lang.String |
SEEK_DEFAULT
The setting for the default seek time.
|
static java.lang.String |
SEEK_ON_HOLD_UPDATE_FREQ
The setting to determine the speed we're seeking when holding down either the rewind or fast-forward button.
|
static java.lang.String |
SEEK_ON_HOLD_WAIT_TIME
The setting to determine when the rewind or fast-forward buttons are been long-pressed and held.
|
static java.lang.String |
SEEK_PERCENTAGE
The setting used if the seek relative is enabled.
|
static java.lang.String |
SEEK_POSITION
Position to which a seek action brings the playhead.
|
static java.lang.String |
SEEK_PROGRESS
The setting that has the amount of time (milliseconds) where the seek indicator must be positioned.
|
static java.lang.String |
SEEK_RELATIVE_ENABLED
The setting to enable to seek relatively to the video duration and not by a fixed time.
|
static java.lang.String |
SEGMENT_DURATION
The video segment's duration in milliseconds.
|
static java.lang.String |
SELECTED_TRACK
The key for the selected track in AUDIO_TRACKS and SELECT_AUDIO_TRACK events.
|
static java.lang.String |
SIZE
The SIZE property of a CAPTION event.
|
static java.lang.String |
SKIP_CUE_POINTS
When added as a key to PLAY/SEEK/VIDEO_COMPLETED events, cue points will be skipped
|
static java.lang.String |
SOURCE
Source for Events that carry a single Source.
|
static java.lang.String |
START_TIME
The beginning of the time range of a list of cue points
|
static java.lang.String |
SUPPORT_FRAGMENT
The key for the Support Fragment object on FRAGMENT_ACTIVITY_CREATED event.
|
static java.lang.String |
TEXT
The text property of a CAPTION event.
|
static java.lang.String |
TRACKS
The key for the list of tracks in AUDIO_TRACKS events.
|
static java.lang.String |
TTML_DOCUMENT
The key for events carrying DFXP/TTML data.
|
protected java.lang.String |
type |
static java.lang.String |
UUID
The property name of the universally unique identifier.
|
static java.lang.String |
VALUE |
static java.lang.String |
VIDEO
Video for Events that carry a single Video.
|
static java.lang.String |
VIDEO_DURATION
The video's duration in milliseconds.
|
static java.lang.String |
VIDEO_HEIGHT
Height of video.
|
static java.lang.String |
VIDEO_STILL
URL for Events that carry a Video still image URL.
|
static java.lang.String |
VIDEO_WIDTH
Width of video.
|
static java.lang.String |
VOLUME
The single setting volume for a player that doesn't use channels.
|
static java.lang.String |
WEBVTT_DOCUMENT
The key for events carrying WebVTT data.
|
Constructor and Description |
---|
AbstractEvent(java.lang.String type) |
Modifier and Type | Method and Description |
---|---|
int |
getId() |
int |
getIntegerProperty(java.lang.String propertyName)
Convenience method for accessing a property with an integer value
|
static int |
getNextId() |
abstract java.util.Map<java.lang.String,PropertyValueType> |
getProperties() |
PropertyValueType |
getProperty(java.lang.String propertyName) |
<T> T |
getProperty(java.lang.String eventPropertyId,
java.lang.Class<T> type)
Returns the casted value of the eventPropertyId.
|
java.lang.String |
getType()
The event type, typically specified from a constant value defined in EventType.
|
boolean |
isPrevented()
Indicates that a participant of the current Event activity has prevented the default behavior
for the current Event.
|
boolean |
isStopped()
Indicates that a participant of the current Event activity has stopped the processing of any
additional Events.
|
void |
preventDefault()
Causes the Event handling framework to not execute any default behavior that may be defined
for a given Event.
|
void |
stopPropagation()
Causes the Event handling framework to stop processing any additional Events.
|
java.lang.String |
toString() |
public static final java.lang.String CONFIGURATION
public static final java.lang.String CUE_POINT
public static final java.lang.String CUE_POINTS
public static final java.lang.String PLAYLIST
public static final java.lang.String VIDEO
public static final java.lang.String SOURCE
public static final java.lang.String CURRENT_VIDEO
public static final java.lang.String NEXT_VIDEO
public static final java.lang.String INDEX
public static final java.lang.String VIDEO_STILL
public static final java.lang.String FROM_SEEK_POSITION
public static final java.lang.String SEEK_POSITION
public static final java.lang.String RESTORE_SEEK_POSITION
public static final java.lang.String ORIGINAL_SEEK_POSITION
public static final java.lang.String PLAYHEAD_POSITION
public static final java.lang.String VIDEO_DURATION
public static final java.lang.String SEGMENT_DURATION
public static final java.lang.String MAX_POSITION
public static final java.lang.String MIN_POSITION
public static final java.lang.String LIVE_WINDOW_DURATION
public static final java.lang.String PERCENT_COMPLETE
public static final java.lang.String ERROR_MESSAGE
public static final java.lang.String ERROR_CODE
public static final java.lang.String ERROR_SUBCODE
public static final java.lang.String ERROR_EXTRA
public static final java.lang.String ERROR
public static final java.lang.String ERRORS
public static final java.lang.String VIDEO_WIDTH
public static final java.lang.String VIDEO_HEIGHT
public static final java.lang.String REQUEST_TOKEN
public static final java.lang.String DEBUG
public static final java.lang.String EMITTER
public static final java.lang.String ORIGINAL_EVENT
public static final java.lang.String EVENT_SOURCE
public static final java.lang.String LIST
public static final java.lang.String UUID
public static final java.lang.String ID
public static final java.lang.String START_TIME
public static final java.lang.String END_TIME
public static final java.lang.String SKIP_CUE_POINTS
public static final java.lang.String PLUGIN_NAME
public static final java.lang.String LEFT_VOLUME
public static final java.lang.String RIGHT_VOLUME
public static final java.lang.String VOLUME
public static final java.lang.String SEEK_CONTROLS_VISIBILITY
public static final java.lang.String SEEK_PROGRESS
public static final java.lang.String SEEK_DEFAULT
public static final java.lang.String SEEK_RELATIVE_ENABLED
public static final java.lang.String SEEK_PERCENTAGE
public static final java.lang.String SEEK_ON_HOLD_WAIT_TIME
public static final java.lang.String SEEK_ON_HOLD_UPDATE_FREQ
public static final java.lang.String BUILD_VERSION
public static final java.lang.String INSTANCE_STATE
public static final java.lang.String ACTIVITY
public static final java.lang.String FRAGMENT
public static final java.lang.String SUPPORT_FRAGMENT
public static final java.lang.String BOOLEAN
public static final java.lang.String TTML_DOCUMENT
public static final java.lang.String WEBVTT_DOCUMENT
public static final java.lang.String VALUE
public static final java.lang.String LOCALE_CODE
public static final java.lang.String CAPTION_FORMAT
BrightcoveCaptionFormat
selected.public static final java.lang.String CAPTION_URI
BrightcoveCaptionFormat
selected.public static final java.lang.String ALIGNMENT
public static final java.lang.String LINE
public static final java.lang.String LINE_TYPE
public static final java.lang.String LINE_ANCHOR
public static final java.lang.String SIZE
public static final java.lang.String POSITION
public static final java.lang.String POSITION_ANCHOR
public static final java.lang.String TEXT
public static final java.lang.String CAPTIONS_STATE
public static final java.lang.String LANGUAGES
public static final java.lang.String AUDIO_TRACKS_STATE
public static final java.lang.String PICTURE_IN_PICTURE_STATE
public static final java.lang.String TRACKS
public static final java.lang.String SELECTED_TRACK
public static final java.lang.String AUDIO_VARIANT
public static final java.lang.String ORIGINAL_PLAYHEAD_POSITION
public static final java.lang.String PROGRESS_BAR_PLAYHEAD_POSITION
public static final java.lang.String CATALOG_URL
public static final java.lang.String RENDITION_URL
public static final java.lang.String RENDITION_INDICATED_BPS
public static final java.lang.String RENDITION_MIME_TYPE
public static final java.lang.String RENDITION_HEIGHT
public static final java.lang.String RENDITION_WIDTH
public static final java.lang.String FORWARD_BUFFER_SECONDS
public static final java.lang.String MEASURED_BPS
public static final java.lang.String MEDIA_BYTES_TRANSFERRED
public static final java.lang.String RESPONSE_TIME_MS
public static final java.lang.String AD_ID
public static final java.lang.String AD_TITLE
public static final java.lang.String PROJECTION_FORMAT
EventType.PROJECTION_FORMAT_CHANGED
.public static final java.lang.String REQUESTED_ORIENTATION
EventType.CHANGE_ORIENTATION
.public static final java.lang.String PLAYBACK_LOCATION
PlaybackLocation
.
Currently used when using the Cast plugin.public static final java.lang.String MEDIA_CONTROLLER_CONFIG
public static final java.lang.String BRIGHTCOVE_CONTROL_BAR
BrightcoveControlBar
.public static final java.lang.String BRIGHTCOVE_MEDIA_CONTROLLER
BrightcoveMediaController
.public static final java.lang.String ANDROID_VIEW
View
.protected final java.lang.String type
protected boolean isStopped
protected boolean isPrevented
public static int getNextId()
public int getId()
public java.lang.String getType()
public void preventDefault()
public void stopPropagation()
public boolean isPrevented()
public boolean isStopped()
public java.lang.String toString()
toString
in class java.lang.Object
@Nullable public PropertyValueType getProperty(@NonNull java.lang.String propertyName)
public <T> T getProperty(java.lang.String eventPropertyId, java.lang.Class<T> type)
T
- the expected type.eventPropertyId
- the id of the property to retrieve.type
- the class to be casted.public int getIntegerProperty(@NonNull java.lang.String propertyName)
propertyName
- Name of property to access@NonNull public abstract java.util.Map<java.lang.String,PropertyValueType> getProperties()