Modules§
Structs§
- IStream
Reader - Read data stream interface
- Video
Capture - Class for video capturing from video files, image sequences or cameras.
- Video
Writer - Video writer class.
Enums§
- Video
Acceleration Type - Video Acceleration type
- Video
CaptureAP Is - cv::VideoCapture API backends identifier.
- Video
CaptureOB Sensor Data Type - OBSENSOR (for Orbbec 3D-Sensor device/module )
- Video
CaptureOB Sensor Generators - OBSENSOR stream generator
- Video
CaptureOB Sensor Properties - OBSENSOR properties
- Video
Capture Properties - cv::VideoCapture generic properties identifier.
- Video
Writer Properties - cv::VideoWriter generic properties identifier.
Constants§
- CAP_
ANDROID - MediaNDK (API Level 21+) and NDK Camera (API level 24+) for Android
- CAP_ANY
- Auto detect == 0
- CAP_
ARAVIS - Aravis SDK
- CAP_
AVFOUNDATION - AVFoundation framework for iOS (OS X Lion will have the same API)
- CAP_
CMU1394 - Same value as CAP_FIREWIRE
- CAP_
DC1394 - Same value as CAP_FIREWIRE
- CAP_
DSHOW - DirectShow (via videoInput)
- CAP_
FFMPEG - Open and record video file or stream using the FFMPEG library
- CAP_
FIREWARE - Same value as CAP_FIREWIRE
- CAP_
FIREWIRE - IEEE 1394 drivers
- CAP_
GIGANETIX - Smartek Giganetix GigEVisionSDK
- CAP_
GPHOT O2 - gPhoto2 connection
- CAP_
GSTREAMER - GStreamer
- CAP_
IEEE1394 - Same value as CAP_FIREWIRE
- CAP_
IMAGES - OpenCV Image Sequence (e.g. img_%02d.jpg)
- CAP_
INTELPERC - RealSense (former Intel Perceptual Computing SDK)
- CAP_
INTELPERC_ DEPTH_ GENERATOR - 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_ GENERATORS_ MASK - CAP_
INTELPERC_ IMAGE - CAP_
INTELPERC_ IMAGE_ GENERATOR - CAP_
INTELPERC_ IR_ GENERATOR - CAP_
INTELPERC_ IR_ MAP - Each pixel is a 16-bit integer. The value indicates the intensity of the reflected laser beam.
- 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_
INTEL_ MFX - Intel MediaSDK
- CAP_
MSMF - Microsoft Media Foundation (via videoInput). See platform specific notes above.
- CAP_
OBSENSOR - For Orbbec 3D-Sensor device/module (Astra+, Femto, Astra2, Gemini2, Gemini2L, Gemini2XL, Femto Mega) attention: Astra2 cameras currently only support Windows and Linux kernel versions no higher than 4.15, and higher versions of Linux kernel may have exceptions.
- CAP_
OBSENSOR_ BGR_ IMAGE - Data given from BGR stream generator
- CAP_
OBSENSOR_ DEPTH_ GENERATOR - CAP_
OBSENSOR_ DEPTH_ MAP - Depth values in mm (CV_16UC1)
- CAP_
OBSENSOR_ GENERATORS_ MASK - CAP_
OBSENSOR_ IMAGE_ GENERATOR - CAP_
OBSENSOR_ IR_ GENERATOR - CAP_
OBSENSOR_ IR_ IMAGE - Data given from IR stream generator(CV_16UC1)
- CAP_
OPENCV_ MJPEG - Built-in OpenCV MotionJPEG codec
- CAP_
OPENNI - OpenNI (for Kinect)
- CAP_
OPENN I2 - OpenNI2 (for Kinect)
- CAP_
OPENN I2_ ASTRA - OpenNI2 (for Orbbec Astra)
- CAP_
OPENN I2_ ASUS - OpenNI2 (for Asus Xtion and Occipital Structure sensors)
- CAP_
OPENNI_ ASUS - OpenNI (for Asus Xtion)
- CAP_
OPENNI_ BGR_ IMAGE - Data given from RGB image generator
- CAP_
OPENNI_ DEPTH_ GENERATOR - CAP_
OPENNI_ DEPTH_ GENERATOR_ BASELINE - CAP_
OPENNI_ DEPTH_ GENERATOR_ FOCAL_ LENGTH - CAP_
OPENNI_ DEPTH_ GENERATOR_ PRESENT - CAP_
OPENNI_ DEPTH_ GENERATOR_ REGISTRATION - CAP_
OPENNI_ DEPTH_ GENERATOR_ REGISTRATION_ ON - CAP_
OPENNI_ DEPTH_ MAP - Depth values in mm (CV_16UC1)
- CAP_
OPENNI_ DISPARITY_ MAP - Disparity in pixels (CV_8UC1)
- CAP_
OPENNI_ DISPARITY_ MAP_ 32F - Disparity in pixels (CV_32FC1)
- CAP_
OPENNI_ GENERATORS_ MASK - CAP_
OPENNI_ GRAY_ IMAGE - Data given from RGB image generator
- CAP_
OPENNI_ IMAGE_ GENERATOR - CAP_
OPENNI_ IMAGE_ GENERATOR_ OUTPUT_ MODE - CAP_
OPENNI_ IMAGE_ GENERATOR_ PRESENT - CAP_
OPENNI_ IR_ GENERATOR - CAP_
OPENNI_ IR_ GENERATOR_ PRESENT - CAP_
OPENNI_ IR_ IMAGE - Data given from IR image generator
- CAP_
OPENNI_ POINT_ CLOUD_ MAP - XYZ in meters (CV_32FC3)
- CAP_
OPENNI_ QVGA_ 30HZ - CAP_
OPENNI_ QVGA_ 60HZ - CAP_
OPENNI_ SXGA_ 15HZ - CAP_
OPENNI_ SXGA_ 30HZ - CAP_
OPENNI_ VALID_ DEPTH_ MASK - CV_8UC1
- CAP_
OPENNI_ VGA_ 30HZ - CAP_
PROP_ ANDROID_ DEVICE_ TORCH - CAP_
PROP_ APERTURE - Aperture. Can be readonly, depends on camera program.
- CAP_
PROP_ ARAVIS_ AUTOTRIGGER - Automatically trigger frame capture if camera is configured with software trigger
- CAP_
PROP_ AUDIO_ BASE_ INDEX - (read-only) Index of the first audio channel for .retrieve() calls. That audio channel number continues enumeration after video channels.
- CAP_
PROP_ AUDIO_ DATA_ DEPTH - (open, read) Alternative definition to bits-per-sample, but with clear handling of 32F / 32S
- CAP_
PROP_ AUDIO_ POS - (read-only) Audio position is measured in samples. Accurate audio sample timestamp of previous grabbed fragment. See CAP_PROP_AUDIO_SAMPLES_PER_SECOND and CAP_PROP_AUDIO_SHIFT_NSEC.
- CAP_
PROP_ AUDIO_ SAMPLES_ PER_ SECOND - (open, read) determined from file/codec input. If not specified, then selected audio sample rate is 44100
- CAP_
PROP_ AUDIO_ SHIFT_ NSEC - (read only) Contains the time difference between the start of the audio stream and the video stream in nanoseconds. Positive value means that audio is started after the first video frame. Negative value means that audio is started before the first video frame.
- CAP_
PROP_ AUDIO_ STREAM - (open-only) Specify stream in multi-language media files, -1 - disable audio processing or microphone. Default value is -1.
- CAP_
PROP_ AUDIO_ SYNCHRONIZE - (open, read) Enables audio synchronization.
- CAP_
PROP_ AUDIO_ TOTAL_ CHANNELS - (read-only) Number of audio channels in the selected audio stream (mono, stereo, etc)
- CAP_
PROP_ AUDIO_ TOTAL_ STREAMS - (read-only) Number of audio streams.
- CAP_
PROP_ AUTOFOCUS - CAP_
PROP_ AUTO_ EXPOSURE - DC1394: exposure control done by camera, user can adjust reference level using this feature.
- CAP_
PROP_ AUTO_ WB - enable/ disable auto white-balance
- CAP_
PROP_ BACKEND - Current backend (enum VideoCaptureAPIs). Read-only property
- CAP_
PROP_ BACKLIGHT - CAP_
PROP_ BITRATE - (read-only) Video bitrate in kbits/s
- CAP_
PROP_ BRIGHTNESS - Brightness of the image (only for those cameras that support).
- CAP_
PROP_ BUFFERSIZE - CAP_
PROP_ CHANNEL - Video input or Channel Number (only for those cameras that support)
- CAP_
PROP_ CODEC_ EXTRADATA_ INDEX - Positive index indicates that returning extra data is supported by the video back end. This can be retrieved as cap.retrieve(data,
). E.g. When reading from a h264 encoded RTSP stream, the FFmpeg backend could return the SPS and/or PPS if available (if sent in reply to a DESCRIBE request), from calls to cap.retrieve(data, ). - CAP_
PROP_ CODEC_ PIXEL_ FORMAT - (read-only) codec’s pixel format. 4-character code - see VideoWriter::fourcc . Subset of AV_PIX_FMT_* or -1 if unknown
- CAP_
PROP_ CONTRAST - Contrast of the image (only for cameras).
- CAP_
PROP_ CONVERT_ RGB - Boolean flags indicating whether images should be converted to RGB.
GStreamer note: The flag is ignored in case if custom pipeline is used. It’s user responsibility to interpret pipeline output. - CAP_
PROP_ DC1394_ MAX - CAP_
PROP_ DC1394_ MODE_ AUTO - CAP_
PROP_ DC1394_ MODE_ MANUAL - set automatically when a value of the feature is set by the user.
- CAP_
PROP_ DC1394_ MODE_ ONE_ PUSH_ AUTO - CAP_
PROP_ DC1394_ OFF - turn the feature off (not controlled manually nor automatically).
- CAP_
PROP_ DTS_ DELAY - (read-only) FFmpeg back-end only - maximum difference between presentation (pts) and decompression timestamps (dts) using FPS time base. e.g. delay is maximum when frame_num = 0, if true, VideoCapture::get(\ref CAP_PROP_PTS) = 0 and VideoCapture::get(\ref CAP_PROP_DTS_DELAY) = 2, dts = -2. Non zero values usually imply the stream is encoded using B-frames which are not decoded in presentation order.
- CAP_
PROP_ EXPOSURE - Exposure (only for those cameras that support).
- CAP_
PROP_ EXPOSUREPROGRAM - Camera exposure program.
- CAP_
PROP_ FOCUS - CAP_
PROP_ FORMAT - Format of the %Mat objects (see Mat::type()) returned by VideoCapture::retrieve(). Set value -1 to fetch undecoded RAW video streams (as Mat 8UC1).
- CAP_
PROP_ FOURCC - 4-character code of codec. see VideoWriter::fourcc .
- CAP_
PROP_ FPS - Frame rate.
- CAP_
PROP_ FRAME_ COUNT - Number of frames in the video file.
- CAP_
PROP_ FRAME_ HEIGHT - Height of the frames in the video stream.
- CAP_
PROP_ FRAME_ TYPE - (read-only) FFmpeg back-end only - Frame type ascii code (73 = ‘I’, 80 = ‘P’, 66 = ‘B’ or 63 = ‘?’ if unknown) of the most recently read frame.
- CAP_
PROP_ FRAME_ WIDTH - Width of the frames in the video stream.
- CAP_
PROP_ GAIN - Gain of the image (only for those cameras that support).
- CAP_
PROP_ GAMMA - CAP_
PROP_ GIGA_ FRAME_ HEIGH_ MAX - CAP_
PROP_ GIGA_ FRAME_ OFFSET_ X - CAP_
PROP_ GIGA_ FRAME_ OFFSET_ Y - CAP_
PROP_ GIGA_ FRAME_ SENS_ HEIGH - CAP_
PROP_ GIGA_ FRAME_ SENS_ WIDTH - CAP_
PROP_ GIGA_ FRAME_ WIDTH_ MAX - CAP_
PROP_ GPHOT O2_ COLLECT_ MSGS - Collect messages with details.
- CAP_
PROP_ GPHOT O2_ FLUSH_ MSGS - Readonly, returns (const char *).
- CAP_
PROP_ GPHOT O2_ PREVIEW - Capture only preview from liveview mode.
- CAP_
PROP_ GPHOT O2_ RELOAD_ CONFIG - Trigger, only by set. Reload camera settings.
- CAP_
PROP_ GPHOT O2_ RELOAD_ ON_ CHANGE - Reload all settings on set.
- CAP_
PROP_ GPHOT O2_ WIDGET_ ENUMERATE - Readonly, returns (const char *).
- CAP_
PROP_ GSTREAMER_ QUEUE_ LENGTH - Default is 1
- CAP_
PROP_ GUID - CAP_
PROP_ HUE - Hue of the image (only for cameras).
- CAP_
PROP_ HW_ ACCELERATION - (open-only) Hardware acceleration type (see #VideoAccelerationType). Setting supported only via
params
parameter in cv::VideoCapture constructor / .open() method. Default value is backend-specific. - CAP_
PROP_ HW_ ACCELERATION_ USE_ OPENCL - (open-only) If non-zero, create new OpenCL context and bind it to current thread. The OpenCL context created with Video Acceleration context attached it (if not attached yet) for optimized GPU data copy between HW accelerated decoder and cv::UMat.
- CAP_
PROP_ HW_ DEVICE - (open-only) Hardware device index (select GPU if multiple available). Device enumeration is acceleration type specific.
- CAP_
PROP_ IMAGES_ BASE - CAP_
PROP_ IMAGES_ LAST - CAP_
PROP_ INTELPERC_ DEPTH_ CONFIDENCE_ THRESHOLD - CAP_
PROP_ INTELPERC_ DEPTH_ FOCAL_ LENGTH_ HORZ - CAP_
PROP_ INTELPERC_ DEPTH_ FOCAL_ LENGTH_ VERT - CAP_
PROP_ INTELPERC_ DEPTH_ LOW_ CONFIDENCE_ VALUE - CAP_
PROP_ INTELPERC_ DEPTH_ SATURATION_ VALUE - CAP_
PROP_ INTELPERC_ PROFILE_ COUNT - CAP_
PROP_ INTELPERC_ PROFILE_ IDX - CAP_
PROP_ IOS_ DEVICE_ EXPOSURE - CAP_
PROP_ IOS_ DEVICE_ FLASH - CAP_
PROP_ IOS_ DEVICE_ FOCUS - CAP_
PROP_ IOS_ DEVICE_ TORCH - CAP_
PROP_ IOS_ DEVICE_ WHITEBALANCE - CAP_
PROP_ IRIS - CAP_
PROP_ ISO_ SPEED - CAP_
PROP_ LRF_ HAS_ KEY_ FRAME - FFmpeg back-end only - Indicates whether the Last Raw Frame (LRF), output from VideoCapture::read() when VideoCapture is initialized with VideoCapture::open(CAP_FFMPEG, {CAP_PROP_FORMAT, -1}) or VideoCapture::set(CAP_PROP_FORMAT,-1) is called before the first call to VideoCapture::read(), contains encoded data for a key frame.
- CAP_
PROP_ MODE - Backend-specific value indicating the current capture mode.
- CAP_
PROP_ MONOCHROME - CAP_
PROP_ N_ THREADS - (open-only) Set the maximum number of threads to use. Use 0 to use as many threads as CPU cores (applicable for FFmpeg back-end only).
- CAP_
PROP_ OBSENSOR_ INTRINSIC_ CX - CAP_
PROP_ OBSENSOR_ INTRINSIC_ CY - CAP_
PROP_ OBSENSOR_ INTRINSIC_ FX - CAP_
PROP_ OBSENSOR_ INTRINSIC_ FY - CAP_
PROP_ OPENN I2_ MIRROR - CAP_
PROP_ OPENN I2_ SYNC - CAP_
PROP_ OPENNI_ APPROX_ FRAME_ SYNC - CAP_
PROP_ OPENNI_ BASELINE - In mm
- CAP_
PROP_ OPENNI_ CIRCLE_ BUFFER - CAP_
PROP_ OPENNI_ FOCAL_ LENGTH - In pixels
- CAP_
PROP_ OPENNI_ FRAME_ MAX_ DEPTH - In mm
- CAP_
PROP_ OPENNI_ GENERATOR_ PRESENT - CAP_
PROP_ OPENNI_ MAX_ BUFFER_ SIZE - CAP_
PROP_ OPENNI_ MAX_ TIME_ DURATION - CAP_
PROP_ OPENNI_ OUTPUT_ MODE - 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_ OPEN_ TIMEOUT_ MSEC - (open-only) timeout in milliseconds for opening a video capture (applicable for FFmpeg and GStreamer back-ends only)
- CAP_
PROP_ ORIENTATION_ AUTO - if true - rotates output frames of CvCapture considering video file’s metadata (applicable for FFmpeg and AVFoundation back-ends only) (https://github.com/opencv/opencv/issues/15499)
- CAP_
PROP_ ORIENTATION_ META - (read-only) Frame rotation defined by stream meta (applicable for FFmpeg and AVFoundation back-ends only)
- CAP_
PROP_ PAN - CAP_
PROP_ POS_ AVI_ RATIO - Relative position of the video file: 0=start of the film, 1=end of the film.
- CAP_
PROP_ POS_ FRAMES - 0-based index of the frame to be decoded/captured next. When the index i is set in RAW mode (CAP_PROP_FORMAT == -1) this will seek to the key frame k, where k <= i.
- CAP_
PROP_ POS_ MSEC - Current position of the video file in milliseconds.
- CAP_
PROP_ PTS - (read-only) FFmpeg back-end only - presentation timestamp of the most recently read frame using the FPS time base. e.g. fps = 25, VideoCapture::get(\ref CAP_PROP_PTS) = 3, presentation time = 3/25 seconds.
- CAP_
PROP_ PVAPI_ BINNINGX - Horizontal binning factor.
- CAP_
PROP_ PVAPI_ BINNINGY - Vertical binning factor.
- CAP_
PROP_ PVAPI_ DECIMATIONHORIZONTAL - Horizontal sub-sampling of the image.
- CAP_
PROP_ PVAPI_ DECIMATIONVERTICAL - Vertical sub-sampling of the image.
- CAP_
PROP_ PVAPI_ FRAMESTARTTRIGGERMODE - FrameStartTriggerMode: Determines how a frame is initiated.
- CAP_
PROP_ PVAPI_ MULTICASTIP - IP for enable multicast master mode. 0 for disable multicast.
- CAP_
PROP_ PVAPI_ PIXELFORMAT - Pixel format.
- CAP_
PROP_ READ_ TIMEOUT_ MSEC - (open-only) timeout in milliseconds for reading from a video capture (applicable for FFmpeg and GStreamer back-ends only)
- CAP_
PROP_ RECTIFICATION - Rectification flag for stereo cameras (note: only supported by DC1394 v 2.x backend currently).
- CAP_
PROP_ ROLL - CAP_
PROP_ SAR_ DEN - Sample aspect ratio: num/den (den)
- CAP_
PROP_ SAR_ NUM - Sample aspect ratio: num/den (num)
- CAP_
PROP_ SATURATION - Saturation of the image (only for cameras).
- CAP_
PROP_ SETTINGS - Pop up video/camera filter dialog (note: only supported by DSHOW backend currently. The property value is ignored)
- CAP_
PROP_ SHARPNESS - CAP_
PROP_ SPEED - Exposure speed. Can be readonly, depends on camera program.
- CAP_
PROP_ STREAM_ OPEN_ TIME_ USEC - (read-only) time in microseconds since Jan 1 1970 when stream was opened. Applicable for FFmpeg backend only. Useful for RTSP and other live streams
- CAP_
PROP_ TEMPERATURE - CAP_
PROP_ TILT - CAP_
PROP_ TRIGGER - CAP_
PROP_ TRIGGER_ DELAY - CAP_
PROP_ VIDEO_ STREAM - (open-only) Specify video stream, 0-based index. Use -1 to disable video stream from file or IP cameras. Default value is 0.
- CAP_
PROP_ VIDEO_ TOTAL_ CHANNELS - (read-only) Number of video channels
- CAP_
PROP_ VIEWFINDER - Enter liveview mode.
- CAP_
PROP_ WB_ TEMPERATURE - white-balance color temperature
- CAP_
PROP_ WHITE_ BALANCE_ BLUE_ U - Currently unsupported.
- CAP_
PROP_ WHITE_ BALANCE_ RED_ V - 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_ FRAME_ BURST_ COUNT - Sets number of frames acquired by burst. This burst is used only if trigger is set to FrameBurstStart.
- CAP_
PROP_ XI_ ACQ_ TIMING_ MODE - Type of sensor frames timing.
- CAP_
PROP_ XI_ ACQ_ TRANSPORT_ BUFFER_ COMMIT - Number of buffers to commit to low level.
- CAP_
PROP_ XI_ ACQ_ TRANSPORT_ BUFFER_ SIZE - Acquisition transport buffer size in bytes.
- CAP_
PROP_ XI_ AEAG - Automatic exposure/gain.
- CAP_
PROP_ XI_ AEAG_ LEVEL - Average intensity of output signal AEAG should achieve(in %).
- CAP_
PROP_ XI_ AEAG_ ROI_ HEIGHT - Automatic exposure/gain ROI Height.
- 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_ 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_ APPLY_ CMS - Enable applying of CMS profiles to xiGetImage (see XI_PRM_INPUT_CMS_PROFILE, XI_PRM_OUTPUT_CMS_PROFILE).
- CAP_
PROP_ XI_ AUTO_ BANDWIDTH_ CALCULATION - Automatic bandwidth calculation.
- CAP_
PROP_ XI_ AUTO_ WB - Automatic white balance.
- CAP_
PROP_ XI_ AVAILABLE_ BANDWIDTH - Calculate and returns available interface bandwidth(int Megabits).
- 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_ BINNING_ SELECTOR - Binning engine selector.
- CAP_
PROP_ XI_ BINNING_ VERTICAL - Vertical Binning - number of vertical photo-sensitive cells to combine together.
- CAP_
PROP_ XI_ BPC - Correction of bad pixels.
- CAP_
PROP_ XI_ BUFFERS_ QUEUE_ SIZE - Queue of field/frame buffers.
- CAP_
PROP_ XI_ BUFFER_ POLICY - Data move policy.
- 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_ CHIP_ TEMP - Camera sensor temperature.
- CAP_
PROP_ XI_ CMS - Mode of color management system.
- CAP_
PROP_ XI_ COLOR_ FILTER_ ARRAY - Returns color filter array type of RAW data.
- CAP_
PROP_ XI_ COLUMN_ FPN_ CORRECTION - Correction of column FPN.
- CAP_
PROP_ XI_ COOLING - Start camera cooling.
- CAP_
PROP_ XI_ COUNTER_ SELECTOR - Select counter.
- CAP_
PROP_ XI_ COUNTER_ VALUE - Counter status.
- CAP_
PROP_ XI_ DATA_ FORMAT - Output data format.
- CAP_
PROP_ XI_ DEBOUNCE_ EN - Enable/Disable debounce to selected GPI.
- CAP_
PROP_ XI_ DEBOUNCE_ POL - Debounce polarity (pol = 1 t0 - falling edge, t1 - rising edge).
- CAP_
PROP_ XI_ DEBOUNCE_ T0 - Debounce time (x * 10us).
- CAP_
PROP_ XI_ DEBOUNCE_ T1 - Debounce time (x * 10us).
- CAP_
PROP_ XI_ DEBUG_ LEVEL - Set debug level.
- 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_ 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_ DEFAULT_ CC_ MATRIX - Set default Color Correction Matrix.
- CAP_
PROP_ XI_ DEVICE_ MODEL_ ID - Returns device model id.
- CAP_
PROP_ XI_ DEVICE_ RESET - Resets the camera to default state.
- CAP_
PROP_ XI_ DEVICE_ SN - Returns device serial number.
- CAP_
PROP_ XI_ DOWNSAMPLING - Change image resolution by binning or skipping.
- CAP_
PROP_ XI_ DOWNSAMPLING_ TYPE - Change image downsampling type.
- 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_ EXP_ PRIORITY - Exposure priority (0.5 - exposure 50%, gain 50%).
- CAP_
PROP_ XI_ FFS_ ACCESS_ KEY - Setting of key enables file operations on some cameras.
- CAP_
PROP_ XI_ FFS_ FILE_ ID - File number.
- CAP_
PROP_ XI_ FFS_ FILE_ SIZE - Size of file.
- CAP_
PROP_ XI_ FRAMERATE - Define framerate in Hz.
- CAP_
PROP_ XI_ FREE_ FFS_ SIZE - Size of free camera FFS.
- CAP_
PROP_ XI_ GAIN - Gain in dB.
- CAP_
PROP_ XI_ GAIN_ SELECTOR - Gain selector for parameter Gain allows to select different type of gains.
- CAP_
PROP_ XI_ GAMMAC - Chromaticity gamma.
- CAP_
PROP_ XI_ GAMMAY - Luminosity gamma.
- CAP_
PROP_ XI_ GPI_ LEVEL - Get general purpose level.
- CAP_
PROP_ XI_ GPI_ MODE - Set general purpose input mode.
- CAP_
PROP_ XI_ GPI_ SELECTOR - Selects general purpose input.
- CAP_
PROP_ XI_ GPO_ MODE - Set general purpose output mode.
- CAP_
PROP_ XI_ GPO_ SELECTOR - Selects general purpose output.
- 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_ HEIGHT - Height of the Image provided by the device (in pixels).
- CAP_
PROP_ XI_ HOUS_ BACK_ SIDE_ TEMP - Camera housing back side temperature.
- CAP_
PROP_ XI_ HOUS_ TEMP - Camera housing temperature.
- CAP_
PROP_ XI_ HW_ REVISION - Returns hardware revision number.
- CAP_
PROP_ XI_ IMAGE_ BLACK_ LEVEL - Last image black level counts. Can be used for Offline processing to recall it.
- CAP_
PROP_ XI_ IMAGE_ DATA_ BIT_ DEPTH - bitdepth of data returned by function xiGetImage.
- CAP_
PROP_ XI_ IMAGE_ DATA_ FORMAT - Output data format.
- CAP_
PROP_ XI_ IMAGE_ DATA_ FORMAT_ RGB32_ ALPHA - The alpha channel of RGB32 output image format.
- CAP_
PROP_ XI_ IMAGE_ IS_ COLOR - Returns 1 for color cameras.
- CAP_
PROP_ XI_ IMAGE_ PAYLOAD_ SIZE - Buffer size in bytes sufficient for output image returned by xiGetImage.
- CAP_
PROP_ XI_ IS_ COOLED - Returns 1 for cameras that support cooling.
- CAP_
PROP_ XI_ IS_ DEVICE_ EXIST - Returns 1 if camera connected and works properly.
- CAP_
PROP_ XI_ KNEEPOIN T1 - Value of first kneepoint (% of sensor saturation).
- CAP_
PROP_ XI_ KNEEPOIN T2 - Value of second kneepoint (% of sensor saturation).
- CAP_
PROP_ XI_ LED_ MODE - Define camera signalling LED functionality.
- CAP_
PROP_ XI_ LED_ SELECTOR - Selects camera signalling LED.
- CAP_
PROP_ XI_ LENS_ APERTURE_ VALUE - Current lens aperture value in stops. Examples: 2.8, 4, 5.6, 8, 11.
- CAP_
PROP_ XI_ LENS_ FEATURE - Allows access to lens feature value currently selected by XI_PRM_LENS_FEATURE_SELECTOR.
- CAP_
PROP_ XI_ LENS_ FEATURE_ SELECTOR - Selects the current feature which is accessible by XI_PRM_LENS_FEATURE.
- CAP_
PROP_ XI_ LENS_ FOCAL_ LENGTH - Lens focal distance in mm.
- CAP_
PROP_ XI_ LENS_ FOCUS_ DISTANCE - Lens focus distance in cm.
- 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_ MOVEMENT_ VALUE - Lens current focus movement value to be used by XI_PRM_LENS_FOCUS_MOVE in motor steps.
- CAP_
PROP_ XI_ LENS_ MODE - Status of lens control interface. This shall be set to XI_ON before any Lens operations.
- CAP_
PROP_ XI_ LIMIT_ BANDWIDTH - Set/get bandwidth(datarate)(in Megabits).
- 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_ MANUAL_ WB - Calculates White Balance(must be called during acquisition).
- 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_ OUTPUT_ DATA_ BIT_ DEPTH - Device output data bit depth.
- 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_ RECENT_ FRAME - GetImage returns most recent frame.
- CAP_
PROP_ XI_ REGION_ MODE - Activates/deactivates Region selected by Region Selector.
- CAP_
PROP_ XI_ REGION_ SELECTOR - Selects Region in Multiple ROI which parameters are set by width, height, … ,region mode.
- CAP_
PROP_ XI_ ROW_ FPN_ CORRECTION - Correction of row FPN.
- CAP_
PROP_ XI_ SENSOR_ BOARD_ TEMP - Camera sensor board temperature.
- 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_ DATA_ BIT_ DEPTH - Sensor output data bit depth.
- 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.
- 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_ SENSOR_ OUTPUT_ CHANNEL_ COUNT - Number of output channels from sensor used for data transfer.
- CAP_
PROP_ XI_ SENSOR_ TAPS - Number of taps.
- CAP_
PROP_ XI_ SHARPNESS - Sharpness Strength.
- CAP_
PROP_ XI_ SHUTTER_ TYPE - Change sensor shutter type(CMOS sensor).
- CAP_
PROP_ XI_ TARGET_ TEMP - Set sensor target temperature for cooling.
- CAP_
PROP_ XI_ TEST_ PATTERN - Selects which test pattern type is generated by the selected generator.
- CAP_
PROP_ XI_ TEST_ PATTERN_ GENERATOR_ SELECTOR - Selects which test pattern generator is controlled by the TestPattern feature.
- CAP_
PROP_ XI_ TIMEOUT - Image capture timeout in milliseconds.
- CAP_
PROP_ XI_ TRANSPORT_ PIXEL_ FORMAT - Current format of pixels on transport layer.
- CAP_
PROP_ XI_ TRG_ DELAY - Specifies the delay in microseconds (us) to apply after the trigger reception before activating it.
- CAP_
PROP_ XI_ TRG_ SELECTOR - Selects the type of trigger.
- CAP_
PROP_ XI_ TRG_ SOFTWARE - Generates an internal trigger. PRM_TRG_SOURCE must be set to TRG_SOFTWARE.
- CAP_
PROP_ XI_ TRG_ SOURCE - Defines source of trigger.
- 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_ USED_ FFS_ SIZE - Size of used camera FFS.
- CAP_
PROP_ XI_ WB_ KB - White balance blue coefficient.
- CAP_
PROP_ XI_ WB_ KG - White balance green coefficient.
- CAP_
PROP_ XI_ WB_ KR - White balance red coefficient.
- CAP_
PROP_ XI_ WIDTH - Width of the Image provided by the device (in pixels).
- CAP_
PROP_ ZOOM - CAP_
PVAPI - PvAPI, Prosilica GigE SDK
- CAP_
PVAPI_ DECIMATION_ 2OUTO F4 - 2 out of 4 decimation
- CAP_
PVAPI_ DECIMATION_ 2OUTO F8 - 2 out of 8 decimation
- CAP_
PVAPI_ DECIMATION_ 2OUTO F16 - 2 out of 16 decimation
- CAP_
PVAPI_ DECIMATION_ OFF - Off
- CAP_
PVAPI_ FSTRIGMODE_ FIXEDRATE - FixedRate
- CAP_
PVAPI_ FSTRIGMODE_ FREERUN - Freerun
- CAP_
PVAPI_ FSTRIGMODE_ SOFTWARE - Software
- CAP_
PVAPI_ FSTRIGMODE_ SYNCI N1 - SyncIn1
- CAP_
PVAPI_ FSTRIGMODE_ SYNCI N2 - SyncIn2
- CAP_
PVAPI_ PIXELFORMAT_ BAYE R8 - Bayer8
- CAP_
PVAPI_ PIXELFORMAT_ BAYE R16 - Bayer16
- CAP_
PVAPI_ PIXELFORMAT_ BGR24 - Bgr24
- CAP_
PVAPI_ PIXELFORMAT_ BGRA32 - Bgra32
- CAP_
PVAPI_ PIXELFORMAT_ MONO8 - Mono8
- CAP_
PVAPI_ PIXELFORMAT_ MONO16 - Mono16
- CAP_
PVAPI_ PIXELFORMAT_ RGB24 - Rgb24
- CAP_
PVAPI_ PIXELFORMAT_ RGBA32 - Rgba32
- CAP_QT
- QuickTime (obsolete, removed)
- CAP_
REALSENSE - Synonym for CAP_INTELPERC
- CAP_
UEYE - uEye Camera API
- CAP_
UNICAP - Unicap drivers (obsolete, removed)
- CAP_V4L
- V4L/V4L2 capturing support
- CAP_
V4L2 - Same as CAP_V4L
- CAP_VFW
- Video For Windows (obsolete, removed)
- CAP_
WINRT - Microsoft Windows Runtime using Media Foundation
- CAP_
XIAPI - XIMEA Camera API
- CAP_
XINE - XINE engine (Linux)
- CV__
CAP_ PROP_ LATEST - CV__
VIDEOWRITER_ PROP_ LATEST - VIDEOWRITER_
PROP_ DEPTH - Defaults to \ref CV_8U.
- VIDEOWRITER_
PROP_ DTS_ DELAY - Specifies the maximum difference between presentation (pts) and decompression timestamps (dts) using the FPS time base. This property is necessary only when encapsulating externally encoded video where the decoding order differs from the presentation order, such as in GOP patterns with bi-directional B-frames. The value should be calculated based on the specific GOP pattern used during encoding. For example, in a GOP with presentation order IBP and decoding order IPB, this value would be 1, as the B-frame is the second frame presented but the third to be decoded. It can be queried from the resulting encapsulated video file using VideoCapture::get(\ref CAP_PROP_DTS_DELAY). Non-zero values usually imply the stream is encoded using B-frames. FFmpeg back-end only.
- VIDEOWRITER_
PROP_ FRAMEBYTES - (Read-only): Size of just encoded video frame. Note that the encoding order may be different from representation order.
- VIDEOWRITER_
PROP_ HW_ ACCELERATION - (open-only) Hardware acceleration type (see #VideoAccelerationType). Setting supported only via
params
parameter in VideoWriter constructor / .open() method. Default value is backend-specific. - VIDEOWRITER_
PROP_ HW_ ACCELERATION_ USE_ OPENCL - (open-only) If non-zero, create new OpenCL context and bind it to current thread. The OpenCL context created with Video Acceleration context attached it (if not attached yet) for optimized GPU data copy between cv::UMat and HW accelerated encoder.
- VIDEOWRITER_
PROP_ HW_ DEVICE - (open-only) Hardware device index (select GPU if multiple available). Device enumeration is acceleration type specific.
- VIDEOWRITER_
PROP_ IS_ COLOR - If it is not zero, the encoder will expect and encode color frames, otherwise it will work with grayscale frames.
- VIDEOWRITER_
PROP_ KEY_ FLAG - Set to non-zero to signal that the following frames are key frames or zero if not, when encapsulating raw video (\ref VIDEOWRITER_PROP_RAW_VIDEO != 0). FFmpeg back-end only.
- VIDEOWRITER_
PROP_ KEY_ INTERVAL - (open-only) Set the key frame interval using raw video encapsulation (\ref VIDEOWRITER_PROP_RAW_VIDEO != 0). Defaults to 1 when not set. FFmpeg back-end only.
- VIDEOWRITER_
PROP_ NSTRIPES - Number of stripes for parallel encoding. -1 for auto detection.
- VIDEOWRITER_
PROP_ PTS - Specifies the frame presentation timestamp for each frame using the FPS time base. This property is only necessary when encapsulating externally encoded video where the decoding order differs from the presentation order, such as in GOP patterns with bi-directional B-frames. The value should be provided by your external encoder and for video sources with fixed frame rates it is equivalent to dividing the current frame’s presentation time (\ref CAP_PROP_POS_MSEC) by the frame duration (1000.0 / VideoCapture::get(\ref CAP_PROP_FPS)). It can be queried from the resulting encapsulated video file using VideoCapture::get(\ref CAP_PROP_PTS). FFmpeg back-end only.
- VIDEOWRITER_
PROP_ QUALITY - Current quality (0..100%) of the encoded videostream. Can be adjusted dynamically in some codecs.
- VIDEOWRITER_
PROP_ RAW_ VIDEO - (open-only) Set to non-zero to enable encapsulation of an encoded raw video stream. Each raw encoded video frame should be passed to VideoWriter::write() as single row or column of a \ref CV_8UC1 Mat. \note If the key frame interval is not 1 then it must be manually specified by the user. This can either be performed during initialization passing \ref VIDEOWRITER_PROP_KEY_INTERVAL as one of the extra encoder params to \ref VideoWriter::VideoWriter(const String &, int, double, const Size &, const std::vector< int > ¶ms) or afterwards by setting the \ref VIDEOWRITER_PROP_KEY_FLAG with \ref VideoWriter::set() before writing each frame. FFMpeg backend only.
- VIDEO_
ACCELERATION_ ANY - Prefer to use H/W acceleration. If no one supported, then fallback to software processing.
- VIDEO_
ACCELERATION_ D3D11 - DirectX 11
- VIDEO_
ACCELERATION_ MFX - libmfx (Intel MediaSDK/oneVPL)
- 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_ VAAPI - VAAPI
Traits§
- IStream
Reader Trait - Mutable methods for crate::videoio::IStreamReader
- IStream
Reader Trait Const - Constant methods for crate::videoio::IStreamReader
- Video
Capture Trait - Mutable methods for crate::videoio::VideoCapture
- Video
Capture Trait Const - Constant methods for crate::videoio::VideoCapture
- Video
Writer Trait - Mutable methods for crate::videoio::VideoWriter
- Video
Writer Trait Const - Constant methods for crate::videoio::VideoWriter
Functions§
- get_
backend_ name - Returns backend API name or “UnknownVideoAPI(xxx)”
- get_
backends - Returns list of all available backends
- get_
camera_ backend_ plugin_ version - Returns description and ABI/API version of videoio plugin’s camera interface
- get_
camera_ backends - Returns list of available backends which works via
cv::VideoCapture(int index)
- get_
stream_ backend_ plugin_ version - Returns description and ABI/API version of videoio plugin’s stream capture interface
- get_
stream_ backends - Returns list of available backends which works via
cv::VideoCapture(filename)
- get_
stream_ buffered_ backend_ plugin_ version - Returns description and ABI/API version of videoio plugin’s buffer capture interface
- get_
stream_ buffered_ backends - Returns list of available backends which works via
cv::VideoCapture(buffer)
- get_
writer_ backend_ plugin_ version - Returns description and ABI/API version of videoio plugin’s writer interface
- get_
writer_ backends - Returns list of available backends which works via
cv::VideoWriter()
- has_
backend - Returns true if backend is available
- is_
backend_ built_ in - Returns true if backend is built in (false if backend is used as plugin)