Sulkta-Coop/rustypipe
Archived
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: add docstring to loudness_db parameter

Browse source
This commit is contained in:
ThetaDev 2023-04-27 00:54:43 +02:00
parent 5fbed49ac6
commit a6ca665fdf
1 changed files with 13 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

15
src/model/mod.rs
View file

@ -256,9 +256,20 @@ pub struct AudioStream {
pub codec: AudioCodec,
/// Number of audio channels
pub channels: Option<u8>,
/// Loudness
/// Audio loudness for ReplayGain correction
///
/// Not available when using the Android client
/// The track volume correction factor (0-1) can be calculated using this formula
///
/// `10^(-loudness_db/20)`
///
/// Note that the value is the inverse of the usual track gain parameter, i.e. a
/// value of 6 means the volume should be reduced by 6dB and the ReplayGain track gain
/// parameter would be -6.
///
/// More information about ReplayGain and how to apply this infomation to audio files
/// can be found here: <https://wiki.hydrogenaud.io/index.php?title=ReplayGain_1.0_specification>.
///
/// The loudness parameter is not available when using the Android client.
pub loudness_db: Option<f32>,
/// True if the deobfuscation of the nsig url parameter failed
/// and the stream will be throttled