[Web IDL] Pass even more types by reference
[WebKit-https.git] / Source / WebCore / 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 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     Conditional=WEB_AUDIO,
31 ] interface AudioParam {
32     attribute unrestricted float value;
33     readonly attribute unrestricted float minValue;
34     readonly attribute unrestricted float maxValue;
35     readonly attribute unrestricted float defaultValue;
36
37     readonly attribute DOMString name;
38
39     // FIXME: Could define units constants here (seconds, decibels, cents, etc.)...
40     readonly attribute unsigned short units;
41
42     // Parameter automation.
43     void setValueAtTime(unrestricted float value, unrestricted float time);
44     void linearRampToValueAtTime(unrestricted float value, unrestricted float time);
45     void exponentialRampToValueAtTime(unrestricted float value, unrestricted float time);
46
47     // Exponentially approach the target with a rate having the given time constant.
48     void setTargetAtTime(unrestricted float target, unrestricted float time, unrestricted float timeConstant);
49
50     // Sets an array of arbitrary parameter values starting at time for the given duration.
51     // The number of values will be scaled to fit into the desired duration.
52     void setValueCurveAtTime(Float32Array? values, unrestricted float time, unrestricted float duration); // FIXME: values should not be nullable.
53
54     // Cancels all scheduled parameter changes with times greater than or equal to startTime.
55     void cancelScheduledValues(unrestricted float startTime);
56
57     [Conditional=LEGACY_WEB_AUDIO, ImplementedAs=setTargetAtTime] void setTargetValueAtTime(unrestricted float targetValue, unrestricted float time, unrestricted float timeConstant);
58
59 };