Home | History | Annotate | Download | only in webaudio
      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 ] interface OscillatorNode : AudioSourceNode {
     29 
     30     // Type constants.
     31     const unsigned short SINE = 0;
     32     const unsigned short SQUARE = 1;
     33     const unsigned short SAWTOOTH = 2;
     34     const unsigned short TRIANGLE = 3;
     35     const unsigned short CUSTOM = 4;
     36 
     37     [CustomSetter] attribute DOMString type;
     38 
     39     // Playback state constants.
     40     const unsigned short UNSCHEDULED_STATE = 0;
     41     const unsigned short SCHEDULED_STATE = 1;
     42     const unsigned short PLAYING_STATE = 2;
     43     const unsigned short FINISHED_STATE = 3;
     44 
     45     readonly attribute unsigned short playbackState;
     46 
     47     readonly attribute AudioParam frequency; // in Hertz
     48     readonly attribute AudioParam detune; // in Cents
     49 
     50     void start(double when);
     51     void stop(double when);
     52 
     53     void noteOn(double when);
     54     void noteOff(double when);
     55 
     56     void setPeriodicWave(PeriodicWave periodicWave);
     57 
     58     attribute EventHandler onended;
     59 };
     60