mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 15:26:59 +00:00
Document Plex control of Sonos speakers (#13604)
This commit is contained in:
parent
1ae280160d
commit
f2646b85bc
@ -15,20 +15,17 @@ ha_domain: plex
|
|||||||
|
|
||||||
The `plex` integration allows you to connect to a [Plex Media Server](https://plex.tv). Once connected, [Plex Clients](https://www.plex.tv/apps-devices/) playing media from the connected Plex Media Server will show up as [Media Players](/integrations/media_player/) and report playback status via a [Sensor](/integrations/sensor/) in Home Assistant. The Media Players will allow you to control media playback and see the current playing item.
|
The `plex` integration allows you to connect to a [Plex Media Server](https://plex.tv). Once connected, [Plex Clients](https://www.plex.tv/apps-devices/) playing media from the connected Plex Media Server will show up as [Media Players](/integrations/media_player/) and report playback status via a [Sensor](/integrations/sensor/) in Home Assistant. The Media Players will allow you to control media playback and see the current playing item.
|
||||||
|
|
||||||
|
Support for playing music directly on linked [Sonos](/integrations/sonos/) speakers is also available for users with an active [Plex Pass](https://www.plex.tv/plex-pass/) subscription. More information [here](#sonos-playback).
|
||||||
|
|
||||||
There is currently support for the following device types within Home Assistant:
|
There is currently support for the following device types within Home Assistant:
|
||||||
|
|
||||||
- [Media Player](#media-player)
|
|
||||||
- [Sensor](#sensor)
|
- [Sensor](#sensor)
|
||||||
|
- [Media Player](#media-player)
|
||||||
|
|
||||||
If your Plex server has been claimed by a Plex account via the [claim interface](https://plex.tv/claim), Home Assistant will require authentication to connect.
|
If your Plex server has been claimed by a Plex account via the [claim interface](https://plex.tv/claim), Home Assistant will require authentication to connect.
|
||||||
|
|
||||||
The Plex integration is set up via **Configuration** -> **Integrations**. You will be redirected to the [Plex](https://plex.tv) website to sign in with your Plex account. Once access is granted, Home Assistant will connect to the server linked to the associated account. If multiple Plex servers are available on the account, you will be prompted to complete the configuration by selecting the desired server on the Integrations page. Home Assistant will show as an authorized device on the [Plex Web](https://app.plex.tv/web/app) interface under **Settings** -> **Authorized Devices**.
|
The Plex integration is set up via **Configuration** -> **Integrations**. You will be redirected to the [Plex](https://plex.tv) website to sign in with your Plex account. Once access is granted, Home Assistant will connect to the server linked to the associated account. If multiple Plex servers are available on the account, you will be prompted to complete the configuration by selecting the desired server on the Integrations page. Home Assistant will show as an authorized device on the [Plex Web](https://app.plex.tv/web/app) interface under **Settings** -> **Authorized Devices**.
|
||||||
|
|
||||||
<div class='note info'>
|
|
||||||
|
|
||||||
Local and secure connections are preferred when setting up an Integration. After the initial configuration, all connections to your Plex servers are made directly without connecting to Plex's services.
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
### Integration Options
|
### Integration Options
|
||||||
|
|
||||||
@ -58,6 +55,11 @@ Alternatively, you can manually configure a Plex server connection by selecting
|
|||||||
**Token**: A valid authorization token for your Plex server. If provided without 'Host', a connection URL will be retreived from Plex.
|
**Token**: A valid authorization token for your Plex server. If provided without 'Host', a connection URL will be retreived from Plex.
|
||||||
|
|
||||||
|
|
||||||
|
## Sensor
|
||||||
|
|
||||||
|
The `plex` sensor platform will monitor activity on a given Plex Media Server. It will create a sensor that shows the number of currently watching users as the state. If you click the sensor for more details, it will show you who is watching what.
|
||||||
|
|
||||||
|
|
||||||
## Media Player
|
## Media Player
|
||||||
|
|
||||||
The `plex` media_player platform will create Media Player entities for each connected client device. These entities will display media information, playback progress, and playback controls if supported by the device.
|
The `plex` media_player platform will create Media Player entities for each connected client device. These entities will display media information, playback progress, and playback controls if supported by the device.
|
||||||
@ -152,11 +154,37 @@ media_content_id: '{ "library_name": "Adult Movies", "video_name": "Blade" }'
|
|||||||
| NVidia Shield | Controlling playback when the Shield is both a client and a server will work but with error logging |
|
| NVidia Shield | Controlling playback when the Shield is both a client and a server will work but with error logging |
|
||||||
| Plex Web | None |
|
| Plex Web | None |
|
||||||
|
|
||||||
### Notes
|
|
||||||
|
## Sonos Playback
|
||||||
|
|
||||||
|
To play Plex music directly to Sonos speakers, the following requirements must be met:
|
||||||
|
|
||||||
|
1. Have an active [Plex Pass](https://www.plex.tv/plex-pass/) subscription.
|
||||||
|
2. Remote access enabled for your Plex server.
|
||||||
|
3. Sonos speakers linked to your Plex account [(Instructions)](https://support.plex.tv/articles/control-sonos-playback-with-a-plex-app/).
|
||||||
|
4. [Sonos](/integrations/sonos/) integration configured.
|
||||||
|
|
||||||
|
### Service `plex.play_on_sonos`
|
||||||
|
|
||||||
|
| Service data attribute | Description |
|
||||||
|
| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `entity_id` | `entity_id` of a Sonos integration device
|
||||||
|
| `media_content_id` | Quoted JSON containing:<br/><ul><li>`library_name` (Required)</li><li>`artist_name` (Required)</li><li>`album_name`</li><li>`track_name`</li><li>`track_number`</li><li>`shuffle` (0 or 1)</li></ul> |
|
||||||
|
| `media_content_type` | `MUSIC` |
|
||||||
|
|
||||||
|
##### Examples:
|
||||||
|
```yaml
|
||||||
|
entity_id: media_player.sonos_speaker
|
||||||
|
media_content_type: MUSIC
|
||||||
|
media_content_id: '{ "library_name": "Music", "artist_name": "Adele", "album_name": "25", "track_name": "Hello" }'
|
||||||
|
```
|
||||||
|
```yaml
|
||||||
|
entity_id: media_player.sonos_speaker
|
||||||
|
media_content_type: MUSIC
|
||||||
|
media_content_id: '{ "library_name": "Music", "artist_name": "Stevie Wonder", "shuffle": "1" }'
|
||||||
|
```
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
* The `plex` integration supports multiple Plex servers. Additional connections can be configured under **Configuration** > **Integrations**.
|
* The `plex` integration supports multiple Plex servers. Additional connections can be configured under **Configuration** > **Integrations**.
|
||||||
* Movies must be located under 'Movies' section in the Plex library to properly get 'playing' state.
|
* Movies must be located under 'Movies' section in the Plex library to properly get 'playing' state.
|
||||||
|
|
||||||
## Sensor
|
|
||||||
|
|
||||||
The `plex` sensor platform will monitor activity on a given [Plex Media Server](https://plex.tv/). It will create a sensor that shows the number of currently watching users as the state. If you click the sensor for more details, it will show you who is watching what.
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user