Facial data capture
Updated
Use the facial capture extension to capture facial data such as facial feature points, head rotation, and head translation.
The Facial Capture extension collects quantitative data such as facial feature points, head rotation, and head translation. You can use this data to drive 3D facial stickers, headgear, pendant applications, or digital humans, adding more vivid expressions to virtual images.
This guide is intended for use-cases where the facial capture extension is used independently to capture facial data, while a third-party rendering engine is used to animate a virtual human.
To avoid collecting facial data through callbacks and building your own collection, encoding, and transmission framework, use the Agora MetaKit extension for facial capture.
Prerequisites
Ensure that you have:
- Implemented the SDK quickstart in your project.
- Integrated Video SDK version 4.3.0 or later with the Facial Capture extension dynamic library for your platform.
- Obtained the face capture authentication parameters
authentication_informationandcompany_idby contacting Agora technical support.
Implement the logic
This section shows you how to integrate the Facial Capture extension in your app to capture facial data.
Enable the extension
To enable the Facial Capture extension, call enableExtension:
agoraKit.enableExtension(
withVendor: "agora_video_filters_face_capture",
extension: "face_capture",
enabled: true,
sourceType: AgoraMediaSourceType.primaryCamera
)When you enable the Facial Capture extension for the first time, a delay may occur. To ensure smooth operation during a session, call enableExtension before joining a channel.
Set authentication parameters
To ensure that the extension functions properly, call setExtensionProperty to pass the necessary authentication parameters.
agoraKit.setExtensionProperty(
withVendor: "agora_video_filters_face_capture",
extension: "face_capture",
key: "authentication_information",
value: "{\"company_id\":\"xxxxx\", \"license\":\"xxxxx\"}",
sourceType: AgoraMediaSourceType.primaryCamera
)Retrieve facial data
To obtain raw video data containing facial information, use the onCaptureVideoFrame callback:
func onCapture(_ videoFrame: AgoraOutputVideoFrame, sourceType: AgoraVideoSourceType) -> Bool {
if !videoFrame.metaInfo.isEmpty {
if videoFrame.metaInfo.contains(where: { $0.key as! String == "KEY_FACE_CAPTURE" }) {
if let faceInfo = videoFrame.metaInfo["KEY_FACE_CAPTURE"] as? String {
print("Face Info: \(faceInfo)")
}
}
}
return true
}Use facial information to drive virtual humans
The output facial data is in JSON format and includes quantitative information such as facial feature points, head rotation, and head translation. This data follows the Blend Shape (BS) format in compliance with the ARKit standard. You can use a third-party 3D rendering engine to further process the BS data. The key elements are:
faces: An array of objects, each representing recognized facial information for one face.detected: A float representing the confidence level of face recognition, ranging from0.0to1.0.blendshapes: An object containing the face capture coefficients. The keys follow the ARKit standard, with each key-value pair representing a blendshape coefficient, where the value is a float between0.0and1.0.rotation: An array of objects representing head rotation. It contains three key-value pairs. All values are floating points between-180.0and180.0.pitch: The pitch angle of the head. Positive values represent head lowering, negative values represent head raising.yaw: The angle of head rotation. Positive values represent left rotation, negative values represent right rotation.roll: The tilt angle of the head. Positive values represent right tilt, negative values represent left tilt.
translation: An object representing head translation, with three key-value pairs:x,y, andz. The values are floats between0.0and1.0.faceState: An integer indicating the current face capture control state:0: The algorithm is in surface capture control.1: The algorithm control returns to the center.2: The algorithm is restored and not in control.
timestamp: A string representing the output result's timestamp, in milliseconds.
This data can be used to animate virtual humans by applying the blendshape coefficients and head movement data to a 3D model.
{
"faces": [
{
"detected": 0.98,
"blendshapes": {
"eyeBlinkLeft": 0.9,
"eyeLookDownLeft": 0.0,
"eyeLookInLeft": 0.0,
"eyeLookOutLeft": 0.0,
"eyeLookUpLeft": 0.0,
"eyeSquintLeft": 0.0,
"eyeWideLeft": 0.0,
"eyeBlinkRight": 0.0,
"eyeLookDownRight": 0.0,
"eyeLookInRight": 0.0,
"eyeLookOutRight": 0.0,
"eyeLookUpRight": 0.0,
"eyeSquintRight": 0.0,
"eyeWideRight": 0.0
},
"rotation": {
"pitch": 30.0,
"yaw": 25.5,
"roll": -15.5
},
"translation": {
"x": 0.5,
"y": 0.3,
"z": 0.5
},
"faceState": 1
}
],
"timestamp": "654879876546"
}Disable the extension
To disable the Facial Capture extension, call enableExtension:
agoraKit.enableExtension(
withVendor: "agora_video_filters_face_capture",
extension: "face_capture",
enabled: false,
sourceType: AgoraMediaSourceType.primaryCamera
)Reference
This section contains content that completes the information in this page, or points you to documentation that explains other aspects to this product.