Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.media_source.local_source.LocalSource Class Reference
Inheritance diagram for homeassistant.components.media_source.local_source.LocalSource:
[legend]
Collaboration diagram for homeassistant.components.media_source.local_source.LocalSource:
[legend]

Public Member Functions

None __init__ (self, HomeAssistant hass)
 
BrowseMediaSource async_browse_media (self, MediaSourceItem item)
 
Path async_full_path (self, str source_dir_id, str location)
 
tuple[str, strasync_parse_identifier (self, MediaSourceItem item)
 
PlayMedia async_resolve_media (self, MediaSourceItem item)
 
- Public Member Functions inherited from homeassistant.components.media_source.models.MediaSource
None __init__ (self, str domain)
 

Public Attributes

 hass
 
- Public Attributes inherited from homeassistant.components.media_source.models.MediaSource
 domain
 
 name
 

Static Public Attributes

 str
 
- Static Public Attributes inherited from homeassistant.components.media_source.models.MediaSource
 None
 

Private Member Functions

BrowseMediaSource _browse_media (self, str|None source_dir_id, str location)
 
BrowseMediaSource|None _build_item_response (self, str source_dir_id, Path path, bool is_child=False)
 

Detailed Description

Provide local directories as media sources.

Definition at line 39 of file local_source.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.media_source.local_source.LocalSource.__init__ (   self,
HomeAssistant  hass 
)
Initialize local source.

Definition at line 44 of file local_source.py.

Member Function Documentation

◆ _browse_media()

BrowseMediaSource homeassistant.components.media_source.local_source.LocalSource._browse_media (   self,
str | None  source_dir_id,
str   location 
)
private
Browse media.

Definition at line 100 of file local_source.py.

◆ _build_item_response()

BrowseMediaSource | None homeassistant.components.media_source.local_source.LocalSource._build_item_response (   self,
str  source_dir_id,
Path  path,
bool   is_child = False 
)
private

Definition at line 147 of file local_source.py.

◆ async_browse_media()

BrowseMediaSource homeassistant.components.media_source.local_source.LocalSource.async_browse_media (   self,
MediaSourceItem  item 
)
Return media.

Reimplemented from homeassistant.components.media_source.models.MediaSource.

Definition at line 85 of file local_source.py.

◆ async_full_path()

Path homeassistant.components.media_source.local_source.LocalSource.async_full_path (   self,
str  source_dir_id,
str  location 
)
Return full path.

Definition at line 50 of file local_source.py.

◆ async_parse_identifier()

tuple[str, str] homeassistant.components.media_source.local_source.LocalSource.async_parse_identifier (   self,
MediaSourceItem  item 
)
Parse identifier.

Definition at line 58 of file local_source.py.

◆ async_resolve_media()

PlayMedia homeassistant.components.media_source.local_source.LocalSource.async_resolve_media (   self,
MediaSourceItem  item 
)
Resolve media to a url.

Reimplemented from homeassistant.components.media_source.models.MediaSource.

Definition at line 77 of file local_source.py.

Member Data Documentation

◆ hass

homeassistant.components.media_source.local_source.LocalSource.hass

Definition at line 47 of file local_source.py.

◆ str

homeassistant.components.media_source.local_source.LocalSource.str
static

Definition at line 42 of file local_source.py.


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