Class StatusEmitter

The status emitter will report every time a device status is recieved

Hierarchy

StatusEmitter

Index

Constructors

constructor

new StatusEmitter(statusSocket: Socket): StatusEmitter
Parameters
- statusSocket: Socket
  
  A UDP socket to recieve CDJ status packets on
Returns StatusEmitter
- Defined in src/status/index.ts:46

Properties

`Private` #emitter

#emitter: Emitter = ...

The EventEmitter which reports the device status

`Private` #mediaSlotQueryLock

#mediaSlotQueryLock: Mutex = ...

Lock used to avoid media slot query races

`Private` #statusSocket

#statusSocket: Socket

off

off: ((eventName: string | symbol, listener: ((...args: any[]) => void)) => EventEmitter) = ...

Type declaration

- (eventName: string | symbol, listener: ((...args: any[]) => void)): EventEmitter
- Alias for emitter.removeListener().
  
  Since
  v10.0.0
  Parameters
  - eventName: string | symbol
  - listener: ((...args: any[]) => void)
    - (...args: any[]): void
      
      Parameters
      
      Rest ...args: any[]
      
      Returns void
  Returns EventEmitter

on

on: {
<P, T>(this: T, event: P, listener: ((...args: ListenerType<StatusEvents[P]>) => void)): T;
(event: typeof assignmentCompatibilityHack, listener: ((...args: any[]) => any)): void;
} = ...

Type declaration

- <P, T>(this: T, event: P, listener: ((...args: ListenerType<StatusEvents[P]>) => void)): T
- Type Parameters
  - P extends keyof StatusEvents
  - T
  Parameters
  - this: T
  - event: P
  - listener: ((...args: ListenerType<StatusEvents[P]>) => void)
    - (...args: ListenerType<StatusEvents[P]>): void
      
      Parameters
      
      Rest ...args: ListenerType<StatusEvents[P]>
      
      Returns void
  Returns T
- (event: typeof assignmentCompatibilityHack, listener: ((...args: any[]) => any)): void
- Parameters
  - event: typeof assignmentCompatibilityHack
  - listener: ((...args: any[]) => any)
    - (...args: any[]): any
      
      Parameters
      
      Rest ...args: any[]
      
      Returns any
  Returns void

once

once: {
<P, T>(this: T, event: P, listener: ((...args: ListenerType<StatusEvents[P]>) => void)): T;
(event: typeof assignmentCompatibilityHack, listener: ((...args: any[]) => any)): void;
} = ...

Type declaration

- <P, T>(this: T, event: P, listener: ((...args: ListenerType<StatusEvents[P]>) => void)): T
- Type Parameters
  - P extends keyof StatusEvents
  - T
  Parameters
  - this: T
  - event: P
  - listener: ((...args: ListenerType<StatusEvents[P]>) => void)
    - (...args: ListenerType<StatusEvents[P]>): void
      
      Parameters
      
      Rest ...args: ListenerType<StatusEvents[P]>
      
      Returns void
  Returns T
- (event: typeof assignmentCompatibilityHack, listener: ((...args: any[]) => any)): void
- Parameters
  - event: typeof assignmentCompatibilityHack
  - listener: ((...args: any[]) => any)
    - (...args: any[]): any
      
      Parameters
      
      Rest ...args: any[]
      
      Returns any
  Returns void

Methods

`Private` #handleStatus

#handleStatus(message: Buffer): undefined | Emitter
Parameters
- message: Buffer
Returns undefined | Emitter
- Defined in src/status/index.ts:56

queryMediaSlot

queryMediaSlot(options: Options): Promise<MediaSlotInfo>
Retrieve media slot status information.
Parameters
- options: Options
Returns Promise<MediaSlotInfo>
- Defined in src/status/index.ts:76

Class StatusEmitter

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

statusSocket: Socket

Returns StatusEmitter

Properties

Private #emitter

Private #mediaSlotQueryLock

Private #statusSocket

off

Type declaration

Since

Parameters

eventName: string | symbol

listener: ((...args: any[]) => void)

Parameters

Rest ...args: any[]

Returns void

Returns EventEmitter

on

Type declaration

Type Parameters

P extends keyof StatusEvents

T

Parameters

this: T

event: P

listener: ((...args: ListenerType<StatusEvents[P]>) => void)

Parameters

Rest ...args: ListenerType<StatusEvents[P]>

Returns void

Returns T

Parameters

event: typeof assignmentCompatibilityHack

listener: ((...args: any[]) => any)

Parameters

Rest ...args: any[]

Returns any

Returns void

once

Type declaration

Type Parameters

P extends keyof StatusEvents

T

Parameters

this: T

event: P

listener: ((...args: ListenerType<StatusEvents[P]>) => void)

Parameters

Rest ...args: ListenerType<StatusEvents[P]>

Returns void

Returns T

Parameters

event: typeof assignmentCompatibilityHack

listener: ((...args: any[]) => any)

Parameters

Rest ...args: any[]

Returns any

Returns void

Methods

Private #handleStatus

Parameters

message: Buffer

Returns undefined | Emitter

queryMediaSlot

Parameters

options: Options

Returns Promise<MediaSlotInfo>

Settings

Member Visibility

Theme

`Private` #emitter

`Private` #mediaSlotQueryLock

`Private` #statusSocket

`Rest` ...args: any[]

`Rest` ...args: ListenerType<StatusEvents[P]>

`Rest` ...args: any[]

`Rest` ...args: ListenerType<StatusEvents[P]>

`Rest` ...args: any[]

`Private` #handleStatus