The MediaTrackConstraints
dictionary's sampleSize
property is a ConstrainLong
describing the requested or mandatory constraints placed upon the value of the sampleSize
constrainable property.
If needed, you can determine whether or not this constraint is supported by checking the value of MediaTrackSupportedConstraints.sampleSize
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 = { sampleSize: constraint }; constraintsObject.sampleSize = constraint;
Value
If this value is a number, the user agent will attempt to obtain media whose sample size (in bits per linear sample) 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 size (if exact
is specified or both min
and max
are provided and have the same value) or to a best-possible value.
Since this property can only represent linear sample sizes, this constraint can only be met by devices that can produce audio with linear samples.
Example
See Example: Constraint exerciser in Capabilities, constraints, and settings for an example.
Specifications
Specification | Status | Comment |
---|---|---|
Media Capture and StreamsThe definition of 'sampleSize' in that specification. | Candidate Recommendation | Initial specification. |
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Update compatibility data on GitHub
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
sampleSize
|
Chrome
Full support 59 |
Edge
Full support ≤79 |
Firefox
No support No |
IE
No support No |
Opera
Full support Yes |
Safari
? |
WebView Android
Full support 59 |
Chrome Android
Full support 59 |
Firefox Android
No support No |
Opera Android
? |
Safari iOS
? |
Samsung Internet Android
Full support 7.0 |
Legend
- Full support
- Full support
- No support
- No support
- Compatibility unknown
- Compatibility unknown
See also
- Media Capture and Streams API
- Capabilities, constraints, and settings
MediaTrackConstraints
MediaDevices.getSupportedConstraints()
MediaTrackSupportedConstraints
MediaStreamTrack
MediaTrackConstraints.sampleSize by Mozilla Contributors is licensed under CC-BY-SA 2.5.