Back to Content

HTMLMediaElement: pause event

files/en-us/web/api/htmlmediaelement/pause_event/index.md

latest3.2 KB
Original Source

{{APIRef("HTMLMediaElement")}}

The pause event is sent when a request to pause an activity is handled and the activity has entered its paused state, most commonly after the media has been paused through a call to the element's {{domxref("HTMLMediaElement.pause", "pause()")}} method.

The event is sent once the pause() method returns and after the media element's {{domxref("HTMLMediaElement.paused", "paused")}} property has been changed to true.

This event is not cancelable and does not bubble.

Syntax

Use the event name in methods like {{domxref("EventTarget.addEventListener", "addEventListener()")}}, or set an event handler property.

js-nolint
addEventListener("pause", (event) => { })

onpause = (event) => { }

Event type

A generic {{domxref("Event")}}.

Examples

These examples add an event listener for the HTMLMediaElement's pause event, then post a message when that event handler has reacted to the event firing.

Using addEventListener():

js
const video = document.querySelector("video");

video.addEventListener("pause", (event) => {
  console.log(
    "The Boolean paused property is now 'true'. Either the pause() method was called or the autoplay attribute was toggled.",
  );
});

Using the onpause event handler property:

js
const video = document.querySelector("video");

video.onpause = (event) => {
  console.log(
    "The Boolean paused property is now 'true'. Either the pause() method was called or the autoplay attribute was toggled.",
  );
};

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

  • The HTMLMediaElement {{domxref("HTMLMediaElement.playing_event", 'playing')}} event
  • The HTMLMediaElement {{domxref("HTMLMediaElement.waiting_event", 'waiting')}} event
  • The HTMLMediaElement {{domxref("HTMLMediaElement.seeking_event", 'seeking')}} event
  • The HTMLMediaElement {{domxref("HTMLMediaElement.seeked_event", 'seeked')}} event
  • The HTMLMediaElement {{domxref("HTMLMediaElement.ended_event", 'ended')}} event
  • The HTMLMediaElement {{domxref("HTMLMediaElement.loadedmetadata_event", 'loadedmetadata')}} event
  • The HTMLMediaElement {{domxref("HTMLMediaElement.loadeddata_event", 'loadeddata')}} event
  • The HTMLMediaElement {{domxref("HTMLMediaElement.canplay_event", 'canplay')}} event
  • The HTMLMediaElement {{domxref("HTMLMediaElement.canplaythrough_event", 'canplaythrough')}} event
  • The HTMLMediaElement {{domxref("HTMLMediaElement.durationchange_event", 'durationchange')}} event
  • The HTMLMediaElement {{domxref("HTMLMediaElement.timeupdate_event", 'timeupdate')}} event
  • The HTMLMediaElement {{domxref("HTMLMediaElement.play_event", 'play')}} event
  • The HTMLMediaElement {{domxref("HTMLMediaElement.ratechange_event", 'ratechange')}} event
  • The HTMLMediaElement {{domxref("HTMLMediaElement.volumechange_event", 'volumechange')}} event
  • The HTMLMediaElement {{domxref("HTMLMediaElement.suspend_event", 'suspend')}} event
  • The HTMLMediaElement {{domxref("HTMLMediaElement.emptied_event", 'emptied')}} event
  • The HTMLMediaElement {{domxref("HTMLMediaElement.stalled_event", 'stalled')}} event

See also

  • {{domxref("HTMLAudioElement")}}
  • {{domxref("HTMLVideoElement")}}
  • {{HTMLElement("audio")}}
  • {{HTMLElement("video")}}
  • {{domxref("SpeechSynthesisUtterance")}}