1/*
2 * Copyright (C) 2012, 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// OscillatorNode is an audio generator of periodic waveforms.
26[
27    Conditional=WEB_AUDIO,
28    JSGenerateToJSObject,
29] interface OscillatorNode : AudioNode {
30
31    // Type constants.
32    const unsigned short SINE = 0;
33    const unsigned short SQUARE = 1;
34    const unsigned short SAWTOOTH = 2;
35    const unsigned short TRIANGLE = 3;
36    const unsigned short CUSTOM = 4;
37
38    [CustomSetter] attribute DOMString type;
39
40    // Playback state constants.
41    const unsigned short UNSCHEDULED_STATE = 0;
42    const unsigned short SCHEDULED_STATE = 1;
43    const unsigned short PLAYING_STATE = 2;
44    const unsigned short FINISHED_STATE = 3;
45
46    readonly attribute unsigned short playbackState;
47
48    readonly attribute AudioParam frequency; // in Hertz
49    readonly attribute AudioParam detune; // in Cents
50
51    [RaisesException] void start(unrestricted double when);
52    [RaisesException] void stop(unrestricted double when);
53
54    [Conditional=LEGACY_WEB_AUDIO, RaisesException] void noteOn(unrestricted double when);
55    [Conditional=LEGACY_WEB_AUDIO, RaisesException] void noteOff(unrestricted double when);
56
57    void setPeriodicWave(PeriodicWave wave);
58
59    attribute EventListener onended;
60};
61