CameraState

Inherits: Event['Camera']

Snapshot of the camera controller state.

Properties

• aspect_ratio(Number | None) –

  Preview aspect ratio, when available.

• description(CameraDescription | None) –

  The underlying camera description.

• device_orientation(DeviceOrientation | None) –

  Current device UI orientation.

• error_description(str | None) –

  Error message when the controller has an error.

• exposure_mode(ExposureMode | None) –

  Active exposure mode.

• exposure_point_supported(bool | None) –

  Whether custom exposure points are supported.

• flash_mode(FlashMode | None) –

  Active flash mode.

• focus_mode(FocusMode | None) –

  Active focus mode.

• focus_point_supported(bool | None) –

  Whether custom focus points are supported.

• has_error(bool | None) –

  Indicates if the controller is in an error state.

• is_capture_orientation_locked(bool) –

  True if capture orientation is locked.

• is_initialized(bool) –

  Whether the controller has been initialized.

• is_preview_paused(bool) –

  True when the preview has been manually paused.

• is_recording_paused(bool) –

  Whether an active recording is currently paused.

• is_recording_video(bool) –

  Whether a video recording is in progress.

• is_streaming_images(bool) –

  True when image streaming is running.

• is_taking_picture(bool) –

  True while a still capture is underway.

• locked_capture_orientation(DeviceOrientation | None) –

  Orientation used when capture orientation is locked.

• preview_pause_orientation(DeviceOrientation | None) –

  Orientation used when the preview was paused.

• preview_size(CameraPreviewSize | None) –

  Preview dimensions, when available.

• recording_orientation(DeviceOrientation | None) –

  Orientation used for the current recording.

Properties

aspect_ratio class-attribute instance-attribute

aspect_ratio: Number | None = None

Preview aspect ratio, when available.

description class-attribute instance-attribute

description: CameraDescription | None = None

The underlying camera description.

device_orientation class-attribute instance-attribute

device_orientation: DeviceOrientation | None = None

Current device UI orientation.

error_description class-attribute instance-attribute

error_description: str | None = None

Error message when the controller has an error.

exposure_mode class-attribute instance-attribute

exposure_mode: ExposureMode | None = None

Active exposure mode.

exposure_point_supported class-attribute instance-attribute

exposure_point_supported: bool | None = None

Whether custom exposure points are supported.

flash_mode class-attribute instance-attribute

flash_mode: FlashMode | None = None

Active flash mode.

focus_mode class-attribute instance-attribute

focus_mode: FocusMode | None = None

Active focus mode.

focus_point_supported class-attribute instance-attribute

focus_point_supported: bool | None = None

Whether custom focus points are supported.

has_error class-attribute instance-attribute

has_error: bool | None = None

Indicates if the controller is in an error state.

is_capture_orientation_locked instance-attribute

is_capture_orientation_locked: bool

True if capture orientation is locked.

is_initialized instance-attribute

is_initialized: bool

Whether the controller has been initialized.

is_preview_paused instance-attribute

is_preview_paused: bool

True when the preview has been manually paused.

is_recording_paused instance-attribute

is_recording_paused: bool

Whether an active recording is currently paused.

is_recording_video instance-attribute

is_recording_video: bool

Whether a video recording is in progress.

is_streaming_images instance-attribute

is_streaming_images: bool

True when image streaming is running.

is_taking_picture instance-attribute

is_taking_picture: bool

True while a still capture is underway.

locked_capture_orientation class-attribute instance-attribute

locked_capture_orientation: DeviceOrientation | None = None

Orientation used when capture orientation is locked.

preview_pause_orientation class-attribute instance-attribute

preview_pause_orientation: DeviceOrientation | None = None

Orientation used when the preview was paused.

preview_size class-attribute instance-attribute

preview_size: CameraPreviewSize | None = None

Preview dimensions, when available.

recording_orientation class-attribute instance-attribute

recording_orientation: DeviceOrientation | None = None

Orientation used for the current recording.