Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.media_extractor.MediaExtractor Class Reference

Public Member Functions

None __init__ (self, HomeAssistant hass, dict[str, Any] component_config, dict[str, Any] call_data)
 
None call_media_player_service (self, Callable[[str], str] stream_selector, str|None entity_id)
 
None extract_and_send (self)
 
list[str] get_entities (self)
 
str get_media_url (self)
 
str get_stream_query_for_entity (self, str|None entity_id)
 
Callable[[str], str] get_stream_selector (self)
 

Public Attributes

 call_data
 
 config
 
 hass
 

Detailed Description

Class which encapsulates all extraction logic.

Definition at line 134 of file __init__.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.media_extractor.MediaExtractor.__init__ (   self,
HomeAssistant  hass,
dict[str, Any]  component_config,
dict[str, Any]  call_data 
)
Initialize media extractor.

Definition at line 137 of file __init__.py.

Member Function Documentation

◆ call_media_player_service()

None homeassistant.components.media_extractor.MediaExtractor.call_media_player_service (   self,
Callable[[str], str]  stream_selector,
str | None   entity_id 
)
Call Media player play_media service.

Definition at line 222 of file __init__.py.

◆ extract_and_send()

None homeassistant.components.media_extractor.MediaExtractor.extract_and_send (   self)
Extract exact stream format for each entity_id and play it.

Definition at line 156 of file __init__.py.

◆ get_entities()

list[str] homeassistant.components.media_extractor.MediaExtractor.get_entities (   self)
Return list of entities.

Definition at line 152 of file __init__.py.

◆ get_media_url()

str homeassistant.components.media_extractor.MediaExtractor.get_media_url (   self)
Return media content url.

Definition at line 148 of file __init__.py.

◆ get_stream_query_for_entity()

str homeassistant.components.media_extractor.MediaExtractor.get_stream_query_for_entity (   self,
str | None  entity_id 
)
Get stream format query for entity.

Definition at line 244 of file __init__.py.

◆ get_stream_selector()

Callable[[str], str] homeassistant.components.media_extractor.MediaExtractor.get_stream_selector (   self)
Return format selector for the media URL.

Definition at line 171 of file __init__.py.

Member Data Documentation

◆ call_data

homeassistant.components.media_extractor.MediaExtractor.call_data

Definition at line 146 of file __init__.py.

◆ config

homeassistant.components.media_extractor.MediaExtractor.config

Definition at line 145 of file __init__.py.

◆ hass

homeassistant.components.media_extractor.MediaExtractor.hass

Definition at line 144 of file __init__.py.


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