Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.unifiprotect.media_source Namespace Reference

Classes

class  IdentifierTimeType
 
class  IdentifierType
 
class  ProtectMediaSource
 
class  SimpleEventType
 

Functions

NoReturn _bad_identifier (str identifier, Exception|None err=None)
 
str _format_duration (timedelta duration)
 
str _get_audio_name (Event|dict[str, Any] event)
 
tuple[datetime, datetime] _get_month_start_end (datetime start)
 
str _get_object_name (Event|dict[str, Any] event)
 
MediaSource async_get_media_source (HomeAssistant hass)
 

Variables

dictionary EVENT_NAME_MAP
 
int THUMBNAIL_HEIGHT = 185
 
int THUMBNAIL_WIDTH = 185
 
string VIDEO_FORMAT = "video/mp4"
 

Detailed Description

UniFi Protect media sources.

Function Documentation

◆ _bad_identifier()

NoReturn homeassistant.components.unifiprotect.media_source._bad_identifier ( str  identifier,
Exception | None   err = None 
)
private

Definition at line 107 of file media_source.py.

◆ _format_duration()

str homeassistant.components.unifiprotect.media_source._format_duration ( timedelta  duration)
private

Definition at line 115 of file media_source.py.

◆ _get_audio_name()

str homeassistant.components.unifiprotect.media_source._get_audio_name ( Event | dict[str, Any]  event)
private

Definition at line 169 of file media_source.py.

◆ _get_month_start_end()

tuple[datetime, datetime] homeassistant.components.unifiprotect.media_source._get_month_start_end ( datetime  start)
private

Definition at line 96 of file media_source.py.

◆ _get_object_name()

str homeassistant.components.unifiprotect.media_source._get_object_name ( Event | dict[str, Any]  event)
private

Definition at line 133 of file media_source.py.

◆ async_get_media_source()

MediaSource homeassistant.components.unifiprotect.media_source.async_get_media_source ( HomeAssistant  hass)
Set up UniFi Protect media source.

Definition at line 84 of file media_source.py.

Variable Documentation

◆ EVENT_NAME_MAP

dictionary homeassistant.components.unifiprotect.media_source.EVENT_NAME_MAP
Initial value:
1 = {
2  SimpleEventType.ALL: "All Events",
3  SimpleEventType.RING: "Ring Events",
4  SimpleEventType.MOTION: "Motion Events",
5  SimpleEventType.SMART: "Object Detections",
6  SimpleEventType.AUDIO: "Audio Detections",
7 }

Definition at line 75 of file media_source.py.

◆ THUMBNAIL_HEIGHT

int homeassistant.components.unifiprotect.media_source.THUMBNAIL_HEIGHT = 185

Definition at line 34 of file media_source.py.

◆ THUMBNAIL_WIDTH

int homeassistant.components.unifiprotect.media_source.THUMBNAIL_WIDTH = 185

Definition at line 33 of file media_source.py.

◆ VIDEO_FORMAT

string homeassistant.components.unifiprotect.media_source.VIDEO_FORMAT = "video/mp4"

Definition at line 32 of file media_source.py.