jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-20 15:56:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Bang & Olufsen add overlay/announce play_media documentation (#31879)

Browse Source 
* Add overlay documentation

* Convert overlay to a play_media feature instead of custom service

* Update source/_integrations/bang_olufsen.markdown

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>

* Update source/_integrations/bang_olufsen.markdown

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>

* Update source/_integrations/bang_olufsen.markdown

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>

* Update source/_integrations/bang_olufsen.markdown

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>

* Specify default language and format

* Update source/_integrations/bang_olufsen.markdown

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
Markus Jacobsen 2024-06-04 16:36:13 +02:00 committed by GitHub
parent 16903d8b58
commit af5b791851
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 59 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
source/_integrations/bang_olufsen.markdown
View File

@ -52,7 +52,7 @@ Device model:
### play_media services
The Bang & Olufsen integration supports different playback types in the `media_player.play_media` service: playback from URL, activating a favourite, playback from a local file, playing a radio station, activating a Deezer flow and Deezer playlists, albums, and tracks.
The Bang & Olufsen integration supports different playback types in the `media_player.play_media` service: playback from URL, activating a favorite, playback from a local file, playing a radio station, activating a Deezer flow and Deezer playlists, albums, tracks, and playing files and text-to-speech (TTS) as an overlay.
#### play_media examples
@ -150,6 +150,64 @@ data:
media_content_id: 1234567890
```
##### Overlay
Interrupts currently playing media to play an audio message.
To use the Bang & Olufsen Cloud TTS, use `overlay_tts` as the `media_content_type` and enter a message into the `media_content_id` field.
Bang & Olufsen Cloud TTS messages are limited to 100 unique messages a day and are cached for 24 hours.
Extra keys available:
| Service data attribute | Optional | Description |
| ------------------------- | -------- | ------------------------------------------------------------------------------------------------ |
| `overlay_absolute_volume` | yes | Specify an absolute volume for the overlay. |
| `overlay_offset_volume` | yes | Specify a volume offset to be added to the current volume level. |
| `overlay_tts_language` | yes | Specify the language used for text-to-speech. Uses the BCP 47 standard. Default value is "en-us". |
###### Examples:
Playing a local file with an absolute volume as an overlay:
```yaml
service: media_player.play_media
target:
entity_id: media_player.beosound_balance_12345678
data:
media_content_type: music
media_content_id: media-source://media_source/local/doorbell.mp3
announce: true
extra:
overlay_absolute_volume: 60
```
Playing a Bang & Olufsen Cloud TTS message with an offset volume (as TTS messages can be quiet):
```yaml
service: media_player.play_media
target:
entity_id: media_player.beosound_balance_12345678
data:
media_content_type: overlay_tts
media_content_id: This is a test
announce: true
extra:
overlay_offset_volume: 10
```
Playing a Bang & Olufsen Cloud TTS message with a local language:
```yaml
service: media_player.play_media
target:
entity_id: media_player.beosound_balance_12345678
data:
media_content_type: overlay_tts
media_content_id: Dette er en test
announce: true
extra:
overlay_tts_language: da-dk
```
## Automations
WebSocket notifications received from the device are fired as events in Home Assistant. These can be received by listening to `bang_olufsen_websocket_event` event types, where `device_id` or `serial_number` can be used to differentiate devices.