Documentation for new parameter to adjust the volume (#644)

* Added parameter to adjust the volume

Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>

* Added 'volume' parameter in the runtime section

Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>

* Removed volume parameter for 'stream()' methods

Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
pull/654/head
Christoph Weitkamp 2018-03-14 14:20:47 +01:00 committed by Jerome L
parent e8cbf52986
commit 229544ad4b
2 changed files with 7 additions and 0 deletions

View File

@ -78,6 +78,7 @@ Usage: smarthome:send <item> <command> - sends a command for an item
### Audio
| `smarthome:audio play [<sink>] <filename>` | plays a sound file from the `conf/sounds` folder through the optionally specified audio sink(s)
| `smarthome:audio play <sink> <filename> <volume>` | plays a sound file from the `conf/sounds` folder through the specified audio sink(s) with the specified volume
| `smarthome:audio stream [<sink>] <url>` | streams the sound from the url through the optionally specified audio sink(s)
| `smarthome:audio sources` | lists the audio sources
| `smarthome:audio sinks` | lists the audio sinks

View File

@ -44,6 +44,9 @@ Alternatively the [`playSound()` function](https://www.eclipse.org/smarthome/doc
```java
playSound("doorbell.mp3")
playSound("doorbell.mp3", 25)
playSound("sonos:PLAY5:kitchen", "doorbell.mp3")
playSound("sonos:PLAY5:kitchen", "doorbell.mp3", 25)
```
## Voice
@ -74,8 +77,11 @@ Alternatively you can execute such commands within DSL rules by using the [`say(
```java
say("Hello world!")
say("Hello world!", 25)
say("Hello world!", "voicerss:enGB")
say("Hello world!", "voicerss:enGB", 25)
say("Hello world!", "voicerss:enUS", "sonos:PLAY5:kitchen")
say("Hello world!", "voicerss:enUS", "sonos:PLAY5:kitchen", 25)
```
You can select a particular voice (second parameter) and a particular audio sink (third parameter).