[media_player] Add enqueue action (#14775)

esphome/components/media_player/__init__.py

@@ -94,6 +94,9 @@ _STATE_CONDITIONS = [
 PlayMediaAction = media_player_ns.class_(
     "PlayMediaAction", automation.Action, cg.Parented.template(MediaPlayer)
 )
+EnqueueMediaAction = media_player_ns.class_(
+    "EnqueueMediaAction", automation.Action, cg.Parented.template(MediaPlayer)
+)
 VolumeSetAction = media_player_ns.class_(
     "VolumeSetAction", automation.Action, cg.Parented.template(MediaPlayer)
 )
@@ -168,20 +171,17 @@ MEDIA_PLAYER_CONDITION_SCHEMA = automation.maybe_simple_id(
 )
 
 
-@automation.register_action(
+_MEDIA_URL_ACTION_SCHEMA = cv.maybe_simple_value(
-    "media_player.play_media",
+    {
-    PlayMediaAction,
+        cv.GenerateID(): cv.use_id(MediaPlayer),
-    cv.maybe_simple_value(
+        cv.Required(CONF_MEDIA_URL): cv.templatable(cv.url),
-        {
+        cv.Optional(CONF_ANNOUNCEMENT, default=False): cv.templatable(cv.boolean),
-            cv.GenerateID(): cv.use_id(MediaPlayer),
+    },
-            cv.Required(CONF_MEDIA_URL): cv.templatable(cv.url),
+    key=CONF_MEDIA_URL,
-            cv.Optional(CONF_ANNOUNCEMENT, default=False): cv.templatable(cv.boolean),
-        },
-        key=CONF_MEDIA_URL,
-    ),
-    synchronous=True,
 )
-async def media_player_play_media_action(config, action_id, template_arg, args):
+
+
+async def _media_action_handler(config, action_id, template_arg, args):
     var = cg.new_Pvariable(action_id, template_arg)
     await cg.register_parented(var, config[CONF_ID])
     media_url = await cg.templatable(config[CONF_MEDIA_URL], args, cg.std_string)
@@ -191,6 +191,21 @@ async def media_player_play_media_action(config, action_id, template_arg, args):
     return var
 
 
+automation.register_action(
+    "media_player.play_media",
+    PlayMediaAction,
+    _MEDIA_URL_ACTION_SCHEMA,
+    synchronous=True,
+)(_media_action_handler)
+
+automation.register_action(
+    "media_player.enqueue",
+    EnqueueMediaAction,
+    _MEDIA_URL_ACTION_SCHEMA,
+    synchronous=True,
+)(_media_action_handler)
+
+
 def _snake_to_camel(name):
     return "".join(word.capitalize() for word in name.split("_"))
 

esphome/components/media_player/automation.h

@@ -55,17 +55,23 @@ using GroupJoinAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYE
 template<typename... Ts>
 using ClearPlaylistAction = MediaPlayerCommandAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_CLEAR_PLAYLIST, Ts...>;
 
-template<typename... Ts> class PlayMediaAction : public Action<Ts...>, public Parented<MediaPlayer> {
+template<MediaPlayerCommand Command, typename... Ts>
+class MediaPlayerMediaAction : public Action<Ts...>, public Parented<MediaPlayer> {
   TEMPLATABLE_VALUE(std::string, media_url)
   TEMPLATABLE_VALUE(bool, announcement)
   void play(const Ts &...x) override {
-    this->parent_->make_call()
+    auto call = this->parent_->make_call();
-        .set_media_url(this->media_url_.value(x...))
+    if constexpr (Command != MediaPlayerCommand::MEDIA_PLAYER_COMMAND_PLAY)
-        .set_announcement(this->announcement_.value(x...))
+      call.set_command(Command);
-        .perform();
+    call.set_media_url(this->media_url_.value(x...)).set_announcement(this->announcement_.value(x...)).perform();
   }
 };
 
+template<typename... Ts>
+using PlayMediaAction = MediaPlayerMediaAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_PLAY, Ts...>;
+template<typename... Ts>
+using EnqueueMediaAction = MediaPlayerMediaAction<MediaPlayerCommand::MEDIA_PLAYER_COMMAND_ENQUEUE, Ts...>;
+
 template<typename... Ts> class VolumeSetAction : public Action<Ts...>, public Parented<MediaPlayer> {
   TEMPLATABLE_VALUE(float, volume)
   void play(const Ts &...x) override { this->parent_->make_call().set_volume(this->volume_.value(x...)).perform(); }

tests/components/media_player/common.yaml

@@ -61,3 +61,8 @@ media_player:
       - media_player.volume_up:
       - media_player.volume_down:
       - media_player.volume_set: 50%
+      - media_player.enqueue: http://localhost/media.mp3
+      - media_player.enqueue: !lambda 'return "http://localhost/media.mp3";'
+      - media_player.enqueue:
+          media_url: http://localhost/media.mp3
+          announcement: true