summaryrefslogtreecommitdiff
path: root/dom/webidl/AudioChannelManager.webidl
blob: 86bfd65daf5cb0592d9163471b1f6ffc96e250c8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */

interface AudioChannelManager : EventTarget {
  /**
   * Indicates whether the headphones are plugged in or not.
   */
  readonly attribute boolean headphones;

  /**
   * Fired when the headphones are plugged or unplugged.
   *
   * When the headphones are unplugged, we may start playing audio through the
   * system's speakers.  Similarly, when headphones are plugged in, we may
   * switch audio from speakers to headphones.
   *
   * If audio is currently playing in this window or in one of its children, we
   * will fire this event before we switch the audio output from headphones to
   * speakers (or vice versa).  This allows you to, for example, pause your
   * window's audio when the headphones are unplugged.
   */
  attribute EventHandler onheadphoneschange;

  /**
   * Indicates which audio channel is used to adjust volume when pressing HW
   * volume keys.
   */
  attribute DOMString volumeControlChannel;

  [Pure, Cached, Throws,
   Pref="dom.mozBrowserFramesEnabled",
   ChromeOnly]
  readonly attribute sequence<BrowserElementAudioChannel> allowedAudioChannels;
};