ESPHome 2025.8.0b1
Loading...
Searching...
No Matches
esphome::media_player Namespace Reference

Data Structures

class  IsAnnouncingCondition
 
class  IsIdleCondition
 
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...>
 
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
}
 
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

◆ IdleTrigger

◆ OffTrigger

◆ OnTrigger

◆ PauseAction

◆ PauseTrigger

◆ PlayAction

◆ PlayTrigger

◆ StopAction

◆ ToggleAction

◆ TurnOffAction

◆ TurnOnAction

◆ VolumeDownAction

◆ VolumeUpAction

Enumeration Type Documentation

◆ MediaPlayerCommand

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 

Definition at line 46 of file media_player.h.

◆ MediaPlayerEntityFeature

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

Enumerator
PURPOSE_DEFAULT 
PURPOSE_ANNOUNCEMENT 

Definition at line 64 of file media_player.h.

◆ MediaPlayerState

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 31 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 10 of file media_player.cpp.