Class Hyperdeck

Hierarchy

EventEmitter<HyperdeckEvents>
- Hyperdeck

Index

Constructors

constructor

new Hyperdeck(options?: HyperdeckOptions): Hyperdeck
Parameters
- Optional options: HyperdeckOptions
Returns Hyperdeck
Overrides EventEmitter<HyperdeckEvents>.constructor
- Defined in src/hyperdeck.ts:57

Properties

DEBUG

DEBUG: boolean = false

DEFAULT_PORT

DEFAULT_PORT: number = 9993

RECONNECT_INTERVAL

RECONNECT_INTERVAL: number = 5000

`Static` prefixed

prefixed: string | boolean

Accessors

connected

get connected(): boolean
Returns boolean
- Defined in src/hyperdeck.ts:141

Methods

addListener

addListener<T>(event: T, fn: ((...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]) => void), context?: any): Hyperdeck
Type Parameters
- T extends keyof HyperdeckEvents
Parameters
- event: T
- fn: ((...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]) => void)
  - - (...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]
      
      Returns void
- Optional context: any
Returns Hyperdeck
Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

connect

connect(address: string, port?: number): void
Parameters
- address: string
- Optional port: number
Returns void
- Defined in src/hyperdeck.ts:102

disconnect

disconnect(): Promise<void>
Returns Promise<void>
- Defined in src/hyperdeck.ts:112

emit

emit<T>(event: T, ...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends keyof HyperdeckEvents
Parameters
- event: T
- Rest ...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): (keyof HyperdeckEvents)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (keyof HyperdeckEvents)[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

listenerCount

listenerCount(event: keyof HyperdeckEvents): number
Return the number of listeners listening to a given event.
Parameters
- event: keyof HyperdeckEvents
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T>(event: T): ((...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends keyof HyperdeckEvents
Parameters
- event: T
Returns ((...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]) => void)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20

off

off<T>(event: T, fn?: ((...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]) => void), context?: any, once?: boolean): Hyperdeck
Type Parameters
- T extends keyof HyperdeckEvents
Parameters
- event: T
- Optional fn: ((...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]) => void)
  - - (...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns Hyperdeck
Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:69

on

on<T>(event: T, fn: ((...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]) => void), context?: any): Hyperdeck
Add a listener for a given event.
Type Parameters
- T extends keyof HyperdeckEvents
Parameters
- event: T
- fn: ((...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]) => void)
  - - (...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]
      
      Returns void
- Optional context: any
Returns Hyperdeck
Inherited from EventEmitter.on
- Defined in node_modules/eventemitter3/index.d.ts:40

once

once<T>(event: T, fn: ((...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]) => void), context?: any): Hyperdeck
Add a one-time listener for a given event.
Type Parameters
- T extends keyof HyperdeckEvents
Parameters
- event: T
- fn: ((...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]) => void)
  - - (...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]
      
      Returns void
- Optional context: any
Returns Hyperdeck
Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:54

removeAllListeners

removeAllListeners(event?: keyof HyperdeckEvents): Hyperdeck
Remove all listeners, or those of the specified event.
Parameters
- Optional event: keyof HyperdeckEvents
Returns Hyperdeck
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T>(event: T, fn?: ((...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]) => void), context?: any, once?: boolean): Hyperdeck
Remove the listeners of a given event.
Type Parameters
- T extends keyof HyperdeckEvents
Parameters
- event: T
- Optional fn: ((...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]) => void)
  - - (...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns Hyperdeck
Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

sendCommand

sendCommand<TResponse>(command: AbstractCommand<TResponse>): Promise<TResponse>
Type Parameters
- TResponse
Parameters
- command: AbstractCommand<TResponse>
Returns Promise<TResponse>
- Defined in src/hyperdeck.ts:128

Class Hyperdeck

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional options: HyperdeckOptions

Returns Hyperdeck

Properties

DEBUG

DEFAULT_PORT

RECONNECT_INTERVAL

Static prefixed

Accessors

connected

Returns boolean

Methods

addListener

Type Parameters

T extends keyof HyperdeckEvents

Parameters

event: T

fn: ((...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]) => void)

Parameters

Rest ...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]

Returns void

Optional context: any

Returns Hyperdeck

connect

Parameters

address: string

Optional port: number

Returns void

disconnect

Returns Promise<void>

emit

Type Parameters

T extends keyof HyperdeckEvents

Parameters

event: T

Rest ...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]

Returns boolean

eventNames

Returns (keyof HyperdeckEvents)[]

listenerCount

Parameters

event: keyof HyperdeckEvents

Returns number

listeners

Type Parameters

T extends keyof HyperdeckEvents

Parameters

event: T

Returns ((...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]) => void)[]

off

Type Parameters

T extends keyof HyperdeckEvents

Parameters

event: T

Optional fn: ((...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]) => void)

Parameters

Rest ...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]

Returns void

Optional context: any

Optional once: boolean

Returns Hyperdeck

on

Type Parameters

T extends keyof HyperdeckEvents

Parameters

event: T

fn: ((...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]) => void)

Parameters

Rest ...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]

Returns void

Optional context: any

`Optional` options: HyperdeckOptions

`Static` prefixed

`Rest` ...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]

`Optional` context: any

`Optional` port: number

`Rest` ...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]

`Optional` fn: ((...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]) => void)

`Rest` ...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]

`Optional` context: any

`Optional` once: boolean

`Rest` ...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]

`Optional` context: any

`Rest` ...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]

`Optional` context: any

`Optional` event: keyof HyperdeckEvents

`Optional` fn: ((...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]) => void)

`Rest` ...args: ArgumentMap<HyperdeckEvents>[Extract<T, keyof HyperdeckEvents>]

`Optional` context: any

`Optional` once: boolean