ESPHome  2024.3.1
Public Member Functions | Protected Attributes
esphome::speaker::PlayAction< Ts > Class Template Reference

#include <automation.h>

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

Public Member Functions

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

Protected Attributes

bool static_ {false}
 
std::function< std::vector< uint8_t >Ts...)> data_func_ {}
 
std::vector< uint8_t > data_static_ {}
 
- 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. More...
 
- Protected Attributes inherited from esphome::Parented< Speaker >
Speaker * parent_
 

Additional Inherited Members

- Protected Member Functions inherited from esphome::Action< Ts... >
void play_next_ (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 ( Ts...  x)
inlineoverridevirtual

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

Definition at line 22 of file automation.h.

◆ set_data_static()

template<typename... Ts>
void esphome::speaker::PlayAction< Ts >::set_data_static ( const std::vector< uint8_t > &  data)
inline

Definition at line 17 of file automation.h.

◆ set_data_template()

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

Definition at line 13 of file automation.h.

Field Documentation

◆ data_func_

template<typename... Ts>
std::function<std::vector<uint8_t>Ts...)> esphome::speaker::PlayAction< Ts >::data_func_ {}
protected

Definition at line 33 of file automation.h.

◆ data_static_

template<typename... Ts>
std::vector<uint8_t> esphome::speaker::PlayAction< Ts >::data_static_ {}
protected

Definition at line 34 of file automation.h.

◆ static_

template<typename... Ts>
bool esphome::speaker::PlayAction< Ts >::static_ {false}
protected

Definition at line 32 of file automation.h.


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