Inheritance diagram for homeassistant.components.hdmi_cec.media_player.CecPlayerEntity:

Collaboration diagram for homeassistant.components.hdmi_cec.media_player.CecPlayerEntity:

Public Member Functions
None	__init__ (self, device, logical)

None	clear_playlist (self)

None	media_next_track (self)

None	media_pause (self)

None	media_play (self)

None	media_previous_track (self)

None	media_seek (self, float position)

None	media_stop (self)

None	mute_volume (self, bool mute)

None	play_media (self, MediaType\|str media_type, str media_id, **Any kwargs)

None	select_source (self, str source)

def	send_keypress (self, key)

def	send_playback (self, key)

None	set_volume_level (self, float volume)

MediaPlayerEntityFeature	supported_features (self)

None	turn_off (self)

None	turn_on (self)

None	update (self)

None	volume_down (self)

None	volume_up (self)

Public Member Functions inherited from homeassistant.components.hdmi_cec.entity.CecEntity
def	async_added_to_hass (self)

def	extra_state_attributes (self)

def	physical_address (self)

def	type (self)

def	type_id (self)

def	vendor_id (self)

def	vendor_name (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_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)

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

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)

str\|None	media_playlist (self)

int\|None	media_position (self)

dt.datetime\|None	media_position_updated_at (self)

str\|None	media_season (self)

str\|None	media_series_title (self)

str\|None	media_title (self)

int\|None	media_track (self)

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)

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 Attributes
	entity_id

	type

	type_id

Public Attributes inherited from homeassistant.components.hdmi_cec.entity.CecEntity
	entity_id

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

Private Attributes
	_attr_state

Additional Inherited Members
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 HDMI device as a Media player.

Definition at line 64 of file media_player.py.

Constructor & Destructor Documentation

◆ init()

None homeassistant.components.hdmi_cec.media_player.CecPlayerEntity.__init__	(	self,
		device,
		logical
	)

Initialize the HDMI device.

Reimplemented from homeassistant.components.hdmi_cec.entity.CecEntity.

Definition at line 67 of file media_player.py.

Member Function Documentation

◆ clear_playlist()

None homeassistant.components.hdmi_cec.media_player.CecPlayerEntity.clear_playlist ( self )

Clear players playlist.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 97 of file media_player.py.

◆ media_next_track()

None homeassistant.components.hdmi_cec.media_player.CecPlayerEntity.media_next_track ( self )

Skip to next track.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 117 of file media_player.py.

◆ media_pause()

None homeassistant.components.hdmi_cec.media_player.CecPlayerEntity.media_pause ( self )

Pause playback.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 129 of file media_player.py.

◆ media_play()

None homeassistant.components.hdmi_cec.media_player.CecPlayerEntity.media_play ( self )

Start playback.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 138 of file media_player.py.

◆ media_previous_track()

None homeassistant.components.hdmi_cec.media_player.CecPlayerEntity.media_previous_track ( self )

Go to previous track.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 88 of file media_player.py.

◆ media_seek()

None homeassistant.components.hdmi_cec.media_player.CecPlayerEntity.media_seek	(		self,
		float	position
	)

Not supported.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 121 of file media_player.py.

◆ media_stop()

None homeassistant.components.hdmi_cec.media_player.CecPlayerEntity.media_stop ( self )

Stop playback.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 106 of file media_player.py.

◆ mute_volume()

None homeassistant.components.hdmi_cec.media_player.CecPlayerEntity.mute_volume	(		self,
		bool	mute
	)

Mute volume.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 84 of file media_player.py.

◆ play_media()

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

Not supported.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 111 of file media_player.py.

◆ select_source()

None homeassistant.components.hdmi_cec.media_player.CecPlayerEntity.select_source	(		self,
		str	source
	)

Not supported.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 134 of file media_player.py.

◆ send_keypress()

def homeassistant.components.hdmi_cec.media_player.CecPlayerEntity.send_keypress	(	self,
		key
	)

Send keypress to CEC adapter.

Definition at line 72 of file media_player.py.

◆ send_playback()

def homeassistant.components.hdmi_cec.media_player.CecPlayerEntity.send_playback	(	self,
		key
	)

Send playback status to CEC adapter.

Definition at line 80 of file media_player.py.

◆ set_volume_level()

None homeassistant.components.hdmi_cec.media_player.CecPlayerEntity.set_volume_level	(		self,
		float	volume
	)

Set volume level, range 0..1.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 125 of file media_player.py.

◆ supported_features()

MediaPlayerEntityFeature homeassistant.components.hdmi_cec.media_player.CecPlayerEntity.supported_features ( self )

Flag media player features that are supported.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 171 of file media_player.py.

◆ turn_off()

None homeassistant.components.hdmi_cec.media_player.CecPlayerEntity.turn_off ( self )

Turn device off.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 101 of file media_player.py.

◆ turn_on()

None homeassistant.components.hdmi_cec.media_player.CecPlayerEntity.turn_on ( self )

Turn device on.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 92 of file media_player.py.

◆ update()

None homeassistant.components.hdmi_cec.media_player.CecPlayerEntity.update ( self )

Update device status.

Definition at line 153 of file media_player.py.

◆ volume_down()

None homeassistant.components.hdmi_cec.media_player.CecPlayerEntity.volume_down ( self )

Decrease volume.

Definition at line 148 of file media_player.py.

◆ volume_up()

None homeassistant.components.hdmi_cec.media_player.CecPlayerEntity.volume_up ( self )

Increase volume.

Definition at line 143 of file media_player.py.

Member Data Documentation

◆ _attr_state

homeassistant.components.hdmi_cec.media_player.CecPlayerEntity._attr_state

private

Definition at line 95 of file media_player.py.

◆ entity_id

homeassistant.components.hdmi_cec.media_player.CecPlayerEntity.entity_id

Definition at line 70 of file media_player.py.

◆ type

homeassistant.components.hdmi_cec.media_player.CecPlayerEntity.type

Definition at line 173 of file media_player.py.

◆ type_id

homeassistant.components.hdmi_cec.media_player.CecPlayerEntity.type_id

Definition at line 173 of file media_player.py.

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

core/homeassistant/components/hdmi_cec/media_player.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ clear_playlist()

◆ media_next_track()

◆ media_pause()

◆ media_play()

◆ media_previous_track()

◆ media_seek()

◆ media_stop()

◆ mute_volume()

◆ play_media()

◆ select_source()

◆ send_keypress()

◆ send_playback()

◆ set_volume_level()

◆ supported_features()

◆ turn_off()

◆ turn_on()

◆ update()

◆ volume_down()

◆ volume_up()

Member Data Documentation

◆ _attr_state

◆ entity_id

◆ type

◆ type_id

◆ init()