Inheritance diagram for homeassistant.components.mpd.media_player.MpdDevice:

Collaboration diagram for homeassistant.components.mpd.media_player.MpdDevice:

Public Member Functions
None	__init__ (self, str server, int port, str\|None password, str unique_id)

BrowseMedia	async_browse_media (self, MediaType\|str\|None media_content_type=None, str\|None media_content_id=None)

None	async_clear_playlist (self)

tuple[bytes\|None, str\|None]	async_get_media_image (self)

None	async_media_next_track (self)

None	async_media_pause (self)

None	async_media_play (self)

None	async_media_previous_track (self)

None	async_media_seek (self, float position)

None	async_media_stop (self)

None	async_mute_volume (self, bool mute)

None	async_play_media (self, MediaType\|str media_type, str media_id, **Any kwargs)

None	async_select_source (self, str source)

None	async_set_repeat (self, RepeatMode repeat)

None	async_set_shuffle (self, bool shuffle)

None	async_set_volume_level (self, float volume)

None	async_turn_off (self)

None	async_turn_on (self)

None	async_update (self)

None	async_volume_down (self)

None	async_volume_up (self)

def	connection (self)

def	media_album_name (self)

def	media_artist (self)

def	media_content_id (self)

def	media_duration (self)

def	media_image_hash (self)

def	media_title (self)

RepeatMode	repeat (self)

def	shuffle (self)

def	source (self)

MediaPlayerState	state (self)

MediaPlayerEntityFeature	supported_features (self)

def	volume_level (self)

Public Member Functions inherited from homeassistant.components.media_player.MediaPlayerEntity
str	access_token (self)

str\|None	app_id (self)

str\|None	app_name (self)

tuple[bytes\|None, str\|None]	async_get_browse_image (self, str media_content_type, str media_content_id, str\|None media_image_id=None)

None	async_join_players (self, list[str] group_members)

None	async_media_play_pause (self)

None	async_select_sound_mode (self, str sound_mode)

None	async_toggle (self)

None	async_unjoin_player (self)

dict[str, Any]	capability_attributes (self)

None	clear_playlist (self)

MediaPlayerDeviceClass\|None	device_class (self)

str\|None	entity_picture (self)

str	get_browse_image_url (self, str media_content_type, str media_content_id, str\|None media_image_id=None)

list[str]\|None	group_members (self)

bool\|None	is_volume_muted (self)

None	join_players (self, list[str] group_members)

str\|None	media_album_artist (self)

str\|None	media_channel (self)

MediaType\|str\|None	media_content_type (self)

str\|None	media_episode (self)

str\|None	media_image_local (self)

bool	media_image_remotely_accessible (self)

str\|None	media_image_url (self)

None	media_next_track (self)

None	media_pause (self)

None	media_play (self)

str\|None	media_playlist (self)

int\|None	media_position (self)

dt.datetime\|None	media_position_updated_at (self)

None	media_previous_track (self)

str\|None	media_season (self)

None	media_seek (self, float position)

str\|None	media_series_title (self)

None	media_stop (self)

int\|None	media_track (self)

None	mute_volume (self, bool mute)

None	play_media (self, MediaType\|str media_type, str media_id, **Any kwargs)

None	select_sound_mode (self, str sound_mode)

None	select_source (self, str source)

None	set_repeat (self, RepeatMode repeat)

None	set_shuffle (self, bool shuffle)

None	set_volume_level (self, float volume)

str\|None	sound_mode (self)

list[str]\|None	sound_mode_list (self)

list[str]\|None	source_list (self)

dict[str, Any]	state_attributes (self)

bool	support_clear_playlist (self)

bool	support_grouping (self)

bool	support_next_track (self)

bool	support_pause (self)

bool	support_play (self)

bool	support_play_media (self)

bool	support_previous_track (self)

bool	support_seek (self)

bool	support_select_sound_mode (self)

bool	support_select_source (self)

bool	support_shuffle_set (self)

bool	support_stop (self)

bool	support_volume_mute (self)

bool	support_volume_set (self)

MediaPlayerEntityFeature	supported_features_compat (self)

None	turn_off (self)

None	turn_on (self)

None	unjoin_player (self)

float	volume_step (self)

Public Member Functions inherited from homeassistant.helpers.entity.Entity
None	__init_subclass__ (cls, **Any kwargs)

str	__repr__ (self)

None	add_to_platform_abort (self)

None	add_to_platform_finish (self)

None	add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore\|None parallel_updates)

bool	assumed_state (self)

None	async_added_to_hass (self)

None	async_device_update (self, bool warning=True)

None	async_internal_added_to_hass (self)

None	async_internal_will_remove_from_hass (self)

None	async_on_remove (self, CALLBACK_TYPE func)

None	async_registry_entry_updated (self)

None	async_remove (self, *bool force_remove=False)

None	async_removed_from_registry (self)

None	async_schedule_update_ha_state (self, bool force_refresh=False)

None	async_set_context (self, Context context)

None	async_update_ha_state (self, bool force_refresh=False)

None	async_will_remove_from_hass (self)

None	async_write_ha_state (self)

str\|None	attribution (self)

bool	available (self)

DeviceInfo\|None	device_info (self)

bool	enabled (self)

EntityCategory\|None	entity_category (self)

bool	entity_registry_enabled_default (self)

bool	entity_registry_visible_default (self)

Mapping[str, Any]\|None	extra_state_attributes (self)

bool	force_update (self)

HassJobType	get_hassjob_type (self, str function_name)

er.EntityOptionsType\|None	get_initial_entity_options (self)

bool	has_entity_name (self)

str\|None	icon (self)

str\|UndefinedType\|None	name (self)

None	schedule_update_ha_state (self, bool force_refresh=False)

bool	should_poll (self)

str\|None	suggested_object_id (self)

str\|None	translation_key (self)

Mapping[str, str]	translation_placeholders (self)

str\|None	unique_id (self)

str\|None	unit_of_measurement (self)

bool	use_device_name (self)

Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None	__init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)

Any	__new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]\|None cached_properties=None, **Any kwargs)

Public Attributes
	password

	port

	server

Public Attributes inherited from homeassistant.components.media_player.MediaPlayerEntity
	state

Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry

	entity_id

	hass

	parallel_updates

	platform

	registry_entry

Private Member Functions
def	_async_get_file_image_response (self, file)

def	_async_update_media_image_hash (self)

None	_update_playlists (self, **Any kwargs)

Private Attributes
	_attr_available

	_attr_device_info

	_attr_is_volume_muted

	_attr_media_position

	_attr_media_position_updated_at

	_attr_source_list

	_attr_unique_id

	_client

	_client_lock

	_current_playlist

	_currentsong

	_media_image_file

	_media_image_hash

	_muted_volume

	_status

Static Private Attributes
bool	_attr_has_entity_name = True

	_attr_media_content_type = MediaType.MUSIC

	_attr_name = None

Additional Inherited Members
Static Public Attributes inherited from homeassistant.components.media_player.MediaPlayerEntity
	bool

	MediaPlayerEntityFeature

	None

Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool

	EntityPlatform

	HomeAssistant

	None

	StateInfo

	StateType

	str

Detailed Description

Representation of a MPD server.

Definition at line 140 of file media_player.py.

Constructor & Destructor Documentation

◆ init()

None homeassistant.components.mpd.media_player.MpdDevice.__init__	(		self,
		str	server,
		int	port,
		str \| None	password,
		str	unique_id
	)

Initialize the MPD device.

Definition at line 147 of file media_player.py.

Member Function Documentation

◆ _async_get_file_image_response()

def homeassistant.components.mpd.media_player.MpdDevice._async_get_file_image_response	(	self,
		file
	)

private

Definition at line 353 of file media_player.py.

◆ _async_update_media_image_hash()

def homeassistant.components.mpd.media_player.MpdDevice._async_update_media_image_hash ( self )

private

Update the hash value for the media image.

Definition at line 327 of file media_player.py.

◆ _update_playlists()

None homeassistant.components.mpd.media_player.MpdDevice._update_playlists	(		self,
		**Any	kwargs
	)

private

Update available MPD playlists.

Definition at line 429 of file media_player.py.

◆ async_browse_media()

BrowseMedia homeassistant.components.mpd.media_player.MpdDevice.async_browse_media	(		self,
		MediaType \| str \| None	media_content_type = `None`,
		str \| None	media_content_id = `None`
	)

Implement the websocket media browsing helper.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 583 of file media_player.py.

◆ async_clear_playlist()

None homeassistant.components.mpd.media_player.MpdDevice.async_clear_playlist ( self )

Clear players playlist.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 573 of file media_player.py.

◆ async_get_media_image()

tuple[bytes | None, str | None] homeassistant.components.mpd.media_player.MpdDevice.async_get_media_image ( self )

Fetch media image of current playing track.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 310 of file media_player.py.

◆ async_media_next_track()

None homeassistant.components.mpd.media_player.MpdDevice.async_media_next_track ( self )

Service to send the MPD the command for next track.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 482 of file media_player.py.

◆ async_media_pause()

None homeassistant.components.mpd.media_player.MpdDevice.async_media_pause ( self )

Service to send the MPD the command for play/pause.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 472 of file media_player.py.

◆ async_media_play()

None homeassistant.components.mpd.media_player.MpdDevice.async_media_play ( self )

Service to send the MPD the command for play/pause.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 464 of file media_player.py.

◆ async_media_previous_track()

None homeassistant.components.mpd.media_player.MpdDevice.async_media_previous_track ( self )

Service to send the MPD the command for previous track.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 487 of file media_player.py.

◆ async_media_seek()

None homeassistant.components.mpd.media_player.MpdDevice.async_media_seek	(		self,
		float	position
	)

Send seek command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 578 of file media_player.py.

◆ async_media_stop()

None homeassistant.components.mpd.media_player.MpdDevice.async_media_stop ( self )

Service to send the MPD the command for stop.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 477 of file media_player.py.

◆ async_mute_volume()

None homeassistant.components.mpd.media_player.MpdDevice.async_mute_volume	(		self,
		bool	mute
	)

Mute. Emulated with set_volume_level.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 492 of file media_player.py.

◆ async_play_media()

None homeassistant.components.mpd.media_player.MpdDevice.async_play_media	(		self,
		MediaType \| str	media_type,
		str	media_id,
		**Any	kwargs
	)

Send the media player the command for playing a playlist.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 502 of file media_player.py.

◆ async_select_source()

None homeassistant.components.mpd.media_player.MpdDevice.async_select_source	(		self,
		str	source
	)

Choose a different available playlist and play it.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 424 of file media_player.py.

◆ async_set_repeat()

None homeassistant.components.mpd.media_player.MpdDevice.async_set_repeat	(		self,
		RepeatMode	repeat
	)

Set repeat mode.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 539 of file media_player.py.

◆ async_set_shuffle()

None homeassistant.components.mpd.media_player.MpdDevice.async_set_shuffle	(		self,
		bool	shuffle
	)

Enable/disable shuffle mode.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 557 of file media_player.py.

◆ async_set_volume_level()

None homeassistant.components.mpd.media_player.MpdDevice.async_set_volume_level	(		self,
		float	volume
	)

Set volume of media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 440 of file media_player.py.

◆ async_turn_off()

None homeassistant.components.mpd.media_player.MpdDevice.async_turn_off ( self )

Service to send the MPD the command to stop playing.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 562 of file media_player.py.

◆ async_turn_on()

None homeassistant.components.mpd.media_player.MpdDevice.async_turn_on ( self )

Service to send the MPD the command to start playing.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 567 of file media_player.py.

◆ async_update()

None homeassistant.components.mpd.media_player.MpdDevice.async_update ( self )

Get the latest data from MPD and update the state.

Definition at line 221 of file media_player.py.

◆ async_volume_down()

None homeassistant.components.mpd.media_player.MpdDevice.async_volume_down ( self )

Service to send the MPD the command for volume down.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 455 of file media_player.py.

◆ async_volume_up()

None homeassistant.components.mpd.media_player.MpdDevice.async_volume_up ( self )

Service to send the MPD the command for volume up.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 446 of file media_player.py.

◆ connection()

def homeassistant.components.mpd.media_player.MpdDevice.connection ( self )

Handle MPD connect and disconnect.

Definition at line 179 of file media_player.py.

◆ media_album_name()

def homeassistant.components.mpd.media_player.MpdDevice.media_album_name ( self )

Return the album of current playing media (Music track only).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 301 of file media_player.py.

◆ media_artist()

def homeassistant.components.mpd.media_player.MpdDevice.media_artist ( self )

Return the artist of current playing media (Music track only).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 293 of file media_player.py.

◆ media_content_id()

def homeassistant.components.mpd.media_player.MpdDevice.media_content_id ( self )

Return the content ID of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 258 of file media_player.py.

◆ media_duration()

def homeassistant.components.mpd.media_player.MpdDevice.media_duration ( self )

Return the duration of current playing media in seconds.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 263 of file media_player.py.

◆ media_image_hash()

def homeassistant.components.mpd.media_player.MpdDevice.media_image_hash ( self )

Hash value for media image.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 306 of file media_player.py.

◆ media_title()

def homeassistant.components.mpd.media_player.MpdDevice.media_title ( self )

Return the title of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 275 of file media_player.py.

◆ repeat()

RepeatMode homeassistant.components.mpd.media_player.MpdDevice.repeat ( self )

Return current repeat mode.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 531 of file media_player.py.

◆ shuffle()

def homeassistant.components.mpd.media_player.MpdDevice.shuffle ( self )

Boolean if shuffle is enabled.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 553 of file media_player.py.

◆ source()

def homeassistant.components.mpd.media_player.MpdDevice.source ( self )

Name of the current input source.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 420 of file media_player.py.

◆ state()

MediaPlayerState homeassistant.components.mpd.media_player.MpdDevice.state ( self )

Return the media state.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 244 of file media_player.py.

◆ supported_features()

MediaPlayerEntityFeature homeassistant.components.mpd.media_player.MpdDevice.supported_features ( self )

Flag media player features that are supported.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 402 of file media_player.py.

◆ volume_level()

def homeassistant.components.mpd.media_player.MpdDevice.volume_level ( self )

Return the volume level.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 395 of file media_player.py.

Member Data Documentation

◆ _attr_available

homeassistant.components.mpd.media_player.MpdDevice._attr_available

private

Definition at line 195 of file media_player.py.

◆ _attr_device_info

homeassistant.components.mpd.media_player.MpdDevice._attr_device_info

private

Definition at line 154 of file media_player.py.

◆ _attr_has_entity_name

bool homeassistant.components.mpd.media_player.MpdDevice._attr_has_entity_name = True

staticprivate

Definition at line 144 of file media_player.py.

◆ _attr_is_volume_muted

homeassistant.components.mpd.media_player.MpdDevice._attr_is_volume_muted

private

Definition at line 500 of file media_player.py.

◆ _attr_media_content_type

homeassistant.components.mpd.media_player.MpdDevice._attr_media_content_type = MediaType.MUSIC

staticprivate

Definition at line 143 of file media_player.py.

◆ _attr_media_position

homeassistant.components.mpd.media_player.MpdDevice._attr_media_position

private

Definition at line 237 of file media_player.py.

◆ _attr_media_position_updated_at

homeassistant.components.mpd.media_player.MpdDevice._attr_media_position_updated_at

private

Definition at line 236 of file media_player.py.

◆ _attr_name

homeassistant.components.mpd.media_player.MpdDevice._attr_name = None

staticprivate

Definition at line 145 of file media_player.py.

◆ _attr_source_list

homeassistant.components.mpd.media_player.MpdDevice._attr_source_list

private

Definition at line 432 of file media_player.py.

◆ _attr_unique_id

homeassistant.components.mpd.media_player.MpdDevice._attr_unique_id

private

Definition at line 153 of file media_player.py.

◆ _client

homeassistant.components.mpd.media_player.MpdDevice._client

private

Definition at line 169 of file media_player.py.

◆ _client_lock

homeassistant.components.mpd.media_player.MpdDevice._client_lock

private

Definition at line 172 of file media_player.py.

◆ _current_playlist

homeassistant.components.mpd.media_player.MpdDevice._current_playlist

private

Definition at line 517 of file media_player.py.

◆ _currentsong

homeassistant.components.mpd.media_player.MpdDevice._currentsong

private

Definition at line 161 of file media_player.py.

◆ _media_image_file

homeassistant.components.mpd.media_player.MpdDevice._media_image_file

private

Definition at line 166 of file media_player.py.

◆ _media_image_hash

homeassistant.components.mpd.media_player.MpdDevice._media_image_hash

private

Definition at line 164 of file media_player.py.

◆ _muted_volume

homeassistant.components.mpd.media_player.MpdDevice._muted_volume

private

Definition at line 163 of file media_player.py.

◆ _status

homeassistant.components.mpd.media_player.MpdDevice._status

private

Definition at line 212 of file media_player.py.

◆ password

homeassistant.components.mpd.media_player.MpdDevice.password

Definition at line 158 of file media_player.py.

◆ port

homeassistant.components.mpd.media_player.MpdDevice.port

Definition at line 152 of file media_player.py.

◆ server

homeassistant.components.mpd.media_player.MpdDevice.server

Definition at line 151 of file media_player.py.

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

core/homeassistant/components/mpd/media_player.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _async_get_file_image_response()

◆ _async_update_media_image_hash()

◆ _update_playlists()

◆ async_browse_media()

◆ async_clear_playlist()

◆ async_get_media_image()

◆ async_media_next_track()

◆ async_media_pause()

◆ async_media_play()

◆ async_media_previous_track()

◆ async_media_seek()

◆ async_media_stop()

◆ async_mute_volume()

◆ async_play_media()

◆ async_select_source()

◆ async_set_repeat()

◆ async_set_shuffle()

◆ async_set_volume_level()

◆ async_turn_off()

◆ async_turn_on()

◆ async_update()

◆ async_volume_down()

◆ async_volume_up()

◆ connection()

◆ media_album_name()

◆ media_artist()

◆ media_content_id()

◆ media_duration()

◆ media_image_hash()

◆ media_title()

◆ repeat()

◆ shuffle()

◆ source()

◆ state()

◆ supported_features()

◆ volume_level()

Member Data Documentation

◆ _attr_available

◆ _attr_device_info

◆ _attr_has_entity_name

◆ _attr_is_volume_muted

◆ _attr_media_content_type

◆ _attr_media_position

◆ _attr_media_position_updated_at

◆ _attr_name

◆ _attr_source_list

◆ _attr_unique_id

◆ _client

◆ _client_lock

◆ _current_playlist

◆ _currentsong

◆ _media_image_file

◆ _media_image_hash

◆ _muted_volume

◆ _status

◆ password

◆ port

◆ server

◆ init()