#include <media_player.h>

Inheritance diagram for esphome::media_player::MediaPlayer:

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 StringRef &	get_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)

ESPDEPRECATED("Use get_icon_ref() instead for better performance (avoids string copy). Will be removed in ESPHome 2026.5.0", "2025.11.0") std void	set_icon (const char *icon)

StringRef	get_icon_ref () const

uint32_t	get_device_id () const

void	set_device (Device *device)

bool	has_state () const

void	set_has_state (bool state)

uint32_t	get_preference_hash ()
	Get a unique hash for storing preferences/settings for this entity.

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
StringRef	get_object_id_ref_for_api_ () const

void	calc_object_id_ ()

bool	is_object_id_dynamic_ () const
	Check if the object_id is dynamic (changes with MAC suffix)

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_ {}

Device *	device_ {}

struct esphome::EntityBase::EntityFlags	flags_

Detailed Description

Definition at line 140 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 148 of file media_player.cpp.

◆ control()

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

protectedpure virtual

Implemented in esphome::i2s_audio::I2SAudioMediaPlayer, and esphome::speaker::SpeakerMediaPlayer.

◆ get_traits()

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

pure virtual

Implemented in esphome::i2s_audio::I2SAudioMediaPlayer, and esphome::speaker::SpeakerMediaPlayer.

◆ is_muted()

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

inlinevirtual

Reimplemented in esphome::i2s_audio::I2SAudioMediaPlayer, and esphome::speaker::SpeakerMediaPlayer.

Definition at line 151 of file media_player.h.

◆ make_call()

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

inline

Definition at line 145 of file media_player.h.

◆ publish_state()

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

Definition at line 152 of file media_player.cpp.

Field Documentation

◆ MediaPlayerCall

friend esphome::media_player::MediaPlayer::MediaPlayerCall

protected

Definition at line 156 of file media_player.h.

◆ state

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

Definition at line 142 of file media_player.h.

◆ state_callback_

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

protected

Definition at line 160 of file media_player.h.

◆ volume

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

Definition at line 143 of file media_player.h.

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

esphome/components/media_player/media_player.h
esphome/components/media_player/media_player.cpp

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes