#include <i2s_audio_media_player.h>

Inheritance diagram for esphome::i2s_audio::I2SAudioMediaPlayer:

Public Member Functions
void	setup () override

float	get_setup_priority () const override

void	loop () override

void	dump_config () override

void	set_dout_pin (uint8_t pin)

void	set_mute_pin (GPIOPin *mute_pin)

void	set_internal_dac_mode (i2s_dac_mode_t mode)

void	set_external_dac_channels (uint8_t channels)

void	set_i2s_comm_fmt_lsb (bool lsb)

media_player::MediaPlayerTraits	get_traits () override

bool	is_muted () const override

void	start ()

void	stop ()

Public Member Functions inherited from esphome::Component
float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

virtual float	get_loop_priority () const
	priority of loop(). More...

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_shutdown ()

uint32_t	get_component_state () const

virtual void	mark_failed ()
	Mark this component as failed. More...

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="unspecified")

void	status_set_error (const char *message="unspecified")

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const std::string &name, uint32_t length=5000)

void	status_momentary_error (const std::string &name, uint32_t length=5000)

bool	has_overridden_loop () const

void	set_component_source (const char *source)
	Set where this component was loaded from for some debug messages. More...

const char *	get_component_source () const
	Get the integration where this component was declared as a string. More...

Public Member Functions inherited from esphome::Parented< I2SAudioComponent >
	Parented ()

	Parented (I2SAudioComponent *parent)

I2SAudioComponent *	get_parent () const
	Get the parent of this object. More...

void	set_parent (I2SAudioComponent *parent)
	Set the parent of this object. More...

Public Member Functions inherited from esphome::media_player::MediaPlayer
MediaPlayerCall	make_call ()

void	publish_state ()

void	add_on_state_callback (std::function< void()> &&callback)

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)

std::string	get_icon () const

void	set_icon (const char *icon)

Protected Member Functions
void	control (const media_player::MediaPlayerCall &call) override

void	mute_ ()

void	unmute_ ()

void	set_volume_ (float volume, bool publish=true)

void	start_ ()

void	stop_ ()

void	play_ ()

Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_setup ()

virtual void	call_dump_config ()

void	set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name. More...

void	set_interval (uint32_t interval, std::function< void()> &&f)

bool	cancel_interval (const std::string &name)
	Cancel an interval function. More...

void	set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
	Set an retry function with a unique name. More...

void	set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)

bool	cancel_retry (const std::string &name)
	Cancel a retry function. More...

void	set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name. More...

void	set_timeout (uint32_t timeout, std::function< void()> &&f)

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function. More...

void	defer (const std::string &name, std::function< void()> &&f)
	Defer a callback to the next loop() call. More...

void	defer (std::function< void()> &&f)
	Defer a callback to the next loop() call. More...

bool	cancel_defer (const std::string &name)
	Cancel a defer callback using the specified name, name must not be empty. More...

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
I2SState	i2s_state_ {I2S_STATE_STOPPED}

std::unique_ptr< Audio >	audio_

uint8_t	dout_pin_ {0}

GPIOPin *	mute_pin_ {nullptr}

bool	muted_ {false}

float	unmuted_volume_ {0}

i2s_dac_mode_t	internal_dac_mode_ {I2S_DAC_CHANNEL_DISABLE}

uint8_t	external_dac_channels_

bool	i2s_comm_fmt_lsb_

HighFrequencyLoopRequester	high_freq_

optional< std::string >	current_url_ {}

bool	is_announcement_ {false}

Protected Attributes inherited from esphome::Component
uint32_t	component_state_ {0x0000}
	State of this component. More...

float	setup_priority_override_ {NAN}

const char *	component_source_ {nullptr}

Protected Attributes inherited from esphome::Parented< I2SAudioComponent >
I2SAudioComponent *	parent_

Protected Attributes inherited from esphome::media_player::MediaPlayer
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}

Additional Inherited Members
Data Fields inherited from esphome::media_player::MediaPlayer
MediaPlayerState	state {MEDIA_PLAYER_STATE_NONE}

float	volume {1.0f}

Detailed Description

Definition at line 26 of file i2s_audio_media_player.h.

Member Function Documentation

◆ control()

void esphome::i2s_audio::I2SAudioMediaPlayer::control ( const media_player::MediaPlayerCall & call )

overrideprotectedvirtual

Implements esphome::media_player::MediaPlayer.

Definition at line 12 of file i2s_audio_media_player.cpp.

◆ dump_config()

void esphome::i2s_audio::I2SAudioMediaPlayer::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 224 of file i2s_audio_media_player.cpp.

◆ get_setup_priority()

float esphome::i2s_audio::I2SAudioMediaPlayer::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 29 of file i2s_audio_media_player.h.

◆ get_traits()

media_player::MediaPlayerTraits esphome::i2s_audio::I2SAudioMediaPlayer::get_traits ( )

overridevirtual

Implements esphome::media_player::MediaPlayer.

Definition at line 218 of file i2s_audio_media_player.cpp.

◆ is_muted()

bool esphome::i2s_audio::I2SAudioMediaPlayer::is_muted ( ) const

inlineoverridevirtual

Reimplemented from esphome::media_player::MediaPlayer.

Definition at line 46 of file i2s_audio_media_player.h.

◆ loop()

void esphome::i2s_audio::I2SAudioMediaPlayer::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 127 of file i2s_audio_media_player.cpp.

◆ mute_()

void esphome::i2s_audio::I2SAudioMediaPlayer::mute_ ( )

protected

Definition at line 99 of file i2s_audio_media_player.cpp.

◆ play_()

void esphome::i2s_audio::I2SAudioMediaPlayer::play_ ( )

protected

Definition at line 143 of file i2s_audio_media_player.cpp.

◆ set_dout_pin()

void esphome::i2s_audio::I2SAudioMediaPlayer::set_dout_pin ( uint8_t pin )

inline

Definition at line 35 of file i2s_audio_media_player.h.

◆ set_external_dac_channels()

void esphome::i2s_audio::I2SAudioMediaPlayer::set_external_dac_channels ( uint8_t channels )

inline

Definition at line 40 of file i2s_audio_media_player.h.

◆ set_i2s_comm_fmt_lsb()

void esphome::i2s_audio::I2SAudioMediaPlayer::set_i2s_comm_fmt_lsb ( bool lsb )

inline

Definition at line 42 of file i2s_audio_media_player.h.

◆ set_internal_dac_mode()

void esphome::i2s_audio::I2SAudioMediaPlayer::set_internal_dac_mode ( i2s_dac_mode_t mode )

inline

Definition at line 38 of file i2s_audio_media_player.h.

◆ set_mute_pin()

void esphome::i2s_audio::I2SAudioMediaPlayer::set_mute_pin ( GPIOPin * mute_pin )

inline

Definition at line 36 of file i2s_audio_media_player.h.

◆ set_volume_()

void esphome::i2s_audio::I2SAudioMediaPlayer::set_volume_	(	float	volume,
		bool	publish = `true`
	)

protected

Definition at line 115 of file i2s_audio_media_player.cpp.

◆ setup()

void esphome::i2s_audio::I2SAudioMediaPlayer::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 122 of file i2s_audio_media_player.cpp.

◆ start()

void esphome::i2s_audio::I2SAudioMediaPlayer::start ( )

Definition at line 152 of file i2s_audio_media_player.cpp.

◆ start_()

void esphome::i2s_audio::I2SAudioMediaPlayer::start_ ( )

protected

Definition at line 153 of file i2s_audio_media_player.cpp.

◆ stop()

void esphome::i2s_audio::I2SAudioMediaPlayer::stop ( )

Definition at line 191 of file i2s_audio_media_player.cpp.

◆ stop_()

void esphome::i2s_audio::I2SAudioMediaPlayer::stop_ ( )

protected

Definition at line 201 of file i2s_audio_media_player.cpp.

◆ unmute_()

void esphome::i2s_audio::I2SAudioMediaPlayer::unmute_ ( )

protected

Definition at line 107 of file i2s_audio_media_player.cpp.

Field Documentation

◆ audio_

std::unique_ptr<Audio> esphome::i2s_audio::I2SAudioMediaPlayer::audio_

protected

Definition at line 63 of file i2s_audio_media_player.h.

◆ current_url_

optional<std::string> esphome::i2s_audio::I2SAudioMediaPlayer::current_url_ {}

protected

Definition at line 80 of file i2s_audio_media_player.h.

◆ dout_pin_

uint8_t esphome::i2s_audio::I2SAudioMediaPlayer::dout_pin_ {0}

protected

Definition at line 65 of file i2s_audio_media_player.h.

◆ external_dac_channels_

uint8_t esphome::i2s_audio::I2SAudioMediaPlayer::external_dac_channels_

protected

Definition at line 74 of file i2s_audio_media_player.h.

◆ high_freq_

HighFrequencyLoopRequester esphome::i2s_audio::I2SAudioMediaPlayer::high_freq_

protected

Definition at line 78 of file i2s_audio_media_player.h.

◆ i2s_comm_fmt_lsb_

bool esphome::i2s_audio::I2SAudioMediaPlayer::i2s_comm_fmt_lsb_

protected

Definition at line 76 of file i2s_audio_media_player.h.

◆ i2s_state_

I2SState esphome::i2s_audio::I2SAudioMediaPlayer::i2s_state_ {I2S_STATE_STOPPED}

protected

Definition at line 62 of file i2s_audio_media_player.h.

◆ internal_dac_mode_

i2s_dac_mode_t esphome::i2s_audio::I2SAudioMediaPlayer::internal_dac_mode_ {I2S_DAC_CHANNEL_DISABLE}

protected

Definition at line 72 of file i2s_audio_media_player.h.

◆ is_announcement_

bool esphome::i2s_audio::I2SAudioMediaPlayer::is_announcement_ {false}

protected

Definition at line 81 of file i2s_audio_media_player.h.

◆ mute_pin_

GPIOPin* esphome::i2s_audio::I2SAudioMediaPlayer::mute_pin_ {nullptr}

protected

Definition at line 67 of file i2s_audio_media_player.h.

◆ muted_

bool esphome::i2s_audio::I2SAudioMediaPlayer::muted_ {false}

protected

Definition at line 68 of file i2s_audio_media_player.h.

◆ unmuted_volume_

float esphome::i2s_audio::I2SAudioMediaPlayer::unmuted_volume_ {0}

protected

Definition at line 69 of file i2s_audio_media_player.h.

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

/opt/build/esphome/esphome/components/i2s_audio/media_player/i2s_audio_media_player.h
/opt/build/esphome/esphome/components/i2s_audio/media_player/i2s_audio_media_player.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ control()

◆ dump_config()

◆ get_setup_priority()

◆ get_traits()

◆ is_muted()

◆ loop()

◆ mute_()

◆ play_()

◆ set_dout_pin()

◆ set_external_dac_channels()

◆ set_i2s_comm_fmt_lsb()

◆ set_internal_dac_mode()

◆ set_mute_pin()

◆ set_volume_()

◆ setup()

◆ start()

◆ start_()

◆ stop()

◆ stop_()

◆ unmute_()

Field Documentation

◆ audio_

◆ current_url_

◆ dout_pin_

◆ external_dac_channels_

◆ high_freq_

◆ i2s_comm_fmt_lsb_

◆ i2s_state_

◆ internal_dac_mode_

◆ is_announcement_

◆ mute_pin_

◆ muted_

◆ unmuted_volume_