esphome::api::MediaPlayerControl Struct Reference

A command to mutate a media player. More...

#include <media_player.hpp>

Public Attributes
std::uint32_t	key = 0
std::optional< MediaPlayerCommand >	command
std::optional< float >	volume
std::optional< std::string >	media_url
std::optional< bool >	announcement

Detailed Description

A command to mutate a media player.

Each optional field is sent only when engaged.

Named with the Control suffix because the canonical MediaPlayerCommand name is already taken by the mirrored proto enum (see enums.hpp).

Member Data Documentation

announcement

std::optional<bool> esphome::api::MediaPlayerControl::announcement

command

std::optional<MediaPlayerCommand> esphome::api::MediaPlayerControl::command

key

std::uint32_t esphome::api::MediaPlayerControl::key = 0

media_url

std::optional<std::string> esphome::api::MediaPlayerControl::media_url

volume

std::optional<float> esphome::api::MediaPlayerControl::volume

---

The documentation for this struct was generated from the following file:

• include/esphome/api/model/entities/media_player.hpp