Add list of states to media player developer docs (#1450)

* Add list of states to media player developer docs

* Add STATE_ON

* Apply suggestions from code review

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
This commit is contained in:
Joakim Plate 2022-08-29 08:47:46 +02:00 committed by GitHub
parent b64e346909
commit 686b818df6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -53,6 +53,20 @@ and are combined using the bitwise or (`|`) operator.
| `VOLUME_SET` | Entity volume can be set to specific levels. |
| `VOLUME_STEP` | Entity volume can be adjusted up and down. |
## States
The state of a media player can take the following possible values.
| Value | Description |
|-------------------|---------------------------------------------------------------------------------------------------------------------|
| `STATE_OFF` | Entity is turned off and is not accepting commands until turned on. |
| `STATE_ON` | Entity is turned on, but no details on its state is currently known. |
| `STATE_IDLE` | Entity is turned on and accepting commands, but currently not playing any media. Possibly at some idle home screen. |
| `STATE_PLAYING` | Entity is currently playing media. |
| `STATE_PAUSED` | Entity has an active media and is currently paused |
| `STATE_STANDBY` | Entity is in a low power state, accepting commands. |
| `STATE_BUFFERING` | Entity is preparing to start playback of some media |
## Methods
### Play Media