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

Public Member Functions

None __init__ (self, JellyfinDataUpdateCoordinator coordinator, str session_id)
 
BrowseMedia async_browse_media (self, MediaType|str|None media_content_type=None, str|None media_content_id=None)
 
str|None media_image_url (self)
 
None media_pause (self)
 
None media_play (self)
 
None media_play_pause (self)
 
None media_seek (self, float position)
 
None media_stop (self)
 
None mute_volume (self, bool mute)
 
None play_media (self, MediaType|str media_type, str media_id, **Any kwargs)
 
None set_volume_level (self, float volume)
 
MediaPlayerEntityFeature supported_features (self)
 
- Public Member Functions inherited from homeassistant.components.jellyfin.entity.JellyfinClientEntity
bool available (self)
 
dict[str, Any] session_data (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.jellyfin.coordinator.JellyfinDataUpdateCoordinator
None __init__ (self, HomeAssistant hass, JellyfinClient api_client, dict[str, Any] system_info, str user_id)
 
- 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)
 
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)
 
None media_next_track (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)
 
str|None media_series_title (self)
 
str|None media_title (self)
 
int|None media_track (self)
 
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)
 
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_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)
 
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

 now_playing
 
 play_state
 
- Public Attributes inherited from homeassistant.components.jellyfin.entity.JellyfinClientEntity
 session_id
 
- Public Attributes inherited from homeassistant.components.jellyfin.coordinator.JellyfinDataUpdateCoordinator
 api_client
 
 device_ids
 
- 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
 

Private Member Functions

None _handle_coordinator_update (self)
 
None _update_from_session_data (self)
 

Private Attributes

 _attr_is_volume_muted
 
 _attr_media_album_artist
 
 _attr_media_album_name
 
 _attr_media_artist
 
 _attr_media_content_id
 
 _attr_media_content_type
 
 _attr_media_duration
 
 _attr_media_episode
 
 _attr_media_image_remotely_accessible
 
 _attr_media_position
 
 _attr_media_position_updated_at
 
 _attr_media_season
 
 _attr_media_series_title
 
 _attr_media_title
 
 _attr_media_track
 
 _attr_state
 
 _attr_unique_id
 
 _attr_volume_level
 

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

Represents a Jellyfin Player device.

Definition at line 51 of file media_player.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.jellyfin.media_player.JellyfinMediaPlayer.__init__ (   self,
JellyfinDataUpdateCoordinator  coordinator,
str  session_id 
)
Initialize the Jellyfin Media Player entity.

Reimplemented from homeassistant.components.jellyfin.entity.JellyfinClientEntity.

Definition at line 54 of file media_player.py.

Member Function Documentation

◆ _handle_coordinator_update()

None homeassistant.components.jellyfin.media_player.JellyfinMediaPlayer._handle_coordinator_update (   self)
private

Definition at line 71 of file media_player.py.

◆ _update_from_session_data()

None homeassistant.components.jellyfin.media_player.JellyfinMediaPlayer._update_from_session_data (   self)
private
Process session data to update entity properties.

Definition at line 83 of file media_player.py.

◆ async_browse_media()

BrowseMedia homeassistant.components.jellyfin.media_player.JellyfinMediaPlayer.async_browse_media (   self,
MediaType | str | None   media_content_type = None,
str | None   media_content_id = None 
)
Return a BrowseMedia instance.

The BrowseMedia instance will be used by the "media_player/browse_media" websocket command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 246 of file media_player.py.

◆ media_image_url()

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

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 166 of file media_player.py.

◆ media_pause()

None homeassistant.components.jellyfin.media_player.JellyfinMediaPlayer.media_pause (   self)
Send pause command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 206 of file media_player.py.

◆ media_play()

None homeassistant.components.jellyfin.media_player.JellyfinMediaPlayer.media_play (   self)
Send play command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 211 of file media_player.py.

◆ media_play_pause()

None homeassistant.components.jellyfin.media_player.JellyfinMediaPlayer.media_play_pause (   self)
Send the PlayPause command to the session.

Definition at line 216 of file media_player.py.

◆ media_seek()

None homeassistant.components.jellyfin.media_player.JellyfinMediaPlayer.media_seek (   self,
float  position 
)
Send seek command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 200 of file media_player.py.

◆ media_stop()

None homeassistant.components.jellyfin.media_player.JellyfinMediaPlayer.media_stop (   self)
Send stop command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 220 of file media_player.py.

◆ mute_volume()

None homeassistant.components.jellyfin.media_player.JellyfinMediaPlayer.mute_volume (   self,
bool  mute 
)
Mute the volume.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 239 of file media_player.py.

◆ play_media()

None homeassistant.components.jellyfin.media_player.JellyfinMediaPlayer.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.

◆ set_volume_level()

None homeassistant.components.jellyfin.media_player.JellyfinMediaPlayer.set_volume_level (   self,
float  volume 
)
Set volume level, range 0..1.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 233 of file media_player.py.

◆ supported_features()

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

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 176 of file media_player.py.

Member Data Documentation

◆ _attr_is_volume_muted

homeassistant.components.jellyfin.media_player.JellyfinMediaPlayer._attr_is_volume_muted
private

Definition at line 148 of file media_player.py.

◆ _attr_media_album_artist

homeassistant.components.jellyfin.media_player.JellyfinMediaPlayer._attr_media_album_artist
private

Definition at line 157 of file media_player.py.

◆ _attr_media_album_name

homeassistant.components.jellyfin.media_player.JellyfinMediaPlayer._attr_media_album_name
private

Definition at line 156 of file media_player.py.

◆ _attr_media_artist

homeassistant.components.jellyfin.media_player.JellyfinMediaPlayer._attr_media_artist
private

Definition at line 158 of file media_player.py.

◆ _attr_media_content_id

homeassistant.components.jellyfin.media_player.JellyfinMediaPlayer._attr_media_content_id
private

Definition at line 151 of file media_player.py.

◆ _attr_media_content_type

homeassistant.components.jellyfin.media_player.JellyfinMediaPlayer._attr_media_content_type
private

Definition at line 150 of file media_player.py.

◆ _attr_media_duration

homeassistant.components.jellyfin.media_player.JellyfinMediaPlayer._attr_media_duration
private

Definition at line 160 of file media_player.py.

◆ _attr_media_episode

homeassistant.components.jellyfin.media_player.JellyfinMediaPlayer._attr_media_episode
private

Definition at line 155 of file media_player.py.

◆ _attr_media_image_remotely_accessible

homeassistant.components.jellyfin.media_player.JellyfinMediaPlayer._attr_media_image_remotely_accessible
private

Definition at line 163 of file media_player.py.

◆ _attr_media_position

homeassistant.components.jellyfin.media_player.JellyfinMediaPlayer._attr_media_position
private

Definition at line 161 of file media_player.py.

◆ _attr_media_position_updated_at

homeassistant.components.jellyfin.media_player.JellyfinMediaPlayer._attr_media_position_updated_at
private

Definition at line 162 of file media_player.py.

◆ _attr_media_season

homeassistant.components.jellyfin.media_player.JellyfinMediaPlayer._attr_media_season
private

Definition at line 154 of file media_player.py.

◆ _attr_media_series_title

homeassistant.components.jellyfin.media_player.JellyfinMediaPlayer._attr_media_series_title
private

Definition at line 153 of file media_player.py.

◆ _attr_media_title

homeassistant.components.jellyfin.media_player.JellyfinMediaPlayer._attr_media_title
private

Definition at line 152 of file media_player.py.

◆ _attr_media_track

homeassistant.components.jellyfin.media_player.JellyfinMediaPlayer._attr_media_track
private

Definition at line 159 of file media_player.py.

◆ _attr_state

homeassistant.components.jellyfin.media_player.JellyfinMediaPlayer._attr_state
private

Definition at line 147 of file media_player.py.

◆ _attr_unique_id

homeassistant.components.jellyfin.media_player.JellyfinMediaPlayer._attr_unique_id
private

Definition at line 61 of file media_player.py.

◆ _attr_volume_level

homeassistant.components.jellyfin.media_player.JellyfinMediaPlayer._attr_volume_level
private

Definition at line 149 of file media_player.py.

◆ now_playing

homeassistant.components.jellyfin.media_player.JellyfinMediaPlayer.now_playing

Definition at line 73 of file media_player.py.

◆ play_state

homeassistant.components.jellyfin.media_player.JellyfinMediaPlayer.play_state

Definition at line 74 of file media_player.py.


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