MediaTrackConstraints

Словарь MediaTrackConstraints используется для описания набора возможностей и значений, которые они могут принимать. Словарь ограничений передаётся в applyConstraints(), чтобы скрипт мог установить набор точных (требуемых) значений или диапазонов, а также предпочтительных значений или диапазонов значений для трека. Последний запрос на пользовательские ограничения можно получить, вызвав getConstraints().

Для указания ограничения для свойства используются следующие типы. Они позволяют указать одно или несколько exact значений, одно из которых должно быть значением параметра, или набор ideal значений, которые следует использовать, если это возможно. Вы также можете указать единственное значение (или массив значений), которое пользовательский агент постарается сопоставить после применения всех более строгих ограничений.

Дополнительную информацию о работе с ограничениями см. в Возможностях, ограничениях и настройках.

Тип ограничения ConstrainBoolean используется для указания ограничения для свойства, значение которого является булевым значением. Его значение может быть установлено в булево значение (true или false) или объект, содержащий следующие свойства:

exact

Булево значение, которое должно быть значением свойства. Если свойство не может быть установлено в это значение, сопоставление завершится неудачей.

ideal

Булево значение, задающее идеальное значение для свойства. Если это возможно, это значение будет использовано, но если нет, пользовательский агент использует наиболее близкое возможное соответствие.

Тип ограничения ConstrainDouble используется для указания ограничения для свойства, значение которого является числом с двойной точностью. Его значение может быть установлено в число или объект, содержащий следующие свойства:

max

Десятичное число, задающее наибольшее допустимое значение свойства, которое оно описывает. Если значение не может остаться равным или меньше этого значения, сопоставление завершится неудачей.

min

Десятичное число, задающее наименьшее допустимое значение свойства, которое оно описывает. Если значение не может остаться равным или больше этого значения, сопоставление завершится неудачей.

exact

Десятичное число, задающее конкретное, необходимое значение, которое должно иметь свойство, чтобы считаться приемлемым.

ideal

Десятичное число, задающее идеальное значение для свойства. Если это возможно, это значение будет использовано, но если нет, пользовательский агент использует наиболее близкое возможное соответствие.

Тип ограничения ConstrainDOMString используется для указания ограничения для свойства, значение которого является строкой. Его значение может быть установлено в строку, массив строк или объект, содержащий следующие свойства:

exact

Строка или массив строк, одна из которых должна быть значением свойства. Если свойство не может быть установлено в одно из перечисленных значений, сопоставление завершится неудачей.

ideal

Строка или массив строк, задающие идеальные значения для свойства. Если это возможно, будет использовано одно из перечисленных значений, но если нет, пользовательский агент использует наиболее близкое возможное соответствие.

Тип ограничения ConstrainULong используется для указания ограничения для свойства, значение которого является целым числом. Его значение может быть установлено в число или объект, содержащий следующие свойства:

max

Целое число, задающее наибольшее допустимое значение свойства, которое оно описывает. Если значение не может остаться равным или меньше этого значения, сопоставление завершится неудачей.

min

Целое число, задающее наименьшее допустимое значение свойства, которое оно описывает. Если значение не может остаться равным или больше этого значения, сопоставление завершится неудачей.

exact

Целое число, задающее конкретное, необходимое значение, которое должно иметь свойство, чтобы считаться приемлемым.

ideal

Целое число, задающее идеальное значение для свойства. Если это возможно, это значение будет использовано, но если нет, пользовательский агент использует наиболее близкое возможное соответствие.

Может присутствовать любая комбинация, но не обязательно все, из следующих свойств. Это может быть потому, что определённый браузер не поддерживает свойство или оно не применимо. Например, так как RTP не предоставляет некоторые из этих значений во время согласования соединения WebRTC, трек, связанный с RTCPeerConnection, не будет включать определённые значения, такие как facingMode или groupId.

deviceId

Объект ConstrainDOMString, указывающий идентификатор устройства или массив идентификаторов устройств, которые приемлемы и/или обязательны.

groupId

Объект ConstrainDOMString, указывающий идентификатор группы или массив идентификаторов групп, которые приемлемы и/или обязательны.

autoGainControl

Объект ConstrainBoolean, указывающий, предпочтительно ли и/или необходимо ли автоматическое управление усилением.

channelCount

Объект ConstrainULong, задающий количество каналов или диапазон количества каналов, которые приемлемы и/или обязательны.

echoCancellation

Объект ConstrainBoolean, задающий, предпочтительно ли и/или необходимо ли подавление эха.

latency

Объект ConstrainDouble, задающий задержку или диапазон задержек, которые приемлемы и/или обязательны.

noiseSuppression

Объект ConstrainBoolean, указывающий, предпочтительно ли и/или необходимо ли подавление шума.

sampleRate

Объект ConstrainULong, задающий частоту дискретизации или диапазон частот дискретизации, которые приемлемы и/или обязательны.

sampleSize

Объект ConstrainULong, задающий размер выборки или диапазон размеров выборок, которые приемлемы и/или обязательны.

volume Устаревшее Нестандартное

Объект ConstrainDouble, задающий громкость или диапазон громкости, которые приемлемы и/или обязательны.

whiteBalanceMode

A String specifying one of "none", "manual", "single-shot", or "continuous".

exposureMode

A String specifying one of "none", "manual", "single-shot", or "continuous".

focusMode

A String specifying one of "none", "manual", "single-shot", or "continuous".

pointsOfInterest

Координаты пикселей на сенсоре одной или нескольких точек интереса. Это может быть объект вида { x:значение, y:значение } или массив таких объектов, где значение — целое число двойной точности.

exposureCompensation

A ConstrainDouble (целое число двойной точности) задающий коррекцию диафрагмы до ±3.

colorTemperature

A ConstrainDouble (целое число двойной точности) задающий желаемую цветовую температуру в градусах Кельвина.

iso

A ConstrainDouble (целое число двойной точности) задающий желаемое значение ISO.

brightness

A ConstrainDouble (целое число двойной точности) задающий желаемое значение яркости.

contrast

A ConstrainDouble (целое число двойной точности) задающий степень разницы между светлым и тёмным.

saturation

A ConstrainDouble (целое число двойной точности) задающий степень интенсивности цвета.

sharpness

A ConstrainDouble (целое число двойной точности) задающий интенсивность краёв.

focusDistance

A ConstrainDouble (целое число двойной точности) задающий расстояние до фокусируемого объекта.

zoom

A ConstrainDouble (целое число двойной точности) задающий желаемую фокусное расстояние.

torch

Значение булевого типа, определяющее, подключен ли свет заполнения постоянно, то есть, остаётся включённым до тех пор, пока активен трек.

aspectRatio

A ConstrainDouble specifying the video отношение сторон или диапазон соотношений сторон, которые приемлемы и/или требуются.

facingMode

A ConstrainDOMString object specifying a facing or an array of facings which are acceptable and/or required.

frameRate

A ConstrainDouble specifying the frame rate or range of frame rates which are acceptable and/or required.

height

A ConstrainULong specifying the video height or range of heights which are acceptable and/or required.

width

A ConstrainULong specifying the video width or range of widths which are acceptable and/or required.

resizeMode

A ConstrainDOMString object specifying a mode or an array of modes the UA can use to derive the resolution of a video track. Allowed values are none and crop-and-scale. none означает, что пользовательский агент использует разрешение, предоставленное камерой, её драйвером или ОС. crop-and-scale означает, что пользовательский агент может использовать обрезку и масштабирование выходных данных камеры для удовлетворения других ограничений, влияющих на разрешение.

Эти ограничения относятся к свойству video объекта, переданного в getDisplayMedia() для получения потока для совместного использования экрана.

displaySurface

A ConstrainDOMString which specifies the types of display surface that may be selected by the user. This may be a single one of the following strings, or a list of them to allow multiple source surfaces:

browser

Поток содержит содержимое одной вкладки браузера, выбранной пользователем.

monitor

Видео-трек потока содержит всё содержимое одного или нескольких экранов пользователя.

window

Поток содержит одно окно, выбранное пользователем для совместного использования.

logicalSurface

A ConstrainBoolean value which may contain a single Boolean value or a set of them, indicating whether or not to allow the user to choose source surfaces which do not directly correspond to display areas. These may include backing buffers for windows to allow capture of window contents that are hidden by other windows in front of them, or buffers containing larger documents that need to be scrolled through to see the entire contents in their windows.

suppressLocalAudioPlayback Экспериментальное

A ConstrainBoolean value describing the requested or mandatory constraints placed upon the value of the suppressLocalAudioPlayback constrainable property. This property controls whether the audio playing in a tab will continue to be played out of a user's local speakers when the tab is captured.

• API захвата и потоков мультимедиа
• Возможности, ограничения и настройки
• API захвата экрана
• Использование API захвата экрана
• MediaDevices.getUserMedia()
• MediaStreamTrack.getConstraints()
• MediaStreamTrack.applyConstraints()
• MediaDevices.getSupportedConstraints()
• MediaTrackSupportedConstraints
• MediaStreamTrack.getSettings()