Class MixstatusProcessor

MixstatusProcessor is a configurable processor which when fed device state will attempt to accurately determine events that happen within the DJ set.

The following events are fired:

nowPlaying: The track is considered playing and on air to the audience.
stopped: The track was stopped / paused / went off-air.

Additionally the following non-track status are reported:

setStarted: The first track has begun playing.
setEnded: The TimeBetweenSets has passed since any tracks were live.

See Config for configuration options.

Config options may be changed after the processor has been created and is actively receiving state updates.

Hierarchy

MixstatusProcessor

Constructors

constructor

new MixstatusProcessor(config?: Partial<MixstatusConfig>): MixstatusProcessor
Parameters
- Optional config: Partial<MixstatusConfig>
Returns MixstatusProcessor
- Defined in src/mixstatus/index.ts:138

Properties

`Private` `Optional` #cancelSetEnding

#cancelSetEnding?: (() => void)

Type declaration

- (): void
- When we are waiting for a set to end, use this to cancel the timer.
  
  Returns void

`Private` #config

#config: MixstatusConfig

The configuration for this instance of the processor

`Private` #emitter

#emitter: Emitter = ...

Used to fire track mix status events

`Private` #isSetActive

#isSetActive: boolean = false

Incidates if we're currentiny in an active DJ set

`Private` #lastStartTime

#lastStartTime: Map<number, number> = ...

Records when each device last started playing a track

`Private` #lastState

#lastState: Map<number, State> = ...

Records the most recent state of each player

`Private` #lastStoppedTimes

#lastStoppedTimes: Map<number, number> = ...

Records when a device entered a 'may stop' state. If it's in the state for long enough it will be reported as stopped.

`Private` #livePlayers

#livePlayers: Set<number> = ...

Records which players have been reported as 'live'

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<MixstatusEvents[P]>) => void)): T;
(event: typeof assignmentCompatibilityHack, listener: ((...args: any[]) => any)): void;
} = ...

Type declaration

- <P, T>(this: T, event: P, listener: ((...args: ListenerType<MixstatusEvents[P]>) => void)): T
- Type Parameters
  - P extends keyof MixstatusEvents
  - T
  Parameters
  - this: T
  - event: P
  - listener: ((...args: ListenerType<MixstatusEvents[P]>) => void)
    - (...args: ListenerType<MixstatusEvents[P]>): void
      
      Parameters
      
      Rest ...args: ListenerType<MixstatusEvents[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<MixstatusEvents[P]>) => void)): T;
(event: typeof assignmentCompatibilityHack, listener: ((...args: any[]) => any)): void;
} = ...

Type declaration

- <P, T>(this: T, event: P, listener: ((...args: ListenerType<MixstatusEvents[P]>) => void)): T
- Type Parameters
  - P extends keyof MixstatusEvents
  - T
  Parameters
  - this: T
  - event: P
  - listener: ((...args: ListenerType<MixstatusEvents[P]>) => void)
    - (...args: ListenerType<MixstatusEvents[P]>): void
      
      Parameters
      
      Rest ...args: ListenerType<MixstatusEvents[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` #handleOnairChange

#handleOnairChange(state: State): void
Parameters
- state: State
Returns void
- Defined in src/mixstatus/index.ts:327

`Private` #handlePlaystateChange

#handlePlaystateChange(lastState: State, state: State): void
Called to indicate that a device has reported a different playState than it had previously reported.
Parameters
- lastState: State
- state: State
Returns void
- Defined in src/mixstatus/index.ts:289

`Private` #markPlayerStopped

#markPlayerStopped(__namedParameters: State): void
Parameters
- __namedParameters: State
Returns void
- Defined in src/mixstatus/index.ts:217

`Private` #onAir

#onAir(state: State): boolean
Helper to account for the useOnAirStatus config. If not configured with this flag the state will always be determined as on air.
Parameters
- state: State
Returns boolean
- Defined in src/mixstatus/index.ts:158

`Private` #playerMayBeFirst

#playerMayBeFirst(state: State): void
Called to indicate that we think this player may be the first one to start playing. Will check if no other players are playing, if so it will report the player as now playing.
Parameters
- state: State
Returns void
- Defined in src/mixstatus/index.ts:264

`Private` #playerMayStop

#playerMayStop(__namedParameters: State): void
Called when the player is in a state where it is no longer playing, but may come back onair. Examples are slip pause, or 'cutting' a track on the mixer taking it offair.
Parameters
- __namedParameters: State
Returns void
- Defined in src/mixstatus/index.ts:281

`Private` #promoteNextPlayer

#promoteNextPlayer(): void
Locate the player that has been playing for the longest time and is onair, and report that device as now playing.

Returns void
- Defined in src/mixstatus/index.ts:194

`Private` #promotePlayer

#promotePlayer(state: State): void
Report a player as 'live'. Will not report the state if the player has already previously been reported as live.
Parameters
- state: State
Returns void
- Defined in src/mixstatus/index.ts:165

`Private` #setMayStop

#setMayStop(): Promise<void>
Returns Promise<void>
- Defined in src/mixstatus/index.ts:226

configure

configure(config?: Partial<MixstatusConfig>): void
Update the configration
Parameters
- Optional config: Partial<MixstatusConfig>
Returns void
- Defined in src/mixstatus/index.ts:145

handleState

handleState(state: State): void
Feed a CDJStatus state object to the mix state processor
Parameters
- state: State
Returns void
- Defined in src/mixstatus/index.ts:349

triggerNextTrack

triggerNextTrack(): void
Manually reports the track that has been playing the longest which has not yet been reported as live.

Returns void
- Defined in src/mixstatus/index.ts:416

Class MixstatusProcessor

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional config: Partial<MixstatusConfig>

Returns MixstatusProcessor

Properties

Private Optional #cancelSetEnding

Type declaration

Returns void

Private #config

Private #emitter

Private #isSetActive

Private #lastStartTime

Private #lastState

Private #lastStoppedTimes

Private #livePlayers

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 MixstatusEvents

T

Parameters

this: T

event: P

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

Parameters

Rest ...args: ListenerType<MixstatusEvents[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 MixstatusEvents

T

Parameters

this: T

event: P

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

Parameters

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

Returns void

Returns T

Parameters

event: typeof assignmentCompatibilityHack

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

Parameters

Rest ...args: any[]

Returns any

Returns void

Methods

Private #handleOnairChange

Parameters

state: State

Returns void

Private #handlePlaystateChange

Parameters

lastState: State

`Optional` config: Partial<MixstatusConfig>

`Private` `Optional` #cancelSetEnding

`Private` #config

`Private` #emitter

`Private` #isSetActive

`Private` #lastStartTime

`Private` #lastState

`Private` #lastStoppedTimes

`Private` #livePlayers

`Rest` ...args: any[]

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

`Rest` ...args: any[]

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

`Rest` ...args: any[]

`Private` #handleOnairChange

`Private` #handlePlaystateChange

`Private` #markPlayerStopped

`Private` #onAir

`Private` #playerMayBeFirst

`Private` #playerMayStop

`Private` #promoteNextPlayer

`Private` #promotePlayer

`Private` #setMayStop

`Optional` config: Partial<MixstatusConfig>