CameraStateEvent

Snapshot of the camera controller state.

Inherits: Event

Properties

• aspect_ratio - Preview aspect ratio, when available.
• description - The underlying camera description.
• device_orientation - Current device UI orientation.
• error_description - Error message when the controller has an error.
• exposure_mode - Active exposure mode.
• exposure_point_supported - Whether custom exposure points are supported.
• flash_mode - Active flash mode.
• focus_mode - Active focus mode.
• focus_point_supported - Whether custom focus points are supported.
• has_error - Indicates if the controller is in an error state.
• is_capture_orientation_locked - True if capture orientation is locked.
• is_initialized - Whether the controller has been initialized.
• is_preview_paused - True when the preview has been manually paused.
• is_recording_paused - Whether an active recording is currently paused.
• is_recording_video - Whether a video recording is in progress.
• is_streaming_images - True when image streaming is running.
• is_taking_picture - True while a still capture is underway.
• locked_capture_orientation - Orientation used when capture orientation is locked.
• preview_pause_orientation - Orientation used when the preview was paused.
• preview_size - Preview dimensions, when available.
• recording_orientation - Orientation used for the current recording.

Properties

buildaspect_ratioclass-attributeinstance-attribute

aspect_ratio: Optional[Number] = None

Preview aspect ratio, when available.

builddescriptionclass-attributeinstance-attribute

description: Optional[CameraDescription] = None

The underlying camera description.

builddevice_orientationclass-attributeinstance-attribute

device_orientation: Optional[DeviceOrientation] = None

Current device UI orientation.

builderror_descriptionclass-attributeinstance-attribute

error_description: Optional[str] = None

Error message when the controller has an error.

buildexposure_modeclass-attributeinstance-attribute

exposure_mode: Optional[ExposureMode] = None

Active exposure mode.

buildexposure_point_supportedclass-attributeinstance-attribute

exposure_point_supported: Optional[bool] = None

Whether custom exposure points are supported.

buildflash_modeclass-attributeinstance-attribute

flash_mode: Optional[FlashMode] = None

Active flash mode.

buildfocus_modeclass-attributeinstance-attribute

focus_mode: Optional[FocusMode] = None

Active focus mode.

buildfocus_point_supportedclass-attributeinstance-attribute

focus_point_supported: Optional[bool] = None

Whether custom focus points are supported.

buildhas_errorclass-attributeinstance-attribute

has_error: Optional[bool] = None

Indicates if the controller is in an error state.

buildis_capture_orientation_lockedinstance-attribute

is_capture_orientation_locked: bool

True if capture orientation is locked.

buildis_initializedinstance-attribute

is_initialized: bool

Whether the controller has been initialized.

buildis_preview_pausedinstance-attribute

is_preview_paused: bool

True when the preview has been manually paused.

buildis_recording_pausedinstance-attribute

is_recording_paused: bool

Whether an active recording is currently paused.

buildis_recording_videoinstance-attribute

is_recording_video: bool

Whether a video recording is in progress.

buildis_streaming_imagesinstance-attribute

is_streaming_images: bool

True when image streaming is running.

buildis_taking_pictureinstance-attribute

is_taking_picture: bool

True while a still capture is underway.

buildlocked_capture_orientationclass-attributeinstance-attribute

locked_capture_orientation: Optional[DeviceOrientation] = None

Orientation used when capture orientation is locked.

buildpreview_pause_orientationclass-attributeinstance-attribute

preview_pause_orientation: Optional[DeviceOrientation] = None

Orientation used when the preview was paused.

buildpreview_sizeclass-attributeinstance-attribute

preview_size: Optional[CameraPreviewSize] = None

Preview dimensions, when available.

buildrecording_orientationclass-attributeinstance-attribute

recording_orientation: Optional[DeviceOrientation] = None

Orientation used for the current recording.