dfx Namespace Reference

Classes
class	ChunkData
	ChunkData is the internal memory representation of a Collection from which a ChunkPayload can be constructed to send to the DFX API. More...
struct	ChunkPayload
	Chunk that was captured by a Collection. More...
class	Collector
	Collector extracts region channel information from video frames for server signal processing. More...
class	DFXFactory
	DFXFactory is the primary entry point for the collector and is used create a collector. More...
struct	Error
struct	Face
	identifies the properties associated with faces within the video frame. More...
class	Frame
	Frame is a wrapper which links a VideoFrame with one or more Face objects and additional state needed for regions and channel construction. More...
class	MeasurementData
class	MeasurementResult
struct	PosePoint
	Pose points are used to identify individual MPEG-4 Facial Data Points of a face. More...
class	ThrowOnError
struct	VideoFrame
	Represents the internal structure for how image frames are passed to the DFX Engine since there is little in the way of standards. More...

Enumerations
enum	ConstraintResult : char { ConstraintResult::Good = 0, ConstraintResult::Warn = 1, ConstraintResult::Error = 2 }
	The possible constraint return values. More...
enum	CollectorState : char {   CollectorState::Waiting = 0, CollectorState::Collecting = 1, CollectorState::ChunkReady = 2, CollectorState::Completed = 3,   CollectorState::Error = 4 }
	A Collector state indicates whether a Collector is in error or ready to collect data. More...
enum	FaceAttribute {   SEX_ASSIGNED_AT_BIRTH = 1, AGE_YEARS = 2, HEIGHT_CM = 3, WEIGHT_KG = 4,   SMOKER = 5, HYPERTENSIVE = 6, BLOOD_PRESSURE_MEDICATION = 7, DIABETES = 8 }
enum	FaceAttributeValue {   SEX_NOT_PROVIDED = 1, SEX_ASSIGNED_MALE_AT_BIRTH = 2, SEX_ASSIGNED_FEMALE_AT_BIRTH = 3, DIABETES_NONE = 4,   DIABETES_TYPE1 = 5, DIABETES_TYPE2 = 6 }

Detailed Description

The namespace containing all dfx related classes.

These are helpers for translating to/from the opaque dfx_error** types and follow a standard pattern to raise the exception after transversing the C-ABI layer.

See also

"Hourglass Interfaces for C++ APIs"

Enumeration Type Documentation

CollectorState

enum dfx::CollectorState : char

strong

A Collector state indicates whether a Collector is in error or ready to collect data.

Enumerator
Waiting	Collector is WAITING to start collection
Collecting	Collector is COLLECTING frame data
ChunkReady	Collector has a CHUNK READY to send to server
Completed	Collector is COMPLETED and should be sent to server
Error	Collector in ERROR and collection aborted

ConstraintResult

enum dfx::ConstraintResult : char

strong

The possible constraint return values.

Enumerator
Good	Good indicates there is nothing presently detected in constraints
Warn	Warn indicates a problem that needs to be corrected
Error	Error indicates a problem that has failed the measurement