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

Public Member Functions

None __init__ (self, ConfigEntry config, str name, str host, str region, pyps4.Ps4Async ps4, str creds)
 
None add_games (self, str|None title_id, str|None app_name, str|None image, str|None g_type, bool is_locked=False)
 
None async_added_to_hass (self)
 
None async_get_device_info (self, dict[str, Any]|None status)
 
None async_get_title_data (self, str title_id, str name)
 
None async_media_pause (self)
 
None async_media_stop (self)
 
None async_select_source (self, str source)
 
None async_send_command (self, str command)
 
None async_send_remote_control (self, str command)
 
None async_toggle (self)
 
None async_turn_off (self)
 
None async_turn_on (self)
 
None async_update (self)
 
None async_will_remove_from_hass (self)
 
None check_region (self)
 
str|None entity_picture (self)
 
None get_source_list (self)
 
None idle (self)
 
str|None media_image_url (self)
 
None reset_title (self)
 
None state_standby (self)
 
None state_unknown (self)
 
None status_callback (self)
 
None subscribe_to_protocol (self)
 
None unsubscribe_to_protocol (self)
 
None update_list (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_play (self)
 
None async_media_play_pause (self)
 
None async_media_previous_track (self)
 
None async_media_seek (self, float position)
 
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_set_repeat (self, RepeatMode repeat)
 
None async_set_shuffle (self, bool shuffle)
 
None async_set_volume_level (self, float volume)
 
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 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)
 
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)
 
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 Attributes

 entity_id
 
 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

None _parse_status (self)
 
bool _use_saved (self)
 

Private Attributes

 _attr_device_info
 
 _attr_media_content_id
 
 _attr_media_content_type
 
 _attr_media_title
 
 _attr_name
 
 _attr_source
 
 _attr_source_list
 
 _attr_state
 
 _attr_unique_id
 
 _creds
 
 _disconnected
 
 _entry_id
 
 _games
 
 _host
 
 _media_image
 
 _ps4
 
 _region
 
 _retry
 

Static Private Attributes

tuple _attr_supported_features
 
string _attr_translation_key = "media_player"
 

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 PS4.

Definition at line 66 of file media_player.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.ps4.media_player.PS4Device.__init__ (   self,
ConfigEntry  config,
str  name,
str  host,
str  region,
pyps4.Ps4Async  ps4,
str  creds 
)
Initialize the ps4 device.

Definition at line 78 of file media_player.py.

Member Function Documentation

◆ _parse_status()

None homeassistant.components.ps4.media_player.PS4Device._parse_status (   self)
private
Parse status.

Definition at line 161 of file media_player.py.

◆ _use_saved()

bool homeassistant.components.ps4.media_player.PS4Device._use_saved (   self)
private
Return True, Set media attrs if data is locked.

Definition at line 202 of file media_player.py.

◆ add_games()

None homeassistant.components.ps4.media_player.PS4Device.add_games (   self,
str | None  title_id,
str | None  app_name,
str | None  image,
str | None  g_type,
bool   is_locked = False 
)
Add games to list.

Definition at line 316 of file media_player.py.

◆ async_added_to_hass()

None homeassistant.components.ps4.media_player.PS4Device.async_added_to_hass (   self)
Subscribe PS4 events.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 128 of file media_player.py.

◆ async_get_device_info()

None homeassistant.components.ps4.media_player.PS4Device.async_get_device_info (   self,
dict[str, Any] | None  status 
)
Set device info for registry.

Definition at line 338 of file media_player.py.

◆ async_get_title_data()

None homeassistant.components.ps4.media_player.PS4Device.async_get_title_data (   self,
str  title_id,
str  name 
)
Get PS Store Data.

Definition at line 244 of file media_player.py.

◆ async_media_pause()

None homeassistant.components.ps4.media_player.PS4Device.async_media_pause (   self)
Send keypress ps to return to menu.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 419 of file media_player.py.

◆ async_media_stop()

None homeassistant.components.ps4.media_player.PS4Device.async_media_stop (   self)
Send keypress ps to return to menu.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 423 of file media_player.py.

◆ async_select_source()

None homeassistant.components.ps4.media_player.PS4Device.async_select_source (   self,
str  source 
)
Select input source.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 427 of file media_player.py.

◆ async_send_command()

None homeassistant.components.ps4.media_player.PS4Device.async_send_command (   self,
str  command 
)
Send Button Command.

Definition at line 447 of file media_player.py.

◆ async_send_remote_control()

None homeassistant.components.ps4.media_player.PS4Device.async_send_remote_control (   self,
str  command 
)
Send RC command.

Definition at line 451 of file media_player.py.

◆ async_toggle()

None homeassistant.components.ps4.media_player.PS4Device.async_toggle (   self)
Toggle media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 415 of file media_player.py.

◆ async_turn_off()

None homeassistant.components.ps4.media_player.PS4Device.async_turn_off (   self)
Turn off media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 407 of file media_player.py.

◆ async_turn_on()

None homeassistant.components.ps4.media_player.PS4Device.async_turn_on (   self)
Turn on the media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 411 of file media_player.py.

◆ async_update()

None homeassistant.components.ps4.media_player.PS4Device.async_update (   self)
Retrieve the latest data.

Definition at line 133 of file media_player.py.

◆ async_will_remove_from_hass()

None homeassistant.components.ps4.media_player.PS4Device.async_will_remove_from_hass (   self)
Remove Entity from Home Assistant.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 378 of file media_player.py.

◆ check_region()

None homeassistant.components.ps4.media_player.PS4Device.check_region (   self)
Display logger msg if region is deprecated.

Definition at line 116 of file media_player.py.

◆ entity_picture()

str | None homeassistant.components.ps4.media_player.PS4Device.entity_picture (   self)
Return picture.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 387 of file media_player.py.

◆ get_source_list()

None homeassistant.components.ps4.media_player.PS4Device.get_source_list (   self)
Parse data entry and update source list.

Definition at line 308 of file media_player.py.

◆ idle()

None homeassistant.components.ps4.media_player.PS4Device.idle (   self)
Set states for state idle.

Definition at line 218 of file media_player.py.

◆ media_image_url()

str | None homeassistant.components.ps4.media_player.PS4Device.media_image_url (   self)
Image url of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 401 of file media_player.py.

◆ reset_title()

None homeassistant.components.ps4.media_player.PS4Device.reset_title (   self)
Update if there is no title.

Definition at line 237 of file media_player.py.

◆ state_standby()

None homeassistant.components.ps4.media_player.PS4Device.state_standby (   self)
Set states for state standby.

Definition at line 223 of file media_player.py.

◆ state_unknown()

None homeassistant.components.ps4.media_player.PS4Device.state_unknown (   self)
Set states for state unknown.

Definition at line 228 of file media_player.py.

◆ status_callback()

None homeassistant.components.ps4.media_player.PS4Device.status_callback (   self)
Handle status callback. Parse status.

Definition at line 99 of file media_player.py.

◆ subscribe_to_protocol()

None homeassistant.components.ps4.media_player.PS4Device.subscribe_to_protocol (   self)
Notify protocol to callback with update changes.

Definition at line 105 of file media_player.py.

◆ unsubscribe_to_protocol()

None homeassistant.components.ps4.media_player.PS4Device.unsubscribe_to_protocol (   self)
Notify protocol to remove callback.

Definition at line 110 of file media_player.py.

◆ update_list()

None homeassistant.components.ps4.media_player.PS4Device.update_list (   self)
Update Game List, Correct data if different.

Definition at line 286 of file media_player.py.

Member Data Documentation

◆ _attr_device_info

homeassistant.components.ps4.media_player.PS4Device._attr_device_info
private

Definition at line 355 of file media_player.py.

◆ _attr_media_content_id

homeassistant.components.ps4.media_player.PS4Device._attr_media_content_id
private

Definition at line 179 of file media_player.py.

◆ _attr_media_content_type

homeassistant.components.ps4.media_player.PS4Device._attr_media_content_type
private

Definition at line 186 of file media_player.py.

◆ _attr_media_title

homeassistant.components.ps4.media_player.PS4Device._attr_media_title
private

Definition at line 184 of file media_player.py.

◆ _attr_name

homeassistant.components.ps4.media_player.PS4Device._attr_name
private

Definition at line 91 of file media_player.py.

◆ _attr_source

homeassistant.components.ps4.media_player.PS4Device._attr_source
private

Definition at line 185 of file media_player.py.

◆ _attr_source_list

homeassistant.components.ps4.media_player.PS4Device._attr_source_list
private

Definition at line 314 of file media_player.py.

◆ _attr_state

homeassistant.components.ps4.media_player.PS4Device._attr_state
private

Definition at line 176 of file media_player.py.

◆ _attr_supported_features

tuple homeassistant.components.ps4.media_player.PS4Device._attr_supported_features
staticprivate
Initial value:
= (
MediaPlayerEntityFeature.TURN_OFF
| MediaPlayerEntityFeature.TURN_ON
| MediaPlayerEntityFeature.PAUSE
| MediaPlayerEntityFeature.STOP
| MediaPlayerEntityFeature.SELECT_SOURCE
)

Definition at line 69 of file media_player.py.

◆ _attr_translation_key

string homeassistant.components.ps4.media_player.PS4Device._attr_translation_key = "media_player"
staticprivate

Definition at line 76 of file media_player.py.

◆ _attr_unique_id

homeassistant.components.ps4.media_player.PS4Device._attr_unique_id
private

Definition at line 349 of file media_player.py.

◆ _creds

homeassistant.components.ps4.media_player.PS4Device._creds
private

Definition at line 93 of file media_player.py.

◆ _disconnected

homeassistant.components.ps4.media_player.PS4Device._disconnected
private

Definition at line 97 of file media_player.py.

◆ _entry_id

homeassistant.components.ps4.media_player.PS4Device._entry_id
private

Definition at line 88 of file media_player.py.

◆ _games

homeassistant.components.ps4.media_player.PS4Device._games
private

Definition at line 165 of file media_player.py.

◆ _host

homeassistant.components.ps4.media_player.PS4Device._host
private

Definition at line 90 of file media_player.py.

◆ _media_image

homeassistant.components.ps4.media_player.PS4Device._media_image
private

Definition at line 211 of file media_player.py.

◆ _ps4

homeassistant.components.ps4.media_player.PS4Device._ps4
private

Definition at line 89 of file media_player.py.

◆ _region

homeassistant.components.ps4.media_player.PS4Device._region
private

Definition at line 92 of file media_player.py.

◆ _retry

homeassistant.components.ps4.media_player.PS4Device._retry
private

Definition at line 96 of file media_player.py.

◆ entity_id

homeassistant.components.ps4.media_player.PS4Device.entity_id

Definition at line 350 of file media_player.py.

◆ state

homeassistant.components.ps4.media_player.PS4Device.state

Definition at line 390 of file media_player.py.


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