Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity Class Reference
Inheritance diagram for homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity:
[legend]
Collaboration diagram for homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity:
[legend]

Public Member Functions

None __init__ (self, ConfigEntry entry, WebOsClient client)
 
None async_added_to_hass (self)
 
None async_button (self, str button)
 
None async_command (self, str command, **Any kwargs)
 
None async_handle_state_update (self, WebOsClient _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_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_output (self, str sound_output)
 
None async_select_source (self, str source)
 
None async_set_volume_level (self, float volume)
 
None async_signal_handler (self, dict[str, Any] data)
 
None async_turn_off (self)
 
None async_turn_on (self)
 
None async_update (self)
 
None async_volume_down (self)
 
None async_volume_up (self)
 
None async_will_remove_from_hass (self)
 
MediaPlayerEntityFeature supported_features (self)
 
- Public Member Functions inherited from homeassistant.helpers.restore_state.RestoreEntity
ExtraStoredData|None async_get_last_extra_data (self)
 
State|None async_get_last_state (self)
 
None async_internal_added_to_hass (self)
 
None async_internal_will_remove_from_hass (self)
 
ExtraStoredData|None extra_restore_state_data (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_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, strtranslation_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|Noneasync_get_browse_image (self, str media_content_type, str media_content_id, str|None media_image_id=None)
 
tuple[bytes|None, str|Noneasync_get_media_image (self)
 
None async_join_players (self, list[str] group_members)
 
None async_media_seek (self, float position)
 
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 Attributes

 state
 
- 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 Member Functions

tuple[bytes|None, str|None_async_fetch_image (self, str url)
 
None _update_sources (self)
 
None _update_states (self)
 

Private Attributes

 _attr_assumed_state
 
 _attr_device_info
 
 _attr_extra_state_attributes
 
 _attr_is_volume_muted
 
 _attr_media_content_type
 
 _attr_media_image_url
 
 _attr_media_title
 
 _attr_source
 
 _attr_source_list
 
 _attr_state
 
 _attr_unique_id
 
 _attr_volume_level
 
 _client
 
 _current_source
 
 _device_name
 
 _entry
 
 _paused
 
 _source_list
 
 _sources
 
 _supported_features
 
 _turn_on
 

Static Private Attributes

 _attr_device_class = MediaPlayerDeviceClass.TV
 
bool _attr_has_entity_name = True
 
 _attr_name = None
 

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 LG webOS Smart TV.

Definition at line 109 of file media_player.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity.__init__ (   self,
ConfigEntry  entry,
WebOsClient  client 
)
Initialize the webos device.

Definition at line 116 of file media_player.py.

Member Function Documentation

◆ _async_fetch_image()

tuple[bytes | None, str | None] homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity._async_fetch_image (   self,
str  url 
)
private
Retrieve an image.

webOS uses self-signed certificates, thus we need to use an empty
SSLContext to bypass validation errors if url starts with https.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 480 of file media_player.py.

◆ _update_sources()

None homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity._update_sources (   self)
private
Update list of sources from current source, apps, inputs and configured list.

Definition at line 270 of file media_player.py.

◆ _update_states()

None homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity._update_states (   self)
private
Update entity state attributes.

Definition at line 186 of file media_player.py.

◆ async_added_to_hass()

None homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity.async_added_to_hass (   self)
Connect and subscribe to dispatcher signals and state updates.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 134 of file media_player.py.

◆ async_button()

None homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity.async_button (   self,
str  button 
)
Send a button press.

Definition at line 471 of file media_player.py.

◆ async_command()

None homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity.async_command (   self,
str  command,
**Any  kwargs 
)
Send a command.

Definition at line 476 of file media_player.py.

◆ async_handle_state_update()

None homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity.async_handle_state_update (   self,
WebOsClient  _client 
)
Update state from WebOsClient.

Definition at line 181 of file media_player.py.

◆ async_media_next_track()

None homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity.async_media_next_track (   self)
Send next track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 455 of file media_player.py.

◆ async_media_pause()

None homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity.async_media_pause (   self)
Send media pause command to media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 444 of file media_player.py.

◆ async_media_play()

None homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity.async_media_play (   self)
Send play command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 438 of file media_player.py.

◆ async_media_play_pause()

None homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity.async_media_play_pause (   self)
Simulate play pause media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 380 of file media_player.py.

◆ async_media_previous_track()

None homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity.async_media_previous_track (   self)
Send the previous track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 463 of file media_player.py.

◆ async_media_stop()

None homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity.async_media_stop (   self)
Send stop command to media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 450 of file media_player.py.

◆ async_mute_volume()

None homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity.async_mute_volume (   self,
bool  mute 
)
Send mute command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 370 of file media_player.py.

◆ async_play_media()

None homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity.async_play_media (   self,
MediaType | str  media_type,
str  media_id,
**Any   kwargs 
)
Play a piece of media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 401 of file media_player.py.

◆ async_select_sound_output()

None homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity.async_select_sound_output (   self,
str  sound_output 
)
Select the sound output.

Definition at line 375 of file media_player.py.

◆ async_select_source()

None homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity.async_select_source (   self,
str  source 
)
Select input source.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 388 of file media_player.py.

◆ async_set_volume_level()

None homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity.async_set_volume_level (   self,
float  volume 
)
Set volume level, range 0..1.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 364 of file media_player.py.

◆ async_signal_handler()

None homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity.async_signal_handler (   self,
dict[str, Any]  data 
)
Handle domain-specific signal by calling appropriate method.

Definition at line 168 of file media_player.py.

◆ async_turn_off()

None homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity.async_turn_off (   self)
Turn off media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 345 of file media_player.py.

◆ async_turn_on()

None homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity.async_turn_on (   self)
Turn on media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 349 of file media_player.py.

◆ async_update()

None homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity.async_update (   self)
Connect.

Definition at line 323 of file media_player.py.

◆ async_volume_down()

None homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity.async_volume_down (   self)
Volume down media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 359 of file media_player.py.

◆ async_volume_up()

None homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity.async_volume_up (   self)
Volume up the media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 354 of file media_player.py.

◆ async_will_remove_from_hass()

None homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity.async_will_remove_from_hass (   self)
Call disconnect on removal.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 164 of file media_player.py.

◆ supported_features()

MediaPlayerEntityFeature homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity.supported_features (   self)
Flag media player features that are supported.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 337 of file media_player.py.

Member Data Documentation

◆ _attr_assumed_state

homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity._attr_assumed_state
private

Definition at line 120 of file media_player.py.

◆ _attr_device_class

homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity._attr_device_class = MediaPlayerDeviceClass.TV
staticprivate

Definition at line 112 of file media_player.py.

◆ _attr_device_info

homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity._attr_device_info
private

Definition at line 234 of file media_player.py.

◆ _attr_extra_state_attributes

homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity._attr_extra_state_attributes
private

Definition at line 264 of file media_player.py.

◆ _attr_has_entity_name

bool homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity._attr_has_entity_name = True
staticprivate

Definition at line 113 of file media_player.py.

◆ _attr_is_volume_muted

homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity._attr_is_volume_muted
private

Definition at line 193 of file media_player.py.

◆ _attr_media_content_type

homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity._attr_media_content_type
private

Definition at line 202 of file media_player.py.

◆ _attr_media_image_url

homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity._attr_media_image_url
private

Definition at line 214 of file media_player.py.

◆ _attr_media_title

homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity._attr_media_title
private

Definition at line 206 of file media_player.py.

◆ _attr_name

homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity._attr_name = None
staticprivate

Definition at line 114 of file media_player.py.

◆ _attr_source

homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity._attr_source
private

Definition at line 199 of file media_player.py.

◆ _attr_source_list

homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity._attr_source_list
private

Definition at line 200 of file media_player.py.

◆ _attr_state

homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity._attr_state
private

Definition at line 190 of file media_player.py.

◆ _attr_unique_id

homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity._attr_unique_id
private

Definition at line 122 of file media_player.py.

◆ _attr_volume_level

homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity._attr_volume_level
private

Definition at line 195 of file media_player.py.

◆ _client

homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity._client
private

Definition at line 119 of file media_player.py.

◆ _current_source

homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity._current_source
private

Definition at line 128 of file media_player.py.

◆ _device_name

homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity._device_name
private

Definition at line 121 of file media_player.py.

◆ _entry

homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity._entry
private

Definition at line 118 of file media_player.py.

◆ _paused

homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity._paused
private

Definition at line 126 of file media_player.py.

◆ _source_list

homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity._source_list
private

Definition at line 273 of file media_player.py.

◆ _sources

homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity._sources
private

Definition at line 123 of file media_player.py.

◆ _supported_features

homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity._supported_features
private

Definition at line 131 of file media_player.py.

◆ _turn_on

homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity._turn_on
private

Definition at line 127 of file media_player.py.

◆ state

homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity.state

Definition at line 154 of file media_player.py.


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