ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
media_player.cpp
Go to the documentation of this file.
1#include "media_player.h"
5#include "esphome/core/log.h"
7
8namespace esphome::media_player {
9
10ESPHOME_LOG_TAG(TAG, "media_player");
11
13 switch (state) {
15 return "ON";
17 return "OFF";
19 return "IDLE";
21 return "PLAYING";
23 return "PAUSED";
25 return "ANNOUNCING";
27 return "NONE";
28 default:
29 return "UNKNOWN";
30 }
31}
32
34 switch (command) {
36 return "PLAY";
38 return "PAUSE";
40 return "STOP";
42 return "MUTE";
44 return "UNMUTE";
46 return "TOGGLE";
48 return "VOLUME_UP";
50 return "VOLUME_DOWN";
52 return "ENQUEUE";
54 return "REPEAT_ONE";
56 return "REPEAT_OFF";
58 return "CLEAR_PLAYLIST";
60 return "TURN_ON";
62 return "TURN_OFF";
64 return "NEXT";
66 return "PREVIOUS";
68 return "REPEAT_ALL";
70 return "SHUFFLE";
72 return "UNSHUFFLE";
74 return "GROUP_JOIN";
75 default:
76 return "UNKNOWN";
77 }
78}
79
83
88
90 if (this->media_url_.has_value()) {
91 if (this->command_.has_value() && this->command_.value() != MEDIA_PLAYER_COMMAND_ENQUEUE) {
92 // Don't remove an enqueue command
93 ESP_LOGW(TAG, "MediaPlayerCall: Setting both command and media_url is not needed.");
94 this->command_.reset();
95 }
96 }
97 if (this->volume_.has_value()) {
98 if (this->volume_.value() < 0.0f || this->volume_.value() > 1.0f) {
99 ESP_LOGW(TAG, "MediaPlayerCall: Volume must be between 0.0 and 1.0.");
100 this->volume_.reset();
101 }
102 }
103}
104
106 ESP_LOGV(TAG, "'%s' - Setting", LOG_STR_ARG(this->parent_->get_log_name()));
107 this->validate_();
108 if (this->command_.has_value()) {
109 const char *command_s = media_player_command_to_string(this->command_.value());
110 ESP_LOGV(TAG, " Command: %s", command_s);
111 }
112 if (this->media_url_.has_value()) {
113 ESP_LOGV(TAG, " Media URL: %s", this->media_url_.value().c_str());
114 }
115 if (this->volume_.has_value()) {
116 ESP_LOGV(TAG, " Volume: %.2f", this->volume_.value());
117 }
118 if (this->announcement_.has_value()) {
119 ESP_LOGV(TAG, " Announcement: %s", this->announcement_.value() ? LOG_STR_LITERAL("yes") : LOG_STR_LITERAL("no"));
120 }
121 this->parent_->control(*this);
122}
123
125 this->command_ = command;
126 return *this;
127}
128MediaPlayerCall &MediaPlayerCall::set_command(optional<MediaPlayerCommand> command) {
129 this->command_ = command;
130 return *this;
131}
133 if (ESPHOME_strcasecmp_P(command, ESPHOME_PSTR("PLAY")) == 0) {
135 } else if (ESPHOME_strcasecmp_P(command, ESPHOME_PSTR("PAUSE")) == 0) {
137 } else if (ESPHOME_strcasecmp_P(command, ESPHOME_PSTR("STOP")) == 0) {
139 } else if (ESPHOME_strcasecmp_P(command, ESPHOME_PSTR("MUTE")) == 0) {
141 } else if (ESPHOME_strcasecmp_P(command, ESPHOME_PSTR("UNMUTE")) == 0) {
143 } else if (ESPHOME_strcasecmp_P(command, ESPHOME_PSTR("TOGGLE")) == 0) {
145 } else if (ESPHOME_strcasecmp_P(command, ESPHOME_PSTR("TURN_ON")) == 0) {
147 } else if (ESPHOME_strcasecmp_P(command, ESPHOME_PSTR("TURN_OFF")) == 0) {
149 } else if (ESPHOME_strcasecmp_P(command, ESPHOME_PSTR("VOLUME_UP")) == 0) {
151 } else if (ESPHOME_strcasecmp_P(command, ESPHOME_PSTR("VOLUME_DOWN")) == 0) {
153 } else if (ESPHOME_strcasecmp_P(command, ESPHOME_PSTR("ENQUEUE")) == 0) {
155 } else if (ESPHOME_strcasecmp_P(command, ESPHOME_PSTR("REPEAT_ONE")) == 0) {
157 } else if (ESPHOME_strcasecmp_P(command, ESPHOME_PSTR("REPEAT_OFF")) == 0) {
159 } else if (ESPHOME_strcasecmp_P(command, ESPHOME_PSTR("REPEAT_ALL")) == 0) {
161 } else if (ESPHOME_strcasecmp_P(command, ESPHOME_PSTR("CLEAR_PLAYLIST")) == 0) {
163 } else if (ESPHOME_strcasecmp_P(command, ESPHOME_PSTR("NEXT")) == 0) {
165 } else if (ESPHOME_strcasecmp_P(command, ESPHOME_PSTR("PREVIOUS")) == 0) {
167 } else if (ESPHOME_strcasecmp_P(command, ESPHOME_PSTR("SHUFFLE")) == 0) {
169 } else if (ESPHOME_strcasecmp_P(command, ESPHOME_PSTR("UNSHUFFLE")) == 0) {
171 } else if (ESPHOME_strcasecmp_P(command, ESPHOME_PSTR("GROUP_JOIN")) == 0) {
173 } else {
174 ESP_LOGW(TAG, "'%s' - Unrecognized command %s", LOG_STR_ARG(this->parent_->get_log_name()), command);
175 }
176 return *this;
177}
178
179MediaPlayerCall &MediaPlayerCall::set_media_url(const std::string &media_url) {
180 this->media_url_ = media_url;
181 return *this;
182}
183
185 this->volume_ = volume;
186 return *this;
187}
188
190 this->announcement_ = announce;
191 return *this;
192}
193
195 this->state_callback_.call(this->state);
196#if defined(USE_MEDIA_PLAYER) && defined(USE_CONTROLLER_REGISTRY)
197 ControllerRegistry::notify_media_player_update(this);
198#endif
199}
200
201} // namespace esphome::media_player
const LogString * get_log_name() const
Get the name for a "%s" log argument (LOG_STR_ARG).
MediaPlayerCall & set_media_url(const std::string &url)
MediaPlayerCall & set_volume(float volume)
MediaPlayerCall & set_announcement(bool announce)
MediaPlayerCall & set_command(MediaPlayerCommand command)
optional< MediaPlayerCommand > command_
virtual void control(const MediaPlayerCall &call)=0
LazyCallbackManager< void(MediaPlayerState)> state_callback_
void set_supports_turn_off_on(bool supports_turn_off_on)
void set_supports_pause(bool supports_pause)
bool state
Definition fan.h:2
const char * media_player_command_to_string(MediaPlayerCommand command)
const char * media_player_state_to_string(MediaPlayerState state)
ESPHOME_LOG_TAG(TAG, "media_player")
ESPHOME_ALWAYS_INLINE constexpr void assign_bits(T &value, std::type_identity_t< T > mask, bool on)
Set the bits of mask in value when on is true, clear them otherwise.
Definition helpers.h:1150