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

Public Member Functions

None __init__ (self, PhilipsTVDataUpdateCoordinator coordinator)
 
None async_added_to_hass (self)
 
BrowseMedia async_browse_media (self, MediaType|str|None media_content_type=None, str|None media_content_id=None)
 
def async_browse_media_applications (self, expanded)
 
BrowseMedia async_browse_media_channels (self, bool expanded)
 
def async_browse_media_favorite_lists (self, expanded)
 
BrowseMedia async_browse_media_favorites (self, str list_id, bool expanded)
 
def async_browse_media_root (self)
 
tuple[bytes|None, str|Noneasync_get_browse_image (self, MediaType|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_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_stop (self)
 
None async_mute_volume (self, bool mute)
 
None async_play_media (self, MediaType|str media_type, str media_id, **Any kwargs)
 
def async_play_media_channel (self, str media_id)
 
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)
 
str|None media_image_url (self)
 
MediaPlayerEntityFeature supported_features (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.components.philips_js.coordinator.PhilipsTVDataUpdateCoordinator
None __init__ (self, HomeAssistant hass, PhilipsTV api, Mapping[str, Any] options)
 
DeviceInfo device_info (self)
 
SystemType system (self)
 
str unique_id (self)
 
- 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.components.media_player.MediaPlayerEntity
str access_token (self)
 
str|None app_id (self)
 
str|None app_name (self)
 
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)
 
None async_join_players (self, list[str] group_members)
 
None async_media_seek (self, float position)
 
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)
 
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)
 
- 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_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)
 
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)
 

Private Member Functions

def _async_update_soon (self)
 
None _handle_coordinator_update (self)
 
def _update_from_coordinator (self)
 

Private Attributes

 _attr_app_id
 
 _attr_app_name
 
 _attr_assumed_state
 
 _attr_is_volume_muted
 
 _attr_media_channel
 
 _attr_media_content_id
 
 _attr_media_content_type
 
 _attr_media_title
 
 _attr_source
 
 _attr_source_list
 
 _attr_state
 
 _attr_unique_id
 
 _attr_volume_level
 
 _sources
 
 _turn_on
 
 _tv
 

Static Private Attributes

 _attr_device_class = MediaPlayerDeviceClass.TV
 
 _attr_name = None
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.philips_js.coordinator.PhilipsTVDataUpdateCoordinator
 api
 
 options
 
- 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.components.media_player.MediaPlayerEntity
 state
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- 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 Philips TV exposing the JointSpace API.

Definition at line 65 of file media_player.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer.__init__ (   self,
PhilipsTVDataUpdateCoordinator  coordinator 
)
Initialize the Philips TV.

Reimplemented from homeassistant.components.philips_js.entity.PhilipsJsEntity.

Definition at line 71 of file media_player.py.

Member Function Documentation

◆ _async_update_soon()

def homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer._async_update_soon (   self)
private
Reschedule update task.

Definition at line 96 of file media_player.py.

◆ _handle_coordinator_update()

None homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer._handle_coordinator_update (   self)
private
Handle updated data from the coordinator.

Definition at line 478 of file media_player.py.

◆ _update_from_coordinator()

def homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer._update_from_coordinator (   self)
private

Definition at line 429 of file media_player.py.

◆ async_added_to_hass()

None homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer.async_added_to_hass (   self)
Handle being added to hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 85 of file media_player.py.

◆ async_browse_media()

BrowseMedia homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer.async_browse_media (   self,
MediaType | str | None   media_content_type = None,
str | None   media_content_id = None 
)
Implement the websocket media browsing helper.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 381 of file media_player.py.

◆ async_browse_media_applications()

def homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer.async_browse_media_applications (   self,
  expanded 
)
Return application media objects.

Definition at line 312 of file media_player.py.

◆ async_browse_media_channels()

BrowseMedia homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer.async_browse_media_channels (   self,
bool  expanded 
)
Return channel media objects.

Definition at line 242 of file media_player.py.

◆ async_browse_media_favorite_lists()

def homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer.async_browse_media_favorite_lists (   self,
  expanded 
)
Return favorite media objects.

Definition at line 343 of file media_player.py.

◆ async_browse_media_favorites()

BrowseMedia homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer.async_browse_media_favorites (   self,
str  list_id,
bool   expanded 
)
Return channel media objects.

Definition at line 270 of file media_player.py.

◆ async_browse_media_root()

def homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer.async_browse_media_root (   self)
Return root media objects.

Definition at line 364 of file media_player.py.

◆ async_get_browse_image()

tuple[bytes | None, str | None] homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer.async_get_browse_image (   self,
MediaType | str  media_content_type,
str  media_content_id,
str | None   media_image_id = None 
)
Serve album art. Returns (content, content_type).

Definition at line 404 of file media_player.py.

◆ async_get_media_image()

tuple[bytes | None, str | None] homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer.async_get_media_image (   self)
Serve album art. Returns (content, content_type).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 420 of file media_player.py.

◆ async_media_next_track()

None homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer.async_media_next_track (   self)
Send fast forward command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 164 of file media_player.py.

◆ async_media_pause()

None homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer.async_media_pause (   self)
Send play command to media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 185 of file media_player.py.

◆ async_media_play()

None homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer.async_media_play (   self)
Send pause command to media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 180 of file media_player.py.

◆ async_media_play_pause()

None homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer.async_media_play_pause (   self)
Send pause command to media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 172 of file media_player.py.

◆ async_media_previous_track()

None homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer.async_media_previous_track (   self)
Send rewind command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 156 of file media_player.py.

◆ async_media_stop()

None homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer.async_media_stop (   self)
Send play command to media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 190 of file media_player.py.

◆ async_mute_volume()

None homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer.async_mute_volume (   self,
bool  mute 
)
Send mute command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 143 of file media_player.py.

◆ async_play_media()

None homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer.async_play_media (   self,
MediaType | str  media_type,
str  media_id,
**Any   kwargs 
)
Play a piece of media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 225 of file media_player.py.

◆ async_play_media_channel()

def homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer.async_play_media_channel (   self,
str  media_id 
)
Play a channel.

Definition at line 209 of file media_player.py.

◆ async_select_source()

None homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer.async_select_source (   self,
str  source 
)
Set the input source.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 109 of file media_player.py.

◆ async_set_volume_level()

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

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 151 of file media_player.py.

◆ async_turn_off()

None homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer.async_turn_off (   self)
Turn off the device.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 124 of file media_player.py.

◆ async_turn_on()

None homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer.async_turn_on (   self)
Turn on the device.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 115 of file media_player.py.

◆ async_volume_down()

None homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer.async_volume_down (   self)
Send volume down command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 138 of file media_player.py.

◆ async_volume_up()

None homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer.async_volume_up (   self)
Send volume up command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 133 of file media_player.py.

◆ media_image_url()

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

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 196 of file media_player.py.

◆ supported_features()

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

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 102 of file media_player.py.

Member Data Documentation

◆ _attr_app_id

homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer._attr_app_id
private

Definition at line 446 of file media_player.py.

◆ _attr_app_name

homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer._attr_app_name
private

Definition at line 448 of file media_player.py.

◆ _attr_assumed_state

homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer._attr_assumed_state
private

Definition at line 475 of file media_player.py.

◆ _attr_device_class

homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer._attr_device_class = MediaPlayerDeviceClass.TV
staticprivate

Definition at line 68 of file media_player.py.

◆ _attr_is_volume_muted

homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer._attr_is_volume_muted
private

Definition at line 453 of file media_player.py.

◆ _attr_media_channel

homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer._attr_media_channel
private

Definition at line 461 of file media_player.py.

◆ _attr_media_content_id

homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer._attr_media_content_id
private

Definition at line 457 of file media_player.py.

◆ _attr_media_content_type

homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer._attr_media_content_type
private

Definition at line 456 of file media_player.py.

◆ _attr_media_title

homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer._attr_media_title
private

Definition at line 458 of file media_player.py.

◆ _attr_name

homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer._attr_name = None
staticprivate

Definition at line 69 of file media_player.py.

◆ _attr_source

homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer._attr_source
private

Definition at line 443 of file media_player.py.

◆ _attr_source_list

homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer._attr_source_list
private

Definition at line 444 of file media_player.py.

◆ _attr_state

homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer._attr_state
private

Definition at line 79 of file media_player.py.

◆ _attr_unique_id

homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer._attr_unique_id
private

Definition at line 78 of file media_player.py.

◆ _attr_volume_level

homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer._attr_volume_level
private

Definition at line 452 of file media_player.py.

◆ _sources

homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer._sources
private

Definition at line 438 of file media_player.py.

◆ _turn_on

homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer._turn_on
private

Definition at line 81 of file media_player.py.

◆ _tv

homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer._tv
private

Definition at line 76 of file media_player.py.


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