Module Musician.Live
Live play module
Functions
Functions
- Musician.Live.AllNotesOff (onlyForLayer)
-
Set all notes to off
Parameters:
- onlyForLayer (int)
- Musician.Live.BandNote (noteOn, key, layer, instrument)
-
Send note event in band mode
Parameters:
- noteOn (boolean)
- key (int) MIDI key index
- layer (int)
- instrument (int)
- Musician.Live.CanStream ()
-
Indicate whenever the live mode can stream
Returns:
-
canStream (boolean)
- Musician.Live.CreateLiveSong ()
- Create the live song for streaming, if needed and assign it to Musician.streamingSong
- Musician.Live.Enable (enabled)
-
Enable or disable live mode
Parameters:
- enabled (boolean)
- Musician.Live.GetSyncedBandPlayers ()
-
Return the list of synced band players
Returns:
-
readyPlayers (table)
- Musician.Live.Init ()
- Init live mode
- Musician.Live.InsertNote (noteOn, key, layer, instrument)
-
Send note
Parameters:
- noteOn (boolean) Note on/off
- key (int) MIDI key index
- layer (int)
- instrument (int)
- Musician.Live.IsBandSyncMode ()
-
Indicate if the player in band sync mode
Returns:
-
isBandSyncMode (boolean)
- Musician.Live.IsEnabled ()
-
Indicate whenever the live mode is enabled
Returns:
-
isLiveEnabled (boolean)
- Musician.Live.IsPlayerSynced (player)
-
Indicate if the provided player is in band sync mode
Parameters:
- player (string)
Returns:
-
isPlayerSynced (boolean)
- Musician.Live.IsPlayingLive ()
-
Indicate whenever the player is playing live, regardless if in solo or live mode
Returns:
-
isPlayingLive (boolean)
- Musician.Live.NoteOff (key, layer, instrument[, isChordNote=false[, ignoreSustain=false]])
-
Send note off
Parameters:
- key (int) MIDI key index
- layer (int)
- instrument (int)
- isChordNote (boolean) (default false)
- ignoreSustain (boolean) Force note off even is sustain is enabled for this layer (default false)
- Musician.Live.NoteOn (key, layer, instrument[, isChordNote=false[, source]])
-
Send note on
Parameters:
- key (int) MIDI key index
- layer (int)
- instrument (int)
- isChordNote (boolean) (default false)
- source (table) UI component triggering the note (optional)
- Musician.Live.OnBandSync (prefix, message, distribution, sender)
-
Receive band sync mode message
Parameters:
- prefix
- message
- distribution
- sender
- Musician.Live.OnBandSyncQuery (prefix, message, distribution, sender)
-
OnBandSyncQuery
Parameters:
- prefix
- message
- distribution
- sender
- Musician.Live.OnGroupJoined ()
- OnGroupJoined
- Musician.Live.OnGroupLeft ()
- OnGroupLeft
- Musician.Live.OnLiveNote (prefix, message, distribution, sender)
-
OnLiveNote
Parameters:
- prefix
- message
- distribution
- sender
- Musician.Live.OnRosterUpdate ()
- OnRosterUpdate
- Musician.Live.SetBandSyncMode (enabled)
-
Set band sync mode
Parameters:
- enabled (boolean)
Returns:
-
success (boolean)
- Musician.Live.SetSustain (enable, layer)
-
Set sustain state for the layer
Parameters:
- enable (boolean)
- layer (int)
- Musician.Live.ToggleBandSyncMode (enabled)
-
Set sync mode
Parameters:
- enabled (boolean)