Inheritance diagram for homeassistant.components.system_bridge.media_player.SystemBridgeMediaPlayer:

Collaboration diagram for homeassistant.components.system_bridge.media_player.SystemBridgeMediaPlayer:

Public Member Functions
None	__init__ (self, SystemBridgeDataUpdateCoordinator coordinator, MediaPlayerEntityDescription description, int api_port)

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_set_repeat (self, RepeatMode repeat)

None	async_set_shuffle (self, bool shuffle)

bool	available (self)

str\|None	media_album_artist (self)

str\|None	media_album_name (self)

str\|None	media_artist (self)

int\|None	media_duration (self)

int\|None	media_position (self)

dt.datetime\|None	media_position_updated_at (self)

str\|None	media_title (self)

int\|None	media_track (self)

RepeatMode\|None	repeat (self)

bool\|None	shuffle (self)

MediaPlayerState\|None	state (self)

MediaPlayerEntityFeature	supported_features (self)

Public Member Functions inherited from homeassistant.components.system_bridge.entity.SystemBridgeEntity
None	__init__ (self, SystemBridgeDataUpdateCoordinator coordinator, int api_port, str key)

DeviceInfo	device_info (self)

str	unique_id (self)

Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None	__init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)

None	async_update (self)

Public Member Functions inherited from homeassistant.components.system_bridge.coordinator.SystemBridgeDataUpdateCoordinator
None	__init__ (self, HomeAssistant hass, logging.Logger LOGGER, *ConfigEntry entry)

ModulesData	async_get_data (self, list[Module] modules)

None	async_handle_module (self, str module_name, Any module)

None	check_websocket_connected (self)

None	clean_disconnect (self)

None	close_websocket (self)

Public Member Functions inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
None	__init__ (self, HomeAssistant hass, logging.Logger logger, *config_entries.ConfigEntry\|None\|UndefinedType config_entry=UNDEFINED, str name, timedelta\|None update_interval=None, Callable[[], Awaitable[_DataT]]\|None update_method=None, Callable[[], Awaitable[None]]\|None setup_method=None, Debouncer[Coroutine[Any, Any, None]]\|None request_refresh_debouncer=None, bool always_update=True)

Callable[[], None]	async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)

None	async_config_entry_first_refresh (self)

Generator[Any]	async_contexts (self)

None	async_refresh (self)

None	async_register_shutdown (self)

None	async_request_refresh (self)

None	async_set_update_error (self, Exception err)

None	async_set_updated_data (self, _DataT data)

None	async_shutdown (self)

None	async_update_listeners (self)

timedelta\|None	update_interval (self)

None	update_interval (self, timedelta\|None value)

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_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_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)

list[str]\|None	group_members (self)

bool\|None	is_volume_muted (self)

None	join_players (self, list[str] group_members)

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)

str\|None	media_image_url (self)

None	media_next_track (self)

None	media_pause (self)

None	media_play (self)

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

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_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_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)

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
	entity_description

Public Attributes inherited from homeassistant.components.system_bridge.coordinator.SystemBridgeDataUpdateCoordinator
	data

	last_update_success

	listen_task

	title

	unsub

	websocket_client

Public Attributes inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
	always_update

	config_entry

	data

	hass

	last_exception

	last_update_success

	logger

	name

	setup_method

	update_interval

	update_method

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
SystemBridgeData	_systembridge_data (self)

Additional Inherited Members
Static Public Attributes inherited from homeassistant.components.system_bridge.data.SystemBridgeData
	Battery

	CPU

	default_factory

	Disks

	Media

	Memory

	System

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

Define a System Bridge media player.

Definition at line 87 of file media_player.py.

Constructor & Destructor Documentation

◆ init()

None homeassistant.components.system_bridge.media_player.SystemBridgeMediaPlayer.__init__	(		self,
		SystemBridgeDataUpdateCoordinator	coordinator,
		MediaPlayerEntityDescription	description,
		int	api_port
	)

Initialize.

Definition at line 92 of file media_player.py.

Member Function Documentation

◆ _systembridge_data()

SystemBridgeData homeassistant.components.system_bridge.media_player.SystemBridgeMediaPlayer._systembridge_data ( self )

private

Return data for the entity.

Definition at line 131 of file media_player.py.

◆ async_media_next_track()

None homeassistant.components.system_bridge.media_player.SystemBridgeMediaPlayer.async_media_next_track ( self )

Send next track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 235 of file media_player.py.

◆ async_media_pause()

None homeassistant.components.system_bridge.media_player.SystemBridgeMediaPlayer.async_media_pause ( self )

Send pause command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 211 of file media_player.py.

◆ async_media_play()

None homeassistant.components.system_bridge.media_player.SystemBridgeMediaPlayer.async_media_play ( self )

Send play command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 203 of file media_player.py.

◆ async_media_previous_track()

None homeassistant.components.system_bridge.media_player.SystemBridgeMediaPlayer.async_media_previous_track ( self )

Send previous track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 227 of file media_player.py.

◆ async_media_stop()

None homeassistant.components.system_bridge.media_player.SystemBridgeMediaPlayer.async_media_stop ( self )

Send stop command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 219 of file media_player.py.

◆ async_set_repeat()

None homeassistant.components.system_bridge.media_player.SystemBridgeMediaPlayer.async_set_repeat	(		self,
		RepeatMode	repeat
	)

Set repeat mode.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 255 of file media_player.py.

◆ async_set_shuffle()

None homeassistant.components.system_bridge.media_player.SystemBridgeMediaPlayer.async_set_shuffle	(		self,
		bool	shuffle
	)

Enable/disable shuffle mode.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 243 of file media_player.py.

◆ available()

bool homeassistant.components.system_bridge.media_player.SystemBridgeMediaPlayer.available ( self )

Return True if entity is available.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 107 of file media_player.py.

◆ media_album_artist()

str | None homeassistant.components.system_bridge.media_player.SystemBridgeMediaPlayer.media_album_artist ( self )

Album artist of current playing media, music track only.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 182 of file media_player.py.

◆ media_album_name()

str | None homeassistant.components.system_bridge.media_player.SystemBridgeMediaPlayer.media_album_name ( self )

Album name of current playing media, music track only.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 177 of file media_player.py.

◆ media_artist()

str | None homeassistant.components.system_bridge.media_player.SystemBridgeMediaPlayer.media_artist ( self )

Artist of current playing media, music track only.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 172 of file media_player.py.

◆ media_duration()

int | None homeassistant.components.system_bridge.media_player.SystemBridgeMediaPlayer.media_duration ( self )

Duration of current playing media in seconds.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 146 of file media_player.py.

◆ media_position()

int | None homeassistant.components.system_bridge.media_player.SystemBridgeMediaPlayer.media_position ( self )

Position of current playing media in seconds.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 153 of file media_player.py.

◆ media_position_updated_at()

dt.datetime | None homeassistant.components.system_bridge.media_player.SystemBridgeMediaPlayer.media_position_updated_at ( self )

When was the position of the current playing media valid.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 160 of file media_player.py.

◆ media_title()

str | None homeassistant.components.system_bridge.media_player.SystemBridgeMediaPlayer.media_title ( self )

Title of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 167 of file media_player.py.

◆ media_track()

int | None homeassistant.components.system_bridge.media_player.SystemBridgeMediaPlayer.media_track ( self )

Track number of current playing media, music track only.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 187 of file media_player.py.

◆ repeat()

RepeatMode | None homeassistant.components.system_bridge.media_player.SystemBridgeMediaPlayer.repeat ( self )

Return current repeat mode.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 197 of file media_player.py.

◆ shuffle()

bool | None homeassistant.components.system_bridge.media_player.SystemBridgeMediaPlayer.shuffle ( self )

Boolean if shuffle is enabled.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 192 of file media_player.py.

◆ state()

MediaPlayerState | None homeassistant.components.system_bridge.media_player.SystemBridgeMediaPlayer.state ( self )

State of the player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 136 of file media_player.py.

◆ supported_features()

MediaPlayerEntityFeature homeassistant.components.system_bridge.media_player.SystemBridgeMediaPlayer.supported_features ( self )

Flag media player features that are supported.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 112 of file media_player.py.

Member Data Documentation

◆ entity_description

homeassistant.components.system_bridge.media_player.SystemBridgeMediaPlayer.entity_description

Definition at line 104 of file media_player.py.

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

core/homeassistant/components/system_bridge/media_player.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Public Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _systembridge_data()

◆ async_media_next_track()

◆ async_media_pause()

◆ async_media_play()

◆ async_media_previous_track()

◆ async_media_stop()

◆ async_set_repeat()

◆ async_set_shuffle()

◆ available()

◆ media_album_artist()

◆ media_album_name()

◆ media_artist()

◆ media_duration()

◆ media_position()

◆ media_position_updated_at()

◆ media_title()

◆ media_track()

◆ repeat()

◆ shuffle()

◆ state()

◆ supported_features()

Member Data Documentation

◆ entity_description

◆ init()