# CameraControl

This message is used for controlling the [ColorCamera](https://docs.luxonis.com/software/depthai-components/nodes/color_camera.md)
as well as the [MonoCamera](https://docs.luxonis.com/software/depthai/examples/mono_camera_control.md). The message handles things
like capturing still images, configuring auto focus, anti banding, white balance, scenes, effects etc.

## Examples of functionality

 * [RGB Camera Control](https://docs.luxonis.com/software/depthai/examples/rgb_camera_control.md)
 * [Mono Camera Control](https://docs.luxonis.com/software/depthai/examples/mono_camera_control.md)
 * [Auto Exposure on ROI](https://docs.luxonis.com/software/depthai/examples/autoexposure_roi.md)

## Reference

### depthai.CameraControl(depthai.Buffer)

Kind: Class

CameraControl message. Specifies various camera control commands like:

- Still capture

- Auto/manual focus

- Auto/manual white balance

- Auto/manual exposure

- Anti banding

- ...

By default the camera enables 3A, with auto-focus in `CONTINUOUS_VIDEO` mode,
auto-white-balance in `AUTO` mode, and auto-exposure with anti-banding for 50Hz
mains frequency.

#### depthai.CameraControl.AntiBandingMode

Kind: Class

Members:

  OFF

  MAINS_50_HZ

  MAINS_60_HZ

  AUTO

##### AUTO: typing.ClassVar[RawCameraControl.AntiBandingMode]

Kind: Class Variable

##### MAINS_50_HZ: typing.ClassVar[RawCameraControl.AntiBandingMode]

Kind: Class Variable

##### MAINS_60_HZ: typing.ClassVar[RawCameraControl.AntiBandingMode]

Kind: Class Variable

##### OFF: typing.ClassVar[RawCameraControl.AntiBandingMode]

Kind: Class Variable

##### __members__: typing.ClassVar[dict[str, RawCameraControl.AntiBandingMode]]

Kind: Class Variable

##### __eq__(self, other: typing.Any) -> bool: bool

Kind: Method

##### __getstate__(self) -> int: int

Kind: Method

##### __hash__(self) -> int: int

Kind: Method

##### __index__(self: RawCameraControl.AntiBandingMode) -> int: int

Kind: Method

##### __init__(self: RawCameraControl.AntiBandingMode, value: typing.SupportsInt)

Kind: Method

##### __int__(self: RawCameraControl.AntiBandingMode) -> int: int

Kind: Method

##### __ne__(self, other: typing.Any) -> bool: bool

Kind: Method

##### __repr__(self) -> str: str

Kind: Method

##### __setstate__(self: RawCameraControl.AntiBandingMode, state: typing.SupportsInt)

Kind: Method

##### __str__(self) -> str: str

Kind: Method

##### name

Kind: Property

##### value

Kind: Property

#### depthai.CameraControl.AutoFocusMode

Kind: Class

Members:

  OFF

  AUTO

  MACRO

  CONTINUOUS_VIDEO

  CONTINUOUS_PICTURE

  EDOF

##### AUTO: typing.ClassVar[RawCameraControl.AutoFocusMode]

Kind: Class Variable

##### CONTINUOUS_PICTURE: typing.ClassVar[RawCameraControl.AutoFocusMode]

Kind: Class Variable

##### CONTINUOUS_VIDEO: typing.ClassVar[RawCameraControl.AutoFocusMode]

Kind: Class Variable

##### EDOF: typing.ClassVar[RawCameraControl.AutoFocusMode]

Kind: Class Variable

##### MACRO: typing.ClassVar[RawCameraControl.AutoFocusMode]

Kind: Class Variable

##### OFF: typing.ClassVar[RawCameraControl.AutoFocusMode]

Kind: Class Variable

##### __members__: typing.ClassVar[dict[str, RawCameraControl.AutoFocusMode]]

Kind: Class Variable

##### __eq__(self, other: typing.Any) -> bool: bool

Kind: Method

##### __getstate__(self) -> int: int

Kind: Method

##### __hash__(self) -> int: int

Kind: Method

##### __index__(self: RawCameraControl.AutoFocusMode) -> int: int

Kind: Method

##### __init__(self: RawCameraControl.AutoFocusMode, value: typing.SupportsInt)

Kind: Method

##### __int__(self: RawCameraControl.AutoFocusMode) -> int: int

Kind: Method

##### __ne__(self, other: typing.Any) -> bool: bool

Kind: Method

##### __repr__(self) -> str: str

Kind: Method

##### __setstate__(self: RawCameraControl.AutoFocusMode, state: typing.SupportsInt)

Kind: Method

##### __str__(self) -> str: str

Kind: Method

##### name

Kind: Property

##### value

Kind: Property

#### depthai.CameraControl.AutoWhiteBalanceMode

Kind: Class

Members:

  OFF

  AUTO

  INCANDESCENT

  FLUORESCENT

  WARM_FLUORESCENT

  DAYLIGHT

  CLOUDY_DAYLIGHT

  TWILIGHT

  SHADE

##### AUTO: typing.ClassVar[RawCameraControl.AutoWhiteBalanceMode]

Kind: Class Variable

##### CLOUDY_DAYLIGHT: typing.ClassVar[RawCameraControl.AutoWhiteBalanceMode]

Kind: Class Variable

##### DAYLIGHT: typing.ClassVar[RawCameraControl.AutoWhiteBalanceMode]

Kind: Class Variable

##### FLUORESCENT: typing.ClassVar[RawCameraControl.AutoWhiteBalanceMode]

Kind: Class Variable

##### INCANDESCENT: typing.ClassVar[RawCameraControl.AutoWhiteBalanceMode]

Kind: Class Variable

##### OFF: typing.ClassVar[RawCameraControl.AutoWhiteBalanceMode]

Kind: Class Variable

##### SHADE: typing.ClassVar[RawCameraControl.AutoWhiteBalanceMode]

Kind: Class Variable

##### TWILIGHT: typing.ClassVar[RawCameraControl.AutoWhiteBalanceMode]

Kind: Class Variable

##### WARM_FLUORESCENT: typing.ClassVar[RawCameraControl.AutoWhiteBalanceMode]

Kind: Class Variable

##### __members__: typing.ClassVar[dict[str, RawCameraControl.AutoWhiteBalanceMode]]

Kind: Class Variable

##### __eq__(self, other: typing.Any) -> bool: bool

Kind: Method

##### __getstate__(self) -> int: int

Kind: Method

##### __hash__(self) -> int: int

Kind: Method

##### __index__(self: RawCameraControl.AutoWhiteBalanceMode) -> int: int

Kind: Method

##### __init__(self: RawCameraControl.AutoWhiteBalanceMode, value: typing.SupportsInt)

Kind: Method

##### __int__(self: RawCameraControl.AutoWhiteBalanceMode) -> int: int

Kind: Method

##### __ne__(self, other: typing.Any) -> bool: bool

Kind: Method

##### __repr__(self) -> str: str

Kind: Method

##### __setstate__(self: RawCameraControl.AutoWhiteBalanceMode, state: typing.SupportsInt)

Kind: Method

##### __str__(self) -> str: str

Kind: Method

##### name

Kind: Property

##### value

Kind: Property

#### depthai.CameraControl.CaptureIntent

Kind: Class

Members:

  CUSTOM

  PREVIEW

  STILL_CAPTURE

  VIDEO_RECORD

  VIDEO_SNAPSHOT

  ZERO_SHUTTER_LAG

##### CUSTOM: typing.ClassVar[RawCameraControl.CaptureIntent]

Kind: Class Variable

##### PREVIEW: typing.ClassVar[RawCameraControl.CaptureIntent]

Kind: Class Variable

##### STILL_CAPTURE: typing.ClassVar[RawCameraControl.CaptureIntent]

Kind: Class Variable

##### VIDEO_RECORD: typing.ClassVar[RawCameraControl.CaptureIntent]

Kind: Class Variable

##### VIDEO_SNAPSHOT: typing.ClassVar[RawCameraControl.CaptureIntent]

Kind: Class Variable

##### ZERO_SHUTTER_LAG: typing.ClassVar[RawCameraControl.CaptureIntent]

Kind: Class Variable

##### __members__: typing.ClassVar[dict[str, RawCameraControl.CaptureIntent]]

Kind: Class Variable

##### __eq__(self, other: typing.Any) -> bool: bool

Kind: Method

##### __getstate__(self) -> int: int

Kind: Method

##### __hash__(self) -> int: int

Kind: Method

##### __index__(self: RawCameraControl.CaptureIntent) -> int: int

Kind: Method

##### __init__(self: RawCameraControl.CaptureIntent, value: typing.SupportsInt)

Kind: Method

##### __int__(self: RawCameraControl.CaptureIntent) -> int: int

Kind: Method

##### __ne__(self, other: typing.Any) -> bool: bool

Kind: Method

##### __repr__(self) -> str: str

Kind: Method

##### __setstate__(self: RawCameraControl.CaptureIntent, state: typing.SupportsInt)

Kind: Method

##### __str__(self) -> str: str

Kind: Method

##### name

Kind: Property

##### value

Kind: Property

#### depthai.CameraControl.Command

Kind: Class

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

##### AE_AUTO: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### AE_LOCK: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### AE_MANUAL: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### AE_REGION: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### AE_TARGET_FPS_RANGE: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### AF_MODE: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### AF_REGION: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### AF_TRIGGER: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### ANTIBANDING_MODE: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### AWB_LOCK: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### AWB_MODE: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### BRIGHTNESS: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### CAPTURE_INTENT: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### CHROMA_DENOISE: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### CONTRAST: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### CONTROL_MODE: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### CUSTOM_CAPTURE: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### CUSTOM_CAPT_MODE: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### CUSTOM_EXP_BRACKETS: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### CUSTOM_USECASE: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### EFFECT_MODE: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### EXPOSURE_COMPENSATION: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### FRAME_DURATION: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### LUMA_DENOISE: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### MOVE_LENS: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### NOISE_REDUCTION_STRENGTH: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### RESOLUTION: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### SATURATION: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### SCENE_MODE: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### SENSITIVITY: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### SHARPNESS: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### START_STREAM: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### STILL_CAPTURE: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### STOP_STREAM: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### STREAM_FORMAT: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### WB_COLOR_TEMP: typing.ClassVar[RawCameraControl.Command]

Kind: Class Variable

##### __members__: typing.ClassVar[dict[str, RawCameraControl.Command]]

Kind: Class Variable

##### __eq__(self, other: typing.Any) -> bool: bool

Kind: Method

##### __getstate__(self) -> int: int

Kind: Method

##### __hash__(self) -> int: int

Kind: Method

##### __index__(self: RawCameraControl.Command) -> int: int

Kind: Method

##### __init__(self: RawCameraControl.Command, value: typing.SupportsInt)

Kind: Method

##### __int__(self: RawCameraControl.Command) -> int: int

Kind: Method

##### __ne__(self, other: typing.Any) -> bool: bool

Kind: Method

##### __repr__(self) -> str: str

Kind: Method

##### __setstate__(self: RawCameraControl.Command, state: typing.SupportsInt)

Kind: Method

##### __str__(self) -> str: str

Kind: Method

##### name

Kind: Property

##### value

Kind: Property

#### depthai.CameraControl.ControlMode

Kind: Class

Members:

  OFF

  AUTO

  USE_SCENE_MODE

##### AUTO: typing.ClassVar[RawCameraControl.ControlMode]

Kind: Class Variable

##### OFF: typing.ClassVar[RawCameraControl.ControlMode]

Kind: Class Variable

##### USE_SCENE_MODE: typing.ClassVar[RawCameraControl.ControlMode]

Kind: Class Variable

##### __members__: typing.ClassVar[dict[str, RawCameraControl.ControlMode]]

Kind: Class Variable

##### __eq__(self, other: typing.Any) -> bool: bool

Kind: Method

##### __getstate__(self) -> int: int

Kind: Method

##### __hash__(self) -> int: int

Kind: Method

##### __index__(self: RawCameraControl.ControlMode) -> int: int

Kind: Method

##### __init__(self: RawCameraControl.ControlMode, value: typing.SupportsInt)

Kind: Method

##### __int__(self: RawCameraControl.ControlMode) -> int: int

Kind: Method

##### __ne__(self, other: typing.Any) -> bool: bool

Kind: Method

##### __repr__(self) -> str: str

Kind: Method

##### __setstate__(self: RawCameraControl.ControlMode, state: typing.SupportsInt)

Kind: Method

##### __str__(self) -> str: str

Kind: Method

##### name

Kind: Property

##### value

Kind: Property

#### depthai.CameraControl.EffectMode

Kind: Class

Members:

  OFF

  MONO

  NEGATIVE

  SOLARIZE

  SEPIA

  POSTERIZE

  WHITEBOARD

  BLACKBOARD

  AQUA

##### AQUA: typing.ClassVar[RawCameraControl.EffectMode]

Kind: Class Variable

##### BLACKBOARD: typing.ClassVar[RawCameraControl.EffectMode]

Kind: Class Variable

##### MONO: typing.ClassVar[RawCameraControl.EffectMode]

Kind: Class Variable

##### NEGATIVE: typing.ClassVar[RawCameraControl.EffectMode]

Kind: Class Variable

##### OFF: typing.ClassVar[RawCameraControl.EffectMode]

Kind: Class Variable

##### POSTERIZE: typing.ClassVar[RawCameraControl.EffectMode]

Kind: Class Variable

##### SEPIA: typing.ClassVar[RawCameraControl.EffectMode]

Kind: Class Variable

##### SOLARIZE: typing.ClassVar[RawCameraControl.EffectMode]

Kind: Class Variable

##### WHITEBOARD: typing.ClassVar[RawCameraControl.EffectMode]

Kind: Class Variable

##### __members__: typing.ClassVar[dict[str, RawCameraControl.EffectMode]]

Kind: Class Variable

##### __eq__(self, other: typing.Any) -> bool: bool

Kind: Method

##### __getstate__(self) -> int: int

Kind: Method

##### __hash__(self) -> int: int

Kind: Method

##### __index__(self: RawCameraControl.EffectMode) -> int: int

Kind: Method

##### __init__(self: RawCameraControl.EffectMode, value: typing.SupportsInt)

Kind: Method

##### __int__(self: RawCameraControl.EffectMode) -> int: int

Kind: Method

##### __ne__(self, other: typing.Any) -> bool: bool

Kind: Method

##### __repr__(self) -> str: str

Kind: Method

##### __setstate__(self: RawCameraControl.EffectMode, state: typing.SupportsInt)

Kind: Method

##### __str__(self) -> str: str

Kind: Method

##### name

Kind: Property

##### value

Kind: Property

#### depthai.CameraControl.FrameSyncMode

Kind: Class

Members:

  OFF

  OUTPUT

  INPUT

##### INPUT: typing.ClassVar[RawCameraControl.FrameSyncMode]

Kind: Class Variable

##### OFF: typing.ClassVar[RawCameraControl.FrameSyncMode]

Kind: Class Variable

##### OUTPUT: typing.ClassVar[RawCameraControl.FrameSyncMode]

Kind: Class Variable

##### __members__: typing.ClassVar[dict[str, RawCameraControl.FrameSyncMode]]

Kind: Class Variable

##### __eq__(self, other: typing.Any) -> bool: bool

Kind: Method

##### __getstate__(self) -> int: int

Kind: Method

##### __hash__(self) -> int: int

Kind: Method

##### __index__(self: RawCameraControl.FrameSyncMode) -> int: int

Kind: Method

##### __init__(self: RawCameraControl.FrameSyncMode, value: typing.SupportsInt)

Kind: Method

##### __int__(self: RawCameraControl.FrameSyncMode) -> int: int

Kind: Method

##### __ne__(self, other: typing.Any) -> bool: bool

Kind: Method

##### __repr__(self) -> str: str

Kind: Method

##### __setstate__(self: RawCameraControl.FrameSyncMode, state: typing.SupportsInt)

Kind: Method

##### __str__(self) -> str: str

Kind: Method

##### name

Kind: Property

##### value

Kind: Property

#### depthai.CameraControl.SceneMode

Kind: Class

Members:

  UNSUPPORTED

  FACE_PRIORITY

  ACTION

  PORTRAIT

  LANDSCAPE

  NIGHT

  NIGHT_PORTRAIT

  THEATRE

  BEACH

  SNOW

  SUNSET

  STEADYPHOTO

  FIREWORKS

  SPORTS

  PARTY

  CANDLELIGHT

  BARCODE

##### ACTION: typing.ClassVar[RawCameraControl.SceneMode]

Kind: Class Variable

##### BARCODE: typing.ClassVar[RawCameraControl.SceneMode]

Kind: Class Variable

##### BEACH: typing.ClassVar[RawCameraControl.SceneMode]

Kind: Class Variable

##### CANDLELIGHT: typing.ClassVar[RawCameraControl.SceneMode]

Kind: Class Variable

##### FACE_PRIORITY: typing.ClassVar[RawCameraControl.SceneMode]

Kind: Class Variable

##### FIREWORKS: typing.ClassVar[RawCameraControl.SceneMode]

Kind: Class Variable

##### LANDSCAPE: typing.ClassVar[RawCameraControl.SceneMode]

Kind: Class Variable

##### NIGHT: typing.ClassVar[RawCameraControl.SceneMode]

Kind: Class Variable

##### NIGHT_PORTRAIT: typing.ClassVar[RawCameraControl.SceneMode]

Kind: Class Variable

##### PARTY: typing.ClassVar[RawCameraControl.SceneMode]

Kind: Class Variable

##### PORTRAIT: typing.ClassVar[RawCameraControl.SceneMode]

Kind: Class Variable

##### SNOW: typing.ClassVar[RawCameraControl.SceneMode]

Kind: Class Variable

##### SPORTS: typing.ClassVar[RawCameraControl.SceneMode]

Kind: Class Variable

##### STEADYPHOTO: typing.ClassVar[RawCameraControl.SceneMode]

Kind: Class Variable

##### SUNSET: typing.ClassVar[RawCameraControl.SceneMode]

Kind: Class Variable

##### THEATRE: typing.ClassVar[RawCameraControl.SceneMode]

Kind: Class Variable

##### UNSUPPORTED: typing.ClassVar[RawCameraControl.SceneMode]

Kind: Class Variable

##### __members__: typing.ClassVar[dict[str, RawCameraControl.SceneMode]]

Kind: Class Variable

##### __eq__(self, other: typing.Any) -> bool: bool

Kind: Method

##### __getstate__(self) -> int: int

Kind: Method

##### __hash__(self) -> int: int

Kind: Method

##### __index__(self: RawCameraControl.SceneMode) -> int: int

Kind: Method

##### __init__(self: RawCameraControl.SceneMode, value: typing.SupportsInt)

Kind: Method

##### __int__(self: RawCameraControl.SceneMode) -> int: int

Kind: Method

##### __ne__(self, other: typing.Any) -> bool: bool

Kind: Method

##### __repr__(self) -> str: str

Kind: Method

##### __setstate__(self: RawCameraControl.SceneMode, state: typing.SupportsInt)

Kind: Method

##### __str__(self) -> str: str

Kind: Method

##### name

Kind: Property

##### value

Kind: Property

#### __init__(self)

Kind: Method

Construct CameraControl message

#### clearMiscControls(self)

Kind: Method

Clear the list of miscellaneous controls set by `setControl`

#### get(self) -> RawCameraControl: RawCameraControl

Kind: Method

Retrieve configuration data for CameraControl.

Returns:
    config for CameraControl

#### getCaptureStill(self) -> bool: bool

Kind: Method

Check whether command to capture a still is set

Returns:
    True if capture still command is set

#### getExposureTime(self) -> datetime.timedelta: datetime.timedelta

Kind: Method

Retrieves exposure time

#### getLensPosition(self) -> int: int

Kind: Method

Retrieves lens position, range 0..255. Returns -1 if not available

#### getLensPositionRaw(self) -> float: float

Kind: Method

Retrieves lens position, range 0.0f..1.0f.

#### getMiscControls(self) -> list [ tuple [ str, str ] ]: list [ tuple [ str, str ] ]

Kind: Method

Get the list of miscellaneous controls set by `setControl`

Returns:
    A list of <key, value> pairs as strings

#### getSensitivity(self) -> int: int

Kind: Method

Retrieves sensitivity, as an ISO value

#### set(self, config: RawCameraControl) -> CameraControl: CameraControl

Kind: Method

Set explicit configuration.

Parameter ``config``:
    Explicit configuration

#### setAntiBandingMode(self, mode: RawCameraControl.AntiBandingMode) -> CameraControl: CameraControl

Kind: Method

Set a command to specify anti-banding mode. Anti-banding / anti-flicker works in
auto-exposure mode, by controlling the exposure time to be applied in multiples
of half the mains period, for example in multiple of 10ms for 50Hz (period 20ms)
AC-powered illumination sources.

If the scene would be too bright for the smallest exposure step (10ms in the
example, with ISO at a minimum of 100), anti-banding is not effective.

Parameter ``mode``:
    Anti-banding mode to use. Default: `MAINS_50_HZ`

#### setAutoExposureCompensation(self, compensation: typing.SupportsInt) -> CameraControl: CameraControl

Kind: Method

Set a command to specify auto exposure compensation

Parameter ``compensation``:
    Compensation value between -9..9, default 0

#### setAutoExposureEnable(self) -> CameraControl: CameraControl

Kind: Method

Set a command to enable auto exposure

#### setAutoExposureLimit()

Kind: Method

#### setAutoExposureLock(self, lock: bool) -> CameraControl: CameraControl

Kind: Method

Set a command to specify lock auto exposure

Parameter ``lock``:
    Auto exposure lock mode enabled or disabled

#### setAutoExposureRegion(self, startX: typing.SupportsInt, startY: typing.SupportsInt, width: typing.SupportsInt, height: typing.SupportsInt) -> CameraControl: CameraControl

Kind: Method

Set a command to specify auto exposure region in pixels. Note: the region should
be mapped to the configured sensor resolution, before ISP scaling

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

#### setAutoFocusLensRange(self, infinityPosition: typing.SupportsInt, macroPosition: typing.SupportsInt) -> CameraControl: CameraControl

Kind: Method

Set autofocus lens range, `infinityPosition < macroPosition`, valid values
`0..255`. May help to improve autofocus in case the lens adjustment is not
typical/tuned

#### setAutoFocusMode(self, mode: RawCameraControl.AutoFocusMode) -> CameraControl: CameraControl

Kind: Method

Set a command to specify autofocus mode. Default `CONTINUOUS_VIDEO`

#### setAutoFocusRegion(self, startX: typing.SupportsInt, startY: typing.SupportsInt, width: typing.SupportsInt, height: typing.SupportsInt) -> CameraControl: CameraControl

Kind: Method

Set a command to specify focus region in pixels. Note: the region should be
mapped to the configured sensor resolution, before ISP scaling

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) -> CameraControl: CameraControl

Kind: Method

Set a command to trigger autofocus

#### setAutoWhiteBalanceLock(self, lock: bool) -> CameraControl: CameraControl

Kind: Method

Set a command to specify auto white balance lock

Parameter ``lock``:
    Auto white balance lock mode enabled or disabled

#### setAutoWhiteBalanceMode(self, mode: RawCameraControl.AutoWhiteBalanceMode) -> CameraControl: CameraControl

Kind: Method

Set a command to specify auto white balance mode

Parameter ``mode``:
    Auto white balance mode to use. Default `AUTO`

#### setBrightness(self, value: typing.SupportsInt) -> CameraControl: CameraControl

Kind: Method

Set a command to adjust image brightness

Parameter ``value``:
    Brightness, range -10..10, default 0

#### setCaptureIntent(self, mode: RawCameraControl.CaptureIntent) -> CameraControl: CameraControl

Kind: Method

Set a command to specify capture intent mode

Parameter ``mode``:
    Capture intent mode

#### setCaptureStill(self, capture: bool) -> CameraControl: CameraControl

Kind: Method

Set a command to capture a still image

#### setChromaDenoise(self, value: typing.SupportsInt) -> CameraControl: CameraControl

Kind: Method

Set a command to adjust chroma denoise amount

Parameter ``value``:
    Chroma denoise amount, range 0..4, default 1

#### setContrast(self, value: typing.SupportsInt) -> CameraControl: CameraControl

Kind: Method

Set a command to adjust image contrast

Parameter ``value``:
    Contrast, range -10..10, default 0

#### setControlMode(self, mode: RawCameraControl.ControlMode) -> CameraControl: CameraControl

Kind: Method

Set a command to specify control mode

Parameter ``mode``:
    Control mode

#### setEffectMode(self, mode: RawCameraControl.EffectMode) -> CameraControl: CameraControl

Kind: Method

Set a command to specify effect mode

Parameter ``mode``:
    Effect mode

#### setExternalTrigger(self, numFramesBurst: typing.SupportsInt, numFramesDiscard: typing.SupportsInt) -> CameraControl: CameraControl

Kind: Method

Set a command to enable external trigger snapshot mode

A rising edge on the sensor FSIN pin will make it capture a sequence of
`numFramesBurst` frames. First `numFramesDiscard` will be skipped as configured
(can be set to 0 as well), as they may have degraded quality

#### setFrameSyncMode(self, mode: RawCameraControl.FrameSyncMode) -> CameraControl: CameraControl

Kind: Method

Set the frame sync mode for continuous streaming operation mode, translating to
how the camera pin FSIN/FSYNC is used: input/output/disabled

#### setLumaDenoise(self, value: typing.SupportsInt) -> CameraControl: CameraControl

Kind: Method

Set a command to adjust luma denoise amount

Parameter ``value``:
    Luma denoise amount, range 0..4, default 1

#### setManualExposure()

Kind: Method

#### setManualFocus(self, lensPosition: typing.SupportsInt) -> CameraControl: CameraControl

Kind: Method

Set a command to specify manual focus position

Parameter ``lensPosition``:
    specify lens position 0..255

#### setManualFocusRaw(self, lensPositionRaw: typing.SupportsFloat) -> CameraControl: CameraControl

Kind: Method

Set a command to specify manual focus position (more precise control).

Parameter ``lensPositionRaw``:
    specify lens position 0.0f .. 1.0f

Returns:
    CameraControl&

#### setManualWhiteBalance(self, colorTemperatureK: typing.SupportsInt) -> CameraControl: CameraControl

Kind: Method

Set a command to manually specify white-balance color correction

Parameter ``colorTemperatureK``:
    Light source color temperature in kelvins, range 1000..12000

#### setMisc()

Kind: Method

#### setSaturation(self, value: typing.SupportsInt) -> CameraControl: CameraControl

Kind: Method

Set a command to adjust image saturation

Parameter ``value``:
    Saturation, range -10..10, default 0

#### setSceneMode(self, mode: RawCameraControl.SceneMode) -> CameraControl: CameraControl

Kind: Method

Set a command to specify scene mode

Parameter ``mode``:
    Scene mode

#### setSharpness(self, value: typing.SupportsInt) -> CameraControl: CameraControl

Kind: Method

Set a command to adjust image sharpness

Parameter ``value``:
    Sharpness, range 0..4, default 1

#### setStartStreaming(self) -> CameraControl: CameraControl

Kind: Method

Set a command to start streaming

#### setStopStreaming(self) -> CameraControl: CameraControl

Kind: Method

Set a command to stop streaming

#### setStrobeDisable(self) -> CameraControl: CameraControl

Kind: Method

Disable STROBE output

#### setStrobeExternal(self, gpioNumber: typing.SupportsInt, activeLevel: typing.SupportsInt) -> CameraControl: CameraControl

Kind: Method

Enable STROBE output driven by a MyriadX GPIO, optionally configuring the
polarity This normally requires a FSIN/FSYNC/trigger input for MyriadX (usually
GPIO 41), to generate timings

#### setStrobeSensor(self, activeLevel: typing.SupportsInt) -> CameraControl: CameraControl

Kind: Method

Enable STROBE output on sensor pin, optionally configuring the polarity. Note:
for many sensors the polarity is high-active and not configurable

### Need assistance?

Head over to [Discussion Forum](https://discuss.luxonis.com/) for technical support or any other questions you might have.
