OpenCVForUnity.UnityUtils.Helper.IVideoSource2MatHelper Interface Reference

Interface to provide conversion from video source to Mat. More...

Public Member Functions
float	GetFPS ()
	Gets the current frame rate (FPS).
int	GetFrameCount ()
	Gets the total frame count.
int	GetFrameIndex ()
	Gets the current frame index.
float	GetFramePosRatio ()
	Gets the current frame position ratio.
void	SetFrameIndex (int index)
	Sets the frame index.
void	SetFramePosRatio (float ratio)
	Sets the frame position ratio.
Public Member Functions inherited from OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper
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
bool	loop [get, set]
	Gets or sets whether to loop the video.
string	requestedVideoFilePath [get, set]
	Gets or sets the requested video file path.
Properties inherited from OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper
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

Interface to provide conversion from video source to Mat.

Member Function Documentation

GetFPS()

float OpenCVForUnity.UnityUtils.Helper.IVideoSource2MatHelper.GetFPS

(

)

Gets the current frame rate (FPS).

Returns

The current FPS

Implemented in OpenCVForUnity.UnityUtils.Helper.UnityVideoPlayer2MatHelper, and OpenCVForUnity.UnityUtils.Helper.VideoCapture2MatHelper.

GetFrameCount()

int OpenCVForUnity.UnityUtils.Helper.IVideoSource2MatHelper.GetFrameCount

(

)

Gets the total frame count.

Returns

The total frame count

Implemented in OpenCVForUnity.UnityUtils.Helper.UnityVideoPlayer2MatHelper, and OpenCVForUnity.UnityUtils.Helper.VideoCapture2MatHelper.

GetFrameIndex()

int OpenCVForUnity.UnityUtils.Helper.IVideoSource2MatHelper.GetFrameIndex

(

)

Gets the current frame index.

Returns

The frame index

Implemented in OpenCVForUnity.UnityUtils.Helper.UnityVideoPlayer2MatHelper, and OpenCVForUnity.UnityUtils.Helper.VideoCapture2MatHelper.

GetFramePosRatio()

float OpenCVForUnity.UnityUtils.Helper.IVideoSource2MatHelper.GetFramePosRatio

(

)

Gets the current frame position ratio.

Returns

The frame position ratio (0.0 to 1.0)

Implemented in OpenCVForUnity.UnityUtils.Helper.UnityVideoPlayer2MatHelper, and OpenCVForUnity.UnityUtils.Helper.VideoCapture2MatHelper.

SetFrameIndex()

void OpenCVForUnity.UnityUtils.Helper.IVideoSource2MatHelper.SetFrameIndex

(

int

index

)

Sets the frame index.

Parameters

index

The frame index

Implemented in OpenCVForUnity.UnityUtils.Helper.UnityVideoPlayer2MatHelper, and OpenCVForUnity.UnityUtils.Helper.VideoCapture2MatHelper.

SetFramePosRatio()

void OpenCVForUnity.UnityUtils.Helper.IVideoSource2MatHelper.SetFramePosRatio

(

float

ratio

)

Sets the frame position ratio.

Parameters

ratio

The frame position ratio (0.0 to 1.0)

Implemented in OpenCVForUnity.UnityUtils.Helper.UnityVideoPlayer2MatHelper, and OpenCVForUnity.UnityUtils.Helper.VideoCapture2MatHelper.

Property Documentation

loop

bool OpenCVForUnity.UnityUtils.Helper.IVideoSource2MatHelper.loop

getset

Gets or sets whether to loop the video.

Implemented in OpenCVForUnity.UnityUtils.Helper.UnityVideoPlayer2MatHelper, and OpenCVForUnity.UnityUtils.Helper.VideoCapture2MatHelper.

requestedVideoFilePath

string OpenCVForUnity.UnityUtils.Helper.IVideoSource2MatHelper.requestedVideoFilePath

getset

Gets or sets the requested video file path.

Implemented in OpenCVForUnity.UnityUtils.Helper.UnityVideoPlayer2MatHelper, and OpenCVForUnity.UnityUtils.Helper.VideoCapture2MatHelper.

---

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

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