Options
All
  • Public
  • Public/Protected
  • All
Menu

@vladmandic/human - v2.3.5

Index

References

Classes

Interfaces

Type aliases

Variables

References

default

Renames and re-exports Human

Type aliases

BodyKeypoint

BodyKeypoint: { part: string; position: Point; positionRaw: Point; score: number }

Type declaration

  • part: string
  • position: Point
  • positionRaw: Point
  • score: number

Box

Box: [number, number, number, number]

Box and Point primitives

Descriptor

Descriptor: number[]

Face descriptor type as number array

Env

Env: { Canvas: undefined; Image: undefined; ImageData: undefined; agent: undefined | string; backends: string[]; browser: undefined | boolean; filter: undefined | boolean; initial: boolean; kernels: string[]; node: undefined | boolean; offscreen: undefined | boolean; platform: undefined | string; tfjs: { version: undefined | string }; wasm: { backend: undefined | boolean; multithread: undefined | boolean; simd: undefined | boolean; supported: undefined | boolean }; webgl: { backend: undefined | boolean; renderer: undefined | string; supported: undefined | boolean; version: undefined | string }; webgpu: { adapter: undefined | string; backend: undefined | boolean; supported: undefined | boolean }; worker: undefined | boolean }

Type declaration

  • Canvas: undefined

    MonkeyPatch for Canvas

  • Image: undefined

    MonkeyPatch for Image

  • ImageData: undefined

    MonkeyPatch for ImageData

  • agent: undefined | string

    Detected agent

  • backends: string[]

    List of supported backends

  • browser: undefined | boolean

    Running in Browser

  • filter: undefined | boolean

    Are image filters supported?

  • initial: boolean

    Has any work been performed so far

  • kernels: string[]

    List of supported kernels for current backend

  • node: undefined | boolean

    Running in NodeJS

  • offscreen: undefined | boolean

    Is offscreenCanvas supported?

  • platform: undefined | string

    Detected platform

  • tfjs: { version: undefined | string }

    TFJS instance details

    • version: undefined | string
  • wasm: { backend: undefined | boolean; multithread: undefined | boolean; simd: undefined | boolean; supported: undefined | boolean }

    WASM detected capabilities

    • backend: undefined | boolean
    • multithread: undefined | boolean
    • simd: undefined | boolean
    • supported: undefined | boolean
  • webgl: { backend: undefined | boolean; renderer: undefined | string; supported: undefined | boolean; version: undefined | string }

    WebGL detected capabilities

    • backend: undefined | boolean
    • renderer: undefined | string
    • supported: undefined | boolean
    • version: undefined | string
  • webgpu: { adapter: undefined | string; backend: undefined | boolean; supported: undefined | boolean }

    WebGPU detected capabilities

    • adapter: undefined | string
    • backend: undefined | boolean
    • supported: undefined | boolean
  • worker: undefined | boolean

    Running in WebWorker thread

Error

Error: { error: string }

Error message

Type declaration

  • error: string

Events

Events: "create" | "load" | "image" | "result" | "warmup" | "error"

Events dispatched by human.events

  • create: triggered when Human object is instantiated
  • load: triggered when models are loaded (explicitly or on-demand)
  • image: triggered when input image is processed
  • result: triggered when detection is complete
  • warmup: triggered when warmup is complete

GestureResult

GestureResult: { face: number; gesture: FaceGesture } | { gesture: IrisGesture; iris: number } | { body: number; gesture: BodyGesture } | { gesture: HandGesture; hand: number }

Gesture results

Input

Input: Tensor | ImageData | ImageBitmap | HTMLImageElement | HTMLMediaElement | HTMLVideoElement | HTMLCanvasElement | OffscreenCanvas | typeof Image | typeof Canvas

Defines all possible input types for Human detection

Point

Point: [number, number, number?]

Box and Point primitives

TensorFlow

TensorFlow: typeof tf

Instance of TensorFlow/JS

external

Variables

defaults

defaults: Config = ...

See all default Config values...

env

env: Env = ...