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

Public Member Functions

def __init__ (self, host, port, unique_id)
 
None async_added_to_hass (self)
 
def handle_event (self, response)
 
def is_volume_muted (self)
 
None mute_volume (self, bool mute)
 
None select_sound_mode (self, str sound_mode)
 
None select_source (self, str source)
 
None set_volume_level (self, float volume)
 
def sound_mode (self)
 
def sound_mode_list (self)
 
def source (self)
 
def source_list (self)
 
None turn_off (self)
 
None turn_on (self)
 
None update (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|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_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)
 
str|None media_title (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 set_repeat (self, RepeatMode repeat)
 
None set_shuffle (self, bool shuffle)
 
bool|None shuffle (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 (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_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)
 
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)
 

Private Member Functions

None _connect (self)
 
None _set_power (self, bool status)
 
None _update_equalisers (self, dict[str, Any] data)
 

Private Attributes

 _attr_device_info
 
 _attr_unique_id
 
 _bass
 
 _device
 
 _equaliser
 
 _equalisers
 
 _function
 
 _functions
 
 _host
 
 _mute
 
 _port
 
 _rear_volume
 
 _rear_volume_max
 
 _rear_volume_min
 
 _treble
 
 _volume
 
 _volume_max
 
 _volume_min
 
 _woofer_volume
 
 _woofer_volume_max
 
 _woofer_volume_min
 

Static Private Attributes

bool _attr_has_entity_name = True
 
 _attr_name = None
 
bool _attr_should_poll = False
 
 _attr_state = MediaPlayerState.ON
 
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 an LG soundbar device.

Definition at line 40 of file media_player.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.lg_soundbar.media_player.LGDevice.__init__ (   self,
  host,
  port,
  unique_id 
)
Initialize the LG speakers.

Definition at line 56 of file media_player.py.

Member Function Documentation

◆ _connect()

None homeassistant.components.lg_soundbar.media_player.LGDevice._connect (   self)
private
Perform the actual devices setup.

Definition at line 87 of file media_player.py.

◆ _set_power()

None homeassistant.components.lg_soundbar.media_player.LGDevice._set_power (   self,
bool  status 
)
private
Set the media player state.

Definition at line 229 of file media_player.py.

◆ _update_equalisers()

None homeassistant.components.lg_soundbar.media_player.LGDevice._update_equalisers (   self,
dict[str, Any]  data 
)
private
Update the equalisers.

Definition at line 142 of file media_player.py.

◆ async_added_to_hass()

None homeassistant.components.lg_soundbar.media_player.LGDevice.async_added_to_hass (   self)
Register the callback after hass is ready for it.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 83 of file media_player.py.

◆ handle_event()

def homeassistant.components.lg_soundbar.media_player.LGDevice.handle_event (   self,
  response 
)
Handle responses from the speakers.

Definition at line 96 of file media_player.py.

◆ is_volume_muted()

def homeassistant.components.lg_soundbar.media_player.LGDevice.is_volume_muted (   self)
Boolean if volume is currently muted.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 168 of file media_player.py.

◆ mute_volume()

None homeassistant.components.lg_soundbar.media_player.LGDevice.mute_volume (   self,
bool  mute 
)
Mute (true) or unmute (false) media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 209 of file media_player.py.

◆ select_sound_mode()

None homeassistant.components.lg_soundbar.media_player.LGDevice.select_sound_mode (   self,
str  sound_mode 
)
Set Sound Mode for Receiver..

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 217 of file media_player.py.

◆ select_source()

None homeassistant.components.lg_soundbar.media_player.LGDevice.select_source (   self,
str  source 
)
Select input source.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 213 of file media_player.py.

◆ set_volume_level()

None homeassistant.components.lg_soundbar.media_player.LGDevice.set_volume_level (   self,
float  volume 
)
Set volume level, range 0..1.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 204 of file media_player.py.

◆ sound_mode()

def homeassistant.components.lg_soundbar.media_player.LGDevice.sound_mode (   self)
Return the current sound mode.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 173 of file media_player.py.

◆ sound_mode_list()

def homeassistant.components.lg_soundbar.media_player.LGDevice.sound_mode_list (   self)
Return the available sound modes.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 180 of file media_player.py.

◆ source()

def homeassistant.components.lg_soundbar.media_player.LGDevice.source (   self)
Return the current input source.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 189 of file media_player.py.

◆ source_list()

def homeassistant.components.lg_soundbar.media_player.LGDevice.source_list (   self)
List of available input sources.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 196 of file media_player.py.

◆ turn_off()

None homeassistant.components.lg_soundbar.media_player.LGDevice.turn_off (   self)
Turn the media player off.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 225 of file media_player.py.

◆ turn_on()

None homeassistant.components.lg_soundbar.media_player.LGDevice.turn_on (   self)
Turn the media player on.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 221 of file media_player.py.

◆ update()

None homeassistant.components.lg_soundbar.media_player.LGDevice.update (   self)
Trigger updates from the device.

Definition at line 153 of file media_player.py.

◆ volume_level()

def homeassistant.components.lg_soundbar.media_player.LGDevice.volume_level (   self)
Volume level of the media player (0..1).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 161 of file media_player.py.

Member Data Documentation

◆ _attr_device_info

homeassistant.components.lg_soundbar.media_player.LGDevice._attr_device_info
private

Definition at line 79 of file media_player.py.

◆ _attr_has_entity_name

bool homeassistant.components.lg_soundbar.media_player.LGDevice._attr_has_entity_name = True
staticprivate

Definition at line 53 of file media_player.py.

◆ _attr_name

homeassistant.components.lg_soundbar.media_player.LGDevice._attr_name = None
staticprivate

Definition at line 54 of file media_player.py.

◆ _attr_should_poll

bool homeassistant.components.lg_soundbar.media_player.LGDevice._attr_should_poll = False
staticprivate

Definition at line 43 of file media_player.py.

◆ _attr_state

homeassistant.components.lg_soundbar.media_player.LGDevice._attr_state = MediaPlayerState.ON
staticprivate

Definition at line 44 of file media_player.py.

◆ _attr_supported_features

tuple homeassistant.components.lg_soundbar.media_player.LGDevice._attr_supported_features
staticprivate
Initial value:
= (
MediaPlayerEntityFeature.VOLUME_SET
| MediaPlayerEntityFeature.VOLUME_MUTE
| MediaPlayerEntityFeature.TURN_ON
| MediaPlayerEntityFeature.TURN_OFF
| MediaPlayerEntityFeature.SELECT_SOURCE
| MediaPlayerEntityFeature.SELECT_SOUND_MODE
)

Definition at line 45 of file media_player.py.

◆ _attr_unique_id

homeassistant.components.lg_soundbar.media_player.LGDevice._attr_unique_id
private

Definition at line 60 of file media_player.py.

◆ _bass

homeassistant.components.lg_soundbar.media_player.LGDevice._bass
private

Definition at line 76 of file media_player.py.

◆ _device

homeassistant.components.lg_soundbar.media_player.LGDevice._device
private

Definition at line 78 of file media_player.py.

◆ _equaliser

homeassistant.components.lg_soundbar.media_player.LGDevice._equaliser
private

Definition at line 67 of file media_player.py.

◆ _equalisers

homeassistant.components.lg_soundbar.media_player.LGDevice._equalisers
private

Definition at line 68 of file media_player.py.

◆ _function

homeassistant.components.lg_soundbar.media_player.LGDevice._function
private

Definition at line 65 of file media_player.py.

◆ _functions

homeassistant.components.lg_soundbar.media_player.LGDevice._functions
private

Definition at line 66 of file media_player.py.

◆ _host

homeassistant.components.lg_soundbar.media_player.LGDevice._host
private

Definition at line 58 of file media_player.py.

◆ _mute

homeassistant.components.lg_soundbar.media_player.LGDevice._mute
private

Definition at line 69 of file media_player.py.

◆ _port

homeassistant.components.lg_soundbar.media_player.LGDevice._port
private

Definition at line 59 of file media_player.py.

◆ _rear_volume

homeassistant.components.lg_soundbar.media_player.LGDevice._rear_volume
private

Definition at line 70 of file media_player.py.

◆ _rear_volume_max

homeassistant.components.lg_soundbar.media_player.LGDevice._rear_volume_max
private

Definition at line 72 of file media_player.py.

◆ _rear_volume_min

homeassistant.components.lg_soundbar.media_player.LGDevice._rear_volume_min
private

Definition at line 71 of file media_player.py.

◆ _treble

homeassistant.components.lg_soundbar.media_player.LGDevice._treble
private

Definition at line 77 of file media_player.py.

◆ _volume

homeassistant.components.lg_soundbar.media_player.LGDevice._volume
private

Definition at line 62 of file media_player.py.

◆ _volume_max

homeassistant.components.lg_soundbar.media_player.LGDevice._volume_max
private

Definition at line 64 of file media_player.py.

◆ _volume_min

homeassistant.components.lg_soundbar.media_player.LGDevice._volume_min
private

Definition at line 63 of file media_player.py.

◆ _woofer_volume

homeassistant.components.lg_soundbar.media_player.LGDevice._woofer_volume
private

Definition at line 73 of file media_player.py.

◆ _woofer_volume_max

homeassistant.components.lg_soundbar.media_player.LGDevice._woofer_volume_max
private

Definition at line 75 of file media_player.py.

◆ _woofer_volume_min

homeassistant.components.lg_soundbar.media_player.LGDevice._woofer_volume_min
private

Definition at line 74 of file media_player.py.


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