# Introduction

The Player API is the top-level API. This API exposes:

* basic functions to manipulate video playback, such as start and pause;
* properties to check states and values, such as the playhead position;
* events to track changes.

The list below overviews how-to articles related to the Player API.

* [How do you know when a stream or an advertisement is playing?](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/how-to-guides/player/how-do-you-know-when-a-stream-or-ad-is-playing.md)
* [How to measure time-to-first-frame](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/how-to-guides/player/how-to-measure-time-to-first-frame.md)
* [How can we track the first play(ing) event?](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/how-to-guides/player/how-can-we-track-the-first-playing-event.md)
* [How to track player states](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/how-to-guides/player/how-to-track-player-states.md)

## Events

As a developer, you can programmatically attach event listeners to different APIs. Event listeners are often used to [implement a custom UI](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/how-to-guides/ui/how-to-build-chromeless-ui.md) or to [implement a custom analytics integration](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/how-to-guides/analytics/custom-analytics-integration.md).

The THEOplayer API exposes many events across different interfaces, as can be seen in the graphic below. Furthermore, most events exist in all SDKs (Web, iOS-based, Android-based and Roku).

![THEOplayer API Interfaces and Events](/pr-860/assets/images/analytics-events-185d6ab52b556af08d8300b545ae5876.png "THEOplayer API Interfaces and Events")

The table below gives an overview of a subset of the available events per interface in the THEOplayer Web SDK.

| Interface                                                                                                                                    | Event                                                                                                                                                            | Description                                                                                                                                   |
| -------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| [Player](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PlayerEventMap)                          | [canplay](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PlayerEventMap#canplay)                                     | Fired when the player can resume playback of the media data.                                                                                  |
| Player                                                                                                                                       | [canplaythrough](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PlayerEventMap#canplaythrough)                       | Fired when the player can resume playback of the media data and buffering is unlikely.                                                        |
| Player                                                                                                                                       | [contentprotectionerror](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PlayerEventMap#contentprotectionerror)       | Fired when an error related to content protection occurs.                                                                                     |
| Player                                                                                                                                       | [contentprotectionsuccess](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PlayerEventMap#contentprotectionsuccess)   | Fired when the key is usable for decryption.                                                                                                  |
| Player                                                                                                                                       | [currentsourcechange](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PlayerEventMap#currentsourcechange)             | Fired when the current source, which is chosen from ChromelessPlayer.source.sources, changes.                                                 |
| Player                                                                                                                                       | [destroy](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PlayerEventMap#destroy)                                     | Fired when the the player is destroyed.                                                                                                       |
| Player                                                                                                                                       | [dimensionchange](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PlayerEventMap#dimensionchange)                     | Fired when the dimensions of the HTML element changes.                                                                                        |
| Player                                                                                                                                       | [durationchange](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PlayerEventMap#durationchange)                       | Fired when ChromelessPlayer.duration changes.                                                                                                 |
| Player                                                                                                                                       | [emptied](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PlayerEventMap#emptied)                                     | Fired when the player's source is cleared.                                                                                                    |
| Player                                                                                                                                       | [encrypted](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PlayerEventMap#encrypted)                                 | Fired when the player encounters key system initialization data in the media data.                                                            |
| Player                                                                                                                                       | [ended](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PlayerEventMap#ended)                                         | Fired when playback has stopped because the end of the media resource was reached.                                                            |
| Player                                                                                                                                       | [error](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PlayerEventMap#error)                                         | Fired when an error occurs.                                                                                                                   |
| Player                                                                                                                                       | [loadeddata](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PlayerEventMap#loadeddata)                               | Fired when the player can render the media data at the current playback position for the first time.                                          |
| Player                                                                                                                                       | [loadedmetadata](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PlayerEventMap#loadedmetadata)                       | Fired when the player determines the duration and dimensions of the media resource.                                                           |
| Player                                                                                                                                       | [loadstart](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PlayerEventMap#loadstart)                                 | Fired when the player starts loading the manifest.                                                                                            |
| Player                                                                                                                                       | [manifestupdate](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PlayerEventMap#manifestupdate)                       | Fired when the manifest is updated.                                                                                                           |
| Player                                                                                                                                       | [pause](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PlayerEventMap#pause)                                         | Fired when ChromelessPlayer.paused changes to true.                                                                                           |
| Player                                                                                                                                       | [play](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PlayerEventMap#play)                                           | Fired when ChromelessPlayer.paused changes to false.                                                                                          |
| Player                                                                                                                                       | [playing](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PlayerEventMap#playing)                                     | Fired when playback is ready to start after having been paused or delayed due to lack of media data.                                          |
| Player                                                                                                                                       | [progress](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PlayerEventMap#progress)                                   | Fired when the player loaded media data.                                                                                                      |
| Player                                                                                                                                       | [ratechange](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PlayerEventMap#ratechange)                               | Fired when ChromelessPlayer.playbackRate changes.                                                                                             |
| Player                                                                                                                                       | [readystatechange](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PlayerEventMap#readystatechange)                   | Fired when ChromelessPlayer.readyState changes.                                                                                               |
| Player                                                                                                                                       | [representationchange](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PlayerEventMap#representationchange)           | Fired when the current representation changes.                                                                                                |
| Player                                                                                                                                       | [resize](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PlayerEventMap#resize)                                       | Fired when either ChromelessPlayer.videoWidth or ChromelessPlayer.videoHeight changes.                                                        |
| Player                                                                                                                                       | [seeked](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PlayerEventMap#seeked)                                       | Fired when ChromelessPlayer.seeking changes to false after the current playback position was changed.                                         |
| Player                                                                                                                                       | [seeking](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PlayerEventMap#seeking)                                     | Fired when ChromelessPlayer.seeking changes to true, and the player has started seeking to a new position.                                    |
| Player                                                                                                                                       | [segmentnotfound](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PlayerEventMap#segmentnotfound)                     | Fired when a segment can not be found.                                                                                                        |
| Player                                                                                                                                       | [sourcechange](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PlayerEventMap#sourcechange)                           | Fired when ChromelessPlayer.source changes.                                                                                                   |
| Player                                                                                                                                       | [timeupdate](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PlayerEventMap#timeupdate)                               | Fired when the current playback position changed as part of normal playback or in an especially interesting way, for example discontinuously. |
| Player                                                                                                                                       | [volumechange](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PlayerEventMap#volumechange)                           | Fired when ChromelessPlayer.volume changes.                                                                                                   |
| Player                                                                                                                                       | [waiting](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PlayerEventMap#waiting)                                     | Fired when playback has stopped because the next frame is not available, but the player expects that frame to become available in due course. |
| Player                                                                                                                                       | [currentTime](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/classes/ChromelessPlayer#currenttime)                              | The current playback position of the media, in seconds.                                                                                       |
| Player                                                                                                                                       | [currentProgramDateTime](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/classes/ChromelessPlayer#currentprogramdatetime)        | The current playback position of the media, as a timestamp.                                                                                   |
| Player                                                                                                                                       | [muted](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/classes/ChromelessPlayer#muted)                                          | Whether audio is muted.                                                                                                                       |
| Player                                                                                                                                       | [...](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/classes/ChromelessPlayer)                                                  | ...                                                                                                                                           |
| [Ads (Client-Side)](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/AdsEventMap)                  | [adbegin](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/AdsEventMap#adbegin)                                        | Fired when an ad begins.                                                                                                                      |
| Ads (Client-Side)                                                                                                                            | [adbreakbegin](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/AdsEventMap#adbreakbegin)                              | Fired when an ad break begins.                                                                                                                |
| Ads (Client-Side)                                                                                                                            | [adbreakchange](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/AdsEventMap#adbreakchange)                            | Fired when an ad break changes.                                                                                                               |
| Ads (Client-Side)                                                                                                                            | [adbreakend](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/AdsEventMap#adbreakend)                                  | Fired when an ad break ends.                                                                                                                  |
| Ads (Client-Side)                                                                                                                            | [adbuffering](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/AdsEventMap#adbuffering)                                | Fired when the ad has stalled playback to buffer.                                                                                             |
| Ads (Client-Side)                                                                                                                            | [addad](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/AdsEventMap#addad)                                            | Fired when an ad is added.                                                                                                                    |
| Ads (Client-Side)                                                                                                                            | [addadbreak](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/AdsEventMap#addadbreak)                                  | Fired when an ad break is added.                                                                                                              |
| Ads (Client-Side)                                                                                                                            | [adend](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/AdsEventMap#adend)                                            | Fired when an ad ends.                                                                                                                        |
| Ads (Client-Side)                                                                                                                            | [aderror](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/AdsEventMap#aderror)                                        | Fired when an ad errors.                                                                                                                      |
| Ads (Client-Side)                                                                                                                            | [adfirstquartile](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/AdsEventMap#adfirstquartile)                        | Fired when an ad reaches the first quartile.                                                                                                  |
| Ads (Client-Side)                                                                                                                            | [adimpression](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/AdsEventMap#adimpression)                              | Fired when an ad counts as an impression.                                                                                                     |
| Ads (Client-Side)                                                                                                                            | [adloaded](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/AdsEventMap#adloaded)                                      | Fired when an ad is loaded.                                                                                                                   |
| Ads (Client-Side)                                                                                                                            | [admetadata](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/AdsEventMap#admetadata)                                  | Fired when an ads list is loaded.                                                                                                             |
| Ads (Client-Side)                                                                                                                            | [admidpoint](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/AdsEventMap#admidpoint)                                  | Fired when an ad reaches the mid point.                                                                                                       |
| Ads (Client-Side)                                                                                                                            | [adskip](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/AdsEventMap#adskip)                                          | Fired when an ad is skipped.                                                                                                                  |
| Ads (Client-Side)                                                                                                                            | [adthirdquartile](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/AdsEventMap#adthirdquartile)                        | Fired when an ad reaches the third quartile.                                                                                                  |
| Ads (Client-Side)                                                                                                                            | [removeadbreak](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/AdsEventMap#removeadbreak)                            | Fired when an ad break is removed.                                                                                                            |
| Ads (Client-Side)                                                                                                                            | [updatead](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/AdsEventMap#updatead)                                      | Fired when an ad is updated.                                                                                                                  |
| Ads (Client-Side)                                                                                                                            | [updateadbreak](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/AdsEventMap#updateadbreak)                            | Fired when an AdBreak is updated.                                                                                                             |
| [Vendor Cast](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/VendorCastEventMap)                 | [statechange](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/VendorCastEventMap#statechange)                         | Fired when the state changes.                                                                                                                 |
| [Chromecast](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/ChromecastEventMap)                  | [error](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/ChromecastEventMap#error)                                     | Fired when an error occurs while casting or trying to cast.                                                                                   |
| [Track List](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/TrackListEventMap)                   | [addtrack](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/TrackListEventMap#addtrack)                                | Fired when a track is added.                                                                                                                  |
| Track List                                                                                                                                   | [change](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/TrackListEventMap#change)                                    | Fired when a track is activated or deactivated.                                                                                               |
| Track List                                                                                                                                   | [removetrack](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/TrackListEventMap#removetrack)                          | Fired when a track is removed.                                                                                                                |
| [Track](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/TrackEventMap)                            | [change](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/TrackEventMap#change)                                        | Fired when a media track's enabled or a text track's changes.                                                                                 |
| Track                                                                                                                                        | [update](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/TrackEventMap#update)                                        | Fired when the track updates.                                                                                                                 |
| [Media Track](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/MediaTrackEventMap)                 | [activequalitychanged](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/MediaTrackEventMap#activequalitychanged)       | Fired when the media track's active quality changes.                                                                                          |
| Media Track                                                                                                                                  | [qualityunavailable](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/MediaTrackEventMap#qualityunavailable)           | Fired when a quality of the track becomes unavailable.                                                                                        |
| Media Track                                                                                                                                  | [targetqualitychanged](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/MediaTrackEventMap#targetqualitychanged)       | Fired when the media track's target quality changes.                                                                                          |
| [Text Track](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/TextTrackEventMap)                   | [addcue](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/TextTrackEventMap#addcue)                                    | Fired when a cue is added to the track.                                                                                                       |
| Text Track                                                                                                                                   | [cuechange](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/TextTrackEventMap#cuechange)                              | Fired when a cue of the track changes.                                                                                                        |
| Text Track                                                                                                                                   | [entercue](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/TextTrackEventMap#entercue)                                | Fired when a cue of the track enters.                                                                                                         |
| Text Track                                                                                                                                   | [error](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/TextTrackEventMap#error)                                      | Fired when an error occurred while loading or parsing the track.                                                                              |
| Text Track                                                                                                                                   | [exitcue](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/TextTrackEventMap#exitcue)                                  | Fired when a cue of the track exits.                                                                                                          |
| Text Track                                                                                                                                   | [readystatechange](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/TextTrackEventMap#readystatechange)                | Fired when the text track's changes.                                                                                                          |
| Text Track                                                                                                                                   | [removecue](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/TextTrackEventMap#removecue)                              | Fired when a cue of the track is removed.                                                                                                     |
| Text Track                                                                                                                                   | [typechange](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/TextTrackEventMap#typechange)                            | Fired when the text track's changes.                                                                                                          |
| [Text Track Cue](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/TextTrackCueEventMap)            | [enter](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/TextTrackCueEventMap#enter)                                   | Fired when the cue is entered.                                                                                                                |
| Text Track Cue                                                                                                                               | [exit](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/TextTrackCueEventMap#exit)                                     | Fired when the cue is exited.                                                                                                                 |
| Text Track Cue                                                                                                                               | [update](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/TextTrackCueEventMap#update)                                 | Fired when the cue is updated.                                                                                                                |
| [Presentation](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PresentationEventMap)              | [error](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PresentationEventMap#error)                                   | Fired when an error occurs.                                                                                                                   |
| Presentation                                                                                                                                 | [presentationmodechange](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/PresentationEventMap#presentationmodechange) | Fired when the presentation mode changes.                                                                                                     |
| [VR](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/VREventMap)                                  | [directionchange](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/VREventMap#directionchange)                         | Fired when the VR.direction changes.                                                                                                          |
| VR                                                                                                                                           | [error](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/VREventMap#error)                                             | Fired when an error occurs.                                                                                                                   |
| VR                                                                                                                                           | [statechange](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/VREventMap#statechange)                                 | Fired when the VR.state changes.                                                                                                              |
| VR                                                                                                                                           | [stereochange](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/VREventMap#stereochange)                               | Fired when the VR.stereo changes.                                                                                                             |
| [Uplynk](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/UplynkEventMap)                          | [assetinforesponse](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/UplynkEventMap#assetinforesponse)                 | Fired when an asset info response is received.                                                                                                |
| Uplynk                                                                                                                                       | [pingerror](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/UplynkEventMap#pingerror)                                 | Fired when an error or invalid response is received from the Ping API.                                                                        |
| Uplynk                                                                                                                                       | [pingresponse](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/UplynkEventMap#pingresponse)                           | Fired when a Ping response is received.                                                                                                       |
| Uplynk                                                                                                                                       | [preplayresponse](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/UplynkEventMap#preplayresponse)                     | Fired when a Preplay response is received.                                                                                                    |
| Uplynk                                                                                                                                       | [ads](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/Uplynk#ads)                                                     | The Uplynk SSAI API.                                                                                                                          |
| Uplynk                                                                                                                                       | [assets](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/Uplynk#assets)                                               | List of Uplynk assets.                                                                                                                        |
| [Uplynk Ad Break List](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/UplynkAdBreakListEventMap) | [addadbreak](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/UplynkAdBreakListEventMap#addadbreak)                    | Fired when the ad break is added.                                                                                                             |
| Uplynk Ad Break List                                                                                                                         | [removeadbreak](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/UplynkAdBreakListEventMap#removeadbreak)              | Fired when the ad break is removed.                                                                                                           |
| [Uplynk Ad Break](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/UplynkAdBreakEventMap)          | [adbreakbegin](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/UplynkAdBreakEventMap#adbreakbegin)                    | Fired when the ad break begins.                                                                                                               |
| Uplynk Ad Break                                                                                                                              | [adbreakend](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/UplynkAdBreakEventMap#adbreakend)                        | Fired when the ad break ends.                                                                                                                 |
| Uplynk Ad Break                                                                                                                              | [adbreakskip](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/UplynkAdBreakEventMap#adbreakskip)                      | Fired when the ad break is skipped.                                                                                                           |
| Uplynk Ad Break                                                                                                                              | [updateadbreak](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/UplynkAdBreakEventMap#updateadbreak)                  | Fired when the ad break is updated.                                                                                                           |
| [Uplynk Ad](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/UplynkAdEventMap)                     | [adbegin](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/UplynkAdEventMap#adbegin)                                   | Fired when an ad begins.                                                                                                                      |
| Uplynk Ad                                                                                                                                    | [adcomplete](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/UplynkAdEventMap#adcomplete)                             | Fired when the ad is completed.                                                                                                               |
| Uplynk Ad                                                                                                                                    | [adend](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/UplynkAdEventMap#adend)                                       | Fired when the ad ends.                                                                                                                       |
| Uplynk Ad                                                                                                                                    | [adfirstquartile](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/UplynkAdEventMap#adfirstquartile)                   | Fired when the ad reaches the first quartile.                                                                                                 |
| Uplynk Ad                                                                                                                                    | [admidpoint](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/UplynkAdEventMap#admidpoint)                             | Fired when the ad reaches the mid point.                                                                                                      |
| Uplynk Ad                                                                                                                                    | [adthirdquartile](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web/interfaces/UplynkAdEventMap#adthirdquartile)                   | Fired when the ad reaches the third quartile.                                                                                                 |

Our APIs are continuously evolving, and so is our list of events. Refer to our API references of our SDKs to go through the latest sets of events:

* [Web SDK](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/web)
* [iOS SDK](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/ios)
* [Android SDK](https://docs-preview.optiview.dolby.com/pr-860/theoplayer/v10/api-reference/android)
