ESPHome  2024.4.0
Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes
esphome::media_player::MediaPlayer Class Referenceabstract

#include <media_player.h>

Inheritance diagram for esphome::media_player::MediaPlayer:
esphome::EntityBase esphome::i2s_audio::I2SAudioMediaPlayer

Public Member Functions

MediaPlayerCall make_call ()
void publish_state ()
void add_on_state_callback (std::function< void()> &&callback)
virtual bool is_muted () const
virtual MediaPlayerTraits get_traits ()=0
- Public Member Functions inherited from esphome::EntityBase
const StringRefget_name () const
void set_name (const char *name)
bool has_own_name () const
std::string get_object_id () const
void set_object_id (const char *object_id)
uint32_t get_object_id_hash ()
bool is_internal () const
void set_internal (bool internal)
bool is_disabled_by_default () const
void set_disabled_by_default (bool disabled_by_default)
EntityCategory get_entity_category () const
void set_entity_category (EntityCategory entity_category)
std::string get_icon () const
void set_icon (const char *icon)

Data Fields

MediaPlayerState state {MEDIA_PLAYER_STATE_NONE}
float volume {1.0f}

Protected Member Functions

virtual void control (const MediaPlayerCall &call)=0
- Protected Member Functions inherited from esphome::EntityBase
virtual uint32_t hash_base ()
 The hash_base() function has been deprecated. More...
void calc_object_id_ ()

Protected Attributes

friend MediaPlayerCall
CallbackManager< void()> state_callback_ {}
- Protected Attributes inherited from esphome::EntityBase
StringRef name_
const char * object_id_c_str_ {nullptr}
const char * icon_c_str_ {nullptr}
uint32_t object_id_hash_
bool has_own_name_ {false}
bool internal_ {false}
bool disabled_by_default_ {false}
EntityCategory entity_category_ {ENTITY_CATEGORY_NONE}

Detailed Description

Definition at line 69 of file media_player.h.

Member Function Documentation

◆ add_on_state_callback()

void esphome::media_player::MediaPlayer::add_on_state_callback ( std::function< void()> &&  callback)

Definition at line 111 of file media_player.cpp.

◆ control()

virtual void esphome::media_player::MediaPlayer::control ( const MediaPlayerCall call)
protectedpure virtual

◆ get_traits()

virtual MediaPlayerTraits esphome::media_player::MediaPlayer::get_traits ( )
pure virtual

◆ is_muted()

virtual bool esphome::media_player::MediaPlayer::is_muted ( ) const

Reimplemented in esphome::i2s_audio::I2SAudioMediaPlayer.

Definition at line 80 of file media_player.h.

◆ make_call()

MediaPlayerCall esphome::media_player::MediaPlayer::make_call ( )

Definition at line 74 of file media_player.h.

◆ publish_state()

void esphome::media_player::MediaPlayer::publish_state ( )

Definition at line 115 of file media_player.cpp.

Field Documentation

◆ MediaPlayerCall

friend esphome::media_player::MediaPlayer::MediaPlayerCall

Definition at line 85 of file media_player.h.

◆ state

MediaPlayerState esphome::media_player::MediaPlayer::state {MEDIA_PLAYER_STATE_NONE}

Definition at line 71 of file media_player.h.

◆ state_callback_

CallbackManager<void()> esphome::media_player::MediaPlayer::state_callback_ {}

Definition at line 89 of file media_player.h.

◆ volume

float esphome::media_player::MediaPlayer::volume {1.0f}

Definition at line 72 of file media_player.h.

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