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

Public Member Functions

None __init__ (self, *DIRECTV dtv, str name, str address="0")
 
None async_media_next_track (self)
 
None async_media_pause (self)
 
None async_media_play (self)
 
None async_media_previous_track (self)
 
None async_media_stop (self)
 
None async_play_media (self, MediaType|str media_type, str media_id, **Any kwargs)
 
None async_turn_off (self)
 
None async_turn_on (self)
 
None async_update (self)
 
def extra_state_attributes (self)
 
def media_album_name (self)
 
def media_artist (self)
 
def media_channel (self)
 
def media_content_id (self)
 
MediaType|None media_content_type (self)
 
def media_currently_recording (self)
 
def media_duration (self)
 
def media_position (self)
 
def media_position_updated_at (self)
 
def media_rating (self)
 
def media_recorded (self)
 
def media_series_title (self)
 
def media_start_time (self)
 
def media_title (self)
 
def source (self)
 
MediaPlayerState state (self)
 
MediaPlayerEntityFeature supported_features (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)
 
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_play_pause (self)
 
None async_media_seek (self, float position)
 
None async_mute_volume (self, bool mute)
 
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_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_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)
 
None media_previous_track (self)
 
str|None media_season (self)
 
None media_seek (self, float position)
 
None media_stop (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)
 
list[str]|None source_list (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

 media_content_type
 
- Public Attributes inherited from homeassistant.components.directv.entity.DIRECTVEntity
 dtv
 
- 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 Attributes

 _attr_assumed_state
 
 _attr_available
 
 _attr_device_class
 
 _attr_unique_id
 
 _is_recorded
 
 _is_standby
 
 _last_position
 
 _last_update
 
 _paused
 
 _program
 

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 DirecTV receiver on the network.

Definition at line 77 of file media_player.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.directv.media_player.DIRECTVMediaPlayer.__init__ (   self,
*DIRECTV  dtv,
str  name,
str   address = "0" 
)
Initialize DirecTV media player.

Reimplemented from homeassistant.components.directv.entity.DIRECTVEntity.

Definition at line 80 of file media_player.py.

Member Function Documentation

◆ async_media_next_track()

None homeassistant.components.directv.media_player.DIRECTVMediaPlayer.async_media_next_track (   self)
Send fast forward command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 314 of file media_player.py.

◆ async_media_pause()

None homeassistant.components.directv.media_player.DIRECTVMediaPlayer.async_media_pause (   self)
Send pause command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 299 of file media_player.py.

◆ async_media_play()

None homeassistant.components.directv.media_player.DIRECTVMediaPlayer.async_media_play (   self)
Send play command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 294 of file media_player.py.

◆ async_media_previous_track()

None homeassistant.components.directv.media_player.DIRECTVMediaPlayer.async_media_previous_track (   self)
Send rewind command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 309 of file media_player.py.

◆ async_media_stop()

None homeassistant.components.directv.media_player.DIRECTVMediaPlayer.async_media_stop (   self)
Send stop command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 304 of file media_player.py.

◆ async_play_media()

None homeassistant.components.directv.media_player.DIRECTVMediaPlayer.async_play_media (   self,
MediaType | str  media_type,
str  media_id,
**Any   kwargs 
)
Select input source.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 319 of file media_player.py.

◆ async_turn_off()

None homeassistant.components.directv.media_player.DIRECTVMediaPlayer.async_turn_off (   self)
Turn off the receiver.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 286 of file media_player.py.

◆ async_turn_on()

None homeassistant.components.directv.media_player.DIRECTVMediaPlayer.async_turn_on (   self)
Turn on the receiver.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 278 of file media_player.py.

◆ async_update()

None homeassistant.components.directv.media_player.DIRECTVMediaPlayer.async_update (   self)
Retrieve latest state.

Definition at line 99 of file media_player.py.

◆ extra_state_attributes()

def homeassistant.components.directv.media_player.DIRECTVMediaPlayer.extra_state_attributes (   self)
Return device specific state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 121 of file media_player.py.

◆ media_album_name()

def homeassistant.components.directv.media_player.DIRECTVMediaPlayer.media_album_name (   self)
Album name of current playing media, music track only.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 210 of file media_player.py.

◆ media_artist()

def homeassistant.components.directv.media_player.DIRECTVMediaPlayer.media_artist (   self)
Artist of current playing media, music track only.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 202 of file media_player.py.

◆ media_channel()

def homeassistant.components.directv.media_player.DIRECTVMediaPlayer.media_channel (   self)
Return the channel current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 226 of file media_player.py.

◆ media_content_id()

def homeassistant.components.directv.media_player.DIRECTVMediaPlayer.media_content_id (   self)
Return the content ID of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 148 of file media_player.py.

◆ media_content_type()

MediaType | None homeassistant.components.directv.media_player.DIRECTVMediaPlayer.media_content_type (   self)
Return the content type of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 156 of file media_player.py.

◆ media_currently_recording()

def homeassistant.components.directv.media_player.DIRECTVMediaPlayer.media_currently_recording (   self)
If the media is currently being recorded or not.

Definition at line 247 of file media_player.py.

◆ media_duration()

def homeassistant.components.directv.media_player.DIRECTVMediaPlayer.media_duration (   self)
Return the duration of current playing media in seconds.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 167 of file media_player.py.

◆ media_position()

def homeassistant.components.directv.media_player.DIRECTVMediaPlayer.media_position (   self)
Position of current playing media in seconds.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 175 of file media_player.py.

◆ media_position_updated_at()

def homeassistant.components.directv.media_player.DIRECTVMediaPlayer.media_position_updated_at (   self)
When was the position of the current playing media valid.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 183 of file media_player.py.

◆ media_rating()

def homeassistant.components.directv.media_player.DIRECTVMediaPlayer.media_rating (   self)
TV Rating of the current playing media.

Definition at line 255 of file media_player.py.

◆ media_recorded()

def homeassistant.components.directv.media_player.DIRECTVMediaPlayer.media_recorded (   self)
If the media was recorded or live.

Definition at line 263 of file media_player.py.

◆ media_series_title()

def homeassistant.components.directv.media_player.DIRECTVMediaPlayer.media_series_title (   self)
Return the title of current episode of TV show.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 218 of file media_player.py.

◆ media_start_time()

def homeassistant.components.directv.media_player.DIRECTVMediaPlayer.media_start_time (   self)
Start time the program aired.

Definition at line 271 of file media_player.py.

◆ media_title()

def homeassistant.components.directv.media_player.DIRECTVMediaPlayer.media_title (   self)
Return the title of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 191 of file media_player.py.

◆ source()

def homeassistant.components.directv.media_player.DIRECTVMediaPlayer.source (   self)
Name of the current input source.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 234 of file media_player.py.

◆ state()

MediaPlayerState homeassistant.components.directv.media_player.DIRECTVMediaPlayer.state (   self)
Return the state of the device.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 134 of file media_player.py.

◆ supported_features()

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

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 242 of file media_player.py.

Member Data Documentation

◆ _attr_assumed_state

homeassistant.components.directv.media_player.DIRECTVMediaPlayer._attr_assumed_state
private

Definition at line 107 of file media_player.py.

◆ _attr_available

homeassistant.components.directv.media_player.DIRECTVMediaPlayer._attr_available
private

Definition at line 90 of file media_player.py.

◆ _attr_device_class

homeassistant.components.directv.media_player.DIRECTVMediaPlayer._attr_device_class
private

Definition at line 89 of file media_player.py.

◆ _attr_unique_id

homeassistant.components.directv.media_player.DIRECTVMediaPlayer._attr_unique_id
private

Definition at line 88 of file media_player.py.

◆ _is_recorded

homeassistant.components.directv.media_player.DIRECTVMediaPlayer._is_recorded
private

Definition at line 92 of file media_player.py.

◆ _is_standby

homeassistant.components.directv.media_player.DIRECTVMediaPlayer._is_standby
private

Definition at line 93 of file media_player.py.

◆ _last_position

homeassistant.components.directv.media_player.DIRECTVMediaPlayer._last_position
private

Definition at line 94 of file media_player.py.

◆ _last_update

homeassistant.components.directv.media_player.DIRECTVMediaPlayer._last_update
private

Definition at line 95 of file media_player.py.

◆ _paused

homeassistant.components.directv.media_player.DIRECTVMediaPlayer._paused
private

Definition at line 96 of file media_player.py.

◆ _program

homeassistant.components.directv.media_player.DIRECTVMediaPlayer._program
private

Definition at line 97 of file media_player.py.

◆ media_content_type

homeassistant.components.directv.media_player.DIRECTVMediaPlayer.media_content_type

Definition at line 196 of file media_player.py.


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