dom/webidl/EncodedAudioChunk.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://w3c.github.io/webcodecs/#encodedaudiochunk
   8  */
   9
  10 // [Serializable] is implemented without adding attribute here.
  11 [Exposed=(Window,DedicatedWorker), Pref="dom.media.webcodecs.enabled"]
  12 interface EncodedAudioChunk {
  13   [Throws]
  14   constructor(EncodedAudioChunkInit init);
  15   readonly attribute EncodedAudioChunkType type;
  16   readonly attribute long long timestamp;          // microseconds
  17   readonly attribute unsigned long long? duration; // microseconds
  18   readonly attribute unsigned long byteLength;
  19
  20   [Throws]
  21   undefined copyTo(
  22       // bug 1696216: Should be `copyTo(AllowSharedBufferSource destination, ...)`
  23       ([AllowShared] ArrayBufferView or [AllowShared] ArrayBuffer) destination);
  24 };
  25
  26 dictionary EncodedAudioChunkInit {
  27   required EncodedAudioChunkType type;
  28   required [EnforceRange] long long timestamp;    // microseconds
  29   [EnforceRange] unsigned long long duration;     // microseconds
  30   // bug 1696216: Should be AllowSharedBufferSource
  31   required ([AllowShared] ArrayBufferView or [AllowShared] ArrayBuffer) data;
  32   sequence<ArrayBuffer> transfer = [];
  33 };
  34
  35 enum EncodedAudioChunkType {
  36     "key",
  37     "delta"
  38 };