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

Public Member Functions

None __init__ (self, str server_id, int instance_num, str instance_name, client.HyperionClient hyperion_client)
 
None async_added_to_hass (self)
 
bytes|None async_camera_image (self, int|None width=None, int|None height=None)
 
None async_will_remove_from_hass (self)
 
bool available (self)
 
web.StreamResponse|None handle_async_mjpeg_stream (self, web.Request request)
 
bool is_on (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)
 
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_recording (self)
 
bool is_streaming (self)
 
str|None model (self)
 
bool motion_detection_enabled (self)
 
str state (self)
 
dict[str, str|Nonestate_attributes (self)
 
str|None stream_source (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_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)
 

Private Member Functions

bytes|None _async_wait_for_camera_image (self)
 
AsyncGenerator _image_streaming (self)
 
bool _start_image_streaming_for_client (self)
 
None _stop_image_streaming_for_client (self)
 
None _update_imagestream (self, dict[str, Any]|None img=None)
 

Private Attributes

 _attr_device_info
 
 _attr_is_streaming
 
 _attr_unique_id
 
 _client
 
 _client_callbacks
 
 _device_id
 
 _image
 
 _image_cond
 
 _image_stream_clients
 
 _instance_name
 

Static Private Attributes

bool _attr_has_entity_name = True
 
 _attr_name = None
 

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

ComponentBinarySwitch switch class.

Definition at line 106 of file camera.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.hyperion.camera.HyperionCamera.__init__ (   self,
str  server_id,
int  instance_num,
str  instance_name,
client.HyperionClient  hyperion_client 
)
Initialize the switch.

Definition at line 112 of file camera.py.

Member Function Documentation

◆ _async_wait_for_camera_image()

bytes | None homeassistant.components.hyperion.camera.HyperionCamera._async_wait_for_camera_image (   self)
private
Return a single camera image in a stream.

Definition at line 172 of file camera.py.

◆ _image_streaming()

AsyncGenerator homeassistant.components.hyperion.camera.HyperionCamera._image_streaming (   self)
private
Async context manager to start/stop image streaming.

Definition at line 201 of file camera.py.

◆ _start_image_streaming_for_client()

bool homeassistant.components.hyperion.camera.HyperionCamera._start_image_streaming_for_client (   self)
private
Start streaming for a client.

Definition at line 178 of file camera.py.

◆ _stop_image_streaming_for_client()

None homeassistant.components.hyperion.camera.HyperionCamera._stop_image_streaming_for_client (   self)
private
Stop streaming for a client.

Definition at line 191 of file camera.py.

◆ _update_imagestream()

None homeassistant.components.hyperion.camera.HyperionCamera._update_imagestream (   self,
dict[str, Any] | None   img = None 
)
private
Update Hyperion components.

Definition at line 156 of file camera.py.

◆ async_added_to_hass()

None homeassistant.components.hyperion.camera.HyperionCamera.async_added_to_hass (   self)
Register callbacks when entity added to hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 231 of file camera.py.

◆ async_camera_image()

bytes | None homeassistant.components.hyperion.camera.HyperionCamera.async_camera_image (   self,
int | None   width = None,
int | None   height = None 
)
Return single camera image bytes.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 208 of file camera.py.

◆ async_will_remove_from_hass()

None homeassistant.components.hyperion.camera.HyperionCamera.async_will_remove_from_hass (   self)
Cleanup prior to hass removal.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 243 of file camera.py.

◆ available()

bool homeassistant.components.hyperion.camera.HyperionCamera.available (   self)
Return server availability.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 152 of file camera.py.

◆ handle_async_mjpeg_stream()

web.StreamResponse | None homeassistant.components.hyperion.camera.HyperionCamera.handle_async_mjpeg_stream (   self,
web.Request   request 
)
Serve an HTTP MJPEG stream from the camera.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 217 of file camera.py.

◆ is_on()

bool homeassistant.components.hyperion.camera.HyperionCamera.is_on (   self)
Return true if the camera is on.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 147 of file camera.py.

Member Data Documentation

◆ _attr_device_info

homeassistant.components.hyperion.camera.HyperionCamera._attr_device_info
private

Definition at line 138 of file camera.py.

◆ _attr_has_entity_name

bool homeassistant.components.hyperion.camera.HyperionCamera._attr_has_entity_name = True
staticprivate

Definition at line 109 of file camera.py.

◆ _attr_is_streaming

homeassistant.components.hyperion.camera.HyperionCamera._attr_is_streaming
private

Definition at line 187 of file camera.py.

◆ _attr_name

homeassistant.components.hyperion.camera.HyperionCamera._attr_name = None
staticprivate

Definition at line 110 of file camera.py.

◆ _attr_unique_id

homeassistant.components.hyperion.camera.HyperionCamera._attr_unique_id
private

Definition at line 122 of file camera.py.

◆ _client

homeassistant.components.hyperion.camera.HyperionCamera._client
private

Definition at line 127 of file camera.py.

◆ _client_callbacks

homeassistant.components.hyperion.camera.HyperionCamera._client_callbacks
private

Definition at line 135 of file camera.py.

◆ _device_id

homeassistant.components.hyperion.camera.HyperionCamera._device_id
private

Definition at line 125 of file camera.py.

◆ _image

homeassistant.components.hyperion.camera.HyperionCamera._image
private

Definition at line 165 of file camera.py.

◆ _image_cond

homeassistant.components.hyperion.camera.HyperionCamera._image_cond
private

Definition at line 129 of file camera.py.

◆ _image_stream_clients

homeassistant.components.hyperion.camera.HyperionCamera._image_stream_clients
private

Definition at line 133 of file camera.py.

◆ _instance_name

homeassistant.components.hyperion.camera.HyperionCamera._instance_name
private

Definition at line 126 of file camera.py.


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