src/third_party/WebKit/Source/modules/webaudio/AudioParam.idl

   1 /*
   2  * Copyright (C) 2010 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *
   8  * 1.  Redistributions of source code must retain the above copyright
   9  *     notice, this list of conditions and the following disclaimer.
  10  * 2.  Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  14  *     its contributors may be used to endorse or promote products derived
  15  *     from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 [
  30     WillBeGarbageCollected,
  31     Conditional=WEB_AUDIO
  32 ] interface AudioParam {
  33     attribute float value;
  34     readonly attribute float minValue;
  35     readonly attribute float maxValue;
  36     readonly attribute float defaultValue;
  37
  38     readonly attribute DOMString name;
  39
  40     // FIXME: Could define units constants here (seconds, decibels, cents, etc.)...
  41     readonly attribute unsigned short units;
  42
  43     // Parameter automation.
  44     void setValueAtTime(float value, double time);
  45     void linearRampToValueAtTime(float value, double time);
  46     [RaisesException] void exponentialRampToValueAtTime(float value, double time);
  47
  48     // Exponentially approach the target with a rate having the given time constant.
  49     void setTargetAtTime(float target, double time, double timeConstant);
  50
  51     // Sets an array of arbitrary parameter values starting at time for the given duration.
  52     // The number of values will be scaled to fit into the desired duration.
  53     void setValueCurveAtTime(Float32Array values, double time, double duration);
  54
  55     // Cancels all scheduled parameter changes with times greater than or equal to startTime.
  56     void cancelScheduledValues(double startTime);
  57
  58 };