Public Attributes | |
| stream | |
Public Attributes inherited from homeassistant.helpers.entity.Entity | |
| device_entry | |
| entity_id | |
| hass | |
| parallel_updates | |
| platform | |
| registry_entry | |
Static Public Attributes | |
| bool | |
| CameraEntityFeature | |
| float | |
| None | |
Static Public Attributes inherited from homeassistant.helpers.entity.Entity | |
| bool | |
| EntityPlatform | |
| HomeAssistant | |
| None | |
| StateInfo | |
| StateType | |
| str | |
Private Member Functions | |
| WebRTCClientConfiguration | _async_get_webrtc_client_configuration (self) |
| None | _invalidate_camera_capabilities_cache (self) |
| _T|None | _T (self, Callable[[HomeAssistant, Camera], Coroutine[None, None, _T|None]] fn) |
Static Private Attributes | |
| _entity_component_unrecorded_attributes | |
The base class for camera entities.
Definition at line 461 of file __init__.py.
| None homeassistant.components.camera.Camera.__init__ | ( | self | ) |
Initialize a camera.
Definition at line 484 of file __init__.py.
|
private |
Return the WebRTC client configuration adjustable per integration.
Reimplemented in homeassistant.components.nest.camera.NestWebRTCEntity.
Definition at line 874 of file __init__.py.
|
private |
Invalidate the camera capabilities cache.
Definition at line 917 of file __init__.py.
|
private |
Get first provider that supports this camera.
Definition at line 864 of file __init__.py.
| bytes | None homeassistant.components.camera.Camera.async_camera_image | ( | self, | |
| int | None | width = None, |
||
| int | None | height = None |
||
| ) |
Return bytes of camera image.
Reimplemented in homeassistant.components.yi.camera.YiCamera, homeassistant.components.yale.camera.YaleCamera, homeassistant.components.xiaomi.camera.XiaomiCamera, homeassistant.components.xeoma.camera.XeomaCamera, homeassistant.components.unifiprotect.camera.ProtectCamera, homeassistant.components.trafikverket_camera.camera.TVCamera, homeassistant.components.synology_dsm.camera.SynoDSMCamera, homeassistant.components.skybell.camera.SkybellCamera, homeassistant.components.ring.camera.RingCam, homeassistant.components.reolink.camera.ReolinkCamera, homeassistant.components.push.camera.PushCamera, homeassistant.components.prusalink.camera.PrusaLinkJobPreviewEntity, homeassistant.components.proxy.camera.ProxyCamera, homeassistant.components.prosegur.camera.ProsegurCamera, homeassistant.components.onvif.camera.ONVIFCameraEntity, homeassistant.components.netatmo.camera.NetatmoCamera, homeassistant.components.nest.camera.NestWebRTCEntity, homeassistant.components.mqtt.camera.MqttCamera, homeassistant.components.mjpeg.camera.MjpegCamera, homeassistant.components.hyperion.camera.HyperionCamera, homeassistant.components.homekit_controller.camera.HomeKitCamera, homeassistant.components.generic.camera.GenericCamera, homeassistant.components.fully_kiosk.camera.FullyCameraEntity, homeassistant.components.ffmpeg.camera.FFmpegCamera, homeassistant.components.familyhub.camera.FamilyHubCamera, homeassistant.components.ezviz.camera.EzvizCamera, homeassistant.components.esphome.camera.EsphomeCamera, homeassistant.components.doorbird.camera.DoorBirdCamera, homeassistant.components.demo.camera.DemoCamera, homeassistant.components.canary.camera.CanaryCamera, homeassistant.components.buienradar.camera.BuienradarCam, homeassistant.components.august.camera.AugustCamera, and homeassistant.components.amcrest.camera.AmcrestCam.
Definition at line 724 of file __init__.py.
Create a Stream for stream_source.
Definition at line 615 of file __init__.py.
| None homeassistant.components.camera.Camera.async_disable_motion_detection | ( | self | ) |
Call the job and disable motion detection.
Reimplemented in homeassistant.components.unifiprotect.camera.ProtectCamera, homeassistant.components.synology_dsm.camera.SynoDSMCamera, homeassistant.components.ring.camera.RingCam, homeassistant.components.freebox.camera.FreeboxCamera, homeassistant.components.demo.camera.DemoCamera, homeassistant.components.blink.camera.BlinkCamera, and homeassistant.components.amcrest.camera.AmcrestCam.
Definition at line 793 of file __init__.py.
| None homeassistant.components.camera.Camera.async_enable_motion_detection | ( | self | ) |
Call the job and enable motion detection.
Reimplemented in homeassistant.components.unifiprotect.camera.ProtectCamera, homeassistant.components.synology_dsm.camera.SynoDSMCamera, homeassistant.components.ring.camera.RingCam, homeassistant.components.freebox.camera.FreeboxCamera, homeassistant.components.demo.camera.DemoCamera, homeassistant.components.blink.camera.BlinkCamera, and homeassistant.components.amcrest.camera.AmcrestCam.
Definition at line 785 of file __init__.py.
| WebRTCClientConfiguration homeassistant.components.camera.Camera.async_get_webrtc_client_configuration | ( | self | ) |
Return the WebRTC client configuration and extend it with the registered ice servers.
Definition at line 880 of file __init__.py.
| None homeassistant.components.camera.Camera.async_handle_async_webrtc_offer | ( | self, | |
| str | offer_sdp, | ||
| str | session_id, | ||
| WebRTCSendMessage | send_message | ||
| ) |
Handle the async WebRTC offer. Async means that it could take some time to process the offer and responses/message will be sent with the send_message callback. This method is used by cameras with CameraEntityFeature.STREAM. An integration overriding this method must also implement async_on_webrtc_candidate. Integrations can override with a native WebRTC implementation.
Reimplemented in homeassistant.components.ring.camera.RingCam, and homeassistant.components.nest.camera.NestWebRTCEntity.
Definition at line 655 of file __init__.py.
| str | None homeassistant.components.camera.Camera.async_handle_web_rtc_offer | ( | self, | |
| str | offer_sdp | ||
| ) |
Handle the WebRTC offer and return an answer. This is used by cameras with CameraEntityFeature.STREAM and StreamType.WEB_RTC. Integrations can override with a native WebRTC implementation.
Definition at line 646 of file __init__.py.
| None homeassistant.components.camera.Camera.async_internal_added_to_hass | ( | self | ) |
Run when entity about to be added to hass.
Reimplemented from homeassistant.helpers.entity.Entity.
Definition at line 823 of file __init__.py.
| None homeassistant.components.camera.Camera.async_on_webrtc_candidate | ( | self, | |
| str | session_id, | ||
| RTCIceCandidateInit | candidate | ||
| ) |
Handle a WebRTC candidate.
Reimplemented in homeassistant.components.ring.camera.RingCam, and homeassistant.components.nest.camera.NestWebRTCEntity.
Definition at line 901 of file __init__.py.
| None homeassistant.components.camera.Camera.async_refresh_providers | ( | self, | |
| *bool | write_state = True |
||
| ) |
Determine if any of the registered providers are suitable for this entity. This affects state attributes, so it should be invoked any time the registered providers or inputs to the state attributes change.
Definition at line 831 of file __init__.py.
| None homeassistant.components.camera.Camera.async_turn_off | ( | self | ) |
Turn off camera.
Reimplemented in homeassistant.components.netatmo.camera.NetatmoCamera, homeassistant.components.fully_kiosk.camera.FullyCameraEntity, homeassistant.components.demo.camera.DemoCamera, and homeassistant.components.amcrest.camera.AmcrestCam.
Definition at line 769 of file __init__.py.
| None homeassistant.components.camera.Camera.async_turn_on | ( | self | ) |
Turn on camera.
Reimplemented in homeassistant.components.netatmo.camera.NetatmoCamera, homeassistant.components.fully_kiosk.camera.FullyCameraEntity, homeassistant.components.demo.camera.DemoCamera, and homeassistant.components.amcrest.camera.AmcrestCam.
Definition at line 777 of file __init__.py.
| None homeassistant.components.camera.Camera.async_update_token | ( | self | ) |
Update the used token.
Definition at line 818 of file __init__.py.
| None homeassistant.components.camera.Camera.async_write_ha_state | ( | self | ) |
Write the state to the state machine. Schedules async_refresh_providers if support of streams have changed.
Reimplemented from homeassistant.helpers.entity.Entity.
Definition at line 939 of file __init__.py.
| bool homeassistant.components.camera.Camera.available | ( | self | ) |
Return True if entity is available.
Reimplemented from homeassistant.helpers.entity.Entity.
Reimplemented in homeassistant.components.synology_dsm.camera.SynoDSMCamera, homeassistant.components.prusalink.camera.PrusaLinkJobPreviewEntity, homeassistant.components.nest.camera.NestRTSPEntity, homeassistant.components.neato.camera.NeatoCleaningMap, homeassistant.components.motioneye.camera.MotionEyeMjpegCamera, homeassistant.components.hyperion.camera.HyperionCamera, homeassistant.components.ezviz.camera.EzvizCamera, and homeassistant.components.amcrest.camera.AmcrestCam.
Definition at line 609 of file __init__.py.
Return the camera brand.
Reimplemented in homeassistant.components.yi.camera.YiCamera, homeassistant.components.xiaomi.camera.XiaomiCamera, homeassistant.components.vivotek.camera.VivotekCam, homeassistant.components.qvr_pro.camera.QVRProCamera, homeassistant.components.blink.camera.BlinkCamera, and homeassistant.components.amcrest.camera.AmcrestCam.
Definition at line 555 of file __init__.py.
| CameraCapabilities homeassistant.components.camera.Camera.camera_capabilities | ( | self | ) |
Return the camera capabilities.
Definition at line 923 of file __init__.py.
| bytes | None homeassistant.components.camera.Camera.camera_image | ( | self, | |
| int | None | width = None, |
||
| int | None | height = None |
||
| ) |
Return bytes of camera image.
Reimplemented in homeassistant.components.vivotek.camera.VivotekCam, homeassistant.components.verisure.camera.VerisureSmartcam, homeassistant.components.uvc.camera.UnifiVideoCamera, homeassistant.components.rpi_camera.camera.RaspberryCamera, homeassistant.components.qvr_pro.camera.QVRProCamera, homeassistant.components.proxy.camera.ProxyCamera, homeassistant.components.neato.camera.NeatoCleaningMap, homeassistant.components.local_file.camera.LocalFile, homeassistant.components.foscam.camera.HassFoscamCamera, homeassistant.components.environment_canada.camera.ECCamera, homeassistant.components.blink.camera.BlinkCamera, and homeassistant.components.abode.camera.AbodeCamera.
Definition at line 718 of file __init__.py.
Close a WebRTC session.
Reimplemented in homeassistant.components.ring.camera.RingCam, and homeassistant.components.nest.camera.NestWebRTCEntity.
Definition at line 911 of file __init__.py.
| None homeassistant.components.camera.Camera.disable_motion_detection | ( | self | ) |
Disable motion detection in camera.
Reimplemented in homeassistant.components.vivotek.camera.VivotekCam, homeassistant.components.uvc.camera.UnifiVideoCamera, homeassistant.components.foscam.camera.HassFoscamCamera, and homeassistant.components.ezviz.camera.EzvizCamera.
Definition at line 789 of file __init__.py.
| None homeassistant.components.camera.Camera.enable_motion_detection | ( | self | ) |
Enable motion detection in the camera.
Reimplemented in homeassistant.components.vivotek.camera.VivotekCam, homeassistant.components.uvc.camera.UnifiVideoCamera, homeassistant.components.foscam.camera.HassFoscamCamera, and homeassistant.components.ezviz.camera.EzvizCamera.
Definition at line 781 of file __init__.py.
| str homeassistant.components.camera.Camera.entity_picture | ( | self | ) |
Return a link to the camera feed as entity picture.
Reimplemented from homeassistant.helpers.entity.Entity.
Definition at line 515 of file __init__.py.
| float homeassistant.components.camera.Camera.frame_interval | ( | self | ) |
Return the interval between frames of the mjpeg stream.
Reimplemented in homeassistant.components.vivotek.camera.VivotekCam, and homeassistant.components.rpi_camera.camera.RaspberryCamera.
Definition at line 570 of file __init__.py.
| StreamType | None homeassistant.components.camera.Camera.frontend_stream_type | ( | self | ) |
Return the type of stream supported by this camera. A camera may have a single stream type which is used to inform the frontend which camera attributes and player to use. The default type is to use HLS, and components can override to change the type.
Definition at line 575 of file __init__.py.
| web.StreamResponse | None homeassistant.components.camera.Camera.handle_async_mjpeg_stream | ( | self, | |
| web.Request | request | ||
| ) |
Serve an HTTP MJPEG stream from the camera. This method can be overridden by camera platforms to proxy a direct stream from the camera.
Reimplemented in homeassistant.components.skybell.camera.SkybellActivityCamera, homeassistant.components.ring.camera.RingCam, homeassistant.components.mjpeg.camera.MjpegCamera, homeassistant.components.hyperion.camera.HyperionCamera, homeassistant.components.ffmpeg.camera.FFmpegCamera, homeassistant.components.esphome.camera.EsphomeCamera, and homeassistant.components.amcrest.camera.AmcrestCam.
Definition at line 740 of file __init__.py.
| web.StreamResponse homeassistant.components.camera.Camera.handle_async_still_stream | ( | self, | |
| web.Request | request, | ||
| float | interval | ||
| ) |
Generate an HTTP MJPEG stream from camera images.
Definition at line 732 of file __init__.py.
| bool homeassistant.components.camera.Camera.is_on | ( | self | ) |
Return true if on.
Reimplemented in homeassistant.components.yi.camera.YiCamera, homeassistant.components.trafikverket_camera.camera.TVCamera, homeassistant.components.hyperion.camera.HyperionCamera, homeassistant.components.ezviz.camera.EzvizCamera, homeassistant.components.amcrest.camera.AmcrestCam, and homeassistant.components.abode.camera.AbodeCamera.
Definition at line 761 of file __init__.py.
| bool homeassistant.components.camera.Camera.is_recording | ( | self | ) |
Return true if the device is recording.
Reimplemented in homeassistant.components.yale.camera.YaleCamera, homeassistant.components.uvc.camera.UnifiVideoCamera, homeassistant.components.synology_dsm.camera.SynoDSMCamera, homeassistant.components.ezviz.camera.EzvizCamera, homeassistant.components.canary.camera.CanaryCamera, homeassistant.components.august.camera.AugustCamera, and homeassistant.components.amcrest.camera.AmcrestCam.
Definition at line 545 of file __init__.py.
| bool homeassistant.components.camera.Camera.is_streaming | ( | self | ) |
Return true if the device is streaming.
Definition at line 550 of file __init__.py.
Return the camera model.
Reimplemented in homeassistant.components.xiaomi.camera.XiaomiCamera, homeassistant.components.vivotek.camera.VivotekCam, homeassistant.components.uvc.camera.UnifiVideoCamera, homeassistant.components.qvr_pro.camera.QVRProCamera, and homeassistant.components.amcrest.camera.AmcrestCam.
Definition at line 565 of file __init__.py.
| bool homeassistant.components.camera.Camera.motion_detection_enabled | ( | self | ) |
Return the camera motion detection status.
Reimplemented in homeassistant.components.vivotek.camera.VivotekCam, homeassistant.components.uvc.camera.UnifiVideoCamera, homeassistant.components.synology_dsm.camera.SynoDSMCamera, homeassistant.components.push.camera.PushCamera, homeassistant.components.motioneye.camera.MotionEyeMjpegCamera, homeassistant.components.ezviz.camera.EzvizCamera, homeassistant.components.canary.camera.CanaryCamera, homeassistant.components.blink.camera.BlinkCamera, and homeassistant.components.amcrest.camera.AmcrestCam.
Definition at line 560 of file __init__.py.
| str homeassistant.components.camera.Camera.state | ( | self | ) |
Return the camera state.
Reimplemented from homeassistant.helpers.entity.Entity.
Definition at line 752 of file __init__.py.
Return the camera state attributes.
Reimplemented from homeassistant.helpers.entity.Entity.
Definition at line 799 of file __init__.py.
Return the source of the stream. This is used by cameras with CameraEntityFeature.STREAM and StreamType.HLS.
Reimplemented in homeassistant.components.vivotek.camera.VivotekCam, homeassistant.components.uvc.camera.UnifiVideoCamera, homeassistant.components.unifiprotect.camera.ProtectCamera, homeassistant.components.synology_dsm.camera.SynoDSMCamera, homeassistant.components.reolink.camera.ReolinkCamera, homeassistant.components.qvr_pro.camera.QVRProCamera, homeassistant.components.onvif.camera.ONVIFCameraEntity, homeassistant.components.netatmo.camera.NetatmoCamera, homeassistant.components.nest.camera.NestRTSPEntity, homeassistant.components.mjpeg.camera.MjpegCamera, homeassistant.components.generic.camera.GenericCamera, homeassistant.components.foscam.camera.HassFoscamCamera, homeassistant.components.ffmpeg.camera.FFmpegCamera, homeassistant.components.ezviz.camera.EzvizCamera, homeassistant.components.doorbird.camera.DoorBirdCamera, and homeassistant.components.amcrest.camera.AmcrestCam.
Definition at line 638 of file __init__.py.
| CameraEntityFeature homeassistant.components.camera.Camera.supported_features | ( | self | ) |
Flag supported features.
Reimplemented from homeassistant.helpers.entity.Entity.
Reimplemented in homeassistant.components.uvc.camera.UnifiVideoCamera, and homeassistant.components.netatmo.camera.NetatmoCamera.
Definition at line 527 of file __init__.py.
| CameraEntityFeature homeassistant.components.camera.Camera.supported_features_compat | ( | self | ) |
Return the supported features as CameraEntityFeature. Remove this compatibility shim in 2025.1 or later.
Definition at line 532 of file __init__.py.
| None homeassistant.components.camera.Camera.turn_off | ( | self | ) |
Turn off camera.
Reimplemented in homeassistant.components.abode.camera.AbodeCamera.
Definition at line 765 of file __init__.py.
| None homeassistant.components.camera.Camera.turn_on | ( | self | ) |
Turn on camera.
Reimplemented in homeassistant.components.abode.camera.AbodeCamera.
Definition at line 773 of file __init__.py.
| bool homeassistant.components.camera.Camera.use_stream_for_stills | ( | self | ) |
Whether or not to use stream to generate stills.
Reimplemented in homeassistant.components.onvif.camera.ONVIFCameraEntity, homeassistant.components.nest.camera.NestRTSPEntity, and homeassistant.components.generic.camera.GenericCamera.
Definition at line 522 of file __init__.py.
|
private |
Definition at line 826 of file __init__.py.
|
private |
Definition at line 619 of file __init__.py.
|
private |
Definition at line 503 of file __init__.py.
|
staticprivate |
Definition at line 464 of file __init__.py.
|
private |
Definition at line 859 of file __init__.py.
|
private |
Definition at line 499 of file __init__.py.
|
private |
Definition at line 496 of file __init__.py.
|
private |
Definition at line 491 of file __init__.py.
|
private |
Definition at line 858 of file __init__.py.
|
static |
Definition at line 473 of file __init__.py.
|
static |
Definition at line 480 of file __init__.py.
|
static |
Definition at line 470 of file __init__.py.
|
static |
Definition at line 469 of file __init__.py.
| homeassistant.components.camera.Camera.stream |
Definition at line 626 of file __init__.py.