Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.plex.services Namespace Reference

Functions

None async_setup_services (HomeAssistant hass)
 
PlexServer get_plex_server (HomeAssistant hass, str|None plex_server_name=None, str|None plex_server_id=None)
 
PlexMediaSearchResult process_plex_payload (HomeAssistant hass, str content_type, str content_id, PlexServer|None default_plex_server=None, bool supports_playqueues=True)
 
None refresh_library (HomeAssistant hass, ServiceCall service_call)
 

Variables

 _LOGGER = logging.getLogger(__package__)
 
 REFRESH_LIBRARY_SCHEMA
 

Detailed Description

Services for the Plex integration.

Function Documentation

◆ async_setup_services()

None homeassistant.components.plex.services.async_setup_services ( HomeAssistant  hass)
Set up services for the Plex component.

Definition at line 34 of file services.py.

◆ get_plex_server()

PlexServer homeassistant.components.plex.services.get_plex_server ( HomeAssistant  hass,
str | None   plex_server_name = None,
str | None   plex_server_id = None 
)
Retrieve a configured Plex server by name.

Definition at line 81 of file services.py.

◆ process_plex_payload()

PlexMediaSearchResult homeassistant.components.plex.services.process_plex_payload ( HomeAssistant  hass,
str  content_type,
str  content_id,
PlexServer | None   default_plex_server = None,
bool   supports_playqueues = True 
)
Look up Plex media using media_player.play_media service payloads.

Definition at line 118 of file services.py.

◆ refresh_library()

None homeassistant.components.plex.services.refresh_library ( HomeAssistant  hass,
ServiceCall  service_call 
)
Scan a Plex library for new and updated media.

Definition at line 60 of file services.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.plex.services._LOGGER = logging.getLogger(__package__)
private

Definition at line 31 of file services.py.

◆ REFRESH_LIBRARY_SCHEMA

homeassistant.components.plex.services.REFRESH_LIBRARY_SCHEMA
Initial value:
1 = vol.Schema(
2  {vol.Optional("server_name"): str, vol.Required("library_name"): str}
3 )

Definition at line 27 of file services.py.