OpenCV  3.4.20-dev
Open Source Computer Vision
Macros | Typedefs | Enumerations | Functions
C API for video I/O

Macros

#define CV_FOURCC_DEFAULT   CV_FOURCC('I', 'Y', 'U', 'V')
 (Linux only) Use default codec for specified filename More...
 
#define CV_FOURCC_MACRO(c1, c2, c3, c4)   (((c1) & 255) + (((c2) & 255) << 8) + (((c3) & 255) << 16) + (((c4) & 255) << 24))
 Macro to construct the fourcc code of the codec. Same as CV_FOURCC() More...
 
#define CV_FOURCC_PROMPT   -1
 (Windows only) Open Codec Selection Dialog More...
 

Typedefs

typedef struct CvCapture CvCapture
 "black box" capture structure More...
 
typedef struct CvVideoWriter CvVideoWriter
 "black box" video file writer structure More...
 

Enumerations

enum  {
  CV_CAP_ANY =0,
  CV_CAP_MIL =100,
  CV_CAP_VFW =200,
  CV_CAP_V4L =200,
  CV_CAP_V4L2 =200,
  CV_CAP_FIREWARE =300,
  CV_CAP_FIREWIRE =300,
  CV_CAP_IEEE1394 =300,
  CV_CAP_DC1394 =300,
  CV_CAP_CMU1394 =300,
  CV_CAP_STEREO =400,
  CV_CAP_TYZX =400,
  CV_TYZX_LEFT =400,
  CV_TYZX_RIGHT =401,
  CV_TYZX_COLOR =402,
  CV_TYZX_Z =403,
  CV_CAP_QT =500,
  CV_CAP_UNICAP =600,
  CV_CAP_DSHOW =700,
  CV_CAP_MSMF =1400,
  CV_CAP_PVAPI =800,
  CV_CAP_OPENNI =900,
  CV_CAP_OPENNI_ASUS =910,
  CV_CAP_ANDROID =1000,
  CV_CAP_ANDROID_BACK =CV_CAP_ANDROID+99,
  CV_CAP_ANDROID_FRONT =CV_CAP_ANDROID+98,
  CV_CAP_XIAPI =1100,
  CV_CAP_AVFOUNDATION = 1200,
  CV_CAP_GIGANETIX = 1300,
  CV_CAP_INTELPERC = 1500,
  CV_CAP_OPENNI2 = 1600,
  CV_CAP_GPHOTO2 = 1700,
  CV_CAP_GSTREAMER = 1800,
  CV_CAP_FFMPEG = 1900,
  CV_CAP_IMAGES = 2000,
  CV_CAP_ARAVIS = 2100
}
 
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_POS_MSEC =0,
  CV_CAP_PROP_POS_FRAMES =1,
  CV_CAP_PROP_POS_AVI_RATIO =2,
  CV_CAP_PROP_FRAME_WIDTH =3,
  CV_CAP_PROP_FRAME_HEIGHT =4,
  CV_CAP_PROP_FPS =5,
  CV_CAP_PROP_FOURCC =6,
  CV_CAP_PROP_FRAME_COUNT =7,
  CV_CAP_PROP_FORMAT =8,
  CV_CAP_PROP_MODE =9,
  CV_CAP_PROP_BRIGHTNESS =10,
  CV_CAP_PROP_CONTRAST =11,
  CV_CAP_PROP_SATURATION =12,
  CV_CAP_PROP_HUE =13,
  CV_CAP_PROP_GAIN =14,
  CV_CAP_PROP_EXPOSURE =15,
  CV_CAP_PROP_CONVERT_RGB =16,
  CV_CAP_PROP_WHITE_BALANCE_BLUE_U =17,
  CV_CAP_PROP_RECTIFICATION =18,
  CV_CAP_PROP_MONOCHROME =19,
  CV_CAP_PROP_SHARPNESS =20,
  CV_CAP_PROP_AUTO_EXPOSURE =21,
  CV_CAP_PROP_GAMMA =22,
  CV_CAP_PROP_TEMPERATURE =23,
  CV_CAP_PROP_TRIGGER =24,
  CV_CAP_PROP_TRIGGER_DELAY =25,
  CV_CAP_PROP_WHITE_BALANCE_RED_V =26,
  CV_CAP_PROP_ZOOM =27,
  CV_CAP_PROP_FOCUS =28,
  CV_CAP_PROP_GUID =29,
  CV_CAP_PROP_ISO_SPEED =30,
  CV_CAP_PROP_MAX_DC1394 =31,
  CV_CAP_PROP_BACKLIGHT =32,
  CV_CAP_PROP_PAN =33,
  CV_CAP_PROP_TILT =34,
  CV_CAP_PROP_ROLL =35,
  CV_CAP_PROP_IRIS =36,
  CV_CAP_PROP_SETTINGS =37,
  CV_CAP_PROP_BUFFERSIZE =38,
  CV_CAP_PROP_AUTOFOCUS =39,
  CV_CAP_PROP_SAR_NUM =40,
  CV_CAP_PROP_SAR_DEN =41,
  CV_CAP_PROP_AUTOGRAB =1024,
  CV_CAP_PROP_SUPPORTED_PREVIEW_SIZES_STRING =1025,
  CV_CAP_PROP_PREVIEW_FORMAT =1026,
  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 = CV_CAP_OPENNI_DEPTH_GENERATOR + CV_CAP_OPENNI_IMAGE_GENERATOR + CV_CAP_OPENNI_IR_GENERATOR,
  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 = CV_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,
  CV_CAP_OPENNI_IMAGE_GENERATOR_PRESENT = CV_CAP_OPENNI_IMAGE_GENERATOR + CV_CAP_PROP_OPENNI_GENERATOR_PRESENT,
  CV_CAP_OPENNI_IMAGE_GENERATOR_OUTPUT_MODE = CV_CAP_OPENNI_IMAGE_GENERATOR + CV_CAP_PROP_OPENNI_OUTPUT_MODE,
  CV_CAP_OPENNI_DEPTH_GENERATOR_PRESENT = CV_CAP_OPENNI_DEPTH_GENERATOR + CV_CAP_PROP_OPENNI_GENERATOR_PRESENT,
  CV_CAP_OPENNI_DEPTH_GENERATOR_BASELINE = CV_CAP_OPENNI_DEPTH_GENERATOR + CV_CAP_PROP_OPENNI_BASELINE,
  CV_CAP_OPENNI_DEPTH_GENERATOR_FOCAL_LENGTH = CV_CAP_OPENNI_DEPTH_GENERATOR + CV_CAP_PROP_OPENNI_FOCAL_LENGTH,
  CV_CAP_OPENNI_DEPTH_GENERATOR_REGISTRATION = CV_CAP_OPENNI_DEPTH_GENERATOR + CV_CAP_PROP_OPENNI_REGISTRATION,
  CV_CAP_OPENNI_DEPTH_GENERATOR_REGISTRATION_ON = CV_CAP_OPENNI_DEPTH_GENERATOR_REGISTRATION,
  CV_CAP_OPENNI_IR_GENERATOR_PRESENT = CV_CAP_OPENNI_IR_GENERATOR + CV_CAP_PROP_OPENNI_GENERATOR_PRESENT,
  CV_CAP_GSTREAMER_QUEUE_LENGTH = 200,
  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,
  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,
  CV_CAP_PROP_ANDROID_FLASH_MODE = 8001,
  CV_CAP_PROP_ANDROID_FOCUS_MODE = 8002,
  CV_CAP_PROP_ANDROID_WHITE_BALANCE = 8003,
  CV_CAP_PROP_ANDROID_ANTIBANDING = 8004,
  CV_CAP_PROP_ANDROID_FOCAL_LENGTH = 8005,
  CV_CAP_PROP_ANDROID_FOCUS_DISTANCE_NEAR = 8006,
  CV_CAP_PROP_ANDROID_FOCUS_DISTANCE_OPTIMAL = 8007,
  CV_CAP_PROP_ANDROID_FOCUS_DISTANCE_FAR = 8008,
  CV_CAP_PROP_ANDROID_EXPOSE_LOCK = 8009,
  CV_CAP_PROP_ANDROID_WHITEBALANCE_LOCK = 8010,
  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,
  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,
  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,
  CV_CAP_INTELPERC_DEPTH_GENERATOR = 1 << 29,
  CV_CAP_INTELPERC_IMAGE_GENERATOR = 1 << 28,
  CV_CAP_INTELPERC_GENERATORS_MASK = CV_CAP_INTELPERC_DEPTH_GENERATOR + CV_CAP_INTELPERC_IMAGE_GENERATOR
}
 
enum  {
  CV_CAP_MODE_BGR = 0,
  CV_CAP_MODE_RGB = 1,
  CV_CAP_MODE_GRAY = 2,
  CV_CAP_MODE_YUYV = 3
}
 
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
}
 
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
}
 
enum  {
  CV_CAP_INTELPERC_DEPTH_MAP = 0,
  CV_CAP_INTELPERC_UVDEPTH_MAP = 1,
  CV_CAP_INTELPERC_IR_MAP = 2,
  CV_CAP_INTELPERC_IMAGE = 3
}
 
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
}
 

Functions

int CV_FOURCC (char c1, char c2, char c3, char c4)
 Constructs the fourcc code of the codec function. More...
 
CvCapturecvCreateCameraCapture (int index)
 start capturing frames from camera: index = camera_index + domain_offset (CV_CAP_*) More...
 
CvCapturecvCreateFileCapture (const char *filename)
 start capturing frames from video file More...
 
CvCapturecvCreateFileCaptureWithPreference (const char *filename, int apiPreference)
 start capturing frames from video file. allows specifying a preferred API to use More...
 
CvVideoWritercvCreateVideoWriter (const char *filename, int fourcc, double fps, CvSize frame_size, int is_color=1)
 initialize video file writer More...
 
int cvGetCaptureDomain (CvCapture *capture)
 Return the type of the capturer (eg, CV_CAP_VFW, CV_CAP_UNICAP) More...
 
double cvGetCaptureProperty (CvCapture *capture, int property_id)
 retrieve capture properties More...
 
int cvGrabFrame (CvCapture *capture)
 grab a frame, return 1 on success, 0 on fail. More...
 
IplImagecvQueryFrame (CvCapture *capture)
 Just a combination of cvGrabFrame and cvRetrieveFrame. More...
 
void cvReleaseCapture (CvCapture **capture)
 stop capturing/reading and free resources More...
 
void cvReleaseVideoWriter (CvVideoWriter **writer)
 close video file writer More...
 
IplImagecvRetrieveFrame (CvCapture *capture, int streamIdx=0)
 get the frame grabbed with cvGrabFrame(..) More...
 
int cvSetCaptureProperty (CvCapture *capture, int property_id, double value)
 set capture properties More...
 
int cvWriteFrame (CvVideoWriter *writer, const IplImage *image)
 write frame to video file More...
 

Obsolete functions/synonyms

#define cvCaptureFromCAM   cvCreateCameraCapture
 
#define cvCaptureFromFile   cvCreateFileCapture
 
#define cvCaptureFromAVI   cvCaptureFromFile
 
#define cvCreateAVIWriter   cvCreateVideoWriter
 
#define cvWriteToAVI   cvWriteFrame
 

Detailed Description

Macro Definition Documentation

◆ CV_FOURCC_DEFAULT

#define CV_FOURCC_DEFAULT   CV_FOURCC('I', 'Y', 'U', 'V')

#include <opencv2/videoio/videoio_c.h>

(Linux only) Use default codec for specified filename

◆ CV_FOURCC_MACRO

#define CV_FOURCC_MACRO (   c1,
  c2,
  c3,
  c4 
)    (((c1) & 255) + (((c2) & 255) << 8) + (((c3) & 255) << 16) + (((c4) & 255) << 24))

#include <opencv2/videoio/videoio_c.h>

Macro to construct the fourcc code of the codec. Same as CV_FOURCC()

◆ CV_FOURCC_PROMPT

#define CV_FOURCC_PROMPT   -1

#include <opencv2/videoio/videoio_c.h>

(Windows only) Open Codec Selection Dialog

◆ cvCaptureFromAVI

#define cvCaptureFromAVI   cvCaptureFromFile

◆ cvCaptureFromCAM

#define cvCaptureFromCAM   cvCreateCameraCapture

◆ cvCaptureFromFile

#define cvCaptureFromFile   cvCreateFileCapture

◆ cvCreateAVIWriter

#define cvCreateAVIWriter   cvCreateVideoWriter

◆ cvWriteToAVI

#define cvWriteToAVI   cvWriteFrame

Typedef Documentation

◆ CvCapture

typedef struct CvCapture CvCapture

#include <opencv2/videoio/videoio_c.h>

"black box" capture structure

In C++ use cv::VideoCapture

◆ CvVideoWriter

typedef struct CvVideoWriter CvVideoWriter

#include <opencv2/videoio/videoio_c.h>

"black box" video file writer structure

In C++ use cv::VideoWriter

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

#include <opencv2/videoio/videoio_c.h>

Enumerator
CV_CAP_ANY 
CV_CAP_MIL 
CV_CAP_VFW 
CV_CAP_V4L 
CV_CAP_V4L2 
CV_CAP_FIREWARE 
CV_CAP_FIREWIRE 
CV_CAP_IEEE1394 
CV_CAP_DC1394 
CV_CAP_CMU1394 
CV_CAP_STEREO 
CV_CAP_TYZX 
CV_TYZX_LEFT 
CV_TYZX_RIGHT 
CV_TYZX_COLOR 
CV_TYZX_Z 
CV_CAP_QT 
CV_CAP_UNICAP 
CV_CAP_DSHOW 
CV_CAP_MSMF 
CV_CAP_PVAPI 
CV_CAP_OPENNI 
CV_CAP_OPENNI_ASUS 
CV_CAP_ANDROID 
CV_CAP_ANDROID_BACK 
CV_CAP_ANDROID_FRONT 
CV_CAP_XIAPI 
CV_CAP_AVFOUNDATION 
CV_CAP_GIGANETIX 
CV_CAP_INTELPERC 
CV_CAP_OPENNI2 
CV_CAP_GPHOTO2 
CV_CAP_GSTREAMER 
CV_CAP_FFMPEG 
CV_CAP_IMAGES 
CV_CAP_ARAVIS 

◆ anonymous enum

anonymous enum

#include <opencv2/videoio/videoio_c.h>

Enumerator
CV_CAP_PROP_DC1394_OFF 
CV_CAP_PROP_DC1394_MODE_MANUAL 
CV_CAP_PROP_DC1394_MODE_AUTO 
CV_CAP_PROP_DC1394_MODE_ONE_PUSH_AUTO 
CV_CAP_PROP_POS_MSEC 
CV_CAP_PROP_POS_FRAMES 
CV_CAP_PROP_POS_AVI_RATIO 
CV_CAP_PROP_FRAME_WIDTH 
CV_CAP_PROP_FRAME_HEIGHT 
CV_CAP_PROP_FPS 
CV_CAP_PROP_FOURCC 
CV_CAP_PROP_FRAME_COUNT 
CV_CAP_PROP_FORMAT 
CV_CAP_PROP_MODE 
CV_CAP_PROP_BRIGHTNESS 
CV_CAP_PROP_CONTRAST 
CV_CAP_PROP_SATURATION 
CV_CAP_PROP_HUE 
CV_CAP_PROP_GAIN 
CV_CAP_PROP_EXPOSURE 
CV_CAP_PROP_CONVERT_RGB 
CV_CAP_PROP_WHITE_BALANCE_BLUE_U 
CV_CAP_PROP_RECTIFICATION 
CV_CAP_PROP_MONOCHROME 
CV_CAP_PROP_SHARPNESS 
CV_CAP_PROP_AUTO_EXPOSURE 
CV_CAP_PROP_GAMMA 
CV_CAP_PROP_TEMPERATURE 
CV_CAP_PROP_TRIGGER 
CV_CAP_PROP_TRIGGER_DELAY 
CV_CAP_PROP_WHITE_BALANCE_RED_V 
CV_CAP_PROP_ZOOM 
CV_CAP_PROP_FOCUS 
CV_CAP_PROP_GUID 
CV_CAP_PROP_ISO_SPEED 
CV_CAP_PROP_MAX_DC1394 
CV_CAP_PROP_BACKLIGHT 
CV_CAP_PROP_PAN 
CV_CAP_PROP_TILT 
CV_CAP_PROP_ROLL 
CV_CAP_PROP_IRIS 
CV_CAP_PROP_SETTINGS 
CV_CAP_PROP_BUFFERSIZE 
CV_CAP_PROP_AUTOFOCUS 
CV_CAP_PROP_SAR_NUM 
CV_CAP_PROP_SAR_DEN 
CV_CAP_PROP_AUTOGRAB 
CV_CAP_PROP_SUPPORTED_PREVIEW_SIZES_STRING 
CV_CAP_PROP_PREVIEW_FORMAT 
CV_CAP_OPENNI_DEPTH_GENERATOR 
CV_CAP_OPENNI_IMAGE_GENERATOR 
CV_CAP_OPENNI_IR_GENERATOR 
CV_CAP_OPENNI_GENERATORS_MASK 
CV_CAP_PROP_OPENNI_OUTPUT_MODE 
CV_CAP_PROP_OPENNI_FRAME_MAX_DEPTH 
CV_CAP_PROP_OPENNI_BASELINE 
CV_CAP_PROP_OPENNI_FOCAL_LENGTH 
CV_CAP_PROP_OPENNI_REGISTRATION 
CV_CAP_PROP_OPENNI_REGISTRATION_ON 
CV_CAP_PROP_OPENNI_APPROX_FRAME_SYNC 
CV_CAP_PROP_OPENNI_MAX_BUFFER_SIZE 
CV_CAP_PROP_OPENNI_CIRCLE_BUFFER 
CV_CAP_PROP_OPENNI_MAX_TIME_DURATION 
CV_CAP_PROP_OPENNI_GENERATOR_PRESENT 
CV_CAP_PROP_OPENNI2_SYNC 
CV_CAP_PROP_OPENNI2_MIRROR 
CV_CAP_OPENNI_IMAGE_GENERATOR_PRESENT 
CV_CAP_OPENNI_IMAGE_GENERATOR_OUTPUT_MODE 
CV_CAP_OPENNI_DEPTH_GENERATOR_PRESENT 
CV_CAP_OPENNI_DEPTH_GENERATOR_BASELINE 
CV_CAP_OPENNI_DEPTH_GENERATOR_FOCAL_LENGTH 
CV_CAP_OPENNI_DEPTH_GENERATOR_REGISTRATION 
CV_CAP_OPENNI_DEPTH_GENERATOR_REGISTRATION_ON 
CV_CAP_OPENNI_IR_GENERATOR_PRESENT 
CV_CAP_GSTREAMER_QUEUE_LENGTH 
CV_CAP_PROP_PVAPI_MULTICASTIP 
CV_CAP_PROP_PVAPI_FRAMESTARTTRIGGERMODE 
CV_CAP_PROP_PVAPI_DECIMATIONHORIZONTAL 
CV_CAP_PROP_PVAPI_DECIMATIONVERTICAL 
CV_CAP_PROP_PVAPI_BINNINGX 
CV_CAP_PROP_PVAPI_BINNINGY 
CV_CAP_PROP_PVAPI_PIXELFORMAT 
CV_CAP_PROP_XI_DOWNSAMPLING 
CV_CAP_PROP_XI_DATA_FORMAT 
CV_CAP_PROP_XI_OFFSET_X 
CV_CAP_PROP_XI_OFFSET_Y 
CV_CAP_PROP_XI_TRG_SOURCE 
CV_CAP_PROP_XI_TRG_SOFTWARE 
CV_CAP_PROP_XI_GPI_SELECTOR 
CV_CAP_PROP_XI_GPI_MODE 
CV_CAP_PROP_XI_GPI_LEVEL 
CV_CAP_PROP_XI_GPO_SELECTOR 
CV_CAP_PROP_XI_GPO_MODE 
CV_CAP_PROP_XI_LED_SELECTOR 
CV_CAP_PROP_XI_LED_MODE 
CV_CAP_PROP_XI_MANUAL_WB 
CV_CAP_PROP_XI_AUTO_WB 
CV_CAP_PROP_XI_AEAG 
CV_CAP_PROP_XI_EXP_PRIORITY 
CV_CAP_PROP_XI_AE_MAX_LIMIT 
CV_CAP_PROP_XI_AG_MAX_LIMIT 
CV_CAP_PROP_XI_AEAG_LEVEL 
CV_CAP_PROP_XI_TIMEOUT 
CV_CAP_PROP_XI_EXPOSURE 
CV_CAP_PROP_XI_EXPOSURE_BURST_COUNT 
CV_CAP_PROP_XI_GAIN_SELECTOR 
CV_CAP_PROP_XI_GAIN 
CV_CAP_PROP_XI_DOWNSAMPLING_TYPE 
CV_CAP_PROP_XI_BINNING_SELECTOR 
CV_CAP_PROP_XI_BINNING_VERTICAL 
CV_CAP_PROP_XI_BINNING_HORIZONTAL 
CV_CAP_PROP_XI_BINNING_PATTERN 
CV_CAP_PROP_XI_DECIMATION_SELECTOR 
CV_CAP_PROP_XI_DECIMATION_VERTICAL 
CV_CAP_PROP_XI_DECIMATION_HORIZONTAL 
CV_CAP_PROP_XI_DECIMATION_PATTERN 
CV_CAP_PROP_XI_TEST_PATTERN_GENERATOR_SELECTOR 
CV_CAP_PROP_XI_TEST_PATTERN 
CV_CAP_PROP_XI_IMAGE_DATA_FORMAT 
CV_CAP_PROP_XI_SHUTTER_TYPE 
CV_CAP_PROP_XI_SENSOR_TAPS 
CV_CAP_PROP_XI_AEAG_ROI_OFFSET_X 
CV_CAP_PROP_XI_AEAG_ROI_OFFSET_Y 
CV_CAP_PROP_XI_AEAG_ROI_WIDTH 
CV_CAP_PROP_XI_AEAG_ROI_HEIGHT 
CV_CAP_PROP_XI_BPC 
CV_CAP_PROP_XI_WB_KR 
CV_CAP_PROP_XI_WB_KG 
CV_CAP_PROP_XI_WB_KB 
CV_CAP_PROP_XI_WIDTH 
CV_CAP_PROP_XI_HEIGHT 
CV_CAP_PROP_XI_REGION_SELECTOR 
CV_CAP_PROP_XI_REGION_MODE 
CV_CAP_PROP_XI_LIMIT_BANDWIDTH 
CV_CAP_PROP_XI_SENSOR_DATA_BIT_DEPTH 
CV_CAP_PROP_XI_OUTPUT_DATA_BIT_DEPTH 
CV_CAP_PROP_XI_IMAGE_DATA_BIT_DEPTH 
CV_CAP_PROP_XI_OUTPUT_DATA_PACKING 
CV_CAP_PROP_XI_OUTPUT_DATA_PACKING_TYPE 
CV_CAP_PROP_XI_IS_COOLED 
CV_CAP_PROP_XI_COOLING 
CV_CAP_PROP_XI_TARGET_TEMP 
CV_CAP_PROP_XI_CHIP_TEMP 
CV_CAP_PROP_XI_HOUS_TEMP 
CV_CAP_PROP_XI_HOUS_BACK_SIDE_TEMP 
CV_CAP_PROP_XI_SENSOR_BOARD_TEMP 
CV_CAP_PROP_XI_CMS 
CV_CAP_PROP_XI_APPLY_CMS 
CV_CAP_PROP_XI_IMAGE_IS_COLOR 
CV_CAP_PROP_XI_COLOR_FILTER_ARRAY 
CV_CAP_PROP_XI_GAMMAY 
CV_CAP_PROP_XI_GAMMAC 
CV_CAP_PROP_XI_SHARPNESS 
CV_CAP_PROP_XI_CC_MATRIX_00 
CV_CAP_PROP_XI_CC_MATRIX_01 
CV_CAP_PROP_XI_CC_MATRIX_02 
CV_CAP_PROP_XI_CC_MATRIX_03 
CV_CAP_PROP_XI_CC_MATRIX_10 
CV_CAP_PROP_XI_CC_MATRIX_11 
CV_CAP_PROP_XI_CC_MATRIX_12 
CV_CAP_PROP_XI_CC_MATRIX_13 
CV_CAP_PROP_XI_CC_MATRIX_20 
CV_CAP_PROP_XI_CC_MATRIX_21 
CV_CAP_PROP_XI_CC_MATRIX_22 
CV_CAP_PROP_XI_CC_MATRIX_23 
CV_CAP_PROP_XI_CC_MATRIX_30 
CV_CAP_PROP_XI_CC_MATRIX_31 
CV_CAP_PROP_XI_CC_MATRIX_32 
CV_CAP_PROP_XI_CC_MATRIX_33 
CV_CAP_PROP_XI_DEFAULT_CC_MATRIX 
CV_CAP_PROP_XI_TRG_SELECTOR 
CV_CAP_PROP_XI_ACQ_FRAME_BURST_COUNT 
CV_CAP_PROP_XI_DEBOUNCE_EN 
CV_CAP_PROP_XI_DEBOUNCE_T0 
CV_CAP_PROP_XI_DEBOUNCE_T1 
CV_CAP_PROP_XI_DEBOUNCE_POL 
CV_CAP_PROP_XI_LENS_MODE 
CV_CAP_PROP_XI_LENS_APERTURE_VALUE 
CV_CAP_PROP_XI_LENS_FOCUS_MOVEMENT_VALUE 
CV_CAP_PROP_XI_LENS_FOCUS_MOVE 
CV_CAP_PROP_XI_LENS_FOCUS_DISTANCE 
CV_CAP_PROP_XI_LENS_FOCAL_LENGTH 
CV_CAP_PROP_XI_LENS_FEATURE_SELECTOR 
CV_CAP_PROP_XI_LENS_FEATURE 
CV_CAP_PROP_XI_DEVICE_MODEL_ID 
CV_CAP_PROP_XI_DEVICE_SN 
CV_CAP_PROP_XI_IMAGE_DATA_FORMAT_RGB32_ALPHA 
CV_CAP_PROP_XI_IMAGE_PAYLOAD_SIZE 
CV_CAP_PROP_XI_TRANSPORT_PIXEL_FORMAT 
CV_CAP_PROP_XI_SENSOR_CLOCK_FREQ_HZ 
CV_CAP_PROP_XI_SENSOR_CLOCK_FREQ_INDEX 
CV_CAP_PROP_XI_SENSOR_OUTPUT_CHANNEL_COUNT 
CV_CAP_PROP_XI_FRAMERATE 
CV_CAP_PROP_XI_COUNTER_SELECTOR 
CV_CAP_PROP_XI_COUNTER_VALUE 
CV_CAP_PROP_XI_ACQ_TIMING_MODE 
CV_CAP_PROP_XI_AVAILABLE_BANDWIDTH 
CV_CAP_PROP_XI_BUFFER_POLICY 
CV_CAP_PROP_XI_LUT_EN 
CV_CAP_PROP_XI_LUT_INDEX 
CV_CAP_PROP_XI_LUT_VALUE 
CV_CAP_PROP_XI_TRG_DELAY 
CV_CAP_PROP_XI_TS_RST_MODE 
CV_CAP_PROP_XI_TS_RST_SOURCE 
CV_CAP_PROP_XI_IS_DEVICE_EXIST 
CV_CAP_PROP_XI_ACQ_BUFFER_SIZE 
CV_CAP_PROP_XI_ACQ_BUFFER_SIZE_UNIT 
CV_CAP_PROP_XI_ACQ_TRANSPORT_BUFFER_SIZE 
CV_CAP_PROP_XI_BUFFERS_QUEUE_SIZE 
CV_CAP_PROP_XI_ACQ_TRANSPORT_BUFFER_COMMIT 
CV_CAP_PROP_XI_RECENT_FRAME 
CV_CAP_PROP_XI_DEVICE_RESET 
CV_CAP_PROP_XI_COLUMN_FPN_CORRECTION 
CV_CAP_PROP_XI_ROW_FPN_CORRECTION 
CV_CAP_PROP_XI_SENSOR_MODE 
CV_CAP_PROP_XI_HDR 
CV_CAP_PROP_XI_HDR_KNEEPOINT_COUNT 
CV_CAP_PROP_XI_HDR_T1 
CV_CAP_PROP_XI_HDR_T2 
CV_CAP_PROP_XI_KNEEPOINT1 
CV_CAP_PROP_XI_KNEEPOINT2 
CV_CAP_PROP_XI_IMAGE_BLACK_LEVEL 
CV_CAP_PROP_XI_HW_REVISION 
CV_CAP_PROP_XI_DEBUG_LEVEL 
CV_CAP_PROP_XI_AUTO_BANDWIDTH_CALCULATION 
CV_CAP_PROP_XI_FFS_FILE_ID 
CV_CAP_PROP_XI_FFS_FILE_SIZE 
CV_CAP_PROP_XI_FREE_FFS_SIZE 
CV_CAP_PROP_XI_USED_FFS_SIZE 
CV_CAP_PROP_XI_FFS_ACCESS_KEY 
CV_CAP_PROP_XI_SENSOR_FEATURE_SELECTOR 
CV_CAP_PROP_XI_SENSOR_FEATURE_VALUE 
CV_CAP_PROP_ANDROID_FLASH_MODE 
CV_CAP_PROP_ANDROID_FOCUS_MODE 
CV_CAP_PROP_ANDROID_WHITE_BALANCE 
CV_CAP_PROP_ANDROID_ANTIBANDING 
CV_CAP_PROP_ANDROID_FOCAL_LENGTH 
CV_CAP_PROP_ANDROID_FOCUS_DISTANCE_NEAR 
CV_CAP_PROP_ANDROID_FOCUS_DISTANCE_OPTIMAL 
CV_CAP_PROP_ANDROID_FOCUS_DISTANCE_FAR 
CV_CAP_PROP_ANDROID_EXPOSE_LOCK 
CV_CAP_PROP_ANDROID_WHITEBALANCE_LOCK 
CV_CAP_PROP_IOS_DEVICE_FOCUS 
CV_CAP_PROP_IOS_DEVICE_EXPOSURE 
CV_CAP_PROP_IOS_DEVICE_FLASH 
CV_CAP_PROP_IOS_DEVICE_WHITEBALANCE 
CV_CAP_PROP_IOS_DEVICE_TORCH 
CV_CAP_PROP_GIGA_FRAME_OFFSET_X 
CV_CAP_PROP_GIGA_FRAME_OFFSET_Y 
CV_CAP_PROP_GIGA_FRAME_WIDTH_MAX 
CV_CAP_PROP_GIGA_FRAME_HEIGH_MAX 
CV_CAP_PROP_GIGA_FRAME_SENS_WIDTH 
CV_CAP_PROP_GIGA_FRAME_SENS_HEIGH 
CV_CAP_PROP_INTELPERC_PROFILE_COUNT 
CV_CAP_PROP_INTELPERC_PROFILE_IDX 
CV_CAP_PROP_INTELPERC_DEPTH_LOW_CONFIDENCE_VALUE 
CV_CAP_PROP_INTELPERC_DEPTH_SATURATION_VALUE 
CV_CAP_PROP_INTELPERC_DEPTH_CONFIDENCE_THRESHOLD 
CV_CAP_PROP_INTELPERC_DEPTH_FOCAL_LENGTH_HORZ 
CV_CAP_PROP_INTELPERC_DEPTH_FOCAL_LENGTH_VERT 
CV_CAP_INTELPERC_DEPTH_GENERATOR 
CV_CAP_INTELPERC_IMAGE_GENERATOR 
CV_CAP_INTELPERC_GENERATORS_MASK 

◆ anonymous enum

anonymous enum

#include <opencv2/videoio/videoio_c.h>

Enumerator
CV_CAP_MODE_BGR 
CV_CAP_MODE_RGB 
CV_CAP_MODE_GRAY 
CV_CAP_MODE_YUYV 

◆ anonymous enum

anonymous enum

#include <opencv2/videoio/videoio_c.h>

Enumerator
CV_CAP_OPENNI_DEPTH_MAP 
CV_CAP_OPENNI_POINT_CLOUD_MAP 
CV_CAP_OPENNI_DISPARITY_MAP 
CV_CAP_OPENNI_DISPARITY_MAP_32F 
CV_CAP_OPENNI_VALID_DEPTH_MASK 
CV_CAP_OPENNI_BGR_IMAGE 
CV_CAP_OPENNI_GRAY_IMAGE 
CV_CAP_OPENNI_IR_IMAGE 

◆ anonymous enum

anonymous enum

#include <opencv2/videoio/videoio_c.h>

Enumerator
CV_CAP_OPENNI_VGA_30HZ 
CV_CAP_OPENNI_SXGA_15HZ 
CV_CAP_OPENNI_SXGA_30HZ 
CV_CAP_OPENNI_QVGA_30HZ 
CV_CAP_OPENNI_QVGA_60HZ 

◆ anonymous enum

anonymous enum

#include <opencv2/videoio/videoio_c.h>

Enumerator
CV_CAP_INTELPERC_DEPTH_MAP 
CV_CAP_INTELPERC_UVDEPTH_MAP 
CV_CAP_INTELPERC_IR_MAP 
CV_CAP_INTELPERC_IMAGE 

◆ anonymous enum

anonymous enum

#include <opencv2/videoio/videoio_c.h>

Enumerator
CV_CAP_PROP_GPHOTO2_PREVIEW 
CV_CAP_PROP_GPHOTO2_WIDGET_ENUMERATE 
CV_CAP_PROP_GPHOTO2_RELOAD_CONFIG 
CV_CAP_PROP_GPHOTO2_RELOAD_ON_CHANGE 
CV_CAP_PROP_GPHOTO2_COLLECT_MSGS 
CV_CAP_PROP_GPHOTO2_FLUSH_MSGS 
CV_CAP_PROP_SPEED 
CV_CAP_PROP_APERTURE 
CV_CAP_PROP_EXPOSUREPROGRAM 
CV_CAP_PROP_VIEWFINDER 

Function Documentation

◆ CV_FOURCC()

int CV_FOURCC ( char  c1,
char  c2,
char  c3,
char  c4 
)

#include <opencv2/videoio/videoio_c.h>

Constructs the fourcc code of the codec function.

Simply call it with 4 chars fourcc code like `CV_FOURCC('I', 'Y', 'U', 'V')`

List of codes can be obtained at Video Codecs by FOURCC page. FFMPEG backend with MP4 container natively uses other values as fourcc code: see ObjectType.

◆ cvCreateCameraCapture()

CvCapture* cvCreateCameraCapture ( int  index)

#include <opencv2/videoio/videoio_c.h>

start capturing frames from camera: index = camera_index + domain_offset (CV_CAP_*)

◆ cvCreateFileCapture()

CvCapture* cvCreateFileCapture ( const char *  filename)

#include <opencv2/videoio/videoio_c.h>

start capturing frames from video file

◆ cvCreateFileCaptureWithPreference()

CvCapture* cvCreateFileCaptureWithPreference ( const char *  filename,
int  apiPreference 
)

#include <opencv2/videoio/videoio_c.h>

start capturing frames from video file. allows specifying a preferred API to use

◆ cvCreateVideoWriter()

CvVideoWriter* cvCreateVideoWriter ( const char *  filename,
int  fourcc,
double  fps,
CvSize  frame_size,
int  is_color = 1 
)

#include <opencv2/videoio/videoio_c.h>

initialize video file writer

◆ cvGetCaptureDomain()

int cvGetCaptureDomain ( CvCapture capture)

#include <opencv2/videoio/videoio_c.h>

Return the type of the capturer (eg, CV_CAP_VFW, CV_CAP_UNICAP)

It is unknown if created with CV_CAP_ANY

◆ cvGetCaptureProperty()

double cvGetCaptureProperty ( CvCapture capture,
int  property_id 
)

#include <opencv2/videoio/videoio_c.h>

retrieve capture properties

◆ cvGrabFrame()

int cvGrabFrame ( CvCapture capture)

#include <opencv2/videoio/videoio_c.h>

grab a frame, return 1 on success, 0 on fail.

this function is thought to be fast

◆ cvQueryFrame()

IplImage* cvQueryFrame ( CvCapture capture)

#include <opencv2/videoio/videoio_c.h>

Just a combination of cvGrabFrame and cvRetrieveFrame.

Warning
!!!DO NOT RELEASE or MODIFY the retrieved frame!!!

◆ cvReleaseCapture()

void cvReleaseCapture ( CvCapture **  capture)

#include <opencv2/videoio/videoio_c.h>

stop capturing/reading and free resources

◆ cvReleaseVideoWriter()

void cvReleaseVideoWriter ( CvVideoWriter **  writer)

#include <opencv2/videoio/videoio_c.h>

close video file writer

◆ cvRetrieveFrame()

IplImage* cvRetrieveFrame ( CvCapture capture,
int  streamIdx = 0 
)

#include <opencv2/videoio/videoio_c.h>

get the frame grabbed with cvGrabFrame(..)

This function may apply some frame processing like frame decompression, flipping etc.

Warning
!!!DO NOT RELEASE or MODIFY the retrieved frame!!!

◆ cvSetCaptureProperty()

int cvSetCaptureProperty ( CvCapture capture,
int  property_id,
double  value 
)

#include <opencv2/videoio/videoio_c.h>

set capture properties

◆ cvWriteFrame()

int cvWriteFrame ( CvVideoWriter writer,
const IplImage image 
)

#include <opencv2/videoio/videoio_c.h>

write frame to video file