Face Recognition identifies faces that are detected in media. Before using face recognition you must train Media Server to recognize faces, by providing images of people who you want to recognize.
Configuration Parameter | Description |
---|---|
Database | A face database to use to recognize faces in an image. Media Server compares the detected faces to faces in this database. |
GPUBatchingDuration | The maximum amount of time to wait, before sending a batch of video frames to the GPU for analysis. |
GPUNumParallel | The maximum number of video frames to analyze concurrently using the GPU (per CPU thread). |
Identifier | A comma-separated list of identifiers that specifies the faces to match against. |
Input | The track that you want to analyze. |
MaxFaces | The maximum number of faces that you want to recognize. |
MaxRecognitionResults | The maximum number of recognition results to return per face. |
Metadata | A metadata field name and value to specify the faces to match against. |
NumParallel | The maximum number of CPU threads to use for analysis. |
OutputIdentities | The types of identities to include in the output (all , known , or unknown ). |
RecognitionThreshold | The minimum confidence score required to consider a face as a match. |
SegmentDuration | The maximum duration of a record in the SegmentedResult or SegmentedResultWithSource track. |
SyncDatabase | Specifies whether to synchronize with the training database before beginning the analysis task. |
Type | The analysis engine to use. Set this parameter to FaceRecognize . |
Output track | Type | Description | Output1This column indicates whether the information contained in the track is included by default in the output created by an output task (when you don't set the Input parameter for the output task). |
---|---|---|---|
Data
|
FaceRecognitionResult | Contains one record, describing the analysis results, for each input record. | No |
DataWithSource
|
FaceRecognitionResultAndImage | The same as the Data track, but each record also includes the source frame. |
No |
Result
|
FaceRecognitionResult | Contains a record, describing the analysis results, for each detected face. | Yes |
ResultWithSource
|
FaceRecognitionResultAndImage | The same as the Result track, but each record also includes the best source frame. |
No |
SegmentedResult
|
FaceRecognitionResult | (Available only when processing video). Contains one or more records, describing the analysis results, for each detected face. The maximum duration of records in this track is limited by the parameter SegmentDuration, so multiple records are created with the same ID when a face remains in the scene for longer than this duration. | Yes |
SegmentedResultWithSource
|
FaceRecognitionResultAndImage | (Available only when processing video). The same as the SegmentedResult track, but each record also includes the best source frame. |
No |
Field name | Type | Description |
---|---|---|
id | UUIDData | A universally unique identifier to identify the face |
face | FaceData | Information about the detected face |
identity | IdentityData |
The identity of the person who matches the detected face. If the face was not recognized, this field is empty. |
The same as FaceRecognitionResult
records, with the following additional fields.
Field name | Type | Description |
---|---|---|
image | ImageData | The source frame |
|