Skip to content

hardware_sound_player:

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 YES ✅
mode config files YES ✅

Note

This section can also be used in a show file in the hardware_sounds: section of a step.

The hardware_sound_player: section of your config is where you can control external sound modules (e.g. in LISY).

This is an example:

hardware_sound_systems:
  default:
    label: Default external sound system
hardware_sound_player:
  event_posted_elsewhere1:
    2:
      action: play
  ball_started:
    3: play
  test_stop: stop

Optional settings

The following sections are optional in the hardware_sound_player: section of your config. (If you don't include them, the default will be used).

action:

Single value, type: one of the following options: play, play_file, text_to_speech, set_volume, increase_volume, decrease_volume, stop. Default: play

play will play a sound. Depending on the hardware this might stop previous sounds. Also loop behavior depends on the hardware and might be different per sound.

stop will stop all sounds.

platform_options:

Single value, type: dict. Defaults to empty.

Help us write it!

This section is unwritten or needs an update or edit. Can you help write it? Get your name in lights and geeky pinball bragging rights! Hit the magic sparkly wand to the right of the title to see this page source on GitHub. Then add/edit and submit your change. It's easy!

sound_system:

Single value, type: string name of a hardware_sound_systems: device. Default: default

In case you got multiple hardware_sound platforms you can expliticly select one here.

track:

Single value, type: integer. Default: 1

The track number to play this sound on. What this means depends on your hardware. Usually, there are one or two tracks.

value:

Single value, type: string. Defaults to empty.

The number of your sound.

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