CameraControl

This message is used for controlling the color camera as well as the mono camera. The message handles things like capturing still images, configuring auto focus, anti banding, white balance, scenes, effects etc.

Reference

class depthai.CameraControl

CameraControl message. Specifies various camera control commands like:

  • Still capture

  • Auto focus

  • Anti banding

  • Auto white balance

  • Scene

  • Effect

class AntiBandingMode

Members:

OFF

MAINS_50_HZ

MAINS_60_HZ

AUTO

property name
class AutoFocusMode

Members:

OFF

AUTO

MACRO

CONTINUOUS_VIDEO

CONTINUOUS_PICTURE

EDOF

property name
class AutoWhiteBalanceMode

Members:

OFF

AUTO

INCANDESCENT

FLUORESCENT

WARM_FLUORESCENT

DAYLIGHT

CLOUDY_DAYLIGHT

TWILIGHT

SHADE

property name
class Command

Members:

START_STREAM

STOP_STREAM

STILL_CAPTURE

MOVE_LENS

AF_TRIGGER

AE_MANUAL

AE_AUTO

AWB_MODE

SCENE_MODE

ANTIBANDING_MODE

EXPOSURE_COMPENSATION

AE_LOCK

AE_TARGET_FPS_RANGE

AWB_LOCK

CAPTURE_INTENT

CONTROL_MODE

FRAME_DURATION

SENSITIVITY

EFFECT_MODE

AF_MODE

NOISE_REDUCTION_STRENGTH

SATURATION

BRIGHTNESS

STREAM_FORMAT

RESOLUTION

SHARPNESS

CUSTOM_USECASE

CUSTOM_CAPT_MODE

CUSTOM_EXP_BRACKETS

CUSTOM_CAPTURE

CONTRAST

AE_REGION

AF_REGION

LUMA_DENOISE

CHROMA_DENOISE

WB_COLOR_TEMP

property name
class EffectMode

Members:

OFF

MONO

NEGATIVE

SOLARIZE

SEPIA

POSTERIZE

WHITEBOARD

BLACKBOARD

AQUA

property name
class SceneMode

Members:

UNSUPPORTED

FACE_PRIORITY

ACTION

PORTRAIT

LANDSCAPE

NIGHT

NIGHT_PORTRAIT

THEATRE

BEACH

SNOW

SUNSET

STEADYPHOTO

FIREWORKS

SPORTS

PARTY

CANDLELIGHT

BARCODE

property name
getCaptureStill(self: depthai.CameraControl)bool

Check whether command to capture a still is set

Returns

True if capture still command is set

getData(self: object) → numpy.ndarray[numpy.uint8]

Get non-owning reference to internal buffer

Returns

Reference to internal buffer

getRaw(self: depthai.ADatatype)depthai.RawBuffer
setAntiBandingMode(self: depthai.CameraControl, mode: depthai.RawCameraControl.AntiBandingMode)depthai.CameraControl

Set a command to specify auto banding mode

Parameter mode:

Auto banding mode to use

setAutoExposureCompensation(self: depthai.CameraControl, compensation: int)depthai.CameraControl

Set a command to specify auto exposure compensation

Parameter compensation:

Compensation value between -9..9

setAutoExposureEnable(self: depthai.CameraControl)depthai.CameraControl

Set a command to enable auto exposure

setAutoExposureLock(self: depthai.CameraControl, lock: bool)depthai.CameraControl

Set a command to specify lock auto exposure

Parameter lock:

Auto exposure lock mode enabled or disabled

setAutoExposureRegion(self: depthai.CameraControl, startX: int, startY: int, width: int, height: int)depthai.CameraControl

Set a command to specify auto exposure region in pixels

Parameter startX:

X coordinate of top left corner of region

Parameter startY:

Y coordinate of top left corner of region

Parameter width:

Region width

Parameter height:

Region height

setAutoFocusMode(self: depthai.CameraControl, mode: depthai.RawCameraControl.AutoFocusMode)depthai.CameraControl

Set a command to specify autofocus mode

setAutoFocusRegion(self: depthai.CameraControl, startX: int, startY: int, width: int, height: int)depthai.CameraControl

Set a command to specify focus region in pixels

Parameter startX:

X coordinate of top left corner of region

Parameter startY:

Y coordinate of top left corner of region

Parameter width:

Region width

Parameter height:

Region height

setAutoFocusTrigger(self: depthai.CameraControl)depthai.CameraControl

Set a command to trigger autofocus

setAutoWhiteBalanceLock(self: depthai.CameraControl, lock: bool)depthai.CameraControl

Set a command to specify auto white balance lock

Parameter lock:

Auto white balance lock mode enabled or disabled

setAutoWhiteBalanceMode(self: depthai.CameraControl, mode: depthai.RawCameraControl.AutoWhiteBalanceMode)depthai.CameraControl

Set a command to specify auto white balance mode

Parameter mode:

Auto white balance mode to use

setBrightness(self: depthai.CameraControl, value: int)depthai.CameraControl

Set a command to adjust image brightness

Parameter value:

Brightness, range -10..10

setCaptureStill(self: depthai.CameraControl, capture: bool)depthai.CameraControl

Set a command to capture a still image

setChromaDenoise(self: depthai.CameraControl, value: int)depthai.CameraControl

Set a command to adjust chroma denoise amount

Parameter value:

Chroma denoise amount, range 0..4

setContrast(self: depthai.CameraControl, value: int)depthai.CameraControl

Set a command to adjust image contrast

Parameter value:

Contrast, range -10..10

setData(*args, **kwargs)

Overloaded function.

  1. setData(self: depthai.Buffer, arg0: List[int]) -> None

Parameter data:

Copies data to internal buffer

  1. setData(self: depthai.Buffer, arg0: numpy.ndarray[numpy.uint8]) -> None

Parameter data:

Copies data to internal buffer

setEffectMode(self: depthai.CameraControl, mode: depthai.RawCameraControl.EffectMode)depthai.CameraControl

Set a command to specify effect mode

Parameter mode:

Effect mode

setLumaDenoise(self: depthai.CameraControl, value: int)depthai.CameraControl

Set a command to adjust luma denoise amount

Parameter value:

Luma denoise amount, range 0..4

setManualExposure(self: depthai.CameraControl, exposureTimeUs: int, sensitivityIso: int)depthai.CameraControl

Set a command to manually specify exposure

Parameter exposureTimeUs:

Exposure time in microseconds

Parameter sensitivityIso:

Sensitivity as ISO value, usual range 100..1600

setManualFocus(self: depthai.CameraControl, lensPosition: int)depthai.CameraControl

Set a command to specify manual focus position

Parameter lensPosition:

specify lens position 0..255

setManualWhiteBalance(self: depthai.CameraControl, colorTemperatureK: int)depthai.CameraControl

Set a command to manually specify white-balance color correction

Parameter colorTemperatureK:

Light source color temperature in kelvins, range 1000..12000

setSaturation(self: depthai.CameraControl, value: int)depthai.CameraControl

Set a command to adjust image saturation

Parameter value:

Saturation, range -10..10

setSceneMode(self: depthai.CameraControl, mode: depthai.RawCameraControl.SceneMode)depthai.CameraControl

Set a command to specify scene mode

Parameter mode:

Scene mode

setSharpness(self: depthai.CameraControl, value: int)depthai.CameraControl

Set a command to adjust image sharpness

Parameter value:

Sharpness, range 0..4

setStartStreaming(self: depthai.CameraControl)depthai.CameraControl

Set a command to start streaming

setStopStreaming(self: depthai.CameraControl)depthai.CameraControl

Set a command to stop streaming

class dai::CameraControl : public dai::Buffer

CameraControl message. Specifies various camera control commands like:

  • Still capture

  • Auto focus

  • Anti banding

  • Auto white balance

  • Scene

  • Effect

Public Types

using AutoFocusMode = RawCameraControl::AutoFocusMode
using AntiBandingMode = RawCameraControl::AntiBandingMode
using AutoWhiteBalanceMode = RawCameraControl::AutoWhiteBalanceMode
using SceneMode = RawCameraControl::SceneMode
using EffectMode = RawCameraControl::EffectMode

Public Functions

CameraControl()

Construct CameraControl message.

CameraControl(std::shared_ptr<RawCameraControl> ptr)
~CameraControl() = default
CameraControl &setCaptureStill(bool capture)

Set a command to capture a still image

CameraControl &setStartStreaming()

Set a command to start streaming

CameraControl &setStopStreaming()

Set a command to stop streaming

CameraControl &setAutoFocusMode(AutoFocusMode mode)

Set a command to specify autofocus mode

CameraControl &setAutoFocusTrigger()

Set a command to trigger autofocus

CameraControl &setAutoFocusRegion(uint16_t startX, uint16_t startY, uint16_t width, uint16_t height)

Set a command to specify focus region in pixels

Parameters
  • startX: X coordinate of top left corner of region

  • startY: Y coordinate of top left corner of region

  • width: Region width

  • height: Region height

CameraControl &setManualFocus(uint8_t lensPosition)

Set a command to specify manual focus position

Parameters
  • lensPosition: specify lens position 0..255

CameraControl &setAutoExposureEnable()

Set a command to enable auto exposure

CameraControl &setAutoExposureLock(bool lock)

Set a command to specify lock auto exposure

Parameters
  • lock: Auto exposure lock mode enabled or disabled

CameraControl &setAutoExposureRegion(uint16_t startX, uint16_t startY, uint16_t width, uint16_t height)

Set a command to specify auto exposure region in pixels

Parameters
  • startX: X coordinate of top left corner of region

  • startY: Y coordinate of top left corner of region

  • width: Region width

  • height: Region height

CameraControl &setAutoExposureCompensation(int compensation)

Set a command to specify auto exposure compensation

Parameters
  • compensation: Compensation value between -9..9

CameraControl &setAntiBandingMode(AntiBandingMode mode)

Set a command to specify auto banding mode

Parameters
  • mode: Auto banding mode to use

CameraControl &setManualExposure(uint32_t exposureTimeUs, uint32_t sensitivityIso)

Set a command to manually specify exposure

Parameters
  • exposureTimeUs: Exposure time in microseconds

  • sensitivityIso: Sensitivity as ISO value, usual range 100..1600

CameraControl &setAutoWhiteBalanceMode(AutoWhiteBalanceMode mode)

Set a command to specify auto white balance mode

Parameters
  • mode: Auto white balance mode to use

CameraControl &setAutoWhiteBalanceLock(bool lock)

Set a command to specify auto white balance lock

Parameters
  • lock: Auto white balance lock mode enabled or disabled

CameraControl &setManualWhiteBalance(int colorTemperatureK)

Set a command to manually specify white-balance color correction

Parameters
  • colorTemperatureK: Light source color temperature in kelvins, range 1000..12000

CameraControl &setBrightness(int value)

Set a command to adjust image brightness

Parameters
  • value: Brightness, range -10..10

CameraControl &setContrast(int value)

Set a command to adjust image contrast

Parameters
  • value: Contrast, range -10..10

CameraControl &setSaturation(int value)

Set a command to adjust image saturation

Parameters
  • value: Saturation, range -10..10

CameraControl &setSharpness(int value)

Set a command to adjust image sharpness

Parameters
  • value: Sharpness, range 0..4

CameraControl &setLumaDenoise(int value)

Set a command to adjust luma denoise amount

Parameters
  • value: Luma denoise amount, range 0..4

CameraControl &setChromaDenoise(int value)

Set a command to adjust chroma denoise amount

Parameters
  • value: Chroma denoise amount, range 0..4

CameraControl &setSceneMode(SceneMode mode)

Set a command to specify scene mode

Parameters
  • mode: Scene mode

CameraControl &setEffectMode(EffectMode mode)

Set a command to specify effect mode

Parameters
  • mode: Effect mode

bool getCaptureStill() const

Check whether command to capture a still is set

Return

True if capture still command is set

Private Functions

std::shared_ptr<RawBuffer> serialize() const override

Private Members

RawCameraControl &cfg

Got questions?

We’re always happy to help with code or other questions you might have.