homeassistant.components.pioneer.media_player.PioneerDevice Class Reference

Inheritance diagram for homeassistant.components.pioneer.media_player.PioneerDevice:

Collaboration diagram for homeassistant.components.pioneer.media_player.PioneerDevice:

Public Member Functions
def	__init__ (self, name, host, port, timeout, sources)
def	is_volume_muted (self)
def	media_title (self)
None	mute_volume (self, bool mute)
def	name (self)
None	select_source (self, str source)
None	set_volume_level (self, float volume)
def	source (self)
def	source_list (self)
MediaPlayerState|None	state (self)
def	telnet_command (self, command)
def	telnet_request (cls, telnet, command, expected_prefix)
None	turn_off (self)
None	turn_on (self)
def	update (self)
None	volume_down (self)
def	volume_level (self)
None	volume_up (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)
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)
int|None	media_track (self)
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	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)
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	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_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)

Private Attributes
	_host
	_muted
	_name
	_port
	_pwstate
	_selected_source
	_source_name_to_number
	_source_number_to_name
	_timeout
	_volume

Static Private Attributes
tuple	_attr_supported_features

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
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 Pioneer device.

Definition at line 66 of file media_player.py.

Constructor & Destructor Documentation

__init__()

def homeassistant.components.pioneer.media_player.PioneerDevice.__init__	(		self,
			name,
			host,
			port,
			timeout,
			sources
	)

Initialize the Pioneer device.

Definition at line 80 of file media_player.py.

Member Function Documentation

is_volume_muted()

def homeassistant.components.pioneer.media_player.PioneerDevice.is_volume_muted

(

self

)

Boolean if volume is currently muted.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 190 of file media_player.py.

media_title()

def homeassistant.components.pioneer.media_player.PioneerDevice.media_title

(

self

)

Title of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 205 of file media_player.py.

mute_volume()

None homeassistant.components.pioneer.media_player.PioneerDevice.mute_volume	(		self,
		bool	mute
	)

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

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 226 of file media_player.py.

name()

def homeassistant.components.pioneer.media_player.PioneerDevice.name

(

self

)

Return the name of the device.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 168 of file media_player.py.

select_source()

None homeassistant.components.pioneer.media_player.PioneerDevice.select_source	(		self,
		str	source
	)

Select input source.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 234 of file media_player.py.

set_volume_level()

None homeassistant.components.pioneer.media_player.PioneerDevice.set_volume_level	(		self,
		float	volume
	)

Set volume level, range 0..1.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 221 of file media_player.py.

source()

def homeassistant.components.pioneer.media_player.PioneerDevice.source

(

self

)

Return the current input source.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 195 of file media_player.py.

source_list()

def homeassistant.components.pioneer.media_player.PioneerDevice.source_list

(

self

)

List of available input sources.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 200 of file media_player.py.

state()

MediaPlayerState | None homeassistant.components.pioneer.media_player.PioneerDevice.state

(

self

)

Return the state of the device.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 173 of file media_player.py.

telnet_command()

def homeassistant.components.pioneer.media_player.PioneerDevice.telnet_command	(		self,
			command
	)

Establish a telnet connection and sends command.

Definition at line 111 of file media_player.py.

telnet_request()

def homeassistant.components.pioneer.media_player.PioneerDevice.telnet_request	(		cls,
			telnet,
			command,
			expected_prefix
	)

Execute `command` and return the response.

Definition at line 94 of file media_player.py.

turn_off()

None homeassistant.components.pioneer.media_player.PioneerDevice.turn_off

(

self

)

Turn off media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 209 of file media_player.py.

turn_on()

None homeassistant.components.pioneer.media_player.PioneerDevice.turn_on

(

self

)

Turn the media player on.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 230 of file media_player.py.

update()

def homeassistant.components.pioneer.media_player.PioneerDevice.update

(

self

)

Get the latest details from the device.

Definition at line 125 of file media_player.py.

volume_down()

None homeassistant.components.pioneer.media_player.PioneerDevice.volume_down

(

self

)

Volume down media player.

Definition at line 217 of file media_player.py.

volume_level()

def homeassistant.components.pioneer.media_player.PioneerDevice.volume_level

(

self

)

Volume level of the media player (0..1).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 185 of file media_player.py.

volume_up()

None homeassistant.components.pioneer.media_player.PioneerDevice.volume_up

(

self

)

Volume up media player.

Definition at line 213 of file media_player.py.

Member Data Documentation

_attr_supported_features

tuple homeassistant.components.pioneer.media_player.PioneerDevice._attr_supported_features

staticprivate

Initial value:

=  (
        MediaPlayerEntityFeature.PAUSE
        | MediaPlayerEntityFeature.VOLUME_SET
        | MediaPlayerEntityFeature.VOLUME_STEP
        | MediaPlayerEntityFeature.VOLUME_MUTE
        | MediaPlayerEntityFeature.TURN_ON
        | MediaPlayerEntityFeature.TURN_OFF
        | MediaPlayerEntityFeature.SELECT_SOURCE
        | MediaPlayerEntityFeature.PLAY
    )

Definition at line 69 of file media_player.py.

_host

homeassistant.components.pioneer.media_player.PioneerDevice._host

private

Definition at line 83 of file media_player.py.

_muted

homeassistant.components.pioneer.media_player.PioneerDevice._muted

private

Definition at line 88 of file media_player.py.

_name

homeassistant.components.pioneer.media_player.PioneerDevice._name

private

Definition at line 82 of file media_player.py.

_port

homeassistant.components.pioneer.media_player.PioneerDevice._port

private

Definition at line 84 of file media_player.py.

_pwstate

homeassistant.components.pioneer.media_player.PioneerDevice._pwstate

private

Definition at line 86 of file media_player.py.

_selected_source

homeassistant.components.pioneer.media_player.PioneerDevice._selected_source

private

Definition at line 89 of file media_player.py.

_source_name_to_number

homeassistant.components.pioneer.media_player.PioneerDevice._source_name_to_number

private

Definition at line 90 of file media_player.py.

_source_number_to_name

homeassistant.components.pioneer.media_player.PioneerDevice._source_number_to_name

private

Definition at line 91 of file media_player.py.

_timeout

homeassistant.components.pioneer.media_player.PioneerDevice._timeout

private

Definition at line 85 of file media_player.py.

_volume

homeassistant.components.pioneer.media_player.PioneerDevice._volume

private

Definition at line 87 of file media_player.py.

---

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

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