View Source Evision.VideoIORegistry (Evision v0.1.21)

Link to this section Summary

Types

t()

Type that represents an Evision.VideoIORegistry struct.

Functions

Returns backend API name or "UnknownVideoAPI(xxx)"

Returns list of all available backends

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

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

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

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

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

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

Returns true if backend is available

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

Link to this section Types

@type t() :: %Evision.VideoIORegistry{ref: reference()}

Type that represents an Evision.VideoIORegistry struct.

  • ref. reference()

    The underlying erlang resource variable.

Link to this section Functions

@spec getBackendName([number()]) :: binary() | {:error, String.t()}

Returns backend API name or "UnknownVideoAPI(xxx)"

Positional Arguments
  • api: VideoCaptureAPIs.

    backend ID (#VideoCaptureAPIs)

Return

Python prototype (for reference only):

getBackendName(api) -> retval
@spec getBackends() :: [[number()]] | {:error, String.t()}

Returns list of all available backends

Return
  • retval: std::vector<VideoCaptureAPIs>

Python prototype (for reference only):

getBackends() -> retval
Link to this function

getCameraBackendPluginVersion(api)

View Source
@spec getCameraBackendPluginVersion([number()]) ::
  {binary(), integer(), integer()} | {:error, String.t()}

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

Positional Arguments
  • api: VideoCaptureAPIs
Return
  • retval: String
  • version_ABI: int
  • version_API: int

Python prototype (for reference only):

getCameraBackendPluginVersion(api) -> retval, version_ABI, version_API
@spec getCameraBackends() :: [[number()]] | {:error, String.t()}

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

Return
  • retval: std::vector<VideoCaptureAPIs>

Python prototype (for reference only):

getCameraBackends() -> retval
Link to this function

getStreamBackendPluginVersion(api)

View Source
@spec getStreamBackendPluginVersion([number()]) ::
  {binary(), integer(), integer()} | {:error, String.t()}

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

Positional Arguments
  • api: VideoCaptureAPIs
Return
  • retval: String
  • version_ABI: int
  • version_API: int

Python prototype (for reference only):

getStreamBackendPluginVersion(api) -> retval, version_ABI, version_API
@spec getStreamBackends() :: [[number()]] | {:error, String.t()}

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

Return
  • retval: std::vector<VideoCaptureAPIs>

Python prototype (for reference only):

getStreamBackends() -> retval
Link to this function

getWriterBackendPluginVersion(api)

View Source
@spec getWriterBackendPluginVersion([number()]) ::
  {binary(), integer(), integer()} | {:error, String.t()}

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

Positional Arguments
  • api: VideoCaptureAPIs
Return
  • retval: String
  • version_ABI: int
  • version_API: int

Python prototype (for reference only):

getWriterBackendPluginVersion(api) -> retval, version_ABI, version_API
@spec getWriterBackends() :: [[number()]] | {:error, String.t()}

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

Return
  • retval: std::vector<VideoCaptureAPIs>

Python prototype (for reference only):

getWriterBackends() -> retval
@spec hasBackend([number()]) :: boolean() | {:error, String.t()}

Returns true if backend is available

Positional Arguments
  • api: VideoCaptureAPIs
Return
  • retval: bool

Python prototype (for reference only):

hasBackend(api) -> retval
@spec isBackendBuiltIn([number()]) :: boolean() | {:error, String.t()}

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

Positional Arguments
  • api: VideoCaptureAPIs
Return
  • retval: bool

Python prototype (for reference only):

isBackendBuiltIn(api) -> retval