Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.agent_dvr.camera.AgentCamera Class Reference
Inheritance diagram for homeassistant.components.agent_dvr.camera.AgentCamera:
[legend]
Collaboration diagram for homeassistant.components.agent_dvr.camera.AgentCamera:
[legend]

Public Member Functions

def __init__ (self, device)
 
def async_disable_alerts (self)
 
None async_disable_motion_detection (self)
 
def async_enable_alerts (self)
 
None async_enable_motion_detection (self)
 
def async_snapshot (self)
 
def async_start_recording (self)
 
def async_stop_recording (self)
 
None async_turn_off (self)
 
None async_turn_on (self)
 
None async_update (self)
 
bool connected (self)
 
bool is_alerted (self)
 
bool is_detected (self)
 
bool is_on (self)
 
bool is_recording (self)
 
bool motion_detection_enabled (self)
 

Public Attributes

 device
 

Private Attributes

 _attr_available
 
 _attr_device_info
 
 _attr_extra_state_attributes
 
 _attr_icon
 
 _attr_unique_id
 
 _removed
 

Static Private Attributes

 _attr_attribution = ATTRIBUTION
 
bool _attr_has_entity_name = True
 
 _attr_name = None
 
bool _attr_should_poll = True
 
 _attr_supported_features = CameraEntityFeature.ON_OFF
 

Detailed Description

Representation of an Agent Device Stream.

Definition at line 65 of file camera.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.agent_dvr.camera.AgentCamera.__init__ (   self,
  device 
)
Initialize as a subclass of MjpegCamera.

Definition at line 74 of file camera.py.

Member Function Documentation

◆ async_disable_alerts()

def homeassistant.components.agent_dvr.camera.AgentCamera.async_disable_alerts (   self)
Disable alerts.

Definition at line 152 of file camera.py.

◆ async_disable_motion_detection()

None homeassistant.components.agent_dvr.camera.AgentCamera.async_disable_motion_detection (   self)
Disable motion detection.

Definition at line 160 of file camera.py.

◆ async_enable_alerts()

def homeassistant.components.agent_dvr.camera.AgentCamera.async_enable_alerts (   self)
Enable alerts.

Definition at line 148 of file camera.py.

◆ async_enable_motion_detection()

None homeassistant.components.agent_dvr.camera.AgentCamera.async_enable_motion_detection (   self)
Enable motion detection.

Definition at line 156 of file camera.py.

◆ async_snapshot()

def homeassistant.components.agent_dvr.camera.AgentCamera.async_snapshot (   self)
Take a snapshot.

Definition at line 176 of file camera.py.

◆ async_start_recording()

def homeassistant.components.agent_dvr.camera.AgentCamera.async_start_recording (   self)
Start recording.

Definition at line 164 of file camera.py.

◆ async_stop_recording()

def homeassistant.components.agent_dvr.camera.AgentCamera.async_stop_recording (   self)
Stop recording.

Definition at line 168 of file camera.py.

◆ async_turn_off()

None homeassistant.components.agent_dvr.camera.AgentCamera.async_turn_off (   self)
Disable the camera.

Definition at line 180 of file camera.py.

◆ async_turn_on()

None homeassistant.components.agent_dvr.camera.AgentCamera.async_turn_on (   self)
Enable the camera.

Definition at line 172 of file camera.py.

◆ async_update()

None homeassistant.components.agent_dvr.camera.AgentCamera.async_update (   self)
Update our state from the Agent API.

Definition at line 92 of file camera.py.

◆ connected()

bool homeassistant.components.agent_dvr.camera.AgentCamera.connected (   self)
Return True if entity is connected.

Definition at line 134 of file camera.py.

◆ is_alerted()

bool homeassistant.components.agent_dvr.camera.AgentCamera.is_alerted (   self)
Return whether the monitor has alerted.

Definition at line 124 of file camera.py.

◆ is_detected()

bool homeassistant.components.agent_dvr.camera.AgentCamera.is_detected (   self)
Return whether the monitor has alerted.

Definition at line 129 of file camera.py.

◆ is_on()

bool homeassistant.components.agent_dvr.camera.AgentCamera.is_on (   self)
Return true if on.

Definition at line 139 of file camera.py.

◆ is_recording()

bool homeassistant.components.agent_dvr.camera.AgentCamera.is_recording (   self)
Return whether the monitor is recording.

Definition at line 119 of file camera.py.

◆ motion_detection_enabled()

bool homeassistant.components.agent_dvr.camera.AgentCamera.motion_detection_enabled (   self)
Return the camera motion detection status.

Definition at line 144 of file camera.py.

Member Data Documentation

◆ _attr_attribution

homeassistant.components.agent_dvr.camera.AgentCamera._attr_attribution = ATTRIBUTION
staticprivate

Definition at line 68 of file camera.py.

◆ _attr_available

homeassistant.components.agent_dvr.camera.AgentCamera._attr_available
private

Definition at line 107 of file camera.py.

◆ _attr_device_info

homeassistant.components.agent_dvr.camera.AgentCamera._attr_device_info
private

Definition at line 84 of file camera.py.

◆ _attr_extra_state_attributes

homeassistant.components.agent_dvr.camera.AgentCamera._attr_extra_state_attributes
private

Definition at line 108 of file camera.py.

◆ _attr_has_entity_name

bool homeassistant.components.agent_dvr.camera.AgentCamera._attr_has_entity_name = True
staticprivate

Definition at line 71 of file camera.py.

◆ _attr_icon

homeassistant.components.agent_dvr.camera.AgentCamera._attr_icon
private

Definition at line 104 of file camera.py.

◆ _attr_name

homeassistant.components.agent_dvr.camera.AgentCamera._attr_name = None
staticprivate

Definition at line 72 of file camera.py.

◆ _attr_should_poll

bool homeassistant.components.agent_dvr.camera.AgentCamera._attr_should_poll = True
staticprivate

Definition at line 69 of file camera.py.

◆ _attr_supported_features

homeassistant.components.agent_dvr.camera.AgentCamera._attr_supported_features = CameraEntityFeature.ON_OFF
staticprivate

Definition at line 70 of file camera.py.

◆ _attr_unique_id

homeassistant.components.agent_dvr.camera.AgentCamera._attr_unique_id
private

Definition at line 78 of file camera.py.

◆ _removed

homeassistant.components.agent_dvr.camera.AgentCamera._removed
private

Definition at line 77 of file camera.py.

◆ device

homeassistant.components.agent_dvr.camera.AgentCamera.device

Definition at line 76 of file camera.py.


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