dom/webidl/AudioBuffer.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 dictionary AudioBufferOptions {
  14              unsigned long numberOfChannels = 1;
  15     required unsigned long length;
  16     required float         sampleRate;
  17 };
  18
  19 [Pref="dom.webaudio.enabled",
  20  Exposed=Window]
  21 interface AudioBuffer {
  22     [Throws]
  23     constructor(AudioBufferOptions options);
  24
  25     readonly attribute float sampleRate;
  26     readonly attribute unsigned long length;
  27
  28     // in seconds
  29     readonly attribute double duration;
  30
  31     readonly attribute unsigned long numberOfChannels;
  32
  33     [Throws]
  34     Float32Array getChannelData(unsigned long channel);
  35
  36     [Throws]
  37     undefined copyFromChannel(Float32Array destination, unsigned long channelNumber, optional unsigned long startInChannel = 0);
  38     [Throws]
  39     undefined copyToChannel(Float32Array source, unsigned long channelNumber, optional unsigned long startInChannel = 0);
  40 };