sound_ducking:
This is a config file reference. Click for instructions.
This page is reference material which explains every setting and option for this section of an MPF yaml config file. See the instructions for config files for formatting and other details. See our guide to config file examples for more examples of real configs in action.
| Valid in | |
|---|---|
| machine config files | NO  |
| mode config files | NO |
The ducking: setting in your sounds: section of your config is where
you configure ducking settings for a sound.
Required settings
The following sections are required in the sound_ducking: section of
your config:
target:
List of one (or more) events.
The list of track names to apply the ducking to when the sound is played. This most commonly contains the name of the track that music is played on.
Optional settings
The following sections are optional in the sound_ducking: section of
your config. (If you don't include them, the default will be used).
attack:
Single value, type: time string (secs)
(Instructions for entering time strings). Default: 10ms
The duration of the period over which the ducking starts until it reaches its maximum attenuation (attack stage). This value is specified as a time string.
attenuation:
Single value, type: gain setting (-inf, db, or float between 0.0 and
1.0). Default: 1.0
The attenuation (gain) to apply to the target track while ducking.
attenuation: controls how quiet to make the target track while the
sound is playing.
delay:
Single value, type: time string (secs)
(Instructions for entering time strings). Default: 0
The duration to delay after the sound starts playing before ducking starts. This value is specified as a time string.
release:
Single value, type: time string (secs)
(Instructions for entering time strings). Default: 10ms
The duration of the period over which the ducking goes from its maximum attenuation until the ducking ends (release stage). This value is specified as a time string.
release_point:
Single value, type: time string (secs)
(Instructions for entering time strings). Default: 0
The point relative to the end of the sound at which to start the returning the attenuation back to normal (release stage). A value of 0.5 seconds means to begin to release the ducking 0.5 seconds prior to the end of the sound. This value is specified as a time string.
Related How To guides
Something missing or wrong? You can fix it!
This website is edited by people like you! Is something wrong or missing? Is something out of date, or can you explain it better?
Please help us! You can fix it yourself and be an official "open source" contributor!
It's easy! See our Beginner's guide to editing the docs.
Page navigation via the keyboard: < >
You can navigate this site via the keyboard. There are two modes:
General navigation, when search is not focused:
- F , S , / : open search dialog
- P , , : go to previous page
- N , . : go to next page
While using the search function:
- Down , Up : select next / previous result
- Esc , Tab : close search
- Enter : go to highlighted page in the results