Source code

Revision control

Copy as Markdown

Other Tools

/* -*- 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/.
*
* The origin of this IDL file is
*
* Copyright © 2012 W3C® (MIT, ERCIM, Keio), All Rights Reserved. W3C
* liability, trademark and document use rules apply.
*/
// These two enums are in the spec even though they're not used directly in the
// Their binding code is used in the implementation.
enum VideoFacingModeEnum {
"user",
"environment",
"left",
"right"
};
enum MediaSourceEnum {
"camera",
"screen",
"application",
"window",
"browser",
"microphone",
"audioCapture",
"other"
// If values are added, adjust n_values in Histograms.json (2 places)
};
dictionary ConstrainLongRange {
long min;
long max;
long exact;
long ideal;
};
dictionary ConstrainDoubleRange {
double min;
double max;
double exact;
double ideal;
};
dictionary ConstrainBooleanParameters {
boolean exact;
boolean ideal;
};
dictionary ConstrainDOMStringParameters {
(DOMString or sequence<DOMString>) exact;
(DOMString or sequence<DOMString>) ideal;
};
typedef (long or ConstrainLongRange) ConstrainLong;
typedef (double or ConstrainDoubleRange) ConstrainDouble;
typedef (boolean or ConstrainBooleanParameters) ConstrainBoolean;
typedef (DOMString or sequence<DOMString> or ConstrainDOMStringParameters) ConstrainDOMString;
// Note: When adding new constraints, remember to update the SelectSettings()
// function in MediaManager.cpp to make OverconstrainedError's constraint work!
dictionary MediaTrackConstraintSet {
ConstrainLong width;
ConstrainLong height;
ConstrainDouble frameRate;
ConstrainDOMString facingMode;
DOMString mediaSource;
long long browserWindow;
boolean scrollWithPage;
ConstrainDOMString deviceId;
ConstrainDOMString groupId;
ConstrainLong viewportOffsetX;
ConstrainLong viewportOffsetY;
ConstrainLong viewportWidth;
ConstrainLong viewportHeight;
ConstrainBoolean echoCancellation;
ConstrainBoolean noiseSuppression;
ConstrainBoolean autoGainControl;
ConstrainLong channelCount;
};
[GenerateToJSON]
dictionary MediaTrackConstraints : MediaTrackConstraintSet {
sequence<MediaTrackConstraintSet> advanced;
};
enum MediaStreamTrackState {
"live",
"ended"
};
[Exposed=Window]
interface MediaStreamTrack : EventTarget {
readonly attribute DOMString kind;
readonly attribute DOMString id;
[NeedsCallerType]
readonly attribute DOMString label;
attribute boolean enabled;
readonly attribute boolean muted;
attribute EventHandler onmute;
attribute EventHandler onunmute;
readonly attribute MediaStreamTrackState readyState;
attribute EventHandler onended;
MediaStreamTrack clone ();
void stop ();
// MediaTrackCapabilities getCapabilities ();
MediaTrackConstraints getConstraints ();
[NeedsCallerType]
MediaTrackSettings getSettings ();
[NewObject, NeedsCallerType]
Promise<void> applyConstraints (optional MediaTrackConstraints constraints = {});
// attribute EventHandler onoverconstrained;
};