Table of Contents

Enum VideoCaptureProperties

Namespace
OpenCvSharp
Assembly
OpenCvSharp.dll

Property identifiers for CvCapture

[SuppressMessage("Microsoft.Design", "CA1717: Only FlagsAttribute enums should have plural names")]
public enum VideoCaptureProperties

Fields

Aperture = 17008

Aperture. Can be readonly, depends on camera program.

AutoExposure = 21

exposure control done by camera, user can adjust refernce level using this feature

AutoFocus = 39
AutoWB = 44

enable/ disable auto white-balance

BackLight = 32
Backend = 42

Current backend (enum VideoCaptureAPIs). Read-only property

BitRate = 47

(read-only) Video bitrate in kbits/s

Brightness = 10

Brightness of image (only for cameras)

BufferSize = 38
Channel = 43

Video input or Channel Number (only for those cameras that support)

CodecPixelFormat = 46

(read-only) codec's pixel format. 4-character code - see VideoWriter::fourcc . Subset of AV_PIX_FMT_* or -1 if unknown

Contrast = 11

contrast of image (only for cameras)

ConvertRgb = 16

Boolean flags indicating whether images should be converted to RGB

Exposure = 15

Exposure (only for cameras)

ExposureProgram = 17009

Camera exposure program.

Focus = 28
Format = 8

The format of the Mat objects returned by retrieve()

FourCC = 6

4-character code of codec (only for cameras).

Fps = 5

Frame rate (only for cameras)

FrameCount = 7

Number of frames in the video stream

FrameHeight = 4

Height of frames in the video stream (only for cameras)

FrameWidth = 3

Width of frames in the video stream (only for cameras)

GIGA_FrameHeightMax = 10004
GIGA_FrameOffsetX = 10001
GIGA_FrameOffsetY = 10002
GIGA_FrameSensHeight = 10006
GIGA_FrameSensWidth = 10005
GIGA_FrameWidthMax = 10003
GPhoto2_CollectMsgs = 17005

Collect messages with details.

GPhoto2_FlushMsgs = 17006

Readonly, returns (const char *).

GPhoto2_Preview = 17001

Capture only preview from liveview mode.

GPhoto2_ReloadConfig = 17003

Trigger, only by set. Reload camera settings.

GPhoto2_ReloadOnChange = 17004

Reload all settings on set.

GPhoto2_WidgetEnumerate = 17002

Readonly, returns (const char *).

GStreamerQueueLength = 200

default is 1

Gain = 14

Gain of the image (only for cameras)

Gamma = 22
Guid = 29
Hue = 13

hue of image (only for cameras)

HwAcceleration = 50

(open-only) Hardware acceleration type (see VideoAccelerationType). Setting supported only via params parameter in cv::VideoCapture constructor / .open() method. Default value is backend-specific.

HwDevice = 51

(open-only) Hardware device index (select GPU if multiple available). Device enumeration is acceleration type specific.

INTELPERC_DepthConfidenceThreshold = 11005
INTELPERC_DepthFocalLengthHorz = 11006
INTELPERC_DepthFocalLengthVert = 11007
INTELPERC_DepthLowConfidenceValue = 11003
INTELPERC_DepthSaturationValue = 11004
INTELPERC_ProfileCount = 11001
INTELPERC_ProfileIdx = 11002
IOS_DeviceExposure = 9002
IOS_DeviceFlash = 9003
IOS_DeviceFocus = 9001
IOS_DeviceTorch = 9005
IOS_DeviceWhiteBalance = 9004
Iris = 36
IsoSpeed = 30
Mode = 9

A backend-specific value indicating the current capture mode

Monocrome = 19
OPENNI2_Mirror = 111
OPENNI2_Sync = 110
OPENNI_ApproxFrameSync = 105
OPENNI_CircleBuffer = 107
OPENNI_GeneratorPresent = 109
OPENNI_MaxBufferSize = 106
OPENNI_MaxTimeDuration = 108
OpenNI_Baseline = 102

in mm

OpenNI_DepthGenerator = -2147483648
OpenNI_DepthGeneratorBaseline = 1073741926
OpenNI_DepthGeneratorFocalLength = 1073741927
OpenNI_DepthGeneratorRegistrationON = 1073741928
OpenNI_FocalLength = 103

in pixels

OpenNI_FrameMaxDepth = 101

in mm

OpenNI_ImageGenerator = 1073741824
OpenNI_ImageGeneratorOutputMode = 1073741924
OpenNI_ImageGeneratorPresent = 1073741933
OpenNI_OutputMode = 100
OpenNI_Registration = 104

flag that synchronizes the remapping depth map to image map by changing depth generator's view point (if the flag is "on") or sets this view point to its normal one (if the flag is "off").

OrientationAuto = 49

if true - rotates output frames of CvCapture considering video file's metadata (applicable for FFmpeg back-end only) (https://github.com/opencv/opencv/issues/15499)

OrientationMeta = 48

(read-only) Frame rotation defined by stream meta (applicable for FFmpeg back-end only)

PVAPI_BinningX = 304

Horizontal binning factor

PVAPI_BinningY = 305

Vertical binning factor

PVAPI_DecimationHorizontal = 302

Horizontal sub-sampling of the image

PVAPI_DecimationVertical = 303

Vertical sub-sampling of the image

PVAPI_FrameStartTriggerMode = 301

Determines how a frame is initiated

PVAPI_PixelFormat = 306

Pixel format

Pan = 33
PosAviRatio = 2

Position in relative units (0 - start of the file, 1 - end of the file)

PosFrames = 1

Position in frames (only for video files)

PosMsec = 0

Position in milliseconds from the file beginning

PvAPIMulticastIP = 300

ip for anable multicast master mode. 0 for disable multicast

Rectification = 18

TOWRITE (note: only supported by DC1394 v 2.x backend currently)

Roll = 35
SARDen = 41

Sample aspect ratio: num/den (den)

SARNum = 40

Sample aspect ratio: num/den (num)

Saturation = 12

Saturation of image (only for cameras)

Settings = 37

Pop up video/camera filter dialog (note: only supported by DSHOW backend currently. Property value is ignored)

Sharpness = 20
Speed = 17007

Exposure speed. Can be readonly, depends on camera program.

Temperature = 23
Tilt = 34
Trigger = 24
TriggerDelay = 25
ViewFinder = 17010

Enter liveview mode.

WBTemperature = 45

white-balance color temperature

WhiteBalanceBlueU = 17
WhiteBalanceRedV = 26
XI_AEAG = 415

Automatic exposure/gain

XI_AEAGLevel = 419

Average intensity of output signal AEAG should achieve(in %)

XI_AEMaxLimit = 417

Maximum limit of exposure in AEAG procedure

XI_AGMaxLimit = 418

Maximum limit of gain in AEAG procedure

XI_AutoWB = 414

Automatic white balance

XI_DataFormat = 401

Output data format.

XI_Downsampling = 400

Change image resolution by binning or skipping.

XI_ExpPriority = 416

Exposure priority (0.5 - exposure 50%, gain 50%).

XI_GpiLevel = 408

Get general purpose level

XI_GpiMode = 407

Set general purpose input mode

XI_GpiSelector = 406

Selects general purpose input

XI_GpoMode = 410

Set general purpose output mode

XI_GpoSelector = 409

Selects general purpose output

XI_LedMode = 412

Define camera signalling LED functionality

XI_LedSelector = 411

Selects camera signalling LED

XI_ManualWB = 413

Calculates White Balance(must be called during acquisition)

XI_OffsetX = 402

Horizontal offset from the origin to the area of interest (in pixels).

XI_OffsetY = 403

Vertical offset from the origin to the area of interest (in pixels).

XI_Timeout = 420

Image capture timeout in milliseconds

XI_TrgSoftware = 405

Generates an internal trigger. PRM_TRG_SOURCE must be set to TRG_SOFTWARE.

XI_TrgSource = 404

Defines source of trigger.

Zoom = 27

Remarks