Warning

This is the dev documentation for an unreleased version of MPF!

This is the documentation for MPF 0.56, which is the “dev” (next) release of MPF that is a work-in-progress. Unless you’re specifically looking for this version, you probably want to use the version of documentation called “latest” which is for the latest released version of MPF. That documentation is at docs.missionpinball.org/en/latest.

sound_ducking:¶

Config file section

Valid in machine config files	NO
Valid in 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:¶