OpenCVForUnity.Extensions.SourceToMat.IVideoFileMatSource Interface Reference

Video-file playback capabilities shared by file-based video sources. More...

Properties
float	FPS [get]
	Gets the current playback frame rate in frames per second.
int	FrameCount [get]
	Gets the total frame count of the video.
int	FrameIndex [get, set]
	Gets or sets the current frame index.
float	FramePosRatio [get, set]
	Gets or sets the current frame position as a ratio from 0.0 to 1.0.
bool	Loop [get, set]
	Gets or sets whether the video loops after reaching the end.
string	RequestedVideoFilePath [get, set]
	Gets or sets the requested video file path.
Properties inherited from OpenCVForUnity.Extensions.SourceToMat.IMatSource
SourceToMatColorFormat	BaseColorFormat [get]
	Gets the native color format produced by the underlying grabber before output conversion.
bool	DidUpdateThisFrame [get]
	Gets a value indicating whether FrameMat was updated during the most recent tick.
Mat	FrameMat [get]
	Gets the owned reusable output buffer. Do not dispose this Mat.
int	Height [get]
	Gets the current frame height in pixels.
int	InitTimeoutMs [get, set]
	Gets or sets the initialization wait timeout in milliseconds.
bool	IsInitialized [get]
	Gets a value indicating whether the source has been initialized and is ready for playback control. Does not include MatSourceState.Initializing.
bool	IsInitializing [get]
	Gets a value indicating whether initialization is in progress (MatSourceState.Initializing).
bool	IsPaused [get]
	Gets a value indicating whether frame acquisition is paused.
bool	IsPlaying [get]
	Gets a value indicating whether frame acquisition is active.
SourceToMatColorFormat	OutputColorFormat [get, set]
	Gets or sets the output color format. When changed after initialization, the output FrameMat channel layout (Mat type) may change and implementations that raise IMatSourceEvents.OnFrameMatLayoutChanged do so after the new layout is committed.
int	Width [get]
	Gets the current frame width in pixels.

Additional Inherited Members
Public Member Functions inherited from OpenCVForUnity.Extensions.SourceToMat.IMatSource
Task	InitializeAsync (CancellationToken cancellationToken=default)
	Initializes the source asynchronously and leaves playback in MatSourceState.Ready.
Task	PauseAsync (CancellationToken cancellationToken=default)
	Pauses frame acquisition asynchronously. When already paused, completes immediately without error. When MatSourceState.Initializing, completes immediately without changing state.
Task	PlayAsync (CancellationToken cancellationToken=default)
	Starts or resumes frame acquisition asynchronously. When already playing, completes immediately without error. When MatSourceState.Initializing, completes immediately without changing state.
Task	ReleaseAsync (CancellationToken cancellationToken=default)
	Releases underlying resources and returns the source to an uninitialized state. When already uninitialized and the grabber is closed, completes immediately without error.
Task	StopAsync (CancellationToken cancellationToken=default)
	Stops frame acquisition asynchronously. When already in the ready (not playing) state, completes immediately without error. When MatSourceState.Initializing, completes immediately without changing state.
Public Member Functions inherited from OpenCVForUnity.Extensions.SourceToMat.IMatMetaProperties
bool	TryGetMeta (string key, out object value)
	Attempts to get a meta property value by key.
bool	TrySetMeta (string key, object value)
	Attempts to set a meta property value by key.

Detailed Description

Video-file playback capabilities shared by file-based video sources.

Property Documentation

FPS

float OpenCVForUnity.Extensions.SourceToMat.IVideoFileMatSource.FPS

get

Gets the current playback frame rate in frames per second.

Implemented in OpenCVForUnity.Extensions.SourceToMat.VideoCaptureMatSource, and OpenCVForUnity.UnityIntegration.Helper.SourceToMat.UnityVideoPlayerMatSource.

FrameCount

int OpenCVForUnity.Extensions.SourceToMat.IVideoFileMatSource.FrameCount

get

Gets the total frame count of the video.

Implemented in OpenCVForUnity.Extensions.SourceToMat.VideoCaptureMatSource, and OpenCVForUnity.UnityIntegration.Helper.SourceToMat.UnityVideoPlayerMatSource.

FrameIndex

int OpenCVForUnity.Extensions.SourceToMat.IVideoFileMatSource.FrameIndex

getset

Gets or sets the current frame index.

Implemented in OpenCVForUnity.Extensions.SourceToMat.VideoCaptureMatSource, and OpenCVForUnity.UnityIntegration.Helper.SourceToMat.UnityVideoPlayerMatSource.

FramePosRatio

float OpenCVForUnity.Extensions.SourceToMat.IVideoFileMatSource.FramePosRatio

getset

Gets or sets the current frame position as a ratio from 0.0 to 1.0.

Implemented in OpenCVForUnity.Extensions.SourceToMat.VideoCaptureMatSource, and OpenCVForUnity.UnityIntegration.Helper.SourceToMat.UnityVideoPlayerMatSource.

Loop

bool OpenCVForUnity.Extensions.SourceToMat.IVideoFileMatSource.Loop

getset

Gets or sets whether the video loops after reaching the end.

Implemented in OpenCVForUnity.Extensions.SourceToMat.VideoCaptureMatSource, and OpenCVForUnity.UnityIntegration.Helper.SourceToMat.UnityVideoPlayerMatSource.

RequestedVideoFilePath

string OpenCVForUnity.Extensions.SourceToMat.IVideoFileMatSource.RequestedVideoFilePath

getset

Gets or sets the requested video file path.

Implemented in OpenCVForUnity.Extensions.SourceToMat.VideoCaptureMatSource, and OpenCVForUnity.UnityIntegration.Helper.SourceToMat.UnityVideoPlayerMatSource.

---

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

• OpenCVForUnity/Assets/OpenCVForUnity/Scripts/Extensions/SourceToMat/IVideoFileMatSource.cs