Documentation

Built for ARKit

Suggest Edits

ARKit Blendshape Compatibility

A didimo can be requested from our API with ARKit compatibility. This can be used for

  • ARKitLive Capture in Unity Editor via our Unity SDK to record MoCap files for animation
  • Build iOS Applications using ARKit to control a didimos facial animation system

📘

ARKit capability is only available via the Advanced Access Package

This option packages your didimo with 51 of the 52 ARKit BlendShapeLocation variables as poses. Please see the corresponding reference table.

ARKit BlendShape LocationDidimo Supplied PosePose
browDownLeft: ARFaceAnchor.BlendShapeLocationARKit_browDownLeftbrowDownLeft
browDownRight: ARFaceAnchor.BlendShapeLocationARKit_browDownRightbrowDownRight
browInnerUp: ARFaceAnchor.BlendShapeLocationARKit_browInnerUpbrowInnerUp
browOuterUpLeft: ARFaceAnchor.BlendShapeLocationARKit_browOuterUpLeftbrowOuterUpLeft
browOuterUpRight: ARFaceAnchor.BlendShapeLocationARKit_browOuterUpRightbrowOuterUpRight
cheekPuff: ARFaceAnchor.BlendShapeLocationARKit_cheekPuffcheekPuff
cheekSquintLeft: ARFaceAnchor.BlendShapeLocationARKit_cheekSquintLeftcheekSquintLeft
cheekSquintRight: ARFaceAnchor.BlendShapeLocationARKit_cheekSquintRightcheekSquintRight
eyeBlinkLeft: ARFaceAnchor.BlendShapeLocationARKit_eyeBlinkLefteyeBlinkLeft
eyeBlinkRight: ARFaceAnchor.BlendShapeLocationARKit_eyeBlinkRighteyeBlinkRight
eyeLookDownLeft: ARFaceAnchor.BlendShapeLocationARKit_eyeLookDownLefteyeLookDownLeft
eyeLookDownRight: ARFaceAnchor.BlendShapeLocationARKit_eyeLookDownRighteyeLookDownRight
eyeLookInLeft: ARFaceAnchor.BlendShapeLocationARKit_eyeLookInLefteyeLookInLeft
eyeLookInRight: ARFaceAnchor.BlendShapeLocationARKit_eyeLookInRighteyeLookInRight
eyeLookOutLeft: ARFaceAnchor.BlendShapeLocationARKit_eyeLookOutLefteyeLookOutLeft
eyeLookOutRight: ARFaceAnchor.BlendShapeLocationARKit_eyeLookOutRighteyeLookOutRight
eyeLookUpLeft: ARFaceAnchor.BlendShapeLocationARKit_eyeLookUpLefteyeLookUpLeft
eyeLookUpRight: ARFaceAnchor.BlendShapeLocationARKit_eyeLookUpRighteyeLookUpRight
eyeSquintLeft: ARFaceAnchor.BlendShapeLocationARKit_eyeSquintLefteyeSquintLeft
eyeSquintRight: ARFaceAnchor.BlendShapeLocationARKit_eyeSquintRighteyeSquintRight
eyeWideLeft: ARFaceAnchor.BlendShapeLocationARKit_eyeWideLefteyeWideLeft
eyeWideRight: ARFaceAnchor.BlendShapeLocationARKit_eyeWideRighteyeWideRight
jawForward: ARFaceAnchor.BlendShapeLocationARKit_jawForwardjawForward
jawLeft: ARFaceAnchor.BlendShapeLocationARKit_jawLeftjawLeft
jawOpen: ARFaceAnchor.BlendShapeLocationARKit_jawOpenjawOpen
jawRight: ARFaceAnchor.BlendShapeLocationARKit_jawRightjawRight
mouthClose: ARFaceAnchor.BlendShapeLocationARKit_mouthClosemouthClose
mouthDimpleLeft: ARFaceAnchor.BlendShapeLocationARKit_mouthDimpleLeftmouthDimpleLeft
mouthDimpleRight: ARFaceAnchor.BlendShapeLocationARKit_mouthDimpleRightmouthDimpleRight
mouthFrownLeft: ARFaceAnchor.BlendShapeLocationARKit_mouthFrownLeftmouthFrownLeft
mouthFrownRight: ARFaceAnchor.BlendShapeLocationARKit_mouthFrownRightmouthFrownRight
mouthFunnel: ARFaceAnchor.BlendShapeLocationARKit_mouthFunnelmouthFunnel
mouthLeft: ARFaceAnchor.BlendShapeLocationARKit_mouthLeftmouthLeft
mouthLowerDownLeft: ARFaceAnchor.BlendShapeLocationARKit_mouthLowerDownLeftmouthLowerDownLeft
mouthLowerDownRight: ARFaceAnchor.BlendShapeLocationARKit_mouthLowerDownRightmouthLowerDownRight
mouthPressLeft: ARFaceAnchor.BlendShapeLocationARKit_mouthPressLeftmouthPressLeft
mouthPressRight: ARFaceAnchor.BlendShapeLocationARKit_mouthPressRightmouthPressRight
mouthPucker: ARFaceAnchor.BlendShapeLocationARKit_mouthPuckermouthPucker
mouthRight: ARFaceAnchor.BlendShapeLocationARKit_mouthRightmouthRight
mouthRollLower: ARFaceAnchor.BlendShapeLocationARKit_mouthRollLowermouthRollLower
mouthRollUpper: ARFaceAnchor.BlendShapeLocationARKit_mouthRollUppermouthRollUpper
mouthShrugLower: ARFaceAnchor.BlendShapeLocationARKit_mouthShrugLowermouthShrugLower
mouthShrugUpper: ARFaceAnchor.BlendShapeLocationARKit_mouthShrugUppermouthShrugUpper
mouthSmileLeft: ARFaceAnchor.BlendShapeLocationARKit_mouthSmileLeftmouthSmileLeft
mouthSmileRight: ARFaceAnchor.BlendShapeLocationARKit_mouthSmileRightmouthSmileRight
mouthStretchLeft: ARFaceAnchor.BlendShapeLocationARKit_mouthStretchLeftmouthStretchLeft
mouthStretchRight: ARFaceAnchor.BlendShapeLocationARKit_mouthStretchRightmouthStretchRight
mouthUpperUpLeft: ARFaceAnchor.BlendShapeLocationARKit_mouthUpperUpLeftmouthUpperUpLeft
mouthUpperUpRight: ARFaceAnchor.BlendShapeLocationARKit_mouthUpperUpRightHmouthUpperUpRight
noseSneerLeft: ARFaceAnchor.BlendShapeLocationARKit_noseSneerLeftnoseSneerLeft
noseSneerRight: ARFaceAnchor.BlendShapeLocationARKit_noseSneerRightnoseSneerRight

🚧

'tongueOut' ARKit blendshape does not exist on the didimo

For more information - please see Known Issues

Updated over 2 years ago