Data Structures
class	MediaPlayer

class	MediaPlayerCall

struct	MediaPlayerSupportedFormat

class	MediaPlayerTraits

struct	StateAnyForwarder
	Callback forwarder that triggers an Automation<> on any state change. More...

struct	StateEnterForwarder
	Callback forwarder that triggers an Automation<> only when a specific media player state is entered. More...

Enumerations
enum	MediaPlayerEntityFeature : uint32_t { PAUSE = 1 << 0 , SEEK = 1 << 1 , VOLUME_SET = 1 << 2 , VOLUME_MUTE = 1 << 3 , PREVIOUS_TRACK = 1 << 4 , NEXT_TRACK = 1 << 5 , TURN_ON = 1 << 7 , TURN_OFF = 1 << 8 , PLAY_MEDIA = 1 << 9 , VOLUME_STEP = 1 << 10 , SELECT_SOURCE = 1 << 11 , STOP = 1 << 12 , CLEAR_PLAYLIST = 1 << 13 , PLAY = 1 << 14 , SHUFFLE_SET = 1 << 15 , SELECT_SOUND_MODE = 1 << 16 , BROWSE_MEDIA = 1 << 17 , REPEAT_SET = 1 << 18 , GROUPING = 1 << 19 , MEDIA_ANNOUNCE = 1 << 20 , MEDIA_ENQUEUE = 1 << 21 , SEARCH_MEDIA = 1 << 22 }

enum	MediaPlayerState : uint8_t { MEDIA_PLAYER_STATE_NONE = 0 , MEDIA_PLAYER_STATE_IDLE = 1 , MEDIA_PLAYER_STATE_PLAYING = 2 , MEDIA_PLAYER_STATE_PAUSED = 3 , MEDIA_PLAYER_STATE_ANNOUNCING = 4 , MEDIA_PLAYER_STATE_OFF = 5 , MEDIA_PLAYER_STATE_ON = 6 }

enum	MediaPlayerCommand : uint8_t { MEDIA_PLAYER_COMMAND_PLAY = 0 , MEDIA_PLAYER_COMMAND_PAUSE = 1 , MEDIA_PLAYER_COMMAND_STOP = 2 , MEDIA_PLAYER_COMMAND_MUTE = 3 , MEDIA_PLAYER_COMMAND_UNMUTE = 4 , MEDIA_PLAYER_COMMAND_TOGGLE = 5 , MEDIA_PLAYER_COMMAND_VOLUME_UP = 6 , MEDIA_PLAYER_COMMAND_VOLUME_DOWN = 7 , MEDIA_PLAYER_COMMAND_ENQUEUE = 8 , MEDIA_PLAYER_COMMAND_REPEAT_ONE = 9 , MEDIA_PLAYER_COMMAND_REPEAT_OFF = 10 , MEDIA_PLAYER_COMMAND_CLEAR_PLAYLIST = 11 , MEDIA_PLAYER_COMMAND_TURN_ON = 12 , MEDIA_PLAYER_COMMAND_TURN_OFF = 13 , MEDIA_PLAYER_COMMAND_NEXT = 14 , MEDIA_PLAYER_COMMAND_PREVIOUS = 15 , MEDIA_PLAYER_COMMAND_REPEAT_ALL = 16 , MEDIA_PLAYER_COMMAND_SHUFFLE = 17 , MEDIA_PLAYER_COMMAND_UNSHUFFLE = 18 , MEDIA_PLAYER_COMMAND_GROUP_JOIN = 19 }

enum class	MediaPlayerFormatPurpose : uint8_t { PURPOSE_DEFAULT = 0 , PURPOSE_ANNOUNCEMENT = 1 }

Functions
	ESPHOME_LOG_TAG (TAG, "media_player")

const char *	media_player_state_to_string (MediaPlayerState state)

const char *	media_player_command_to_string (MediaPlayerCommand command)

Enumeration Type Documentation

◆ MediaPlayerCommand

enum esphome::media_player::MediaPlayerCommand : uint8_t

Enumerator
MEDIA_PLAYER_COMMAND_PLAY
MEDIA_PLAYER_COMMAND_PAUSE
MEDIA_PLAYER_COMMAND_STOP
MEDIA_PLAYER_COMMAND_MUTE
MEDIA_PLAYER_COMMAND_UNMUTE
MEDIA_PLAYER_COMMAND_TOGGLE
MEDIA_PLAYER_COMMAND_VOLUME_UP
MEDIA_PLAYER_COMMAND_VOLUME_DOWN
MEDIA_PLAYER_COMMAND_ENQUEUE
MEDIA_PLAYER_COMMAND_REPEAT_ONE
MEDIA_PLAYER_COMMAND_REPEAT_OFF
MEDIA_PLAYER_COMMAND_CLEAR_PLAYLIST
MEDIA_PLAYER_COMMAND_TURN_ON
MEDIA_PLAYER_COMMAND_TURN_OFF
MEDIA_PLAYER_COMMAND_NEXT
MEDIA_PLAYER_COMMAND_PREVIOUS
MEDIA_PLAYER_COMMAND_REPEAT_ALL
MEDIA_PLAYER_COMMAND_SHUFFLE
MEDIA_PLAYER_COMMAND_UNSHUFFLE
MEDIA_PLAYER_COMMAND_GROUP_JOIN

Definition at line 45 of file media_player.h.

◆ MediaPlayerEntityFeature

enum esphome::media_player::MediaPlayerEntityFeature : uint32_t

Enumerator
PAUSE
SEEK
VOLUME_SET
VOLUME_MUTE
PREVIOUS_TRACK
NEXT_TRACK
TURN_ON
TURN_OFF
PLAY_MEDIA
VOLUME_STEP
SELECT_SOURCE
STOP
CLEAR_PLAYLIST
PLAY
SHUFFLE_SET
SELECT_SOUND_MODE
BROWSE_MEDIA
REPEAT_SET
GROUPING
MEDIA_ANNOUNCE
MEDIA_ENQUEUE
SEARCH_MEDIA

Definition at line 8 of file media_player.h.

◆ MediaPlayerFormatPurpose

enum class esphome::media_player::MediaPlayerFormatPurpose : uint8_t

strong

Enumerator
PURPOSE_DEFAULT
PURPOSE_ANNOUNCEMENT

Definition at line 69 of file media_player.h.

◆ MediaPlayerState

enum esphome::media_player::MediaPlayerState : uint8_t

Enumerator
MEDIA_PLAYER_STATE_NONE
MEDIA_PLAYER_STATE_IDLE
MEDIA_PLAYER_STATE_PLAYING
MEDIA_PLAYER_STATE_PAUSED
MEDIA_PLAYER_STATE_ANNOUNCING
MEDIA_PLAYER_STATE_OFF
MEDIA_PLAYER_STATE_ON

Definition at line 34 of file media_player.h.

Function Documentation

◆ ESPHOME_LOG_TAG()

esphome::media_player::ESPHOME_LOG_TAG	(	TAG	,
		"media_player"	)

◆ media_player_command_to_string()

const char * esphome::media_player::media_player_command_to_string ( MediaPlayerCommand command )

Definition at line 32 of file media_player.cpp.

◆ media_player_state_to_string()

const char * esphome::media_player::media_player_state_to_string ( MediaPlayerState state )

Definition at line 11 of file media_player.cpp.

Data Structures

Enumerations

Functions