ESPHome  2025.2.0
Data Structures | Enumerations
esphome::speaker Namespace Reference

Data Structures

class  AudioPipeline
 
class  FinishAction
 
struct  InfoErrorEvent
 
class  IsPlayingCondition
 
class  IsStoppedCondition
 
struct  MediaCallCommand
 
class  MuteOffAction
 
class  MuteOnAction
 
class  PlayAction
 
struct  PlaylistItem
 
class  PlayOnDeviceMediaAction
 
class  Speaker
 
class  SpeakerMediaPlayer
 
class  StopAction
 
struct  VolumeRestoreState
 
class  VolumeSetAction
 

Enumerations

enum  EventGroupBits : uint32_t {
  PIPELINE_COMMAND_STOP = (1 << 0), READER_COMMAND_INIT_HTTP = (1 << 4), READER_COMMAND_INIT_FILE = (1 << 5), READER_MESSAGE_LOADED_MEDIA_TYPE = (1 << 6),
  READER_MESSAGE_FINISHED = (1 << 7), READER_MESSAGE_ERROR = (1 << 8), DECODER_MESSAGE_FINISHED = (1 << 12), DECODER_MESSAGE_ERROR = (1 << 13)
}
 
enum  AudioPipelineType : uint8_t { AudioPipelineType::MEDIA, AudioPipelineType::ANNOUNCEMENT }
 
enum  AudioPipelineState : uint8_t {
  AudioPipelineState::STARTING_FILE, AudioPipelineState::STARTING_URL, AudioPipelineState::PLAYING, AudioPipelineState::STOPPING,
  AudioPipelineState::STOPPED, AudioPipelineState::PAUSED, AudioPipelineState::ERROR_READING, AudioPipelineState::ERROR_DECODING
}
 
enum  InfoErrorSource : uint8_t { InfoErrorSource::READER = 0, InfoErrorSource::DECODER }
 
enum  DecodingError : uint8_t { DecodingError::FAILED_HEADER = 0, DecodingError::INCOMPATIBLE_BITS_PER_SAMPLE, DecodingError::INCOMPATIBLE_CHANNELS }
 
enum  State : uint8_t { STATE_STOPPED = 0, STATE_STARTING, STATE_RUNNING, STATE_STOPPING }
 

Enumeration Type Documentation

◆ AudioPipelineState

enum esphome::speaker::AudioPipelineState : uint8_t
strong
Enumerator
STARTING_FILE 
STARTING_URL 
PLAYING 
STOPPING 
STOPPED 
PAUSED 
ERROR_READING 
ERROR_DECODING 

Definition at line 29 of file audio_pipeline.h.

◆ AudioPipelineType

enum esphome::speaker::AudioPipelineType : uint8_t
strong
Enumerator
MEDIA 
ANNOUNCEMENT 

Definition at line 24 of file audio_pipeline.h.

◆ DecodingError

enum esphome::speaker::DecodingError : uint8_t
strong
Enumerator
FAILED_HEADER 
INCOMPATIBLE_BITS_PER_SAMPLE 
INCOMPATIBLE_CHANNELS 

Definition at line 45 of file audio_pipeline.h.

◆ EventGroupBits

Enumerator
PIPELINE_COMMAND_STOP 
READER_COMMAND_INIT_HTTP 
READER_COMMAND_INIT_FILE 
READER_MESSAGE_LOADED_MEDIA_TYPE 
READER_MESSAGE_FINISHED 
READER_MESSAGE_ERROR 
DECODER_MESSAGE_FINISHED 
DECODER_MESSAGE_ERROR 

Definition at line 22 of file audio_pipeline.cpp.

◆ InfoErrorSource

enum esphome::speaker::InfoErrorSource : uint8_t
strong
Enumerator
READER 
DECODER 

Definition at line 40 of file audio_pipeline.h.

◆ State

enum esphome::speaker::State : uint8_t
Enumerator
STATE_STOPPED 
STATE_STARTING 
STATE_RUNNING 
STATE_STOPPING 

Definition at line 22 of file speaker.h.