File: media_stream_constraints.idl

package info (click to toggle)
chromium 141.0.7390.107-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,254,812 kB
  • sloc: cpp: 35,264,957; ansic: 7,169,920; javascript: 4,250,185; python: 1,460,636; asm: 950,788; xml: 751,751; pascal: 187,972; sh: 89,459; perl: 88,691; objc: 79,953; sql: 53,924; cs: 44,622; fortran: 24,137; makefile: 22,319; tcl: 15,277; php: 14,018; yacc: 8,995; ruby: 7,553; awk: 3,720; lisp: 3,096; lex: 1,330; ada: 727; jsp: 228; sed: 36
file content (64 lines) | stat: -rw-r--r-- 2,761 bytes parent folder | download | duplicates (3)
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
// Copyright 2015 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

enum DisplayMediaIncludeOrExclude { "include", "exclude" };
enum DisplayMediaSystemWindowOrExclude { "system", "window", "exclude" };

typedef DisplayMediaIncludeOrExclude SystemAudioPreferenceEnum;
typedef DisplayMediaSystemWindowOrExclude WindowAudioPreferenceEnum;
typedef DisplayMediaIncludeOrExclude SelfCapturePreferenceEnum;
typedef DisplayMediaIncludeOrExclude SurfaceSwitchingPreferenceEnum;
typedef DisplayMediaIncludeOrExclude MonitorTypeSurfacesEnum;

// https://w3c.github.io/mediacapture-main/#idl-def-mediastreamconstraints
// The name differs from the spec because the name MediaStreamConstraints
// is used internally to hold all media stream constraints from getUserMedia()
// and getDisplayMedia().
dictionary UserMediaStreamConstraints {
    (boolean or MediaTrackConstraints) video = false;
    (boolean or MediaTrackConstraints) audio = false;
};

// https://www.w3.org/TR/screen-capture/#dom-displaymediastreamoptions
dictionary DisplayMediaStreamOptions {
    (boolean or MediaTrackConstraints) video = true;
    (boolean or MediaTrackConstraints) audio = false;

    // https://wicg.github.io/prefer-current-tab/#prefer-current-tab
    boolean preferCurrentTab = false;

    // https://w3c.github.io/mediacapture-screen-share/#dom-displaymediastreamoptions-controller
    [
      RuntimeEnabled = CaptureController
    ] CaptureController controller;

    SelfCapturePreferenceEnum selfBrowserSurface;
    SystemAudioPreferenceEnum systemAudio;
    [RuntimeEnabled = GetDisplayMediaWindowAudioCapture]
        WindowAudioPreferenceEnum windowAudio;
    SurfaceSwitchingPreferenceEnum surfaceSwitching;
    MonitorTypeSurfacesEnum monitorTypeSurfaces;
};

// This dictionnary is used internally to hold all members from
// UserMediaStreamConstraints and DisplayMediaStreamOptions dictionary
// passed respectively to getUserMedia() and getDisplayMedia().
// UserMediaStreamConstraints and DisplayMediaStreamOptions are converted to
// MediaStreamConstraints and consumed by MediaDevices::SendUserMediaRequest().
dictionary MediaStreamConstraints {
    (boolean or MediaTrackConstraints) video = false;
    (boolean or MediaTrackConstraints) audio = false;
    boolean preferCurrentTab = false;
    CaptureController controller;
    SelfCapturePreferenceEnum selfBrowserSurface;
    SystemAudioPreferenceEnum systemAudio;
    [RuntimeEnabled = GetDisplayMediaWindowAudioCapture]
        WindowAudioPreferenceEnum windowAudio;
    SurfaceSwitchingPreferenceEnum surfaceSwitching;
    MonitorTypeSurfacesEnum monitorTypeSurfaces;
};

dictionary AudioOutputOptions {
  DOMString deviceId = "";
};