CameraController class

High-level controller that mirrors the vision_camera API surface.

Quick start

// 1. Get devices (like Camera.getAvailableCameraDevices in vision_camera)
final devices = await CameraController.getAvailableCameraDevices();
final back = devices.firstWhere((d) => d.isBackCamera);

// 2. Pick a format (optional — defaults to the best available)
final format = back.formats.first;

// 3. Create and initialise
final controller = CameraController(device: back, format: format);
await controller.initialize();

// 4. Render
CameraPreview(controller: controller)
Inheritance

Constructors

CameraController({required CameraDeviceInfo device, CameraDeviceFormat? format, bool audio = false})

Properties

audio → bool
Whether to capture audio during video recording.
final
configuration → CameraConfiguration?
The last-applied declarative configuration (null until initialize).
no setter
detections → Stream<DetectionResult>
Typed native-detector results for THIS session (vision-camera-style).
no setter
device → CameraDeviceInfo
The camera device to open.
final
events → Stream<CameraSessionEvent>
Typed session events (started / stopped / error / interruption) for this session. Mirrors vision-camera's session listeners.
no setter
exposure → double
no setter
flash → FlashMode
no setter
format → CameraDeviceFormat?
The capture format to use. Defaults to the first format in device.formats.
final
frameDropReasons → Stream<FrameDropReason>
Typed frame-drop reasons for this session (vision-camera's onFrameDropped) — a sustained stream of these means the frame processor can't keep up (drop-latest backpressure is discarding frames).
no setter
frameStream → Stream<CameraFrame>
Stream of raw camera frames for this session (only active after enableFrameProcessing). Frames from other concurrently-open sessions (multi-cam, the double-buffered switch window) are filtered out.
no setter
hashCode → int
The hash code for this object.
no setterinherited
hasListeners → bool
Whether any listeners are currently registered.
no setterinherited
height → int
The height of the camera resolution.
no setter
isActive → bool
Whether the preview/camera session is active.
no setter
isInitialized → bool
True once initialize has completed successfully.
no setter
isRecording → bool
no setter
isRecordingPaused → bool
no setter
nativeDetections → Stream<Map<String, dynamic>>
Decoded native-detector results for THIS session, as parsed JSON maps ({detector, width, height, rotation, results: [...]}).
no setter
resolvedConfig → ResolvedCameraConfig?
What format negotiation actually selected — the analogue of vision-camera's onSessionConfigSelected read-back.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sensorOrientation → int
The physical orientation of the camera sensor (90/270 for portrait).
no setter
textureId → int?
The Flutter texture ID. Pass this to Texture(textureId: controller.textureId!).
no setter
thermalStates → Stream<ThermalState>
Device thermal-pressure changes while this session is open. Shed capture load (fps / resolution / HDR) as this climbs toward ThermalState.critical to avoid a HAL throttle or shutdown. Monitoring auto-starts with the session (no enable call needed).
no setter
torch → bool
no setter
width → int
The width of the camera resolution.
no setter
zoom → double
no setter

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
cancelRecording() → void
Cancels the recording and deletes the temporary file.
closeSession() → Future<void>
Closes the native camera session — freeing the camera hardware for the next open — while keeping this controller (and textureId) alive.
configure(CameraConfiguration next) → Future<void>
Applies a new declarative CameraConfiguration, updating only what changed.
disableFrameProcessing() → void
Disables raw frame delivery.
dispose() → Future<void>
Discards any resources used by the object.
override
enableFrameProcessing() → void
Enables raw frame delivery via frameStream.
focus(double x, double y) → void
Focus at the normalised coordinates (x, y) in range 0.0–1.0. Mirrors camera.focus(point) in vision_camera.
getSessionState() → SessionState
Reads the live native session state (running / resolution / fps / pixel format) as a typed SessionState.
initialize({int? width, int? height, int? fps}) → Future<void>
Opens the camera and registers the Flutter texture.
lockExposure({required bool locked}) → void
Locks / unlocks auto-exposure at its current value.
lockFocus({required bool locked}) → void
Locks / unlocks focus at its current position.
lockWhiteBalance({required bool locked}) → void
Locks / unlocks white balance at its current gains.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void
Call all the registered listeners.
inherited
pausePreview() → void
pauseRecording() → void
Pauses an active recording without finalising the file.
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
resumePreview() → void
resumeRecording() → void
Resumes a paused recording.
setActive(bool active) → void
Set isActive programmatically — starts or stops the preview stream.
setAutoFocus(AutoFocusMode mode) → void
Sets the auto-focus mode.
setDistortionCorrection({required bool enabled}) → void
Enables / disables lens distortion correction (default ON where the device supports it — API 28+). vision-camera's enableDistortionCorrection.
setExposure(double value) → void
Exposure bias in the range device.minExposure .. device.maxExposure.
setFilterShader(String glslSource) → void
Updates the GPU filter shader applied to the preview.
setFlash(FlashMode mode) → void
Flash mode for photo capture.
setFrameProcessing({required bool enabled}) → void
Enables or disables raw frame delivery via frameStream.
setHdr({required bool enabled}) → void
Enables or disables HDR mode.
setLowLightBoost({required bool enabled}) → void
Enables or disables low-light boost (night mode).
setNativeDetector(String detector) → void
Runs a NATIVE ML Kit detector on this session's frames: "barcode", "face", or "" to stop.
setPixelFormat(PixelFormat format) → void
Frame-stream pixel format.
setSamplingRate(int rate) → void
Deliver every Nth frame to frameStream (1 = every frame).
setTargetOrientation(int degrees) → void
Sets the target output orientation in degrees (0 / 90 / 180 / 270).
setTorch({required bool enabled}) → void
Continuous torch (flashlight) on/off.
setTorchLevel(double level) → void
Torch brightness in 0.0..1.0 (1.0 = max). Values > 0 imply torch on.
setVideoStabilization(VideoStabilizationMode mode) → void
Video stabilization mode.
setWhiteBalance(int kelvin) → void
White balance colour temperature in Kelvin. Pass 0 to restore auto.
setZoom(double zoom) → void
Zoom factor clamped to device.minZoom .. device.maxZoom.
startDetector(NativeDetector detector) → void
Starts a NATIVE ML Kit detector (NativeDetector.barcode / NativeDetector.face) on this session's frames. Results arrive typed on detections. Requires the host app to add the matching ML Kit dependency (documented in the README).
startRecording(String outputPath, {RecordingOptions? options}) → Future<void>
Starts recording to outputPath.
stopDetector() → void
Stops the native detector.
stopRecording() → Future<RecordingResult>
Stops and finalises the recording. Returns the file path and metadata.
takePhoto() → Future<PhotoResult>
Captures a photo. Returns the file path and metadata.
takePhotoWithOptions(PhotoCaptureOptions options) → Future<PhotoResult>
Captures a photo with explicit options (flash, quality, shutter sound…).
takeSnapshot() → Future<PhotoResult>
Captures the current preview frame as a fast JPEG snapshot (no full still-capture round-trip).
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

allEvents → Stream<CameraSessionEvent>
Typed session events across all open sessions.
no setter

Static Methods

getAvailableCameraDevices() → Future<List<CameraDeviceInfo>>
Returns all available camera devices, each with their supported formats.
getConcurrentCameraIds() → List<List<String>>
Camera-ID combinations that can stream CONCURRENTLY (multi-cam, API 30+). Each inner list is one combination that initialize can open as simultaneous CameraController instances. Empty when unsupported.
requestCameraPermission() → Future<PermissionStatus>
Shorthand: request camera permission and return the status.
requestMicrophonePermission() → Future<PermissionStatus>
Shorthand: request microphone permission and return the status.