statemap.md

StateMap Service

The StateMap service provides real-time state tracking for DJ decks, including track information, playback state, fader positions, and more.

Usage

import { StageLinq } from 'stagelinq';

const stagelinq = new StageLinq();

stagelinq.devices.on('stateChanged', (state) => {
  console.log(`${state.name}: ${state.value}`);
});

stagelinq.devices.on('stateMessage', (data) => {
  // Raw state message
});

// Listen to specific state paths
stagelinq.devices.on('/Engine/Deck1/CurrentBPM', (bpm) => {
  console.log(`Deck 1 BPM: ${bpm}`);
});

await stagelinq.connect();

State Categories

Track Information

State	Type	Description
ArtistName	string	Track artist
SongName	string	Track title
TrackName	string	Full track name
AlbumName	string	Album name
Genre	string	Genre
Label	string	Record label
TrackLength	number	Duration in seconds
TrackNetworkPath	string	Network path to track
TrackURI	string	Track URI

Playback State

State	Type	Description
Play	boolean	Is playing
PlayState	number	Play state enum
CurrentBPM	number	Current BPM
Speed	number	Playback speed (1.0 = normal)
SpeedRange	number	Pitch range setting

Sync & Master

State	Type	Description
SyncMode	number	Sync mode (off/beat/bar)
DeckIsMaster	boolean	Is tempo master
MasterTempo	number	Master tempo BPM

Key & Pitch

State	Type	Description
CurrentKeyIndex	number	Musical key index
KeyLock	boolean	Key lock enabled

Loop

State	Type	Description
LoopEnableState	boolean	Loop active
CurrentLoopInPosition	number	Loop in point
CurrentLoopOutPosition	number	Loop out point
CurrentLoopSizeInBeats	number	Loop size in beats

Cue Points

State	Type	Description
CuePosition	number	Main cue position
HotCue1 - HotCue8	object	Hot cue data

Mixer

State	Type	Description
ExternalMixerVolume	number	Channel fader (0-1)
CrossfaderPosition	number	Crossfader position

State Path Format

States are organized by deck:

/Engine/Deck1/CurrentBPM
/Engine/Deck2/CurrentBPM
/Engine/Deck3/CurrentBPM
/Engine/Deck4/CurrentBPM

Mixer states use a different path:

/Mixer/CrossfaderPosition
/Mixer/ChannelFader1

Full State List

See events.md for the complete list of 200+ states.