Enum CapProp

Namespace

Emgu.CV.CvEnum

Assembly

Emgu.CV.dll

CV Capture property identifier

public enum CapProp

Fields

AndroidAntibanding = 8004

Android anti banding

AndroidExposeLock = 8009

Android expose lock

AndroidFlashMode = 8001

Android flash mode

AndroidFocalLength = 8005

Android focal length

AndroidFocusDistanceFar = 8008

Android focus distance far

AndroidFocusDistanceNear = 8006

Android focus distance near

AndroidFocusDistanceOptimal = 8007

Android focus distance optimal

AndroidFocusMode = 8002

Android focus mode

AndroidWhiteBalance = 8003

Android white balance

AndroidWhitebalanceLock = 8010

Android white balance lock

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 reference level using this feature

AutoWb = 44

Enable/ disable auto white-balance

Autofocus = 39

Auto focus

Autograb = 1024

property for highgui class CvCapture_Android only

Backend = 42

Current backend (enum VideoCaptureAPIs). Read-only property

Backlight = 32

Backlight

Bitrate = 47

(read-only) Video bitrate in kbits/s

Brightness = 10

Brightness of the image (only for those cameras that support).

Buffersize = 38

Buffer size

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 the image (only for cameras).

ConvertRgb = 16

Boolean flags indicating whether images should be converted to RGB.

DC1394ModeAuto = -2

DC1394 mode auto

DC1394ModeManual = -3

Set automatically when a value of the feature is set by the user

DC1394ModeOnePushAuto = -1

DC1394 mode one push auto

DC1394Off = -4

Turn the feature off (not controlled manually nor automatically)

Exposure = 15

Exposure (only for those cameras that support).

Focus = 28

Focus

Format = 8

Format of the %Mat objects returned by VideoCapture::retrieve().

FourCC = 6

4-character code of codec

Fps = 5

Frame rate

FrameCount = 7

Number of frames in video file

FrameHeight = 4

Height of frames in the video stream

FrameWidth = 3

Width of frames in the video stream

Gain = 14

Gain of the image (only for those cameras that support).

Gamma = 22

Gamma

GigaFrameHeighMax = 10004

Smartek Giganetix Ethernet Vision: frame height max

GigaFrameOffsetX = 10001

Smartek Giganetix Ethernet Vision: frame offset X

GigaFrameOffsetY = 10002

Smartek Giganetix Ethernet Vision: frame offset Y

GigaFrameSensHeigh = 10006

Smartek Giganetix Ethernet Vision: frame sens height

GigaFrameSensWidth = 10005

Smartek Giganetix Ethernet Vision: frame sens width

GigaFrameWidthMax = 10003

Smartek Giganetix Ethernet Vision: frame width max

Gphoto2Aperture = 17008

Aperture. Can be readonly, depends on camera program.

Gphoto2CollectMsgs = 17005

Collect messages with details.

Gphoto2Exposureprogram = 17009

Camera exposure program.

Gphoto2FlushMsgs = 17006

Readonly, returns (const char *).

Gphoto2Preview = 17001

Capture only preview from liveview mode.

Gphoto2ReloadConfig = 17003

Trigger, only by set. Reload camera settings.

Gphoto2ReloadOnChange = 17004

Reload all settings on set.

Gphoto2Speed = 17007

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

Gphoto2Viewfinder = 17010

Enter liveview mode.

Gphoto2WidgetEnumerate = 17002

Readonly, returns (const char *).

GstreamerQueueLength = 200

Properties of cameras available through GStreamer interface. Default is 1

Guid = 29

GUID

Hue = 13

Hue of the 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)

IOSDeviceExposure = 9002

iOS device exposure

IOSDeviceFlash = 9003

iOS device flash

IOSDeviceFocus = 9001

iOS device focus

IOSDeviceTorch = 9005

iOS device torch

IOSDeviceWhitebalance = 9004

iOS device white-balance

IntelpercDepthConfidenceThreshold = 11005

Intelperc Depth Confidence Threshold

IntelpercDepthFocalLengthHorz = 11006

Intelperc Depth Focal Length Horz

IntelpercDepthFocalLengthVert = 11007

Intelperc Depth Focal Length Vert

IntelpercDepthGenerator = 536870912

Intelperc Depth Generator

IntelpercDepthLowConfidenceValue = 11003

Intelperc Depth Low Confidence Value

IntelpercDepthSaturationValue = 11004

Intelperc Depth Saturation Value

IntelpercGeneratorsMask = 805306368

Intelperc Generators Mask

IntelpercImageGenerator = 268435456

Intelperc Image Generator

IntelpercProfileCount = 11001

Intelperc Profile Count

IntelpercProfileIdx = 11002

Intelperc Profile Idx

Iris = 36

Iris

IsoSpeed = 30

ISO SPEED

LrfHasKeyFrame = 67

FFmpeg back-end only - Indicates whether the Last Raw Frame (LRF), output from VideoCapture::read() when VideoCapture is initialized with VideoCapture::open(CAP_FFMPEG, {CAP_PROP_FORMAT, -1}) or VideoCapture::set(CAP_PROP_FORMAT,-1) is called before the first call to VideoCapture::read(), contains encoded data for a key frame.

MaxDC1394 = 31

MAX DC1394

Mode = 9

Backend-specific value indicating the current capture mode.

Monochrome = 19

Monochrome

OpenTimeoutMsec = 53

(open-only) Timeout in milliseconds for opening a video capture (applicable for FFmpeg back-end only)

Openni2Mirror = 111

OpenNI2 Mirror

Openni2Sync = 110

OpenNI2 Sync

OpenniApproxFrameSync = 105

Approx frame sync

OpenniBaseline = 102

Properties of cameras available through OpenNI interfaces, in mm.

OpenniCircleBuffer = 107

Circle buffer

OpenniDepthGenerator = -2147483648

OpenNI depth generator

OpenniDepthGeneratorBaseline = -2147483546

Depth generator baseline, in mm.

OpenniDepthGeneratorFocalLength = -2147483545

Depth generator focal length, in pixels.

OpenniDepthGeneratorPresent = -2147483539

Depth generator present

OpenniDepthGeneratorRegistration = -2147483544

Openni generator registration

OpenniDepthGeneratorRegistrationOn = -2147483544

Openni generator registration on

OpenniFocalLength = 103

Properties of cameras available through OpenNI interfaces, in pixels.

OpenniFrameMaxDepth = 101

Properties of cameras available through OpenNI interfaces, in mm.

OpenniGeneratorPresent = 109

Generator present

OpenniGeneratorsMask = -536870912

OpenNI map generators

OpenniIRGenerator = 536870912

OpenNI IR generator

OpenniIRGeneratorPresent = 536871021

Openni IR generator present

OpenniImageGenerator = 1073741824

OpenNI image generator

OpenniImageGeneratorOutputMode = 1073741924

Image generator output mode

OpenniImageGeneratorPresent = 1073741933

Openni image generator present

OpenniMaxBufferSize = 106

Max buffer size

OpenniMaxTimeDuration = 108

Max time duration

OpenniOutputMode = 100

Properties of cameras available through OpenNI interfaces

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

OpenniRegistrationOn = 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)

Pan = 33

Pan

PosAviRatio = 2

Relative position of the video file: 0=start of the film, 1=end of the film.

PosFrames = 1

0-based index of the frame to be decoded/captured next

PosMsec = 0

Film current position in milliseconds or video capture timestamp

PreviewFormat = 1026

readonly, tricky property, returns cpnst char* indeed

PvapiBinningX = 304

Horizontal binning factor

PvapiBinningY = 305

Vertical binning factor

PvapiDecimationHorizontal = 302

Horizontal sub-sampling of the image

PvapiDecimationVertical = 303

Vertical sub-sampling of the image

PvapiFrameStartTriggerMode = 301

FrameStartTriggerMode: Determines how a frame is initiated

PvapiMulticastip = 300

Ip for enable multicast master mode. 0 for disable multicast

PvapiPixelFormat = 306

Pixel format

ReadTimeoutMsec = 54

(open-only) Timeout in milliseconds for reading from a video capture (applicable for FFmpeg back-end only)

Rectification = 18

Rectification flag for stereo cameras (note: only supported by DC1394 v 2.x backend currently).

Roll = 35

Roll

SarDen = 41

Sample aspect ratio: num/den (den)

SarNum = 40

Sample aspect ratio: num/den (num)

Saturation = 12

Saturation of the image (only for cameras).

Settings = 37

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

Sharpness = 20

Sharpness

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

SupportedPreviewSizesString = 1025

readonly, tricky property, returns cpnst char* indeed

Temperature = 23

Temperature

Tilt = 34

Tilt

Trigger = 24

Trigger

TriggerDelay = 25

Trigger delay

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

WbTemperature = 45

White-balance color temperature

WhiteBalanceBlueU = 17

Currently unsupported.

WhiteBalanceRedV = 26

White balance red v

XiAcqBufferSize = 548

Acquisition buffer size in buffer_size_unit. Default bytes.

XiAcqBufferSizeUnit = 549

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

XiAcqFrameBurstCount = 499

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

XiAcqTimingMode = 538

Type of sensor frames timing.

XiAcqTransportBufferCommit = 552

Number of buffers to commit to low level

XiAcqTransportBufferSize = 550

Acquisition transport buffer size in bytes

XiAeMaxLimit = 417

Maximum limit of exposure in AEAG procedure

XiAeag = 415

Automatic exposure/gain

XiAeagLevel = 419

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

XiAeagRoiHeight = 442

Automatic exposure/gain ROI Height

XiAeagRoiOffsetX = 439

Automatic exposure/gain ROI offset X

XiAeagRoiOffsetY = 440

Automatic exposure/gain ROI offset Y

XiAeagRoiWidth = 441

Automatic exposure/gain ROI Width

XiAgMaxLimit = 418

Maximum limit of gain in AEAG procedure

XiApplyCms = 471

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

XiAutoBandwidthCalculation = 573

Automatic bandwidth calculation,

XiAutoWb = 414

Automatic white balance

XiAvailableBandwidth = 539

Calculate and return available interface bandwidth(int Megabits)

XiBinningHorizontal = 429

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

XiBinningPattern = 430

Binning pattern type.

XiBinningSelector = 427

Binning engine selector.

XiBinningVertical = 428

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

XiBpc = 445

Correction of bad pixels

XiBufferPolicy = 540

Data move policy

XiBuffersQueueSize = 551

Queue of field/frame buffers

XiCcMatrix00 = 479

Color Correction Matrix element [0][0]

XiCcMatrix01 = 480

Color Correction Matrix element [0][1]

XiCcMatrix02 = 481

Color Correction Matrix element [0][2]

XiCcMatrix03 = 482

Color Correction Matrix element [0][3]

XiCcMatrix10 = 483

Color Correction Matrix element [1][0]

XiCcMatrix11 = 484

Color Correction Matrix element [1][1]

XiCcMatrix12 = 485

Color Correction Matrix element [1][2]

XiCcMatrix13 = 486

Color Correction Matrix element [1][3]

XiCcMatrix20 = 487

Color Correction Matrix element [2][0]

XiCcMatrix21 = 488

Color Correction Matrix element [2][1]

XiCcMatrix22 = 489

Color Correction Matrix element [2][2]

XiCcMatrix23 = 490

Color Correction Matrix element [2][3]

XiCcMatrix30 = 491

Color Correction Matrix element [3][0]

XiCcMatrix31 = 492

Color Correction Matrix element [3][1]

XiCcMatrix32 = 493

Color Correction Matrix element [3][2]

XiCcMatrix33 = 494

Color Correction Matrix element [3][3]

XiChipTemp = 468

Camera sensor temperature

XiCms = 470

Mode of color management system.

XiColorFilterArray = 475

Returns color filter array type of RAW data.

XiColumnFpnCorrection = 555

Correction of column FPN

XiCooling = 466

Start camera cooling.

XiCounterSelector = 536

Select counter

XiCounterValue = 537

Counter status

XiDataFormat = 401

Output data format

XiDebounceEn = 507

Enable/Disable debounce to selected GPI

XiDebouncePol = 510

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

XiDebounceT0 = 508

Debounce time (x * 10us)

XiDebounceT1 = 509

Debounce time (x * 10us)

XiDebugLevel = 572

Set debug level

XiDecimationHorizontal = 433

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

XiDecimationPattern = 434

Decimation pattern type.

XiDecimationSelector = 431

Decimation engine selector.

XiDecimationVertical = 432

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

XiDefaultCcMatrix = 495

Set default Color Correction Matrix

XiDeviceModelId = 521

Return device model id

XiDeviceReset = 554

Resets the camera to default state.

XiDeviceSn = 522

Return device serial number

XiDownsampling = 400

Change image resolution by binning or skipping.

XiDownsamplingType = 426

Change image downsampling type.

XiExpPriority = 416

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

XiExposure = 421

Exposure time in microseconds

XiExposureBurstCount = 422

Sets the number of times of exposure in one frame.

XiFfsAccessKey = 583

Setting of key enables file operations on some cameras.

XiFfsFileId = 594

File number.

XiFfsFileSize = 580

Size of file.

XiFramerate = 535

Define framerate in Hz

XiFreeFfsSize = 581

Size of free camera FFS.

XiGain = 424

Gain in dB

XiGainSelector = 423

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

XiGammac = 477

Chromaticity gamma

XiGammay = 476

Luminosity gamma

XiGpiLevel = 408

Get general purpose level

XiGpiMode = 407

Set general purpose input mode

XiGpiSelector = 406

Selects general purpose input

XiGpoMode = 410

Set general purpose output mode

XiGpoSelector = 409

Selects general purpose output

XiHdr = 559

Enable High Dynamic Range feature.

XiHdrKneepointCount = 560

The number of kneepoints in the PWLR.

XiHdrT1 = 561

position of first kneepoint(in % of XI_PRM_EXPOSURE)

XiHdrT2 = 562

position of second kneepoint (in % of XI_PRM_EXPOSURE)

XiHeight = 452

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

XiHousBackSideTemp = 590

Camera housing back side temperature

XiHousTemp = 469

Camera housing temperature

XiHwRevision = 571

Returns hardware revision number.

XiImageBlackLevel = 565

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

XiImageDataBitDepth = 462

bitdepth of data returned by function xiGetImage

XiImageDataFormat = 435

Output data format.

XiImageDataFormatRgb32Alpha = 529

The alpha channel of RGB32 output image format.

XiImageIsColor = 474

Returns 1 for color cameras.

XiImagePayloadSize = 530

Buffer size in bytes sufficient for output image returned by xiGetImage

XiIsCooled = 465

Returns 1 for cameras that support cooling.

XiIsDeviceExist = 547

Returns 1 if camera connected and works properly.

XiKneepoint1 = 563

value of first kneepoint (% of sensor saturation)

XiKneepoint2 = 564

value of second kneepoint (% of sensor saturation)

XiLedMode = 412

Define camera signaling LED functionality

XiLedSelector = 411

Selects camera signaling LED

XiLensApertureValue = 512

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

XiLensFeature = 518

Allows access to lens feature value currently selected by XI_PRM_LENS_FEATURE_SELECTOR.

XiLensFeatureSelector = 517

Selects the current feature which is accessible by XI_PRM_LENS_FEATURE.

XiLensFocalLength = 516

Lens focal distance in mm.

XiLensFocusDistance = 515

Lens focus distance in cm.

XiLensFocusMove = 514

Moves lens focus motor by steps set in XI_PRM_LENS_FOCUS_MOVEMENT_VALUE.

XiLensFocusMovementValue = 513

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

XiLensMode = 511

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

XiLimitBandwidth = 459

Set/get bandwidth(datarate)(in Megabits)

XiLutEn = 541

Activates LUT.

XiLutIndex = 542

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

XiLutValue = 543

Value at entry LUTIndex of the LUT

XiManualWb = 413

Calculates White Balance(must be called during acquisition)

XiOffsetX = 402

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

XiOffsetY = 403

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

XiOutputDataBitDepth = 461

Device output data bit depth.

XiOutputDataPacking = 463

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

XiOutputDataPackingType = 464

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

XiRecentFrame = 553

GetImage returns most recent frame

XiRegionMode = 595

Activates/deactivates Region selected by Region Selector

XiRegionSelector = 589

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

XiRowFpnCorrection = 591

Correction of row FPN

XiSensorBoardTemp = 596

Camera sensor board temperature

XiSensorClockFreqHz = 532

Sensor clock frequency in Hz.

XiSensorClockFreqIndex = 533

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

XiSensorDataBitDepth = 460

Sensor output data bit depth.

XiSensorFeatureSelector = 585

Selects the current feature which is accessible by XI_PRM_SENSOR_FEATURE_VALUE.

XiSensorFeatureValue = 586

Allows access to sensor feature value currently selected by XI_PRM_SENSOR_FEATURE_SELECTOR.

XiSensorMode = 558

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

XiSensorOutputChannelCount = 534

Number of output channels from sensor used for data transfer.

XiSensorTaps = 437

Number of taps

XiSharpness = 478

Sharpness Strength

XiShutterType = 436

Change sensor shutter type(CMOS sensor).

XiTargetTemp = 467

Set sensor target temperature for cooling.

XiTestPattern = 588

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

XiTestPatternGeneratorSelector = 587

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

XiTimeout = 420

Image capture timeout in milliseconds

XiTransportPixelFormat = 531

Current format of pixels on transport layer.

XiTrgDelay = 544

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

XiTrgSelector = 498

Selects the type of trigger.

XiTrgSoftware = 405

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

XiTrgSource = 404

Defines source of trigger.

XiTsRstMode = 545

Defines how time stamp reset engine will be armed

XiTsRstSource = 546

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

XiUsedFfsSize = 582

Size of used camera FFS.

XiWbKb = 450

White balance blue coefficient

XiWbKg = 449

White balance green coefficient

XiWbKr = 448

White balance red coefficient

XiWidth = 451

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

Zoom = 27

Zoom