OpenCV  4.5.1
Open Source Computer Vision
Additional flags for video I/O API backends

IEEE 1394 drivers

enum  {
  cv::CAP_PROP_DC1394_OFF = -4,
  cv::CAP_PROP_DC1394_MODE_MANUAL = -3,
  cv::CAP_PROP_DC1394_MODE_AUTO = -2,
  cv::CAP_PROP_DC1394_MODE_ONE_PUSH_AUTO = -1,
  cv::CAP_PROP_DC1394_MAX = 31
}
 Modes of the IEEE 1394 controlling registers (can be: auto, manual, auto single push, absolute Latter allowed with any other mode) every feature can have only one mode turned on at a time. More...
 

OpenNI (for Kinect)

enum  {
  cv::CAP_OPENNI_DEPTH_GENERATOR = 1 << 31,
  cv::CAP_OPENNI_IMAGE_GENERATOR = 1 << 30,
  cv::CAP_OPENNI_IR_GENERATOR = 1 << 29,
  cv::CAP_OPENNI_GENERATORS_MASK = CAP_OPENNI_DEPTH_GENERATOR + CAP_OPENNI_IMAGE_GENERATOR + CAP_OPENNI_IR_GENERATOR
}
 OpenNI map generators. More...
 
enum  {
  cv::CAP_PROP_OPENNI_OUTPUT_MODE = 100,
  cv::CAP_PROP_OPENNI_FRAME_MAX_DEPTH = 101,
  cv::CAP_PROP_OPENNI_BASELINE = 102,
  cv::CAP_PROP_OPENNI_FOCAL_LENGTH = 103,
  cv::CAP_PROP_OPENNI_REGISTRATION = 104,
  cv::CAP_PROP_OPENNI_REGISTRATION_ON = CAP_PROP_OPENNI_REGISTRATION,
  cv::CAP_PROP_OPENNI_APPROX_FRAME_SYNC = 105,
  cv::CAP_PROP_OPENNI_MAX_BUFFER_SIZE = 106,
  cv::CAP_PROP_OPENNI_CIRCLE_BUFFER = 107,
  cv::CAP_PROP_OPENNI_MAX_TIME_DURATION = 108,
  cv::CAP_PROP_OPENNI_GENERATOR_PRESENT = 109,
  cv::CAP_PROP_OPENNI2_SYNC = 110,
  cv::CAP_PROP_OPENNI2_MIRROR = 111
}
 Properties of cameras available through OpenNI backend. More...
 
enum  {
  cv::CAP_OPENNI_IMAGE_GENERATOR_PRESENT = CAP_OPENNI_IMAGE_GENERATOR + CAP_PROP_OPENNI_GENERATOR_PRESENT,
  cv::CAP_OPENNI_IMAGE_GENERATOR_OUTPUT_MODE = CAP_OPENNI_IMAGE_GENERATOR + CAP_PROP_OPENNI_OUTPUT_MODE,
  cv::CAP_OPENNI_DEPTH_GENERATOR_PRESENT = CAP_OPENNI_DEPTH_GENERATOR + CAP_PROP_OPENNI_GENERATOR_PRESENT,
  cv::CAP_OPENNI_DEPTH_GENERATOR_BASELINE = CAP_OPENNI_DEPTH_GENERATOR + CAP_PROP_OPENNI_BASELINE,
  cv::CAP_OPENNI_DEPTH_GENERATOR_FOCAL_LENGTH = CAP_OPENNI_DEPTH_GENERATOR + CAP_PROP_OPENNI_FOCAL_LENGTH,
  cv::CAP_OPENNI_DEPTH_GENERATOR_REGISTRATION = CAP_OPENNI_DEPTH_GENERATOR + CAP_PROP_OPENNI_REGISTRATION,
  cv::CAP_OPENNI_DEPTH_GENERATOR_REGISTRATION_ON = CAP_OPENNI_DEPTH_GENERATOR_REGISTRATION,
  cv::CAP_OPENNI_IR_GENERATOR_PRESENT = CAP_OPENNI_IR_GENERATOR + CAP_PROP_OPENNI_GENERATOR_PRESENT
}
 OpenNI shortcuts. More...
 
enum  {
  cv::CAP_OPENNI_DEPTH_MAP = 0,
  cv::CAP_OPENNI_POINT_CLOUD_MAP = 1,
  cv::CAP_OPENNI_DISPARITY_MAP = 2,
  cv::CAP_OPENNI_DISPARITY_MAP_32F = 3,
  cv::CAP_OPENNI_VALID_DEPTH_MASK = 4,
  cv::CAP_OPENNI_BGR_IMAGE = 5,
  cv::CAP_OPENNI_GRAY_IMAGE = 6,
  cv::CAP_OPENNI_IR_IMAGE = 7
}
 OpenNI data given from depth generator. More...
 
enum  {
  cv::CAP_OPENNI_VGA_30HZ = 0,
  cv::CAP_OPENNI_SXGA_15HZ = 1,
  cv::CAP_OPENNI_SXGA_30HZ = 2,
  cv::CAP_OPENNI_QVGA_30HZ = 3,
  cv::CAP_OPENNI_QVGA_60HZ = 4
}
 Supported output modes of OpenNI image generator. More...
 

GStreamer

enum  { cv::CAP_PROP_GSTREAMER_QUEUE_LENGTH = 200 }
 

PvAPI, Prosilica GigE SDK

enum  {
  cv::CAP_PROP_PVAPI_MULTICASTIP = 300,
  cv::CAP_PROP_PVAPI_FRAMESTARTTRIGGERMODE = 301,
  cv::CAP_PROP_PVAPI_DECIMATIONHORIZONTAL = 302,
  cv::CAP_PROP_PVAPI_DECIMATIONVERTICAL = 303,
  cv::CAP_PROP_PVAPI_BINNINGX = 304,
  cv::CAP_PROP_PVAPI_BINNINGY = 305,
  cv::CAP_PROP_PVAPI_PIXELFORMAT = 306
}
 PVAPI. More...
 
enum  {
  cv::CAP_PVAPI_FSTRIGMODE_FREERUN = 0,
  cv::CAP_PVAPI_FSTRIGMODE_SYNCIN1 = 1,
  cv::CAP_PVAPI_FSTRIGMODE_SYNCIN2 = 2,
  cv::CAP_PVAPI_FSTRIGMODE_FIXEDRATE = 3,
  cv::CAP_PVAPI_FSTRIGMODE_SOFTWARE = 4
}
 PVAPI: FrameStartTriggerMode. More...
 
enum  {
  cv::CAP_PVAPI_DECIMATION_OFF = 1,
  cv::CAP_PVAPI_DECIMATION_2OUTOF4 = 2,
  cv::CAP_PVAPI_DECIMATION_2OUTOF8 = 4,
  cv::CAP_PVAPI_DECIMATION_2OUTOF16 = 8
}
 PVAPI: DecimationHorizontal, DecimationVertical. More...
 
enum  {
  cv::CAP_PVAPI_PIXELFORMAT_MONO8 = 1,
  cv::CAP_PVAPI_PIXELFORMAT_MONO16 = 2,
  cv::CAP_PVAPI_PIXELFORMAT_BAYER8 = 3,
  cv::CAP_PVAPI_PIXELFORMAT_BAYER16 = 4,
  cv::CAP_PVAPI_PIXELFORMAT_RGB24 = 5,
  cv::CAP_PVAPI_PIXELFORMAT_BGR24 = 6,
  cv::CAP_PVAPI_PIXELFORMAT_RGBA32 = 7,
  cv::CAP_PVAPI_PIXELFORMAT_BGRA32 = 8
}
 PVAPI: PixelFormat. More...
 

XIMEA Camera API

enum  {
  cv::CAP_PROP_XI_DOWNSAMPLING = 400,
  cv::CAP_PROP_XI_DATA_FORMAT = 401,
  cv::CAP_PROP_XI_OFFSET_X = 402,
  cv::CAP_PROP_XI_OFFSET_Y = 403,
  cv::CAP_PROP_XI_TRG_SOURCE = 404,
  cv::CAP_PROP_XI_TRG_SOFTWARE = 405,
  cv::CAP_PROP_XI_GPI_SELECTOR = 406,
  cv::CAP_PROP_XI_GPI_MODE = 407,
  cv::CAP_PROP_XI_GPI_LEVEL = 408,
  cv::CAP_PROP_XI_GPO_SELECTOR = 409,
  cv::CAP_PROP_XI_GPO_MODE = 410,
  cv::CAP_PROP_XI_LED_SELECTOR = 411,
  cv::CAP_PROP_XI_LED_MODE = 412,
  cv::CAP_PROP_XI_MANUAL_WB = 413,
  cv::CAP_PROP_XI_AUTO_WB = 414,
  cv::CAP_PROP_XI_AEAG = 415,
  cv::CAP_PROP_XI_EXP_PRIORITY = 416,
  cv::CAP_PROP_XI_AE_MAX_LIMIT = 417,
  cv::CAP_PROP_XI_AG_MAX_LIMIT = 418,
  cv::CAP_PROP_XI_AEAG_LEVEL = 419,
  cv::CAP_PROP_XI_TIMEOUT = 420,
  cv::CAP_PROP_XI_EXPOSURE = 421,
  cv::CAP_PROP_XI_EXPOSURE_BURST_COUNT = 422,
  cv::CAP_PROP_XI_GAIN_SELECTOR = 423,
  cv::CAP_PROP_XI_GAIN = 424,
  cv::CAP_PROP_XI_DOWNSAMPLING_TYPE = 426,
  cv::CAP_PROP_XI_BINNING_SELECTOR = 427,
  cv::CAP_PROP_XI_BINNING_VERTICAL = 428,
  cv::CAP_PROP_XI_BINNING_HORIZONTAL = 429,
  cv::CAP_PROP_XI_BINNING_PATTERN = 430,
  cv::CAP_PROP_XI_DECIMATION_SELECTOR = 431,
  cv::CAP_PROP_XI_DECIMATION_VERTICAL = 432,
  cv::CAP_PROP_XI_DECIMATION_HORIZONTAL = 433,
  cv::CAP_PROP_XI_DECIMATION_PATTERN = 434,
  cv::CAP_PROP_XI_TEST_PATTERN_GENERATOR_SELECTOR = 587,
  cv::CAP_PROP_XI_TEST_PATTERN = 588,
  cv::CAP_PROP_XI_IMAGE_DATA_FORMAT = 435,
  cv::CAP_PROP_XI_SHUTTER_TYPE = 436,
  cv::CAP_PROP_XI_SENSOR_TAPS = 437,
  cv::CAP_PROP_XI_AEAG_ROI_OFFSET_X = 439,
  cv::CAP_PROP_XI_AEAG_ROI_OFFSET_Y = 440,
  cv::CAP_PROP_XI_AEAG_ROI_WIDTH = 441,
  cv::CAP_PROP_XI_AEAG_ROI_HEIGHT = 442,
  cv::CAP_PROP_XI_BPC = 445,
  cv::CAP_PROP_XI_WB_KR = 448,
  cv::CAP_PROP_XI_WB_KG = 449,
  cv::CAP_PROP_XI_WB_KB = 450,
  cv::CAP_PROP_XI_WIDTH = 451,
  cv::CAP_PROP_XI_HEIGHT = 452,
  cv::CAP_PROP_XI_REGION_SELECTOR = 589,
  cv::CAP_PROP_XI_REGION_MODE = 595,
  cv::CAP_PROP_XI_LIMIT_BANDWIDTH = 459,
  cv::CAP_PROP_XI_SENSOR_DATA_BIT_DEPTH = 460,
  cv::CAP_PROP_XI_OUTPUT_DATA_BIT_DEPTH = 461,
  cv::CAP_PROP_XI_IMAGE_DATA_BIT_DEPTH = 462,
  cv::CAP_PROP_XI_OUTPUT_DATA_PACKING = 463,
  cv::CAP_PROP_XI_OUTPUT_DATA_PACKING_TYPE = 464,
  cv::CAP_PROP_XI_IS_COOLED = 465,
  cv::CAP_PROP_XI_COOLING = 466,
  cv::CAP_PROP_XI_TARGET_TEMP = 467,
  cv::CAP_PROP_XI_CHIP_TEMP = 468,
  cv::CAP_PROP_XI_HOUS_TEMP = 469,
  cv::CAP_PROP_XI_HOUS_BACK_SIDE_TEMP = 590,
  cv::CAP_PROP_XI_SENSOR_BOARD_TEMP = 596,
  cv::CAP_PROP_XI_CMS = 470,
  cv::CAP_PROP_XI_APPLY_CMS = 471,
  cv::CAP_PROP_XI_IMAGE_IS_COLOR = 474,
  cv::CAP_PROP_XI_COLOR_FILTER_ARRAY = 475,
  cv::CAP_PROP_XI_GAMMAY = 476,
  cv::CAP_PROP_XI_GAMMAC = 477,
  cv::CAP_PROP_XI_SHARPNESS = 478,
  cv::CAP_PROP_XI_CC_MATRIX_00 = 479,
  cv::CAP_PROP_XI_CC_MATRIX_01 = 480,
  cv::CAP_PROP_XI_CC_MATRIX_02 = 481,
  cv::CAP_PROP_XI_CC_MATRIX_03 = 482,
  cv::CAP_PROP_XI_CC_MATRIX_10 = 483,
  cv::CAP_PROP_XI_CC_MATRIX_11 = 484,
  cv::CAP_PROP_XI_CC_MATRIX_12 = 485,
  cv::CAP_PROP_XI_CC_MATRIX_13 = 486,
  cv::CAP_PROP_XI_CC_MATRIX_20 = 487,
  cv::CAP_PROP_XI_CC_MATRIX_21 = 488,
  cv::CAP_PROP_XI_CC_MATRIX_22 = 489,
  cv::CAP_PROP_XI_CC_MATRIX_23 = 490,
  cv::CAP_PROP_XI_CC_MATRIX_30 = 491,
  cv::CAP_PROP_XI_CC_MATRIX_31 = 492,
  cv::CAP_PROP_XI_CC_MATRIX_32 = 493,
  cv::CAP_PROP_XI_CC_MATRIX_33 = 494,
  cv::CAP_PROP_XI_DEFAULT_CC_MATRIX = 495,
  cv::CAP_PROP_XI_TRG_SELECTOR = 498,
  cv::CAP_PROP_XI_ACQ_FRAME_BURST_COUNT = 499,
  cv::CAP_PROP_XI_DEBOUNCE_EN = 507,
  cv::CAP_PROP_XI_DEBOUNCE_T0 = 508,
  cv::CAP_PROP_XI_DEBOUNCE_T1 = 509,
  cv::CAP_PROP_XI_DEBOUNCE_POL = 510,
  cv::CAP_PROP_XI_LENS_MODE = 511,
  cv::CAP_PROP_XI_LENS_APERTURE_VALUE = 512,
  cv::CAP_PROP_XI_LENS_FOCUS_MOVEMENT_VALUE = 513,
  cv::CAP_PROP_XI_LENS_FOCUS_MOVE = 514,
  cv::CAP_PROP_XI_LENS_FOCUS_DISTANCE = 515,
  cv::CAP_PROP_XI_LENS_FOCAL_LENGTH = 516,
  cv::CAP_PROP_XI_LENS_FEATURE_SELECTOR = 517,
  cv::CAP_PROP_XI_LENS_FEATURE = 518,
  cv::CAP_PROP_XI_DEVICE_MODEL_ID = 521,
  cv::CAP_PROP_XI_DEVICE_SN = 522,
  cv::CAP_PROP_XI_IMAGE_DATA_FORMAT_RGB32_ALPHA = 529,
  cv::CAP_PROP_XI_IMAGE_PAYLOAD_SIZE = 530,
  cv::CAP_PROP_XI_TRANSPORT_PIXEL_FORMAT = 531,
  cv::CAP_PROP_XI_SENSOR_CLOCK_FREQ_HZ = 532,
  cv::CAP_PROP_XI_SENSOR_CLOCK_FREQ_INDEX = 533,
  cv::CAP_PROP_XI_SENSOR_OUTPUT_CHANNEL_COUNT = 534,
  cv::CAP_PROP_XI_FRAMERATE = 535,
  cv::CAP_PROP_XI_COUNTER_SELECTOR = 536,
  cv::CAP_PROP_XI_COUNTER_VALUE = 537,
  cv::CAP_PROP_XI_ACQ_TIMING_MODE = 538,
  cv::CAP_PROP_XI_AVAILABLE_BANDWIDTH = 539,
  cv::CAP_PROP_XI_BUFFER_POLICY = 540,
  cv::CAP_PROP_XI_LUT_EN = 541,
  cv::CAP_PROP_XI_LUT_INDEX = 542,
  cv::CAP_PROP_XI_LUT_VALUE = 543,
  cv::CAP_PROP_XI_TRG_DELAY = 544,
  cv::CAP_PROP_XI_TS_RST_MODE = 545,
  cv::CAP_PROP_XI_TS_RST_SOURCE = 546,
  cv::CAP_PROP_XI_IS_DEVICE_EXIST = 547,
  cv::CAP_PROP_XI_ACQ_BUFFER_SIZE = 548,
  cv::CAP_PROP_XI_ACQ_BUFFER_SIZE_UNIT = 549,
  cv::CAP_PROP_XI_ACQ_TRANSPORT_BUFFER_SIZE = 550,
  cv::CAP_PROP_XI_BUFFERS_QUEUE_SIZE = 551,
  cv::CAP_PROP_XI_ACQ_TRANSPORT_BUFFER_COMMIT = 552,
  cv::CAP_PROP_XI_RECENT_FRAME = 553,
  cv::CAP_PROP_XI_DEVICE_RESET = 554,
  cv::CAP_PROP_XI_COLUMN_FPN_CORRECTION = 555,
  cv::CAP_PROP_XI_ROW_FPN_CORRECTION = 591,
  cv::CAP_PROP_XI_SENSOR_MODE = 558,
  cv::CAP_PROP_XI_HDR = 559,
  cv::CAP_PROP_XI_HDR_KNEEPOINT_COUNT = 560,
  cv::CAP_PROP_XI_HDR_T1 = 561,
  cv::CAP_PROP_XI_HDR_T2 = 562,
  cv::CAP_PROP_XI_KNEEPOINT1 = 563,
  cv::CAP_PROP_XI_KNEEPOINT2 = 564,
  cv::CAP_PROP_XI_IMAGE_BLACK_LEVEL = 565,
  cv::CAP_PROP_XI_HW_REVISION = 571,
  cv::CAP_PROP_XI_DEBUG_LEVEL = 572,
  cv::CAP_PROP_XI_AUTO_BANDWIDTH_CALCULATION = 573,
  cv::CAP_PROP_XI_FFS_FILE_ID = 594,
  cv::CAP_PROP_XI_FFS_FILE_SIZE = 580,
  cv::CAP_PROP_XI_FREE_FFS_SIZE = 581,
  cv::CAP_PROP_XI_USED_FFS_SIZE = 582,
  cv::CAP_PROP_XI_FFS_ACCESS_KEY = 583,
  cv::CAP_PROP_XI_SENSOR_FEATURE_SELECTOR = 585,
  cv::CAP_PROP_XI_SENSOR_FEATURE_VALUE = 586
}
 Properties of cameras available through XIMEA SDK backend. More...
 
enum  { cv::CAP_PROP_ARAVIS_AUTOTRIGGER = 600 }
 Properties of cameras available through ARAVIS backend. More...
 

AVFoundation framework for iOS

OS X Lion will have the same API

enum  {
  cv::CAP_PROP_IOS_DEVICE_FOCUS = 9001,
  cv::CAP_PROP_IOS_DEVICE_EXPOSURE = 9002,
  cv::CAP_PROP_IOS_DEVICE_FLASH = 9003,
  cv::CAP_PROP_IOS_DEVICE_WHITEBALANCE = 9004,
  cv::CAP_PROP_IOS_DEVICE_TORCH = 9005
}
 Properties of cameras available through AVFOUNDATION backend. More...
 

Smartek Giganetix GigEVisionSDK

enum  {
  cv::CAP_PROP_GIGA_FRAME_OFFSET_X = 10001,
  cv::CAP_PROP_GIGA_FRAME_OFFSET_Y = 10002,
  cv::CAP_PROP_GIGA_FRAME_WIDTH_MAX = 10003,
  cv::CAP_PROP_GIGA_FRAME_HEIGH_MAX = 10004,
  cv::CAP_PROP_GIGA_FRAME_SENS_WIDTH = 10005,
  cv::CAP_PROP_GIGA_FRAME_SENS_HEIGH = 10006
}
 Properties of cameras available through Smartek Giganetix Ethernet Vision backend. More...
 

Intel Perceptual Computing SDK

enum  {
  cv::CAP_PROP_INTELPERC_PROFILE_COUNT = 11001,
  cv::CAP_PROP_INTELPERC_PROFILE_IDX = 11002,
  cv::CAP_PROP_INTELPERC_DEPTH_LOW_CONFIDENCE_VALUE = 11003,
  cv::CAP_PROP_INTELPERC_DEPTH_SATURATION_VALUE = 11004,
  cv::CAP_PROP_INTELPERC_DEPTH_CONFIDENCE_THRESHOLD = 11005,
  cv::CAP_PROP_INTELPERC_DEPTH_FOCAL_LENGTH_HORZ = 11006,
  cv::CAP_PROP_INTELPERC_DEPTH_FOCAL_LENGTH_VERT = 11007
}
 
enum  {
  cv::CAP_INTELPERC_DEPTH_GENERATOR = 1 << 29,
  cv::CAP_INTELPERC_IMAGE_GENERATOR = 1 << 28,
  cv::CAP_INTELPERC_IR_GENERATOR = 1 << 27,
  cv::CAP_INTELPERC_GENERATORS_MASK = CAP_INTELPERC_DEPTH_GENERATOR + CAP_INTELPERC_IMAGE_GENERATOR + CAP_INTELPERC_IR_GENERATOR
}
 Intel Perceptual Streams. More...
 
enum  {
  cv::CAP_INTELPERC_DEPTH_MAP = 0,
  cv::CAP_INTELPERC_UVDEPTH_MAP = 1,
  cv::CAP_INTELPERC_IR_MAP = 2,
  cv::CAP_INTELPERC_IMAGE = 3
}
 

gPhoto2 connection

enum  {
  cv::CAP_PROP_GPHOTO2_PREVIEW = 17001,
  cv::CAP_PROP_GPHOTO2_WIDGET_ENUMERATE = 17002,
  cv::CAP_PROP_GPHOTO2_RELOAD_CONFIG = 17003,
  cv::CAP_PROP_GPHOTO2_RELOAD_ON_CHANGE = 17004,
  cv::CAP_PROP_GPHOTO2_COLLECT_MSGS = 17005,
  cv::CAP_PROP_GPHOTO2_FLUSH_MSGS = 17006,
  cv::CAP_PROP_SPEED = 17007,
  cv::CAP_PROP_APERTURE = 17008,
  cv::CAP_PROP_EXPOSUREPROGRAM = 17009,
  cv::CAP_PROP_VIEWFINDER = 17010
}
 gPhoto2 properties More...
 

Images backend

enum  {
  cv::CAP_PROP_IMAGES_BASE = 18000,
  cv::CAP_PROP_IMAGES_LAST = 19000
}
 Images backend properties. More...
 

Detailed Description

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

#include <opencv2/videoio.hpp>

Supported output modes of OpenNI image generator.

Enumerator
CAP_OPENNI_VGA_30HZ 
Python: cv.CAP_OPENNI_VGA_30HZ
CAP_OPENNI_SXGA_15HZ 
Python: cv.CAP_OPENNI_SXGA_15HZ
CAP_OPENNI_SXGA_30HZ 
Python: cv.CAP_OPENNI_SXGA_30HZ
CAP_OPENNI_QVGA_30HZ 
Python: cv.CAP_OPENNI_QVGA_30HZ
CAP_OPENNI_QVGA_60HZ 
Python: cv.CAP_OPENNI_QVGA_60HZ

◆ anonymous enum

anonymous enum

#include <opencv2/videoio.hpp>

Enumerator
CAP_PROP_GSTREAMER_QUEUE_LENGTH 
Python: cv.CAP_PROP_GSTREAMER_QUEUE_LENGTH

Default is 1.

◆ anonymous enum

anonymous enum

#include <opencv2/videoio.hpp>

PVAPI.

Enumerator
CAP_PROP_PVAPI_MULTICASTIP 
Python: cv.CAP_PROP_PVAPI_MULTICASTIP

IP for enable multicast master mode. 0 for disable multicast.

CAP_PROP_PVAPI_FRAMESTARTTRIGGERMODE 
Python: cv.CAP_PROP_PVAPI_FRAMESTARTTRIGGERMODE

FrameStartTriggerMode: Determines how a frame is initiated.

CAP_PROP_PVAPI_DECIMATIONHORIZONTAL 
Python: cv.CAP_PROP_PVAPI_DECIMATIONHORIZONTAL

Horizontal sub-sampling of the image.

CAP_PROP_PVAPI_DECIMATIONVERTICAL 
Python: cv.CAP_PROP_PVAPI_DECIMATIONVERTICAL

Vertical sub-sampling of the image.

CAP_PROP_PVAPI_BINNINGX 
Python: cv.CAP_PROP_PVAPI_BINNINGX

Horizontal binning factor.

CAP_PROP_PVAPI_BINNINGY 
Python: cv.CAP_PROP_PVAPI_BINNINGY

Vertical binning factor.

CAP_PROP_PVAPI_PIXELFORMAT 
Python: cv.CAP_PROP_PVAPI_PIXELFORMAT

Pixel format.

◆ anonymous enum

anonymous enum

#include <opencv2/videoio.hpp>

PVAPI: FrameStartTriggerMode.

Enumerator
CAP_PVAPI_FSTRIGMODE_FREERUN 
Python: cv.CAP_PVAPI_FSTRIGMODE_FREERUN

Freerun.

CAP_PVAPI_FSTRIGMODE_SYNCIN1 
Python: cv.CAP_PVAPI_FSTRIGMODE_SYNCIN1

SyncIn1.

CAP_PVAPI_FSTRIGMODE_SYNCIN2 
Python: cv.CAP_PVAPI_FSTRIGMODE_SYNCIN2

SyncIn2.

CAP_PVAPI_FSTRIGMODE_FIXEDRATE 
Python: cv.CAP_PVAPI_FSTRIGMODE_FIXEDRATE

FixedRate.

CAP_PVAPI_FSTRIGMODE_SOFTWARE 
Python: cv.CAP_PVAPI_FSTRIGMODE_SOFTWARE

Software.

◆ anonymous enum

anonymous enum

#include <opencv2/videoio.hpp>

PVAPI: DecimationHorizontal, DecimationVertical.

Enumerator
CAP_PVAPI_DECIMATION_OFF 
Python: cv.CAP_PVAPI_DECIMATION_OFF

Off.

CAP_PVAPI_DECIMATION_2OUTOF4 
Python: cv.CAP_PVAPI_DECIMATION_2OUTOF4

2 out of 4 decimation

CAP_PVAPI_DECIMATION_2OUTOF8 
Python: cv.CAP_PVAPI_DECIMATION_2OUTOF8

2 out of 8 decimation

CAP_PVAPI_DECIMATION_2OUTOF16 
Python: cv.CAP_PVAPI_DECIMATION_2OUTOF16

2 out of 16 decimation

◆ anonymous enum

anonymous enum

#include <opencv2/videoio.hpp>

PVAPI: PixelFormat.

Enumerator
CAP_PVAPI_PIXELFORMAT_MONO8 
Python: cv.CAP_PVAPI_PIXELFORMAT_MONO8

Mono8.

CAP_PVAPI_PIXELFORMAT_MONO16 
Python: cv.CAP_PVAPI_PIXELFORMAT_MONO16

Mono16.

CAP_PVAPI_PIXELFORMAT_BAYER8 
Python: cv.CAP_PVAPI_PIXELFORMAT_BAYER8

Bayer8.

CAP_PVAPI_PIXELFORMAT_BAYER16 
Python: cv.CAP_PVAPI_PIXELFORMAT_BAYER16

Bayer16.

CAP_PVAPI_PIXELFORMAT_RGB24 
Python: cv.CAP_PVAPI_PIXELFORMAT_RGB24

Rgb24.

CAP_PVAPI_PIXELFORMAT_BGR24 
Python: cv.CAP_PVAPI_PIXELFORMAT_BGR24

Bgr24.

CAP_PVAPI_PIXELFORMAT_RGBA32 
Python: cv.CAP_PVAPI_PIXELFORMAT_RGBA32

Rgba32.

CAP_PVAPI_PIXELFORMAT_BGRA32 
Python: cv.CAP_PVAPI_PIXELFORMAT_BGRA32

Bgra32.

◆ anonymous enum

anonymous enum

#include <opencv2/videoio.hpp>

Properties of cameras available through XIMEA SDK backend.

Enumerator
CAP_PROP_XI_DOWNSAMPLING 
Python: cv.CAP_PROP_XI_DOWNSAMPLING

Change image resolution by binning or skipping.

CAP_PROP_XI_DATA_FORMAT 
Python: cv.CAP_PROP_XI_DATA_FORMAT

Output data format.

CAP_PROP_XI_OFFSET_X 
Python: cv.CAP_PROP_XI_OFFSET_X

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

CAP_PROP_XI_OFFSET_Y 
Python: cv.CAP_PROP_XI_OFFSET_Y

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

CAP_PROP_XI_TRG_SOURCE 
Python: cv.CAP_PROP_XI_TRG_SOURCE

Defines source of trigger.

CAP_PROP_XI_TRG_SOFTWARE 
Python: cv.CAP_PROP_XI_TRG_SOFTWARE

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

CAP_PROP_XI_GPI_SELECTOR 
Python: cv.CAP_PROP_XI_GPI_SELECTOR

Selects general purpose input.

CAP_PROP_XI_GPI_MODE 
Python: cv.CAP_PROP_XI_GPI_MODE

Set general purpose input mode.

CAP_PROP_XI_GPI_LEVEL 
Python: cv.CAP_PROP_XI_GPI_LEVEL

Get general purpose level.

CAP_PROP_XI_GPO_SELECTOR 
Python: cv.CAP_PROP_XI_GPO_SELECTOR

Selects general purpose output.

CAP_PROP_XI_GPO_MODE 
Python: cv.CAP_PROP_XI_GPO_MODE

Set general purpose output mode.

CAP_PROP_XI_LED_SELECTOR 
Python: cv.CAP_PROP_XI_LED_SELECTOR

Selects camera signalling LED.

CAP_PROP_XI_LED_MODE 
Python: cv.CAP_PROP_XI_LED_MODE

Define camera signalling LED functionality.

CAP_PROP_XI_MANUAL_WB 
Python: cv.CAP_PROP_XI_MANUAL_WB

Calculates White Balance(must be called during acquisition).

CAP_PROP_XI_AUTO_WB 
Python: cv.CAP_PROP_XI_AUTO_WB

Automatic white balance.

CAP_PROP_XI_AEAG 
Python: cv.CAP_PROP_XI_AEAG

Automatic exposure/gain.

CAP_PROP_XI_EXP_PRIORITY 
Python: cv.CAP_PROP_XI_EXP_PRIORITY

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

CAP_PROP_XI_AE_MAX_LIMIT 
Python: cv.CAP_PROP_XI_AE_MAX_LIMIT

Maximum limit of exposure in AEAG procedure.

CAP_PROP_XI_AG_MAX_LIMIT 
Python: cv.CAP_PROP_XI_AG_MAX_LIMIT

Maximum limit of gain in AEAG procedure.

CAP_PROP_XI_AEAG_LEVEL 
Python: cv.CAP_PROP_XI_AEAG_LEVEL

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

CAP_PROP_XI_TIMEOUT 
Python: cv.CAP_PROP_XI_TIMEOUT

Image capture timeout in milliseconds.

CAP_PROP_XI_EXPOSURE 
Python: cv.CAP_PROP_XI_EXPOSURE

Exposure time in microseconds.

CAP_PROP_XI_EXPOSURE_BURST_COUNT 
Python: cv.CAP_PROP_XI_EXPOSURE_BURST_COUNT

Sets the number of times of exposure in one frame.

CAP_PROP_XI_GAIN_SELECTOR 
Python: cv.CAP_PROP_XI_GAIN_SELECTOR

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

CAP_PROP_XI_GAIN 
Python: cv.CAP_PROP_XI_GAIN

Gain in dB.

CAP_PROP_XI_DOWNSAMPLING_TYPE 
Python: cv.CAP_PROP_XI_DOWNSAMPLING_TYPE

Change image downsampling type.

CAP_PROP_XI_BINNING_SELECTOR 
Python: cv.CAP_PROP_XI_BINNING_SELECTOR

Binning engine selector.

CAP_PROP_XI_BINNING_VERTICAL 
Python: cv.CAP_PROP_XI_BINNING_VERTICAL

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

CAP_PROP_XI_BINNING_HORIZONTAL 
Python: cv.CAP_PROP_XI_BINNING_HORIZONTAL

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

CAP_PROP_XI_BINNING_PATTERN 
Python: cv.CAP_PROP_XI_BINNING_PATTERN

Binning pattern type.

CAP_PROP_XI_DECIMATION_SELECTOR 
Python: cv.CAP_PROP_XI_DECIMATION_SELECTOR

Decimation engine selector.

CAP_PROP_XI_DECIMATION_VERTICAL 
Python: cv.CAP_PROP_XI_DECIMATION_VERTICAL

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

CAP_PROP_XI_DECIMATION_HORIZONTAL 
Python: cv.CAP_PROP_XI_DECIMATION_HORIZONTAL

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

CAP_PROP_XI_DECIMATION_PATTERN 
Python: cv.CAP_PROP_XI_DECIMATION_PATTERN

Decimation pattern type.

CAP_PROP_XI_TEST_PATTERN_GENERATOR_SELECTOR 
Python: cv.CAP_PROP_XI_TEST_PATTERN_GENERATOR_SELECTOR

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

CAP_PROP_XI_TEST_PATTERN 
Python: cv.CAP_PROP_XI_TEST_PATTERN

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

CAP_PROP_XI_IMAGE_DATA_FORMAT 
Python: cv.CAP_PROP_XI_IMAGE_DATA_FORMAT

Output data format.

CAP_PROP_XI_SHUTTER_TYPE 
Python: cv.CAP_PROP_XI_SHUTTER_TYPE

Change sensor shutter type(CMOS sensor).

CAP_PROP_XI_SENSOR_TAPS 
Python: cv.CAP_PROP_XI_SENSOR_TAPS

Number of taps.

CAP_PROP_XI_AEAG_ROI_OFFSET_X 
Python: cv.CAP_PROP_XI_AEAG_ROI_OFFSET_X

Automatic exposure/gain ROI offset X.

CAP_PROP_XI_AEAG_ROI_OFFSET_Y 
Python: cv.CAP_PROP_XI_AEAG_ROI_OFFSET_Y

Automatic exposure/gain ROI offset Y.

CAP_PROP_XI_AEAG_ROI_WIDTH 
Python: cv.CAP_PROP_XI_AEAG_ROI_WIDTH

Automatic exposure/gain ROI Width.

CAP_PROP_XI_AEAG_ROI_HEIGHT 
Python: cv.CAP_PROP_XI_AEAG_ROI_HEIGHT

Automatic exposure/gain ROI Height.

CAP_PROP_XI_BPC 
Python: cv.CAP_PROP_XI_BPC

Correction of bad pixels.

CAP_PROP_XI_WB_KR 
Python: cv.CAP_PROP_XI_WB_KR

White balance red coefficient.

CAP_PROP_XI_WB_KG 
Python: cv.CAP_PROP_XI_WB_KG

White balance green coefficient.

CAP_PROP_XI_WB_KB 
Python: cv.CAP_PROP_XI_WB_KB

White balance blue coefficient.

CAP_PROP_XI_WIDTH 
Python: cv.CAP_PROP_XI_WIDTH

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

CAP_PROP_XI_HEIGHT 
Python: cv.CAP_PROP_XI_HEIGHT

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

CAP_PROP_XI_REGION_SELECTOR 
Python: cv.CAP_PROP_XI_REGION_SELECTOR

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

CAP_PROP_XI_REGION_MODE 
Python: cv.CAP_PROP_XI_REGION_MODE

Activates/deactivates Region selected by Region Selector.

CAP_PROP_XI_LIMIT_BANDWIDTH 
Python: cv.CAP_PROP_XI_LIMIT_BANDWIDTH

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

CAP_PROP_XI_SENSOR_DATA_BIT_DEPTH 
Python: cv.CAP_PROP_XI_SENSOR_DATA_BIT_DEPTH

Sensor output data bit depth.

CAP_PROP_XI_OUTPUT_DATA_BIT_DEPTH 
Python: cv.CAP_PROP_XI_OUTPUT_DATA_BIT_DEPTH

Device output data bit depth.

CAP_PROP_XI_IMAGE_DATA_BIT_DEPTH 
Python: cv.CAP_PROP_XI_IMAGE_DATA_BIT_DEPTH

bitdepth of data returned by function xiGetImage.

CAP_PROP_XI_OUTPUT_DATA_PACKING 
Python: cv.CAP_PROP_XI_OUTPUT_DATA_PACKING

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

CAP_PROP_XI_OUTPUT_DATA_PACKING_TYPE 
Python: cv.CAP_PROP_XI_OUTPUT_DATA_PACKING_TYPE

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

CAP_PROP_XI_IS_COOLED 
Python: cv.CAP_PROP_XI_IS_COOLED

Returns 1 for cameras that support cooling.

CAP_PROP_XI_COOLING 
Python: cv.CAP_PROP_XI_COOLING

Start camera cooling.

CAP_PROP_XI_TARGET_TEMP 
Python: cv.CAP_PROP_XI_TARGET_TEMP

Set sensor target temperature for cooling.

CAP_PROP_XI_CHIP_TEMP 
Python: cv.CAP_PROP_XI_CHIP_TEMP

Camera sensor temperature.

CAP_PROP_XI_HOUS_TEMP 
Python: cv.CAP_PROP_XI_HOUS_TEMP

Camera housing temperature.

CAP_PROP_XI_HOUS_BACK_SIDE_TEMP 
Python: cv.CAP_PROP_XI_HOUS_BACK_SIDE_TEMP

Camera housing back side temperature.

CAP_PROP_XI_SENSOR_BOARD_TEMP 
Python: cv.CAP_PROP_XI_SENSOR_BOARD_TEMP

Camera sensor board temperature.

CAP_PROP_XI_CMS 
Python: cv.CAP_PROP_XI_CMS

Mode of color management system.

CAP_PROP_XI_APPLY_CMS 
Python: cv.CAP_PROP_XI_APPLY_CMS

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

CAP_PROP_XI_IMAGE_IS_COLOR 
Python: cv.CAP_PROP_XI_IMAGE_IS_COLOR

Returns 1 for color cameras.

CAP_PROP_XI_COLOR_FILTER_ARRAY 
Python: cv.CAP_PROP_XI_COLOR_FILTER_ARRAY

Returns color filter array type of RAW data.

CAP_PROP_XI_GAMMAY 
Python: cv.CAP_PROP_XI_GAMMAY

Luminosity gamma.

CAP_PROP_XI_GAMMAC 
Python: cv.CAP_PROP_XI_GAMMAC

Chromaticity gamma.

CAP_PROP_XI_SHARPNESS 
Python: cv.CAP_PROP_XI_SHARPNESS

Sharpness Strength.

CAP_PROP_XI_CC_MATRIX_00 
Python: cv.CAP_PROP_XI_CC_MATRIX_00

Color Correction Matrix element [0][0].

CAP_PROP_XI_CC_MATRIX_01 
Python: cv.CAP_PROP_XI_CC_MATRIX_01

Color Correction Matrix element [0][1].

CAP_PROP_XI_CC_MATRIX_02 
Python: cv.CAP_PROP_XI_CC_MATRIX_02

Color Correction Matrix element [0][2].

CAP_PROP_XI_CC_MATRIX_03 
Python: cv.CAP_PROP_XI_CC_MATRIX_03

Color Correction Matrix element [0][3].

CAP_PROP_XI_CC_MATRIX_10 
Python: cv.CAP_PROP_XI_CC_MATRIX_10

Color Correction Matrix element [1][0].

CAP_PROP_XI_CC_MATRIX_11 
Python: cv.CAP_PROP_XI_CC_MATRIX_11

Color Correction Matrix element [1][1].

CAP_PROP_XI_CC_MATRIX_12 
Python: cv.CAP_PROP_XI_CC_MATRIX_12

Color Correction Matrix element [1][2].

CAP_PROP_XI_CC_MATRIX_13 
Python: cv.CAP_PROP_XI_CC_MATRIX_13

Color Correction Matrix element [1][3].

CAP_PROP_XI_CC_MATRIX_20 
Python: cv.CAP_PROP_XI_CC_MATRIX_20

Color Correction Matrix element [2][0].

CAP_PROP_XI_CC_MATRIX_21 
Python: cv.CAP_PROP_XI_CC_MATRIX_21

Color Correction Matrix element [2][1].

CAP_PROP_XI_CC_MATRIX_22 
Python: cv.CAP_PROP_XI_CC_MATRIX_22

Color Correction Matrix element [2][2].

CAP_PROP_XI_CC_MATRIX_23 
Python: cv.CAP_PROP_XI_CC_MATRIX_23

Color Correction Matrix element [2][3].

CAP_PROP_XI_CC_MATRIX_30 
Python: cv.CAP_PROP_XI_CC_MATRIX_30

Color Correction Matrix element [3][0].

CAP_PROP_XI_CC_MATRIX_31 
Python: cv.CAP_PROP_XI_CC_MATRIX_31

Color Correction Matrix element [3][1].

CAP_PROP_XI_CC_MATRIX_32 
Python: cv.CAP_PROP_XI_CC_MATRIX_32

Color Correction Matrix element [3][2].

CAP_PROP_XI_CC_MATRIX_33 
Python: cv.CAP_PROP_XI_CC_MATRIX_33

Color Correction Matrix element [3][3].

CAP_PROP_XI_DEFAULT_CC_MATRIX 
Python: cv.CAP_PROP_XI_DEFAULT_CC_MATRIX

Set default Color Correction Matrix.

CAP_PROP_XI_TRG_SELECTOR 
Python: cv.CAP_PROP_XI_TRG_SELECTOR

Selects the type of trigger.

CAP_PROP_XI_ACQ_FRAME_BURST_COUNT 
Python: cv.CAP_PROP_XI_ACQ_FRAME_BURST_COUNT

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

CAP_PROP_XI_DEBOUNCE_EN 
Python: cv.CAP_PROP_XI_DEBOUNCE_EN

Enable/Disable debounce to selected GPI.

CAP_PROP_XI_DEBOUNCE_T0 
Python: cv.CAP_PROP_XI_DEBOUNCE_T0

Debounce time (x * 10us).

CAP_PROP_XI_DEBOUNCE_T1 
Python: cv.CAP_PROP_XI_DEBOUNCE_T1

Debounce time (x * 10us).

CAP_PROP_XI_DEBOUNCE_POL 
Python: cv.CAP_PROP_XI_DEBOUNCE_POL

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

CAP_PROP_XI_LENS_MODE 
Python: cv.CAP_PROP_XI_LENS_MODE

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

CAP_PROP_XI_LENS_APERTURE_VALUE 
Python: cv.CAP_PROP_XI_LENS_APERTURE_VALUE

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

CAP_PROP_XI_LENS_FOCUS_MOVEMENT_VALUE 
Python: cv.CAP_PROP_XI_LENS_FOCUS_MOVEMENT_VALUE

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

CAP_PROP_XI_LENS_FOCUS_MOVE 
Python: cv.CAP_PROP_XI_LENS_FOCUS_MOVE

Moves lens focus motor by steps set in XI_PRM_LENS_FOCUS_MOVEMENT_VALUE.

CAP_PROP_XI_LENS_FOCUS_DISTANCE 
Python: cv.CAP_PROP_XI_LENS_FOCUS_DISTANCE

Lens focus distance in cm.

CAP_PROP_XI_LENS_FOCAL_LENGTH 
Python: cv.CAP_PROP_XI_LENS_FOCAL_LENGTH

Lens focal distance in mm.

CAP_PROP_XI_LENS_FEATURE_SELECTOR 
Python: cv.CAP_PROP_XI_LENS_FEATURE_SELECTOR

Selects the current feature which is accessible by XI_PRM_LENS_FEATURE.

CAP_PROP_XI_LENS_FEATURE 
Python: cv.CAP_PROP_XI_LENS_FEATURE

Allows access to lens feature value currently selected by XI_PRM_LENS_FEATURE_SELECTOR.

CAP_PROP_XI_DEVICE_MODEL_ID 
Python: cv.CAP_PROP_XI_DEVICE_MODEL_ID

Returns device model id.

CAP_PROP_XI_DEVICE_SN 
Python: cv.CAP_PROP_XI_DEVICE_SN

Returns device serial number.

CAP_PROP_XI_IMAGE_DATA_FORMAT_RGB32_ALPHA 
Python: cv.CAP_PROP_XI_IMAGE_DATA_FORMAT_RGB32_ALPHA

The alpha channel of RGB32 output image format.

CAP_PROP_XI_IMAGE_PAYLOAD_SIZE 
Python: cv.CAP_PROP_XI_IMAGE_PAYLOAD_SIZE

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

CAP_PROP_XI_TRANSPORT_PIXEL_FORMAT 
Python: cv.CAP_PROP_XI_TRANSPORT_PIXEL_FORMAT

Current format of pixels on transport layer.

CAP_PROP_XI_SENSOR_CLOCK_FREQ_HZ 
Python: cv.CAP_PROP_XI_SENSOR_CLOCK_FREQ_HZ

Sensor clock frequency in Hz.

CAP_PROP_XI_SENSOR_CLOCK_FREQ_INDEX 
Python: cv.CAP_PROP_XI_SENSOR_CLOCK_FREQ_INDEX

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

CAP_PROP_XI_SENSOR_OUTPUT_CHANNEL_COUNT 
Python: cv.CAP_PROP_XI_SENSOR_OUTPUT_CHANNEL_COUNT

Number of output channels from sensor used for data transfer.

CAP_PROP_XI_FRAMERATE 
Python: cv.CAP_PROP_XI_FRAMERATE

Define framerate in Hz.

CAP_PROP_XI_COUNTER_SELECTOR 
Python: cv.CAP_PROP_XI_COUNTER_SELECTOR

Select counter.

CAP_PROP_XI_COUNTER_VALUE 
Python: cv.CAP_PROP_XI_COUNTER_VALUE

Counter status.

CAP_PROP_XI_ACQ_TIMING_MODE 
Python: cv.CAP_PROP_XI_ACQ_TIMING_MODE

Type of sensor frames timing.

CAP_PROP_XI_AVAILABLE_BANDWIDTH 
Python: cv.CAP_PROP_XI_AVAILABLE_BANDWIDTH

Calculate and returns available interface bandwidth(int Megabits).

CAP_PROP_XI_BUFFER_POLICY 
Python: cv.CAP_PROP_XI_BUFFER_POLICY

Data move policy.

CAP_PROP_XI_LUT_EN 
Python: cv.CAP_PROP_XI_LUT_EN

Activates LUT.

CAP_PROP_XI_LUT_INDEX 
Python: cv.CAP_PROP_XI_LUT_INDEX

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

CAP_PROP_XI_LUT_VALUE 
Python: cv.CAP_PROP_XI_LUT_VALUE

Value at entry LUTIndex of the LUT.

CAP_PROP_XI_TRG_DELAY 
Python: cv.CAP_PROP_XI_TRG_DELAY

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

CAP_PROP_XI_TS_RST_MODE 
Python: cv.CAP_PROP_XI_TS_RST_MODE

Defines how time stamp reset engine will be armed.

CAP_PROP_XI_TS_RST_SOURCE 
Python: cv.CAP_PROP_XI_TS_RST_SOURCE

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

CAP_PROP_XI_IS_DEVICE_EXIST 
Python: cv.CAP_PROP_XI_IS_DEVICE_EXIST

Returns 1 if camera connected and works properly.

CAP_PROP_XI_ACQ_BUFFER_SIZE 
Python: cv.CAP_PROP_XI_ACQ_BUFFER_SIZE

Acquisition buffer size in buffer_size_unit. Default bytes.

CAP_PROP_XI_ACQ_BUFFER_SIZE_UNIT 
Python: cv.CAP_PROP_XI_ACQ_BUFFER_SIZE_UNIT

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

CAP_PROP_XI_ACQ_TRANSPORT_BUFFER_SIZE 
Python: cv.CAP_PROP_XI_ACQ_TRANSPORT_BUFFER_SIZE

Acquisition transport buffer size in bytes.

CAP_PROP_XI_BUFFERS_QUEUE_SIZE 
Python: cv.CAP_PROP_XI_BUFFERS_QUEUE_SIZE

Queue of field/frame buffers.

CAP_PROP_XI_ACQ_TRANSPORT_BUFFER_COMMIT 
Python: cv.CAP_PROP_XI_ACQ_TRANSPORT_BUFFER_COMMIT

Number of buffers to commit to low level.

CAP_PROP_XI_RECENT_FRAME 
Python: cv.CAP_PROP_XI_RECENT_FRAME

GetImage returns most recent frame.

CAP_PROP_XI_DEVICE_RESET 
Python: cv.CAP_PROP_XI_DEVICE_RESET

Resets the camera to default state.

CAP_PROP_XI_COLUMN_FPN_CORRECTION 
Python: cv.CAP_PROP_XI_COLUMN_FPN_CORRECTION

Correction of column FPN.

CAP_PROP_XI_ROW_FPN_CORRECTION 
Python: cv.CAP_PROP_XI_ROW_FPN_CORRECTION

Correction of row FPN.

CAP_PROP_XI_SENSOR_MODE 
Python: cv.CAP_PROP_XI_SENSOR_MODE

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

CAP_PROP_XI_HDR 
Python: cv.CAP_PROP_XI_HDR

Enable High Dynamic Range feature.

CAP_PROP_XI_HDR_KNEEPOINT_COUNT 
Python: cv.CAP_PROP_XI_HDR_KNEEPOINT_COUNT

The number of kneepoints in the PWLR.

CAP_PROP_XI_HDR_T1 
Python: cv.CAP_PROP_XI_HDR_T1

Position of first kneepoint(in % of XI_PRM_EXPOSURE).

CAP_PROP_XI_HDR_T2 
Python: cv.CAP_PROP_XI_HDR_T2

Position of second kneepoint (in % of XI_PRM_EXPOSURE).

CAP_PROP_XI_KNEEPOINT1 
Python: cv.CAP_PROP_XI_KNEEPOINT1

Value of first kneepoint (% of sensor saturation).

CAP_PROP_XI_KNEEPOINT2 
Python: cv.CAP_PROP_XI_KNEEPOINT2

Value of second kneepoint (% of sensor saturation).

CAP_PROP_XI_IMAGE_BLACK_LEVEL 
Python: cv.CAP_PROP_XI_IMAGE_BLACK_LEVEL

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

CAP_PROP_XI_HW_REVISION 
Python: cv.CAP_PROP_XI_HW_REVISION

Returns hardware revision number.

CAP_PROP_XI_DEBUG_LEVEL 
Python: cv.CAP_PROP_XI_DEBUG_LEVEL

Set debug level.

CAP_PROP_XI_AUTO_BANDWIDTH_CALCULATION 
Python: cv.CAP_PROP_XI_AUTO_BANDWIDTH_CALCULATION

Automatic bandwidth calculation.

CAP_PROP_XI_FFS_FILE_ID 
Python: cv.CAP_PROP_XI_FFS_FILE_ID

File number.

CAP_PROP_XI_FFS_FILE_SIZE 
Python: cv.CAP_PROP_XI_FFS_FILE_SIZE

Size of file.

CAP_PROP_XI_FREE_FFS_SIZE 
Python: cv.CAP_PROP_XI_FREE_FFS_SIZE

Size of free camera FFS.

CAP_PROP_XI_USED_FFS_SIZE 
Python: cv.CAP_PROP_XI_USED_FFS_SIZE

Size of used camera FFS.

CAP_PROP_XI_FFS_ACCESS_KEY 
Python: cv.CAP_PROP_XI_FFS_ACCESS_KEY

Setting of key enables file operations on some cameras.

CAP_PROP_XI_SENSOR_FEATURE_SELECTOR 
Python: cv.CAP_PROP_XI_SENSOR_FEATURE_SELECTOR

Selects the current feature which is accessible by XI_PRM_SENSOR_FEATURE_VALUE.

CAP_PROP_XI_SENSOR_FEATURE_VALUE 
Python: cv.CAP_PROP_XI_SENSOR_FEATURE_VALUE

Allows access to sensor feature value currently selected by XI_PRM_SENSOR_FEATURE_SELECTOR.

◆ anonymous enum

anonymous enum

#include <opencv2/videoio.hpp>

Properties of cameras available through ARAVIS backend.

Enumerator
CAP_PROP_ARAVIS_AUTOTRIGGER 
Python: cv.CAP_PROP_ARAVIS_AUTOTRIGGER

Automatically trigger frame capture if camera is configured with software trigger.

◆ anonymous enum

anonymous enum

#include <opencv2/videoio.hpp>

Properties of cameras available through AVFOUNDATION backend.

Enumerator
CAP_PROP_IOS_DEVICE_FOCUS 
Python: cv.CAP_PROP_IOS_DEVICE_FOCUS
CAP_PROP_IOS_DEVICE_EXPOSURE 
Python: cv.CAP_PROP_IOS_DEVICE_EXPOSURE
CAP_PROP_IOS_DEVICE_FLASH 
Python: cv.CAP_PROP_IOS_DEVICE_FLASH
CAP_PROP_IOS_DEVICE_WHITEBALANCE 
Python: cv.CAP_PROP_IOS_DEVICE_WHITEBALANCE
CAP_PROP_IOS_DEVICE_TORCH 
Python: cv.CAP_PROP_IOS_DEVICE_TORCH

◆ anonymous enum

anonymous enum

#include <opencv2/videoio.hpp>

Properties of cameras available through Smartek Giganetix Ethernet Vision backend.

Enumerator
CAP_PROP_GIGA_FRAME_OFFSET_X 
Python: cv.CAP_PROP_GIGA_FRAME_OFFSET_X
CAP_PROP_GIGA_FRAME_OFFSET_Y 
Python: cv.CAP_PROP_GIGA_FRAME_OFFSET_Y
CAP_PROP_GIGA_FRAME_WIDTH_MAX 
Python: cv.CAP_PROP_GIGA_FRAME_WIDTH_MAX
CAP_PROP_GIGA_FRAME_HEIGH_MAX 
Python: cv.CAP_PROP_GIGA_FRAME_HEIGH_MAX
CAP_PROP_GIGA_FRAME_SENS_WIDTH 
Python: cv.CAP_PROP_GIGA_FRAME_SENS_WIDTH
CAP_PROP_GIGA_FRAME_SENS_HEIGH 
Python: cv.CAP_PROP_GIGA_FRAME_SENS_HEIGH

◆ anonymous enum

anonymous enum

#include <opencv2/videoio.hpp>

Enumerator
CAP_PROP_INTELPERC_PROFILE_COUNT 
Python: cv.CAP_PROP_INTELPERC_PROFILE_COUNT
CAP_PROP_INTELPERC_PROFILE_IDX 
Python: cv.CAP_PROP_INTELPERC_PROFILE_IDX
CAP_PROP_INTELPERC_DEPTH_LOW_CONFIDENCE_VALUE 
Python: cv.CAP_PROP_INTELPERC_DEPTH_LOW_CONFIDENCE_VALUE
CAP_PROP_INTELPERC_DEPTH_SATURATION_VALUE 
Python: cv.CAP_PROP_INTELPERC_DEPTH_SATURATION_VALUE
CAP_PROP_INTELPERC_DEPTH_CONFIDENCE_THRESHOLD 
Python: cv.CAP_PROP_INTELPERC_DEPTH_CONFIDENCE_THRESHOLD
CAP_PROP_INTELPERC_DEPTH_FOCAL_LENGTH_HORZ 
Python: cv.CAP_PROP_INTELPERC_DEPTH_FOCAL_LENGTH_HORZ
CAP_PROP_INTELPERC_DEPTH_FOCAL_LENGTH_VERT 
Python: cv.CAP_PROP_INTELPERC_DEPTH_FOCAL_LENGTH_VERT

◆ anonymous enum

anonymous enum

#include <opencv2/videoio.hpp>

Intel Perceptual Streams.

Enumerator
CAP_INTELPERC_DEPTH_GENERATOR 
Python: cv.CAP_INTELPERC_DEPTH_GENERATOR
CAP_INTELPERC_IMAGE_GENERATOR 
Python: cv.CAP_INTELPERC_IMAGE_GENERATOR
CAP_INTELPERC_IR_GENERATOR 
Python: cv.CAP_INTELPERC_IR_GENERATOR
CAP_INTELPERC_GENERATORS_MASK 
Python: cv.CAP_INTELPERC_GENERATORS_MASK

◆ anonymous enum

anonymous enum

#include <opencv2/videoio.hpp>

Enumerator
CAP_INTELPERC_DEPTH_MAP 
Python: cv.CAP_INTELPERC_DEPTH_MAP

Each pixel is a 16-bit integer. The value indicates the distance from an object to the camera's XY plane or the Cartesian depth.

CAP_INTELPERC_UVDEPTH_MAP 
Python: cv.CAP_INTELPERC_UVDEPTH_MAP

Each pixel contains two 32-bit floating point values in the range of 0-1, representing the mapping of depth coordinates to the color coordinates.

CAP_INTELPERC_IR_MAP 
Python: cv.CAP_INTELPERC_IR_MAP

Each pixel is a 16-bit integer. The value indicates the intensity of the reflected laser beam.

CAP_INTELPERC_IMAGE 
Python: cv.CAP_INTELPERC_IMAGE

◆ anonymous enum

anonymous enum

#include <opencv2/videoio.hpp>

gPhoto2 properties

If propertyId is less than 0 then work on widget with that additive inversed camera setting ID Get IDs by using CAP_PROP_GPHOTO2_WIDGET_ENUMERATE.

See also
CvCaptureCAM_GPHOTO2 for more info
Enumerator
CAP_PROP_GPHOTO2_PREVIEW 
Python: cv.CAP_PROP_GPHOTO2_PREVIEW

Capture only preview from liveview mode.

CAP_PROP_GPHOTO2_WIDGET_ENUMERATE 
Python: cv.CAP_PROP_GPHOTO2_WIDGET_ENUMERATE

Readonly, returns (const char *).

CAP_PROP_GPHOTO2_RELOAD_CONFIG 
Python: cv.CAP_PROP_GPHOTO2_RELOAD_CONFIG

Trigger, only by set. Reload camera settings.

CAP_PROP_GPHOTO2_RELOAD_ON_CHANGE 
Python: cv.CAP_PROP_GPHOTO2_RELOAD_ON_CHANGE

Reload all settings on set.

CAP_PROP_GPHOTO2_COLLECT_MSGS 
Python: cv.CAP_PROP_GPHOTO2_COLLECT_MSGS

Collect messages with details.

CAP_PROP_GPHOTO2_FLUSH_MSGS 
Python: cv.CAP_PROP_GPHOTO2_FLUSH_MSGS

Readonly, returns (const char *).

CAP_PROP_SPEED 
Python: cv.CAP_PROP_SPEED

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

CAP_PROP_APERTURE 
Python: cv.CAP_PROP_APERTURE

Aperture. Can be readonly, depends on camera program.

CAP_PROP_EXPOSUREPROGRAM 
Python: cv.CAP_PROP_EXPOSUREPROGRAM

Camera exposure program.

CAP_PROP_VIEWFINDER 
Python: cv.CAP_PROP_VIEWFINDER

Enter liveview mode.

◆ anonymous enum

anonymous enum

#include <opencv2/videoio.hpp>

Images backend properties.

Enumerator
CAP_PROP_IMAGES_BASE 
Python: cv.CAP_PROP_IMAGES_BASE
CAP_PROP_IMAGES_LAST 
Python: cv.CAP_PROP_IMAGES_LAST

◆ anonymous enum

anonymous enum

#include <opencv2/videoio.hpp>

Modes of the IEEE 1394 controlling registers (can be: auto, manual, auto single push, absolute Latter allowed with any other mode) every feature can have only one mode turned on at a time.

Enumerator
CAP_PROP_DC1394_OFF 
Python: cv.CAP_PROP_DC1394_OFF

turn the feature off (not controlled manually nor automatically).

CAP_PROP_DC1394_MODE_MANUAL 
Python: cv.CAP_PROP_DC1394_MODE_MANUAL

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

CAP_PROP_DC1394_MODE_AUTO 
Python: cv.CAP_PROP_DC1394_MODE_AUTO
CAP_PROP_DC1394_MODE_ONE_PUSH_AUTO 
Python: cv.CAP_PROP_DC1394_MODE_ONE_PUSH_AUTO
CAP_PROP_DC1394_MAX 
Python: cv.CAP_PROP_DC1394_MAX

◆ anonymous enum

anonymous enum

#include <opencv2/videoio.hpp>

OpenNI map generators.

Enumerator
CAP_OPENNI_DEPTH_GENERATOR 
Python: cv.CAP_OPENNI_DEPTH_GENERATOR
CAP_OPENNI_IMAGE_GENERATOR 
Python: cv.CAP_OPENNI_IMAGE_GENERATOR
CAP_OPENNI_IR_GENERATOR 
Python: cv.CAP_OPENNI_IR_GENERATOR
CAP_OPENNI_GENERATORS_MASK 
Python: cv.CAP_OPENNI_GENERATORS_MASK

◆ anonymous enum

anonymous enum

#include <opencv2/videoio.hpp>

Properties of cameras available through OpenNI backend.

Enumerator
CAP_PROP_OPENNI_OUTPUT_MODE 
Python: cv.CAP_PROP_OPENNI_OUTPUT_MODE
CAP_PROP_OPENNI_FRAME_MAX_DEPTH 
Python: cv.CAP_PROP_OPENNI_FRAME_MAX_DEPTH

In mm.

CAP_PROP_OPENNI_BASELINE 
Python: cv.CAP_PROP_OPENNI_BASELINE

In mm.

CAP_PROP_OPENNI_FOCAL_LENGTH 
Python: cv.CAP_PROP_OPENNI_FOCAL_LENGTH

In pixels.

CAP_PROP_OPENNI_REGISTRATION 
Python: cv.CAP_PROP_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").

CAP_PROP_OPENNI_REGISTRATION_ON 
Python: cv.CAP_PROP_OPENNI_REGISTRATION_ON
CAP_PROP_OPENNI_APPROX_FRAME_SYNC 
Python: cv.CAP_PROP_OPENNI_APPROX_FRAME_SYNC
CAP_PROP_OPENNI_MAX_BUFFER_SIZE 
Python: cv.CAP_PROP_OPENNI_MAX_BUFFER_SIZE
CAP_PROP_OPENNI_CIRCLE_BUFFER 
Python: cv.CAP_PROP_OPENNI_CIRCLE_BUFFER
CAP_PROP_OPENNI_MAX_TIME_DURATION 
Python: cv.CAP_PROP_OPENNI_MAX_TIME_DURATION
CAP_PROP_OPENNI_GENERATOR_PRESENT 
Python: cv.CAP_PROP_OPENNI_GENERATOR_PRESENT
CAP_PROP_OPENNI2_SYNC 
Python: cv.CAP_PROP_OPENNI2_SYNC
CAP_PROP_OPENNI2_MIRROR 
Python: cv.CAP_PROP_OPENNI2_MIRROR

◆ anonymous enum

anonymous enum

#include <opencv2/videoio.hpp>

OpenNI shortcuts.

Enumerator
CAP_OPENNI_IMAGE_GENERATOR_PRESENT 
Python: cv.CAP_OPENNI_IMAGE_GENERATOR_PRESENT
CAP_OPENNI_IMAGE_GENERATOR_OUTPUT_MODE 
Python: cv.CAP_OPENNI_IMAGE_GENERATOR_OUTPUT_MODE
CAP_OPENNI_DEPTH_GENERATOR_PRESENT 
Python: cv.CAP_OPENNI_DEPTH_GENERATOR_PRESENT
CAP_OPENNI_DEPTH_GENERATOR_BASELINE 
Python: cv.CAP_OPENNI_DEPTH_GENERATOR_BASELINE
CAP_OPENNI_DEPTH_GENERATOR_FOCAL_LENGTH 
Python: cv.CAP_OPENNI_DEPTH_GENERATOR_FOCAL_LENGTH
CAP_OPENNI_DEPTH_GENERATOR_REGISTRATION 
Python: cv.CAP_OPENNI_DEPTH_GENERATOR_REGISTRATION
CAP_OPENNI_DEPTH_GENERATOR_REGISTRATION_ON 
Python: cv.CAP_OPENNI_DEPTH_GENERATOR_REGISTRATION_ON
CAP_OPENNI_IR_GENERATOR_PRESENT 
Python: cv.CAP_OPENNI_IR_GENERATOR_PRESENT

◆ anonymous enum

anonymous enum

#include <opencv2/videoio.hpp>

OpenNI data given from depth generator.

Enumerator
CAP_OPENNI_DEPTH_MAP 
Python: cv.CAP_OPENNI_DEPTH_MAP

Depth values in mm (CV_16UC1)

CAP_OPENNI_POINT_CLOUD_MAP 
Python: cv.CAP_OPENNI_POINT_CLOUD_MAP

XYZ in meters (CV_32FC3)

CAP_OPENNI_DISPARITY_MAP 
Python: cv.CAP_OPENNI_DISPARITY_MAP

Disparity in pixels (CV_8UC1)

CAP_OPENNI_DISPARITY_MAP_32F 
Python: cv.CAP_OPENNI_DISPARITY_MAP_32F

Disparity in pixels (CV_32FC1)

CAP_OPENNI_VALID_DEPTH_MASK 
Python: cv.CAP_OPENNI_VALID_DEPTH_MASK

CV_8UC1.

CAP_OPENNI_BGR_IMAGE 
Python: cv.CAP_OPENNI_BGR_IMAGE

Data given from RGB image generator.

CAP_OPENNI_GRAY_IMAGE 
Python: cv.CAP_OPENNI_GRAY_IMAGE

Data given from RGB image generator.

CAP_OPENNI_IR_IMAGE 
Python: cv.CAP_OPENNI_IR_IMAGE

Data given from IR image generator.