Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.music_assistant.media_player Namespace Reference

Classes

class  MusicAssistantPlayer
 

Functions

None async_setup_entry (HomeAssistant hass, MusicAssistantConfigEntry entry, AddEntitiesCallback async_add_entities)
 
Callable[..., Coroutine[Any, Any, _R|None]] P (Callable[..., Awaitable[_R]] func)
 

Variables

string ATTR_ALBUM = "album"
 
string ATTR_ANNOUNCE_VOLUME = "announce_volume"
 
string ATTR_ARTIST = "artist"
 
string ATTR_AUTO_PLAY = "auto_play"
 
string ATTR_MEDIA_ID = "media_id"
 
string ATTR_MEDIA_TYPE = "media_type"
 
string ATTR_RADIO_MODE = "radio_mode"
 
string ATTR_SOURCE_PLAYER = "source_player"
 
string ATTR_URL = "url"
 
string ATTR_USE_PRE_ANNOUNCE = "use_pre_announce"
 
dictionary QUEUE_OPTION_MAP
 
string SERVICE_PLAY_ANNOUNCEMENT = "play_announcement"
 
string SERVICE_PLAY_MEDIA_ADVANCED = "play_media"
 
string SERVICE_TRANSFER_QUEUE = "transfer_queue"
 
tuple SUPPORTED_FEATURES
 

Detailed Description

MediaPlayer platform for Music Assistant integration.

Function Documentation

◆ async_setup_entry()

None homeassistant.components.music_assistant.media_player.async_setup_entry ( HomeAssistant  hass,
MusicAssistantConfigEntry  entry,
AddEntitiesCallback  async_add_entities 
)
Set up Music Assistant MediaPlayer(s) from Config Entry.

Definition at line 123 of file media_player.py.

◆ P()

Callable[..., Coroutine[Any, Any, _R | None]] homeassistant.components.music_assistant.media_player.P ( Callable[..., Awaitable[_R]]  func)
private
Check and log commands to players.

Definition at line 104 of file media_player.py.

Variable Documentation

◆ ATTR_ALBUM

string homeassistant.components.music_assistant.media_player.ATTR_ALBUM = "album"

Definition at line 96 of file media_player.py.

◆ ATTR_ANNOUNCE_VOLUME

string homeassistant.components.music_assistant.media_player.ATTR_ANNOUNCE_VOLUME = "announce_volume"

Definition at line 99 of file media_player.py.

◆ ATTR_ARTIST

string homeassistant.components.music_assistant.media_player.ATTR_ARTIST = "artist"

Definition at line 95 of file media_player.py.

◆ ATTR_AUTO_PLAY

string homeassistant.components.music_assistant.media_player.ATTR_AUTO_PLAY = "auto_play"

Definition at line 101 of file media_player.py.

◆ ATTR_MEDIA_ID

string homeassistant.components.music_assistant.media_player.ATTR_MEDIA_ID = "media_id"

Definition at line 93 of file media_player.py.

◆ ATTR_MEDIA_TYPE

string homeassistant.components.music_assistant.media_player.ATTR_MEDIA_TYPE = "media_type"

Definition at line 94 of file media_player.py.

◆ ATTR_RADIO_MODE

string homeassistant.components.music_assistant.media_player.ATTR_RADIO_MODE = "radio_mode"

Definition at line 92 of file media_player.py.

◆ ATTR_SOURCE_PLAYER

string homeassistant.components.music_assistant.media_player.ATTR_SOURCE_PLAYER = "source_player"

Definition at line 100 of file media_player.py.

◆ ATTR_URL

string homeassistant.components.music_assistant.media_player.ATTR_URL = "url"

Definition at line 97 of file media_player.py.

◆ ATTR_USE_PRE_ANNOUNCE

string homeassistant.components.music_assistant.media_player.ATTR_USE_PRE_ANNOUNCE = "use_pre_announce"

Definition at line 98 of file media_player.py.

◆ QUEUE_OPTION_MAP

dictionary homeassistant.components.music_assistant.media_player.QUEUE_OPTION_MAP
Initial value:
1 = {
2  # map from HA enqueue options to MA enqueue options
3  # which are the same but just in case
4  MediaPlayerEnqueue.ADD: QueueOption.ADD,
5  MediaPlayerEnqueue.NEXT: QueueOption.NEXT,
6  MediaPlayerEnqueue.PLAY: QueueOption.PLAY,
7  MediaPlayerEnqueue.REPLACE: QueueOption.REPLACE,
8 }

Definition at line 80 of file media_player.py.

◆ SERVICE_PLAY_ANNOUNCEMENT

string homeassistant.components.music_assistant.media_player.SERVICE_PLAY_ANNOUNCEMENT = "play_announcement"

Definition at line 90 of file media_player.py.

◆ SERVICE_PLAY_MEDIA_ADVANCED

string homeassistant.components.music_assistant.media_player.SERVICE_PLAY_MEDIA_ADVANCED = "play_media"

Definition at line 89 of file media_player.py.

◆ SERVICE_TRANSFER_QUEUE

string homeassistant.components.music_assistant.media_player.SERVICE_TRANSFER_QUEUE = "transfer_queue"

Definition at line 91 of file media_player.py.

◆ SUPPORTED_FEATURES

tuple homeassistant.components.music_assistant.media_player.SUPPORTED_FEATURES
Initial value:
1 = (
2  MediaPlayerEntityFeature.PAUSE
3  | MediaPlayerEntityFeature.VOLUME_SET
4  | MediaPlayerEntityFeature.STOP
5  | MediaPlayerEntityFeature.PREVIOUS_TRACK
6  | MediaPlayerEntityFeature.NEXT_TRACK
7  | MediaPlayerEntityFeature.SHUFFLE_SET
8  | MediaPlayerEntityFeature.REPEAT_SET
9  | MediaPlayerEntityFeature.TURN_ON
10  | MediaPlayerEntityFeature.TURN_OFF
11  | MediaPlayerEntityFeature.PLAY
12  | MediaPlayerEntityFeature.PLAY_MEDIA
13  | MediaPlayerEntityFeature.VOLUME_STEP
14  | MediaPlayerEntityFeature.CLEAR_PLAYLIST
15  | MediaPlayerEntityFeature.BROWSE_MEDIA
16  | MediaPlayerEntityFeature.MEDIA_ENQUEUE
17  | MediaPlayerEntityFeature.MEDIA_ANNOUNCE
18  | MediaPlayerEntityFeature.SEEK
19 )

Definition at line 60 of file media_player.py.