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

Public Member Functions

None __init__ (self, *str|None name=None, str mjpeg_url, str|None still_image_url, str|None authentication=None, str|None username=None, str password="", bool verify_ssl=True, str|None unique_id=None, DeviceInfo|None device_info=None)
 
bytes|None async_camera_image (self, int|None width=None, int|None height=None)
 
web.StreamResponse|None handle_async_mjpeg_stream (self, web.Request request)
 
str stream_source (self)
 
- Public Member Functions inherited from homeassistant.components.camera.Camera
None __init__ (self)
 
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)
 
bool available (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 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)
 
bool use_stream_for_stills (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_added_to_hass (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)
 
None async_will_remove_from_hass (self)
 
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)
 

Private Member Functions

bytes|None _async_digest_or_fallback_camera_image (self)
 
httpx.Auth _get_httpx_auth (self)
 
web.StreamResponse|None _handle_async_mjpeg_digest_stream (self, web.Request request)
 

Private Attributes

 _attr_device_info
 
 _attr_name
 
 _attr_unique_id
 
 _auth
 
 _authentication
 
 _mjpeg_url
 
 _password
 
 _still_image_url
 
 _username
 
 _verify_ssl
 

Additional Inherited Members

- 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 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
 

Detailed Description

An implementation of an IP camera that is reachable over a URL.

Definition at line 86 of file camera.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.mjpeg.camera.MjpegCamera.__init__ (   self,
*str | None   name = None,
str  mjpeg_url,
str | None  still_image_url,
str | None   authentication = None,
str | None   username = None,
str   password = "",
bool   verify_ssl = True,
str | None   unique_id = None,
DeviceInfo | None   device_info = None 
)
Initialize a MJPEG camera.

Definition at line 89 of file camera.py.

Member Function Documentation

◆ _async_digest_or_fallback_camera_image()

bytes | None homeassistant.components.mjpeg.camera.MjpegCamera._async_digest_or_fallback_camera_image (   self)
private
Return a still image response from the camera using digest authentication.

Definition at line 166 of file camera.py.

◆ _get_httpx_auth()

httpx.Auth homeassistant.components.mjpeg.camera.MjpegCamera._get_httpx_auth (   self)
private
Return a httpx auth object.

Definition at line 159 of file camera.py.

◆ _handle_async_mjpeg_digest_stream()

web.StreamResponse | None homeassistant.components.mjpeg.camera.MjpegCamera._handle_async_mjpeg_digest_stream (   self,
web.Request   request 
)
private
Generate an HTTP MJPEG stream from the camera using digest authentication.

Definition at line 195 of file camera.py.

◆ async_camera_image()

bytes | None homeassistant.components.mjpeg.camera.MjpegCamera.async_camera_image (   self,
int | None   width = None,
int | None   height = None 
)
Return a still image response from the camera.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 134 of file camera.py.

◆ handle_async_mjpeg_stream()

web.StreamResponse | None homeassistant.components.mjpeg.camera.MjpegCamera.handle_async_mjpeg_stream (   self,
web.Request   request 
)
Generate an HTTP MJPEG stream from the camera.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 213 of file camera.py.

◆ stream_source()

str homeassistant.components.mjpeg.camera.MjpegCamera.stream_source (   self)
Return the stream source.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 125 of file camera.py.

Member Data Documentation

◆ _attr_device_info

homeassistant.components.mjpeg.camera.MjpegCamera._attr_device_info
private

Definition at line 123 of file camera.py.

◆ _attr_name

homeassistant.components.mjpeg.camera.MjpegCamera._attr_name
private

Definition at line 104 of file camera.py.

◆ _attr_unique_id

homeassistant.components.mjpeg.camera.MjpegCamera._attr_unique_id
private

Definition at line 121 of file camera.py.

◆ _auth

homeassistant.components.mjpeg.camera.MjpegCamera._auth
private

Definition at line 111 of file camera.py.

◆ _authentication

homeassistant.components.mjpeg.camera.MjpegCamera._authentication
private

Definition at line 105 of file camera.py.

◆ _mjpeg_url

homeassistant.components.mjpeg.camera.MjpegCamera._mjpeg_url
private

Definition at line 108 of file camera.py.

◆ _password

homeassistant.components.mjpeg.camera.MjpegCamera._password
private

Definition at line 107 of file camera.py.

◆ _still_image_url

homeassistant.components.mjpeg.camera.MjpegCamera._still_image_url
private

Definition at line 109 of file camera.py.

◆ _username

homeassistant.components.mjpeg.camera.MjpegCamera._username
private

Definition at line 106 of file camera.py.

◆ _verify_ssl

homeassistant.components.mjpeg.camera.MjpegCamera._verify_ssl
private

Definition at line 118 of file camera.py.


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