OpenCV  4.5.4-dev
Open Source Computer Vision
Functions
Query I/O API backends registry

Functions

cv::String cv::videoio_registry::getBackendName (VideoCaptureAPIs api)
 Returns backend API name or "UnknownVideoAPI(xxx)". More...
 
std::vector< VideoCaptureAPIscv::videoio_registry::getBackends ()
 Returns list of all available backends. More...
 
std::string cv::videoio_registry::getCameraBackendPluginVersion (VideoCaptureAPIs api, int &version_ABI, int &version_API)
 Returns description and ABI/API version of videoio plugin's camera interface. More...
 
std::vector< VideoCaptureAPIscv::videoio_registry::getCameraBackends ()
 Returns list of available backends which works via cv::VideoCapture(int index) More...
 
std::string cv::videoio_registry::getStreamBackendPluginVersion (VideoCaptureAPIs api, int &version_ABI, int &version_API)
 Returns description and ABI/API version of videoio plugin's stream capture interface. More...
 
std::vector< VideoCaptureAPIscv::videoio_registry::getStreamBackends ()
 Returns list of available backends which works via cv::VideoCapture(filename) More...
 
std::string cv::videoio_registry::getWriterBackendPluginVersion (VideoCaptureAPIs api, int &version_ABI, int &version_API)
 Returns description and ABI/API version of videoio plugin's writer interface. More...
 
std::vector< VideoCaptureAPIscv::videoio_registry::getWriterBackends ()
 Returns list of available backends which works via cv::VideoWriter() More...
 
bool cv::videoio_registry::hasBackend (VideoCaptureAPIs api)
 Returns true if backend is available. More...
 
bool cv::videoio_registry::isBackendBuiltIn (VideoCaptureAPIs api)
 Returns true if backend is built in (false if backend is used as plugin) More...
 

Detailed Description

This section contains API description how to query/configure available Video I/O backends.

Runtime configuration options:

Function Documentation

◆ getBackendName()

cv::String cv::videoio_registry::getBackendName ( VideoCaptureAPIs  api)
Python:
cv.videoio_registry.getBackendName(api) -> retval

#include <opencv2/videoio/registry.hpp>

Returns backend API name or "UnknownVideoAPI(xxx)".

Parameters
apibackend ID (VideoCaptureAPIs)

◆ getBackends()

std::vector<VideoCaptureAPIs> cv::videoio_registry::getBackends ( )
Python:
cv.videoio_registry.getBackends() -> retval

#include <opencv2/videoio/registry.hpp>

Returns list of all available backends.

◆ getCameraBackendPluginVersion()

std::string cv::videoio_registry::getCameraBackendPluginVersion ( VideoCaptureAPIs  api,
int &  version_ABI,
int &  version_API 
)
Python:
cv.videoio_registry.getCameraBackendPluginVersion(api) -> retval, version_ABI, version_API

#include <opencv2/videoio/registry.hpp>

Returns description and ABI/API version of videoio plugin's camera interface.

◆ getCameraBackends()

std::vector<VideoCaptureAPIs> cv::videoio_registry::getCameraBackends ( )
Python:
cv.videoio_registry.getCameraBackends() -> retval

#include <opencv2/videoio/registry.hpp>

Returns list of available backends which works via cv::VideoCapture(int index)

◆ getStreamBackendPluginVersion()

std::string cv::videoio_registry::getStreamBackendPluginVersion ( VideoCaptureAPIs  api,
int &  version_ABI,
int &  version_API 
)
Python:
cv.videoio_registry.getStreamBackendPluginVersion(api) -> retval, version_ABI, version_API

#include <opencv2/videoio/registry.hpp>

Returns description and ABI/API version of videoio plugin's stream capture interface.

◆ getStreamBackends()

std::vector<VideoCaptureAPIs> cv::videoio_registry::getStreamBackends ( )
Python:
cv.videoio_registry.getStreamBackends() -> retval

#include <opencv2/videoio/registry.hpp>

Returns list of available backends which works via cv::VideoCapture(filename)

◆ getWriterBackendPluginVersion()

std::string cv::videoio_registry::getWriterBackendPluginVersion ( VideoCaptureAPIs  api,
int &  version_ABI,
int &  version_API 
)
Python:
cv.videoio_registry.getWriterBackendPluginVersion(api) -> retval, version_ABI, version_API

#include <opencv2/videoio/registry.hpp>

Returns description and ABI/API version of videoio plugin's writer interface.

◆ getWriterBackends()

std::vector<VideoCaptureAPIs> cv::videoio_registry::getWriterBackends ( )
Python:
cv.videoio_registry.getWriterBackends() -> retval

#include <opencv2/videoio/registry.hpp>

Returns list of available backends which works via cv::VideoWriter()

◆ hasBackend()

bool cv::videoio_registry::hasBackend ( VideoCaptureAPIs  api)
Python:
cv.videoio_registry.hasBackend(api) -> retval

#include <opencv2/videoio/registry.hpp>

Returns true if backend is available.

◆ isBackendBuiltIn()

bool cv::videoio_registry::isBackendBuiltIn ( VideoCaptureAPIs  api)
Python:
cv.videoio_registry.isBackendBuiltIn(api) -> retval

#include <opencv2/videoio/registry.hpp>

Returns true if backend is built in (false if backend is used as plugin)