Inheritance diagram for homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice:

Collaboration diagram for homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice:

Public Member Functions
None	__init__ (self, StreamMagicClient client)

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_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_turn_off (self)

None	async_turn_on (self)

None	async_volume_down (self)

None	async_volume_up (self)

bool\|None	is_volume_muted (self)

str\|None	media_album_name (self)

str\|None	media_artist (self)

int\|None	media_duration (self)

str\|None	media_image_url (self)

int\|None	media_position (self)

datetime	media_position_updated_at (self)

str\|None	media_title (self)

RepeatMode\|None	repeat (self)

bool	shuffle (self)

str\|None	source (self)

list[str]	source_list (self)

MediaPlayerState	state (self)

MediaPlayerEntityFeature	supported_features (self)

float\|None	volume_level (self)

Public Member Functions inherited from homeassistant.components.cambridge_audio.entity.CambridgeAudioEntity
None	async_added_to_hass (self)

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

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_select_sound_mode (self, str sound_mode)

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)

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)

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)

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

None	turn_off (self)

None	turn_on (self)

None	unjoin_player (self)

float	volume_step (self)

Private Attributes
	_attr_unique_id

Static Private Attributes
	_attr_device_class = MediaPlayerDeviceClass.RECEIVER

	_attr_media_content_type = MediaType.MUSIC

	_attr_name = None

Additional Inherited Members
Public Attributes inherited from homeassistant.components.cambridge_audio.entity.CambridgeAudioEntity
	client

Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry

	entity_id

	hass

	parallel_updates

	platform

	registry_entry

Public Attributes inherited from homeassistant.components.media_player.MediaPlayerEntity
	state

Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool

	EntityPlatform

	HomeAssistant

	None

	StateInfo

	StateType

	str

Static Public Attributes inherited from homeassistant.components.media_player.MediaPlayerEntity
	bool

	MediaPlayerEntityFeature

	None

Detailed Description

Representation of a Cambridge Audio Media Player Device.

Definition at line 73 of file media_player.py.

Constructor & Destructor Documentation

◆ init()

None homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice.__init__	(		self,
		StreamMagicClient	client
	)

Initialize an Cambridge Audio entity.

Reimplemented from homeassistant.components.cambridge_audio.entity.CambridgeAudioEntity.

Definition at line 80 of file media_player.py.

Member Function Documentation

◆ async_media_next_track()

None homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice.async_media_next_track ( self )

Skip to the next track.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 229 of file media_player.py.

◆ async_media_pause()

None homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice.async_media_pause ( self )

Pause the current media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 200 of file media_player.py.

◆ async_media_play()

None homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice.async_media_play ( self )

Play the current media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 217 of file media_player.py.

◆ async_media_play_pause()

None homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice.async_media_play_pause ( self )

Toggle play/pause the current media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 195 of file media_player.py.

◆ async_media_previous_track()

None homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice.async_media_previous_track ( self )

Skip to the previous track.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 234 of file media_player.py.

◆ async_media_seek()

None homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice.async_media_seek	(		self,
		float	position
	)

Seek to a position in the current media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 277 of file media_player.py.

◆ async_media_stop()

None homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice.async_media_stop ( self )

Stop the current media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 212 of file media_player.py.

◆ async_mute_volume()

None homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice.async_mute_volume	(		self,
		bool	mute
	)

Set the mute state.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 272 of file media_player.py.

◆ async_play_media()

None homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice.async_play_media	(		self,
		MediaType \| str	media_type,
		str	media_id,
		**Any	kwargs
	)

Play media on the Cambridge Audio device.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 298 of file media_player.py.

◆ async_select_source()

None homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice.async_select_source	(		self,
		str	source
	)

Select the source.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 239 of file media_player.py.

◆ async_set_repeat()

None homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice.async_set_repeat	(		self,
		RepeatMode	repeat
	)

Set the repeat mode for the current queue.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 290 of file media_player.py.

◆ async_set_shuffle()

None homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice.async_set_shuffle	(		self,
		bool	shuffle
	)

Set the shuffle mode for the current queue.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 282 of file media_player.py.

◆ async_set_volume_level()

None homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice.async_set_volume_level	(		self,
		float	volume
	)

Set the volume level.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 267 of file media_player.py.

◆ async_turn_off()

None homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice.async_turn_off ( self )

Power off the device.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 252 of file media_player.py.

◆ async_turn_on()

None homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice.async_turn_on ( self )

Power on the device.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 247 of file media_player.py.

◆ async_volume_down()

None homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice.async_volume_down ( self )

Step the volume down.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 262 of file media_player.py.

◆ async_volume_up()

None homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice.async_volume_up ( self )

Step the volume up.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 257 of file media_player.py.

◆ is_volume_muted()

bool | None homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice.is_volume_muted ( self )

Volume mute status.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 171 of file media_player.py.

◆ media_album_name()

str | None homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice.media_album_name ( self )

Album name of current playing media, music track only.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 146 of file media_player.py.

◆ media_artist()

str | None homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice.media_artist ( self )

Artist of current playing media, music track only.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 141 of file media_player.py.

◆ media_duration()

int | None homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice.media_duration ( self )

Duration of the current media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 156 of file media_player.py.

◆ media_image_url()

str | None homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice.media_image_url ( self )

Image url of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 151 of file media_player.py.

◆ media_position()

int | None homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice.media_position ( self )

Position of the current media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 161 of file media_player.py.

◆ media_position_updated_at()

datetime homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice.media_position_updated_at ( self )

Last time the media position was updated.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 166 of file media_player.py.

◆ media_title()

str | None homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice.media_title ( self )

Title of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 136 of file media_player.py.

◆ repeat()

RepeatMode | None homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice.repeat ( self )

Current repeat configuration.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 187 of file media_player.py.

◆ shuffle()

bool homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice.shuffle ( self )

Current shuffle configuration.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 182 of file media_player.py.

◆ source()

str | None homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice.source ( self )

Return the current input source.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 124 of file media_player.py.

◆ source_list()

list[str] homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice.source_list ( self )

Return a list of available input sources.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 119 of file media_player.py.

◆ state()

MediaPlayerState homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice.state ( self )

Return the state of the device.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 101 of file media_player.py.

◆ supported_features()

MediaPlayerEntityFeature homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice.supported_features ( self )

Supported features for the media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 86 of file media_player.py.

◆ volume_level()

float | None homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice.volume_level ( self )

Current pre-amp volume level.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 176 of file media_player.py.

Member Data Documentation

◆ _attr_device_class

homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice._attr_device_class = MediaPlayerDeviceClass.RECEIVER

staticprivate

Definition at line 78 of file media_player.py.

◆ _attr_media_content_type

homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice._attr_media_content_type = MediaType.MUSIC

staticprivate

Definition at line 77 of file media_player.py.

◆ _attr_name

homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice._attr_name = None

staticprivate

Definition at line 76 of file media_player.py.

◆ _attr_unique_id

homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice._attr_unique_id

private

Definition at line 83 of file media_player.py.

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

core/homeassistant/components/cambridge_audio/media_player.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ async_media_next_track()

◆ async_media_pause()

◆ async_media_play()

◆ async_media_play_pause()

◆ async_media_previous_track()

◆ async_media_seek()

◆ async_media_stop()

◆ async_mute_volume()

◆ async_play_media()

◆ async_select_source()

◆ async_set_repeat()

◆ async_set_shuffle()

◆ async_set_volume_level()

◆ async_turn_off()

◆ async_turn_on()

◆ async_volume_down()

◆ async_volume_up()

◆ is_volume_muted()

◆ media_album_name()

◆ media_artist()

◆ media_duration()

◆ media_image_url()

◆ media_position()

◆ media_position_updated_at()

◆ media_title()

◆ repeat()

◆ shuffle()

◆ source()

◆ source_list()

◆ state()

◆ supported_features()

◆ volume_level()

Member Data Documentation

◆ _attr_device_class

◆ _attr_media_content_type

◆ _attr_name

◆ _attr_unique_id

◆ init()