playlist_player.md

title
playlist_player:

playlist_player:

--8<-- "config_section.md"

Valid in
machine config files	YES ✅
mode config files	YES ✅

!!! note

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

The playlist_player: section of your config is where you specify actions to perform on playlists when MPF events are received. Additional information may be found in the playlist_player documentation.

Examples:

playlist_player:
  play_attract_music:
    playlist:
      playlist: attract_music
      action: play
  advance_playlist:
    playlist:
      action: advance
  stop_playlist:
    playlist:
      action: stop

Basic usage:

playlist_player:
  <triggering_event_name>:
    <playlist track name>:
      action: <action name>
      <optional settings>
  <triggering_event_name>:
    <playlist track name>:
      action: <action name>
      <optional settings>

Optional settings

The following sections are optional in the playlist_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, stop, advance, set_repeat. Default: play

--8<-- "todo.md"

Related How To guides

--8<-- "todo.md"