API documentation

• Functions
  • Main
    • Musician.ImportSource
    • Musician.MutePlayer
    • Musician.PlayerIsMuted
  • Communication
    • Musician.Comm.CanBroadcast()
    • Musician.Comm.CanPlay()
    • Musician.Comm.PlaySong()
    • Musician.Comm.StopSong()
    • Musician.Comm.TogglePlaySong()
    • Musician.Comm.GetCurrentSongCrc32()
    • Musician.Comm.SetBandPlayReady(isReady)
    • Musician.Comm.QueryBandReady()
    • Musician.Comm.IsBandPlayReady()
    • Musician.Comm.PlaySongBand()
    • Musician.Comm.StopSongBand()
  • Registry
    • Musician.Registry.PlayerIsInLoadingRange(player)
    • Musician.Registry.PlayerIsInRange(player)
    • Musician.Registry.GetPlayerGUID(player)
    • Musician.Registry.SendHello()
    • Musician.Registry.PlayerIsRegistered(player)
    • Musician.Registry.PlayerIsRegisteredWithVersion(player)
  • Live
    • Musician.Live.Enable(enabled)
    • Musician.Live.IsEnabled()
    • Musician.Live.IsPlayingLive()
    • Musician.Live.CanStream()
    • Musician.Live.NoteOn(key, layer, instrument, isChordNote)
    • Musician.Live.NoteOff(key, layer, instrument, isChordNote)
    • Musician.Live.AllNotesOff(onlyForLayer)
    • Musician.Live.InsertNote(noteOn, key, layer, instrument)
    • Musician.Live.IsBandSyncMode()
    • Musician.Live.SetBandSyncMode(enabled)
    • Musician.Live.ToggleBandSyncMode()
    • Musician.Live.IsPlayerSynced(player)
    • Musician.Live.BandNote(noteOn, key, layer, instrument)
• Classes
  • Musician.Song
  • Musician.VolumeMeter
• Events
  • Musician.Events.Frame
  • Musician.Events.RegistryReady
  • Musician.Events.CommChannelUpdate
  • Musician.Events.CommSendAction
  • Musician.Events.CommSendActionComplete
  • Musician.Events.SongPlay
  • Musician.Events.SongStop
  • Musician.Events.SongChunk
  • Musician.Events.StreamStart
  • Musician.Events.StreamStop
  • Musician.Events.SongCursor
  • Musician.Events.SongInstrumentChange
  • Musician.Events.NoteOn
  • Musician.Events.NoteOff
  • Musician.Events.VisualNoteOn
  • Musician.Events.VisualNoteOff
  • Musician.Events.LiveNoteOn
  • Musician.Events.LiveNoteOff
  • Musician.Events.NoteDropped
  • Musician.Events.PreloadingProgress
  • Musician.Events.PreloadingComplete
  • Musician.Events.SongImportStart
  • Musician.Events.SongImportProgress
  • Musician.Events.SongImportComplete
  • Musician.Events.SongImportSucessful
  • Musician.Events.SongImportFailed
  • Musician.Events.SourceSongLoaded
  • Musician.Events.PromoEmote
  • Musician.Events.Bandwidth
  • Musician.Events.BandPlay
  • Musician.Events.BandStop
  • Musician.Events.BandPlayReady
  • Musician.Events.BandReadyPlayersUpdated
  • Musician.Events.LiveBandSync

Functions

Main

Musician.ImportSource

Import song from encoded string. Triggers SongImport* events

Musician.ImportSource(str)

Arguments

• str (string)

Musician.MutePlayer

Mute or unmute a player

Musician.MutePlayer(playerName, isMuted)

Arguments

• playerName (string)
• isMuted (boolean)

Musician.PlayerIsMuted

Returns true if the player is muted

isMuted = Musician.PlayerIsMuted(playerName)

Arguments

• playerName (string) Returns isMuted (boolean)

Communication

Musician.Comm.CanBroadcast()

Musician.Comm.CanPlay()

Musician.Comm.PlaySong()

Musician.Comm.StopSong()

Musician.Comm.TogglePlaySong()

Musician.Comm.GetCurrentSongCrc32()

Musician.Comm.SetBandPlayReady(isReady)

Musician.Comm.QueryBandReady()

Musician.Comm.IsBandPlayReady()

Musician.Comm.PlaySongBand()

Musician.Comm.StopSongBand()

Registry

Musician.Registry.PlayerIsInLoadingRange(player)

Musician.Registry.PlayerIsInRange(player)

Musician.Registry.GetPlayerGUID(player)

Musician.Registry.SendHello()

Musician.Registry.PlayerIsRegistered(player)

Musician.Registry.PlayerIsRegisteredWithVersion(player)

Live

Musician.Live.Enable(enabled)

Musician.Live.IsEnabled()

Musician.Live.IsPlayingLive()

Musician.Live.CanStream()

Musician.Live.NoteOn(key, layer, instrument, isChordNote)

Musician.Live.NoteOff(key, layer, instrument, isChordNote)

Musician.Live.AllNotesOff(onlyForLayer)

Musician.Live.InsertNote(noteOn, key, layer, instrument)

Musician.Live.IsBandSyncMode()

Musician.Live.SetBandSyncMode(enabled)

Musician.Live.ToggleBandSyncMode()

Musician.Live.IsPlayerSynced(player)

Musician.Live.BandNote(noteOn, key, layer, instrument)

Classes

Musician.Song

Musician.VolumeMeter

Events

Musician.Events.Frame

Musician.Events.RegistryReady

Musician.Events.CommChannelUpdate

Musician.Events.CommSendAction

Musician.Events.CommSendActionComplete

Musician.Events.SongPlay

Musician.Events.SongStop

Musician.Events.SongChunk

Musician.Events.StreamStart

Musician.Events.StreamStop

Musician.Events.SongCursor

Musician.Events.SongInstrumentChange

Musician.Events.NoteOn

Musician.Events.NoteOff

Musician.Events.VisualNoteOn

Musician.Events.VisualNoteOff

Musician.Events.LiveNoteOn

Musician.Events.LiveNoteOff

Musician.Events.NoteDropped

Musician.Events.PreloadingProgress

Musician.Events.PreloadingComplete

Musician.Events.SongImportStart

Musician.Events.SongImportProgress

Musician.Events.SongImportComplete

Musician.Events.SongImportSucessful

Musician.Events.SongImportFailed

Musician.Events.SourceSongLoaded

Musician.Events.PromoEmote

Musician.Events.Bandwidth

Musician.Events.BandPlay

Musician.Events.BandStop

Musician.Events.BandPlayReady

Musician.Events.BandReadyPlayersUpdated

Musician.Events.LiveBandSync