Animation.pause()

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The pause() method of the Web Animations API's Animation interface suspends playback of the animation.

Syntax

animation.pause(); 

Parameters

None.

Return value

None.

Exceptions

InvalidStateError
The animation's currentTime is unresolved (for example, if it's never been played or isn't currently playing) and the end time of the animation is positive infinity.

Throws an InvalidStateError if the animation's currentTime is unresolved (perhaps it hasn't started playing yet) and the end time of the animation is positive infinity.

Example

Animation.pause() is used many times in the Alice in Web Animations API Land Growing/Shrinking Alice Game, largely because animations created with the Element.animate() method immediately start playing and must be paused manually if you want to avoid that:

// animation of the cupcake slowly getting eaten up
var nommingCake = document.getElementById('eat-me_sprite').animate(
[
  { transform: 'translateY(0)' },
  { transform: 'translateY(-80%)' }   
], {
  fill: 'forwards',
  easing: 'steps(4, end)',
  duration: aliceChange.effect.timing.duration / 2
});

// doesn't actually need to be eaten until a click event, so pause it initially:
nommingCake.pause();

Additionally, when resetting :

// An all-purpose function to pause the animations on Alice, the cupcake, and the bottle that reads "drink me."
var stopPlayingAlice = function() {
  aliceChange.pause();
  nommingCake.pause();
  drinking.pause();
};

// When the user releases the cupcake or the bottle, pause the animations.
cake.addEventListener("mouseup", stopPlayingAlice, false);
bottle.addEventListener("mouseup", stopPlayingAlice, false);

Specifications

Specification Status Comment
Web Animations
The definition of 'play()' in that specification.
Working Draft  

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support39 ?

48

36 — 481

No26 No
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support3939 ?

48

36 — 481

26 No4.0

1. From version 36 until version 48 (exclusive): this feature is behind the dom.animations-api.core.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.

See also

Document Tags and Contributors

Last updated by: fscholz,