dom/webidl/AudioParam.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  * https://webaudio.github.io/web-audio-api/
   8  *
   9  * Copyright © 2012 W3C® (MIT, ERCIM, Keio), All Rights Reserved. W3C
  10  * liability, trademark and document use rules apply.
  11  */
  12
  13 enum AutomationRate {
  14     "a-rate",
  15     "k-rate"
  16 };
  17
  18 [Pref="dom.webaudio.enabled",
  19  Exposed=Window]
  20 interface AudioParam {
  21
  22                     attribute float value;
  23     readonly        attribute float defaultValue;
  24     readonly        attribute float minValue;
  25     readonly        attribute float maxValue;
  26
  27     // Parameter automation.
  28     [Throws]
  29     AudioParam setValueAtTime(float value, double startTime);
  30     [Throws]
  31     AudioParam linearRampToValueAtTime(float value, double endTime);
  32     [Throws]
  33     AudioParam exponentialRampToValueAtTime(float value, double endTime);
  34
  35     // Exponentially approach the target value with a rate having the given time constant.
  36     [Throws]
  37     AudioParam setTargetAtTime(float target, double startTime, double timeConstant);
  38
  39     // Sets an array of arbitrary parameter values starting at time for the given duration.
  40     // The number of values will be scaled to fit into the desired duration.
  41     [Throws]
  42     AudioParam setValueCurveAtTime(sequence<float> values, double startTime, double duration);
  43
  44     // Cancels all scheduled parameter changes with times greater than or equal to startTime.
  45     [Throws]
  46     AudioParam cancelScheduledValues(double startTime);
  47
  48 };
  49
  50 // Mozilla extension
  51 partial interface AudioParam {
  52   // The ID of the AudioNode this AudioParam belongs to.
  53   [ChromeOnly]
  54   readonly attribute unsigned long parentNodeId;
  55   // The name of the AudioParam
  56   [ChromeOnly]
  57   readonly attribute DOMString name;
  58 };
  59
  60 partial interface AudioParam {
  61   // This attribute is used for mochitest only.
  62   [ChromeOnly]
  63   readonly attribute boolean isTrackSuspended;
  64 };