VideoCapture to mat helper. v 1.0.4 More...
Inheritance diagram for OpenCVForUnity.UnityUtils.Helper.VideoCaptureToMatHelper:
Classes | |
| class | ErrorUnityEvent |
Public Types | |
| enum | ColorFormat : int { ColorFormat.GRAY = 0, ColorFormat.RGB, ColorFormat.BGR, ColorFormat.RGBA, ColorFormat.BGRA } |
| enum | ErrorCode : int { ErrorCode.UNKNOWN = 0, ErrorCode.VIDEO_FILE_NOT_EXIST, ErrorCode.VIDEO_FILE_CANT_OPEN, ErrorCode.TIMEOUT } |
Public Member Functions | |
| virtual void | Initialize () |
| Initializes this instance. More... | |
| virtual void | Initialize (string requestedVideoFilePath) |
| Initializes this instance. More... | |
| virtual bool | IsInitialized () |
| Indicates whether this instance has been initialized. More... | |
| virtual void | Play () |
| Starts the video. More... | |
| virtual void | Pause () |
| Pauses the video. More... | |
| virtual void | Stop () |
| Stops the video. More... | |
| virtual bool | IsPlaying () |
| Indicates whether the video is currently playing. More... | |
| virtual int | GetWidth () |
| Returns the video width. More... | |
| virtual int | GetHeight () |
| Returns the video height. More... | |
| virtual float | GetFPS () |
| Returns the video framerate. More... | |
| virtual float | GetPosRatio () |
| Returns the relative position of the video file: 0=start of the film, 1=end of the film. More... | |
| virtual void | SetPosRatio (float ratio) |
| Sets the relative position of the video file: 0=start of the film, 1=end of the film. More... | |
| virtual ColorFormat | GetBaseColorFormat () |
| Returns the video base color format. More... | |
| virtual VideoCapture | GetVideoCapture () |
| Returns the VideoCapture instance. More... | |
| virtual bool | DidUpdateThisFrame () |
| Indicates whether the video buffer of the frame has been updated. More... | |
| virtual Mat | GetMat () |
| Gets 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... | |
Public Attributes | |
| UnityEvent | onInitialized |
| UnityEvent that is triggered when this instance is initialized. More... | |
| UnityEvent | onDisposed |
| UnityEvent that is triggered when this instance is disposed. More... | |
| ErrorUnityEvent | onErrorOccurred |
| UnityEvent that is triggered when this instance is error Occurred. More... | |
Protected Member Functions | |
| virtual void | OnValidate () |
| virtual void | LateUpdate () |
| virtual void | ReadFrame () |
| virtual void | OnDestroy () |
| Raises the destroy event. More... | |
| virtual IEnumerator | _Initialize () |
| Initializes this instance by coroutine. More... | |
| virtual void | StartWaitFrameTimeThread () |
| virtual void | StopWaitFrameTimeThread () |
| virtual void | WaitFrameTimeThreadWorker () |
| virtual int | Channels (ColorFormat type) |
| virtual int | ColorConversionCodes (ColorFormat srcType, ColorFormat dstType) |
| 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. 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... | |
| ColorFormat | _outputColorFormat = ColorFormat.BGR |
| Select the output color format. More... | |
| int | _timeoutFrameCount = 1500 |
| The number of frames before the initialization process times out. More... | |
| bool | _loop = true |
| Indicates whether to play this video in a loop. More... | |
| System.Object | videoCaptureLockObject = new System.Object() |
| The VideoCapture. More... | |
| 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 |
| ColorFormat | baseColorFormat = ColorFormat.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 |
Properties | |
| virtual string | requestedVideoFilePath [get, set] |
| virtual int | apiPreference [get, set] |
| virtual ColorFormat | outputColorFormat [get, set] |
| virtual int | timeoutFrameCount [get, set] |
| virtual bool | loop [get, set] |
| VideoCapture | videoCapture [get, set] |
| virtual bool | isReading [get, set] |
| virtual bool | isPlaying [get, set] |
| virtual bool | didUpdateThisFrame [get, set] |
| virtual bool | didUpdateImageBufferInCurrentFrame [get, set] |
| Mat | imageBufferMat [get, set] |
| virtual bool | isThreadRunning [get, set] |
| virtual bool | shouldStopThread [get, set] |
Detailed Description
VideoCapture to mat helper. v 1.0.4
Member Enumeration Documentation
◆ ColorFormat
|
strong |
◆ ErrorCode
|
strong |
Member Function Documentation
◆ _Initialize()
|
protectedvirtual |
Initializes this instance by coroutine.
◆ CancelInitCoroutine()
|
protectedvirtual |
Cancel Init Coroutine.
◆ Channels()
|
protectedvirtual |
◆ ColorConversionCodes()
|
protectedvirtual |
◆ DidUpdateThisFrame()
|
virtual |
Indicates whether the video buffer of the frame has been updated.
- Returns
true, if the video buffer has been updatedfalseotherwise.
◆ Dispose()
|
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.
◆ GetBaseColorFormat()
|
virtual |
Returns the video base color format.
- Returns
- The video base color format.
◆ GetFPS()
|
virtual |
Returns the video framerate.
- Returns
- The video framerate.
◆ GetHeight()
|
virtual |
Returns the video height.
- Returns
- The video height.
◆ GetMat()
|
virtual |
Gets 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).
- Returns
- The mat of the current frame.
◆ GetPosRatio()
|
virtual |
Returns the relative position of the video file: 0=start of the film, 1=end of the film.
- Returns
- The relative position of the video file: 0=start of the film, 1=end of the film.
◆ GetVideoCapture()
|
virtual |
Returns the VideoCapture instance.
- Returns
- The VideoCapture instance.
◆ GetWidth()
|
virtual |
Returns the video width.
- Returns
- The video width.
◆ Initialize() [1/2]
|
virtual |
Initializes this instance.
◆ Initialize() [2/2]
|
virtual |
Initializes this instance.
- Parameters
-
requestedVideoFilePath Requested video file path.
◆ IsInitialized()
|
virtual |
Indicates whether this instance has been initialized.
- Returns
true, if this instance has been initialized,falseotherwise.
◆ IsPlaying()
|
virtual |
Indicates whether the video is currently playing.
- Returns
true, if the video is playing,falseotherwise.
◆ LateUpdate()
|
protectedvirtual |
◆ OnDestroy()
|
protectedvirtual |
Raises the destroy event.
◆ OnValidate()
|
protectedvirtual |
◆ Pause()
|
virtual |
Pauses the video.
◆ Play()
|
virtual |
Starts the video.
◆ ReadFrame()
|
protectedvirtual |
◆ ReleaseResources()
|
protectedvirtual |
To release the resources.
◆ SetPosRatio()
|
virtual |
Sets the relative position of the video file: 0=start of the film, 1=end of the film.
- Parameters
-
ratio The relative position of the video file: 0=start of the film, 1=end of the film.
◆ StartWaitFrameTimeThread()
|
protectedvirtual |
◆ Stop()
|
virtual |
Stops the video.
◆ StopWaitFrameTimeThread()
|
protectedvirtual |
◆ WaitFrameTimeThreadWorker()
|
protectedvirtual |
Member Data Documentation
◆ _apiPreference
|
protected |
Set the apiPreference. VideoCapture API backends identifier. (Advanced Option) See ReadMe.pdf for setup instructions for using CAP_FFMPEG on Windows platforms.
◆ _didUpdateImageBufferInCurrentFrame
|
protected |
◆ _didUpdateThisFrame
|
protected |
◆ _imageBufferMat
|
protected |
◆ _isPlaying
|
protected |
◆ _isReading
|
protected |
◆ _isThreadRunning
|
protected |
◆ _loop
|
protected |
Indicates whether to play this video in a loop.
◆ _outputColorFormat
|
protected |
Select the output color format.
◆ _requestedVideoFilePath
|
protected |
Set the video file path.
◆ _shouldStopThread
|
protected |
◆ _timeoutFrameCount
|
protected |
The number of frames before the initialization process times out.
◆ _videoCapture
|
protected |
◆ baseColorFormat
|
protected |
The base color format.
◆ baseMat
|
protected |
The base mat.
◆ frameMat
|
protected |
The frame mat.
◆ getFilePathCoroutine
|
protected |
The get file path coroutine.
◆ hasInitDone
|
protected |
Indicates whether this instance has been initialized.
◆ imageBufferMatLockObject
|
protected |
The image buffer mat.
◆ initCoroutine
|
protected |
The initialization coroutine.
◆ isInitWaiting
|
protected |
Indicates whether this instance is waiting for initialization to complete.
◆ onDisposed
| UnityEvent OpenCVForUnity.UnityUtils.Helper.VideoCaptureToMatHelper.onDisposed |
UnityEvent that is triggered when this instance is disposed.
◆ onErrorOccurred
| ErrorUnityEvent OpenCVForUnity.UnityUtils.Helper.VideoCaptureToMatHelper.onErrorOccurred |
UnityEvent that is triggered when this instance is error Occurred.
◆ onInitialized
| UnityEvent OpenCVForUnity.UnityUtils.Helper.VideoCaptureToMatHelper.onInitialized |
UnityEvent that is triggered when this instance is initialized.
◆ sync
|
protected |
◆ videoCaptureLockObject
|
protected |
The VideoCapture.
Property Documentation
◆ apiPreference
|
getset |
◆ didUpdateImageBufferInCurrentFrame
|
getsetprotected |
◆ didUpdateThisFrame
|
getsetprotected |
◆ imageBufferMat
|
getsetprotected |
◆ isPlaying
|
getsetprotected |
◆ isReading
|
getsetprotected |
◆ isThreadRunning
|
getsetprotected |
◆ loop
|
getset |
◆ outputColorFormat
|
getset |
◆ requestedVideoFilePath
|
getset |
◆ shouldStopThread
|
getsetprotected |
◆ timeoutFrameCount
|
getset |
◆ videoCapture
|
getsetprotected |
The documentation for this class was generated from the following file:
- OpenCVForUnity/Assets/OpenCVForUnity/org/opencv/unity/helper/VideoCaptureToMatHelper.cs
