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

AndroidDeviceTorch = 8001

Properties of cameras available through NDK Camera API backend

Aperture = 17008

Aperture. Can be readonly, depends on camera program.

AravisAutoTrigger = 600

Automatically trigger frame capture if camera is configured with software trigger

AudioBaseIndex = 63

(read-only) Index of the first audio channel for .retrieve() calls. That audio channel number continues enumeration after video channels.

AudioDataDepth = 61

(open, read) Alternative definition to bits-per-sample, but with clear handling of 32F / 32S

AudioPos = 59

(read-only) Audio position is measured in samples. Accurate audio sample timestamp of previous grabbed fragment. See AudioSamplesPerSecond and AudioShiftNsec.

AudioSamplesPerSecond = 62

(open, read) determined from file/codec input. If not specified, then selected audio sample rate is 44100

AudioShiftNsec = 60

(read only) Contains the time difference between the start of the audio stream and the video stream in nanoseconds. Positive value means that audio is started after the first video frame. Negative value means that audio is started before the first video frame.

AudioStream = 58

(open-only) Specify stream in multi-language media files, -1 - disable audio processing or microphone. Default value is -1.

AudioSynchronize = 66

(open, read) Enables audio synchronization.

AudioTotalChannels = 64

(read-only) Number of audio channels in the selected audio stream (mono, stereo, etc)

AudioTotalStreams = 65

(read-only) Number of audio streams.

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)

CodecExtradataIndex = 68

Positive index indicates that returning extra data is supported by the video back end. This can be retrieved as cap.Retrieve(data, <returned index>). E.g. When reading from a h264 encoded RTSP stream, the FFmpeg backend could return the SPS and/or PPS if available (if sent in reply to a DESCRIBE request), from calls to cap.Retrieve(data, <returned index>).

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

DtsDelay = 72

(read-only) FFmpeg back-end only - maximum difference between presentation (pts) and decompression timestamps (dts) using FPS time base. e.g. delay is maximum when frame_num = 0, if true, VideoCapture.Get(Pts) = 0 and VideoCapture.Get(DtsDelay) = 2, dts = -2. Non zero values usually imply the stream is encoded using B-frames which are not decoded in presentation order.

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)

FrameType = 69

(read-only) FFmpeg back-end only - Frame type ascii code (73 = 'I', 80 = 'P', 66 = 'B' or 63 = '?' if unknown) of the most recently read frame.

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.

HwAccelerationUseOpenCL = 52

(open-only) If non-zero, create new OpenCL context and bind it to current thread. The OpenCL context created with Video Acceleration context attached it (if not attached yet) for optimized GPU data copy between HW accelerated decoder and cv::UMat.

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_DepthGenerator = 536870912

INTELPERC_DepthLowConfidenceValue = 11003

INTELPERC_DepthSaturationValue = 11004

INTELPERC_GeneratorsMask = 939524096

INTELPERC_ImageGenerator = 268435456

INTELPERC_IrGenerator = 134217728

INTELPERC_ProfileCount = 11001

INTELPERC_ProfileIdx = 11002

IOS_DeviceExposure = 9002

IOS_DeviceFlash = 9003

IOS_DeviceFocus = 9001

IOS_DeviceTorch = 9005

IOS_DeviceWhiteBalance = 9004

ImageSeqStart = 73

(open-only) Start number for image sequences opened with a printf-style pattern (e.g. frame_%05d.dpx). Sets the initial frame number and disables automatic first-frame detection. Applicable to VideoCaptureAPIs.FFMPEG (passed as the image2 demuxer start_number) and VideoCaptureAPIs.IMAGES backends. Default: not set (automatic detection).

ImagesBase = 18000

Base value for image sequence backend properties (CAP_IMAGES).

ImagesLast = 19000

Last value (excluding) for image sequence backend properties (CAP_IMAGES).

Iris = 36

IsoSpeed = 30

LrfHasKeyFrame = 67

FFmpeg back-end only - Indicates whether the Last Raw Frame (LRF), output from VideoCapture.Read() when VideoCapture is initialized with VideoCapture.Open(VideoCaptureAPIs.FFMPEG, [Format, -1]) or Set(Format, -1) is called before the first call to VideoCapture.Read(), contains encoded data for a key frame.

Mode = 9

A backend-specific value indicating the current capture mode

Monocrome = 19

NThreads = 70

(open-only) Set the maximum number of threads to use. Use 0 to use as many threads as CPU cores (applicable for FFmpeg back-end only).

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 = -2147483546

OpenNI_DepthGeneratorFocalLength = -2147483545

OpenNI_DepthGeneratorPresent = -2147483539

OpenNI_DepthGeneratorRegistrationON = -2147483544

OpenNI_FocalLength = 103

in pixels

OpenNI_FrameMaxDepth = 101

in mm

OpenNI_GeneratorsMask = -536870912

OpenNI_ImageGenerator = 1073741824

OpenNI_ImageGeneratorOutputMode = 1073741924

OpenNI_ImageGeneratorPresent = 1073741933

OpenNI_IrGenerator = 536870912

OpenNI_IrGeneratorPresent = 536871021

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

OpenTimeoutMsec = 53

(open-only) timeout in milliseconds for opening a video capture (applicable for FFmpeg and GStreamer back-ends only)

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

Pts = 71

(read-only) FFmpeg back-end only - presentation timestamp of the most recently read frame using the FPS time base. e.g. fps = 25, VideoCapture.Get(Pts) = 3, presentation time = 3/25 seconds.

PvAPIMulticastIP = 300

ip for anable multicast master mode. 0 for disable multicast

ReadTimeoutMsec = 54

(open-only) timeout in milliseconds for reading from a video capture (applicable for FFmpeg and GStreamer back-ends only)

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.

StreamOpenTimeUsec = 55

(read-only) time in microseconds since Jan 1 1970 when stream was opened. Applicable for FFmpeg backend only. Useful for RTSP and other live streams

Temperature = 23

Tilt = 34

Trigger = 24

TriggerDelay = 25

VideoStream = 57

(open-only) Specify video stream, 0-based index. Use -1 to disable video stream from file or IP cameras. Default value is 0.

VideoTotalChannels = 56

(read-only) Number of video channels

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_AEAGRoiHeight = 442

Automatic exposure/gain ROI Height.

XI_AEAGRoiOffsetX = 439

Automatic exposure/gain ROI offset X.

XI_AEAGRoiOffsetY = 440

Automatic exposure/gain ROI offset Y.

XI_AEAGRoiWidth = 441

Automatic exposure/gain ROI Width.

XI_AEMaxLimit = 417

Maximum limit of exposure in AEAG procedure

XI_AGMaxLimit = 418

Maximum limit of gain in AEAG procedure

XI_AcqBufferSize = 548

Acquisition buffer size in buffer_size_unit. Default bytes.

XI_AcqBufferSizeUnit = 549

Acquisition buffer size unit in bytes. Default 1. E.g. Value 1024 means that buffer_size is in KiBytes.

XI_AcqFrameBurstCount = 499

Sets number of frames acquired by burst. This burst is used only if trigger is set to FrameBurstStart.

XI_AcqTimingMode = 538

Type of sensor frames timing.

XI_AcqTransportBufferCommit = 552

Number of buffers to commit to low level.

XI_AcqTransportBufferSize = 550

Acquisition transport buffer size in bytes.

XI_ApplyCMS = 471

Enable applying of CMS profiles to xiGetImage (see XI_PRM_INPUT_CMS_PROFILE, XI_PRM_OUTPUT_CMS_PROFILE).

XI_AutoBandwidthCalculation = 573

Automatic bandwidth calculation.

XI_AutoWB = 414

Automatic white balance

XI_AvailableBandwidth = 539

Calculate and returns available interface bandwidth(int Megabits).

XI_BPC = 445

Correction of bad pixels.

XI_BinningHorizontal = 429

Horizontal Binning - number of horizontal photo-sensitive cells to combine together.

XI_BinningPattern = 430

Binning pattern type.

XI_BinningSelector = 427

Binning engine selector.

XI_BinningVertical = 428

Vertical Binning - number of vertical photo-sensitive cells to combine together.

XI_BufferPolicy = 540

Data move policy.

XI_BuffersQueueSize = 551

Queue of field/frame buffers.

XI_CCMatrix00 = 479

Color Correction Matrix element [0][0].

XI_CCMatrix01 = 480

Color Correction Matrix element [0][1].

XI_CCMatrix02 = 481

Color Correction Matrix element [0][2].

XI_CCMatrix03 = 482

Color Correction Matrix element [0][3].

XI_CCMatrix10 = 483

Color Correction Matrix element [1][0].

XI_CCMatrix11 = 484

Color Correction Matrix element [1][1].

XI_CCMatrix12 = 485

Color Correction Matrix element [1][2].

XI_CCMatrix13 = 486

Color Correction Matrix element [1][3].

XI_CCMatrix20 = 487

Color Correction Matrix element [2][0].

XI_CCMatrix21 = 488

Color Correction Matrix element [2][1].

XI_CCMatrix22 = 489

Color Correction Matrix element [2][2].

XI_CCMatrix23 = 490

Color Correction Matrix element [2][3].

XI_CCMatrix30 = 491

Color Correction Matrix element [3][0].

XI_CCMatrix31 = 492

Color Correction Matrix element [3][1].

XI_CCMatrix32 = 493

Color Correction Matrix element [3][2].

XI_CCMatrix33 = 494

Color Correction Matrix element [3][3].

XI_CMS = 470

Mode of color management system.

XI_ChipTemp = 468

Camera sensor temperature.

XI_ColorFilterArray = 475

Returns color filter array type of RAW data.

XI_ColumnFPNCorrection = 555

Correction of column FPN.

XI_Cooling = 466

Start camera cooling.

XI_CounterSelector = 536

Select counter.

XI_CounterValue = 537

Counter status.

XI_DataFormat = 401

Output data format.

XI_DebounceEn = 507

Enable/Disable debounce to selected GPI.

XI_DebouncePol = 510

Debounce polarity (pol = 1 t0 - falling edge, t1 - rising edge).

XI_DebounceT0 = 508

Debounce time (x * 10us).

XI_DebounceT1 = 509

Debounce time (x * 10us).

XI_DebugLevel = 572

Set debug level.

XI_DecimationHorizontal = 433

Horizontal Decimation - horizontal sub-sampling of the image - reduces the horizontal resolution of the image by the specified vertical decimation factor.

XI_DecimationPattern = 434

Decimation pattern type.

XI_DecimationSelector = 431

Decimation engine selector.

XI_DecimationVertical = 432

Vertical Decimation - vertical sub-sampling of the image - reduces the vertical resolution of the image by the specified vertical decimation factor.

XI_DefaultCCMatrix = 495

Set default Color Correction Matrix.

XI_DeviceModelId = 521

Returns device model id.

XI_DeviceReset = 554

Resets the camera to default state.

XI_DeviceSN = 522

Returns device serial number.

XI_Downsampling = 400

Change image resolution by binning or skipping.

XI_DownsamplingType = 426

Change image downsampling type.

XI_ExpPriority = 416

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

XI_Exposure = 421

Exposure time in microseconds.

XI_ExposureBurstCount = 422

Sets the number of times of exposure in one frame.

XI_FFSAccessKey = 583

Setting of key enables file operations on some cameras.

XI_FFSFileId = 594

File number.

XI_FFSFileSize = 580

Size of file.

XI_Framerate = 535

Define framerate in Hz.

XI_FreeFFSSize = 581

Size of free camera FFS.

XI_Gain = 424

Gain in dB.

XI_GainSelector = 423

Gain selector for parameter Gain allows to select different type of gains.

XI_GammaC = 477

Chromaticity gamma.

XI_GammaY = 476

Luminosity gamma.

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_HDR = 559

Enable High Dynamic Range feature.

XI_HDRKneepointCount = 560

The number of kneepoints in the PWLR.

XI_HDRT1 = 561

Position of first kneepoint(in % of XI_PRM_EXPOSURE).

XI_HDRT2 = 562

Position of second kneepoint (in % of XI_PRM_EXPOSURE).

XI_Height = 452

Height of the Image provided by the device (in pixels).

XI_HousBackSideTemp = 590

Camera housing back side temperature.

XI_HousTemp = 469

Camera housing temperature.

XI_HwRevision = 571

Returns hardware revision number.

XI_ImageBlackLevel = 565

Last image black level counts. Can be used for Offline processing to recall it.

XI_ImageDataBitDepth = 462

bitdepth of data returned by function xiGetImage.

XI_ImageDataFormat = 435

Output data format.

XI_ImageDataFormatRGB32Alpha = 529

The alpha channel of RGB32 output image format.

XI_ImageIsColor = 474

Returns 1 for color cameras.

XI_ImagePayloadSize = 530

Buffer size in bytes sufficient for output image returned by xiGetImage.

XI_IsCooled = 465

Returns 1 for cameras that support cooling.

XI_IsDeviceExist = 547

Returns 1 if camera connected and works properly.

XI_Kneepoint1 = 563

Value of first kneepoint (% of sensor saturation).

XI_Kneepoint2 = 564

Value of second kneepoint (% of sensor saturation).

XI_LedMode = 412

Define camera signalling LED functionality

XI_LedSelector = 411

Selects camera signalling LED

XI_LensApertureValue = 512

Current lens aperture value in stops. Examples: 2.8, 4, 5.6, 8, 11.

XI_LensFeature = 518

Allows access to lens feature value currently selected by XI_PRM_LENS_FEATURE_SELECTOR.

XI_LensFeatureSelector = 517

Selects the current feature which is accessible by XI_PRM_LENS_FEATURE.

XI_LensFocalLength = 516

Lens focal distance in mm.

XI_LensFocusDistance = 515

Lens focus distance in cm.

XI_LensFocusMove = 514

Moves lens focus motor by steps set in XI_PRM_LENS_FOCUS_MOVEMENT_VALUE.

XI_LensFocusMovementValue = 513

Lens current focus movement value to be used by XI_PRM_LENS_FOCUS_MOVE in motor steps.

XI_LensMode = 511

Status of lens control interface. This shall be set to XI_ON before any Lens operations.

XI_LimitBandwidth = 459

Set/get bandwidth(datarate)(in Megabits).

XI_LutEn = 541

Activates LUT.

XI_LutIndex = 542

Control the index (offset) of the coefficient to access in the LUT.

XI_LutValue = 543

Value at entry LUTIndex of the LUT.

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_OutputDataBitDepth = 461

Device output data bit depth.

XI_OutputDataPacking = 463

Device output data packing (or grouping) enabled. Packing could be enabled if output_data_bit_depth > 8 and packing capability is available.

XI_OutputDataPackingType = 464

Data packing type. Some cameras supports only specific packing type.

XI_RecentFrame = 553

GetImage returns most recent frame.

XI_RegionMode = 595

Activates/deactivates Region selected by Region Selector.

XI_RegionSelector = 589

Selects Region in Multiple ROI which parameters are set by width, height, ... ,region mode.

XI_RowFPNCorrection = 591

Correction of row FPN.

XI_SensorBoardTemp = 596

Camera sensor board temperature.

XI_SensorClockFreqHz = 532

Sensor clock frequency in Hz.

XI_SensorClockFreqIndex = 533

Sensor clock frequency index. Sensor with selected frequencies have possibility to set the frequency only by this index.

XI_SensorDataBitDepth = 460

Sensor output data bit depth.

XI_SensorFeatureSelector = 585

Selects the current feature which is accessible by XI_PRM_SENSOR_FEATURE_VALUE.

XI_SensorFeatureValue = 586

Allows access to sensor feature value currently selected by XI_PRM_SENSOR_FEATURE_SELECTOR.

XI_SensorMode = 558

Current sensor mode. Allows to select sensor mode by one integer. Setting of this parameter affects: image dimensions and downsampling.

XI_SensorOutputChannelCount = 534

Number of output channels from sensor used for data transfer.

XI_SensorTaps = 437

Number of taps.

XI_Sharpness = 478

Sharpness Strength.

XI_ShutterType = 436

Change sensor shutter type(CMOS sensor).

XI_TargetTemp = 467

Set sensor target temperature for cooling.

XI_TestPattern = 588

Selects which test pattern type is generated by the selected generator.

XI_TestPatternGeneratorSelector = 587

Selects which test pattern generator is controlled by the TestPattern feature.

XI_Timeout = 420

Image capture timeout in milliseconds

XI_TransportPixelFormat = 531

Current format of pixels on transport layer.

XI_TrgDelay = 544

Specifies the delay in microseconds (us) to apply after the trigger reception before activating it.

XI_TrgSelector = 498

Selects the type of trigger.

XI_TrgSoftware = 405

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

XI_TrgSource = 404

Defines source of trigger.

XI_TsRstMode = 545

Defines how time stamp reset engine will be armed.

XI_TsRstSource = 546

Defines which source will be used for timestamp reset. Writing this parameter will trigger settings of engine (arming).

XI_UsedFFSSize = 582

Size of used camera FFS.

XI_WBKb = 450

White balance blue coefficient.

XI_WBKg = 449

White balance green coefficient.

XI_WBKr = 448

White balance red coefficient.

XI_Width = 451

Width of the Image provided by the device (in pixels).

Zoom = 27

Remarks

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