# Classes

##

### Classes

Errors
MediaPlayerEvents
MediaPlayerModel
MetricsReportingEvents
MssErrors
OfflineErrors
OfflineEvents
ProtectionErrors
ProtectionEvents

### Events

#### ADAPTATION_SET_REMOVED_NO_CAPABILITIES

  Event that is dispatched whenever an adaptation set is removed due to all representations not being supported.

  Source:
    - streaming/MediaPlayerEvents.js, line 424

#### AST_IN_FUTURE

  Triggered when playback will not start yet
  as the MPD's availabilityStartTime is in the future.
  Check delay property in payload to determine time before playback will start.

  Source:
    - streaming/MediaPlayerEvents.js, line 44

#### BASE_URLS_UPDATED

  Triggered when the BaseURLs have been updated.

  Source:
    - streaming/MediaPlayerEvents.js, line 52

#### BUFFER_EMPTY

  Triggered when the video element's buffer state changes to stalled.
  Check mediaType in payload to determine type (Video, Audio, FragmentedText).

  Source:
    - streaming/MediaPlayerEvents.js, line 58

#### BUFFER_LEVEL_STATE_CHANGED

  Triggered when the video element's buffer state changes, either stalled or loaded. Check payload for state.

  Source:
    - streaming/MediaPlayerEvents.js, line 72

#### BUFFER_LEVEL_UPDATED

  Triggered when the buffer level of a media type has been updated

  Source:
    - streaming/MediaPlayerEvents.js, line 78

#### BUFFER_LOADED

  Triggered when the video element's buffer state changes to loaded.
  Check mediaType in payload to determine type (Video, Audio, FragmentedText).

  Source:
    - streaming/MediaPlayerEvents.js, line 65

#### CAN_PLAY

  Sent when enough data is available that the media can be played,
  at least for a couple of frames. This corresponds to the
  HAVE_ENOUGH_DATA readyState.

  Source:
    - streaming/MediaPlayerEvents.js, line 274

#### CAN_PLAY_THROUGH

  This corresponds to the CAN_PLAY_THROUGH readyState.

  Source:
    - streaming/MediaPlayerEvents.js, line 282

#### CAPTION_CONTAINER_RESIZE

  Triggered when the caption container is resized.

  Source:
    - streaming/MediaPlayerEvents.js, line 268

#### CAPTION_RENDERED

  Triggered when a caption is rendered.

  Source:
    - streaming/MediaPlayerEvents.js, line 262

#### CONFORMANCE_VIOLATION

  Event that is dispatched whenever the player encounters a potential conformance validation that might lead to unexpected/not optimal behavior

  Source:
    - streaming/MediaPlayerEvents.js, line 412

#### CONTENT_STEERING_REQUEST_COMPLETED

  Triggered when a content steering request has completed.

  Source:
    - streaming/MediaPlayerEvents.js, line 430

#### DYNAMIC_TO_STATIC

  Triggered when a dynamic stream changed to static (transition phase between Live and On-Demand).

  Source:
    - streaming/MediaPlayerEvents.js, line 84

#### ERROR

  Triggered when there is an error from the element or MSE source buffer.

  Source:
    - streaming/MediaPlayerEvents.js, line 90

#### EVENT_MODE_ON_RECEIVE

  Dash events are triggered as soon as they were parsed.

  Source:
    - streaming/MediaPlayerEvents.js, line 406

#### EVENT_MODE_ON_START

  Dash events are triggered at their respective start points on the timeline.

  Source:
    - streaming/MediaPlayerEvents.js, line 400

#### FRAGMENT_LOADING_ABANDONED

  Triggered when a fragment download is abandoned due to detection of slow download base on the ABR abandon rule..

  Source:
    - streaming/MediaPlayerEvents.js, line 112

#### FRAGMENT_LOADING_COMPLETED

  Triggered when a fragment download has completed.

  Source:
    - streaming/MediaPlayerEvents.js, line 95

#### FRAGMENT_LOADING_PROGRESS

  Triggered when a partial fragment download has completed.

  Source:
    - streaming/MediaPlayerEvents.js, line 101

#### FRAGMENT_LOADING_STARTED

  Triggered when a fragment download has started.

  Source:
    - streaming/MediaPlayerEvents.js, line 106

#### INBAND_PRFT

  Triggered when an inband prft (ProducerReferenceTime) boxes has been received.

  Source:
    - streaming/MediaPlayerEvents.js, line 436

#### LOG

  Triggered when `module:Debug` logger methods are called.

  Source:
    - streaming/MediaPlayerEvents.js, line 118

#### MANIFEST_LOADED

  Triggered when the manifest load is complete, providing the payload

  Source:
    - streaming/MediaPlayerEvents.js, line 136

#### MANIFEST_LOADING_FINISHED

  Triggered when the manifest loading is finished, providing the request object information

  Source:
    - streaming/MediaPlayerEvents.js, line 130

#### MANIFEST_LOADING_STARTED

  Triggered when the manifest load is started

  Source:
    - streaming/MediaPlayerEvents.js, line 124

#### MANIFEST_VALIDITY_CHANGED

  Manifest validity changed - As a result of an MPD validity expiration event.

  Source:
    - streaming/MediaPlayerEvents.js, line 394

#### METRIC_ADDED

  Triggered every time a new metric is added.

  Source:
    - streaming/MediaPlayerEvents.js, line 154

#### METRIC_CHANGED

  Triggered when an individual metric is added, updated or cleared.

  Source:
    - streaming/MediaPlayerEvents.js, line 148

#### METRIC_UPDATED

  Triggered every time a metric is updated.

  Source:
    - streaming/MediaPlayerEvents.js, line 160

#### METRICS_CHANGED

  Triggered anytime there is a change to the overall metrics.

  Source:
    - streaming/MediaPlayerEvents.js, line 142

#### PERIOD_SWITCH_COMPLETED

  Triggered at the stream end of a period.

  Source:
    - streaming/MediaPlayerEvents.js, line 172

#### PERIOD_SWITCH_STARTED

  Triggered when a new stream (period) starts.

  Source:
    - streaming/MediaPlayerEvents.js, line 166

#### PLAYBACK_ENDED

  Sent when playback completes.

  Source:
    - streaming/MediaPlayerEvents.js, line 288

#### PLAYBACK_ERROR

  Sent when an error occurs. The element's error
  attribute contains more information.

  Source:
    - streaming/MediaPlayerEvents.js, line 294

#### PLAYBACK_LOADED_DATA

  The event is fired when the frame at the current playback position of the media has finished loading;
  often the first frame

  Source:
    - streaming/MediaPlayerEvents.js, line 314

#### PLAYBACK_METADATA_LOADED

  The media's metadata has finished loading; all attributes now
  contain as much useful information as they're going to.

  Source:
    - streaming/MediaPlayerEvents.js, line 307

#### PLAYBACK_NOT_ALLOWED

  Sent when playback is not allowed (for example if user gesture is needed).

  Source:
    - streaming/MediaPlayerEvents.js, line 301

#### PLAYBACK_PAUSED

  Sent when playback is paused.

  Source:
    - streaming/MediaPlayerEvents.js, line 321

#### PLAYBACK_PLAYING

  Sent when the media begins to play (either for the first time, after having been paused,
  or after ending and then restarting).

  Source:
    - streaming/MediaPlayerEvents.js, line 327

#### PLAYBACK_PROGRESS

  Sent periodically to inform interested parties of progress downloading
  the media. Information about the current amount of the media that has
  been downloaded is available in the media element's buffered attribute.

  Source:
    - streaming/MediaPlayerEvents.js, line 335

#### PLAYBACK_RATE_CHANGED

  Sent when the playback speed changes.

  Source:
    - streaming/MediaPlayerEvents.js, line 343

#### PLAYBACK_SEEKED

  Sent when a seek operation completes.

  Source:
    - streaming/MediaPlayerEvents.js, line 349

#### PLAYBACK_SEEKING

  Sent when a seek operation begins.

  Source:
    - streaming/MediaPlayerEvents.js, line 355

#### PLAYBACK_STALLED

  Sent when the video element reports stalled

  Source:
    - streaming/MediaPlayerEvents.js, line 361

#### PLAYBACK_STARTED

  Sent when playback of the media starts after having been paused;
  that is, when playback is resumed after a prior pause event.

  Source:
    - streaming/MediaPlayerEvents.js, line 367

#### PLAYBACK_TIME_UPDATED

  The time indicated by the element's currentTime attribute has changed.

  Source:
    - streaming/MediaPlayerEvents.js, line 375

#### PLAYBACK_VOLUME_CHANGED

  Sent when the video element reports that the volume has changed

  Source:
    - streaming/MediaPlayerEvents.js, line 381

#### PLAYBACK_WAITING

  Sent when the media playback has stopped because of a temporary lack of data.

  Source:
    - streaming/MediaPlayerEvents.js, line 387

#### QUALITY_CHANGE_RENDERED

  Triggered when the new ABR quality is being rendered on-screen.

  Source:
    - streaming/MediaPlayerEvents.js, line 184

#### QUALITY_CHANGE_REQUESTED

  Triggered when an ABR up /down switch is initiated; either by user in manual mode or auto mode via ABR rules.

  Source:
    - streaming/MediaPlayerEvents.js, line 178

#### REPRESENTATION_SWITCH

  Event that is dispatched whenever the player switches to a different representation

  Source:
    - streaming/MediaPlayerEvents.js, line 418

#### STREAM_ACTIVATED

  Triggered when a stream (period) is activated

  Source:
    - streaming/MediaPlayerEvents.js, line 208

#### STREAM_DEACTIVATED

  Triggered when a stream (period) is deactivated

  Source:
    - streaming/MediaPlayerEvents.js, line 214

#### STREAM_INITIALIZED

  Triggered when a stream (period) is activated

  Source:
    - streaming/MediaPlayerEvents.js, line 220

#### STREAM_INITIALIZING

  Triggered when a stream (period) is being loaded

  Source:
    - streaming/MediaPlayerEvents.js, line 196

#### STREAM_TEARDOWN_COMPLETE

  Triggered when the player has been reset.

  Source:
    - streaming/MediaPlayerEvents.js, line 226

#### STREAM_UPDATED

  Triggered when a stream (period) is loaded

  Source:
    - streaming/MediaPlayerEvents.js, line 202

#### TEXT_TRACK_ADDED

  Triggered when a text track is added to the video element's TextTrackList

  Source:
    - streaming/MediaPlayerEvents.js, line 238

#### TEXT_TRACKS_ADDED

  Triggered once all text tracks detected in the MPD are added to the video element.

  Source:
    - streaming/MediaPlayerEvents.js, line 232

#### THROUGHPUT_MEASUREMENT_STORED

  Triggered when a throughput measurement based on the last segment request has been stored

  Source:
    - streaming/MediaPlayerEvents.js, line 244

#### TRACK_CHANGE_RENDERED

  Triggered when the new track is being rendered.

  Source:
    - streaming/MediaPlayerEvents.js, line 190

#### TTML_PARSED

  Triggered when a ttml chunk is parsed.

  Source:
    - streaming/MediaPlayerEvents.js, line 250

#### TTML_TO_PARSE

  Triggered when a ttml chunk has to be parsed.

  Source:
    - streaming/MediaPlayerEvents.js, line 256

#### CMCD_DATA_GENERATED

  Triggered when CMCD data was generated for a HTTP request

  Source:
    - streaming/metrics/MetricsReportingEvents.js, line 44

#### OFFLINE_RECORD_FINISHED

  Triggered when all record has been downloaded

  Source:
    - offline/events/OfflineEvents.js, line 28

#### OFFLINE_RECORD_LOADEDMETADATA

  Triggered when all mediaInfo has been loaded

  Source:
    - offline/events/OfflineEvents.js, line 10

#### OFFLINE_RECORD_STARTED

  Triggered when a record is initialized and download is started

  Source:
    - offline/events/OfflineEvents.js, line 16

#### OFFLINE_RECORD_STOPPED

  Triggered when the user stop downloading a record

  Source:
    - offline/events/OfflineEvents.js, line 22

#### KEY_ADDED

  Event ID for events delivered when a new key has been added

  Deprecated:
    - The latest versions of the EME specification no longer use this event. {@MediaPlayer.models.protectionModel.eventList.KEY_STATUSES_CHANGED} is preferred.
  Source:
    - streaming/protection/ProtectionEvents.js, line 59

#### KEY_ERROR

  Event ID for events delivered when an error is encountered by the CDM
  while processing a license server response message

  Source:
    - streaming/protection/ProtectionEvents.js, line 69

#### KEY_MESSAGE

  Event ID for events delivered when the protection set receives
  a key message from the CDM

  Source:
    - streaming/protection/ProtectionEvents.js, line 76

#### KEY_SESSION_CLOSED

  Event ID for events delivered when a key session close
  process has completed

  Source:
    - streaming/protection/ProtectionEvents.js, line 83

#### KEY_SESSION_CREATED

  Event ID for events delivered when a new key sessions creation
  process has completed

  Source:
    - streaming/protection/ProtectionEvents.js, line 90

#### KEY_SESSION_REMOVED

  Event ID for events delivered when a key session removal
  process has completed

  Source:
    - streaming/protection/ProtectionEvents.js, line 97

#### KEY_STATUSES_CHANGED

  Event ID for events delivered when the status of one or more
  decryption keys has changed

  Source:
    - streaming/protection/ProtectionEvents.js, line 104

#### KEY_SYSTEM_ACCESS_COMPLETE

  Event ID for events delivered when a key system access procedure
  has completed

  Source:
    - streaming/protection/ProtectionEvents.js, line 111

#### KEY_SYSTEM_SELECTED

  Event ID for events delivered when a key system selection procedure
  completes

  Source:
    - streaming/protection/ProtectionEvents.js, line 118

#### LICENSE_REQUEST_COMPLETE

  Event ID for events delivered when a license request procedure
  has completed

  Source:
    - streaming/protection/ProtectionEvents.js, line 125

#### LICENSE_REQUEST_SENDING

  Sending a license rquest

  Source:
    - streaming/protection/ProtectionEvents.js, line 132

#### PROTECTION_CREATED

  Event ID for events delivered when the Protection system is detected and created.

  Source:
    - streaming/protection/ProtectionEvents.js, line 144

#### PROTECTION_DESTROYED

  Event ID for events delivered when the Protection system is destroyed.

  Source:
    - streaming/protection/ProtectionEvents.js, line 150

#### Search results