Table of Contents

Class ImageSequenceSourceSettings

Namespace
VisioForge.Core.Types.X.Sources
Assembly
VisioForge.Core.dll

Image sequence source settings for reading image sequences from a folder.

public class ImageSequenceSourceSettings : IVideoCaptureBaseVideoSourceSettings, IVideoMixerSource, IVideoSourceSettings, IMediaBlockSettings

Inheritance

Implements

Inherited Members

Constructors

ImageSequenceSourceSettings(string, string)

Initializes a new instance of the VisioForge.Core.Types.X.Sources.ImageSequenceSourceSettings class.

public ImageSequenceSourceSettings(string folderPath, string filePattern = null)

Parameters

folderPath string

The folder path containing the image sequence.

filePattern string

The file pattern (optional, will auto-detect if not provided).

Properties

FilePattern

Gets or sets the image file pattern (e.g., "image_%05d.jpg").

public string FilePattern { get; set; }

Property Value

string

FolderPath

Gets or sets the folder path containing the image sequence.

public string FolderPath { get; set; }

Property Value

string

FrameRate

Gets or sets the frame rate for the image sequence playback.

public VideoFrameRate FrameRate { get; set; }

Property Value

VideoFrameRate

ImageFiles

Gets the image file names found in the folder.

public string[] ImageFiles { get; }

Property Value

string[]

IsLive

True for live stream, false for a stream with seeking support.

public bool IsLive { get; set; }

Property Value

bool

Loop

Gets or sets whether the sequence should loop infinitely.

public bool Loop { get; set; }

Property Value

bool

NumBuffers

Gets or sets the number of buffers to output before sending Stop call (-1 = unlimited).

public int NumBuffers { get; set; }

Property Value

int

StartIndex

Gets or sets the starting index for the image sequence.

public int StartIndex { get; set; }

Property Value

int

Methods

CreateBlock()

Creates the media block for this image sequence source.

public MediaBlock CreateBlock()

Returns

MediaBlock

MediaBlock.

GetImageCount()

Gets the number of image files detected in the folder.

public int GetImageCount()

Returns

int

The count of image files.