Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new Action and Condition. #3953

Merged
merged 4 commits into from
Aug 14, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions components/speaker/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
---------
Expand Down