AudioPannerNode should raise exception when distanceModel is set incorrectly
[WebKit-https.git] / Source / WebCore / Modules / webaudio / AudioPannerNode.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 module audio {
26     interface [
27         Conditional=WEB_AUDIO,
28         JSGenerateToJSObject
29     ] AudioPannerNode : AudioNode {
30         // Panning model
31         const unsigned short EQUALPOWER = 0;
32         const unsigned short HRTF = 1;
33         const unsigned short SOUNDFIELD = 2;
34
35         // Distance model
36         const unsigned short LINEAR_DISTANCE = 0;
37         const unsigned short INVERSE_DISTANCE = 1;
38         const unsigned short EXPONENTIAL_DISTANCE = 2;
39
40         // Default model for stereo is HRTF 
41         attribute unsigned short panningModel
42             setter raises(DOMException);
43
44         // Uses a 3D cartesian coordinate system 
45         void setPosition(in float x, in float y, in float z);
46         void setOrientation(in float x, in float y, in float z);
47         void setVelocity(in float x, in float y, in float z);
48
49         // Distance model
50         attribute unsigned short distanceModel
51             setter raises(DOMException);
52
53         attribute float refDistance;
54         attribute float maxDistance;
55         attribute float rolloffFactor;
56
57         // Directional sound cone
58         attribute float coneInnerAngle;
59         attribute float coneOuterAngle;
60         attribute float coneOuterGain;
61
62         // Dynamically calculated gain values          
63         readonly attribute AudioGain coneGain;
64         readonly attribute AudioGain distanceGain;
65     };
66 }