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

Public Member Functions

def __init__ (self, server, player_data)
 
None async_added_to_hass (self)
 
BrowseMedia async_browse_media (self, MediaType|str|None media_content_type=None, str|None media_content_id=None)
 
def async_transfer (self, transfer_id)
 
def async_update_callback (self, player_data)
 
DeviceInfo|None device_info (self)
 
def group_members (self)
 
None join_players (self, list[str] group_members)
 
str|None media_album_artist (self)
 
None media_next_track (self)
 
None media_pause (self)
 
None media_play (self)
 
None media_play_pause (self)
 
None media_previous_track (self)
 
None media_seek (self, float position)
 
None media_stop (self)
 
def mute_volume (self, mute=True)
 
def output_id (self)
 
None play_media (self, MediaType|str media_type, str media_id, **Any kwargs)
 
None set_repeat (self, RepeatMode repeat)
 
None set_shuffle (self, bool shuffle)
 
None set_volume_level (self, float volume)
 
def supports_standby (self)
 
None turn_off (self)
 
None turn_on (self)
 
None unjoin_player (self)
 
def update_data (self, player_data=None)
 
def update_state (self)
 
None volume_down (self)
 
None volume_up (self)
 
def zone_id (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)
 
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)
 
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)
 
bool|None is_volume_muted (self)
 
str|None media_album_name (self)
 
str|None media_artist (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)
 
str|None media_series_title (self)
 
str|None media_title (self)
 
int|None media_track (self)
 
None mute_volume (self, bool mute)
 
RepeatMode|str|None repeat (self)
 
None select_sound_mode (self, str sound_mode)
 
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_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)
 
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

 player_data
 
 state
 
- 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 _parse_now_playing (self, player_data)
 
def _parse_volume (cls, player_data)
 

Private Attributes

 _attr_available
 
 _attr_is_volume_muted
 
 _attr_media_album_name
 
 _attr_media_artist
 
 _attr_media_duration
 
 _attr_media_image_url
 
 _attr_media_position
 
 _attr_media_position_updated_at
 
 _attr_media_title
 
 _attr_name
 
 _attr_repeat
 
 _attr_shuffle
 
 _attr_state
 
 _attr_supported_features
 
 _attr_unique_id
 
 _attr_volume_level
 
 _attr_volume_step
 
 _output_id
 
 _remove_signal_status
 
 _server
 
 _supports_standby
 
 _volume_fixed
 
 _volume_incremental
 
 _zone_id
 

Static Private Attributes

bool _attr_should_poll = False
 
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

Representation of an Roon device.

Definition at line 88 of file media_player.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.roon.media_player.RoonDevice.__init__ (   self,
  server,
  player_data 
)
Initialize Roon device object.

Definition at line 109 of file media_player.py.

Member Function Documentation

◆ _parse_now_playing()

def homeassistant.components.roon.media_player.RoonDevice._parse_now_playing (   self,
  player_data 
)
private
Parse now playing data to determine title, artist, position, duration and artwork.

Definition at line 224 of file media_player.py.

◆ _parse_volume()

def homeassistant.components.roon.media_player.RoonDevice._parse_volume (   cls,
  player_data 
)
private
Parse volume data to determine volume levels and mute state.

Definition at line 188 of file media_player.py.

◆ async_added_to_hass()

None homeassistant.components.roon.media_player.RoonDevice.async_added_to_hass (   self)
Register callback.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 130 of file media_player.py.

◆ async_browse_media()

BrowseMedia homeassistant.components.roon.media_player.RoonDevice.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 526 of file media_player.py.

◆ async_transfer()

def homeassistant.components.roon.media_player.RoonDevice.async_transfer (   self,
  transfer_id 
)
Transfer playback from this roon player to another.

Definition at line 499 of file media_player.py.

◆ async_update_callback()

def homeassistant.components.roon.media_player.RoonDevice.async_update_callback (   self,
  player_data 
)
Handle device updates.

Definition at line 142 of file media_player.py.

◆ device_info()

DeviceInfo | None homeassistant.components.roon.media_player.RoonDevice.device_info (   self)
Return the device info.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 155 of file media_player.py.

◆ group_members()

def homeassistant.components.roon.media_player.RoonDevice.group_members (   self)
Return the grouped players.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 148 of file media_player.py.

◆ join_players()

None homeassistant.components.roon.media_player.RoonDevice.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 444 of file media_player.py.

◆ media_album_artist()

str | None homeassistant.components.roon.media_player.RoonDevice.media_album_artist (   self)
Album artist of current playing media (Music track only).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 328 of file media_player.py.

◆ media_next_track()

None homeassistant.components.roon.media_player.RoonDevice.media_next_track (   self)
Send next track command to device.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 353 of file media_player.py.

◆ media_pause()

None homeassistant.components.roon.media_player.RoonDevice.media_pause (   self)
Send pause command to device.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 341 of file media_player.py.

◆ media_play()

None homeassistant.components.roon.media_player.RoonDevice.media_play (   self)
Send play command to device.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 337 of file media_player.py.

◆ media_play_pause()

None homeassistant.components.roon.media_player.RoonDevice.media_play_pause (   self)
Toggle play command to device.

Definition at line 345 of file media_player.py.

◆ media_previous_track()

None homeassistant.components.roon.media_player.RoonDevice.media_previous_track (   self)
Send previous track command to device.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 357 of file media_player.py.

◆ media_seek()

None homeassistant.components.roon.media_player.RoonDevice.media_seek (   self,
float  position 
)
Send seek command to device.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 361 of file media_player.py.

◆ media_stop()

None homeassistant.components.roon.media_player.RoonDevice.media_stop (   self)
Send stop command to device.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 349 of file media_player.py.

◆ mute_volume()

def homeassistant.components.roon.media_player.RoonDevice.mute_volume (   self,
  mute = True 
)
Send mute/unmute to device.

Definition at line 373 of file media_player.py.

◆ output_id()

def homeassistant.components.roon.media_player.RoonDevice.output_id (   self)
Return current session Id.

Definition at line 323 of file media_player.py.

◆ play_media()

None homeassistant.components.roon.media_player.RoonDevice.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 424 of file media_player.py.

◆ set_repeat()

None homeassistant.components.roon.media_player.RoonDevice.set_repeat (   self,
RepeatMode  repeat 
)
Set repeat mode.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 418 of file media_player.py.

◆ set_shuffle()

None homeassistant.components.roon.media_player.RoonDevice.set_shuffle (   self,
bool  shuffle 
)
Set shuffle state.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 414 of file media_player.py.

◆ set_volume_level()

None homeassistant.components.roon.media_player.RoonDevice.set_volume_level (   self,
float  volume 
)
Send new volume_level to device.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 368 of file media_player.py.

◆ supports_standby()

def homeassistant.components.roon.media_player.RoonDevice.supports_standby (   self)
Return power state of source controls.

Definition at line 333 of file media_player.py.

◆ turn_off()

None homeassistant.components.roon.media_player.RoonDevice.turn_off (   self)
Turn off device (if supported).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 403 of file media_player.py.

◆ turn_on()

None homeassistant.components.roon.media_player.RoonDevice.turn_on (   self)
Turn on device (if supported).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 391 of file media_player.py.

◆ unjoin_player()

None homeassistant.components.roon.media_player.RoonDevice.unjoin_player (   self)
Remove this player from any group.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 487 of file media_player.py.

◆ update_data()

def homeassistant.components.roon.media_player.RoonDevice.update_data (   self,
  player_data = None 
)
Update session object.

Definition at line 172 of file media_player.py.

◆ update_state()

def homeassistant.components.roon.media_player.RoonDevice.update_state (   self)
Update the power state and player state.

Definition at line 259 of file media_player.py.

◆ volume_down()

None homeassistant.components.roon.media_player.RoonDevice.volume_down (   self)
Send new volume_level to device.

Definition at line 384 of file media_player.py.

◆ volume_up()

None homeassistant.components.roon.media_player.RoonDevice.volume_up (   self)
Send new volume_level to device.

Definition at line 377 of file media_player.py.

◆ zone_id()

def homeassistant.components.roon.media_player.RoonDevice.zone_id (   self)
Return current session Id.

Definition at line 318 of file media_player.py.

Member Data Documentation

◆ _attr_available

homeassistant.components.roon.media_player.RoonDevice._attr_available
private

Definition at line 113 of file media_player.py.

◆ _attr_is_volume_muted

homeassistant.components.roon.media_player.RoonDevice._attr_is_volume_muted
private

Definition at line 121 of file media_player.py.

◆ _attr_media_album_name

homeassistant.components.roon.media_player.RoonDevice._attr_media_album_name
private

Definition at line 312 of file media_player.py.

◆ _attr_media_artist

homeassistant.components.roon.media_player.RoonDevice._attr_media_artist
private

Definition at line 311 of file media_player.py.

◆ _attr_media_duration

homeassistant.components.roon.media_player.RoonDevice._attr_media_duration
private

Definition at line 120 of file media_player.py.

◆ _attr_media_image_url

homeassistant.components.roon.media_player.RoonDevice._attr_media_image_url
private

Definition at line 124 of file media_player.py.

◆ _attr_media_position

homeassistant.components.roon.media_player.RoonDevice._attr_media_position
private

Definition at line 119 of file media_player.py.

◆ _attr_media_position_updated_at

homeassistant.components.roon.media_player.RoonDevice._attr_media_position_updated_at
private

Definition at line 185 of file media_player.py.

◆ _attr_media_title

homeassistant.components.roon.media_player.RoonDevice._attr_media_title
private

Definition at line 310 of file media_player.py.

◆ _attr_name

homeassistant.components.roon.media_player.RoonDevice._attr_name
private

Definition at line 118 of file media_player.py.

◆ _attr_repeat

homeassistant.components.roon.media_player.RoonDevice._attr_repeat
private

Definition at line 288 of file media_player.py.

◆ _attr_should_poll

bool homeassistant.components.roon.media_player.RoonDevice._attr_should_poll = False
staticprivate

Definition at line 91 of file media_player.py.

◆ _attr_shuffle

homeassistant.components.roon.media_player.RoonDevice._attr_shuffle
private

Definition at line 123 of file media_player.py.

◆ _attr_state

homeassistant.components.roon.media_player.RoonDevice._attr_state
private

Definition at line 115 of file media_player.py.

◆ _attr_supported_features [1/2]

tuple homeassistant.components.roon.media_player.RoonDevice._attr_supported_features
staticprivate
Initial value:
= (
MediaPlayerEntityFeature.BROWSE_MEDIA
| MediaPlayerEntityFeature.GROUPING
| MediaPlayerEntityFeature.PAUSE
| MediaPlayerEntityFeature.STOP
| MediaPlayerEntityFeature.PREVIOUS_TRACK
| MediaPlayerEntityFeature.NEXT_TRACK
| MediaPlayerEntityFeature.REPEAT_SET
| MediaPlayerEntityFeature.SHUFFLE_SET
| MediaPlayerEntityFeature.SEEK
| MediaPlayerEntityFeature.TURN_ON
| MediaPlayerEntityFeature.TURN_OFF
| MediaPlayerEntityFeature.VOLUME_MUTE
| MediaPlayerEntityFeature.PLAY
| MediaPlayerEntityFeature.PLAY_MEDIA
)

Definition at line 92 of file media_player.py.

◆ _attr_supported_features [2/2]

homeassistant.components.roon.media_player.RoonDevice._attr_supported_features
private

Definition at line 301 of file media_player.py.

◆ _attr_unique_id

homeassistant.components.roon.media_player.RoonDevice._attr_unique_id
private

Definition at line 285 of file media_player.py.

◆ _attr_volume_level

homeassistant.components.roon.media_player.RoonDevice._attr_volume_level
private

Definition at line 125 of file media_player.py.

◆ _attr_volume_step

homeassistant.components.roon.media_player.RoonDevice._attr_volume_step
private

Definition at line 122 of file media_player.py.

◆ _output_id

homeassistant.components.roon.media_player.RoonDevice._output_id
private

Definition at line 117 of file media_player.py.

◆ _remove_signal_status

homeassistant.components.roon.media_player.RoonDevice._remove_signal_status
private

Definition at line 111 of file media_player.py.

◆ _server

homeassistant.components.roon.media_player.RoonDevice._server
private

Definition at line 112 of file media_player.py.

◆ _supports_standby

homeassistant.components.roon.media_player.RoonDevice._supports_standby
private

Definition at line 114 of file media_player.py.

◆ _volume_fixed

homeassistant.components.roon.media_player.RoonDevice._volume_fixed
private

Definition at line 126 of file media_player.py.

◆ _volume_incremental

homeassistant.components.roon.media_player.RoonDevice._volume_incremental
private

Definition at line 127 of file media_player.py.

◆ _zone_id

homeassistant.components.roon.media_player.RoonDevice._zone_id
private

Definition at line 116 of file media_player.py.

◆ player_data

homeassistant.components.roon.media_player.RoonDevice.player_data

Definition at line 175 of file media_player.py.

◆ state

homeassistant.components.roon.media_player.RoonDevice.state

Definition at line 184 of file media_player.py.


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