{{APIRef("Media Capture and Streams")}}
The ConstrainDOMString
dictionary is used to specify a constraint for a property whose value is a string. It allows you to specify one or more exact
string values from which one must be the parameter's value, or a set of ideal
values which should be used if possible. You can also specify a single string (or an array of strings) which the user agent will do its best to match once all more stringent constraints have been applied.
Properties
exact
- Either a single {{domxref("DOMString")}} which must be the value of the property, or an array of
DOMString
objects one of which must be the property's value. If the property can't be set to one of the listed values, matching will fail.
ideal
- Either a single {{domxref("DOMString")}} or an arrray of
DOMString
s specifying ideal values for the property. If possible, one of the listed values will be used, but if it's not possible, the user agent will use the closest possible match.
Specifications
Specification |
Status |
Comment |
{{SpecName('Media Capture', '#idl-def-ConstrainDOMString', 'ConstrainDOMString')}} |
{{Spec2('Media Capture')}} |
Initial definition |
Technically, ConstrainDOMString
is actually based on an intermediary dictionary named ConstrainDOMStringParameters
, which adds exact
and ideal
to {{domxref("DOMString")}}. However, for the sake of documentation clarity, the intermediate type (present only because of quirks in {{Glossary("WebIDL")}} syntax) is ignored here.
Browser compatibility
{{CompatibilityTable}}
Feature |
Chrome |
Firefox (Gecko) |
Internet Explorer |
Microsoft Edge |
Opera |
Safari (WebKit) |
Basic support |
{{CompatVersionUnknown}} |
{{CompatGeckoDesktop(50)}} |
{{CompatNo}} |
{{CompatUnknown}} |
{{CompatNo}} |
{{CompatUnknown}} |
Feature |
Android |
Android Webview |
Firefox Mobile (Gecko) |
IE Phone |
Opera Mobile |
Safari Mobile |
Chrome for Android |
Basic support |
{{CompatUnknown}} |
{{CompatVersionUnknown}} |
{{CompatGeckoMobile(50)}} |
{{CompatNo}} |
{{CompatNo}} |
{{CompatUnknown}} |
{{CompatVersionUnknown}} |
See also