Inheritance diagram for homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer:

Collaboration diagram for homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer:

Public Member Functions
def	__init__ (self, zone_id, name, entry_id, coordinator)

None	async_added_to_hass (self)

def	async_browse_media (self, media_content_type=None, media_content_id=None)

def	async_check_client_list (self)

bool	async_client_join (self, group_id, server)

def	async_client_leave_group (self, force=False)

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

def	async_schedule_check_client_list (self)

None	async_select_sound_mode (self, str sound_mode)

None	async_select_source (self, str source)

def	async_server_close_group (self)

None	async_set_repeat (self, RepeatMode repeat)

None	async_set_shuffle (self, bool shuffle)

None	async_set_volume_level (self, float volume)

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)

None	async_will_remove_from_hass (self)

list[MusicCastMediaPlayer]	get_all_mc_entities (self)

list[MusicCastMediaPlayer]	get_all_server_entities (self)

int	get_distribution_num (self)

list[str]\|None	group_members (self)

def	group_server (self)

def	ip_address (self)

bool	is_client (self)

bool	is_network_client (self)

bool	is_network_server (self)

bool	is_part_of_group (self, group_server)

bool	is_server (self)

def	is_volume_muted (self)

def	media_album_name (self)

def	media_artist (self)

def	media_content_id (self)

def	media_duration (self)

def	media_image_url (self)

def	media_position (self)

def	media_position_updated_at (self)

def	media_title (self)

list[MusicCastMediaPlayer]	musiccast_group (self)

MusicCastMediaPlayer	musiccast_zone_entity (self)

list[MusicCastMediaPlayer]	other_zones (self)

def	repeat (self)

def	reverse_source_mapping (self)

def	shuffle (self)

def	sound_mode (self)

def	sound_mode_list (self)

def	source (self)

def	source_id (self)

def	source_list (self)

def	source_mapping (self)

MediaPlayerState	state (self)

MediaPlayerEntityFeature	supported_features (self)

str	unique_id (self)

def	update_all_mc_entities (self, check_clients=False)

def	volume_level (self)

def	zone (self)

def	zone_id (self)

Public Member Functions inherited from homeassistant.components.yamaha_musiccast.entity.MusicCastDeviceEntity
def	device_id (self)

DeviceInfo	device_info (self)

def	device_name (self)

Public Member Functions inherited from homeassistant.components.yamaha_musiccast.entity.MusicCastEntity
None	__init__ (self, *str name, str icon, MusicCastDataUpdateCoordinator coordinator, bool enabled_default=True)

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

None	async_update (self)

bool	available (self)

Public Member Functions inherited from homeassistant.components.yamaha_musiccast.coordinator.MusicCastDataUpdateCoordinator
None	__init__ (self, HomeAssistant hass, MusicCastDevice client)

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_media_play_pause (self)

None	async_media_seek (self, float position)

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

None	join_players (self, list[str] group_members)

str\|None	media_album_artist (self)

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

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)

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

	source_id

	state

Public Attributes inherited from homeassistant.components.yamaha_musiccast.coordinator.MusicCastDataUpdateCoordinator
	musiccast

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
def	_is_netusb (self)

def	_is_tuner (self)

Private Attributes
	_cur_track

	_player_state

	_repeat

	_shuffle

	_volume_max

	_volume_min

	_volume_muted

	_zone_id

Static Private Attributes
	_attr_media_content_type = MediaType.MUSIC

bool	_attr_should_poll = False

Additional Inherited Members
Static Public Attributes inherited from homeassistant.components.yamaha_musiccast.entity.MusicCastDeviceEntity
	str

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

The musiccast media player.

Definition at line 77 of file media_player.py.

Constructor & Destructor Documentation

◆ init()

def homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.__init__	(	self,
		zone_id,
		name,
		entry_id,
		coordinator
	)

Initialize the musiccast device.

Definition at line 83 of file media_player.py.

Member Function Documentation

◆ _is_netusb()

def homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer._is_netusb ( self )

private

Definition at line 134 of file media_player.py.

◆ _is_tuner()

def homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer._is_tuner ( self )

private

Definition at line 138 of file media_player.py.

◆ async_added_to_hass()

None homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.async_added_to_hass ( self )

Run when this Entity has been added to HA.

Reimplemented from homeassistant.components.yamaha_musiccast.entity.MusicCastDeviceEntity.

Definition at line 102 of file media_player.py.

◆ async_browse_media()

def homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.async_browse_media	(	self,
		media_content_type = `None`,
		media_content_id = `None`
	)

Implement the websocket media browsing helper.

Definition at line 327 of file media_player.py.

◆ async_check_client_list()

def homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.async_check_client_list ( self )

Let the server check if all its clients are still part of his group.

Definition at line 897 of file media_player.py.

◆ async_client_join()

bool homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.async_client_join	(	self,
		group_id,
		server
	)

Let the client join a group.

If this client is a server, the server will stop distributing.
If the client is part of a different group,
it will leave that group first. Returns True, if the server has to
add the client on his side.

Definition at line 794 of file media_player.py.

◆ async_client_leave_group()

def homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.async_client_leave_group	(	self,
		force = `False`
	)

Make self leave the group.

Should only be called for clients.

Definition at line 857 of file media_player.py.

◆ async_join_players()

None homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.async_join_players	(		self,
		list[str]	group_members
	)

Add all clients given in entities to the group of the server.

Creates a new group if necessary. Used for join service.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 708 of file media_player.py.

◆ async_media_next_track()

None homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.async_media_next_track ( self )

Send next track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 488 of file media_player.py.

◆ async_media_pause()

None homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.async_media_pause ( self )

Send pause command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 258 of file media_player.py.

◆ async_media_play()

None homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.async_media_play ( self )

Send play command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 249 of file media_player.py.

◆ async_media_previous_track()

None homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.async_media_previous_track ( self )

Send previous track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 476 of file media_player.py.

◆ async_media_stop()

None homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.async_media_stop ( self )

Send stop command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 267 of file media_player.py.

◆ async_mute_volume()

None homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.async_mute_volume	(		self,
		bool	mute
	)

Mute the volume.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 230 of file media_player.py.

◆ async_play_media()

None homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.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 285 of file media_player.py.

◆ async_schedule_check_client_list()

def homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.async_schedule_check_client_list ( self )

Schedule async_check_client_list.

Definition at line 927 of file media_player.py.

◆ async_select_sound_mode()

None homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.async_select_sound_mode	(		self,
		str	sound_mode
	)

Select sound mode.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 399 of file media_player.py.

◆ async_select_source()

None homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.async_select_source	(		self,
		str	source
	)

Select input source.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 510 of file media_player.py.

◆ async_server_close_group()

def homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.async_server_close_group ( self )

Close group of self.

Should only be called for servers.

Definition at line 886 of file media_player.py.

◆ async_set_repeat()

None homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.async_set_repeat	(		self,
		RepeatMode	repeat
	)

Enable/disable repeat mode.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 499 of file media_player.py.

◆ async_set_shuffle()

None homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.async_set_shuffle	(		self,
		bool	shuffle
	)

Enable/disable shuffle mode.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 276 of file media_player.py.

◆ async_set_volume_level()

None homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.async_set_volume_level	(		self,
		float	volume
	)

Set the volume level, range 0..1.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 236 of file media_player.py.

◆ async_turn_off()

None homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.async_turn_off ( self )

Turn the media player off.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 225 of file media_player.py.

◆ async_turn_on()

None homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.async_turn_on ( self )

Turn the media player on.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 220 of file media_player.py.

◆ async_unjoin_player()

None homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.async_unjoin_player ( self )

Leave the group.

Stops the distribution if device is server. Used for unjoin service.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 778 of file media_player.py.

◆ async_volume_down()

None homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.async_volume_down ( self )

Turn volume down for media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 245 of file media_player.py.

◆ async_volume_up()

None homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.async_volume_up ( self )

Turn volume up for media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 241 of file media_player.py.

◆ async_will_remove_from_hass()

None homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.async_will_remove_from_hass ( self )

Entity being removed from hass.

Reimplemented from homeassistant.components.yamaha_musiccast.entity.MusicCastDeviceEntity.

Definition at line 114 of file media_player.py.

◆ get_all_mc_entities()

list[MusicCastMediaPlayer] homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.get_all_mc_entities ( self )

Return all media player entities of the musiccast system.

Definition at line 613 of file media_player.py.

◆ get_all_server_entities()

list[MusicCastMediaPlayer] homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.get_all_server_entities ( self )

Return all media player entities in the musiccast system, which are in server mode.

Definition at line 624 of file media_player.py.

◆ get_distribution_num()

int homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.get_distribution_num ( self )

Return the distribution_num (number of clients in the whole musiccast system).

Definition at line 629 of file media_player.py.

◆ group_members()

list[str] | None homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.group_members ( self )

Return a list of entity_ids, which belong to the group of self.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 661 of file media_player.py.

◆ group_server()

def homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.group_server ( self )

Return the server of the own group if present, self else.

Definition at line 653 of file media_player.py.

◆ ip_address()

def homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.ip_address ( self )

Return the ip address of the musiccast device.

Definition at line 124 of file media_player.py.

◆ is_client()

bool homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.is_client ( self )

Return whether the media player is the client of a group.

If the media player is not part of a group, False is returned.

Definition at line 606 of file media_player.py.

◆ is_network_client()

bool homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.is_network_client ( self )

Return True if the current entity is a network client and not just a main syncing entity.

Definition at line 597 of file media_player.py.

◆ is_network_server()

bool homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.is_network_server ( self )

Return only true if the current entity is a network server and not a main zone with an attached zone2.

Definition at line 561 of file media_player.py.

◆ is_part_of_group()

bool homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.is_part_of_group	(	self,
		group_server
	)

Return True if the given server is the server of self's group.

Definition at line 636 of file media_player.py.

◆ is_server()

bool homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.is_server ( self )

Return whether the media player is the server/host of the group.

If the media player is not part of a group, False is returned.

Definition at line 579 of file media_player.py.

◆ is_volume_muted()

def homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.is_volume_muted ( self )

Return boolean if volume is currently muted.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 187 of file media_player.py.

◆ media_album_name()

def homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.media_album_name ( self )

Return the album of current playing media (Music track only).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 431 of file media_player.py.

◆ media_artist()

def homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.media_artist ( self )

Return the artist of current playing media (Music track only).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 421 of file media_player.py.

◆ media_content_id()

def homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.media_content_id ( self )

Return the content ID of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 142 of file media_player.py.

◆ media_duration()

def homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.media_duration ( self )

Duration of current playing media in seconds.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 532 of file media_player.py.

◆ media_image_url()

def homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.media_image_url ( self )

Return the image url of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 404 of file media_player.py.

◆ media_position()

def homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.media_position ( self )

Position of current playing media in seconds.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 540 of file media_player.py.

◆ media_position_updated_at()

def homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.media_position_updated_at ( self )

When was the position of the current playing media valid.

Returns value from homeassistant.util.dt.utcnow().

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 548 of file media_player.py.

◆ media_title()

def homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.media_title ( self )

Return the title of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 411 of file media_player.py.

◆ musiccast_group()

list[MusicCastMediaPlayer] homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.musiccast_group ( self )

Return all media players of the current group, if the media player is server.

Definition at line 666 of file media_player.py.

◆ musiccast_zone_entity()

MusicCastMediaPlayer homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.musiccast_zone_entity ( self )

Return the entity of the zone, which is using MusicCast at the moment, if there is one, self else.

It is possible that multiple zones use MusicCast as client at the same time. In this case the first one is
returned.

Definition at line 681 of file media_player.py.

◆ other_zones()

list[MusicCastMediaPlayer] homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.other_zones ( self )

Return media player entities of the other zones of this device.

Definition at line 570 of file media_player.py.

◆ repeat()

def homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.repeat ( self )

Return current repeat mode.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 436 of file media_player.py.

◆ reverse_source_mapping()

def homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.reverse_source_mapping ( self )

Return a mapping from the source label to the source name.

Definition at line 174 of file media_player.py.

◆ shuffle()

def homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.shuffle ( self )

Boolean if shuffling is enabled.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 194 of file media_player.py.

◆ sound_mode()

def homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.sound_mode ( self )

Return the current sound mode.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 201 of file media_player.py.

◆ sound_mode_list()

def homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.sound_mode_list ( self )

Return a list of available sound modes.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 206 of file media_player.py.

◆ source()

def homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.source ( self )

Name of the current input source.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 522 of file media_player.py.

◆ source_id()

def homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.source_id ( self )

ID of the current input source.

Definition at line 517 of file media_player.py.

◆ source_list()

def homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.source_list ( self )

List of available input sources.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 527 of file media_player.py.

◆ source_mapping()

def homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.source_mapping ( self )

Return a mapping of the actual source names to their labels configured in the MusicCast App.

Definition at line 158 of file media_player.py.

◆ state()

MediaPlayerState homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.state ( self )

Return the state of the player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 147 of file media_player.py.

◆ supported_features()

MediaPlayerEntityFeature homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.supported_features ( self )

Flag media player features that are supported.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 445 of file media_player.py.

◆ unique_id()

str homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.unique_id ( self )

Return the unique ID for this media_player.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 216 of file media_player.py.

◆ update_all_mc_entities()

def homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.update_all_mc_entities	(	self,
		check_clients = `False`
	)

Update the whole musiccast system when group data change.

Definition at line 693 of file media_player.py.

◆ volume_level()

def homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.volume_level ( self )

Return the volume level of the media player (0..1).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 179 of file media_player.py.

◆ zone()

def homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.zone ( self )

Return the zone of the media player.

Definition at line 211 of file media_player.py.

◆ zone_id()

def homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.zone_id ( self )

Return the zone id of the musiccast device.

Definition at line 129 of file media_player.py.

Member Data Documentation

◆ _attr_media_content_type

homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer._attr_media_content_type = MediaType.MUSIC

staticprivate

Definition at line 80 of file media_player.py.

◆ _attr_should_poll

bool homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer._attr_should_poll = False

staticprivate

Definition at line 81 of file media_player.py.

◆ _cur_track

homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer._cur_track

private

Definition at line 99 of file media_player.py.

◆ _player_state

homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer._player_state

private

Definition at line 85 of file media_player.py.

◆ _repeat

homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer._repeat

private

Definition at line 100 of file media_player.py.

◆ _shuffle

homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer._shuffle

private

Definition at line 87 of file media_player.py.

◆ _volume_max

homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer._volume_max

private

Definition at line 97 of file media_player.py.

◆ _volume_min

homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer._volume_min

private

Definition at line 96 of file media_player.py.

◆ _volume_muted

homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer._volume_muted

private

Definition at line 86 of file media_player.py.

◆ _zone_id

homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer._zone_id

private

Definition at line 88 of file media_player.py.

◆ ip_address

homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.ip_address

Definition at line 647 of file media_player.py.

◆ source_id

homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.source_id

Definition at line 139 of file media_player.py.

◆ state

homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer.state

Definition at line 295 of file media_player.py.

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

core/homeassistant/components/yamaha_musiccast/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

◆ _is_netusb()

◆ _is_tuner()

◆ async_added_to_hass()

◆ async_browse_media()

◆ async_check_client_list()

◆ async_client_join()

◆ async_client_leave_group()

◆ async_join_players()

◆ async_media_next_track()

◆ async_media_pause()

◆ async_media_play()

◆ async_media_previous_track()

◆ async_media_stop()

◆ async_mute_volume()

◆ async_play_media()

◆ async_schedule_check_client_list()

◆ async_select_sound_mode()

◆ async_select_source()

◆ async_server_close_group()

◆ async_set_repeat()

◆ async_set_shuffle()

◆ async_set_volume_level()

◆ async_turn_off()

◆ async_turn_on()

◆ async_unjoin_player()

◆ async_volume_down()

◆ async_volume_up()

◆ async_will_remove_from_hass()

◆ get_all_mc_entities()

◆ get_all_server_entities()

◆ get_distribution_num()

◆ group_members()

◆ group_server()

◆ ip_address()

◆ is_client()

◆ is_network_client()

◆ is_network_server()

◆ is_part_of_group()

◆ is_server()

◆ is_volume_muted()

◆ media_album_name()

◆ media_artist()

◆ media_content_id()

◆ media_duration()

◆ media_image_url()

◆ media_position()

◆ media_position_updated_at()

◆ media_title()

◆ musiccast_group()

◆ musiccast_zone_entity()

◆ other_zones()

◆ repeat()

◆ reverse_source_mapping()

◆ shuffle()

◆ sound_mode()

◆ sound_mode_list()

◆ source()

◆ source_id()

◆ source_list()

◆ source_mapping()

◆ state()

◆ supported_features()

◆ unique_id()

◆ update_all_mc_entities()

◆ volume_level()

◆ zone()

◆ zone_id()

Member Data Documentation

◆ _attr_media_content_type

◆ _attr_should_poll

◆ init()