homeassistant.components.snapcast.media_player.SnapcastClientDevice Class Reference

Inheritance diagram for homeassistant.components.snapcast.media_player.SnapcastClientDevice:

Collaboration diagram for homeassistant.components.snapcast.media_player.SnapcastClientDevice:

Public Member Functions
def	__init__ (self, client, uid_part, entry_id)
None	async_added_to_hass (self)
def	async_join (self, master)
None	async_mute_volume (self, bool mute)
def	async_restore (self)
None	async_select_source (self, str source)
def	async_set_latency (self, latency)
None	async_set_volume_level (self, float volume)
def	async_unjoin (self)
None	async_will_remove_from_hass (self)
def	extra_state_attributes (self)
def	identifier (self)
def	is_volume_muted (self)
def	latency (self)
def	name (self)
None	set_availability (self, bool available)
def	snapshot (self)
def	source (self)
def	source_list (self)
MediaPlayerState|None	state (self)
def	volume_level (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_play_media (self, MediaType|str media_type, str media_id, **Any kwargs)
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_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)
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)
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	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)
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
	_attr_available
	_attr_unique_id
	_client
	_entry_id

Static Private Attributes
bool	_attr_should_poll = False
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 Snapcast client device.

Definition at line 203 of file media_player.py.

Constructor & Destructor Documentation

__init__()

def homeassistant.components.snapcast.media_player.SnapcastClientDevice.__init__	(		self,
			client,
			uid_part,
			entry_id
	)

Initialize the Snapcast client device.

Definition at line 213 of file media_player.py.

Member Function Documentation

async_added_to_hass()

None homeassistant.components.snapcast.media_player.SnapcastClientDevice.async_added_to_hass

(

self

)

Subscribe to client events.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 221 of file media_player.py.

async_join()

def homeassistant.components.snapcast.media_player.SnapcastClientDevice.async_join	(		self,
			master
	)

Join the group of the master player.

Definition at line 305 of file media_player.py.

async_mute_volume()

None homeassistant.components.snapcast.media_player.SnapcastClientDevice.async_mute_volume	(		self,
		bool	mute
	)

Send the mute command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 295 of file media_player.py.

async_restore()

def homeassistant.components.snapcast.media_player.SnapcastClientDevice.async_restore

(

self

)

Restore the client state.

Definition at line 332 of file media_player.py.

async_select_source()

None homeassistant.components.snapcast.media_player.SnapcastClientDevice.async_select_source	(		self,
		str	source
	)

Set input source.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 288 of file media_player.py.

async_set_latency()

def homeassistant.components.snapcast.media_player.SnapcastClientDevice.async_set_latency	(		self,
			latency
	)

Set the latency of the client.

Definition at line 337 of file media_player.py.

async_set_volume_level()

None homeassistant.components.snapcast.media_player.SnapcastClientDevice.async_set_volume_level	(		self,
		float	volume
	)

Set the volume level.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 300 of file media_player.py.

async_unjoin()

def homeassistant.components.snapcast.media_player.SnapcastClientDevice.async_unjoin

(

self

)

Unjoin the group the player is currently in.

Definition at line 323 of file media_player.py.

async_will_remove_from_hass()

None homeassistant.components.snapcast.media_player.SnapcastClientDevice.async_will_remove_from_hass

(

self

)

Disconnect client object when removed.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 226 of file media_player.py.

extra_state_attributes()

def homeassistant.components.snapcast.media_player.SnapcastClientDevice.extra_state_attributes

(

self

)

Return the state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 276 of file media_player.py.

identifier()

def homeassistant.components.snapcast.media_player.SnapcastClientDevice.identifier

(

self

)

Return the snapcast identifier.

Definition at line 237 of file media_player.py.

is_volume_muted()

def homeassistant.components.snapcast.media_player.SnapcastClientDevice.is_volume_muted

(

self

)

Volume muted.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 257 of file media_player.py.

latency()

def homeassistant.components.snapcast.media_player.SnapcastClientDevice.latency

(

self

)

Latency for Client.

Definition at line 284 of file media_player.py.

name()

def homeassistant.components.snapcast.media_player.SnapcastClientDevice.name

(

self

)

Return the name of the device.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 242 of file media_player.py.

set_availability()

None homeassistant.components.snapcast.media_player.SnapcastClientDevice.set_availability	(		self,
		bool	available
	)

Set availability of group.

Definition at line 231 of file media_player.py.

snapshot()

def homeassistant.components.snapcast.media_player.SnapcastClientDevice.snapshot

(

self

)

Snapshot the client state.

Definition at line 328 of file media_player.py.

source()

def homeassistant.components.snapcast.media_player.SnapcastClientDevice.source

(

self

)

Return the current input source.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 247 of file media_player.py.

source_list()

def homeassistant.components.snapcast.media_player.SnapcastClientDevice.source_list

(

self

)

List of available input sources.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 262 of file media_player.py.

state()

MediaPlayerState | None homeassistant.components.snapcast.media_player.SnapcastClientDevice.state

(

self

)

Return the state of the player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 267 of file media_player.py.

volume_level()

def homeassistant.components.snapcast.media_player.SnapcastClientDevice.volume_level

(

self

)

Return the volume level.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 252 of file media_player.py.

Member Data Documentation

_attr_available

homeassistant.components.snapcast.media_player.SnapcastClientDevice._attr_available

private

Definition at line 215 of file media_player.py.

_attr_should_poll

bool homeassistant.components.snapcast.media_player.SnapcastClientDevice._attr_should_poll = False

staticprivate

Definition at line 206 of file media_player.py.

_attr_supported_features

tuple homeassistant.components.snapcast.media_player.SnapcastClientDevice._attr_supported_features

staticprivate

Initial value:

=  (
        MediaPlayerEntityFeature.VOLUME_MUTE
        | MediaPlayerEntityFeature.VOLUME_SET
        | MediaPlayerEntityFeature.SELECT_SOURCE
    )

Definition at line 207 of file media_player.py.

_attr_unique_id

homeassistant.components.snapcast.media_player.SnapcastClientDevice._attr_unique_id

private

Definition at line 218 of file media_player.py.

_client

homeassistant.components.snapcast.media_player.SnapcastClientDevice._client

private

Definition at line 216 of file media_player.py.

_entry_id

homeassistant.components.snapcast.media_player.SnapcastClientDevice._entry_id

private

Definition at line 219 of file media_player.py.

---

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

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