Interface Result

Result interface definition for Human library

Contains all possible detection results

interface Result {
    body: BodyResult[];
    canvas?: null | AnyCanvas;
    error: null | string;
    face: FaceResult[];
    gesture: GestureResult[];
    hand: HandResult[];
    height: number;
    object: ObjectResult[];
    performance: Record<string, number>;
    persons: PersonResult[];
    timestamp: number;
    width: number;
}

Properties

body canvas? error face gesture hand height object performance persons timestamp width

Properties

body

body: BodyResult[]

BodyResult: detection & analysis results

Optional canvas

canvas?: null | AnyCanvas

optional processed canvas that can be used to draw input on screen

error

error: null | string

Last known error message

face

face: FaceResult[]

FaceResult: detection & analysis results

gesture

gesture: GestureResult[]

GestureResult: detection & analysis results

hand

hand: HandResult[]

HandResult: detection & analysis results

height

height: number

Resolution height

object

object: ObjectResult[]

ObjectResult: detection & analysis results

performance

performance: Record<string, number>

global performance object with timing values for each operation

persons

persons: PersonResult[]

getter property that returns unified persons object

Readonly timestamp

timestamp: number

timestamp of detection representing the milliseconds elapsed since the UNIX epoch

width

width: number

Resolution width

Settings

Member Visibility

Theme

On This Page

bodycanvaserrorfacegesturehandheightobjectperformancepersonstimestampwidth