ESPHome 2025.12.0-dev
Loading...
Searching...
No Matches
esphome::speaker::PlayAction< Ts > Class Template Reference

#include <automation.h>

Inheritance diagram for esphome::speaker::PlayAction< Ts >:
esphome::Action< Ts... > esphome::Parented< Speaker >

Data Structures

union  Data
 

Public Member Functions

void set_data_template (std::vector< uint8_t >(*func)(Ts...))
 
void set_data_static (const uint8_t *data, size_t len)
 
void play (const Ts &...x) override
 
- Public Member Functions inherited from esphome::Action< Ts... >
virtual void play_complex (const Ts &...x)
 
virtual void stop_complex ()
 
virtual bool is_running ()
 Check if this or any of the following actions are currently running.
 
int num_running_total ()
 The total number of actions that are currently running in this plus any of the following actions in the chain.
 
- Public Member Functions inherited from esphome::Parented< Speaker >
 Parented ()
 
 Parented (Speaker *parent)
 
Speaker * get_parent () const
 Get the parent of this object.
 
void set_parent (Speaker *parent)
 Set the parent of this object.
 

Protected Attributes

ssize_t len_ {-1}
 
union esphome::speaker::PlayAction::Data data_
 
- Protected Attributes inherited from esphome::Action< Ts... >
friend ActionList< Ts... >
 
Action< Ts... > * next_
 
int num_running_
 The number of instances of this sequence in the list of actions that is currently being executed.
 
- Protected Attributes inherited from esphome::Parented< Speaker >
Speaker * parent_
 

Additional Inherited Members

- Protected Member Functions inherited from esphome::Action< Ts... >
void play_next_ (const Ts &...x)
 
void play_next_tuple_ (const std::tuple< Ts... > &tuple, seq< S... >)
 
void play_next_tuple_ (const std::tuple< Ts... > &tuple)
 
virtual void stop ()
 
void stop_next_ ()
 
bool is_running_next_ ()
 

Detailed Description

template<typename... Ts>
class esphome::speaker::PlayAction< Ts >

Definition at line 11 of file automation.h.

Member Function Documentation

◆ play()

template<typename... Ts>
void esphome::speaker::PlayAction< Ts >::play ( const Ts &... x)
inlineoverridevirtual

Implements esphome::Action< Ts... >.

Definition at line 23 of file automation.h.

◆ set_data_static()

template<typename... Ts>
void esphome::speaker::PlayAction< Ts >::set_data_static ( const uint8_t * data,
size_t len )
inline

Definition at line 18 of file automation.h.

◆ set_data_template()

template<typename... Ts>
void esphome::speaker::PlayAction< Ts >::set_data_template ( std::vector< uint8_t >(* func )(Ts...))
inline

Definition at line 13 of file automation.h.

Field Documentation

◆ data_

template<typename... Ts>
union esphome::speaker::PlayAction::Data esphome::speaker::PlayAction< Ts >::data_
protected

◆ len_

template<typename... Ts>
ssize_t esphome::speaker::PlayAction< Ts >::len_ {-1}
protected

Definition at line 35 of file automation.h.


The documentation for this class was generated from the following file: