[subcommand sleep]
purpose = stream, fade out, sleep, fade in
[description]
- Change to the initial volume and select the initial mood/playlist.
- Fade out to the given fade-out volume in the specified time. Switch
- to the sleep mood/playlist and wait until wake time minus fade-in
- time. Finally, switch to the wake mood/playlist and fade in to the
- fade-in volume.
+ Set the initial volume and mood, start playing and sleep. Then switch
+ to the fade-out mood and fade to the fade-out volume. Next, switch to
+ the sleep mood and wait until wake time minus fade-in time. Finally,
+ switch to the wake mood and fade in to the fade-in volume.
[/description]
[option ivol]
summary = set initial volume
channel part may be omitted, in which case the default channel is
used. This option may be given multiple times.
[/help]
+ [option initial-mood]
+ summary = mood or playlist to start with
+ arg_info = required_arg
+ arg_type = string
+ typestr = mood_spec
+ [help]
+ This mood or playlist is selected right after setting the initial
+ volume and before fade-out starts. If unset, fade-out starts
+ immediately.
+ [/help]
+ [option initial-delay]
+ summary = time before fade-out starts.
+ arg_info = required_arg
+ arg_type = uint32
+ typestr = seconds
+ default_val = 0
+ [help]
+ If left at the default, no initial delay occurs even if an initial
+ mood is given.
+ [/help]
[option fo-mood]
summary = mood or playlist for fade-out
arg_info = required_arg
arg_type = string
typestr = mood_spec
- default_val = m/fade
[help]
This mood (or playlist) is selected right after setting the initial
volume.
arg_info = required_arg
arg_type = string
typestr = mood_spec
- default_val = m/sleep
[help]
Select the given mood or playlist after the fade-out. If unset,
playback is stopped until fade-in starts.
arg_info = required_arg
arg_type = string
typestr = mood_spec
- default_val = m/wake
[help]
This mood or playlist is selected right before fade-in begins.
[/help]