Frame Class

Frame is a wrapper which links a VideoFrame with one or more Face objects and additional state needed for regions and channel construction.


Namespace: Dfx.Sdk
Assembly: Nuralogix.Dfx.Sdk (in Nuralogix.Dfx.Sdk.dll) Version: (
public class Frame : IDisposable
Object    Frame


In addition to the video image, a Frame will have Faces and addition state. It also enables client applications to augment the Frame with markers and device data like Acceleration and Rotation data if available.


DesiredDeviceAttributes Gets a list of desired device attributes for this Frame.
DesiredFaceAttributes Gets a list of desired face attributes for this Frame.
FaceIdentifiers Gets a list of the known face identifiers within this Frame.
Markers Gets a list of markers in this frame


AddFace Add a face and associated data to the frame.
AddMarker Adds a marker/label to a video frame.
DisposeReleases all resources used by the Frame
Dispose(Boolean)Releases the unmanaged resources used by the Frame and optionally releases the managed resources
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
(Overrides ObjectFinalize)
GetDeviceAttribute Returns the value of a device attribute if it exists or zero
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetOpticalQualityMetrics Calculates the optical quality metrics for the current frame.
GetOpticalRating Provide the 5-star optical rating value for the current frame.
GetQualityMetrics Calculates the quality metrics for the current frame.
GetRegionHistogram Obtain the histogram for a region of interest.
GetRegionIntProperty Regions can have numeric properties attached to them.
GetRegionNames Returns the names of regions which are defined for the face within this frame.
GetRegionPolygon Returns the polygon for the region of interest.
GetStarRating Provide the 5-star rating value for the current frame.
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
SetDeviceAttribute Add a device attribute
ToStringReturns a string that represents the current object.
(Inherited from Object)

See Also