Is fired when the playback of an ad break has started. Several ON_AD_STARTED and ON_AD_FINISHED events can follow before the ad break closes with an ON_AD_BREAK_FINISHED event. This event is currently only supported for the ad client typ 'ima'. The passed event is of type PlayerEvent.
Also accessible via the bitmovin.player.EVENT.ON_AD_BREAK_STARTED constant.
Is fired when the user clicks on the ad. The passed event is of type AdClickedEvent.
Also accessible via the bitmovin.player.EVENT.ON_AD_STARTED constant.
Is fired when ad playback fails. The passed event is of type PlayerEvent.
Also accessible via the bitmovin.player.EVENT.ON_AD_STARTED constant.
Is fired when the playback of an ad has been finished. The passed event is of type PlayerEvent.
Also accessible via the bitmovin.player.EVENT.ON_AD_FINISHED constant.
Is fired when VPAID ad changes its linearity. The passed event is of type AdLinearityChangedEvent.
Also accessible via the bitmovin.player.EVENT.ON_AD_STARTED constant.
Is fired when the ad manifest has been successfully loaded. The passed event is of type AdManifestLoadedEvent.
Also accessible via the bitmovin.player.EVENT.ON_AD_MANIFEST_LOADED constant.
[new in v7.0] To overwrite the parsed manifest, the new onAdManifestLoaded callback in the Advertising part of the player configuration should be used. This event does not respect any return values anymore.
Is fired when the playback of an ad has been finished. The passed event is of type PlayerEvent.
Also accessible via the bitmovin.player.EVENT.ON_AD_PLAYBACK_FINISHED constant.
Is fired when the playback of an ad has progressed over a quartile boundary. The passed event is of type AdQuartileEvent.
Also accessible via the bitmovin.player.EVENT.ON_AD_QUARTILE constant.
Is fired when an ad manifest was successfully downloaded and parsed and the ad has been added onto the queue. The passed event is of type AdScheduledEvent.
Also accessible via the bitmovin.player.EVENT.ON_AD_STARTED constant.
Is fired when an ad has been skipped. The passed event is of type PlayerEvent.
Also accessible via the bitmovin.player.EVENT.ON_AD_SKIPPED constant.
Is fired when the playback of an ad has been started. The passed event is of type AdStartedEvent.
Also accessible via the bitmovin.player.EVENT.ON_AD_STARTED constant.
Is fired when the airplay playback target turned available. The passed event is of type PlayerEvent.
Also accessible via the bitmovin.player.EVENT.ON_AIRPLAY_AVAILABLE constant.
Is fired when a media element starts or stops AirPlay playback. The passed event is of type AirplayChangedEvent.
Also accessible via the bitmovin.player.EVENT.ON_AIRPLAY_CHANGED constant.
Is fired before a new audio segment is downloaded. The passed event is of type AudioAdaptationEvent.
Also accessible via the bitmovin.player.EVENT.ON_AUDIO_ADAPTATION constant.
[new in v6.0] To overwrite the suggested quality, the new onAudioAdaptation callback in the Adaptation part of the player configuration should be used. This event does not respect any return values anymore.
Is fired when a new audio track is added. The passed event is of type AudioTrackEvent.
Also accessible via the bitmovin.player.EVENT.ON_AUDIO_ADDED constant.
Is fired when the audio track is changed. The passed event is of type AudioChangedEvent.
Also accessible via the bitmovin.player.EVENT.ON_AUDIO_CHANGED constant.
In previous player versions, this was called ON_AUDIO_CHANGE.
Is fired when changing the downloaded audio quality is triggered, either by using setAudioQuality or due to automatic dynamic adaptation. The passed event is of type AudioDownloadQualityChangeEvent.
Also accessible via the bitmovin.player.EVENT.ON_AUDIO_DOWNLOAD_QUALITY_CHANGE constant.
Is fired when the downloaded audio quality has been changed successfully. It is (not necessarily directly) preceded by an ON_AUDIO_DOWNLOAD_QUALITY_CHANGE event. The passed event is of type AudioDownloadQualityChangedEvent.
Also accessible via the bitmovin.player.EVENT.ON_AUDIO_DOWNLOAD_QUALITY_CHANGED constant.
Is fired when the played audio quality changed. The passed event is of type AudioPlaybackQualityChangedEvent.
Also accessible via the bitmovin.player.EVENT.ON_AUDIO_PLAYBACK_QUALITY_CHANGED constant.
In previous player versions, this was called ON_AUDIO_PLAYBACK_QUALITY_CHANGE.
Is fired when one ore more audio representations have been added to the stream.
Is fired when changing the audio quality is triggered by using setAudioQuality. The passed event is of type AudioQualityChangedEvent.
Also accessible via the bitmovin.player.EVENT.ON_AUDIO_QUALITY_CHANGED constant.
Is fired when one ore more audio representations have been removed from the stream.
Is fired when an existing audio track is removed. The passed event is of type AudioTrackEvent.
Also accessible via the bitmovin.player.EVENT.ON_AUDIO_REMOVED constant.
Is fired when casting to another device, such as a ChromeCast, is available. The passed event is of type CastAvailableEvent.
Also accessible via the bitmovin.player.EVENT.ON_CAST_AVAILABLE constant.
Is fired when playback on the cast device has been paused. The passed event is of type PlayerEvent.
Also accessible via the bitmovin.player.EVENT.ON_CAST_PAUSED constant.
In previous player versions, this was called ON_CAST_PAUSE.
Is fired when playback on the cast device has finished. The passed event is of type PlayerEvent.
Also accessible via the bitmovin.player.EVENT.ON_CAST_PLAYBACK_FINISHED constant.
Is fired when playback on the cast device has started. The passed event is of type PlayerEvent.
Also accessible via the bitmovin.player.EVENT.ON_CAST_PLAYING constant.
Is fired when the casting has been initiated, but the user still needs to choose which device should be used. The passed event is of type PlayerEvent.
Also accessible via the bitmovin.player.EVENT.ON_CAST_START constant.
Is fired when the Cast app is either launched successfully or an active Cast session is resumed successfully. The passed event is of type CastStartedEvent.
Also accessible via the bitmovin.player.EVENT.ON_CAST_STARTED constant.
In versions previous to v7.0 this event was called ON_CAST_LAUNCHED.
Is fired when the casting is stopped. The passed event is of type PlayerEvent.
Also accessible via the bitmovin.player.EVENT.ON_CAST_STOPPED constant.
In previous player versions, this was called ON_CAST_STOP.
Is fired when the time update from the currently used cast device is received. The passed event is of type PlayerEvent.
Also accessible via the bitmovin.player.EVENT.ON_CAST_TIME_UPDATED constant.
In previous player versions, this was called ON_CAST_TIME_UPDATE.
Is fired when the user has chosen a cast device and the player is waiting for the device to get ready for playback. The passed event is of type CastWaitingForDeviceEvent.
Also accessible via the bitmovin.player.EVENT.ON_CAST_WAITING_FOR_DEVICE constant.
Is fired when a subtitle entry transitions into the active status. The passed event is of type SubtitleCueEvent.
Also accessible via the bitmovin.player.EVENT.ON_CUE_ENTER constant.
Is fired when an active subtitle entry transitions into the inactive status. The passed event is of type SubtitleCueEvent.
Also accessible via the bitmovin.player.EVENT.ON_CUE_EXIT constant.
Is fired when a subtitle is parsed from a stream, manifest or subtitle file. The passed event is of type SubtitleCueParsedEvent.
Also accessible via the bitmovin.player.EVENT.ON_CUE_PARSED constant.
Is fired when either the start time or the end time of a cue change. The passed event is of type SubtitleCueEvent.
Also accessible via the bitmovin.player.EVENT.ON_CUE_UPDATE constant.
Is fired when the player instance is destroyed. The passed event is of type PlayerEvent.
Also accessible via the bitmovin.player.EVENT.ON_DESTROY constant.
Is fired immediately after a download finishes successfully, or if all retries of a download failed. The passed event is of type DownloadFinishedEvent.
Also accessible via the bitmovin.player.EVENT.ON_DOWNLOAD_FINISHED constant.
Is fired if the player is paused or in buffering state and the timeShift offset has exceeded the available timeShift window. The passed event is of type PlayerEvent.
Also accessible via the bitmovin.player.EVENT.ON_DVR_WINDOW_EXCEEDED constant.
Is fired when an error during setup, e.g. neither HTML5/JS nor Flash can be used, or playback is encountered. The passed event is of type ErrorEvent.
Also accessible via the bitmovin.player.EVENT.ON_ERROR constant.
Is fired when the player enters fullscreen mode. The passed event is of type PlayerEvent.
Also accessible via the bitmovin.player.EVENT.ON_FULLSCREEN_ENTER constant.
Is fired when the player exits fullscreen mode. The passed event is of type PlayerEvent.
Also accessible via the bitmovin.player.EVENT.ON_FULLSCREEN_EXIT constant.
Is fired when metadata (i.e. ID3 tags in HLS and EMSG in DASH) are encountered. The passed event is of type MetadataEvent.
Also accessible via the bitmovin.player.EVENT.ON_METADATA constant.
Is fired when metadata (i.e. ID3 tags in HLS and EMSG in DASH) is parsed. The passed event is of type MetadataParsedEvent.
Also accessible via the bitmovin.player.EVENT.ON_METADATA_PARSED constant.
Is fired when the player is muted. The passed event is of type UserInteractionEvent.
Also accessible via the bitmovin.player.EVENT.ON_MUTED constant.
In previous player versions, this was called ON_MUTE.
Is fired when the player enters the pause state. The passed event is of type PlaybackEvent.
Also accessible via the bitmovin.player.EVENT.ON_PAUSED constant.
In previous player versions, this was called ON_PAUSE.
Is fired when a period switch starts. The passed event is of type PlayerEvent.
Also accessible via the bitmovin.player.EVENT.ON_PERIOD_SWITCH constant.
Is fired when a period switch was performed. The passed event is of type PeriodSwitchedEvent.
Also accessible via the bitmovin.player.EVENT.ON_PERIOD_SWITCHED constant.
Is fired when player enters macOS picture in picture mode. The passed event is of type PlayerEvent.
Also accessible via the bitmovin.player.EVENT.ON_PICTURE_IN_PICTURE_ENTER constant.
Is fired when player exits macOS picture in picture mode. The passed event is of type PlayerEvent.
Also accessible via the bitmovin.player.EVENT.ON_PICTURE_IN_PICTURE_EXIT constant.
Is fired when the player enters the play state. The passed event is of type PlaybackEvent.
Also accessible via the bitmovin.player.EVENT.ON_PLAY constant.
Is fired when the playback of the current video has finished. The passed event is of type PlayerEvent.
Also accessible via the bitmovin.player.EVENT.ON_PLAYBACK_FINISHED constant.
Is fired when the playback speed is changed. The passed event is of type {@link PlaybackSpeedEvent}.
Is fired when the player size is updated. The passed event is of type PlayerResizeEvent.
Also accessible via the bitmovin.player.EVENT.ON_PLAYER_RESIZE constant.
Is fired when the player actually has started playback. The passed event is of type PlaybackEvent.
Also accessible via the bitmovin.player.EVENT.ON_PLAYING constant.
Is fired when the player is initialized and ready to play and to handle API calls. The passed event is of type PlayerEvent.
Also accessible via the bitmovin.player.EVENT.ON_READY constant.
Is fired periodically during seeking. Only applies to VoD streams, please refer to onTimeShift for live. The passed event is of type SeekEvent.
Also accessible via the bitmovin.player.EVENT.ON_SEEK constant.
Is fired when seeking has been finished and data is available to continue playback. Only applies to VoD streams, please refer to onTimeShifted for live. The passed event is of type PlayerEvent.
Also accessible via the bitmovin.player.EVENT.ON_SEEKED constant.
Is fired when a segment is played back. The passed event is of type SegmentPlaybackEvent.
For HLS streams being played in the native
player technology, the TweaksConfig.native_hls_parsing
option needs to be enabled to receive this event.
Also accessible via the bitmovin.player.EVENT.ON_SEGMENT_PLAYBACK constant.
Is fired when a segment download has been finished, whether successful or not. The passed event is of type SegmentRequestFinishedEvent.
Also accessible via the bitmovin.player.EVENT.ON_SEGMENT_REQUEST_FINISHED constant.
Is fired when the airplay playback target picker is shown. The passed event is of type PlayerEvent.
Also accessible via the bitmovin.player.EVENT.ON_SHOW_AIRPLAY_TARGET_PICKER constant.
Is fired when a new source is loaded. This does not mean that loading of the new manifest has been finished. The passed event is of type SourceLoadedEvent.
Also accessible via the bitmovin.player.EVENT.ON_SOURCE_LOADED constant.
Is fired when the current source has been unloaded. The passed event is of type PlayerEvent.
Also accessible via the bitmovin.player.EVENT.ON_SOURCE_LOADED constant.
Is fired when the player ends stalling due to enough data in the buffer. The passed event is of type PlayerEvent.
Also accessible via the bitmovin.player.EVENT.ON_STALL_ENDED constant.
In previous player versions, this was called ON_STOP_BUFFERING.
Is fired when the player begins to stall and to buffer due to an empty buffer. The passed event is of type PlayerEvent.
Also accessible via the bitmovin.player.EVENT.ON_STALL_STARTED constant.
In previous player versions, this was called ON_START_BUFFERING.
Is fired when a new subtitles/captions track is added, for example using the addSubtitle API call or when in-stream closed captions are encountered. The passed event is of type SubtitleAddedEvent.
Also accessible via the bitmovin.player.EVENT.ON_SUBTITLE_ADDED constant.
Is fired when the subtitles/captions track is changed. The passed event is of type SubtitleChangedEvent.
Also accessible via the bitmovin.player.EVENT.ON_SUBTITLE_CHANGED constant.
In previous player versions, this was called ON_SUBTITLE_CHANGE.
Is fired when an external subtitle file has been removed so it is possible to update the controls accordingly. The passed event is of type SubtitleRemovedEvent.
Also accessible via the bitmovin.player.EVENT.ON_SUBTITLE_REMOVED constant.
Is fired when the current playback time has changed. The passed event is of type PlaybackEvent.
Also accessible via the bitmovin.player.EVENT.ON_TIME_CHANGED constant.
Is fired periodically during time shifting. Only applies to live streams, please refer to onSeek for VoD. The passed event is of type TimeShiftEvent.
Also accessible via the bitmovin.player.EVENT.ON_TIME_SHIFT constant.
Is fired when time shifting has been finished and data is available to continue playback. Only applies to live streams, please refer to onSeeked for VoD. The passed event is of type PlayerEvent.
Also accessible via the bitmovin.player.EVENT.ON_TIME_SHIFTED constant.
Is fired when the player is unmuted. The passed event is of type UserInteractionEvent.
Also accessible via the bitmovin.player.EVENT.ON_UNMUTED constant.
In previous player versions, this was called ON_UNMUTE.
Is fired before a new video segment is downloaded. The passed event is of type VideoAdaptationEvent.
Also accessible via the bitmovin.player.EVENT.ON_VIDEO_ADAPTATION constant.
[new in v6.0] To overwrite the suggested quality, the new onVideoAdaptation callback in the Adaptation part of the player configuration should be used. This event does not respect any return values anymore.
Is fired when changing the downloaded video quality is triggered, either by using setVideoQuality or due to automatic dynamic adaptation. The passed event is of type VideoDownloadQualityChangeEvent.
Also accessible via the bitmovin.player.EVENT.ON_VIDEO_DOWNLOAD_QUALITY_CHANGE constant.
Is fired when the downloaded video quality has been changed successfully. It is (not necessarily directly) preceded by an ON_VIDEO_DOWNLOAD_QUALITY_CHANGE event. The passed event is of type VideoDownloadQualityChangedEvent.
Also accessible via the bitmovin.player.EVENT.ON_VIDEO_DOWNLOAD_QUALITY_CHANGED constant.
Is fired when the displayed video quality changed. The passed event is of type VideoPlaybackQualityChangedEvent.
Also accessible via the bitmovin.player.EVENT.ON_VIDEO_PLAYBACK_QUALITY_CHANGED constant.
In previous player versions, this was called ON_VIDEO_PLAYBACK_QUALITY_CHANGE.
Is fired when one ore more video representations have been added to the stream.
Is fired when changing the video quality is triggered by using setVideoQuality. The passed event is of type VideoQualityChangedEvent.
Also accessible via the bitmovin.player.EVENT.ON_VIDEO_QUALITY_CHANGED constant.
Is fired when one ore more video representations have been removed from the stream.
Is fired when the volume is changed. The passed event is of type VolumeChangedEvent.
Also accessible via the bitmovin.player.EVENT.ON_VOLUME_CHANGED constant.
In previous player versions, this was called ON_VOLUME_CHANGE.
Is fired when the stereo mode during playback of VR content changes. The passed event is of type VRStereoChangedEvent.
Also accessible via the bitmovin.player.EVENT.ON_VR_STEREO_CHANGED constant.
This event is fired when the VR viewing direction changes. The minimal interval between two consecutive event callbacks is specified through PlayerVRAPI.setViewingDirectionChangeEventInterval. The passed event is of type VRViewingDirectionChangeEvent.
Also accessible via the bitmovin.player.EVENT.ON_VR_VIEWING_DIRECTION_CHANGE constant.
This event is fired when the VR viewing direction did not change more than the specified threshold in the last interval, after the ON_VR_VIEWING_DIRECTION_CHANGE event was triggered. The threshold can be set through PlayerVRAPI.setViewingDirectionChangeThreshold. The passed event is of type VRViewingDirectionChangedEvent.
Also accessible via the bitmovin.player.EVENT.ON_VR_VIEWING_DIRECTION_CHANGED constant.
Is fired when something happens which is not as serious as an error but could potentially affect playback or other functionalities. The passed event is of type WarningEvent.
Also accessible via the bitmovin.player.EVENT.ON_WARNING constant.
Generated using TypeDoc
Is fired when the playback of an ad break has ended. Is preceded by a @see ON_AD_BREAK_STARTED event. This event is currently only supported for the ad client typ 'ima'. The passed event is of type PlayerEvent.
Also accessible via the bitmovin.player.EVENT.ON_AD_BREAK_FINISHED constant.
v7.5.4