Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.demo.media_player.DemoMusicPlayer Class Reference
Inheritance diagram for homeassistant.components.demo.media_player.DemoMusicPlayer:
[legend]
Collaboration diagram for homeassistant.components.demo.media_player.DemoMusicPlayer:
[legend]

Public Member Functions

None __init__ (self, str name="Walkman")
 
None clear_playlist (self)
 
None join_players (self, list[str] group_members)
 
str media_artist (self)
 
None media_next_track (self)
 
None media_previous_track (self)
 
str media_title (self)
 
int media_track (self)
 
None set_repeat (self, RepeatMode repeat)
 
None unjoin_player (self)
 
- Public Member Functions inherited from homeassistant.components.demo.media_player.AbstractDemoPlayer
None __init__ (self, str name, MediaPlayerDeviceClass|None device_class=None)
 
None media_pause (self)
 
None media_play (self)
 
None media_stop (self)
 
None mute_volume (self, bool mute)
 
None select_sound_mode (self, str sound_mode)
 
None set_shuffle (self, bool shuffle)
 
None set_volume_level (self, float volume)
 
None turn_off (self)
 
None turn_on (self)
 
None volume_down (self)
 
None volume_up (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)
 
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|Noneasync_get_browse_image (self, str media_content_type, str media_content_id, str|None media_image_id=None)
 
tuple[bytes|None, str|Noneasync_get_media_image (self)
 
None async_join_players (self, list[str] group_members)
 
None async_media_next_track (self)
 
None async_media_pause (self)
 
None async_media_play (self)
 
None async_media_play_pause (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_sound_mode (self, str sound_mode)
 
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_toggle (self)
 
None async_turn_off (self)
 
None async_turn_on (self)
 
None async_unjoin_player (self)
 
None async_volume_down (self)
 
None async_volume_up (self)
 
dict[str, Any] capability_attributes (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)
 
str|None media_album_artist (self)
 
str|None media_album_name (self)
 
str|None media_channel (self)
 
str|None media_content_id (self)
 
MediaType|str|None media_content_type (self)
 
int|None media_duration (self)
 
str|None media_episode (self)
 
str|None media_image_hash (self)
 
str|None media_image_local (self)
 
bool media_image_remotely_accessible (self)
 
str|None media_image_url (self)
 
str|None media_playlist (self)
 
int|None media_position (self)
 
dt.datetime|None media_position_updated_at (self)
 
str|None media_season (self)
 
None media_seek (self, float position)
 
str|None media_series_title (self)
 
None play_media (self, MediaType|str media_type, str media_id, **Any kwargs)
 
RepeatMode|str|None repeat (self)
 
None select_source (self, str source)
 
bool|None shuffle (self)
 
str|None sound_mode (self)
 
list[str]|None sound_mode_list (self)
 
str|None source (self)
 
list[str]|None source_list (self)
 
MediaPlayerState|None state (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)
 
float|None volume_level (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, strtranslation_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

 tracks
 
- 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
 

Static Public Attributes

list tracks
 
- 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
 

Private Attributes

 _attr_group_members
 
 _attr_repeat
 
 _attr_state
 
 _cur_track
 

Static Private Attributes

string _attr_media_album_name = "Bounzz"
 
string _attr_media_content_id = "bounzz-1"
 
 _attr_media_content_type = MediaType.MUSIC
 
int _attr_media_duration = 213
 
tuple _attr_media_image_url
 
 _attr_supported_features = MUSIC_PLAYER_SUPPORT
 

Detailed Description

A Demo media player.

Definition at line 241 of file media_player.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.demo.media_player.DemoMusicPlayer.__init__ (   self,
str   name = "Walkman" 
)
Initialize the demo device.

Definition at line 278 of file media_player.py.

Member Function Documentation

◆ clear_playlist()

None homeassistant.components.demo.media_player.DemoMusicPlayer.clear_playlist (   self)
Clear players playlist.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 312 of file media_player.py.

◆ join_players()

None homeassistant.components.demo.media_player.DemoMusicPlayer.join_players (   self,
list[str group_members 
)
Join `group_members` as a player group with the current player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 324 of file media_player.py.

◆ media_artist()

str homeassistant.components.demo.media_player.DemoMusicPlayer.media_artist (   self)
Return the artist of current playing media (Music track only).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 291 of file media_player.py.

◆ media_next_track()

None homeassistant.components.demo.media_player.DemoMusicPlayer.media_next_track (   self)
Send next track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 306 of file media_player.py.

◆ media_previous_track()

None homeassistant.components.demo.media_player.DemoMusicPlayer.media_previous_track (   self)
Send previous track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 300 of file media_player.py.

◆ media_title()

str homeassistant.components.demo.media_player.DemoMusicPlayer.media_title (   self)
Return the title of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 286 of file media_player.py.

◆ media_track()

int homeassistant.components.demo.media_player.DemoMusicPlayer.media_track (   self)
Return the track number of current media (Music track only).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 296 of file media_player.py.

◆ set_repeat()

None homeassistant.components.demo.media_player.DemoMusicPlayer.set_repeat (   self,
RepeatMode  repeat 
)
Enable/disable repeat mode.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 319 of file media_player.py.

◆ unjoin_player()

None homeassistant.components.demo.media_player.DemoMusicPlayer.unjoin_player (   self)
Remove this player from any group.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 329 of file media_player.py.

Member Data Documentation

◆ _attr_group_members

homeassistant.components.demo.media_player.DemoMusicPlayer._attr_group_members
private

Definition at line 326 of file media_player.py.

◆ _attr_media_album_name

string homeassistant.components.demo.media_player.DemoMusicPlayer._attr_media_album_name = "Bounzz"
staticprivate

Definition at line 246 of file media_player.py.

◆ _attr_media_content_id

string homeassistant.components.demo.media_player.DemoMusicPlayer._attr_media_content_id = "bounzz-1"
staticprivate

Definition at line 247 of file media_player.py.

◆ _attr_media_content_type

homeassistant.components.demo.media_player.DemoMusicPlayer._attr_media_content_type = MediaType.MUSIC
staticprivate

Definition at line 248 of file media_player.py.

◆ _attr_media_duration

int homeassistant.components.demo.media_player.DemoMusicPlayer._attr_media_duration = 213
staticprivate

Definition at line 249 of file media_player.py.

◆ _attr_media_image_url

tuple homeassistant.components.demo.media_player.DemoMusicPlayer._attr_media_image_url
staticprivate
Initial value:
= (
"https://graph.facebook.com/v2.5/107771475912710/picture?type=large"
)

Definition at line 250 of file media_player.py.

◆ _attr_repeat

homeassistant.components.demo.media_player.DemoMusicPlayer._attr_repeat
private

Definition at line 283 of file media_player.py.

◆ _attr_state

homeassistant.components.demo.media_player.DemoMusicPlayer._attr_state
private

Definition at line 316 of file media_player.py.

◆ _attr_supported_features

homeassistant.components.demo.media_player.DemoMusicPlayer._attr_supported_features = MUSIC_PLAYER_SUPPORT
staticprivate

Definition at line 253 of file media_player.py.

◆ _cur_track

homeassistant.components.demo.media_player.DemoMusicPlayer._cur_track
private

Definition at line 281 of file media_player.py.

◆ tracks [1/2]

list homeassistant.components.demo.media_player.DemoMusicPlayer.tracks
static
Initial value:
= [
("Technohead", "I Wanna Be A Hippy (Flamman & Abraxas Radio Mix)"),
("Paul Elstak", "Luv U More"),
("Dune", "Hardcore Vibes"),
("Nakatomi", "Children Of The Night"),
("Party Animals", "Have You Ever Been Mellow? (Flamman & Abraxas Radio Mix)"),
("Rob G.*", "Ecstasy, You Got What I Need"),
("Lipstick", "I'm A Raver"),
("4 Tune Fairytales", "My Little Fantasy (Radio Edit)"),
("Prophet", "The Big Boys Don't Cry"),
("Lovechild", "All Out Of Love (DJ Weirdo & Sim Remix)"),
("Stingray & Sonic Driver", "Cold As Ice (El Bruto Remix)"),
("Highlander", "Hold Me Now (Bass-D & King Matthew Remix)"),
("Juggernaut", 'Ruffneck Rules Da Artcore Scene (12" Edit)'),
("Diss Reaction", "Jiiieehaaaa "),
("Flamman And Abraxas", "Good To Go (Radio Mix)"),
("Critical Mass", "Dancing Together"),
(
"Charly Lownoise & Mental Theo",
"Ultimate Sex Track (Bass-D & King Matthew Remix)",
),
]

Definition at line 255 of file media_player.py.

◆ tracks [2/2]

homeassistant.components.demo.media_player.DemoMusicPlayer.tracks

Definition at line 314 of file media_player.py.


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