homeassistant.components.onkyo.media_player.OnkyoMediaPlayer Class Reference

Inheritance diagram for homeassistant.components.onkyo.media_player.OnkyoMediaPlayer:

Collaboration diagram for homeassistant.components.onkyo.media_player.OnkyoMediaPlayer:

Public Member Functions
None	__init__ (self, Receiver receiver, str zone, *VolumeResolution volume_resolution, float max_volume, dict[InputSource, str] sources)
None	async_added_to_hass (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_output (self, str hdmi_output)
None	async_select_source (self, str source)
None	async_set_volume_level (self, float volume)
None	async_turn_off (self)
None	async_turn_on (self)
None	async_volume_down (self)
None	async_volume_up (self)
None	async_will_remove_from_hass (self)
None	backfill_state (self)
None	process_update (self, tuple[str, str, Any] update)
MediaPlayerEntityFeature	supported_features (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_select_sound_mode (self, str sound_mode)
None	async_set_repeat (self, RepeatMode repeat)
None	async_set_shuffle (self, bool shuffle)
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_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)
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_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_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	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)

Static Public Attributes
	bool
	None
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

Private Member Functions
None	_parse_audio_information (self, tuple[str]|Literal["N/A"] audio_information)
None	_parse_source (self, InputLibValue source_lib)
None	_parse_video_information (self, tuple[str]|Literal["N/A"] video_information)
None	_query_av_info_delayed (self)
None	_query_receiver (self, str propname)
None	_update_receiver (self, str propname, Any value)

Private Attributes
	_attr_extra_state_attributes
	_attr_is_volume_muted
	_attr_name
	_attr_source
	_attr_source_list
	_attr_state
	_attr_unique_id
	_attr_volume_level
	_lib_mapping
	_max_volume
	_name_mapping
	_query_timer
	_receiver
	_reverse_lib_mapping
	_reverse_name_mapping
	_supports_audio_info
	_supports_video_info
	_supports_volume
	_volume_resolution
	_zone

Static Private Attributes
bool	_attr_should_poll = False

Additional Inherited Members
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

Detailed Description

Representation of an Onkyo Receiver Media Player (one per each zone).

Definition at line 323 of file media_player.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.onkyo.media_player.OnkyoMediaPlayer.__init__	(		self,
		Receiver	receiver,
		str	zone,
		*VolumeResolution	volume_resolution,
		float	max_volume,
		dict[InputSource, str]	sources
	)

Initialize the Onkyo Receiver.

Definition at line 333 of file media_player.py.

Member Function Documentation

_parse_audio_information()

None homeassistant.components.onkyo.media_player.OnkyoMediaPlayer._parse_audio_information (   self, tuple[str] | Literal["N/A"]   audio_information  )

private

Definition at line 534 of file media_player.py.

_parse_source()

None homeassistant.components.onkyo.media_player.OnkyoMediaPlayer._parse_source (   self, InputLibValue  source_lib  )

private

Definition at line 521 of file media_player.py.

_parse_video_information()

None homeassistant.components.onkyo.media_player.OnkyoMediaPlayer._parse_video_information (   self, tuple[str] | Literal["N/A"]   video_information  )

private

Definition at line 552 of file media_player.py.

_query_av_info_delayed()

None homeassistant.components.onkyo.media_player.OnkyoMediaPlayer._query_av_info_delayed (   self )

private

Definition at line 569 of file media_player.py.

_query_receiver()

None homeassistant.components.onkyo.media_player.OnkyoMediaPlayer._query_receiver (   self, str  propname  )

private

Cause the receiver to send an update about a property.

Definition at line 387 of file media_player.py.

_update_receiver()

None homeassistant.components.onkyo.media_player.OnkyoMediaPlayer._update_receiver (   self, str  propname, Any  value  )

private

Update a property in the receiver.

Definition at line 382 of file media_player.py.

async_added_to_hass()

None homeassistant.components.onkyo.media_player.OnkyoMediaPlayer.async_added_to_hass

(

self

)

Entity has been added to hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 364 of file media_player.py.

async_mute_volume()

None homeassistant.components.onkyo.media_player.OnkyoMediaPlayer.async_mute_volume	(		self,
		bool	mute
	)

Mute the volume.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 421 of file media_player.py.

async_play_media()

None homeassistant.components.onkyo.media_player.OnkyoMediaPlayer.async_play_media	(		self,
		MediaType | str	media_type,
		str	media_id,
		**Any	kwargs
	)

Play radio station by preset number.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 444 of file media_player.py.

async_select_output()

None homeassistant.components.onkyo.media_player.OnkyoMediaPlayer.async_select_output	(		self,
		str	hdmi_output
	)

Set hdmi-out.

Definition at line 440 of file media_player.py.

async_select_source()

None homeassistant.components.onkyo.media_player.OnkyoMediaPlayer.async_select_source	(		self,
		str	source
	)

Select input source.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 428 of file media_player.py.

async_set_volume_level()

None homeassistant.components.onkyo.media_player.OnkyoMediaPlayer.async_set_volume_level	(		self,
		float	volume
	)

Set volume level, range 0..1.

However full volume on the amp is usually far too loud so allow the user to
specify the upper range with CONF_MAX_VOLUME. We change as per max_volume
set by user. This means that if max volume is 80 then full volume in HA
will give 80% volume on the receiver. Then we convert that to the correct
scale for the receiver.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 399 of file media_player.py.

async_turn_off()

None homeassistant.components.onkyo.media_player.OnkyoMediaPlayer.async_turn_off

(

self

)

Turn the media player off.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 395 of file media_player.py.

async_turn_on()

None homeassistant.components.onkyo.media_player.OnkyoMediaPlayer.async_turn_on

(

self

)

Turn the media player on.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 391 of file media_player.py.

async_volume_down()

None homeassistant.components.onkyo.media_player.OnkyoMediaPlayer.async_volume_down

(

self

)

Decrease volume by 1 step.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 417 of file media_player.py.

async_volume_up()

None homeassistant.components.onkyo.media_player.OnkyoMediaPlayer.async_volume_up

(

self

)

Increase volume by 1 step.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 413 of file media_player.py.

async_will_remove_from_hass()

None homeassistant.components.onkyo.media_player.OnkyoMediaPlayer.async_will_remove_from_hass

(

self

)

Cancel the query timer when the entity is removed.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 368 of file media_player.py.

backfill_state()

None homeassistant.components.onkyo.media_player.OnkyoMediaPlayer.backfill_state

(

self

)

Get the receiver to send all the info we care about.

Usually run only on connect, as we can otherwise rely on the
receiver to keep us informed of changes.

Definition at line 454 of file media_player.py.

process_update()

None homeassistant.components.onkyo.media_player.OnkyoMediaPlayer.process_update	(		self,
		tuple[str, str, Any]	update
	)

Store relevant updates so they can be queried later.

Definition at line 475 of file media_player.py.

supported_features()

MediaPlayerEntityFeature homeassistant.components.onkyo.media_player.OnkyoMediaPlayer.supported_features

(

self

)

Return media player features that are supported.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 375 of file media_player.py.

Member Data Documentation

_attr_extra_state_attributes

homeassistant.components.onkyo.media_player.OnkyoMediaPlayer._attr_extra_state_attributes

private

Definition at line 362 of file media_player.py.

_attr_is_volume_muted

homeassistant.components.onkyo.media_player.OnkyoMediaPlayer._attr_is_volume_muted

private

Definition at line 498 of file media_player.py.

_attr_name

homeassistant.components.onkyo.media_player.OnkyoMediaPlayer._attr_name

private

Definition at line 346 of file media_player.py.

_attr_should_poll

bool homeassistant.components.onkyo.media_player.OnkyoMediaPlayer._attr_should_poll = False

staticprivate

Definition at line 326 of file media_player.py.

_attr_source

homeassistant.components.onkyo.media_player.OnkyoMediaPlayer._attr_source

private

Definition at line 524 of file media_player.py.

_attr_source_list

homeassistant.components.onkyo.media_player.OnkyoMediaPlayer._attr_source_list

private

Definition at line 361 of file media_player.py.

_attr_state

homeassistant.components.onkyo.media_player.OnkyoMediaPlayer._attr_state

private

Definition at line 483 of file media_player.py.

_attr_unique_id

homeassistant.components.onkyo.media_player.OnkyoMediaPlayer._attr_unique_id

private

Definition at line 347 of file media_player.py.

_attr_volume_level

homeassistant.components.onkyo.media_player.OnkyoMediaPlayer._attr_volume_level

private

Definition at line 496 of file media_player.py.

_lib_mapping

homeassistant.components.onkyo.media_player.OnkyoMediaPlayer._lib_mapping

private

Definition at line 356 of file media_player.py.

_max_volume

homeassistant.components.onkyo.media_player.OnkyoMediaPlayer._max_volume

private

Definition at line 352 of file media_player.py.

_name_mapping

homeassistant.components.onkyo.media_player.OnkyoMediaPlayer._name_mapping

private

Definition at line 354 of file media_player.py.

_query_timer

homeassistant.components.onkyo.media_player.OnkyoMediaPlayer._query_timer

private

Definition at line 372 of file media_player.py.

_receiver

homeassistant.components.onkyo.media_player.OnkyoMediaPlayer._receiver

private

Definition at line 343 of file media_player.py.

_reverse_lib_mapping

homeassistant.components.onkyo.media_player.OnkyoMediaPlayer._reverse_lib_mapping

private

Definition at line 357 of file media_player.py.

_reverse_name_mapping

homeassistant.components.onkyo.media_player.OnkyoMediaPlayer._reverse_name_mapping

private

Definition at line 355 of file media_player.py.

_supports_audio_info

homeassistant.components.onkyo.media_player.OnkyoMediaPlayer._supports_audio_info

private

Definition at line 510 of file media_player.py.

_supports_video_info

homeassistant.components.onkyo.media_player.OnkyoMediaPlayer._supports_video_info

private

Definition at line 513 of file media_player.py.

_supports_volume

homeassistant.components.onkyo.media_player.OnkyoMediaPlayer._supports_volume

private

Definition at line 491 of file media_player.py.

_volume_resolution

homeassistant.components.onkyo.media_player.OnkyoMediaPlayer._volume_resolution

private

Definition at line 351 of file media_player.py.

_zone

homeassistant.components.onkyo.media_player.OnkyoMediaPlayer._zone

private

Definition at line 349 of file media_player.py.

bool

homeassistant.components.onkyo.media_player.OnkyoMediaPlayer.bool

static

Definition at line 328 of file media_player.py.

None

homeassistant.components.onkyo.media_player.OnkyoMediaPlayer.None

static

Definition at line 331 of file media_player.py.

---

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

• core/homeassistant/components/onkyo/media_player.py