MediaTrackConstraints.sampleRate

The MediaTrackConstraints dictionary's sampleRate property is a ConstrainLong describing the requested or mandatory constraints placed upon the value of the sampleRate constrainable property.

If needed, you can determine whether or not this constraint is supported by checking the value of MediaTrackSupportedConstraints.sampleRate as returned by a call to MediaDevices.getSupportedConstraints(). However, typically this is unnecessary since browsers will simply ignore any constraints they're unfamiliar with.

Syntax

var constraintsObject = { sampleRate: constraint };
constraintsObject.sampleRate = constraint;

Value

If this value is a number, the user agent will attempt to obtain media whose sample rate is as close as possible to this number given the capabilities of the hardware and the other constraints specified. Otherwise, the value of this ConstrainLong will guide the user agent in its efforts to provide an exact match to the required sample rate (if exact is specified or both min and max are provided and have the same value) or to a best-possible value.

Example

See "Example: Constraint exerciser" in Capabilities, constraints, and settings for an example.

Specifications

Browser compatibility

See also

• Media Capture and Streams API
• Capabilities, constraints, and settings
• MediaTrackConstraints
• MediaDevices.getSupportedConstraints()
• MediaTrackSupportedConstraints
• MediaStreamTrack