OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper Interface Reference

Base interface for converting various sources to Mat. More...

Public Member Functions
bool	DidUpdateThisFrame ()
	Gets whether the frame was updated in the current frame.
void	Dispose ()
	Disposes of resources.
Source2MatHelperColorFormat	GetBaseColorFormat ()
	Gets the base color format.
string	GetDeviceName ()
	Gets the device name.
int	GetHeight ()
	Gets the height of the frame.
Mat	GetMat ()
	Gets the current Mat.
int	GetWidth ()
	Gets the width of the frame.
void	Initialize (bool autoPlay)
	Initializes the helper with the specified auto-play setting.
bool	IsInitialized ()
	Gets whether the helper is initialized.
bool	IsPaused ()
	Gets whether playback is paused.
bool	IsPlaying ()
	Gets whether playback is active.
void	Pause ()
	Pauses playback.
void	Play ()
	Starts playing.
void	Stop ()
	Stops playback.

Properties
UnityEvent	onDisposed [get, set]
	Gets or sets the event that is invoked when resources are disposed.
Source2MatHelperErrorUnityEvent	onErrorOccurred [get, set]
	Gets or sets the event that is invoked when an error occurs.
UnityEvent	onInitialized [get, set]
	Gets or sets the event that is invoked when initialization is complete.
Source2MatHelperColorFormat	outputColorFormat [get, set]
	Gets or sets the output color format.
int	timeoutFrameCount [get, set]
	Gets or sets the timeout frame count.

Detailed Description

Base interface for converting various sources to Mat.

Member Function Documentation

DidUpdateThisFrame()

bool OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.DidUpdateThisFrame

(

)

Gets whether the frame was updated in the current frame.

Returns

True if updated

Implemented in OpenCVForUnity.UnityUtils.Helper.AsyncGPUReadback2MatHelper, OpenCVForUnity.UnityUtils.Helper.Image2MatHelper, OpenCVForUnity.UnityUtils.Helper.MultiSource2MatHelper, OpenCVForUnity.UnityUtils.Helper.UnityVideoPlayer2MatHelper, OpenCVForUnity.UnityUtils.Helper.VideoCapture2MatHelper, OpenCVForUnity.UnityUtils.Helper.WebCamTexture2MatAsyncGPUHelper, and OpenCVForUnity.UnityUtils.Helper.WebCamTexture2MatHelper.

Dispose()

void OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.Dispose

(

)

Disposes of resources.

Implemented in OpenCVForUnity.UnityUtils.Helper.AsyncGPUReadback2MatHelper, OpenCVForUnity.UnityUtils.Helper.Image2MatHelper, OpenCVForUnity.UnityUtils.Helper.MultiSource2MatHelper, OpenCVForUnity.UnityUtils.Helper.UnityVideoPlayer2MatHelper, OpenCVForUnity.UnityUtils.Helper.VideoCapture2MatHelper, OpenCVForUnity.UnityUtils.Helper.WebCamTexture2MatAsyncGPUHelper, and OpenCVForUnity.UnityUtils.Helper.WebCamTexture2MatHelper.

GetBaseColorFormat()

Source2MatHelperColorFormat OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.GetBaseColorFormat

(

)

Gets the base color format.

Returns

The base color format

Implemented in OpenCVForUnity.UnityUtils.Helper.AsyncGPUReadback2MatHelper, OpenCVForUnity.UnityUtils.Helper.Image2MatHelper, OpenCVForUnity.UnityUtils.Helper.MultiSource2MatHelper, OpenCVForUnity.UnityUtils.Helper.UnityVideoPlayer2MatHelper, OpenCVForUnity.UnityUtils.Helper.VideoCapture2MatHelper, and OpenCVForUnity.UnityUtils.Helper.WebCamTexture2MatHelper.

GetDeviceName()

string OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.GetDeviceName

(

)

Gets the device name.

Returns

The device name

Implemented in OpenCVForUnity.UnityUtils.Helper.AsyncGPUReadback2MatHelper, OpenCVForUnity.UnityUtils.Helper.Image2MatHelper, OpenCVForUnity.UnityUtils.Helper.MultiSource2MatHelper, OpenCVForUnity.UnityUtils.Helper.UnityVideoPlayer2MatHelper, OpenCVForUnity.UnityUtils.Helper.VideoCapture2MatHelper, and OpenCVForUnity.UnityUtils.Helper.WebCamTexture2MatHelper.

GetHeight()

int OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.GetHeight

(

)

Gets the height of the frame.

Returns

The height

Implemented in OpenCVForUnity.UnityUtils.Helper.AsyncGPUReadback2MatHelper, OpenCVForUnity.UnityUtils.Helper.Image2MatHelper, OpenCVForUnity.UnityUtils.Helper.MultiSource2MatHelper, OpenCVForUnity.UnityUtils.Helper.UnityVideoPlayer2MatHelper, OpenCVForUnity.UnityUtils.Helper.VideoCapture2MatHelper, and OpenCVForUnity.UnityUtils.Helper.WebCamTexture2MatHelper.

GetMat()

Mat OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.GetMat

(

)

Gets the current Mat.

Returns

The current Mat

Implemented in OpenCVForUnity.UnityUtils.Helper.AsyncGPUReadback2MatHelper, OpenCVForUnity.UnityUtils.Helper.Image2MatHelper, OpenCVForUnity.UnityUtils.Helper.MultiSource2MatHelper, OpenCVForUnity.UnityUtils.Helper.UnityVideoPlayer2MatHelper, OpenCVForUnity.UnityUtils.Helper.VideoCapture2MatHelper, OpenCVForUnity.UnityUtils.Helper.WebCamTexture2MatAsyncGPUHelper, and OpenCVForUnity.UnityUtils.Helper.WebCamTexture2MatHelper.

GetWidth()

int OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.GetWidth

(

)

Gets the width of the frame.

Returns

The width

Implemented in OpenCVForUnity.UnityUtils.Helper.AsyncGPUReadback2MatHelper, OpenCVForUnity.UnityUtils.Helper.Image2MatHelper, OpenCVForUnity.UnityUtils.Helper.MultiSource2MatHelper, OpenCVForUnity.UnityUtils.Helper.UnityVideoPlayer2MatHelper, OpenCVForUnity.UnityUtils.Helper.VideoCapture2MatHelper, and OpenCVForUnity.UnityUtils.Helper.WebCamTexture2MatHelper.

Initialize()

void OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.Initialize

(

bool

autoPlay

)

Initializes the helper with the specified auto-play setting.

Parameters

autoPlay

Whether to automatically start playing

Implemented in OpenCVForUnity.UnityUtils.Helper.AsyncGPUReadback2MatHelper, OpenCVForUnity.UnityUtils.Helper.Image2MatHelper, OpenCVForUnity.UnityUtils.Helper.MultiSource2MatHelper, OpenCVForUnity.UnityUtils.Helper.UnityVideoPlayer2MatHelper, OpenCVForUnity.UnityUtils.Helper.VideoCapture2MatHelper, and OpenCVForUnity.UnityUtils.Helper.WebCamTexture2MatHelper.

IsInitialized()

bool OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.IsInitialized

(

)

Gets whether the helper is initialized.

Returns

True if initialized

Implemented in OpenCVForUnity.UnityUtils.Helper.AsyncGPUReadback2MatHelper, OpenCVForUnity.UnityUtils.Helper.Image2MatHelper, OpenCVForUnity.UnityUtils.Helper.MultiSource2MatHelper, OpenCVForUnity.UnityUtils.Helper.UnityVideoPlayer2MatHelper, OpenCVForUnity.UnityUtils.Helper.VideoCapture2MatHelper, and OpenCVForUnity.UnityUtils.Helper.WebCamTexture2MatHelper.

IsPaused()

bool OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.IsPaused

(

)

Gets whether playback is paused.

Returns

True if paused

Implemented in OpenCVForUnity.UnityUtils.Helper.AsyncGPUReadback2MatHelper, OpenCVForUnity.UnityUtils.Helper.Image2MatHelper, OpenCVForUnity.UnityUtils.Helper.MultiSource2MatHelper, OpenCVForUnity.UnityUtils.Helper.UnityVideoPlayer2MatHelper, OpenCVForUnity.UnityUtils.Helper.VideoCapture2MatHelper, and OpenCVForUnity.UnityUtils.Helper.WebCamTexture2MatHelper.

IsPlaying()

bool OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.IsPlaying

(

)

Gets whether playback is active.

Returns

True if playing

Implemented in OpenCVForUnity.UnityUtils.Helper.AsyncGPUReadback2MatHelper, OpenCVForUnity.UnityUtils.Helper.Image2MatHelper, OpenCVForUnity.UnityUtils.Helper.MultiSource2MatHelper, OpenCVForUnity.UnityUtils.Helper.UnityVideoPlayer2MatHelper, OpenCVForUnity.UnityUtils.Helper.VideoCapture2MatHelper, and OpenCVForUnity.UnityUtils.Helper.WebCamTexture2MatHelper.

Pause()

void OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.Pause

(

)

Pauses playback.

Implemented in OpenCVForUnity.UnityUtils.Helper.AsyncGPUReadback2MatHelper, OpenCVForUnity.UnityUtils.Helper.Image2MatHelper, OpenCVForUnity.UnityUtils.Helper.MultiSource2MatHelper, OpenCVForUnity.UnityUtils.Helper.UnityVideoPlayer2MatHelper, OpenCVForUnity.UnityUtils.Helper.VideoCapture2MatHelper, OpenCVForUnity.UnityUtils.Helper.WebCamTexture2MatAsyncGPUHelper, and OpenCVForUnity.UnityUtils.Helper.WebCamTexture2MatHelper.

Play()

void OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.Play

(

)

Starts playing.

Implemented in OpenCVForUnity.UnityUtils.Helper.AsyncGPUReadback2MatHelper, OpenCVForUnity.UnityUtils.Helper.Image2MatHelper, OpenCVForUnity.UnityUtils.Helper.MultiSource2MatHelper, OpenCVForUnity.UnityUtils.Helper.UnityVideoPlayer2MatHelper, OpenCVForUnity.UnityUtils.Helper.VideoCapture2MatHelper, OpenCVForUnity.UnityUtils.Helper.WebCamTexture2MatAsyncGPUHelper, and OpenCVForUnity.UnityUtils.Helper.WebCamTexture2MatHelper.

Stop()

void OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.Stop

(

)

Stops playback.

Implemented in OpenCVForUnity.UnityUtils.Helper.AsyncGPUReadback2MatHelper, OpenCVForUnity.UnityUtils.Helper.Image2MatHelper, OpenCVForUnity.UnityUtils.Helper.MultiSource2MatHelper, OpenCVForUnity.UnityUtils.Helper.UnityVideoPlayer2MatHelper, OpenCVForUnity.UnityUtils.Helper.VideoCapture2MatHelper, OpenCVForUnity.UnityUtils.Helper.WebCamTexture2MatAsyncGPUHelper, and OpenCVForUnity.UnityUtils.Helper.WebCamTexture2MatHelper.

Property Documentation

onDisposed

UnityEvent OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.onDisposed

getset

Gets or sets the event that is invoked when resources are disposed.

Implemented in OpenCVForUnity.UnityUtils.Helper.AsyncGPUReadback2MatHelper, OpenCVForUnity.UnityUtils.Helper.Image2MatHelper, OpenCVForUnity.UnityUtils.Helper.MultiSource2MatHelper, OpenCVForUnity.UnityUtils.Helper.UnityVideoPlayer2MatHelper, OpenCVForUnity.UnityUtils.Helper.VideoCapture2MatHelper, and OpenCVForUnity.UnityUtils.Helper.WebCamTexture2MatHelper.

onErrorOccurred

Source2MatHelperErrorUnityEvent OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.onErrorOccurred

getset

Gets or sets the event that is invoked when an error occurs.

Implemented in OpenCVForUnity.UnityUtils.Helper.AsyncGPUReadback2MatHelper, OpenCVForUnity.UnityUtils.Helper.Image2MatHelper, OpenCVForUnity.UnityUtils.Helper.MultiSource2MatHelper, OpenCVForUnity.UnityUtils.Helper.UnityVideoPlayer2MatHelper, OpenCVForUnity.UnityUtils.Helper.VideoCapture2MatHelper, and OpenCVForUnity.UnityUtils.Helper.WebCamTexture2MatHelper.

onInitialized

UnityEvent OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.onInitialized

getset

Gets or sets the event that is invoked when initialization is complete.

Implemented in OpenCVForUnity.UnityUtils.Helper.AsyncGPUReadback2MatHelper, OpenCVForUnity.UnityUtils.Helper.Image2MatHelper, OpenCVForUnity.UnityUtils.Helper.MultiSource2MatHelper, OpenCVForUnity.UnityUtils.Helper.UnityVideoPlayer2MatHelper, OpenCVForUnity.UnityUtils.Helper.VideoCapture2MatHelper, and OpenCVForUnity.UnityUtils.Helper.WebCamTexture2MatHelper.

outputColorFormat

Source2MatHelperColorFormat OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.outputColorFormat

getset

Gets or sets the output color format.

Implemented in OpenCVForUnity.UnityUtils.Helper.AsyncGPUReadback2MatHelper, OpenCVForUnity.UnityUtils.Helper.Image2MatHelper, OpenCVForUnity.UnityUtils.Helper.MultiSource2MatHelper, OpenCVForUnity.UnityUtils.Helper.UnityVideoPlayer2MatHelper, OpenCVForUnity.UnityUtils.Helper.VideoCapture2MatHelper, and OpenCVForUnity.UnityUtils.Helper.WebCamTexture2MatHelper.

timeoutFrameCount

int OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.timeoutFrameCount

getset

Gets or sets the timeout frame count.

Implemented in OpenCVForUnity.UnityUtils.Helper.AsyncGPUReadback2MatHelper, OpenCVForUnity.UnityUtils.Helper.Image2MatHelper, OpenCVForUnity.UnityUtils.Helper.MultiSource2MatHelper, OpenCVForUnity.UnityUtils.Helper.UnityVideoPlayer2MatHelper, OpenCVForUnity.UnityUtils.Helper.VideoCapture2MatHelper, and OpenCVForUnity.UnityUtils.Helper.WebCamTexture2MatHelper.

---

The documentation for this interface was generated from the following file:

• OpenCVForUnity/Assets/OpenCVForUnity/org/opencv/_unity/Helper/Source2MatHelper/ISource2MatHelper.cs