esphome::media_player Namespace Reference

Data Structures
class	IsAnnouncingCondition
class	IsIdleCondition
class	IsMutedCondition
class	IsOffCondition
class	IsOnCondition
class	IsPausedCondition
class	IsPlayingCondition
class	MediaPlayer
class	MediaPlayerCall
class	MediaPlayerCommandAction
class	MediaPlayerStateTrigger
struct	MediaPlayerSupportedFormat
class	MediaPlayerTraits
class	PlayMediaAction
class	StateTrigger
class	VolumeSetAction

Typedefs
template<typename... Ts>
using	PlayAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_PLAY, Ts...>
template<typename... Ts>
using	PauseAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_PAUSE, Ts...>
template<typename... Ts>
using	StopAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_STOP, Ts...>
template<typename... Ts>
using	ToggleAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_TOGGLE, Ts...>
template<typename... Ts>
using	VolumeUpAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_VOLUME_UP, Ts...>
template<typename... Ts>
using	VolumeDownAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_VOLUME_DOWN, Ts...>
template<typename... Ts>
using	TurnOnAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_TURN_ON, Ts...>
template<typename... Ts>
using	TurnOffAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_TURN_OFF, Ts...>
template<typename... Ts>
using	NextAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_NEXT, Ts...>
template<typename... Ts>
using	PreviousAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_PREVIOUS, Ts...>
template<typename... Ts>
using	MuteAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_MUTE, Ts...>
template<typename... Ts>
using	UnmuteAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_UNMUTE, Ts...>
template<typename... Ts>
using	RepeatOffAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_REPEAT_OFF, Ts...>
template<typename... Ts>
using	RepeatOneAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_REPEAT_ONE, Ts...>
template<typename... Ts>
using	RepeatAllAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_REPEAT_ALL, Ts...>
template<typename... Ts>
using	ShuffleAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_SHUFFLE, Ts...>
template<typename... Ts>
using	UnshuffleAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_UNSHUFFLE, Ts...>
template<typename... Ts>
using	GroupJoinAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_GROUP_JOIN, Ts...>
template<typename... Ts>
using	ClearPlaylistAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_CLEAR_PLAYLIST, Ts...>
using	IdleTrigger = MediaPlayerStateTrigger<MediaPlayerState::MEDIA_PLAYER_STATE_IDLE>
using	PlayTrigger = MediaPlayerStateTrigger<MediaPlayerState::MEDIA_PLAYER_STATE_PLAYING>
using	PauseTrigger = MediaPlayerStateTrigger<MediaPlayerState::MEDIA_PLAYER_STATE_PAUSED>
using	AnnouncementTrigger = MediaPlayerStateTrigger<MediaPlayerState::MEDIA_PLAYER_STATE_ANNOUNCING>
using	OnTrigger = MediaPlayerStateTrigger<MediaPlayerState::MEDIA_PLAYER_STATE_ON>
using	OffTrigger = MediaPlayerStateTrigger<MediaPlayerState::MEDIA_PLAYER_STATE_OFF>

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
const char *	media_player_state_to_string (MediaPlayerState state)
const char *	media_player_command_to_string (MediaPlayerCommand command)

Typedef Documentation

AnnouncementTrigger

using esphome::media_player::AnnouncementTrigger = MediaPlayerStateTrigger<MediaPlayerState::MEDIA_PLAYER_STATE_ANNOUNCING>

Definition at line 94 of file automation.h.

ClearPlaylistAction

template<typename... Ts>

using esphome::media_player::ClearPlaylistAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_CLEAR_PLAYLIST, Ts...>

Definition at line 56 of file automation.h.

GroupJoinAction

template<typename... Ts>

using esphome::media_player::GroupJoinAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_GROUP_JOIN, Ts...>

Definition at line 54 of file automation.h.

IdleTrigger

using esphome::media_player::IdleTrigger = MediaPlayerStateTrigger<MediaPlayerState::MEDIA_PLAYER_STATE_IDLE>

Definition at line 91 of file automation.h.

MuteAction

template<typename... Ts>

using esphome::media_player::MuteAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_MUTE, Ts...>

Definition at line 40 of file automation.h.

NextAction

template<typename... Ts>

using esphome::media_player::NextAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_NEXT, Ts...>

Definition at line 36 of file automation.h.

OffTrigger

using esphome::media_player::OffTrigger = MediaPlayerStateTrigger<MediaPlayerState::MEDIA_PLAYER_STATE_OFF>

Definition at line 96 of file automation.h.

OnTrigger

using esphome::media_player::OnTrigger = MediaPlayerStateTrigger<MediaPlayerState::MEDIA_PLAYER_STATE_ON>

Definition at line 95 of file automation.h.

PauseAction

template<typename... Ts>

using esphome::media_player::PauseAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_PAUSE, Ts...>

Definition at line 22 of file automation.h.

PauseTrigger

using esphome::media_player::PauseTrigger = MediaPlayerStateTrigger<MediaPlayerState::MEDIA_PLAYER_STATE_PAUSED>

Definition at line 93 of file automation.h.

PlayAction

template<typename... Ts>

using esphome::media_player::PlayAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_PLAY, Ts...>

Definition at line 20 of file automation.h.

PlayTrigger

using esphome::media_player::PlayTrigger = MediaPlayerStateTrigger<MediaPlayerState::MEDIA_PLAYER_STATE_PLAYING>

Definition at line 92 of file automation.h.

PreviousAction

template<typename... Ts>

using esphome::media_player::PreviousAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_PREVIOUS, Ts...>

Definition at line 38 of file automation.h.

RepeatAllAction

template<typename... Ts>

using esphome::media_player::RepeatAllAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_REPEAT_ALL, Ts...>

Definition at line 48 of file automation.h.

RepeatOffAction

template<typename... Ts>

using esphome::media_player::RepeatOffAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_REPEAT_OFF, Ts...>

Definition at line 44 of file automation.h.

RepeatOneAction

template<typename... Ts>

using esphome::media_player::RepeatOneAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_REPEAT_ONE, Ts...>

Definition at line 46 of file automation.h.

ShuffleAction

template<typename... Ts>

using esphome::media_player::ShuffleAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_SHUFFLE, Ts...>

Definition at line 50 of file automation.h.

StopAction

template<typename... Ts>

using esphome::media_player::StopAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_STOP, Ts...>

Definition at line 24 of file automation.h.

ToggleAction

template<typename... Ts>

using esphome::media_player::ToggleAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_TOGGLE, Ts...>

Definition at line 26 of file automation.h.

TurnOffAction

template<typename... Ts>

using esphome::media_player::TurnOffAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_TURN_OFF, Ts...>

Definition at line 34 of file automation.h.

TurnOnAction

template<typename... Ts>

using esphome::media_player::TurnOnAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_TURN_ON, Ts...>

Definition at line 32 of file automation.h.

UnmuteAction

template<typename... Ts>

using esphome::media_player::UnmuteAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_UNMUTE, Ts...>

Definition at line 42 of file automation.h.

UnshuffleAction

template<typename... Ts>

using esphome::media_player::UnshuffleAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_UNSHUFFLE, Ts...>

Definition at line 52 of file automation.h.

VolumeDownAction

template<typename... Ts>

using esphome::media_player::VolumeDownAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_VOLUME_DOWN, Ts...>

Definition at line 30 of file automation.h.

VolumeUpAction

template<typename... Ts>

using esphome::media_player::VolumeUpAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_VOLUME_UP, Ts...>

Definition at line 28 of file automation.h.

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 46 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 9 of file media_player.h.

MediaPlayerFormatPurpose

enum class esphome::media_player::MediaPlayerFormatPurpose : uint8_t

strong

Enumerator
PURPOSE_DEFAULT
PURPOSE_ANNOUNCEMENT

Definition at line 70 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 35 of file media_player.h.

Function Documentation

media_player_command_to_string()

const char * esphome::media_player::media_player_command_to_string

(

MediaPlayerCommand

command

)

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