|
| float | get_setup_priority () const override |
| |
| void | setup () override |
| |
| void | loop () override |
| |
| void | dump_config () override |
| |
| media_player::MediaPlayerTraits | get_traits () override |
| |
| bool | is_muted () const override |
| |
| void | set_volume_increment (float volume_increment) |
| |
| void | set_volume_initial (float volume_initial) |
| |
| void | set_volume_max (float volume_max) |
| |
| void | set_volume_min (float volume_min) |
| |
| void | add_media_source (uint8_t pipeline, media_source::MediaSource *media_source) |
| | Adds a media source to a pipeline and registers this player as its listener.
|
| |
| void | set_speaker (uint8_t pipeline, speaker::Speaker *speaker) |
| |
| void | set_format (uint8_t pipeline, const media_player::MediaPlayerSupportedFormat &format) |
| |
| Trigger * | get_mute_trigger () |
| |
| Trigger * | get_unmute_trigger () |
| |
| Trigger< float > * | get_volume_trigger () |
| |
| void | set_playlist_delay_ms (uint8_t pipeline, uint32_t delay_ms) |
| |
| float | get_actual_setup_priority () const |
| |
| void | set_setup_priority (float priority) |
| |
| virtual float | get_loop_priority () const |
| | priority of loop().
|
| |
| void | call () |
| |
| virtual void | on_shutdown () |
| |
| virtual void | on_safe_shutdown () |
| |
| virtual bool | teardown () |
| | Called during teardown to allow component to gracefully finish operations.
|
| |
| virtual void | on_powerdown () |
| | Called after teardown is complete to power down hardware.
|
| |
| uint8_t | get_component_state () const |
| |
| void | reset_to_construction_state () |
| | Reset this component back to the construction state to allow setup to run again.
|
| |
| bool | is_in_loop_state () const |
| | Check if this component has completed setup and is in the loop state.
|
| |
| bool | is_idle () const |
| | Check if this component is idle.
|
| |
| void | mark_failed () |
| | Mark this component as failed.
|
| |
| | ESPDEPRECATED ("Use mark_failed(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void mark_failed(const char *message) |
| |
| void | mark_failed (const LogString *message) |
| |
| void | disable_loop () |
| | Disable this component's loop.
|
| |
| void | enable_loop () |
| | Enable this component's loop.
|
| |
| void | enable_loop_soon_any_context () |
| | Thread and ISR-safe version of enable_loop() that can be called from any context.
|
| |
| bool | is_failed () const |
| |
| bool | is_ready () const |
| |
| virtual bool | can_proceed () |
| |
| bool | status_has_warning () const |
| |
| bool | status_has_error () const |
| |
| void | status_set_warning (const char *message=nullptr) |
| |
| void | status_set_warning (const LogString *message) |
| |
| void | status_set_error () |
| |
| | ESPDEPRECATED ("Use status_set_error(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void status_set_error(const char *message) |
| |
| void | status_set_error (const LogString *message) |
| |
| void | status_clear_warning () |
| |
| void | status_clear_error () |
| |
| void | status_momentary_warning (const char *name, uint32_t length=5000) |
| | Set warning status flag and automatically clear it after a timeout.
|
| |
| void | status_momentary_error (const char *name, uint32_t length=5000) |
| | Set error status flag and automatically clear it after a timeout.
|
| |
| bool | has_overridden_loop () const |
| |
| void | set_component_source (const LogString *source) |
| | Set where this component was loaded from for some debug messages.
|
| |
| const LogString * | get_component_log_str () const |
| | Get the integration where this component was declared as a LogString for logging.
|
| |
| bool | should_warn_of_blocking (uint32_t blocking_time) |
| |
| MediaPlayerCall | make_call () |
| |
| void | publish_state () |
| |
| void | add_on_state_callback (std::function< void()> &&callback) |
| |
| const StringRef & | get_name () const |
| |
| bool | has_own_name () const |
| |
| ESPDEPRECATED("object_id mangles names and all object_id methods are planned for removal " "(see https://github.com/esphome/backlog/issues/76). " "Now is the time to stop using object_id. If still needed, use get_object_id_to() " "which will remain available longer. get_object_id() will be removed in 2026.7.0", "2025.12.0") std uint32_t | get_object_id_hash () |
| |
| StringRef | get_object_id_to (std::span< char, OBJECT_ID_MAX_LEN > buf) const |
| | Get object_id with zero heap allocation For static case: returns StringRef to internal storage (buffer unused) For dynamic case: formats into buffer and returns StringRef to buffer.
|
| |
| size_t | write_object_id_to (char *buf, size_t buf_size) const |
| | Write object_id directly to buffer, returns length written (excluding null) Useful for building compound strings without intermediate buffer.
|
| |
| bool | is_internal () const |
| |
| | ESPDEPRECATED ("set_internal() is undefined behavior at runtime — components and Home Assistant are NOT " "notified. Use the 'internal:' YAML key instead. Will be removed in 2027.3.0.", "2026.3.0") void set_internal(bool internal) |
| |
| bool | is_disabled_by_default () const |
| |
| EntityCategory | get_entity_category () const |
| |
| const char * | get_device_class_to (std::span< char, MAX_DEVICE_CLASS_LENGTH > buffer) const |
| |
| template<typename T = int> |
| StringRef | get_device_class_ref () const |
| |
| template<typename T = int> |
| std::string | get_device_class () const |
| |
| | ESPDEPRECATED ("Use get_device_class_to() instead. Will be removed in ESPHome 2026.9.0", "2026.3.0") StringRef get_device_class_ref() const |
| |
| ESPDEPRECATED("Use get_device_class_to() instead. Will be removed in ESPHome 2026.9.0", "2026.3.0") std StringRef | get_unit_of_measurement_ref () const |
| |
| ESPDEPRECATED("Use get_unit_of_measurement_ref() instead for better performance (avoids string copy). Will be " "removed in ESPHome 2026.9.0", "2026.3.0") std const char * | get_icon_to (std::span< char, MAX_ICON_LENGTH > buffer) const |
| | Get the unit of measurement as std::string (deprecated, prefer get_unit_of_measurement_ref())
|
| |
| template<typename T = int> |
| StringRef | get_icon_ref () const |
| |
| template<typename T = int> |
| std::string | get_icon () const |
| |
| | ESPDEPRECATED ("Use get_icon_to() instead. Will be removed in ESPHome 2026.9.0", "2026.3.0") StringRef get_icon_ref() const |
| |
| ESPDEPRECATED("Use get_icon_to() instead. Will be removed in ESPHome 2026.9.0", "2026.3.0") std uint32_t | get_device_id () const |
| |
| Device * | get_device () const |
| |
| bool | has_state () const |
| |
| void | set_has_state (bool state) |
| |
| | ESPDEPRECATED ("Use make_entity_preference<T>() instead, or preferences won't be migrated. " "See https://github.com/esphome/backlog/issues/85. Will be removed in 2027.1.0.", "2026.7.0") uint32_t get_preference_hash() |
| | Get a unique hash for storing preferences/settings for this entity.
|
| |
| template<typename T > |
| ESPPreferenceObject | make_entity_preference (uint32_t version=0) |
| | Create a preference object for storing this entity's state/settings.
|
| |
|
| size_t | handle_media_output_ (uint8_t pipeline, media_source::MediaSource *source, const uint8_t *data, size_t length, uint32_t timeout_ms, const audio::AudioStreamInfo &stream_info) |
| |
| void | handle_media_state_changed_ (uint8_t pipeline, media_source::MediaSource *source, media_source::MediaSourceState state) |
| |
| void | handle_volume_request_ (float volume) |
| |
| void | handle_mute_request_ (bool is_muted) |
| |
| void | handle_play_uri_request_ (uint8_t pipeline, const std::string &uri) |
| |
| void | handle_speaker_playback_callback_ (uint32_t frames, int64_t timestamp, uint8_t pipeline) |
| |
| void | control (const media_player::MediaPlayerCall &call) override |
| |
| void | set_volume_ (float volume, bool publish=true) |
| | Updates this->volume and saves volume/mute state to flash for restoration if publish is true.
|
| |
| void | set_mute_state_ (bool mute_state, bool publish=true) |
| | Sets the mute state.
|
| |
| void | save_volume_restore_state_ () |
| | Saves the current volume and mute state to the flash for restoration.
|
| |
| media_player::MediaPlayerState | get_source_state_ (media_source::MediaSource *media_source, bool playlist_active, media_player::MediaPlayerState old_state) const |
| | Determine media player state from a pipeline's active source.
|
| |
| void | process_control_queue_ () |
| |
| void | handle_player_command_ (media_player::MediaPlayerCommand player_command, uint8_t pipeline) |
| |
| bool | try_execute_play_uri_ (const std::string &uri, uint8_t pipeline) |
| |
| media_source::MediaSource * | find_source_for_uri_ (const std::string &uri, uint8_t pipeline) |
| |
| void | queue_command_ (MediaPlayerControlCommand::Type type, uint8_t pipeline) |
| |
| void | queue_play_current_ (uint8_t pipeline, uint32_t delay_ms=0) |
| |
| size_t | get_playlist_position_ (uint8_t pipeline) const |
| | Maps playlist_index through shuffle indices if shuffle is active.
|
| |
| void | shuffle_playlist_ (uint8_t pipeline) |
| | Generates shuffled indices for the playlist, keeping current track at current position.
|
| |
| void | unshuffle_playlist_ (uint8_t pipeline) |
| | Clears shuffle indices and adjusts playlist_index to maintain current track.
|
| |
| void | call_loop_ () |
| |
| virtual void | call_setup () |
| |
| void | call_dump_config_ () |
| |
| void | set_component_state_ (uint8_t state) |
| | Helper to set component state (clears state bits and sets new state)
|
| |
| bool | set_status_flag_ (uint8_t flag) |
| | Helper to set a status LED flag on both this component and the app.
|
| |
| void | set_interval (uint32_t id, uint32_t interval, std::function< void()> &&f) |
| | Set an interval function with a numeric ID (zero heap allocation).
|
| |
| void | set_interval (InternalSchedulerID id, uint32_t interval, std::function< void()> &&f) |
| |
| void | set_interval (uint32_t interval, std::function< void()> &&f) |
| |
| bool | cancel_interval (uint32_t id) |
| |
| bool | cancel_interval (InternalSchedulerID id) |
| |
| ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std | ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const char *name |
| |
| | ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t id |
| |
| | ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t initial_wait_time |
| |
| ESPDEPRECATED("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const std | ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const char *name) |
| |
| | ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(uint32_t id) |
| |
| void | set_timeout (uint32_t id, uint32_t timeout, std::function< void()> &&f) |
| | Set a timeout function with a numeric ID (zero heap allocation).
|
| |
| void | set_timeout (InternalSchedulerID id, uint32_t timeout, std::function< void()> &&f) |
| |
| void | set_timeout (uint32_t timeout, std::function< void()> &&f) |
| |
| bool | cancel_timeout (uint32_t id) |
| |
| bool | cancel_timeout (InternalSchedulerID id) |
| |
| void | defer (std::function< void()> &&f) |
| | Defer a callback to the next loop() call.
|
| |
| void | defer (uint32_t id, std::function< void()> &&f) |
| | Defer a callback with a numeric ID (zero heap allocation)
|
| |
| bool | cancel_defer (uint32_t id) |
| |
| void | status_clear_warning_slow_path_ () |
| |
| void | status_clear_error_slow_path_ () |
| |
| friend | void::setup () |
| |
| friend | void::original_setup () |
| |
| void | configure_entity_ (const char *name, uint32_t object_id_hash, uint32_t entity_fields) |
| | Combined entity setup from codegen: set name, object_id hash, entity string indices, and flags.
|
| |
| void | set_device_ (Device *device) |
| |
| ESPPreferenceObject | make_entity_preference_ (size_t size, uint32_t version) |
| | Non-template helper for make_entity_preference() to avoid code bloat.
|
| |
| void | calc_object_id_ () |
| |
|
| QueueHandle_t | media_control_command_queue_ |
| |
| std::array< PipelineContext, 2 > | pipelines_ |
| |
| ESPPreferenceObject | pref_ |
| |
| Trigger | mute_trigger_ |
| |
| Trigger | unmute_trigger_ |
| |
| Trigger< float > | volume_trigger_ |
| |
| float | volume_increment_ |
| |
| float | volume_initial_ |
| |
| float | volume_max_ |
| |
| float | volume_min_ |
| |
| bool | is_muted_ {false} |
| |
| ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_interval(const std voi | set_interval )(const char *name, uint32_t interval, std::function< void()> &&f) |
| | Set an interval function with a unique name.
|
| |
| ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_interval(const std boo | cancel_interval )(const char *name) |
| | Cancel an interval function.
|
| |
| ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t | initial_wait_time |
| |
| ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t | max_attempts |
| |
| ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> && | f |
| |
| ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> float | backoff_increase_factor = 1.0f) |
| |
| uint32_t | initial_wait_time |
| |
| uint32_t uint8_t | max_attempts |
| |
| uint32_t uint8_t std::function< RetryResult(uint8_t)> && | f |
| |
| uint32_t uint8_t std::function< RetryResult(uint8_t)> float | backoff_increase_factor = 1.0f) |
| |
| uint8_t | max_attempts |
| |
| uint8_t std::function< RetryResult(uint8_t)> && | f |
| |
| uint8_t std::function< RetryResult(uint8_t)> float | backoff_increase_factor = 1.0f) |
| |
| ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_timeout(const std voi | set_timeout )(const char *name, uint32_t timeout, std::function< void()> &&f) |
| | Set a timeout function with a unique name.
|
| |
| ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_timeout(const std boo | cancel_timeout )(const char *name) |
| | Cancel a timeout function.
|
| |
| ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") void defer(const std voi | defer )(const char *name, std::function< void()> &&f) |
| | Defer a callback to the next loop() call.
|
| |
| ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_defer(const std boo | cancel_defer )(const char *name) |
| | Cancel a defer callback using the specified name, name must not be empty.
|
| |
| const LogString * | component_source_ {nullptr} |
| |
| uint16_t | warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS} |
| | Warn if blocked for this many ms (max 65.5s)
|
| |
| uint8_t | component_state_ {0x00} |
| | State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bit 5: Has overridden loop() (set at registration time) Bits 6-7: Unused - reserved for future expansion.
|
| |
| volatile bool | pending_enable_loop_ {false} |
| | ISR-safe flag for enable_loop_soon_any_context.
|
| |
| friend | MediaPlayerCall |
| |
| LazyCallbackManager< void()> | state_callback_ {} |
| |
| StringRef | name_ |
| |
| uint32_t | object_id_hash_ {} |
| |
| Device * | device_ {} |
| |
| struct esphome::EntityBase::EntityFlags | flags_ |
| |
| uint8_t | device_class_idx_ {} |
| |
| uint8_t | uom_idx_ {} |
| |
| uint8_t | icon_idx_ {} |
| |
Public Member Functions inherited from esphome::Component
1.12.0