# .NET API Reference

Realeyes.FaceVerification

Main entry point for face detection, embedding, and verification operations. Implements IDisposable.

public FaceVerifier(string modelPath, int maxConcurrency = 0)

Creates a new FaceVerifier instance.

Throws:

• ArgumentNullException — when modelPath is null
• FaceVerificationException — when model loading fails

public Task<FaceList> DetectFacesAsync(ImageHeader imageHeader)

Detects faces in an image asynchronously.

Returns: Task<FaceList> — disposable collection of detected faces.

Throws: FaceVerificationException — when detection fails.

public Task<float[]> EmbedFaceAsync(Face face)

Computes the embedding vector for a detected face asynchronously.

Returns: Task<float[]> — embedding vector.

Throws:

• ArgumentNullException — when face is null
• FaceVerificationException — when embedding fails

public Match CompareFaces(float[] embedding1, float[] embedding2)

Compares two face embeddings and returns a similarity score.

Returns: Match — match result with similarity score.

Throws:

• ArgumentNullException — when either embedding is null
• ArgumentException — when embeddings have different lengths

public void Dispose()

Disposes the FaceVerifier and releases native resources.

A disposable collection of Face objects that automatically disposes all faces when disposed. Inherits from List<Face> and implements IDisposable and IAsyncDisposable.

public void Dispose()

Disposes all Face objects in the collection synchronously.

public ValueTask DisposeAsync()

Disposes all Face objects in the collection asynchronously.

Represents a detected face with landmarks, bounding box, and quality information. Implements IDisposable.

public Face(ImageHeader imageHeader, Point2d[] landmarks, BoundingBox boundingBox, float confidence)

Creates a Face object from a third-party face detector.

Throws:

• ArgumentNullException — when imageHeader or landmarks is null
• ArgumentException — when landmarks count is not exactly 5
• FaceVerificationException — when face creation fails

public Point2d[] GetLandmarks()

Gets the facial landmarks.

Returns: Point2d[] — array of 5 landmark points.

public Face Clone()

Creates a copy of this face.

Returns: Face — a new Face instance with the same data.

public void Dispose()

Disposes the face and releases native resources.

Image descriptor for passing image data to the Face Verification Library. (readonly record struct)

public ImageHeader(byte[] Data, int Width, int Height, int Stride, ImageFormat Format)

Throws:

• ArgumentNullException — when Data is null
• ArgumentOutOfRangeException — when Width, Height, or Stride is not positive

Bounding box representing a rectangular region. (readonly record struct)

public BoundingBox(int X, int Y, int Width, int Height)

2D point representing a landmark coordinate. (readonly record struct)

public Point2d(float X, float Y)

Result of face comparison indicating similarity. (readonly record struct)

public Match(float Similarity)

public bool ExceedsThreshold(float threshold)

Checks if the similarity score exceeds a threshold.

Returns: bool — true if Similarity >= threshold.

Semantic version number. (readonly record struct)

public Version(int Major, int Minor, int Patch)

public override string ToString()

Returns: string — version in "Major.Minor.Patch" format.

Image pixel format.

Detection quality indicator.

Exception thrown when Face Verification Library operations fail. Inherits from Exception.

public FaceVerificationException()
public FaceVerificationException(string message)
public FaceVerificationException(string message, Exception innerException)