dom/webidl/AnimationPlayer.webidl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   4  * You can obtain one at http://mozilla.org/MPL/2.0/.
   5  *
   6  * The origin of this IDL file is
   7  * http://dev.w3.org/fxtf/web-animations/#idl-def-AnimationPlayer
   8  *
   9  * Copyright © 2014 W3C® (MIT, ERCIM, Keio), All Rights Reserved. W3C
  10  * liability, trademark and document use rules apply.
  11  */
  12
  13 enum AnimationPlayState { "idle", "pending", "running", "paused", "finished" };
  14
  15 [Func="nsDocument::IsWebAnimationsEnabled"]
  16 interface AnimationPlayer {
  17   // Bug 1049975
  18   //           attribute AnimationNode?     source;
  19   [Pure]
  20   readonly attribute Animation? source;
  21   readonly attribute AnimationTimeline timeline;
  22   [BinaryName="startTimeAsDouble"]
  23   readonly attribute double? startTime;
  24   [BinaryName="currentTimeAsDouble"]
  25   readonly attribute double? currentTime;
  26
  27   /* Not yet implemented
  28            attribute double             playbackRate; */
  29   [BinaryName="playStateFromJS"]
  30   readonly attribute AnimationPlayState playState;
  31   [Throws]
  32   readonly attribute Promise<AnimationPlayer> ready;
  33   /*
  34   readonly attribute Promise<AnimationPlayer> finished;
  35   void cancel ();
  36   void finish ();
  37   */
  38   [BinaryName="playFromJS"]
  39   void play ();
  40   [BinaryName="pauseFromJS"]
  41   void pause ();
  42   /*
  43   void reverse ();
  44   */
  45 };
  46
  47 // Non-standard extensions
  48 partial interface AnimationPlayer {
  49   [ChromeOnly] readonly attribute boolean isRunningOnCompositor;
  50 };