Inheritance diagram for homeassistant.components.volumio.media_player.Volumio:

Collaboration diagram for homeassistant.components.volumio.media_player.Volumio:

Public Member Functions
def	__init__ (self, volumio, uid, name, info)

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_browse_image (self, MediaType\|str media_content_type, str media_content_id, str\|None media_image_id=None)

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_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_update (self)

None	async_volume_down (self)

None	async_volume_up (self)

def	is_volume_muted (self)

def	media_album_name (self)

def	media_artist (self)

def	media_duration (self)

def	media_image_url (self)

def	media_seek_position (self)

def	media_title (self)

RepeatMode	repeat (self)

def	shuffle (self)

MediaPlayerState	state (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)

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

None	async_join_players (self, list[str] group_members)

None	async_media_play_pause (self)

None	async_media_seek (self, float position)

None	async_select_sound_mode (self, str sound_mode)

None	async_toggle (self)

None	async_turn_off (self)

None	async_turn_on (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)

None	join_players (self, list[str] group_members)

str\|None	media_album_artist (self)

str\|None	media_channel (self)

str\|None	media_content_id (self)

MediaType\|str\|None	media_content_type (self)

str\|None	media_episode (self)

str\|None	media_image_hash (self)

str\|None	media_image_local (self)

bool	media_image_remotely_accessible (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)

str\|None	source (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 (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
	thumbnail_cache

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_update_playlists (self, **kwargs)

Private Attributes
	_attr_device_info

	_attr_source

	_attr_source_list

	_attr_unique_id

	_state

	_volumio

Static Private Attributes
bool	_attr_has_entity_name = True

	_attr_media_content_type = MediaType.MUSIC

	_attr_name = None

list	_attr_source_list = []

tuple	_attr_supported_features

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

Volumio Player Object.

Definition at line 50 of file media_player.py.

Constructor & Destructor Documentation

◆ init()

def homeassistant.components.volumio.media_player.Volumio.__init__	(	self,
		volumio,
		uid,
		name,
		info
	)

Initialize the media player.

Definition at line 75 of file media_player.py.

Member Function Documentation

◆ _async_update_playlists()

def homeassistant.components.volumio.media_player.Volumio._async_update_playlists	(		self,
		**	kwargs
	)

private

Update available Volumio playlists.

Definition at line 226 of file media_player.py.

◆ async_browse_media()

BrowseMedia homeassistant.components.volumio.media_player.Volumio.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 236 of file media_player.py.

◆ async_clear_playlist()

None homeassistant.components.volumio.media_player.Volumio.async_clear_playlist ( self )

Clear players playlist.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 220 of file media_player.py.

◆ async_get_browse_image()

tuple[bytes \| None, str \| None] homeassistant.components.volumio.media_player.Volumio.async_get_browse_image	(		self,
		MediaType \| str	media_content_type,
		str	media_content_id,
		str \| None	media_image_id = `None`
	)

Get album art from Volumio.

Definition at line 250 of file media_player.py.

◆ async_media_next_track()

None homeassistant.components.volumio.media_player.Volumio.async_media_next_track ( self )

Send media_next command to media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 162 of file media_player.py.

◆ async_media_pause()

None homeassistant.components.volumio.media_player.Volumio.async_media_pause ( self )

Send media_pause command to media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 174 of file media_player.py.

◆ async_media_play()

None homeassistant.components.volumio.media_player.Volumio.async_media_play ( self )

Send media_play command to media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 170 of file media_player.py.

◆ async_media_previous_track()

None homeassistant.components.volumio.media_player.Volumio.async_media_previous_track ( self )

Send media_previous command to media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 166 of file media_player.py.

◆ async_media_stop()

None homeassistant.components.volumio.media_player.Volumio.async_media_stop ( self )

Send media_stop command to media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 181 of file media_player.py.

◆ async_mute_volume()

None homeassistant.components.volumio.media_player.Volumio.async_mute_volume	(		self,
		bool	mute
	)

Send mute command to media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 197 of file media_player.py.

◆ async_play_media()

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

Send the play_media command to the media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 230 of file media_player.py.

◆ async_select_source()

None homeassistant.components.volumio.media_player.Volumio.async_select_source	(		self,
		str	source
	)

Choose an available playlist and play it.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 215 of file media_player.py.

◆ async_set_repeat()

None homeassistant.components.volumio.media_player.Volumio.async_set_repeat	(		self,
		RepeatMode	repeat
	)

Set repeat mode.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 208 of file media_player.py.

◆ async_set_shuffle()

None homeassistant.components.volumio.media_player.Volumio.async_set_shuffle	(		self,
		bool	shuffle
	)

Enable/disable shuffle mode.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 204 of file media_player.py.

◆ async_set_volume_level()

None homeassistant.components.volumio.media_player.Volumio.async_set_volume_level	(		self,
		float	volume
	)

Send volume_up command to media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 185 of file media_player.py.

◆ async_update()

None homeassistant.components.volumio.media_player.Volumio.async_update ( self )

Update state.

Definition at line 90 of file media_player.py.

◆ async_volume_down()

None homeassistant.components.volumio.media_player.Volumio.async_volume_down ( self )

Service to send the Volumio the command for volume down.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 193 of file media_player.py.

◆ async_volume_up()

None homeassistant.components.volumio.media_player.Volumio.async_volume_up ( self )

Service to send the Volumio the command for volume up.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 189 of file media_player.py.

◆ is_volume_muted()

def homeassistant.components.volumio.media_player.Volumio.is_volume_muted ( self )

Boolean if volume is currently muted.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 146 of file media_player.py.

◆ media_album_name()

def homeassistant.components.volumio.media_player.Volumio.media_album_name ( self )

Artist of current playing media (Music track only).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 117 of file media_player.py.

◆ media_artist()

def homeassistant.components.volumio.media_player.Volumio.media_artist ( self )

Artist of current playing media (Music track only).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 112 of file media_player.py.

◆ media_duration()

def homeassistant.components.volumio.media_player.Volumio.media_duration ( self )

Time in seconds of current song duration.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 133 of file media_player.py.

◆ media_image_url()

def homeassistant.components.volumio.media_player.Volumio.media_image_url ( self )

Image url of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 122 of file media_player.py.

◆ media_seek_position()

def homeassistant.components.volumio.media_player.Volumio.media_seek_position ( self )

Time in seconds of current seek position.

Definition at line 128 of file media_player.py.

◆ media_title()

def homeassistant.components.volumio.media_player.Volumio.media_title ( self )

Title of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 107 of file media_player.py.

◆ repeat()

RepeatMode homeassistant.components.volumio.media_player.Volumio.repeat ( self )

Return current repeat mode.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 156 of file media_player.py.

◆ shuffle()

def homeassistant.components.volumio.media_player.Volumio.shuffle ( self )

Boolean if shuffle is enabled.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 151 of file media_player.py.

◆ state()

MediaPlayerState homeassistant.components.volumio.media_player.Volumio.state ( self )

Return the state of the device.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 96 of file media_player.py.

◆ volume_level()

def homeassistant.components.volumio.media_player.Volumio.volume_level ( self )

Volume level of the media player (0..1).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 138 of file media_player.py.

Member Data Documentation

◆ _attr_device_info

homeassistant.components.volumio.media_player.Volumio._attr_device_info

private

Definition at line 82 of file media_player.py.

◆ _attr_has_entity_name

bool homeassistant.components.volumio.media_player.Volumio._attr_has_entity_name = True

staticprivate

Definition at line 53 of file media_player.py.

◆ _attr_media_content_type

homeassistant.components.volumio.media_player.Volumio._attr_media_content_type = MediaType.MUSIC

staticprivate

Definition at line 55 of file media_player.py.

◆ _attr_name

homeassistant.components.volumio.media_player.Volumio._attr_name = None

staticprivate

Definition at line 54 of file media_player.py.

◆ _attr_source

homeassistant.components.volumio.media_player.Volumio._attr_source

private

Definition at line 218 of file media_player.py.

◆ _attr_source_list [1/2]

list homeassistant.components.volumio.media_player.Volumio._attr_source_list = []

staticprivate

Definition at line 73 of file media_player.py.

◆ _attr_source_list [2/2]

homeassistant.components.volumio.media_player.Volumio._attr_source_list

private

Definition at line 228 of file media_player.py.

◆ _attr_supported_features

tuple homeassistant.components.volumio.media_player.Volumio._attr_supported_features

staticprivate

Initial value:

=  (
        MediaPlayerEntityFeature.PAUSE
        | MediaPlayerEntityFeature.VOLUME_SET
        | MediaPlayerEntityFeature.VOLUME_MUTE
        | MediaPlayerEntityFeature.PREVIOUS_TRACK
        | MediaPlayerEntityFeature.NEXT_TRACK
        | MediaPlayerEntityFeature.SEEK
        | MediaPlayerEntityFeature.STOP
        | MediaPlayerEntityFeature.PLAY
        | MediaPlayerEntityFeature.PLAY_MEDIA
        | MediaPlayerEntityFeature.VOLUME_STEP
        | MediaPlayerEntityFeature.SELECT_SOURCE
        | MediaPlayerEntityFeature.REPEAT_SET
        | MediaPlayerEntityFeature.SHUFFLE_SET
        | MediaPlayerEntityFeature.CLEAR_PLAYLIST
        | MediaPlayerEntityFeature.BROWSE_MEDIA
    )

Definition at line 56 of file media_player.py.

◆ _attr_unique_id

homeassistant.components.volumio.media_player.Volumio._attr_unique_id

private

Definition at line 81 of file media_player.py.

◆ _state

homeassistant.components.volumio.media_player.Volumio._state

private

Definition at line 79 of file media_player.py.

◆ _volumio

homeassistant.components.volumio.media_player.Volumio._volumio

private

Definition at line 77 of file media_player.py.

◆ thumbnail_cache

homeassistant.components.volumio.media_player.Volumio.thumbnail_cache

Definition at line 80 of file media_player.py.

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

core/homeassistant/components/volumio/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_update_playlists()

◆ async_browse_media()

◆ async_clear_playlist()

◆ async_get_browse_image()

◆ async_media_next_track()

◆ async_media_pause()

◆ async_media_play()

◆ async_media_previous_track()

◆ async_media_stop()

◆ async_mute_volume()

◆ async_play_media()

◆ async_select_source()

◆ async_set_repeat()

◆ async_set_shuffle()

◆ async_set_volume_level()

◆ async_update()

◆ async_volume_down()

◆ async_volume_up()

◆ is_volume_muted()

◆ media_album_name()

◆ media_artist()

◆ media_duration()

◆ media_image_url()

◆ media_seek_position()

◆ media_title()

◆ repeat()

◆ shuffle()

◆ state()

◆ volume_level()

Member Data Documentation

◆ _attr_device_info

◆ _attr_has_entity_name

◆ _attr_media_content_type

◆ _attr_name

◆ _attr_source

◆ _attr_source_list [1/2]

◆ _attr_source_list [2/2]

◆ _attr_supported_features

◆ _attr_unique_id

◆ _state

◆ _volumio

◆ thumbnail_cache

◆ init()