Table of Contents

Class VFPFingerprintSource

Namespace
VisioForge.Core.VideoFingerPrinting
Assembly
VisioForge.Core.dll

Represents a source file configuration for video fingerprinting operations.

public class VFPFingerprintSource

Inheritance

Inherited Members

Remarks

The VisioForge.Core.VideoFingerPrinting.VFPFingerprintSource class encapsulates all the settings and parameters needed to generate a video fingerprint from a media file. It supports temporal trimming, spatial cropping, resolution adjustment, and the ability to ignore specific regions of the video frame during fingerprint generation.

Constructors

VFPFingerprintSource(string)

Initializes a new instance of the VisioForge.Core.VideoFingerPrinting.VFPFingerprintSource class.

public VFPFingerprintSource(string filename)

Parameters

filename string

The path to the video file to be used as a fingerprint source.

Remarks

The constructor automatically reads the video duration from the file metadata and initializes the StopTime to match the full duration. The CustomResolution is set to VisioForge.Core.Types.Size.Empty and CustomCropSize is initialized to an empty rectangle.

Exceptions

FileNotFoundException

Thrown when the specified file does not exist.

Properties

CustomCropSize

Gets or sets the custom crop rectangle to apply to video frames before fingerprinting.

public Rect CustomCropSize { get; set; }

Property Value

Rect

Remarks

Cropping is applied before any resolution changes. Use this to remove black bars, watermarks, or other static elements that might interfere with fingerprint matching.

CustomResolution

Gets or sets the custom resolution to which video frames should be resized before fingerprinting.

public Size CustomResolution { get; set; }

Property Value

Size

Remarks

Resizing occurs after cropping but before fingerprint generation. Standardizing resolution can improve matching performance and reduce computational requirements.

Filename

Gets or sets the path to the source media file for fingerprinting.

public string Filename { get; set; }

Property Value

string

Exceptions

FileNotFoundException

Thrown when the specified file does not exist during object construction.

IgnoredAreas

Gets the collection of rectangular areas to be ignored during fingerprint generation.

public List<Rect> IgnoredAreas { get; }

Property Value

List<Rect>

Remarks

Ignored areas are applied after cropping but before resizing. This feature is useful for excluding dynamic overlays such as channel logos, timestamps, or other burn-in graphics that would otherwise interfere with content matching. The rectangles are defined in the coordinate space of the cropped (but not yet resized) frame.

OriginalDuration

Gets or sets the original duration of the source media file.

public TimeSpan OriginalDuration { get; set; }

Property Value

TimeSpan

Remarks

This value is automatically populated when the source file is loaded and represents the complete duration of the media file, regardless of the StartTime and StopTime settings.

StartTime

Gets or sets the start time for fingerprint generation within the video.

public TimeSpan StartTime { get; set; }

Property Value

TimeSpan

Remarks

Use this property to skip introductions or other unwanted content at the beginning of the video.

StopTime

Gets or sets the stop time for fingerprint generation within the video.

public TimeSpan StopTime { get; set; }

Property Value

TimeSpan

Remarks

Use this property to exclude end credits or other unwanted content at the end of the video. The actual duration analyzed will be StopTime - StartTime.