esphome-docs/components/speaker/index.rst
[NUT] 67e5ba0c19
Guide on creating and including sound clips to be played by the i2s Speaker component. (#3718)
* Add files via upload

* Add files via upload

* Update audio_clips_for_i2s.rst

* Update audio_clips_for_i2s.rst

* Update audio_clips_for_i2s.rst

* Update index.rst

missing link to the speaker component (this page is well hidden!) and added the link to the guide.

* Update audio_clips_for_i2s.rst

Dots on i

* Update audio_clips_for_i2s.rst

updated links

* Update audio_clips_for_i2s.rst

xxd link for anything else but Linux...

* Update index.rst

links in this format are strange.

* Update audio_clips_for_i2s.rst

And again... links are weird.

* Update audio_clips_for_i2s.rst

---------

Co-authored-by: H. Árkosi Róbert <robreg@zsurob.hu>
2024-03-28 08:37:40 +01:00

98 lines
2.1 KiB
ReStructuredText

Speaker Components
==================
.. seo::
:description: Instructions for setting up speakers in ESPHome.
:image: speaker.svg
The ``speaker`` domain contains common functionality shared across the
speaker platforms.
.. _config-speaker:
Base Speaker Configuration
--------------------------
No configuration variables
.. _speaker-actions:
Speaker Actions
------------------
All ``speaker`` actions can be used without specifying an ``id`` if you have only one ``speaker`` in
your configuration YAML.
.. _speaker-play:
``speaker.play`` Action
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This action will start playing raw audio data from the speaker.
.. code-block:: yaml
on_...:
# Static raw audio data
- speaker.play: [...]
# Templated, return type is std::vector<uint8_t>
- speaker.play: !lambda return {...};
# in case you need to specify the speaker id
- speaker.play:
id: my_speaker
data: [...]
Configuration variables:
- **id** (*Optional*, :ref:`config-id`): The speaker to control. Defaults to the only one in YAML.
- **data** (**Required**, list of bytes): The raw audio data to play.
.. _speaker-stop:
``speaker.stop`` Action
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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 Conditions
---------------------
All ``speaker`` conditions can be used without specifying an ``id`` if you have only one ``speaker`` in
your configuration YAML.
.. _speaker-is_playing:
``speaker.is_playing`` Condition
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This condition will check if the speaker is currently playing audio data.
Configuration variables:
- **id** (*Optional*, :ref:`config-id`): The speaker to check. Defaults to the only one in YAML.
Platforms
---------
.. toctree::
:maxdepth: 1
:glob:
*
See Also
--------
- :doc:`/guides/audio_clips_for_i2s`
- :doc:`/components/speaker/i2s_audio`
- :ghedit:`Edit`