Skip to content

Commit 2187939

Browse files
authored
Merge pull request #628 from bosh/sound_player_action_replace
Document sound_player action: replace
2 parents 6bb2408 + 61e0772 commit 2187939

File tree

1 file changed

+29
-15
lines changed

1 file changed

+29
-15
lines changed

docs/config/sound_player.md

Lines changed: 29 additions & 15 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,47 +157,51 @@ 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:
158168

159169
List of one (or more) events. Those will be posted by the device.
160170
Default: `use_sound_setting`
161171

162-
Please refer to the [sounds:](sounds.md) documentation for details about this setting as it just
172+
Please refer to the [sounds:events_when_looping](sounds.md#events_when_looping) documentation for details about this setting as it just
163173
overwrites the setting in your sound.
164174

165175
### events_when_played:
166176

167177
List of one (or more) events. Those will be posted by the device.
168178
Default: `use_sound_setting`
169179

170-
Please refer to the [sounds:](sounds.md) documentation for details about this setting as it just
180+
Please refer to the [sounds:events_when_played](sounds.md#events_when_played) documentation for details about this setting as it just
171181
overwrites the setting in your sound.
172182

173183
### events_when_stopped:
174184

175185
List of one (or more) events. Those will be posted by the device.
176186
Default: `use_sound_setting`
177187

178-
Please refer to the [sounds:](sounds.md) documentation for details about this setting as it just
188+
Please refer to the [sounds:events_when_stopped](sounds.md#events_when_stopped) documentation for details about this setting as it just
179189
overwrites the setting in your sound.
180190

181191
### fade_in:
182192

183193
Single value, type: `time string (secs)`
184194
([Instructions for entering time strings](instructions/time_strings.md)). Defaults to empty.
185195

186-
Please refer to the [sounds:](sounds.md) documentation for details about this setting as it just
196+
Please refer to the [sounds:fade_in](sounds.md#fade_in) documentation for details about this setting as it just
187197
overwrites the setting in your sound.
188198

189199
### fade_out:
190200

191201
Single value, type: `time string (secs)`
192202
([Instructions for entering time strings](instructions/time_strings.md)). Defaults to empty.
193203

194-
Please refer to the [sounds:](sounds.md) documentation for details about this setting as it just
204+
Please refer to the [sounds:fade_out](sounds.md#fade_out) documentation for details about this setting as it just
195205
overwrites the setting in your sound.
196206

197207
### key:
@@ -204,45 +214,49 @@ Used to reference this sound entry when stopping/pausing/resuming it.
204214

205215
Single value, type: `int_or_token`. Defaults to empty.
206216

207-
Please refer to the [sounds:](sounds.md) documentation for details about this setting as it just
217+
Please refer to the [sounds:loops](sounds.md#loops) documentation for details about this setting as it just
208218
overwrites the setting in your sound.
209219

210220
### max_queue_time:
211221

212222
Single value, type: `time string (secs)`
213223
([Instructions for entering time strings](instructions/time_strings.md)). Default: `-1`
214224

215-
Please refer to the [sounds:](sounds.md) documentation for details about this setting as it just
225+
Please refer to the [sounds:max_queue_time](sounds.md#max_queue_time) documentation for details about this setting as it just
216226
overwrites the setting in your sound.
217227

218228
### mode_end_action:
219229

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:
227241

228242
Single value, type: `float_or_token`. Defaults to empty.
229243

230-
Please refer to the [sounds:](sounds.md) documentation for details about this setting as it just
244+
Please refer to the [sounds:pan](sounds.md#pan) documentation for details about this setting as it just
231245
overwrites the setting in your sound.
232246

233247
### priority:
234248

235249
Single value, type: `int_or_token`. Defaults to empty.
236250

237-
Please refer to the [sounds:](sounds.md) documentation for details about this setting as it just
251+
Please refer to the [sounds:priority](sounds.md#priority) documentation for details about this setting as it just
238252
overwrites the setting in your sound.
239253

240254
### start_at:
241255

242256
Single value, type: `time string (secs)`
243257
([Instructions for entering time strings](instructions/time_strings.md)). Defaults to empty.
244258

245-
Please refer to the [sounds:](sounds.md) documentation for details about this setting as it just
259+
Please refer to the [sounds:start_at](sounds.md#start_at) documentation for details about this setting as it just
246260
overwrites the setting in your sound.
247261

248262
### track:
@@ -253,15 +267,15 @@ overwrites the setting in your sound.
253267

254268
Single value, type: `string`. Defaults to empty.
255269

256-
Please refer to the [sounds:](sounds.md) documentation for details about this setting as it just
270+
Please refer to the [sounds:track](sounds.md#track) documentation for details about this setting as it just
257271
overwrites the setting in your sound.
258272

259273
### volume:
260274

261275
Single value, type: `gain setting` (-inf, db, or float between 0.0 and
262276
1.0). Defaults to empty.
263277

264-
Please refer to the [sounds:](sounds.md) documentation for details about this setting as it just
278+
Please refer to the [sounds:volume](sounds.md#volume) documentation for details about this setting as it just
265279
overwrites the setting in your sound.
266280

267281
## Related How To guides

0 commit comments

Comments
 (0)