API Communication

Communication module

• Functions
  • Musician.Comm.Init
  • Musician.Comm.JoinChannel
  • Musician.Comm.GetGroupChatType
  • Musician.Comm.BroadcastCommMessage
  • Musician.Comm.GetChannel
  • Musician.Comm.ChannelIsReady
  • Musician.Comm.InChatMessagingLockdown
  • Musician.Comm.CanBroadcast
  • Musician.Comm.CanPlay
  • Musician.Comm.PlaySong
  • Musician.Comm.TogglePlaySong
  • Musician.Comm.StreamSongChunk
  • Musician.Comm.StreamCompressedSongChunk
  • Musician.Comm.GetBandwidthColor
  • Musician.Comm.ProcessChunk
  • Musician.Comm.OnChunk
  • Musician.Comm.StopSong
  • Musician.Comm.IsSongPlaying
  • Musician.Comm.OnStopSong
  • Musician.Comm.GetReadyBandPlayers
  • Musician.Comm.OnGroupJoined
  • Musician.Comm.QueryBandReady
  • Musician.Comm.OnBandReadyQuery
  • Musician.Comm.OnGroupLeft
  • Musician.Comm.OnRosterUpdate
  • Musician.Comm.GetCurrentSongCrc32
  • Musician.Comm.UpdateCurrentSongCrc32
  • Musician.Comm.OnSongLoaded
  • Musician.Comm.IsBandPlayReady
  • Musician.Comm.ToggleBandPlayReady
  • Musician.Comm.SetBandPlayReady
  • Musician.Comm.OnBandPlayReady
  • Musician.Comm.PlaySongBand
  • Musician.Comm.OnBandPlay
  • Musician.Comm.StopSongBand
  • Musician.Comm.OnBandStop
  • Musician.Comm.OnSongPlay
  • Musician.Comm.OnSongStop
  • Musician.Comm.OnDead

Functions

Musician.Comm.Init

Initialize communication

Musician.Comm.Init()

Musician.Comm.JoinChannel

Join the communication channel and keep it joined

Musician.Comm.JoinChannel()

Musician.Comm.GetGroupChatType

Return communication chat type for group

chatType = Musician.Comm.GetGroupChatType()

Returns

• chatType (string)

Musician.Comm.BroadcastCommMessage

Broadcast communication message using appropriate channels

Musician.Comm.BroadcastCommMessage(message, type, groupType)

Arguments

• message (string)
• type (string)
• groupType (string) (optional)

Musician.Comm.GetChannel

Return the communication channel ID

channelId = Musician.Comm.GetChannel()

Returns

• channelId (string)

Musician.Comm.ChannelIsReady

Return true if the communication channel is ready

isReady = Musician.Comm.ChannelIsReady()

Returns

• isReady (boolean)

Musician.Comm.InChatMessagingLockdown

Return true if the game is in messaging lockdown (ie during a boss fight in a dungeon)

inLockdown = Musician.Comm.InChatMessagingLockdown()

Returns

• inLockdown (boolean)

Musician.Comm.CanBroadcast

Return true if the player can broadcast via the channel or the group chat

canBroadcast = Musician.Comm.CanBroadcast()

Returns

• canBroadcast (boolean)

Musician.Comm.CanPlay

Return true if the player can play music

canPlay = Musician.Comm.CanPlay()

Returns

• canPlay (boolean)

Musician.Comm.PlaySong

Play song

success = Musician.Comm.PlaySong()

Returns

• success (boolean)

Musician.Comm.TogglePlaySong

Toggle play song

Musician.Comm.TogglePlaySong()

Musician.Comm.StreamSongChunk

Stream a packed song chunk

Musician.Comm.StreamSongChunk(packedChunk)

Arguments

• packedChunk (string)

Musician.Comm.StreamCompressedSongChunk

Stream a compressed song chunk

success = Musician.Comm.StreamCompressedSongChunk(compressedChunk)

Arguments

• compressedChunk (string)

Returns

• success (boolean)

Musician.Comm.GetBandwidthColor

Get bandwidth color

r, g, b = Musician.Comm.GetBandwidthColor(bandwidth, blink)

Arguments

• bandwidth (number)
• blink (boolean)

Returns

• r (number)
• g (number)
• b (number)

Musician.Comm.ProcessChunk

Process a packed chunk

Musician.Comm.ProcessChunk(packedChunk, sender)

Arguments

• packedChunk (string)
• sender (string)

Musician.Comm.OnChunk

Receive compressed chunk

Musician.Comm.OnChunk()

Musician.Comm.StopSong

Stop song

success = Musician.Comm.StopSong()

Returns

• success (boolean)

Musician.Comm.IsSongPlaying

Indicate if the player song is playing

isSongPlaying = Musician.Comm.IsSongPlaying()

Returns

• isSongPlaying (boolean)

Musician.Comm.OnStopSong

Stop a song

Musician.Comm.OnStopSong()

Musician.Comm.GetReadyBandPlayers

Return the list of ready band players for the current source song

readyPlayers = Musician.Comm.GetReadyBandPlayers()

Returns

• readyPlayers (table)

Musician.Comm.OnGroupJoined

OnGroupJoined

Musician.Comm.OnGroupJoined()

Musician.Comm.QueryBandReady

QueryBandReady

Musician.Comm.QueryBandReady()

Musician.Comm.OnBandReadyQuery

OnBandReadyQuery

Musician.Comm.OnBandReadyQuery()

Musician.Comm.OnGroupLeft

OnGroupLeft

Musician.Comm.OnGroupLeft()

Musician.Comm.OnRosterUpdate

OnRosterUpdate

Musician.Comm.OnRosterUpdate()

Musician.Comm.GetCurrentSongCrc32

Return current song CRC32

songCrc32 = Musician.Comm.GetCurrentSongCrc32()

Returns

• songCrc32 (number)

Musician.Comm.UpdateCurrentSongCrc32

Update current song CRC32

Musician.Comm.UpdateCurrentSongCrc32(songCrc32)

Arguments

• songCrc32 (number)

Musician.Comm.OnSongLoaded

OnSongLoaded

Musician.Comm.OnSongLoaded()

Musician.Comm.IsBandPlayReady

Indicate if the player is ready for band play

isBandPlayReady = Musician.Comm.IsBandPlayReady()

Returns

• isBandPlayReady (boolean)

Musician.Comm.ToggleBandPlayReady

Toggle band play ready

Musician.Comm.ToggleBandPlayReady()

Musician.Comm.SetBandPlayReady

Set band play ready

success = Musician.Comm.SetBandPlayReady(isReady)

Arguments

• isReady (boolean)

Returns

• success (boolean)

Musician.Comm.OnBandPlayReady

Receive band ready or not ready message

Musician.Comm.OnBandPlayReady()

Musician.Comm.PlaySongBand

Play song as a band

success = Musician.Comm.PlaySongBand()

Returns

• success (boolean)

Musician.Comm.OnBandPlay

OnBandPlay

Musician.Comm.OnBandPlay()

Musician.Comm.StopSongBand

Stop song as a band

success = Musician.Comm.StopSongBand()

Returns

• success (boolean)

Musician.Comm.OnBandStop

OnBandStop

Musician.Comm.OnBandStop()

Musician.Comm.OnSongPlay

OnSongPlay

Musician.Comm.OnSongPlay()

Musician.Comm.OnSongStop

OnSongStop

Musician.Comm.OnSongStop()

Musician.Comm.OnDead

OnDead

Stop music when dead

Musician.Comm.OnDead()