This documentation is for an unreleased version of MPF!
This is the developer documentation for MPF 0.54, which is the “dev” (next) release of MPF that is a work-in-progress. Use the “Read the Docs” link in the lower left corner to view the developer docs for the version of MPF you’re using.
Hardware sound system using in EM and SS machines.
Accessing hardware_sound_systems in code
The device collection which contains the hardware_sound_systems in your machine is available via
self.machine.hardware_sound_systems. For example, to access one called “foo”, you would use
self.machine.hardware_sound_systems.foo. You can also access hardware_sound_systems in dictionary form, e.g.
You can also get devices by tag or hardware number. See the DeviceCollection documentation for details.
Methods & Attributes
Hardware_sound_systems have the following methods & attributes available. Note that methods & attributes inherited from base classes are not included here.
decrease_volume(volume: float, track: int = 1)¶
format_log_line(msg, context, error_no) → str¶
Return a formatted log line with log link and context.
increase_volume(volume: float, track: int = 1)¶
play(sound_number: int, track: int = 1)¶
Play a sound.
play_file(file: str, platform_options, track: int = 1)¶
Play a sound file.
raise_config_error(msg, error_no, *, context=None) → NoReturn¶
Raise a ConfigFileError exception.
set_volume(volume: float, track: int = 1)¶
stop_all_sounds(track: int = 1)¶
Stop all sounds on track.
text_to_speech(text: str, platform_options, track: int = 1)¶
Text to speech output.