Inheritance diagram for homeassistant.components.yamaha.media_player.YamahaDeviceZone:

Collaboration diagram for homeassistant.components.yamaha.media_player.YamahaDeviceZone:

Public Member Functions
None	__init__ (self, str name, RXV zctrl, list[str]\|None source_ignore, dict[str, str]\|None source_names, dict[str, str]\|None zone_names)

None	build_source_list (self)

None	enable_output (self, str port, bool enabled)

str\|None	media_album_name (self)

str\|None	media_artist (self)

MediaType\|None	media_content_type (self)

None	media_next_track (self)

None	media_pause (self)

None	media_play (self)

None	media_previous_track (self)

None	media_stop (self)

str\|None	media_title (self)

None	menu_cursor (self, str cursor)

None	mute_volume (self, bool mute)

str	name (self)

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_scene (self, str scene)

None	set_volume_level (self, float volume)

MediaPlayerEntityFeature	supported_features (self)

None	turn_off (self)

None	turn_on (self)

None	update (self)

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

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

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

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

int\|None	media_track (self)

RepeatMode\|str\|None	repeat (self)

None	set_repeat (self, RepeatMode repeat)

None	set_shuffle (self, bool shuffle)

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_compat (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)

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)

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
	zctrl

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	_call_playback_function (self, function, function_text)

Private Attributes
	_attr_available

	_attr_is_volume_muted

	_attr_sound_mode

	_attr_sound_mode_list

	_attr_source

	_attr_source_list

	_attr_state

	_attr_unique_id

	_attr_volume_level

	_is_playback_supported

	_name

	_play_status

	_playback_support

	_reverse_mapping

	_zone

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 Yamaha device zone.

Definition at line 208 of file media_player.py.

Constructor & Destructor Documentation

◆ init()

None homeassistant.components.yamaha.media_player.YamahaDeviceZone.__init__	(		self,
		str	name,
		RXV	zctrl,
		list[str] \| None	source_ignore,
		dict[str, str] \| None	source_names,
		dict[str, str] \| None	zone_names
	)

Initialize the Yamaha Receiver.

Definition at line 213 of file media_player.py.

Member Function Documentation

◆ _call_playback_function()

def homeassistant.components.yamaha.media_player.YamahaDeviceZone._call_playback_function	(	self,
		function,
		function_text
	)

private

Definition at line 366 of file media_player.py.

◆ build_source_list()

None homeassistant.components.yamaha.media_player.YamahaDeviceZone.build_source_list ( self )

Build the source list.

Definition at line 280 of file media_player.py.

◆ enable_output()

None homeassistant.components.yamaha.media_player.YamahaDeviceZone.enable_output	(		self,
		str	port,
		bool	enabled
	)

Enable or disable an output port..

Definition at line 400 of file media_player.py.

◆ media_album_name()

str | None homeassistant.components.yamaha.media_player.YamahaDeviceZone.media_album_name ( self )

Album of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 427 of file media_player.py.

◆ media_artist()

str | None homeassistant.components.yamaha.media_player.YamahaDeviceZone.media_artist ( self )

Artist of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 420 of file media_player.py.

◆ media_content_type()

MediaType | None homeassistant.components.yamaha.media_player.YamahaDeviceZone.media_content_type ( self )

Content type of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 434 of file media_player.py.

◆ media_next_track()

None homeassistant.components.yamaha.media_player.YamahaDeviceZone.media_next_track ( self )

Send next track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 362 of file media_player.py.

◆ media_pause()

None homeassistant.components.yamaha.media_player.YamahaDeviceZone.media_pause ( self )

Send pause command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 350 of file media_player.py.

◆ media_play()

None homeassistant.components.yamaha.media_player.YamahaDeviceZone.media_play ( self )

Send play command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 346 of file media_player.py.

◆ media_previous_track()

None homeassistant.components.yamaha.media_player.YamahaDeviceZone.media_previous_track ( self )

Send previous track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 358 of file media_player.py.

◆ media_stop()

None homeassistant.components.yamaha.media_player.YamahaDeviceZone.media_stop ( self )

Send stop command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 354 of file media_player.py.

◆ media_title()

str | None homeassistant.components.yamaha.media_player.YamahaDeviceZone.media_title ( self )

Artist of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 442 of file media_player.py.

◆ menu_cursor()

None homeassistant.components.yamaha.media_player.YamahaDeviceZone.menu_cursor	(		self,
		str	cursor
	)

Press a menu cursor button.

Definition at line 404 of file media_player.py.

◆ mute_volume()

None homeassistant.components.yamaha.media_player.YamahaDeviceZone.mute_volume	(		self,
		bool	mute
	)

Mute (true) or unmute (false) media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 337 of file media_player.py.

◆ name()

str homeassistant.components.yamaha.media_player.YamahaDeviceZone.name ( self )

Return the name of the device.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 293 of file media_player.py.

◆ play_media()

None homeassistant.components.yamaha.media_player.YamahaDeviceZone.play_media	(		self,
		MediaType \| str	media_type,
		str	media_id,
		**Any	kwargs
	)

Play media from an ID.

This exposes a pass through for various input sources in the
Yamaha to direct play certain kinds of media. media_type is
treated as the input type that we are setting, and media id is
specific to it.
For the NET RADIO mediatype the format for ``media_id`` is a
"path" in your vtuner hierarchy. For instance:
``Bookmarks>Internet>Radio Paradise``. The separators are
``>`` and the parts of this are navigated by name behind the
scenes. There is a looping construct built into the yamaha
library to do this with a fallback timeout if the vtuner
service is unresponsive.
NOTE: this might take a while, because the only API interface
for setting the net radio station emulates button pressing and
navigating through the net radio menu hierarchy. And each sub
menu must be fetched by the receiver from the vtuner service.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 376 of file media_player.py.

◆ select_sound_mode()

None homeassistant.components.yamaha.media_player.YamahaDeviceZone.select_sound_mode	(		self,
		str	sound_mode
	)

Set Sound Mode for Receiver..

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 415 of file media_player.py.

◆ select_source()

None homeassistant.components.yamaha.media_player.YamahaDeviceZone.select_source	(		self,
		str	source
	)

Select input source.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 372 of file media_player.py.

◆ set_scene()

None homeassistant.components.yamaha.media_player.YamahaDeviceZone.set_scene	(		self,
		str	scene
	)

Set the current scene.

Definition at line 408 of file media_player.py.

◆ set_volume_level()

None homeassistant.components.yamaha.media_player.YamahaDeviceZone.set_volume_level	(		self,
		float	volume
	)

Set volume level, range 0..1.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 331 of file media_player.py.

◆ supported_features()

MediaPlayerEntityFeature homeassistant.components.yamaha.media_player.YamahaDeviceZone.supported_features ( self )

Flag media player features that are supported.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 308 of file media_player.py.

◆ turn_off()

None homeassistant.components.yamaha.media_player.YamahaDeviceZone.turn_off ( self )

Turn off media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 327 of file media_player.py.

◆ turn_on()

None homeassistant.components.yamaha.media_player.YamahaDeviceZone.turn_on ( self )

Turn the media player on.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 341 of file media_player.py.

◆ update()

None homeassistant.components.yamaha.media_player.YamahaDeviceZone.update ( self )

Get the latest details from the device.

Definition at line 240 of file media_player.py.

◆ zone_id()

str homeassistant.components.yamaha.media_player.YamahaDeviceZone.zone_id ( self )

Return a zone_id to ensure 1 media player per zone.

Definition at line 303 of file media_player.py.

Member Data Documentation

◆ _attr_available

homeassistant.components.yamaha.media_player.YamahaDeviceZone._attr_available

private

Definition at line 246 of file media_player.py.

◆ _attr_is_volume_muted

homeassistant.components.yamaha.media_player.YamahaDeviceZone._attr_is_volume_muted

private

Definition at line 223 of file media_player.py.

◆ _attr_sound_mode

homeassistant.components.yamaha.media_player.YamahaDeviceZone._attr_sound_mode

private

Definition at line 274 of file media_player.py.

◆ _attr_sound_mode_list

homeassistant.components.yamaha.media_player.YamahaDeviceZone._attr_sound_mode_list

private

Definition at line 275 of file media_player.py.

◆ _attr_source

homeassistant.components.yamaha.media_player.YamahaDeviceZone._attr_source

private

Definition at line 267 of file media_player.py.

◆ _attr_source_list

homeassistant.components.yamaha.media_player.YamahaDeviceZone._attr_source_list

private

Definition at line 286 of file media_player.py.

◆ _attr_state

homeassistant.components.yamaha.media_player.YamahaDeviceZone._attr_state

private

Definition at line 225 of file media_player.py.

◆ _attr_unique_id

homeassistant.components.yamaha.media_player.YamahaDeviceZone._attr_unique_id

private

Definition at line 238 of file media_player.py.

◆ _attr_volume_level

homeassistant.components.yamaha.media_player.YamahaDeviceZone._attr_volume_level

private

Definition at line 224 of file media_player.py.

◆ _is_playback_supported

homeassistant.components.yamaha.media_player.YamahaDeviceZone._is_playback_supported

private

Definition at line 230 of file media_player.py.

◆ _name

homeassistant.components.yamaha.media_player.YamahaDeviceZone._name

private

Definition at line 232 of file media_player.py.

◆ _play_status

homeassistant.components.yamaha.media_player.YamahaDeviceZone._play_status

private

Definition at line 231 of file media_player.py.

◆ _playback_support

homeassistant.components.yamaha.media_player.YamahaDeviceZone._playback_support

private

Definition at line 229 of file media_player.py.

◆ _reverse_mapping

homeassistant.components.yamaha.media_player.YamahaDeviceZone._reverse_mapping

private

Definition at line 282 of file media_player.py.

◆ _zone

homeassistant.components.yamaha.media_player.YamahaDeviceZone._zone

private

Definition at line 233 of file media_player.py.

◆ zctrl

homeassistant.components.yamaha.media_player.YamahaDeviceZone.zctrl

Definition at line 222 of file media_player.py.

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

core/homeassistant/components/yamaha/media_player.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _call_playback_function()

◆ build_source_list()

◆ enable_output()

◆ media_album_name()

◆ media_artist()

◆ media_content_type()

◆ media_next_track()

◆ media_pause()

◆ media_play()

◆ media_previous_track()

◆ media_stop()

◆ media_title()

◆ menu_cursor()

◆ mute_volume()

◆ name()

◆ play_media()

◆ select_sound_mode()

◆ select_source()

◆ set_scene()

◆ set_volume_level()

◆ supported_features()

◆ turn_off()

◆ turn_on()

◆ update()

◆ zone_id()

Member Data Documentation

◆ _attr_available

◆ _attr_is_volume_muted

◆ _attr_sound_mode

◆ _attr_sound_mode_list

◆ _attr_source

◆ _attr_source_list

◆ _attr_state

◆ _attr_unique_id

◆ _attr_volume_level

◆ _is_playback_supported

◆ _name

◆ _play_status

◆ _playback_support

◆ _reverse_mapping

◆ _zone

◆ zctrl

◆ init()