OpenCV for Unity
2.6.2
Enox Software / Please refer to OpenCV official document ( http://docs.opencv.org/4.10.0/index.html ) for the details of the argument of the method.
|
VideoCapture 2 mat helper. v 1.0.0 More...
Public Member Functions | |
virtual void | Initialize (bool autoPlay=true) |
Initialize this instance. More... | |
virtual void | Initialize (string requestedVideoFilePath, bool autoPlay=true) |
Initialize this instance. More... | |
virtual bool | IsInitialized () |
Indicate whether this instance has been initialized. More... | |
virtual void | Play () |
Start the video. More... | |
virtual void | Pause () |
Pause the video. More... | |
virtual void | Stop () |
Stop the video. More... | |
virtual bool | IsPlaying () |
Indicate whether the video is currently playing. More... | |
virtual bool | IsPaused () |
Indicate whether the video is paused. More... | |
virtual string | GetDeviceName () |
Return the active video device name. More... | |
virtual int | GetWidth () |
Return the video width. More... | |
virtual int | GetHeight () |
Return the video height. More... | |
virtual float | GetFPS () |
Return the video framerate. More... | |
virtual float | GetFramePosRatio () |
Return the relative position of the video file: 0=start of the film, 1=end of the film. More... | |
virtual void | SetFramePosRatio (float ratio) |
Set the relative position of the video file: 0=start of the film, 1=end of the film. More... | |
virtual int | GetFrameIndex () |
Return the video frame index. More... | |
virtual void | SetFrameIndex (int index) |
Set the video frame index. More... | |
virtual int | GetFrameCount () |
Return the number of frames in the current video content. More... | |
virtual Source2MatHelperColorFormat | GetBaseColorFormat () |
Return the video base color format. More... | |
virtual VideoCapture | GetVideoCapture () |
Return the VideoCapture instance. More... | |
virtual bool | DidUpdateThisFrame () |
Indicate whether the video buffer of the frame has been updated. More... | |
virtual Mat | GetMat () |
Get the mat of the current frame. The Mat object's type is 'CV_8UC4' or 'CV_8UC3' or 'CV_8UC1' (ColorFormat is determined by the outputColorFormat setting). More... | |
virtual void | Dispose () |
Releases all resource used by the VideoCaptrueToMatHelper object. More... | |
Protected Member Functions | |
virtual void | OnValidate () |
virtual void | LateUpdate () |
virtual void | ReadFrame () |
virtual void | OnDestroy () |
Raises the destroy event. More... | |
virtual IEnumerator | _Initialize () |
Initialize this instance by coroutine. More... | |
virtual void | StartWaitFrameTimeThread () |
virtual void | StopWaitFrameTimeThread () |
virtual void | WaitFrameTimeThreadWorker () |
virtual void | CancelInitCoroutine () |
Cancel Init Coroutine. More... | |
virtual void | ReleaseResources () |
To release the resources. More... | |
Protected Attributes | |
string | _requestedVideoFilePath = string.Empty |
Set the video file path, relative to the starting point of the "StreamingAssets" folder, or absolute path. More... | |
int | _apiPreference = Videoio.CAP_ANY |
Set the apiPreference. VideoCapture API backends identifier. (Advanced Option) See ReadMe.pdf for setup instructions for using CAP_FFMPEG on Windows platforms. More... | |
Source2MatHelperColorFormat | _outputColorFormat = Source2MatHelperColorFormat.BGR |
Select the output color format. More... | |
int | _timeoutFrameCount = 1500 |
The number of frames before the initialization process times out. More... | |
bool | _loop = true |
Indicate whether to play this video in a loop. More... | |
UnityEvent | _onInitialized |
UnityEvent that is triggered when this instance is initialized. More... | |
UnityEvent | _onDisposed |
UnityEvent that is triggered when this instance is disposed. More... | |
Source2MatHelperErrorUnityEvent | _onErrorOccurred |
UnityEvent that is triggered when this instance is error Occurred. More... | |
System.Object | videoCaptureLockObject = new System.Object() |
VideoCapture | _videoCapture |
System.Object | sync = new System.Object() |
bool | _isReading = false |
bool | _isPlaying = false |
bool | _didUpdateThisFrame = false |
bool | _didUpdateImageBufferInCurrentFrame = false |
Mat | frameMat |
The frame mat. More... | |
Mat | baseMat |
The base mat. More... | |
System.Object | imageBufferMatLockObject = new System.Object() |
The image buffer mat. More... | |
Mat | _imageBufferMat |
Source2MatHelperColorFormat | baseColorFormat = Source2MatHelperColorFormat.BGR |
The base color format. More... | |
bool | isInitWaiting = false |
Indicates whether this instance is waiting for initialization to complete. More... | |
bool | hasInitDone = false |
Indicates whether this instance has been initialized. More... | |
IEnumerator | initCoroutine |
The initialization coroutine. More... | |
IEnumerator | getFilePathCoroutine |
The get file path coroutine. More... | |
bool | _isThreadRunning = false |
bool | _shouldStopThread = false |
bool | autoPlayAfterInitialize |
If set to true play after completion of initialization. More... | |
VideoCapture 2 mat helper. v 1.0.0
By setting outputColorFormat to BGR, processing that does not include extra color conversion is performed.
|
protectedvirtual |
Initialize this instance by coroutine.
|
protectedvirtual |
Cancel Init Coroutine.
|
virtual |
Indicate whether the video buffer of the frame has been updated.
true
, if the video buffer has been updated false
otherwise.Implements OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.
|
virtual |
Releases all resource used by the VideoCaptrueToMatHelper object.
Call Dispose when you are finished using the VideoCaptrueToMatHelper. The Dispose method leaves the VideoCaptrueToMatHelper in an unusable state. After calling Dispose, you must release all references to the VideoCaptrueToMatHelper so the garbage collector can reclaim the memory that the VideoCaptrueToMatHelper was occupying.
Implements OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.
|
virtual |
Return the video base color format.
Implements OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.
|
virtual |
Return the active video device name.
Implements OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.
|
virtual |
Return the video framerate.
Implements OpenCVForUnity.UnityUtils.Helper.IVideoSource2MatHelper.
|
virtual |
Return the number of frames in the current video content.
Implements OpenCVForUnity.UnityUtils.Helper.IVideoSource2MatHelper.
|
virtual |
Return the video frame index.
Implements OpenCVForUnity.UnityUtils.Helper.IVideoSource2MatHelper.
|
virtual |
Return the relative position of the video file: 0=start of the film, 1=end of the film.
Implements OpenCVForUnity.UnityUtils.Helper.IVideoSource2MatHelper.
|
virtual |
Return the video height.
Implements OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.
|
virtual |
Get the mat of the current frame. The Mat object's type is 'CV_8UC4' or 'CV_8UC3' or 'CV_8UC1' (ColorFormat is determined by the outputColorFormat setting).
Implements OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.
|
virtual |
Return the VideoCapture instance.
|
virtual |
Return the video width.
Implements OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.
|
virtual |
Initialize this instance.
autoPlay | If set to true play after completion of initialization. |
Implements OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.
|
virtual |
Initialize this instance.
requestedVideoFilePath | Requested video file path. |
autoPlay | If set to true play after completion of initialization. |
|
virtual |
Indicate whether this instance has been initialized.
true
, if this instance has been initialized, false
otherwise.Implements OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.
|
virtual |
Indicate whether the video is paused.
true
, if the video is paused, false
otherwise.Implements OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.
|
virtual |
Indicate whether the video is currently playing.
true
, if the video is playing, false
otherwise.Implements OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.
|
protectedvirtual |
|
protectedvirtual |
Raises the destroy event.
|
protectedvirtual |
|
virtual |
Pause the video.
Implements OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.
|
virtual |
Start the video.
Implements OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.
|
protectedvirtual |
|
protectedvirtual |
To release the resources.
|
virtual |
Set the video frame index.
index | The video frame index. |
Implements OpenCVForUnity.UnityUtils.Helper.IVideoSource2MatHelper.
|
virtual |
Set the relative position of the video file: 0=start of the film, 1=end of the film.
ratio | The relative position of the video file: 0=start of the film, 1=end of the film. |
Implements OpenCVForUnity.UnityUtils.Helper.IVideoSource2MatHelper.
|
protectedvirtual |
|
virtual |
Stop the video.
Implements OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.
|
protectedvirtual |
|
protectedvirtual |
|
protected |
Set the apiPreference. VideoCapture API backends identifier. (Advanced Option) See ReadMe.pdf for setup instructions for using CAP_FFMPEG on Windows platforms.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Indicate whether to play this video in a loop.
|
protected |
UnityEvent that is triggered when this instance is disposed.
|
protected |
UnityEvent that is triggered when this instance is error Occurred.
|
protected |
UnityEvent that is triggered when this instance is initialized.
|
protected |
Select the output color format.
|
protected |
Set the video file path, relative to the starting point of the "StreamingAssets" folder, or absolute path.
|
protected |
|
protected |
The number of frames before the initialization process times out.
|
protected |
|
protected |
If set to true play after completion of initialization.
|
protected |
The base color format.
|
protected |
The base mat.
|
protected |
The frame mat.
|
protected |
The get file path coroutine.
|
protected |
Indicates whether this instance has been initialized.
|
protected |
The image buffer mat.
|
protected |
The initialization coroutine.
|
protected |
Indicates whether this instance is waiting for initialization to complete.
|
protected |
|
protected |
|
getset |
|
getsetprotected |
|
getsetprotected |
|
getsetprotected |
|
getsetprotected |
|
getsetprotected |
|
getsetprotected |
|
getset |
|
getset |
|
getset |
|
getset |
|
getset |
|
getset |
|
getsetprotected |
|
getset |
|
getsetprotected |