Enum opencv::videoio::VideoCaptureProperties

#[repr(C)]pub enum VideoCaptureProperties {
    CAP_PROP_POS_MSEC,
    CAP_PROP_POS_FRAMES,
    CAP_PROP_POS_AVI_RATIO,
    CAP_PROP_FRAME_WIDTH,
    CAP_PROP_FRAME_HEIGHT,
    CAP_PROP_FPS,
    CAP_PROP_FOURCC,
    CAP_PROP_FRAME_COUNT,
    CAP_PROP_FORMAT,
    CAP_PROP_MODE,
    CAP_PROP_BRIGHTNESS,
    CAP_PROP_CONTRAST,
    CAP_PROP_SATURATION,
    CAP_PROP_HUE,
    CAP_PROP_GAIN,
    CAP_PROP_EXPOSURE,
    CAP_PROP_CONVERT_RGB,
    CAP_PROP_WHITE_BALANCE_BLUE_U,
    CAP_PROP_RECTIFICATION,
    CAP_PROP_MONOCHROME,
    CAP_PROP_SHARPNESS,
    CAP_PROP_AUTO_EXPOSURE,
    CAP_PROP_GAMMA,
    CAP_PROP_TEMPERATURE,
    CAP_PROP_TRIGGER,
    CAP_PROP_TRIGGER_DELAY,
    CAP_PROP_WHITE_BALANCE_RED_V,
    CAP_PROP_ZOOM,
    CAP_PROP_FOCUS,
    CAP_PROP_GUID,
    CAP_PROP_ISO_SPEED,
    CAP_PROP_BACKLIGHT,
    CAP_PROP_PAN,
    CAP_PROP_TILT,
    CAP_PROP_ROLL,
    CAP_PROP_IRIS,
    CAP_PROP_SETTINGS,
    CAP_PROP_BUFFERSIZE,
    CAP_PROP_AUTOFOCUS,
    CAP_PROP_SAR_NUM,
    CAP_PROP_SAR_DEN,
    CAP_PROP_BACKEND,
    CAP_PROP_CHANNEL,
    CAP_PROP_AUTO_WB,
    CAP_PROP_WB_TEMPERATURE,
    CAP_PROP_CODEC_PIXEL_FORMAT,
    CAP_PROP_BITRATE,
    CAP_PROP_ORIENTATION_META,
    CAP_PROP_ORIENTATION_AUTO,
    CV__CAP_PROP_LATEST,
}

%VideoCapture generic properties identifier.

Reading / writing properties involves many layers. Some unexpected result might happens along this chain. Effective behaviour depends from device hardware, driver and API Backend.

See also

videoio_flags_others, VideoCapture::get(), VideoCapture::set()

Variants

CAP_PROP_POS_MSEC

Current position of the video file in milliseconds.

CAP_PROP_POS_FRAMES

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

CAP_PROP_POS_AVI_RATIO

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

CAP_PROP_FRAME_WIDTH

Width of the frames in the video stream.

CAP_PROP_FRAME_HEIGHT

Height of the frames in the video stream.

CAP_PROP_FPS

Frame rate.

CAP_PROP_FOURCC

4-character code of codec. see VideoWriter::fourcc .

CAP_PROP_FRAME_COUNT

Number of frames in the video file.

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_MODE

Backend-specific value indicating the current capture mode.

CAP_PROP_BRIGHTNESS

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

CAP_PROP_CONTRAST

Contrast of the image (only for cameras).

CAP_PROP_SATURATION

Saturation of the image (only for cameras).

CAP_PROP_HUE

Hue of the image (only for cameras).

CAP_PROP_GAIN

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

CAP_PROP_EXPOSURE

Exposure (only for those cameras that support).

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_WHITE_BALANCE_BLUE_U

Currently unsupported.

CAP_PROP_RECTIFICATION

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

CAP_PROP_MONOCHROME

CAP_PROP_SHARPNESS

CAP_PROP_AUTO_EXPOSURE

DC1394: exposure control done by camera, user can adjust reference level using this feature.

CAP_PROP_GAMMA

CAP_PROP_TEMPERATURE

CAP_PROP_TRIGGER

CAP_PROP_TRIGGER_DELAY

CAP_PROP_WHITE_BALANCE_RED_V

CAP_PROP_ZOOM

CAP_PROP_FOCUS

CAP_PROP_GUID

CAP_PROP_ISO_SPEED

CAP_PROP_BACKLIGHT

CAP_PROP_PAN

CAP_PROP_TILT

CAP_PROP_ROLL

CAP_PROP_IRIS

CAP_PROP_SETTINGS

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

CAP_PROP_BUFFERSIZE

CAP_PROP_AUTOFOCUS

CAP_PROP_SAR_NUM

Sample aspect ratio: num/den (num)

CAP_PROP_SAR_DEN

Sample aspect ratio: num/den (den)

CAP_PROP_BACKEND

Current backend (enum VideoCaptureAPIs). Read-only property

CAP_PROP_CHANNEL

Video input or Channel Number (only for those cameras that support)

CAP_PROP_AUTO_WB

enable/ disable auto white-balance

CAP_PROP_WB_TEMPERATURE

white-balance color temperature

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_BITRATE

(read-only) Video bitrate in kbits/s

CAP_PROP_ORIENTATION_META

(read-only) Frame rotation defined by stream meta (applicable for FFmpeg back-end only)

CAP_PROP_ORIENTATION_AUTO

if true - rotates output frames of CvCapture considering video file’s metadata (applicable for FFmpeg back-end only) (https://github.com/opencv/opencv/issues/15499)

CV__CAP_PROP_LATEST

Trait Implementations

impl Clone for VideoCaptureProperties

fn clone(&self) -> VideoCaptureProperties

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for VideoCaptureProperties

impl Debug for VideoCaptureProperties

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<VideoCaptureProperties> for VideoCaptureProperties

fn eq(&self, other: &VideoCaptureProperties) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl StructuralPartialEq for VideoCaptureProperties