Show / Hide Table of Contents

Enum VideoCaptureProperties

Property identifiers for CvCapture

Namespace: OpenCvSharp
Assembly: OpenCvSharp.dll
Syntax
public enum VideoCaptureProperties
Remarks

https://github.com/opencv/opencv/blob/d3bc563c6e01c2bc153f23e7393322a95c7d3974/modules/videoio/include/opencv2/videoio.hpp#L133

Fields

Name Description
Aperture

Aperture. Can be readonly, depends on camera program.

AutoExposure

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

AutoFocus
AutoWB

enable/ disable auto white-balance

Backend

Current backend (enum VideoCaptureAPIs). Read-only property

BackLight
BitRate

(read-only) Video bitrate in kbits/s

Brightness

Brightness of image (only for cameras)

BufferSize
Channel

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

CodecPixelFormat

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

Contrast

contrast of image (only for cameras)

ConvertRgb

Boolean flags indicating whether images should be converted to RGB

Exposure

Exposure (only for cameras)

ExposureProgram

Camera exposure program.

Focus
Format

The format of the Mat objects returned by retrieve()

FourCC

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

Fps

Frame rate (only for cameras)

FrameCount

Number of frames in the video stream

FrameHeight

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

FrameWidth

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

Gain

Gain of the image (only for cameras)

Gamma
GIGA_FrameHeightMax
GIGA_FrameOffsetX
GIGA_FrameOffsetY
GIGA_FrameSensHeight
GIGA_FrameSensWidth
GIGA_FrameWidthMax
GPhoto2_CollectMsgs

Collect messages with details.

GPhoto2_FlushMsgs

Readonly, returns (const char *).

GPhoto2_Preview

Capture only preview from liveview mode.

GPhoto2_ReloadConfig

Trigger, only by set. Reload camera settings.

GPhoto2_ReloadOnChange

Reload all settings on set.

GPhoto2_WidgetEnumerate

Readonly, returns (const char *).

GStreamerQueueLength

default is 1

Guid
Hue

hue of image (only for cameras)

HwAcceleration

(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

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

INTELPERC_DepthConfidenceThreshold
INTELPERC_DepthFocalLengthHorz
INTELPERC_DepthFocalLengthVert
INTELPERC_DepthLowConfidenceValue
INTELPERC_DepthSaturationValue
INTELPERC_ProfileCount
INTELPERC_ProfileIdx
IOS_DeviceExposure
IOS_DeviceFlash
IOS_DeviceFocus
IOS_DeviceTorch
IOS_DeviceWhiteBalance
Iris
IsoSpeed
Mode

A backend-specific value indicating the current capture mode

Monocrome
OPENNI_ApproxFrameSync
OpenNI_Baseline

in mm

OPENNI_CircleBuffer
OpenNI_DepthGenerator
OpenNI_DepthGeneratorBaseline
OpenNI_DepthGeneratorFocalLength
OpenNI_DepthGeneratorRegistrationON
OpenNI_FocalLength

in pixels

OpenNI_FrameMaxDepth

in mm

OPENNI_GeneratorPresent
OpenNI_ImageGenerator
OpenNI_ImageGeneratorOutputMode
OpenNI_ImageGeneratorPresent
OPENNI_MaxBufferSize
OPENNI_MaxTimeDuration
OpenNI_OutputMode
OpenNI_Registration

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").

OPENNI2_Mirror
OPENNI2_Sync
OrientationAuto

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

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

Pan
PosAviRatio

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

PosFrames

Position in frames (only for video files)

PosMsec

Position in milliseconds from the file beginning

PVAPI_BinningX

Horizontal binning factor

PVAPI_BinningY

Vertical binning factor

PVAPI_DecimationHorizontal

Horizontal sub-sampling of the image

PVAPI_DecimationVertical

Vertical sub-sampling of the image

PVAPI_FrameStartTriggerMode

Determines how a frame is initiated

PVAPI_PixelFormat

Pixel format

PvAPIMulticastIP

ip for anable multicast master mode. 0 for disable multicast

Rectification

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

Roll
SARDen

Sample aspect ratio: num/den (den)

SARNum

Sample aspect ratio: num/den (num)

Saturation

Saturation of image (only for cameras)

Settings

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

Sharpness
Speed

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

Temperature
Tilt
Trigger
TriggerDelay
ViewFinder

Enter liveview mode.

WBTemperature

white-balance color temperature

WhiteBalanceBlueU
WhiteBalanceRedV
XI_AEAG

Automatic exposure/gain

XI_AEAGLevel

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

XI_AEMaxLimit

Maximum limit of exposure in AEAG procedure

XI_AGMaxLimit

Maximum limit of gain in AEAG procedure

XI_AutoWB

Automatic white balance

XI_DataFormat

Output data format.

XI_Downsampling

Change image resolution by binning or skipping.

XI_ExpPriority

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

XI_GpiLevel

Get general purpose level

XI_GpiMode

Set general purpose input mode

XI_GpiSelector

Selects general purpose input

XI_GpoMode

Set general purpose output mode

XI_GpoSelector

Selects general purpose output

XI_LedMode

Define camera signalling LED functionality

XI_LedSelector

Selects camera signalling LED

XI_ManualWB

Calculates White Balance(must be called during acquisition)

XI_OffsetX

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

XI_OffsetY

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

XI_Timeout

Image capture timeout in milliseconds

XI_TrgSoftware

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

XI_TrgSource

Defines source of trigger.

Zoom
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX