Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix AddShortNoises documentation errors #352

Merged
merged 1 commit into from
Sep 30, 2024
Merged

Fix AddShortNoises documentation errors #352

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion audiomentations/augmentations/add_short_noises.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ def __init__(
fraction) the burst sound should start playing. The value must be greater than 0.
:param min_fade_in_time: Min sound/noise fade in time in seconds. Use a value larger
than 0 to avoid a "click" at the start of the sound/noise.
:param max_fade_in_time: Max sound/noise fade out time in seconds. Use a value larger
:param max_fade_in_time: Max sound/noise fade in time in seconds. Use a value larger
than 0 to avoid a "click" at the start of the sound/noise.
:param min_fade_out_time: Min sound/noise fade out time in seconds. Use a value larger
than 0 to avoid a "click" at the end of the sound/noise.
Expand Down
5 changes: 2 additions & 3 deletions docs/waveform_transforms/add_short_noises.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,7 @@ Here we add some short noise sounds to a voice recording.
added sounds/noises

[`noise_rms`](#noise_rms){ #noise_rms }: `str` • choices: `"absolute"`, `"relative"`, `"relative_to_whole_input"`
: :octicons-milestone-24: Default: `"relative"` (<=v0.27), but will be changed to
`"relative_to_whole_input"` in a future version.
: :octicons-milestone-24: Default: `"relative_to_whole_input"` (since v0.29.0)

This parameter defines how the noises will be added to the audio input.

Expand All @@ -109,7 +108,7 @@ Here we add some short noise sounds to a voice recording.
`"absolute"`. It is the minimum RMS value in dB that the added noise can take. The
lower the RMS is, the lower will the added sound be.

[`max_absolute_noise_rms_db`](#max_absolute_noise_rms_db){ #max_absolute_noise_rms_db }: `float` • unit: seconds
[`max_absolute_noise_rms_db`](#max_absolute_noise_rms_db){ #max_absolute_noise_rms_db }: `float` • unit: Decibel
: :octicons-milestone-24: Default: `-20.0`. Is only used if `noise_rms` is set to
`"absolute"`. It is the maximum RMS value in dB that the added noise can take. Note
that this value can not exceed 0.
Expand Down
Loading