CameraControl¶
This message is used for controlling the color camera as well as the mono camera. The message handles things like capturing still images, confifguring auto focus, anti banding, white balance, scenes, effects etc.
Examples of functionality¶
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
-
property
-
class
AutoFocusMode
Members:
OFF
AUTO
MACRO
CONTINUOUS_VIDEO
CONTINUOUS_PICTURE
EDOF
-
property
name
-
property
-
class
AutoWhiteBalanceMode
Members:
OFF
AUTO
INCANDESCENT
FLUORESCENT
WARM_FLUORESCENT
DAYLIGHT
CLOUDY_DAYLIGHT
TWILIGHT
SHADE
-
property
name
-
property
-
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
-
property
-
class
EffectMode
Members:
OFF
MONO
NEGATIVE
SOLARIZE
SEPIA
POSTERIZE
WHITEBOARD
BLACKBOARD
AQUA
-
property
name
-
property
-
class
SceneMode
Members:
UNSUPPORTED
FACE_PRIORITY
ACTION
PORTRAIT
LANDSCAPE
NIGHT
NIGHT_PORTRAIT
THEATRE
BEACH
SNOW
SUNSET
STEADYPHOTO
FIREWORKS
SPORTS
PARTY
CANDLELIGHT
BARCODE
-
property
name
-
property
-
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] - Returns
Reference to internal buffer
-
getRaw
(self: depthai.ADatatype) → depthai.RawBuffer
-
setAntiBandingMode
(self: depthai.CameraControl, mode: depthai.RawCameraControl.AntiBandingMode) → None Set a command to specify auto banding mode
- Parameter
mode
: Auto banding mode to use
- Parameter
-
setAutoExposureCompensation
(self: depthai.CameraControl, compensation: int) → None Set a command to specify auto exposure compensation
- Parameter
compensation
: Compensation value between -9..9
- Parameter
-
setAutoExposureEnable
(self: depthai.CameraControl) → None Set a command to enable auto exposure
-
setAutoExposureLock
(self: depthai.CameraControl, lock: bool) → None Set a command to specify lock auto exposure
- Parameter
lock
: Auto exposure lock mode enabled or disabled
- Parameter
-
setAutoExposureRegion
(self: depthai.CameraControl, startX: int, startY: int, width: int, height: int) → None 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
- Parameter
-
setAutoFocusMode
(self: depthai.CameraControl, mode: depthai.RawCameraControl.AutoFocusMode) → None Set a command to specify autofocus mode
-
setAutoFocusRegion
(self: depthai.CameraControl, startX: int, startY: int, width: int, height: int) → None 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
- Parameter
-
setAutoFocusTrigger
(self: depthai.CameraControl) → None Set a command to trigger autofocus
-
setAutoWhiteBalanceLock
(self: depthai.CameraControl, lock: bool) → None Set a command to specify auto white balance lock
- Parameter
lock
: Auto white balance lock mode enabled or disabled
- Parameter
-
setAutoWhiteBalanceMode
(self: depthai.CameraControl, mode: depthai.RawCameraControl.AutoWhiteBalanceMode) → None Set a command to specify auto white balance mode
- Parameter
mode
: Auto white balance mode to use
- Parameter
-
setBrightness
(self: depthai.CameraControl, value: int) → None Set a command to adjust image brightness
- Parameter
value
: Brightness, range -10..10
- Parameter
-
setCaptureStill
(self: depthai.CameraControl, capture: bool) → None Set a command to capture a still image
-
setChromaDenoise
(self: depthai.CameraControl, value: int) → None Set a command to adjust chroma denoise amount
- Parameter
value
: Chroma denoise amount, range 0..4
- Parameter
-
setContrast
(self: depthai.CameraControl, value: int) → None Set a command to adjust image contrast
- Parameter
value
: Contrast, range -10..10
- Parameter
-
setData
(*args, **kwargs) Overloaded function.
setData(self: depthai.Buffer, arg0: List[int]) -> None
- Parameter
data
: Copies data to internal buffer
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) → None Set a command to specify effect mode
- Parameter
mode
: Effect mode
- Parameter
-
setLumaDenoise
(self: depthai.CameraControl, value: int) → None Set a command to adjust luma denoise amount
- Parameter
value
: Luma denoise amount, range 0..4
- Parameter
-
setManualExposure
(self: depthai.CameraControl, exposureTimeUs: int, sensitivityIso: int) → None Set a command to manually specify exposure
- Parameter
exposureTimeUs
: Exposure time in microseconds
- Parameter
sensitivityIso
: Sensitivity as ISO value, usual range 100..1600
- Parameter
-
setManualFocus
(self: depthai.CameraControl, lensPosition: int) → None Set a command to specify manual focus position
- Parameter
lensPosition
: specify lens position 0..255
- Parameter
-
setManualWhiteBalance
(self: depthai.CameraControl, colorTemperatureK: int) → None Set a command to manually specify white-balance color correction
- Parameter
colorTemperatureK
: Light source color temperature in kelvins, range 1000..12000
- Parameter
-
setSaturation
(self: depthai.CameraControl, value: int) → None Set a command to adjust image saturation
- Parameter
value
: Saturation, range -10..10
- Parameter
-
setSceneMode
(self: depthai.CameraControl, mode: depthai.RawCameraControl.SceneMode) → None Set a command to specify scene mode
- Parameter
mode
: Scene mode
- Parameter
-
setSharpness
(self: depthai.CameraControl, value: int) → None Set a command to adjust image sharpness
- Parameter
value
: Sharpness, range 0..4
- Parameter
-
setStartStreaming
(self: depthai.CameraControl) → None Set a command to start streaming
-
setStopStreaming
(self: depthai.CameraControl) → None 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
() = default¶
-
void
setCaptureStill
(bool capture)¶ Set a command to capture a still image
-
void
setStartStreaming
()¶ Set a command to start streaming
-
void
setStopStreaming
()¶ Set a command to stop streaming
-
void
setAutoFocusMode
(AutoFocusMode mode)¶ Set a command to specify autofocus mode
-
void
setAutoFocusTrigger
()¶ Set a command to trigger autofocus
-
void
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 regionstartY
: Y coordinate of top left corner of regionwidth
: Region widthheight
: Region height
-
void
setManualFocus
(uint8_t lensPosition)¶ Set a command to specify manual focus position
- Parameters
lensPosition
: specify lens position 0..255
-
void
setAutoExposureEnable
()¶ Set a command to enable auto exposure
-
void
setAutoExposureLock
(bool lock)¶ Set a command to specify lock auto exposure
- Parameters
lock
: Auto exposure lock mode enabled or disabled
-
void
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 regionstartY
: Y coordinate of top left corner of regionwidth
: Region widthheight
: Region height
-
void
setAutoExposureCompensation
(int compensation)¶ Set a command to specify auto exposure compensation
- Parameters
compensation
: Compensation value between -9..9
-
void
setAntiBandingMode
(AntiBandingMode mode)¶ Set a command to specify auto banding mode
- Parameters
mode
: Auto banding mode to use
-
void
setManualExposure
(uint32_t exposureTimeUs, uint32_t sensitivityIso)¶ Set a command to manually specify exposure
- Parameters
exposureTimeUs
: Exposure time in microsecondssensitivityIso
: Sensitivity as ISO value, usual range 100..1600
-
void
setAutoWhiteBalanceMode
(AutoWhiteBalanceMode mode)¶ Set a command to specify auto white balance mode
- Parameters
mode
: Auto white balance mode to use
-
void
setAutoWhiteBalanceLock
(bool lock)¶ Set a command to specify auto white balance lock
- Parameters
lock
: Auto white balance lock mode enabled or disabled
-
void
setManualWhiteBalance
(int colorTemperatureK)¶ Set a command to manually specify white-balance color correction
- Parameters
colorTemperatureK
: Light source color temperature in kelvins, range 1000..12000
-
void
setBrightness
(int value)¶ Set a command to adjust image brightness
- Parameters
value
: Brightness, range -10..10
-
void
setContrast
(int value)¶ Set a command to adjust image contrast
- Parameters
value
: Contrast, range -10..10
-
void
setSaturation
(int value)¶ Set a command to adjust image saturation
- Parameters
value
: Saturation, range -10..10
-
void
setSharpness
(int value)¶ Set a command to adjust image sharpness
- Parameters
value
: Sharpness, range 0..4
-
void
setLumaDenoise
(int value)¶ Set a command to adjust luma denoise amount
- Parameters
value
: Luma denoise amount, range 0..4
-
void
setChromaDenoise
(int value)¶ Set a command to adjust chroma denoise amount
- Parameters
value
: Chroma denoise amount, range 0..4
-
void
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 Members
-
RawCameraControl &
cfg
¶
Got questions?
We’re always happy to help with code or other questions you might have.