DeepAR Scripting API v5.6.12

Namespace: Context

Context

Represents the current frame context.

Members

(static, readonly) BodyKeyPoint :uint

Type:
  • uint
Properties:
Name Type Description
NOSE uint Nose keypoint.
LEFT_EYE uint Left eye keypoint.
RIGHT_EYE uint Right eye keypoint.
LEFT_EAR uint Left ear keypoint.
RIGHT_EAR uint Right ear keypoint.
LEFT_SHOULDER uint Left shoulder keypoint.
RIGHT_SHOULDER uint Right shoulder keypoint.
LEFT_ELBOW uint Left elbow keypoint.
RIGHT_ELBOW uint Right elbow keypoint.
LEFT_WRIST uint Left wrist keypoint.
RIGHT_WRIST uint Right wrist keypoint.
LEFT_HIP uint Left hip keypoint.
RIGHT_HIP uint Right hip keypoint.
LEFT_KNEE uint Left knee keypoint.
RIGHT_KNEE uint Right knee keypoint.
LEFT_ANKLE uint Left ankle keypoint.
RIGHT_ANKLE uint Right ankle keypoint.
NECK uint Neck keypoint.
WAIST uint Waist keypoint.

(static, readonly) cameraMirrored :bool

Checks whether the camera is mirrored or not.
Type:
  • bool

(static, readonly) cameraResolution :Vector2

The camera resolution.
Type:

(static, readonly) MAX_BODIES :uint

Maximum number of bodies that can be simultaneously tracked.
Type:
  • uint

(static, readonly) MAX_FACES :uint

Maximum number of faces that can be simultaneously tracked.
Type:
  • uint

(static, readonly) renderResolution :Vector2

The render context buffer resolution.
Type:

(static, readonly) visibleFacesCount :uint

Number of currently visible faces.
Type:
  • uint

Methods

(static) get2DKeypoint(keypoint, bodyIdopt, isOverlayopt) → {Vector2}

Get 2D body keypoint for specific body.
Parameters:
Name Type Attributes Default Description
keypoint BodyKeyPoint 2D body keypoint.
bodyId uint <optional>
 0 The body ID.
isOverlay boolean <optional>
 true True if 2D keypoint position should be calculated from overlay layer.
Returns:
2D body keypoint.
Type
Vector2

(static) get2DKeypointInScreenSpace(keypoint, bodyIdopt) → {Vector2}

Get 2D body keypoint position in screen space.
Parameters:
Name Type Attributes Default Description
keypoint BodyKeyPoint 2D body keypoint.
bodyId uint <optional>
 0 The body ID.
Returns:
2D body keypoint position in screen space.
Type
Vector2

(static) get3DKeypoint(keypoint, bodyIdopt) → {Vector3}

Get 3D body keypoint for specific body.
Parameters:
Name Type Attributes Default Description
keypoint BodyKeyPoint 3D body keypoint.
bodyId uint <optional>
 0 The body ID.
Returns:
3D body keypoint.
Type
Vector3

(static) getBodyPose(bodyIdopt) → {RigidPose}

Get rigid pose.
Parameters:
Name Type Attributes Default Description
bodyId uint <optional>
 0 The body ID.
Returns:
Body pose.
Type
RigidPose

(static) getFaceEulerAngles(faceIdopt) → {Vector3}

Gets the global Euler angles of a face.
Parameters:
Name Type Attributes Default Description
faceId uint <optional>
 0 Face index.
Returns:
Global face Euler angles (in radians).
Type
Vector3

(static) getFacePosition(faceIdopt) → {Vector3}

Gets the global position of a face.
Parameters:
Name Type Attributes Default Description
faceId uint <optional>
 0 Face index.
Returns:
Global face position.
Type
Vector3

(static) getFaceQuaternion(faceIdopt) → {Vector4}

Gets the global quaternion of a face.
Parameters:
Name Type Attributes Default Description
faceId uint <optional>
 0 Face index.
Returns:
Global face quaternion.
Type
Vector4

(static) is2DKeypointDetected(keypoint, bodyIdopt) → {boolean}

Check if specified 2D body keypoint is detected.
Parameters:
Name Type Attributes Default Description
keypoint BodyKeyPoint 2D body keypoint.
bodyId uint <optional>
 0 The body ID.
Returns:
True if 2D body keypoint is detected, false otherwise.
Type
boolean

(static) is3DKeypointDetected(keypoint, bodyIdopt) → {boolean}

Check if specified 3D body keypoint is detected.
Parameters:
Name Type Attributes Default Description
keypoint BodyKeyPoint 3D body keypoint.
bodyId uint <optional>
 0 The body ID.
Returns:
True if 3D body keypoint is detected, false otherwise.
Type
boolean

(static) isBodyDetected(bodyIdopt) → {bool}

Checks whether a body is detected or not.
Parameters:
Name Type Attributes Default Description
bodyId uint <optional>
 0 The body ID.
Returns:
True if the body is detected, false otherwise.
Type
bool

(static) isFaceVisible(faceIdopt) → {bool}

Checks whether a face is visible or not.
Parameters:
Name Type Attributes Default Description
faceId uint <optional>
 0 Face index.
Returns:
True if face is visible, false otherwise.
Type
bool