ConstrainDOMString

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

The value of a ConstrainDOMString can be any of the following:

• A single DOMString
• An array of DOMString objects
• An object with one or both of the following properties:

exact

Either a single 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 DOMString or an arrray of DOMStrings 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
Media Capture and Streams The definition of 'ConstrainDOMString' in that specification.	Editor's Draft	Initial definition

Browser compatibility

See also

• Media Capture and Streams API
• Capabilities, constraints, and settings
• MediaTrackConstraints
• MediaTrackCapabilities
• MediaTrackSupportedConstraints