dom/webidl/BiquadFilterNode.webidl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   4  * You can obtain one at http://mozilla.org/MPL/2.0/.
   5  *
   6  * The origin of this IDL file is
   7  * https://webaudio.github.io/web-audio-api/
   8  *
   9  * Copyright © 2012 W3C® (MIT, ERCIM, Keio), All Rights Reserved. W3C
  10  * liability, trademark and document use rules apply.
  11  */
  12
  13 enum BiquadFilterType {
  14   "lowpass",
  15   "highpass",
  16   "bandpass",
  17   "lowshelf",
  18   "highshelf",
  19   "peaking",
  20   "notch",
  21   "allpass"
  22 };
  23
  24 dictionary BiquadFilterOptions : AudioNodeOptions {
  25              BiquadFilterType type = "lowpass";
  26              float            Q = 1;
  27              float            detune = 0;
  28              float            frequency = 350;
  29              float            gain = 0;
  30 };
  31
  32 [Pref="dom.webaudio.enabled",
  33  Exposed=Window]
  34 interface BiquadFilterNode : AudioNode {
  35     [Throws]
  36     constructor(BaseAudioContext context,
  37                 optional BiquadFilterOptions options = {});
  38
  39     attribute BiquadFilterType type;
  40     readonly attribute AudioParam frequency; // in Hertz
  41     readonly attribute AudioParam detune; // in Cents
  42     readonly attribute AudioParam Q; // Quality factor
  43     readonly attribute AudioParam gain; // in Decibels
  44
  45     [Throws]
  46     undefined getFrequencyResponse(Float32Array frequencyHz,
  47                                    Float32Array magResponse,
  48                                    Float32Array phaseResponse);
  49
  50 };
  51
  52 // Mozilla extension
  53 BiquadFilterNode includes  AudioNodePassThrough;