The MediaTrackSettings
dictionary's sampleRate
property is an integer indicating how many audio samples per second 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.sampleRate
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.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 sampleRate = MediaTrackSettings.sampleRate;
Value
An integer value indicating how many samples each second of audio data includes. Common values include 44,100 (standard CD audio), 48,000 (standard digital audio), 96,000 (commonly used in audio mastering and post-production), and 192,000 (used for high-resolution audio in professional recording and mastering sessions). However, lower values are often used to reduce bandwidth requirements; 8,000 samples per second is adequate for comprehensible albeit imperfect human speech, and both 11,025 FPS and 22,050 FPS are often used for low-bandwidth, reduced quality sound and music.
Example
See Example: Constraint exerciser in Capabilities, constraints, and settings for an example.
Specifications
Specification | Status | Comment |
---|---|---|
Media Capture and StreamsThe definition of 'sampleRate' 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 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
sampleRate
|
Chrome
No support No |
Edge
No support No |
Firefox
No support No |
IE
No support No |
Opera
No support No |
Safari
? |
WebView Android
No support No |
Chrome Android
No support No |
Firefox Android
No support No |
Opera Android
No support No |
Safari iOS
? |
Samsung Internet Android
No support No |
Legend
- No support
- No support
- Compatibility unknown
- Compatibility unknown
See also
- Media Capture and Streams API
- Capabilities, constraints, and settings
MediaTrackConstraints.sampleRate
MediaTrackSettings
MediaTrackSettings.sampleRate by Mozilla Contributors is licensed under CC-BY-SA 2.5.