Back to Content

MediaTrackSettings: volume property

files/en-us/web/api/mediatracksettings/volume/index.md

latest1.6 KB
Original Source

{{APIRef("Media Capture and Streams")}}{{Deprecated_Header}}{{Non-standard_Header}}

The {{domxref("MediaTrackSettings")}} dictionary's volume property is a double-precision floating-point number indicating the volume of the {{domxref("MediaStreamTrack")}} as currently configured, as a value from 0.0 (silence) to 1.0 (maximum supported volume for the device). This lets you determine what value was selected to comply with your specified constraints for this property's value as described in the {{domxref("MediaTrackConstraints.volume")}} property you provided when calling either {{domxref("MediaDevices.getUserMedia", "getUserMedia()")}} or {{domxref("MediaStreamTrack.applyConstraints()")}}.

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

Value

A double-precision floating-point number indicating the volume, from 0.0 to 1.0, of the audio track as currently configured.

Examples

See the Constraint exerciser example.

Browser compatibility

{{Compat}}

See also