Inheritance diagram for homeassistant.components.mediaroom.media_player.MediaroomDevice:

Collaboration diagram for homeassistant.components.mediaroom.media_player.MediaroomDevice:

Public Member Functions
def	__init__ (self, host, device_id, optimistic=False, timeout=DEFAULT_TIMEOUT)

None	async_added_to_hass (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_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_turn_off (self)

None	async_turn_on (self)

None	async_volume_down (self)

None	async_volume_up (self)

def	available (self)

def	media_channel (self)

def	name (self)

def	set_state (self, mediaroom_state)

def	unique_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)

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

str\|None	media_artist (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)

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)

str\|None	media_title (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)

RepeatMode\|str\|None	repeat (self)

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)

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)

None	turn_off (self)

None	turn_on (self)

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

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)

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

	stb

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 Attributes
	_attr_state

	_available

	_channel

	_name

	_optimistic

	_unique_id

Static Private Attributes
	_attr_media_content_type = MediaType.CHANNEL

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 a Mediaroom set-up-box on the network.

Definition at line 114 of file media_player.py.

Constructor & Destructor Documentation

◆ init()

def homeassistant.components.mediaroom.media_player.MediaroomDevice.__init__	(	self,
		host,
		device_id,
		optimistic = `False`,
		timeout = `DEFAULT_TIMEOUT`
	)

Initialize the device.

Definition at line 147 of file media_player.py.

Member Function Documentation

◆ async_added_to_hass()

None homeassistant.components.mediaroom.media_player.MediaroomDevice.async_added_to_hass ( self )

Retrieve latest state.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 172 of file media_player.py.

◆ async_media_next_track()

None homeassistant.components.mediaroom.media_player.MediaroomDevice.async_media_next_track ( self )

Send Program Up command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 312 of file media_player.py.

◆ async_media_pause()

None homeassistant.components.mediaroom.media_player.MediaroomDevice.async_media_pause ( self )

Send pause command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 276 of file media_player.py.

◆ async_media_play()

None homeassistant.components.mediaroom.media_player.MediaroomDevice.async_media_play ( self )

Send play command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 263 of file media_player.py.

◆ async_media_previous_track()

None homeassistant.components.mediaroom.media_player.MediaroomDevice.async_media_previous_track ( self )

Send Program Down command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 300 of file media_player.py.

◆ async_media_stop()

None homeassistant.components.mediaroom.media_player.MediaroomDevice.async_media_stop ( self )

Send stop command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 288 of file media_player.py.

◆ async_mute_volume()

None homeassistant.components.mediaroom.media_player.MediaroomDevice.async_mute_volume	(		self,
		bool	mute
	)

Send mute command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 343 of file media_player.py.

◆ async_play_media()

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

Play media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 192 of file media_player.py.

◆ async_turn_off()

None homeassistant.components.mediaroom.media_player.MediaroomDevice.async_turn_off ( self )

Turn off the receiver.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 251 of file media_player.py.

◆ async_turn_on()

None homeassistant.components.mediaroom.media_player.MediaroomDevice.async_turn_on ( self )

Turn on the receiver.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 239 of file media_player.py.

◆ async_volume_down()

None homeassistant.components.mediaroom.media_player.MediaroomDevice.async_volume_down ( self )

Send volume up command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 334 of file media_player.py.

◆ async_volume_up()

None homeassistant.components.mediaroom.media_player.MediaroomDevice.async_volume_up ( self )

Send volume up command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 324 of file media_player.py.

◆ available()

def homeassistant.components.mediaroom.media_player.MediaroomDevice.available ( self )

Return True if entity is available.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 168 of file media_player.py.

◆ media_channel()

def homeassistant.components.mediaroom.media_player.MediaroomDevice.media_channel ( self )

Channel currently playing.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 235 of file media_player.py.

◆ name()

def homeassistant.components.mediaroom.media_player.MediaroomDevice.name ( self )

Return the name of the device.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 230 of file media_player.py.

◆ set_state()

def homeassistant.components.mediaroom.media_player.MediaroomDevice.set_state	(	self,
		mediaroom_state
	)

Map pymediaroom state to HA state.

Definition at line 132 of file media_player.py.

◆ unique_id()

def homeassistant.components.mediaroom.media_player.MediaroomDevice.unique_id ( self )

Return a unique ID.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 225 of file media_player.py.

Member Data Documentation

◆ _attr_media_content_type

homeassistant.components.mediaroom.media_player.MediaroomDevice._attr_media_content_type = MediaType.CHANNEL

staticprivate

Definition at line 117 of file media_player.py.

◆ _attr_should_poll

bool homeassistant.components.mediaroom.media_player.MediaroomDevice._attr_should_poll = False

staticprivate

Definition at line 118 of file media_player.py.

◆ _attr_state

homeassistant.components.mediaroom.media_player.MediaroomDevice._attr_state

private

Definition at line 145 of file media_player.py.

◆ _attr_supported_features

tuple homeassistant.components.mediaroom.media_player.MediaroomDevice._attr_supported_features

staticprivate

Initial value:

=  (
        MediaPlayerEntityFeature.PAUSE
        | MediaPlayerEntityFeature.TURN_ON
        | MediaPlayerEntityFeature.TURN_OFF
        | MediaPlayerEntityFeature.VOLUME_STEP
        | MediaPlayerEntityFeature.VOLUME_MUTE
        | MediaPlayerEntityFeature.PLAY_MEDIA
        | MediaPlayerEntityFeature.STOP
        | MediaPlayerEntityFeature.NEXT_TRACK
        | MediaPlayerEntityFeature.PREVIOUS_TRACK
        | MediaPlayerEntityFeature.PLAY
    )

Definition at line 119 of file media_player.py.

◆ _available

homeassistant.components.mediaroom.media_player.MediaroomDevice._available

private

Definition at line 161 of file media_player.py.

◆ _channel

homeassistant.components.mediaroom.media_player.MediaroomDevice._channel

private

Definition at line 155 of file media_player.py.

◆ _name

homeassistant.components.mediaroom.media_player.MediaroomDevice._name

private

Definition at line 160 of file media_player.py.

◆ _optimistic

homeassistant.components.mediaroom.media_player.MediaroomDevice._optimistic

private

Definition at line 156 of file media_player.py.

◆ _unique_id

homeassistant.components.mediaroom.media_player.MediaroomDevice._unique_id

private

Definition at line 163 of file media_player.py.

◆ host

homeassistant.components.mediaroom.media_player.MediaroomDevice.host

Definition at line 150 of file media_player.py.

◆ stb

homeassistant.components.mediaroom.media_player.MediaroomDevice.stb

Definition at line 151 of file media_player.py.

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

core/homeassistant/components/mediaroom/media_player.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Public Attributes

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ async_added_to_hass()

◆ async_media_next_track()

◆ async_media_pause()

◆ async_media_play()

◆ async_media_previous_track()

◆ async_media_stop()

◆ async_mute_volume()

◆ async_play_media()

◆ async_turn_off()

◆ async_turn_on()

◆ async_volume_down()

◆ async_volume_up()

◆ available()

◆ media_channel()

◆ name()

◆ set_state()

◆ unique_id()

Member Data Documentation

◆ _attr_media_content_type

◆ _attr_should_poll

◆ _attr_state

◆ _attr_supported_features

◆ _available

◆ _channel

◆ _name

◆ _optimistic

◆ _unique_id

◆ host

◆ stb

◆ init()