The MediaTrackSettings
dictionary's sampleSize
property is an integer indicating the linear sample size (in bits per sample) the MediaStreamTrack
is currently configured for. This lets you determine what value was selected to comply with your specified constraints for this property's value as described in the MediaTrackConstraints.sampleSize
property you provided when calling either getUserMedia()
or MediaStreamTrack.applyConstraints()
.
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 sampleSize = MediaTrackSettings.sampleSize;
Value
An integer value indicating how many bits each audio sample is represented by. The most commonly used sample size for many years now is 16 bits per sample, which was used for CD audio among others. Other common sample sizes are 8 (for reduced bandwidth requirements) and 24 (for high-resolution professional audio).
Each audio channel on the track requires sampleSize bits. That means that a given sample actually uses (sampleSize
/8)*channelCount
bytes of data. For example, 16-bit stereo audio requires (16/8)*2 or 4 bytes per sample.
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 Yes |
Edge
Full support ≤79 |
Firefox
No support No |
IE
No support No |
Opera
Full support Yes |
Safari
? |
WebView Android
Full support Yes |
Chrome Android
Full support Yes |
Firefox Android
No support No |
Opera Android
Full support Yes |
Safari iOS
? |
Samsung Internet Android
Full support Yes |
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.sampleSize
MediaTrackSettings
MediaTrackSettings.sampleSize by Mozilla Contributors is licensed under CC-BY-SA 2.5.