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

Public Member Functions

None __init__ (self, SamsungTVDataUpdateCoordinator coordinator)
 
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_play_pause (self)
 
None async_media_previous_track (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_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)
 
None async_will_remove_from_hass (self)
 
MediaPlayerEntityFeature supported_features (self)
 
- Public Member Functions inherited from homeassistant.components.samsungtv.entity.SamsungTVEntity
None __init__ (self, *SamsungTVDataUpdateCoordinator coordinator)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
- Public Member Functions inherited from homeassistant.components.samsungtv.coordinator.SamsungTVDataUpdateCoordinator
None __init__ (self, HomeAssistant hass, SamsungTVBridge bridge)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
None __init__ (self, HomeAssistant hass, logging.Logger logger, *config_entries.ConfigEntry|None|UndefinedType config_entry=UNDEFINED, str name, timedelta|None update_interval=None, Callable[[], Awaitable[_DataT]]|None update_method=None, Callable[[], Awaitable[None]]|None setup_method=None, Debouncer[Coroutine[Any, Any, None]]|None request_refresh_debouncer=None, bool always_update=True)
 
Callable[[], None] async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
 
None async_config_entry_first_refresh (self)
 
Generator[Any] async_contexts (self)
 
None async_refresh (self)
 
None async_register_shutdown (self)
 
None async_request_refresh (self)
 
None async_set_update_error (self, Exception err)
 
None async_set_updated_data (self, _DataT data)
 
None async_shutdown (self)
 
None async_update_listeners (self)
 
timedelta|None update_interval (self)
 
None update_interval (self, timedelta|None value)
 
- 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)
 
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_media_stop (self)
 
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)
 

Private Member Functions

None _app_list_callback (self, dict[str, str] app_list)
 
None _async_extra_update (self)
 
None _async_launch_app (self, str app_id)
 
None _async_resubscribe_dmr (self)
 
None _async_send_keys (self, list[str] keys)
 
None _async_shutdown_dmr (self)
 
None _async_startup_app_list (self)
 
None _async_startup_dmr (self)
 
None _handle_coordinator_update (self)
 
None _on_upnp_event (self, UpnpService service, Sequence[UpnpStateVariable] state_variables)
 
bool _update_from_upnp (self)
 
None _update_sources (self)
 

Private Attributes

 _app_list
 
 _attr_is_volume_muted
 
 _attr_source_list
 
 _attr_state
 
 _attr_supported_features
 
 _attr_volume_level
 
 _dmr_device
 
 _playing
 
 _upnp_server
 

Static Private Attributes

 _attr_device_class = MediaPlayerDeviceClass.TV
 
 _attr_name = None
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.samsungtv.coordinator.SamsungTVDataUpdateCoordinator
 bridge
 
 is_on
 
- Public Attributes inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
 always_update
 
 config_entry
 
 data
 
 hass
 
 last_exception
 
 last_update_success
 
 logger
 
 name
 
 setup_method
 
 update_interval
 
 update_method
 
- 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 Samsung TV.

Definition at line 74 of file media_player.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.samsungtv.media_player.SamsungTVDevice.__init__ (   self,
SamsungTVDataUpdateCoordinator  coordinator 
)
Initialize the Samsung device.

Definition at line 81 of file media_player.py.

Member Function Documentation

◆ _app_list_callback()

None homeassistant.components.samsungtv.media_player.SamsungTVDevice._app_list_callback (   self,
dict[str, str app_list 
)
private
App list callback.

Definition at line 122 of file media_player.py.

◆ _async_extra_update()

None homeassistant.components.samsungtv.media_player.SamsungTVDevice._async_extra_update (   self)
private
Update state of device.

Definition at line 154 of file media_player.py.

◆ _async_launch_app()

None homeassistant.components.samsungtv.media_player.SamsungTVDevice._async_launch_app (   self,
str  app_id 
)
private
Send launch_app to the tv.

Definition at line 284 of file media_player.py.

◆ _async_resubscribe_dmr()

None homeassistant.components.samsungtv.media_player.SamsungTVDevice._async_resubscribe_dmr (   self)
private

Definition at line 258 of file media_player.py.

◆ _async_send_keys()

None homeassistant.components.samsungtv.media_player.SamsungTVDevice._async_send_keys (   self,
list[str keys 
)
private
Send a key to the tv and handles exceptions.

Definition at line 292 of file media_player.py.

◆ _async_shutdown_dmr()

None homeassistant.components.samsungtv.media_player.SamsungTVDevice._async_shutdown_dmr (   self)
private
Handle removal.

Definition at line 265 of file media_player.py.

◆ _async_startup_app_list()

None homeassistant.components.samsungtv.media_player.SamsungTVDevice._async_startup_app_list (   self)
private

Definition at line 198 of file media_player.py.

◆ _async_startup_dmr()

None homeassistant.components.samsungtv.media_player.SamsungTVDevice._async_startup_dmr (   self)
private

Definition at line 212 of file media_player.py.

◆ _handle_coordinator_update()

None homeassistant.components.samsungtv.media_player.SamsungTVDevice._handle_coordinator_update (   self)
private
Handle data update.

Definition at line 145 of file media_player.py.

◆ _on_upnp_event()

None homeassistant.components.samsungtv.media_player.SamsungTVDevice._on_upnp_event (   self,
UpnpService  service,
Sequence[UpnpStateVariable]   state_variables 
)
private
State variable(s) changed, let home-assistant know.

Definition at line 276 of file media_player.py.

◆ _update_from_upnp()

bool homeassistant.components.samsungtv.media_player.SamsungTVDevice._update_from_upnp (   self)
private

Definition at line 175 of file media_player.py.

◆ _update_sources()

None homeassistant.components.samsungtv.media_player.SamsungTVDevice._update_sources (   self)
private

Definition at line 117 of file media_player.py.

◆ async_added_to_hass()

None homeassistant.components.samsungtv.media_player.SamsungTVDevice.async_added_to_hass (   self)
Run when entity about to be added to hass.

Reimplemented from homeassistant.components.samsungtv.entity.SamsungTVEntity.

Definition at line 128 of file media_player.py.

◆ async_media_next_track()

None homeassistant.components.samsungtv.media_player.SamsungTVDevice.async_media_next_track (   self)
Send next track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 343 of file media_player.py.

◆ async_media_pause()

None homeassistant.components.samsungtv.media_player.SamsungTVDevice.async_media_pause (   self)
Send media pause command to media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 338 of file media_player.py.

◆ async_media_play()

None homeassistant.components.samsungtv.media_player.SamsungTVDevice.async_media_play (   self)
Send play command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 333 of file media_player.py.

◆ async_media_play_pause()

None homeassistant.components.samsungtv.media_player.SamsungTVDevice.async_media_play_pause (   self)
Simulate play pause media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 326 of file media_player.py.

◆ async_media_previous_track()

None homeassistant.components.samsungtv.media_player.SamsungTVDevice.async_media_previous_track (   self)
Send the previous track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 347 of file media_player.py.

◆ async_mute_volume()

None homeassistant.components.samsungtv.media_player.SamsungTVDevice.async_mute_volume (   self,
bool  mute 
)
Send mute command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 322 of file media_player.py.

◆ async_play_media()

None homeassistant.components.samsungtv.media_player.SamsungTVDevice.async_play_media (   self,
MediaType | str  media_type,
str  media_id,
**Any   kwargs 
)
Support changing a channel.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 351 of file media_player.py.

◆ async_select_source()

None homeassistant.components.samsungtv.media_player.SamsungTVDevice.async_select_source (   self,
str  source 
)
Select input source.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 378 of file media_player.py.

◆ async_set_volume_level()

None homeassistant.components.samsungtv.media_player.SamsungTVDevice.async_set_volume_level (   self,
float  volume 
)
Set volume level on the media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 304 of file media_player.py.

◆ async_turn_off()

None homeassistant.components.samsungtv.media_player.SamsungTVDevice.async_turn_off (   self)
Turn off media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 300 of file media_player.py.

◆ async_turn_on()

None homeassistant.components.samsungtv.media_player.SamsungTVDevice.async_turn_on (   self)
Turn the media player on.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 374 of file media_player.py.

◆ async_volume_down()

None homeassistant.components.samsungtv.media_player.SamsungTVDevice.async_volume_down (   self)
Volume down media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 318 of file media_player.py.

◆ async_volume_up()

None homeassistant.components.samsungtv.media_player.SamsungTVDevice.async_volume_up (   self)
Volume up the media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 314 of file media_player.py.

◆ async_will_remove_from_hass()

None homeassistant.components.samsungtv.media_player.SamsungTVDevice.async_will_remove_from_hass (   self)
Handle removal.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 139 of file media_player.py.

◆ supported_features()

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

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 109 of file media_player.py.

Member Data Documentation

◆ _app_list

homeassistant.components.samsungtv.media_player.SamsungTVDevice._app_list
private

Definition at line 124 of file media_player.py.

◆ _attr_device_class

homeassistant.components.samsungtv.media_player.SamsungTVDevice._attr_device_class = MediaPlayerDeviceClass.TV
staticprivate

Definition at line 79 of file media_player.py.

◆ _attr_is_volume_muted

homeassistant.components.samsungtv.media_player.SamsungTVDevice._attr_is_volume_muted
private

Definition at line 193 of file media_player.py.

◆ _attr_name

homeassistant.components.samsungtv.media_player.SamsungTVDevice._attr_name = None
staticprivate

Definition at line 78 of file media_player.py.

◆ _attr_source_list

homeassistant.components.samsungtv.media_player.SamsungTVDevice._attr_source_list
private

Definition at line 91 of file media_player.py.

◆ _attr_state

homeassistant.components.samsungtv.media_player.SamsungTVDevice._attr_state
private

Definition at line 134 of file media_player.py.

◆ _attr_supported_features

homeassistant.components.samsungtv.media_player.SamsungTVDevice._attr_supported_features
private

Definition at line 95 of file media_player.py.

◆ _attr_volume_level

homeassistant.components.samsungtv.media_player.SamsungTVDevice._attr_volume_level
private

Definition at line 187 of file media_player.py.

◆ _dmr_device

homeassistant.components.samsungtv.media_player.SamsungTVDevice._dmr_device
private

Definition at line 240 of file media_player.py.

◆ _playing

homeassistant.components.samsungtv.media_player.SamsungTVDevice._playing
private

Definition at line 335 of file media_player.py.

◆ _upnp_server

homeassistant.components.samsungtv.media_player.SamsungTVDevice._upnp_server
private

Definition at line 233 of file media_player.py.


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