File: webrtc_audio_private.idl

package info (click to toggle)
chromium 138.0.7204.183-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,908 kB
  • sloc: cpp: 34,937,088; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (65 lines) | stat: -rw-r--r-- 2,416 bytes parent folder | download | duplicates (4)
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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
// Copyright 2013 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

// The <code>chrome.webrtcAudioPrivate</code> API allows enumeration
// of audio output (sink) devices.
//
// Note that device IDs as used in this API are opaque (i.e. they are
// not the hardware identifier of the device) and while they are
// unique and persistent across sessions, they are valid only to the
// extension calling this API (i.e. they cannot be shared between
// extensions).
//
// See this document for further details of this API:
// https://docs.google.com/document/d/1un8aJoUvyt5jMUkK_hoeEJ4HRw-Nf8bA25hYUOpg_Oo/

namespace webrtcAudioPrivate {

  dictionary SinkInfo {
    // The opaque identifier of the audio sink device, which is unique
    // and static for the extension calling the API but invalid for
    // others.
    DOMString sinkId;
    // The user-friendly name (e.g. "Bose Amplifier").
    DOMString sinkLabel;
    // Current sample rate of the device, in Hz. Useful e.g. to know
    // if the remote side should be asked to send a lower sampling
    // rate.
    long sampleRate;
    // True if the device is ready to play out audio. E.g. if it is a
    // device that takes an audio jack, whether a jack is plugged in.
    //
    // TODO(joi): Do unplugged devices even get included in enumeration?
    boolean isReady;
    // True if this device is the default audio sink device on the
    // machine.
    boolean isDefault;
  };

  callback GetSinksCallback = void(SinkInfo[] sinkInfo);
  callback SinkIdCallback = void(DOMString sinkId);

  interface Functions {
    // Retrieves a list of available audio sink devices.
    static void getSinks(GetSinksCallback callback);

    // Given a security origin and an input device ID valid for that
    // security origin, retrieve an audio sink ID valid for the
    // extension, or the empty string if there is no associated audio
    // sink.
    //
    // The associated sink ID can be used as a sink ID for
    // setActiveSink. It is valid irrespective of which process you are
    // setting the active sink for.
    static void getAssociatedSink(
        DOMString securityOrigin,
        DOMString sourceIdInOrigin,
        SinkIdCallback callback);
  };

  interface Events {
    // Fired when audio sink devices are added or removed.
    static void onSinksChanged();
  };
};