src/third_party/WebKit/Source/modules/webaudio/PannerNode.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  * 1.  Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2.  Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  15  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  16  * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  17  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  18  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  19  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
  20  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  22  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  23  */
  24
  25 [
  26     NoInterfaceObject,
  27     Conditional=WEB_AUDIO
  28 ] interface PannerNode : AudioNode {
  29     // Panning model
  30     const unsigned short EQUALPOWER = 0;
  31     const unsigned short HRTF = 1;
  32     const unsigned short SOUNDFIELD = 2;
  33
  34     // Distance model
  35     const unsigned short LINEAR_DISTANCE = 0;
  36     const unsigned short INVERSE_DISTANCE = 1;
  37     const unsigned short EXPONENTIAL_DISTANCE = 2;
  38
  39     // Default model for stereo is HRTF
  40     [Custom=Setter] attribute DOMString panningModel;
  41
  42     // Uses a 3D cartesian coordinate system
  43     void setPosition(float x, float y, float z);
  44     void setOrientation(float x, float y, float z);
  45     void setVelocity(float x, float y, float z);
  46
  47     // Distance model
  48     [Custom=Setter] attribute DOMString distanceModel;
  49
  50     attribute double refDistance;
  51     attribute double maxDistance;
  52     attribute double rolloffFactor;
  53
  54     // Directional sound cone
  55     attribute double coneInnerAngle;
  56     attribute double coneOuterAngle;
  57     attribute double coneOuterGain;
  58 };