GestureHandler | broox.js API Reference

Parses gestures coming from Vision Node and allows to add callbacks to perform an action when such gestures occure.

// example
const gestureHandler = new broox.mediaPlayer.GestureHandler(500, 2);
gestureHandler.onPresence(() => console.log('Presence'));

Hierarchy

GestureHandler

Index

Constructors

constructor

Methods

Constructors

constructor

new GestureHandler(time: number, delay: number): GestureHandler

- Defined in src/modules/mediaPlayer/gesture/GestureHandler.ts:30
Creates an instance of the GestureHandler class.

Parameters
- time: number
  
  Time lapse in milliseconds before accepting a gesture as such.
- delay: number
  
  Time lapse in seconds before listening to other gestures once a gesture is accepted.
Returns GestureHandler

Methods

add

add(args: any[]): void

- Defined in src/modules/mediaPlayer/gesture/GestureHandler.ts:48
Adds a potential gesture to be processed.

Parameters
- args: any[]
  
  OSC event args.
Returns void

onBothHandsOnChest

onBothHandsOnChest(callback: (() => any)): void

- Defined in src/modules/mediaPlayer/gesture/GestureHandler.ts:100
Adds a callback function for the "both hands on chest" gesture.

Parameters
- callback: (() => any)
  
  Function that will be executed when the "both hands on chest" gesture is detected.
  - - (): any
    - Returns any
Returns void

onBothHandsUp

onBothHandsUp(callback: (() => any)): void

- Defined in src/modules/mediaPlayer/gesture/GestureHandler.ts:76
Adds a callback function for the "both hands up" gesture.

Parameters
- callback: (() => any)
  
  Function that will be executed when the "both hands up" gesture is detected.
  - - (): any
    - Returns any
Returns void

onLeftHandOnChest

onLeftHandOnChest(callback: (() => any)): void

- Defined in src/modules/mediaPlayer/gesture/GestureHandler.ts:108
Adds a callback function for the "left hand on chest" gesture.

Parameters
- callback: (() => any)
  
  Function that will be executed when the "left hand on chest" gesture is detected.
  - - (): any
    - Returns any
Returns void

onLeftHandUp

onLeftHandUp(callback: (() => any)): void

- Defined in src/modules/mediaPlayer/gesture/GestureHandler.ts:84
Adds a callback function for the "left hand up" gesture.

Parameters
- callback: (() => any)
  
  Function that will be executed when the "left hand up" gesture is detected.
  - - (): any
    - Returns any
Returns void

onPresence

onPresence(callback: (() => any)): void

- Defined in src/modules/mediaPlayer/gesture/GestureHandler.ts:68
Adds a callback function for the "presence" gesture.

Parameters
- callback: (() => any)
  
  Function that will be executed when the presence gesture is detected.
  - - (): any
    - Returns any
Returns void

onRightHandOnChest

onRightHandOnChest(callback: (() => any)): void

- Defined in src/modules/mediaPlayer/gesture/GestureHandler.ts:116
Adds a callback function for the "right hand on chest" gesture.

Parameters
- callback: (() => any)
  
  Function that will be executed when the "right hand on chest" gesture is detected.
  - - (): any
    - Returns any
Returns void

onRightHandUp

onRightHandUp(callback: (() => any)): void

- Defined in src/modules/mediaPlayer/gesture/GestureHandler.ts:92
Adds a callback function for the "right hand up" gesture.

Parameters
- callback: (() => any)
  
  Function that will be executed when the "right hand up" gesture is detected.
  - - (): any
    - Returns any
Returns void

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

time: number

delay: number

Returns GestureHandler

Methods

add

Parameters

args: any[]

Returns void

onBothHandsOnChest

Parameters

callback: (() => any)

Returns any

Returns void

onBothHandsUp

Parameters

callback: (() => any)

Returns any

Returns void

onLeftHandOnChest

Parameters

callback: (() => any)

Returns any

Returns void

onLeftHandUp

Parameters

callback: (() => any)

Returns any

Returns void

onPresence

Parameters

callback: (() => any)

Returns any

Returns void

onRightHandOnChest

Parameters

callback: (() => any)

Returns any

Returns void

onRightHandUp

Parameters

callback: (() => any)

Returns any

Returns void