From 686b818df6e59a2a8baf3de329f3466d189ad427 Mon Sep 17 00:00:00 2001 From: Joakim Plate Date: Mon, 29 Aug 2022 08:47:46 +0200 Subject: [PATCH] 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 Co-authored-by: Martin Hjelmare --- docs/core/entity/media-player.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/core/entity/media-player.md b/docs/core/entity/media-player.md index 4da2f117..30668175 100644 --- a/docs/core/entity/media-player.md +++ b/docs/core/entity/media-player.md @@ -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