-
-
Notifications
You must be signed in to change notification settings - Fork 7
API Live
Live play module
-
Functions
- Musician.Live.Init
- Musician.Live.Enable
- Musician.Live.IsEnabled
- Musician.Live.IsPlayingLive
- Musician.Live.CanStream
- Musician.Live.CreateLiveSong
- Musician.Live.InsertNote
- Musician.Live.SetSustain
- Musician.Live.NoteOn
- Musician.Live.NoteOff
- Musician.Live.BandNote
- Musician.Live.AllNotesOff
- Musician.Live.IsBandSyncMode
- Musician.Live.IsPlayerSynced
- Musician.Live.GetSyncedBandPlayers
- Musician.Live.ToggleBandSyncMode
- Musician.Live.SetBandSyncMode
- Musician.Live.OnBandSync
- Musician.Live.OnGroupJoined
- Musician.Live.OnBandSyncQuery
- Musician.Live.OnGroupLeft
- Musician.Live.OnRosterUpdate
- Musician.Live.OnLiveNote
Init live mode
Musician.Live.Init()Enable or disable live mode
Musician.Live.Enable(enabled)Arguments
- enabled (boolean)
Indicate whenever the live mode is enabled
isLiveEnabled = Musician.Live.IsEnabled()Returns
- isLiveEnabled (boolean)
Indicate whenever the player is playing live, regardless if in solo or live mode
isPlayingLive = Musician.Live.IsPlayingLive()Returns
- isPlayingLive (boolean)
Indicate whenever the live mode can stream
canStream = Musician.Live.CanStream()Returns
- canStream (boolean)
Create the live song for streaming, if needed
and assign it to Musician.streamingSong
Musician.Live.CreateLiveSong()Send note
Musician.Live.InsertNote(noteOn, key, layer, instrument)Arguments
- noteOn (boolean) Note on/off
- key (int) MIDI key index
- layer (int)
- instrument (int)
Set sustain state for the layer
Musician.Live.SetSustain(enable, layer)Arguments
- enable (boolean)
- layer (int)
Send note on
Musician.Live.NoteOn(key, layer, instrument, isChordNote)Arguments
- key (int) MIDI key index
- layer (int)
- instrument (int)
- isChordNote (boolean)
Send note off
Musician.Live.NoteOff(key, layer, instrument, isChordNote, ignoreSustain)Arguments
- key (int) MIDI key index
- layer (int)
- instrument (int)
- isChordNote (boolean)
- ignoreSustain (boolean) Force note off even is sustain is enabled for this layer _(default=false)
Send note event in band mode
Musician.Live.BandNote(noteOn, key, layer, instrument)Arguments
- noteOn (boolean)
- key (int) MIDI key index
- layer (int)
- instrument (int)
Set all notes to off
Musician.Live.AllNotesOff(onlyForLayer)Arguments
- onlyForLayer (int)
Indicate if the player in band sync mode
isBandSyncMode = Musician.Live.IsBandSyncMode()Returns
- isBandSyncMode (boolean)
Indicate if the provided player is in band sync mode
isPlayerSynced = Musician.Live.IsPlayerSynced(player)Arguments
- player (string)
Returns
- isPlayerSynced (boolean)
Return the list of synced band players
readyPlayers = Musician.Live.GetSyncedBandPlayers()Returns
- readyPlayers (table)
Set sync mode
Musician.Live.ToggleBandSyncMode(enabled)Arguments
- enabled (boolean)
Set band sync mode
success = Musician.Live.SetBandSyncMode(enabled)Arguments
- enabled (boolean)
Returns
- success (boolean)
Receive band sync mode message
Musician.Live.OnBandSync()OnGroupJoined
Musician.Live.OnGroupJoined()OnBandSyncQuery
Musician.Live.OnBandSyncQuery()OnGroupLeft
Musician.Live.OnGroupLeft()OnRosterUpdate
Musician.Live.OnRosterUpdate()OnLiveNote
Musician.Live.OnLiveNote()Table of contents
- User guide (FR)
- Optional modules
- What the FAQ
- Tips and Tricks
- Music producer guide
- Localization
- Technical design
- API documentation
Discord / MusicianList / Patreon / Donate