Add media_player.repeat_set (#15037)

* Add media_player.repeat_set

* ✏️ Correct entity_id, since it is optional

Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
Anders Melchiorsen 2020-10-20 23:28:08 +02:00 committed by GitHub
parent 36d5544140
commit 336dbea330
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -13,17 +13,17 @@ Interacts with media players on your network.
## Services
### Media control services
Available services: `turn_on`, `turn_off`, `toggle`, `volume_up`, `volume_down`, `volume_set`, `volume_mute`, `media_play_pause`, `media_play`, `media_pause`, `media_stop`, `media_next_track`, `media_previous_track`, `clear_playlist`, `shuffle_set`, `play_media`, `select_source`, `select_sound_mode`
Available services: `turn_on`, `turn_off`, `toggle`, `volume_up`, `volume_down`, `volume_set`, `volume_mute`, `media_play_pause`, `media_play`, `media_pause`, `media_stop`, `media_next_track`, `media_previous_track`, `clear_playlist`, `shuffle_set`, `repeat_set`, `play_media`, `select_source`, `select_sound_mode`
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------ |
| `entity_id` | no | Target a specific media player. To target all media players, use `all`. |
| `entity_id` | yes | Target a specific media player. To target all media players, use `all`. |
#### Service `media_player.volume_mute`
| Service data attribute | Optional | Description |
|------------------------|----------|--------------------------------------------------|
| `entity_id` | no | Target a specific media player. To target all media players, use `all`. |
| `entity_id` | yes | Target a specific media player. To target all media players, use `all`. |
| `is_volume_muted` | no | True/false for mute/unmute |
#### Service `media_player.volume_set`
@ -37,14 +37,14 @@ Available services: `turn_on`, `turn_off`, `toggle`, `volume_up`, `volume_down`,
| Service data attribute | Optional | Description |
|------------------------|----------|--------------------------------------------------------|
| `entity_id` | no | Target a specific media player. To target all media players, use `all`. |
| `entity_id` | yes | Target a specific media player. To target all media players, use `all`. |
| `seek_position` | no | Position to seek to. The format is platform dependent. |
#### Service `media_player.play_media`
| Service data attribute | Optional | Description |
| -----------------------| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | no | Target a specific media player. To target all media players, use `all`. |
| `entity_id` | yes | Target a specific media player. To target all media players, use `all`. |
| `media_content_id` | no | A media identifier. The format of this is integration dependent. For example, you can provide URLs to Sonos and Cast but only a playlist ID to iTunes. |
| `media_content_type` | no | A media type. Must be one of `music`, `tvshow`, `video`, `episode`, `channel` or `playlist`. For example, to play music you would set `media_content_type` to `music`. |
@ -52,7 +52,7 @@ Available services: `turn_on`, `turn_off`, `toggle`, `volume_up`, `volume_down`,
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------- |
| `entity_id` | no | Target a specific media player. To target all media players, use `all`. |
| `entity_id` | yes | Target a specific media player. To target all media players, use `all`. |
| `source` | no | Name of the source to switch to. Platform dependent. |
#### Service `media_player.select_sound_mode`
@ -61,7 +61,7 @@ Currently only supported on [Denon AVR](/integrations/denonavr/) and [Songpal](
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------- |
| `entity_id` | no | Target a specific media player. For example `media_player.marantz`|
| `entity_id` | yes | Target a specific media player. For example `media_player.marantz`|
| `sound_mode` | no | Name of the sound mode to switch to. Platform dependent.|
#### Service `media_player.shuffle_set`
@ -70,9 +70,16 @@ Currently only supported on [Sonos](/integrations/sonos), [Spotify](/integration
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------- |
| `entity_id` | no | Target a specific media player. For example `media_player.spotify`|
| `entity_id` | yes | Target a specific media player. For example `media_player.spotify`|
| `shuffle` | no | `true`/`false` for enabling/disabling shuffle |
#### Service `media_player.repeat_set`
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------- |
| `entity_id` | yes | Target a specific media player. For example `media_player.kitchen`|
| `repeat` | no | `off`/`all`/`one` for setting repeat mode |
### Device Class
The way media players are displayed in the frontend can be modified in the [customize section](/getting-started/customizing-devices/). The following device classes are supported for media players: