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

Public Member Functions

None __init__ (self, Device device)
 
None async_will_remove_from_hass (self)
 
bool available (self)
 
str|None stream_source (self)
 
bool use_stream_for_stills (self)
 
- Public Member Functions inherited from homeassistant.components.nest.camera.NestCameraBaseEntity
None async_added_to_hass (self)
 
- Public Member Functions inherited from homeassistant.components.camera.Camera
None __init__ (self)
 
bytes|None async_camera_image (self, int|None width=None, int|None height=None)
 
Stream|None async_create_stream (self)
 
None async_disable_motion_detection (self)
 
None async_enable_motion_detection (self)
 
WebRTCClientConfiguration async_get_webrtc_client_configuration (self)
 
None async_handle_async_webrtc_offer (self, str offer_sdp, str session_id, WebRTCSendMessage send_message)
 
str|None async_handle_web_rtc_offer (self, str offer_sdp)
 
None async_internal_added_to_hass (self)
 
None async_on_webrtc_candidate (self, str session_id, RTCIceCandidateInit candidate)
 
None async_refresh_providers (self, *bool write_state=True)
 
None async_turn_off (self)
 
None async_turn_on (self)
 
None async_update_token (self)
 
None async_write_ha_state (self)
 
str|None brand (self)
 
CameraCapabilities camera_capabilities (self)
 
bytes|None camera_image (self, int|None width=None, int|None height=None)
 
None close_webrtc_session (self, str session_id)
 
None disable_motion_detection (self)
 
None enable_motion_detection (self)
 
str entity_picture (self)
 
float frame_interval (self)
 
StreamType|None frontend_stream_type (self)
 
web.StreamResponse|None handle_async_mjpeg_stream (self, web.Request request)
 
web.StreamResponse handle_async_still_stream (self, web.Request request, float interval)
 
bool is_on (self)
 
bool is_recording (self)
 
bool is_streaming (self)
 
str|None model (self)
 
bool motion_detection_enabled (self)
 
str state (self)
 
dict[str, str|Nonestate_attributes (self)
 
CameraEntityFeature supported_features (self)
 
CameraEntityFeature supported_features_compat (self)
 
None turn_off (self)
 
None turn_on (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.Entity
None __init_subclass__ (cls, **Any kwargs)
 
str __repr__ (self)
 
None add_to_platform_abort (self)
 
None add_to_platform_finish (self)
 
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
bool assumed_state (self)
 
None async_device_update (self, bool warning=True)
 
None async_internal_will_remove_from_hass (self)
 
None async_on_remove (self, CALLBACK_TYPE func)
 
None async_registry_entry_updated (self)
 
None async_remove (self, *bool force_remove=False)
 
None async_removed_from_registry (self)
 
None async_schedule_update_ha_state (self, bool force_refresh=False)
 
None async_set_context (self, Context context)
 
None async_update_ha_state (self, bool force_refresh=False)
 
str|None attribution (self)
 
dict[str, Any]|None capability_attributes (self)
 
str|None device_class (self)
 
DeviceInfo|None device_info (self)
 
bool enabled (self)
 
EntityCategory|None entity_category (self)
 
bool entity_registry_enabled_default (self)
 
bool entity_registry_visible_default (self)
 
Mapping[str, Any]|None extra_state_attributes (self)
 
bool force_update (self)
 
HassJobType get_hassjob_type (self, str function_name)
 
er.EntityOptionsType|None get_initial_entity_options (self)
 
bool has_entity_name (self)
 
str|None icon (self)
 
str|UndefinedType|None name (self)
 
None schedule_update_ha_state (self, bool force_refresh=False)
 
bool should_poll (self)
 
str|None suggested_object_id (self)
 
str|None translation_key (self)
 
Mapping[str, strtranslation_placeholders (self)
 
str|None unique_id (self)
 
str|None unit_of_measurement (self)
 
bool use_device_name (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None __init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
 
Any __new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)
 

Public Attributes

 stream
 
- Public Attributes inherited from homeassistant.components.camera.Camera
 stream
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Static Public Attributes

 None
 
- Static Public Attributes inherited from homeassistant.components.camera.Camera
 bool
 
 CameraEntityFeature
 
 float
 
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Private Member Functions

datetime.datetime|None _async_refresh_stream (self)
 

Private Attributes

 _create_stream_url_lock
 
 _refresh_unsub
 
 _rtsp_live_stream_trait
 
 _rtsp_stream
 

Detailed Description

Nest cameras that use RTSP.

Definition at line 164 of file camera.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.nest.camera.NestRTSPEntity.__init__ (   self,
Device  device 
)
Initialize the camera.

Reimplemented from homeassistant.components.nest.camera.NestCameraBaseEntity.

Definition at line 170 of file camera.py.

Member Function Documentation

◆ _async_refresh_stream()

datetime.datetime | None homeassistant.components.nest.camera.NestRTSPEntity._async_refresh_stream (   self)
private
Refresh stream to extend expiration time.

Definition at line 214 of file camera.py.

◆ async_will_remove_from_hass()

None homeassistant.components.nest.camera.NestRTSPEntity.async_will_remove_from_hass (   self)
Invalidates the RTSP token when unloaded.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 234 of file camera.py.

◆ available()

bool homeassistant.components.nest.camera.NestRTSPEntity.available (   self)
Return True if entity is available.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 183 of file camera.py.

◆ stream_source()

str | None homeassistant.components.nest.camera.NestRTSPEntity.stream_source (   self)
Return the source of the stream.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 192 of file camera.py.

◆ use_stream_for_stills()

bool homeassistant.components.nest.camera.NestRTSPEntity.use_stream_for_stills (   self)
Always use the RTSP stream to generate snapshots.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 178 of file camera.py.

Member Data Documentation

◆ _create_stream_url_lock

homeassistant.components.nest.camera.NestRTSPEntity._create_stream_url_lock
private

Definition at line 173 of file camera.py.

◆ _refresh_unsub

homeassistant.components.nest.camera.NestRTSPEntity._refresh_unsub
private

Definition at line 208 of file camera.py.

◆ _rtsp_live_stream_trait

homeassistant.components.nest.camera.NestRTSPEntity._rtsp_live_stream_trait
private

Definition at line 174 of file camera.py.

◆ _rtsp_stream

homeassistant.components.nest.camera.NestRTSPEntity._rtsp_stream
private

Definition at line 198 of file camera.py.

◆ None

homeassistant.components.nest.camera.NestRTSPEntity.None
static

Definition at line 167 of file camera.py.

◆ stream

homeassistant.components.nest.camera.NestRTSPEntity.stream

Definition at line 227 of file camera.py.


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