From 11ade94a738eb5297277ff0223a3adf1463b328d Mon Sep 17 00:00:00 2001 From: NP v/d Spek Date: Wed, 14 Aug 2024 05:42:46 +0200 Subject: [PATCH] Add new Action and Condition. (#3953) Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com> --- components/speaker/index.rst | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/components/speaker/index.rst b/components/speaker/index.rst index 045d3bab0..aa9279ad9 100644 --- a/components/speaker/index.rst +++ b/components/speaker/index.rst @@ -60,6 +60,17 @@ Configuration variables: - **id** (*Optional*, :ref:`config-id`): The speaker to control. Defaults to the only one in YAML. +.. _speaker-finish: + +``speaker.finish`` Action +^^^^^^^^^^^^^^^^^^^^^^^^^ + +This action will stop playing audio data from the speaker after all data **is** played. + +Configuration variables: + +- **id** (*Optional*, :ref:`config-id`): The speaker to control. Defaults to the only one in YAML. + .. _speaker-conditions: Speaker Conditions @@ -79,6 +90,21 @@ Configuration variables: - **id** (*Optional*, :ref:`config-id`): The speaker to check. Defaults to the only one in YAML. +.. _speaker-is_stopped: + +``speaker.is_stopped`` Condition +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This condition will check if the speaker is fully stopped audio data and is in idle mode. + +.. note: + +Between the time ``speaker.is_playing`` is false and ``speaker.is_stopped`` is true the 'speaker' component is closing down structures that where used to play the data correctly. *It better to check if the speaker is stopped then that if it plays.* + +Configuration variables: + +- **id** (*Optional*, :ref:`config-id`): The speaker to check. Defaults to the only one in YAML. + Platforms ---------