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

Public Member Functions

def __init__ (self, name, host, port, maximum_volume, volume_step, standby_time, inverse_speaker_mode, supports_on, sources, speaker_type, loop, unique_id)
 
None async_added_to_hass (self)
 
None async_media_next_track (self)
 
None async_media_pause (self)
 
None async_media_play (self)
 
None async_media_previous_track (self)
 
None async_mute_volume (self, bool mute)
 
None async_select_source (self, str source)
 
None async_set_volume_level (self, float volume)
 
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)
 
def extra_state_attributes (self)
 
def set_desk_db (self, db_value)
 
def set_high_hz (self, hz_value)
 
def set_low_hz (self, hz_value)
 
def set_mode (self, desk_mode=None, wall_mode=None, phase_correction=None, high_pass=None, sub_polarity=None, bass_extension=None)
 
def set_sub_db (self, db_value)
 
def set_treble_db (self, db_value)
 
def set_wall_db (self, db_value)
 
None update_dsp (self, _=None)
 
- 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_play_pause (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_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 (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 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)
 
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 Attributes

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

Private Attributes

 _attr_available
 
 _attr_is_volume_muted
 
 _attr_name
 
 _attr_source
 
 _attr_source_list
 
 _attr_state
 
 _attr_supported_features
 
 _attr_unique_id
 
 _attr_volume_level
 
 _dsp
 
 _speaker
 
 _speaker_type
 
 _supports_on
 
 _update_dsp_task_remover
 

Static Private Attributes

string _attr_icon = "mdi:speaker-wireless"
 

Additional Inherited Members

- 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

Kef Player Object.

Definition at line 187 of file media_player.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.kef.media_player.KefMediaPlayer.__init__ (   self,
  name,
  host,
  port,
  maximum_volume,
  volume_step,
  standby_time,
  inverse_speaker_mode,
  supports_on,
  sources,
  speaker_type,
  loop,
  unique_id 
)
Initialize the media player.

Definition at line 192 of file media_player.py.

Member Function Documentation

◆ async_added_to_hass()

None homeassistant.components.kef.media_player.KefMediaPlayer.async_added_to_hass (   self)
Subscribe to DSP updates.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 337 of file media_player.py.

◆ async_media_next_track()

None homeassistant.components.kef.media_player.KefMediaPlayer.async_media_next_track (   self)
Send next track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 316 of file media_player.py.

◆ async_media_pause()

None homeassistant.components.kef.media_player.KefMediaPlayer.async_media_pause (   self)
Send pause command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 308 of file media_player.py.

◆ async_media_play()

None homeassistant.components.kef.media_player.KefMediaPlayer.async_media_play (   self)
Send play command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 304 of file media_player.py.

◆ async_media_previous_track()

None homeassistant.components.kef.media_player.KefMediaPlayer.async_media_previous_track (   self)
Send previous track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 312 of file media_player.py.

◆ async_mute_volume()

None homeassistant.components.kef.media_player.KefMediaPlayer.async_mute_volume (   self,
bool  mute 
)
Mute (True) or unmute (False) media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 290 of file media_player.py.

◆ async_select_source()

None homeassistant.components.kef.media_player.KefMediaPlayer.async_select_source (   self,
str  source 
)
Select input source.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 297 of file media_player.py.

◆ async_set_volume_level()

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

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 286 of file media_player.py.

◆ async_turn_off()

None homeassistant.components.kef.media_player.KefMediaPlayer.async_turn_off (   self)
Turn the media player off.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 268 of file media_player.py.

◆ async_turn_on()

None homeassistant.components.kef.media_player.KefMediaPlayer.async_turn_on (   self)
Turn the media player on.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 272 of file media_player.py.

◆ async_update()

None homeassistant.components.kef.media_player.KefMediaPlayer.async_update (   self)
Update latest state.

Definition at line 241 of file media_player.py.

◆ async_volume_down()

None homeassistant.components.kef.media_player.KefMediaPlayer.async_volume_down (   self)
Volume down the media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 282 of file media_player.py.

◆ async_volume_up()

None homeassistant.components.kef.media_player.KefMediaPlayer.async_volume_up (   self)
Volume up the media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 278 of file media_player.py.

◆ async_will_remove_from_hass()

None homeassistant.components.kef.media_player.KefMediaPlayer.async_will_remove_from_hass (   self)
Unsubscribe to DSP updates.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 343 of file media_player.py.

◆ extra_state_attributes()

def homeassistant.components.kef.media_player.KefMediaPlayer.extra_state_attributes (   self)
Return the DSP settings of the KEF device.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 349 of file media_player.py.

◆ set_desk_db()

def homeassistant.components.kef.media_player.KefMediaPlayer.set_desk_db (   self,
  db_value 
)
Set desk_db of the KEF speakers.

Definition at line 373 of file media_player.py.

◆ set_high_hz()

def homeassistant.components.kef.media_player.KefMediaPlayer.set_high_hz (   self,
  hz_value 
)
Set high_hz of the KEF speakers.

Definition at line 388 of file media_player.py.

◆ set_low_hz()

def homeassistant.components.kef.media_player.KefMediaPlayer.set_low_hz (   self,
  hz_value 
)
Set low_hz of the KEF speakers.

Definition at line 393 of file media_player.py.

◆ set_mode()

def homeassistant.components.kef.media_player.KefMediaPlayer.set_mode (   self,
  desk_mode = None,
  wall_mode = None,
  phase_correction = None,
  high_pass = None,
  sub_polarity = None,
  bass_extension = None 
)
Set the speaker mode.

Definition at line 353 of file media_player.py.

◆ set_sub_db()

def homeassistant.components.kef.media_player.KefMediaPlayer.set_sub_db (   self,
  db_value 
)
Set sub_db of the KEF speakers.

Definition at line 398 of file media_player.py.

◆ set_treble_db()

def homeassistant.components.kef.media_player.KefMediaPlayer.set_treble_db (   self,
  db_value 
)
Set treble_db of the KEF speakers.

Definition at line 383 of file media_player.py.

◆ set_wall_db()

def homeassistant.components.kef.media_player.KefMediaPlayer.set_wall_db (   self,
  db_value 
)
Set wall_db of the KEF speakers.

Definition at line 378 of file media_player.py.

◆ update_dsp()

None homeassistant.components.kef.media_player.KefMediaPlayer.update_dsp (   self,
  _ = None 
)
Update the DSP settings.

Definition at line 320 of file media_player.py.

Member Data Documentation

◆ _attr_available

homeassistant.components.kef.media_player.KefMediaPlayer._attr_available
private

Definition at line 223 of file media_player.py.

◆ _attr_icon

string homeassistant.components.kef.media_player.KefMediaPlayer._attr_icon = "mdi:speaker-wireless"
staticprivate

Definition at line 190 of file media_player.py.

◆ _attr_is_volume_muted

homeassistant.components.kef.media_player.KefMediaPlayer._attr_is_volume_muted
private

Definition at line 260 of file media_player.py.

◆ _attr_name

homeassistant.components.kef.media_player.KefMediaPlayer._attr_name
private

Definition at line 208 of file media_player.py.

◆ _attr_source

homeassistant.components.kef.media_player.KefMediaPlayer._attr_source
private

Definition at line 252 of file media_player.py.

◆ _attr_source_list

homeassistant.components.kef.media_player.KefMediaPlayer._attr_source_list
private

Definition at line 209 of file media_player.py.

◆ _attr_state

homeassistant.components.kef.media_player.KefMediaPlayer._attr_state
private

Definition at line 253 of file media_player.py.

◆ _attr_supported_features

homeassistant.components.kef.media_player.KefMediaPlayer._attr_supported_features
private

Definition at line 227 of file media_player.py.

◆ _attr_unique_id

homeassistant.components.kef.media_player.KefMediaPlayer._attr_unique_id
private

Definition at line 219 of file media_player.py.

◆ _attr_volume_level

homeassistant.components.kef.media_player.KefMediaPlayer._attr_volume_level
private

Definition at line 262 of file media_player.py.

◆ _dsp

homeassistant.components.kef.media_player.KefMediaPlayer._dsp
private

Definition at line 224 of file media_player.py.

◆ _speaker

homeassistant.components.kef.media_player.KefMediaPlayer._speaker
private

Definition at line 210 of file media_player.py.

◆ _speaker_type

homeassistant.components.kef.media_player.KefMediaPlayer._speaker_type
private

Definition at line 221 of file media_player.py.

◆ _supports_on

homeassistant.components.kef.media_player.KefMediaPlayer._supports_on
private

Definition at line 220 of file media_player.py.

◆ _update_dsp_task_remover

homeassistant.components.kef.media_player.KefMediaPlayer._update_dsp_task_remover
private

Definition at line 225 of file media_player.py.

◆ state

homeassistant.components.kef.media_player.KefMediaPlayer.state

Definition at line 322 of file media_player.py.


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