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 to the speaker component. #3952

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion .github/workflows/docker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
repo: cloudcannon/pagefind
-
name: Checkout source code
uses: actions/[email protected].6
uses: actions/[email protected].7
-
name: Set up QEMU
uses: docker/setup-qemu-action@v3
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:
uses: jaxxstorm/[email protected]
with:
repo: cloudcannon/pagefind
- uses: actions/[email protected].6
- uses: actions/[email protected].7
- name: Set up Python 3.8
uses: actions/setup-python@v5
with:
Expand Down
25 changes: 24 additions & 1 deletion components/speaker/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,20 @@ Configuration variables:
``speaker.stop`` Action
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

This action will stop playing audio data from the speaker and discard the unplayed data.
This action will stop playing audio data from the speaker and **discard** the unplayed data.

Configuration variables:

- **id** (*Optional*, :ref:`config-id`): The speaker to control. Defaults to the only one in YAML.

.. _speaker-conditions:

.. _speaker-finish:

``speaker.finish`` Action
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

This action will stop playing audio data from the speaker after all data **is** played.

Configuration variables:

Expand All @@ -79,6 +92,16 @@ 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.

Configuration variables:

- **id** (*Optional*, :ref:`config-id`): The speaker to check. Defaults to the only one in YAML.

Platforms
---------
Expand Down
Loading