Interface HandConfig

Configures all hand detection specific options

interface HandConfig {
    detector: {
        modelPath?: string;
    };
    enabled: boolean;
    iouThreshold: number;
    landmarks: boolean;
    maxDetected: number;
    minConfidence: number;
    modelPath: string;
    rotation: boolean;
    skeleton: {
        modelPath?: string;
    };
    skipFrames: number;
    skipTime: number;
}

Hierarchy (view full)

Properties

detector: {
    modelPath?: string;
}

Type declaration

  • Optional modelPath?: string

    path to hand detector model json

enabled: boolean

is module enabled?

iouThreshold: number

minimum overlap between two detected hands before one is discarded

landmarks: boolean

should hand landmarks be detected or just return detected hand box

maxDetected: number

maximum number of detected hands

minConfidence: number

minimum confidence for a detected hand before results are discarded

modelPath: string

path to model json file (relative to modelBasePath

rotation: boolean

should hand rotation correction be performed after hand detection?

skeleton: {
    modelPath?: string;
}

Type declaration

  • Optional modelPath?: string

    path to hand skeleton model json

skipFrames: number

how many max frames to go without re-running model if cached results are acceptable for two-phase models such as face and hand caching applies to bounding boxes detection only

skipTime: number

how many max milliseconds to go without re-running model if cached results are acceptable for two-phase models such as face and hand caching applies to bounding boxes detection only