Additional flags for video I/O API backends#

Detailed Description#

Hardware acceleration support#

Video Acceleration type. View details

IEEE 1394 drivers#

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. View details

OpenNI (for Kinect)#

enum cv {
    CAP_OPENNI_DEPTH_GENERATOR = 1 << 31,
    CAP_OPENNI_IMAGE_GENERATOR = 1 << 30,
    CAP_OPENNI_IR_GENERATOR = 1 << 29,
    CAP_OPENNI_GENERATORS_MASK = CAP_OPENNI_DEPTH_GENERATOR + CAP_OPENNI_IMAGE_GENERATOR + CAP_OPENNI_IR_GENERATOR
}

OpenNI map generators. View details

Properties of cameras available through OpenNI backend. View details

enum cv {
    CAP_OPENNI_IMAGE_GENERATOR_PRESENT = +CAP_OPENNI_IMAGE_GENERATOR + CAP_PROP_OPENNI_GENERATOR_PRESENT,
    CAP_OPENNI_IMAGE_GENERATOR_OUTPUT_MODE = +CAP_OPENNI_IMAGE_GENERATOR + CAP_PROP_OPENNI_OUTPUT_MODE,
    CAP_OPENNI_DEPTH_GENERATOR_PRESENT = +CAP_OPENNI_DEPTH_GENERATOR + CAP_PROP_OPENNI_GENERATOR_PRESENT,
    CAP_OPENNI_DEPTH_GENERATOR_BASELINE = +CAP_OPENNI_DEPTH_GENERATOR + CAP_PROP_OPENNI_BASELINE,
    CAP_OPENNI_DEPTH_GENERATOR_FOCAL_LENGTH = +CAP_OPENNI_DEPTH_GENERATOR + CAP_PROP_OPENNI_FOCAL_LENGTH,
    CAP_OPENNI_DEPTH_GENERATOR_REGISTRATION = +CAP_OPENNI_DEPTH_GENERATOR + CAP_PROP_OPENNI_REGISTRATION,
    CAP_OPENNI_DEPTH_GENERATOR_REGISTRATION_ON =  CAP_OPENNI_DEPTH_GENERATOR_REGISTRATION,
    CAP_OPENNI_IR_GENERATOR_PRESENT = +CAP_OPENNI_IR_GENERATOR + CAP_PROP_OPENNI_GENERATOR_PRESENT
}

OpenNI shortcuts. View details

OpenNI data given from depth generator. View details

Supported output modes of OpenNI image generator. View details

GStreamer#

View details

PvAPI, Prosilica GigE SDK#

PVAPI. View details

PVAPI: FrameStartTriggerMode. View details

PVAPI: DecimationHorizontal, DecimationVertical. View details

PVAPI: PixelFormat. View details

XIMEA Camera API#

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

Properties of cameras available through XIMEA SDK backend. View details

ARAVIS Camera API#

Properties of cameras available through ARAVIS backend. View details

Android#

Properties of cameras available through NDK Camera API backend. View details

AVFoundation framework for iOS#

Properties of cameras available through AVFOUNDATION backend. View details

Smartek Giganetix GigEVisionSDK#

Properties of cameras available through Smartek Giganetix Ethernet Vision backend. View details

Intel Perceptual Computing SDK#

View details

enum cv {
    CAP_INTELPERC_DEPTH_GENERATOR = 1 << 29,
    CAP_INTELPERC_IMAGE_GENERATOR = 1 << 28,
    CAP_INTELPERC_IR_GENERATOR = 1 << 27,
    CAP_INTELPERC_GENERATORS_MASK = CAP_INTELPERC_DEPTH_GENERATOR + CAP_INTELPERC_IMAGE_GENERATOR + CAP_INTELPERC_IR_GENERATOR
}

Intel Perceptual Streams. View details

View details

gPhoto2 connection#

gPhoto2 properties View details

Images backend#

enum cv {
    CAP_PROP_IMAGES_BASE = 18000,
    CAP_PROP_IMAGES_LAST = 19000
}

Images backend properties. View details

OBSENSOR (for Orbbec 3D-Sensor device/module )#

OBSENSOR data given from image generator. View details

enum cv::VideoCaptureOBSensorGenerators {
    cv::CAP_OBSENSOR_DEPTH_GENERATOR = 1 << 29,
    cv::CAP_OBSENSOR_IMAGE_GENERATOR = 1 << 28,
    cv::CAP_OBSENSOR_IR_GENERATOR = 1 << 27,
    cv::CAP_OBSENSOR_GENERATORS_MASK = CAP_OBSENSOR_DEPTH_GENERATOR + CAP_OBSENSOR_IMAGE_GENERATOR + CAP_OBSENSOR_IR_GENERATOR
}

OBSENSOR stream generator. View details

OBSENSOR properties. View details

Enumeration Type Documentation#

VideoAccelerationType#

enum cv::VideoAccelerationType

#include <opencv2/videoio.hpp>

Video Acceleration type.

Used as value in CAP_PROP_HW_ACCELERATION and VIDEOWRITER_PROP_HW_ACCELERATION

Note

In case of FFmpeg backend, it translated to enum AVHWDeviceType (FFmpeg/FFmpeg)

Enumerator:

VIDEO_ACCELERATION_NONE
Python: cv.VIDEO_ACCELERATION_NONE

Do not require any specific H/W acceleration, prefer software processing. Reading of this value means that special H/W accelerated handling is not added or not detected by OpenCV.

VIDEO_ACCELERATION_ANY
Python: cv.VIDEO_ACCELERATION_ANY

Prefer to use H/W acceleration. If no one supported, then fallback to software processing.

Note

H/W acceleration may require special configuration of used environment.

Results in encoding scenario may differ between software and hardware accelerated encoders.

VIDEO_ACCELERATION_D3D11
Python: cv.VIDEO_ACCELERATION_D3D11

DirectX 11.

VIDEO_ACCELERATION_VAAPI
Python: cv.VIDEO_ACCELERATION_VAAPI

VAAPI.

VIDEO_ACCELERATION_MFX
Python: cv.VIDEO_ACCELERATION_MFX

libmfx (Intel MediaSDK/oneVPL)

VIDEO_ACCELERATION_DRM
Python: cv.VIDEO_ACCELERATION_DRM

Raspberry Pi V4.

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

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

CAP_PROP_DC1394_MODE_MANUAL

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

CAP_PROP_DC1394_MODE_AUTO

CAP_PROP_DC1394_MODE_ONE_PUSH_AUTO

CAP_PROP_DC1394_MAX

enum#

#include <opencv2/videoio.hpp>

OpenNI map generators.

Enumerator:

CAP_OPENNI_DEPTH_GENERATOR

CAP_OPENNI_IMAGE_GENERATOR

CAP_OPENNI_IR_GENERATOR

CAP_OPENNI_GENERATORS_MASK

enum#

#include <opencv2/videoio.hpp>

Properties of cameras available through OpenNI backend.

Enumerator:

CAP_PROP_OPENNI_OUTPUT_MODE

CAP_PROP_OPENNI_FRAME_MAX_DEPTH

In mm.

CAP_PROP_OPENNI_BASELINE

In mm.

CAP_PROP_OPENNI_FOCAL_LENGTH

In pixels.

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

CAP_PROP_OPENNI_APPROX_FRAME_SYNC

CAP_PROP_OPENNI_MAX_BUFFER_SIZE

CAP_PROP_OPENNI_CIRCLE_BUFFER

CAP_PROP_OPENNI_MAX_TIME_DURATION

CAP_PROP_OPENNI_GENERATOR_PRESENT

CAP_PROP_OPENNI2_SYNC

CAP_PROP_OPENNI2_MIRROR

enum#

#include <opencv2/videoio.hpp>

OpenNI shortcuts.

Enumerator:

CAP_OPENNI_IMAGE_GENERATOR_PRESENT

CAP_OPENNI_IMAGE_GENERATOR_OUTPUT_MODE

CAP_OPENNI_DEPTH_GENERATOR_PRESENT

CAP_OPENNI_DEPTH_GENERATOR_BASELINE

CAP_OPENNI_DEPTH_GENERATOR_FOCAL_LENGTH

CAP_OPENNI_DEPTH_GENERATOR_REGISTRATION

CAP_OPENNI_DEPTH_GENERATOR_REGISTRATION_ON

CAP_OPENNI_IR_GENERATOR_PRESENT

enum#

#include <opencv2/videoio.hpp>

OpenNI data given from depth generator.

Enumerator:

CAP_OPENNI_DEPTH_MAP

Depth values in mm (CV_16UC1)

CAP_OPENNI_POINT_CLOUD_MAP

XYZ in meters (CV_32FC3)

CAP_OPENNI_DISPARITY_MAP

Disparity in pixels (CV_8UC1)

CAP_OPENNI_DISPARITY_MAP_32F

Disparity in pixels (CV_32FC1)

CAP_OPENNI_VALID_DEPTH_MASK

CV_8UC1.

CAP_OPENNI_BGR_IMAGE

Data given from RGB image generator.

CAP_OPENNI_GRAY_IMAGE

Data given from RGB image generator.

CAP_OPENNI_IR_IMAGE

Data given from IR image generator.

enum#

#include <opencv2/videoio.hpp>

Supported output modes of OpenNI image generator.

Enumerator:

CAP_OPENNI_VGA_30HZ

CAP_OPENNI_SXGA_15HZ

CAP_OPENNI_SXGA_30HZ

CAP_OPENNI_QVGA_30HZ

CAP_OPENNI_QVGA_60HZ

enum#

#include <opencv2/videoio.hpp>

Enumerator:

CAP_PROP_GSTREAMER_QUEUE_LENGTH

Default is 1.

enum#

#include <opencv2/videoio.hpp>

PVAPI.

Enumerator:

CAP_PROP_PVAPI_MULTICASTIP

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

CAP_PROP_PVAPI_FRAMESTARTTRIGGERMODE

FrameStartTriggerMode: Determines how a frame is initiated.

CAP_PROP_PVAPI_DECIMATIONHORIZONTAL

Horizontal sub-sampling of the image.

CAP_PROP_PVAPI_DECIMATIONVERTICAL

Vertical sub-sampling of the image.

CAP_PROP_PVAPI_BINNINGX

Horizontal binning factor.

CAP_PROP_PVAPI_BINNINGY

Vertical binning factor.

CAP_PROP_PVAPI_PIXELFORMAT

Pixel format.

enum#

#include <opencv2/videoio.hpp>

PVAPI: FrameStartTriggerMode.

Enumerator:

CAP_PVAPI_FSTRIGMODE_FREERUN

Freerun.

CAP_PVAPI_FSTRIGMODE_SYNCIN1

SyncIn1.

CAP_PVAPI_FSTRIGMODE_SYNCIN2

SyncIn2.

CAP_PVAPI_FSTRIGMODE_FIXEDRATE

FixedRate.

CAP_PVAPI_FSTRIGMODE_SOFTWARE

Software.

enum#

#include <opencv2/videoio.hpp>

PVAPI: DecimationHorizontal, DecimationVertical.

Enumerator:

CAP_PVAPI_DECIMATION_OFF

Off.

CAP_PVAPI_DECIMATION_2OUTOF4

2 out of 4 decimation

CAP_PVAPI_DECIMATION_2OUTOF8

2 out of 8 decimation

CAP_PVAPI_DECIMATION_2OUTOF16

2 out of 16 decimation

enum#

#include <opencv2/videoio.hpp>

PVAPI: PixelFormat.

Enumerator:

CAP_PVAPI_PIXELFORMAT_MONO8

Mono8.

CAP_PVAPI_PIXELFORMAT_MONO16

Mono16.

CAP_PVAPI_PIXELFORMAT_BAYER8

Bayer8.

CAP_PVAPI_PIXELFORMAT_BAYER16

Bayer16.

CAP_PVAPI_PIXELFORMAT_RGB24

Rgb24.

CAP_PVAPI_PIXELFORMAT_BGR24

Bgr24.

CAP_PVAPI_PIXELFORMAT_RGBA32

Rgba32.

CAP_PVAPI_PIXELFORMAT_BGRA32

Bgra32.

enum#

#include <opencv2/videoio.hpp>

Properties of cameras available through XIMEA SDK backend.

Enumerator:

CAP_PROP_XI_DOWNSAMPLING

Change image resolution by binning or skipping.

CAP_PROP_XI_DATA_FORMAT

Output data format.

CAP_PROP_XI_OFFSET_X

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

CAP_PROP_XI_OFFSET_Y

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

CAP_PROP_XI_TRG_SOURCE

Defines source of trigger.

CAP_PROP_XI_TRG_SOFTWARE

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

CAP_PROP_XI_GPI_SELECTOR

Selects general purpose input.

CAP_PROP_XI_GPI_MODE

Set general purpose input mode.

CAP_PROP_XI_GPI_LEVEL

Get general purpose level.

CAP_PROP_XI_GPO_SELECTOR

Selects general purpose output.

CAP_PROP_XI_GPO_MODE

Set general purpose output mode.

CAP_PROP_XI_LED_SELECTOR

Selects camera signalling LED.

CAP_PROP_XI_LED_MODE

Define camera signalling LED functionality.

CAP_PROP_XI_MANUAL_WB

Calculates White Balance(must be called during acquisition).

CAP_PROP_XI_AUTO_WB

Automatic white balance.

CAP_PROP_XI_AEAG

Automatic exposure/gain.

CAP_PROP_XI_EXP_PRIORITY

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

CAP_PROP_XI_AE_MAX_LIMIT

Maximum limit of exposure in AEAG procedure.

CAP_PROP_XI_AG_MAX_LIMIT

Maximum limit of gain in AEAG procedure.

CAP_PROP_XI_AEAG_LEVEL

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

CAP_PROP_XI_TIMEOUT

Image capture timeout in milliseconds.

CAP_PROP_XI_EXPOSURE

Exposure time in microseconds.

CAP_PROP_XI_EXPOSURE_BURST_COUNT

Sets the number of times of exposure in one frame.

CAP_PROP_XI_GAIN_SELECTOR

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

CAP_PROP_XI_GAIN

Gain in dB.

CAP_PROP_XI_DOWNSAMPLING_TYPE

Change image downsampling type.

CAP_PROP_XI_BINNING_SELECTOR

Binning engine selector.

CAP_PROP_XI_BINNING_VERTICAL

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

CAP_PROP_XI_BINNING_HORIZONTAL

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

CAP_PROP_XI_BINNING_PATTERN

Binning pattern type.

CAP_PROP_XI_DECIMATION_SELECTOR

Decimation engine selector.

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

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

Decimation pattern type.

CAP_PROP_XI_TEST_PATTERN_GENERATOR_SELECTOR

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

CAP_PROP_XI_TEST_PATTERN

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

CAP_PROP_XI_IMAGE_DATA_FORMAT

Output data format.

CAP_PROP_XI_SHUTTER_TYPE

Change sensor shutter type(CMOS sensor).

CAP_PROP_XI_SENSOR_TAPS

Number of taps.

CAP_PROP_XI_AEAG_ROI_OFFSET_X

Automatic exposure/gain ROI offset X.

CAP_PROP_XI_AEAG_ROI_OFFSET_Y

Automatic exposure/gain ROI offset Y.

CAP_PROP_XI_AEAG_ROI_WIDTH

Automatic exposure/gain ROI Width.

CAP_PROP_XI_AEAG_ROI_HEIGHT

Automatic exposure/gain ROI Height.

CAP_PROP_XI_BPC

Correction of bad pixels.

CAP_PROP_XI_WB_KR

White balance red coefficient.

CAP_PROP_XI_WB_KG

White balance green coefficient.

CAP_PROP_XI_WB_KB

White balance blue coefficient.

CAP_PROP_XI_WIDTH

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

CAP_PROP_XI_HEIGHT

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

CAP_PROP_XI_REGION_SELECTOR

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

CAP_PROP_XI_REGION_MODE

Activates/deactivates Region selected by Region Selector.

CAP_PROP_XI_LIMIT_BANDWIDTH

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

CAP_PROP_XI_SENSOR_DATA_BIT_DEPTH

Sensor output data bit depth.

CAP_PROP_XI_OUTPUT_DATA_BIT_DEPTH

Device output data bit depth.

CAP_PROP_XI_IMAGE_DATA_BIT_DEPTH

bitdepth of data returned by function xiGetImage.

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

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

CAP_PROP_XI_IS_COOLED

Returns 1 for cameras that support cooling.

CAP_PROP_XI_COOLING

Start camera cooling.

CAP_PROP_XI_TARGET_TEMP

Set sensor target temperature for cooling.

CAP_PROP_XI_CHIP_TEMP

Camera sensor temperature.

CAP_PROP_XI_HOUS_TEMP

Camera housing temperature.

CAP_PROP_XI_HOUS_BACK_SIDE_TEMP

Camera housing back side temperature.

CAP_PROP_XI_SENSOR_BOARD_TEMP

Camera sensor board temperature.

CAP_PROP_XI_CMS

Mode of color management system.

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

Returns 1 for color cameras.

CAP_PROP_XI_COLOR_FILTER_ARRAY

Returns color filter array type of RAW data.

CAP_PROP_XI_GAMMAY

Luminosity gamma.

CAP_PROP_XI_GAMMAC

Chromaticity gamma.

CAP_PROP_XI_SHARPNESS

Sharpness Strength.

CAP_PROP_XI_CC_MATRIX_00

Color Correction Matrix element [0][0].

CAP_PROP_XI_CC_MATRIX_01

Color Correction Matrix element [0][1].

CAP_PROP_XI_CC_MATRIX_02

Color Correction Matrix element [0][2].

CAP_PROP_XI_CC_MATRIX_03

Color Correction Matrix element [0][3].

CAP_PROP_XI_CC_MATRIX_10

Color Correction Matrix element [1][0].

CAP_PROP_XI_CC_MATRIX_11

Color Correction Matrix element [1][1].

CAP_PROP_XI_CC_MATRIX_12

Color Correction Matrix element [1][2].

CAP_PROP_XI_CC_MATRIX_13

Color Correction Matrix element [1][3].

CAP_PROP_XI_CC_MATRIX_20

Color Correction Matrix element [2][0].

CAP_PROP_XI_CC_MATRIX_21

Color Correction Matrix element [2][1].

CAP_PROP_XI_CC_MATRIX_22

Color Correction Matrix element [2][2].

CAP_PROP_XI_CC_MATRIX_23

Color Correction Matrix element [2][3].

CAP_PROP_XI_CC_MATRIX_30

Color Correction Matrix element [3][0].

CAP_PROP_XI_CC_MATRIX_31

Color Correction Matrix element [3][1].

CAP_PROP_XI_CC_MATRIX_32

Color Correction Matrix element [3][2].

CAP_PROP_XI_CC_MATRIX_33

Color Correction Matrix element [3][3].

CAP_PROP_XI_DEFAULT_CC_MATRIX

Set default Color Correction Matrix.

CAP_PROP_XI_TRG_SELECTOR

Selects the type of trigger.

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

Enable/Disable debounce to selected GPI.

CAP_PROP_XI_DEBOUNCE_T0

Debounce time (x * 10us).

CAP_PROP_XI_DEBOUNCE_T1

Debounce time (x * 10us).

CAP_PROP_XI_DEBOUNCE_POL

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

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

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

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

Moves lens focus motor by steps set in XI_PRM_LENS_FOCUS_MOVEMENT_VALUE.

CAP_PROP_XI_LENS_FOCUS_DISTANCE

Lens focus distance in cm.

CAP_PROP_XI_LENS_FOCAL_LENGTH

Lens focal distance in mm.

CAP_PROP_XI_LENS_FEATURE_SELECTOR

Selects the current feature which is accessible by XI_PRM_LENS_FEATURE.

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

Returns device model id.

CAP_PROP_XI_DEVICE_SN

Returns device serial number.

CAP_PROP_XI_IMAGE_DATA_FORMAT_RGB32_ALPHA

The alpha channel of RGB32 output image format.

CAP_PROP_XI_IMAGE_PAYLOAD_SIZE

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

CAP_PROP_XI_TRANSPORT_PIXEL_FORMAT

Current format of pixels on transport layer.

CAP_PROP_XI_SENSOR_CLOCK_FREQ_HZ

Sensor clock frequency in Hz.

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

Number of output channels from sensor used for data transfer.

CAP_PROP_XI_FRAMERATE

Define framerate in Hz.

CAP_PROP_XI_COUNTER_SELECTOR

Select counter.

CAP_PROP_XI_COUNTER_VALUE

Counter status.

CAP_PROP_XI_ACQ_TIMING_MODE

Type of sensor frames timing.

CAP_PROP_XI_AVAILABLE_BANDWIDTH

Calculate and returns available interface bandwidth(int Megabits).

CAP_PROP_XI_BUFFER_POLICY

Data move policy.

CAP_PROP_XI_LUT_EN

Activates LUT.

CAP_PROP_XI_LUT_INDEX

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

CAP_PROP_XI_LUT_VALUE

Value at entry LUTIndex of the LUT.

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

Defines how time stamp reset engine will be armed.

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

Returns 1 if camera connected and works properly.

CAP_PROP_XI_ACQ_BUFFER_SIZE

Acquisition buffer size in buffer_size_unit. Default bytes.

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

Acquisition transport buffer size in bytes.

CAP_PROP_XI_BUFFERS_QUEUE_SIZE

Queue of field/frame buffers.

CAP_PROP_XI_ACQ_TRANSPORT_BUFFER_COMMIT

Number of buffers to commit to low level.

CAP_PROP_XI_RECENT_FRAME

GetImage returns most recent frame.

CAP_PROP_XI_DEVICE_RESET

Resets the camera to default state.

CAP_PROP_XI_COLUMN_FPN_CORRECTION

Correction of column FPN.

CAP_PROP_XI_ROW_FPN_CORRECTION

Correction of row FPN.

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

Enable High Dynamic Range feature.

CAP_PROP_XI_HDR_KNEEPOINT_COUNT

The number of kneepoints in the PWLR.

CAP_PROP_XI_HDR_T1

Position of first kneepoint(in % of XI_PRM_EXPOSURE).

CAP_PROP_XI_HDR_T2

Position of second kneepoint (in % of XI_PRM_EXPOSURE).

CAP_PROP_XI_KNEEPOINT1

Value of first kneepoint (% of sensor saturation).

CAP_PROP_XI_KNEEPOINT2

Value of second kneepoint (% of sensor saturation).

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

Returns hardware revision number.

CAP_PROP_XI_DEBUG_LEVEL

Set debug level.

CAP_PROP_XI_AUTO_BANDWIDTH_CALCULATION

Automatic bandwidth calculation.

CAP_PROP_XI_FFS_FILE_ID

File number.

CAP_PROP_XI_FFS_FILE_SIZE

Size of file.

CAP_PROP_XI_FREE_FFS_SIZE

Size of free camera FFS.

CAP_PROP_XI_USED_FFS_SIZE

Size of used camera FFS.

CAP_PROP_XI_FFS_ACCESS_KEY

Setting of key enables file operations on some cameras.

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

Allows access to sensor feature value currently selected by XI_PRM_SENSOR_FEATURE_SELECTOR.

enum#

#include <opencv2/videoio.hpp>

Properties of cameras available through ARAVIS backend.

Enumerator:

CAP_PROP_ARAVIS_AUTOTRIGGER

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

enum#

#include <opencv2/videoio.hpp>

Properties of cameras available through NDK Camera API backend.

Enumerator:

CAP_PROP_ANDROID_DEVICE_TORCH

enum#

#include <opencv2/videoio.hpp>

Properties of cameras available through AVFOUNDATION backend.

Enumerator:

CAP_PROP_IOS_DEVICE_FOCUS

CAP_PROP_IOS_DEVICE_EXPOSURE

CAP_PROP_IOS_DEVICE_FLASH

CAP_PROP_IOS_DEVICE_WHITEBALANCE

CAP_PROP_IOS_DEVICE_TORCH

enum#

#include <opencv2/videoio.hpp>

Properties of cameras available through Smartek Giganetix Ethernet Vision backend.

Enumerator:

CAP_PROP_GIGA_FRAME_OFFSET_X

CAP_PROP_GIGA_FRAME_OFFSET_Y

CAP_PROP_GIGA_FRAME_WIDTH_MAX

CAP_PROP_GIGA_FRAME_HEIGHT_MAX

CAP_PROP_GIGA_FRAME_HEIGH_MAX

CAP_PROP_GIGA_FRAME_SENS_WIDTH

CAP_PROP_GIGA_FRAME_SENS_HEIGHT

CAP_PROP_GIGA_FRAME_SENS_HEIGH

enum#

#include <opencv2/videoio.hpp>

Enumerator:

CAP_PROP_INTELPERC_PROFILE_COUNT

CAP_PROP_INTELPERC_PROFILE_IDX

CAP_PROP_INTELPERC_DEPTH_LOW_CONFIDENCE_VALUE

CAP_PROP_INTELPERC_DEPTH_SATURATION_VALUE

CAP_PROP_INTELPERC_DEPTH_CONFIDENCE_THRESHOLD

CAP_PROP_INTELPERC_DEPTH_FOCAL_LENGTH_HORZ

CAP_PROP_INTELPERC_DEPTH_FOCAL_LENGTH_VERT

enum#

#include <opencv2/videoio.hpp>

Intel Perceptual Streams.

Enumerator:

CAP_INTELPERC_DEPTH_GENERATOR

CAP_INTELPERC_IMAGE_GENERATOR

CAP_INTELPERC_IR_GENERATOR

CAP_INTELPERC_GENERATORS_MASK

enum#

#include <opencv2/videoio.hpp>

Enumerator:

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

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

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

CAP_INTELPERC_IMAGE

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

Capture only preview from liveview mode.

CAP_PROP_GPHOTO2_WIDGET_ENUMERATE

Readonly, returns (const char *).

CAP_PROP_GPHOTO2_RELOAD_CONFIG

Trigger, only by set. Reload camera settings.

CAP_PROP_GPHOTO2_RELOAD_ON_CHANGE

Reload all settings on set.

CAP_PROP_GPHOTO2_COLLECT_MSGS

Collect messages with details.

CAP_PROP_GPHOTO2_FLUSH_MSGS

Readonly, returns (const char *).

CAP_PROP_SPEED

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

CAP_PROP_APERTURE

Aperture. Can be readonly, depends on camera program.

CAP_PROP_EXPOSUREPROGRAM

Camera exposure program.

CAP_PROP_VIEWFINDER

Enter liveview mode.

enum#

#include <opencv2/videoio.hpp>

Images backend properties.

Enumerator:

CAP_PROP_IMAGES_BASE

CAP_PROP_IMAGES_LAST

VideoCaptureOBSensorDataType#

enum cv::VideoCaptureOBSensorDataType

#include <opencv2/videoio.hpp>

OBSENSOR data given from image generator.

Enumerator:

CAP_OBSENSOR_DEPTH_MAP
Python: cv.CAP_OBSENSOR_DEPTH_MAP

Depth values in mm (CV_16UC1)

CAP_OBSENSOR_BGR_IMAGE
Python: cv.CAP_OBSENSOR_BGR_IMAGE

Data given from BGR stream generator.

CAP_OBSENSOR_IR_IMAGE
Python: cv.CAP_OBSENSOR_IR_IMAGE

Data given from IR stream generator(CV_16UC1)

VideoCaptureOBSensorGenerators#

enum cv::VideoCaptureOBSensorGenerators

#include <opencv2/videoio.hpp>

OBSENSOR stream generator.

Enumerator:

CAP_OBSENSOR_DEPTH_GENERATOR
Python: cv.CAP_OBSENSOR_DEPTH_GENERATOR

CAP_OBSENSOR_IMAGE_GENERATOR
Python: cv.CAP_OBSENSOR_IMAGE_GENERATOR

CAP_OBSENSOR_IR_GENERATOR
Python: cv.CAP_OBSENSOR_IR_GENERATOR

CAP_OBSENSOR_GENERATORS_MASK
Python: cv.CAP_OBSENSOR_GENERATORS_MASK

VideoCaptureOBSensorProperties#

enum cv::VideoCaptureOBSensorProperties

#include <opencv2/videoio.hpp>

OBSENSOR properties.

Enumerator:

CAP_PROP_OBSENSOR_INTRINSIC_FX
Python: cv.CAP_PROP_OBSENSOR_INTRINSIC_FX

CAP_PROP_OBSENSOR_INTRINSIC_FY
Python: cv.CAP_PROP_OBSENSOR_INTRINSIC_FY

CAP_PROP_OBSENSOR_INTRINSIC_CX
Python: cv.CAP_PROP_OBSENSOR_INTRINSIC_CX

CAP_PROP_OBSENSOR_INTRINSIC_CY
Python: cv.CAP_PROP_OBSENSOR_INTRINSIC_CY

CAP_PROP_OBSENSOR_RGB_POS_MSEC
Python: cv.CAP_PROP_OBSENSOR_RGB_POS_MSEC

CAP_PROP_OBSENSOR_DEPTH_POS_MSEC
Python: cv.CAP_PROP_OBSENSOR_DEPTH_POS_MSEC

CAP_PROP_OBSENSOR_DEPTH_WIDTH
Python: cv.CAP_PROP_OBSENSOR_DEPTH_WIDTH

CAP_PROP_OBSENSOR_DEPTH_HEIGHT
Python: cv.CAP_PROP_OBSENSOR_DEPTH_HEIGHT

CAP_PROP_OBSENSOR_DEPTH_FPS
Python: cv.CAP_PROP_OBSENSOR_DEPTH_FPS

CAP_PROP_OBSENSOR_COLOR_DISTORTION_K1
Python: cv.CAP_PROP_OBSENSOR_COLOR_DISTORTION_K1

CAP_PROP_OBSENSOR_COLOR_DISTORTION_K2
Python: cv.CAP_PROP_OBSENSOR_COLOR_DISTORTION_K2

CAP_PROP_OBSENSOR_COLOR_DISTORTION_K3
Python: cv.CAP_PROP_OBSENSOR_COLOR_DISTORTION_K3

CAP_PROP_OBSENSOR_COLOR_DISTORTION_K4
Python: cv.CAP_PROP_OBSENSOR_COLOR_DISTORTION_K4

CAP_PROP_OBSENSOR_COLOR_DISTORTION_K5
Python: cv.CAP_PROP_OBSENSOR_COLOR_DISTORTION_K5

CAP_PROP_OBSENSOR_COLOR_DISTORTION_K6
Python: cv.CAP_PROP_OBSENSOR_COLOR_DISTORTION_K6

CAP_PROP_OBSENSOR_COLOR_DISTORTION_P1
Python: cv.CAP_PROP_OBSENSOR_COLOR_DISTORTION_P1

CAP_PROP_OBSENSOR_COLOR_DISTORTION_P2
Python: cv.CAP_PROP_OBSENSOR_COLOR_DISTORTION_P2