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

Public Member Functions

def __init__ (self, client, name, remote_keys)
 
None media_next_track (self)
 
None media_pause (self)
 
None media_play (self)
 
None media_play_pause (self)
 
None media_previous_track (self)
 
def name (self)
 
None play_media (self, MediaType|str media_type, str media_id, **Any kwargs)
 
None turn_off (self)
 
None turn_on (self)
 
None update (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)
 
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)
 
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)
 
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 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_added_to_hass (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)
 
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 Member Functions

def _select_channel (self, channel)
 
def _send (self, key=None, channel=None)
 
def _send_key (self, key)
 

Private Attributes

 _attr_state
 
 _client
 
 _keys
 
 _name
 

Static Private Attributes

tuple _attr_supported_features
 

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

Representation of a Horizon HD Recorder.

Definition at line 73 of file media_player.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.horizon.media_player.HorizonDevice.__init__ (   self,
  client,
  name,
  remote_keys 
)
Initialize the remote.

Definition at line 86 of file media_player.py.

Member Function Documentation

◆ _select_channel()

def homeassistant.components.horizon.media_player.HorizonDevice._select_channel (   self,
  channel 
)
private
Select a channel (taken from einder library, thx).

Definition at line 163 of file media_player.py.

◆ _send()

def homeassistant.components.horizon.media_player.HorizonDevice._send (   self,
  key = None,
  channel = None 
)
private
Send a key to the Horizon device.

Definition at line 171 of file media_player.py.

◆ _send_key()

def homeassistant.components.horizon.media_player.HorizonDevice._send_key (   self,
  key 
)
private
Send a key to the Horizon device.

Definition at line 167 of file media_player.py.

◆ media_next_track()

None homeassistant.components.horizon.media_player.HorizonDevice.media_next_track (   self)
Channel up.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 123 of file media_player.py.

◆ media_pause()

None homeassistant.components.horizon.media_player.HorizonDevice.media_pause (   self)
Send pause command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 133 of file media_player.py.

◆ media_play()

None homeassistant.components.horizon.media_player.HorizonDevice.media_play (   self)
Send play command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 128 of file media_player.py.

◆ media_play_pause()

None homeassistant.components.horizon.media_player.HorizonDevice.media_play_pause (   self)
Send play/pause command.

Definition at line 138 of file media_player.py.

◆ media_previous_track()

None homeassistant.components.horizon.media_player.HorizonDevice.media_previous_track (   self)
Channel down.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 118 of file media_player.py.

◆ name()

def homeassistant.components.horizon.media_player.HorizonDevice.name (   self)
Return the name of the remote.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 93 of file media_player.py.

◆ play_media()

None homeassistant.components.horizon.media_player.HorizonDevice.play_media (   self,
MediaType | str  media_type,
str  media_id,
**Any   kwargs 
)
Play media / switch to channel.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 146 of file media_player.py.

◆ turn_off()

None homeassistant.components.horizon.media_player.HorizonDevice.turn_off (   self)
Turn the device off.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 113 of file media_player.py.

◆ turn_on()

None homeassistant.components.horizon.media_player.HorizonDevice.turn_on (   self)
Turn the device on.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 108 of file media_player.py.

◆ update()

None homeassistant.components.horizon.media_player.HorizonDevice.update (   self)
Update State using the media server running on the Horizon.

Definition at line 98 of file media_player.py.

Member Data Documentation

◆ _attr_state

homeassistant.components.horizon.media_player.HorizonDevice._attr_state
private

Definition at line 102 of file media_player.py.

◆ _attr_supported_features

tuple homeassistant.components.horizon.media_player.HorizonDevice._attr_supported_features
staticprivate
Initial value:
= (
MediaPlayerEntityFeature.NEXT_TRACK
| MediaPlayerEntityFeature.PAUSE
| MediaPlayerEntityFeature.PLAY
| MediaPlayerEntityFeature.PLAY_MEDIA
| MediaPlayerEntityFeature.PREVIOUS_TRACK
| MediaPlayerEntityFeature.TURN_ON
| MediaPlayerEntityFeature.TURN_OFF
)

Definition at line 76 of file media_player.py.

◆ _client

homeassistant.components.horizon.media_player.HorizonDevice._client
private

Definition at line 88 of file media_player.py.

◆ _keys

homeassistant.components.horizon.media_player.HorizonDevice._keys
private

Definition at line 90 of file media_player.py.

◆ _name

homeassistant.components.horizon.media_player.HorizonDevice._name
private

Definition at line 89 of file media_player.py.

◆ state

homeassistant.components.horizon.media_player.HorizonDevice.state

Definition at line 110 of file media_player.py.


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