Skip to content

Commit c2a5be7

Browse files
committed
add replace action to sound_player documentation
1 parent 6bb2408 commit c2a5be7

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

docs/config/sound_player.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,11 @@ your config. (If you don't include them, the default will be used).
7070
Single value, type: `time string (secs)`
7171
([Instructions for entering time strings](instructions/time_strings.md)). Default: `-1`
7272

73-
--8<-- "todo.md"
73+
!!! warning ""
74+
75+
`about_to_finish_time` is not implemented in MPF 0.80
76+
77+
See: [`sounds:about_to_finish_time`](sounds.md#about_to_finish_time)
7478

7579
### action:
7680

@@ -99,6 +103,8 @@ specified sound. Options for `action:` are:
99103
All instances of the sound or sound pool will be immediately
100104
stopped. The request is ignored if the sound is not currently
101105
loaded.
106+
* `replace` - *new in MPF 0.80* - All sounds currently playing on the
107+
specified bus are stopped, and the replacing sound is played.
102108

103109
### block:
104110

@@ -151,7 +157,11 @@ before playing the sound.
151157
List of one (or more) events. Those will be posted by the device.
152158
Default: `use_sound_setting`
153159

154-
Please refer to the [sounds:](sounds.md) documentation for details about this setting as it just
160+
!!! warning ""
161+
162+
`events_when_about_to_finish` is not implemented in MPF 0.80
163+
164+
Please refer to the [sounds:events_when_about_to_finish](sounds.md#events_when_about_to_finish) documentation for details about this setting as it just
155165
overwrites the setting in your sound.
156166

157167
### events_when_looping:
@@ -220,7 +230,11 @@ overwrites the setting in your sound.
220230
Single value, type: one of the following options: stop, stop_looping,
221231
use_sound_setting. Default: `use_sound_setting`
222232

223-
Please refer to the [sounds:](sounds.md) documentation for details about this setting as it just
233+
!!! warning ""
234+
235+
`mode_end_action` is not implemented in MPF 0.80
236+
237+
Please refer to the [sounds:mode_end_action](sounds.md#mode_end_action) documentation for details about this setting as it just
224238
overwrites the setting in your sound.
225239

226240
### pan:

0 commit comments

Comments
 (0)