Skip to content

VideoCaptureAPIs

videoioclassOpenCV 5.0.0
import { VideoCaptureAPIs } from '@banou/opencv-wasm'

Use after await initOpenCV(). See the initialization and named imports guide.

ARGUMENTSConstructor or factory
CLASSVideoCaptureAPIs
RETURN TYPEOwned native handle
Call structure. A void return can still write to destination arguments. The parameter descriptions define inputs, outputs and ownership.

Native object: release it with using or delete(). Factories can return null; check before calling methods.

cv::VideoCapture API backends identifier.

Select preferred API for a capture object. To be used in the VideoCapture::VideoCapture() constructor or VideoCapture::open()

Note: - Backends are available only if they have been built with your OpenCV binaries. See videoio_overview for more information.

Constructors and members

static CAP_ANY

Auto detect == 0

CAP_ANY: VideoCaptureAPIsValue<0>,

static CAP_V4L

Same as CAP_V4L

CAP_V4L: VideoCaptureAPIsValue<200>,

static CAP_V4L2

Same as CAP_V4L

CAP_V4L2: VideoCaptureAPIsValue<200>,

static CAP_FIREWIRE

Same value as CAP_FIREWIRE

CAP_FIREWIRE: VideoCaptureAPIsValue<300>,

static CAP_FIREWARE

Same value as CAP_FIREWIRE

CAP_FIREWARE: VideoCaptureAPIsValue<300>,

static CAP_IEEE1394

Same value as CAP_FIREWIRE

CAP_IEEE1394: VideoCaptureAPIsValue<300>,

static CAP_DC1394

Same value as CAP_FIREWIRE

CAP_DC1394: VideoCaptureAPIsValue<300>,

static CAP_CMU1394

Same value as CAP_FIREWIRE

CAP_CMU1394: VideoCaptureAPIsValue<300>,

static CAP_DSHOW

DirectShow (via videoInput)

CAP_DSHOW: VideoCaptureAPIsValue<700>,

static CAP_PVAPI

PvAPI, Prosilica GigE SDK

CAP_PVAPI: VideoCaptureAPIsValue<800>,

static CAP_ANDROID

MediaNDK (API Level 21+) and NDK Camera (API level 24+) for Android

CAP_ANDROID: VideoCaptureAPIsValue<1000>,

static CAP_XIAPI

XIMEA Camera API

CAP_XIAPI: VideoCaptureAPIsValue<1100>,

static CAP_AVFOUNDATION

AVFoundation framework for iOS (OS X Lion will have the same API)

CAP_AVFOUNDATION: VideoCaptureAPIsValue<1200>,

static CAP_MSMF

Microsoft Media Foundation (via videoInput). See platform specific notes above.

CAP_MSMF: VideoCaptureAPIsValue<1400>,

static CAP_WINRT

Microsoft Windows Runtime using Media Foundation

CAP_WINRT: VideoCaptureAPIsValue<1410>,

static CAP_INTELPERC

Synonym for CAP_INTELPERC

CAP_INTELPERC: VideoCaptureAPIsValue<1500>,

static CAP_REALSENSE

Synonym for CAP_INTELPERC

CAP_REALSENSE: VideoCaptureAPIsValue<1500>,

static CAP_OPENNI2

OpenNI2 (for Kinect)

CAP_OPENNI2: VideoCaptureAPIsValue<1600>,

static CAP_OPENNI2_ASUS

OpenNI2 (for Asus Xtion and Occipital Structure sensors)

CAP_OPENNI2_ASUS: VideoCaptureAPIsValue<1610>,

static CAP_OPENNI2_ASTRA

OpenNI2 (for Orbbec Astra)

CAP_OPENNI2_ASTRA: VideoCaptureAPIsValue<1620>,

static CAP_GPHOTO2

gPhoto2 connection

CAP_GPHOTO2: VideoCaptureAPIsValue<1700>,

static CAP_GSTREAMER

VideoCaptureAPIs.CAP_GSTREAMER: GStreamer

CAP_GSTREAMER: VideoCaptureAPIsValue<1800>,

static CAP_FFMPEG

Open and record video file or stream using the FFMPEG library

CAP_FFMPEG: VideoCaptureAPIsValue<1900>,

static CAP_IMAGES

OpenCV Image Sequence (e.g. img_%02d.jpg)

CAP_IMAGES: VideoCaptureAPIsValue<2000>,

static CAP_ARAVIS

VideoCaptureAPIs.CAP_ARAVIS: Aravis SDK

CAP_ARAVIS: VideoCaptureAPIsValue<2100>,

static CAP_OPENCV_MJPEG

Built-in OpenCV MotionJPEG codec

CAP_OPENCV_MJPEG: VideoCaptureAPIsValue<2200>,

static CAP_INTEL_MFX

VideoCaptureAPIs.CAP_INTEL_MFX: Intel MediaSDK

CAP_INTEL_MFX: VideoCaptureAPIsValue<2300>,

static CAP_XINE

XINE engine (Linux)

CAP_XINE: VideoCaptureAPIsValue<2400>,

static CAP_UEYE

uEye Camera API

CAP_UEYE: VideoCaptureAPIsValue<2500>,

static CAP_OBSENSOR

For Orbbec 3D-Sensor device/module (Astra+, Femto, Astra2, Gemini2, Gemini2L, Gemini2XL, Gemini330, 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: VideoCaptureAPIsValue<2600>

These signatures describe this package. Upstream documentation can mention optional backends that are absent from this build. Check runtime compatibility before choosing a backend or file format.