Module Musician.Frame

Main window with song import and controls

Functions

MusicianFrame.Clear (focus) Clear import field
MusicianFrame.Focus () Set focus to import field
MusicianFrame.GetDefaultText () Return default text for import text field
MusicianFrame.ImportSource () Import source song
MusicianFrame.Init () Init
MusicianFrame.OnBandPlay (event, player, songCrc32) OnBandPlay
MusicianFrame.OnBandPlayReady (event, player, songCrc32, isReady) OnBandPlayReady
MusicianFrame.OnBandStop (event, player, songCrc32) OnBandStop
MusicianFrame.OnCommChannelUpdate (event, isConnected) OnCommChannelUpdate
MusicianFrame.OnCommSendAction (event, action) OnCommSendAction
MusicianFrame.OnRosterUpdate (event) OnRosterUpdate
MusicianFrame.OnSongPlayOrStop (event, song) OnCommSendAction
MusicianFrame.OnSourceChanged (self, isUserInput) OnSourceChanged
MusicianFrame.OnSourceSongUpdated (event, ...) OnSourceSongUpdated
MusicianFrame.RefreshBandwidthIndicator (event, bandwidth) Regresh bandwidth indicator
MusicianFrame.RefreshLoadingProgressBar (event, song, progression) Refresh loading progress bar
MusicianFrame.RefreshPlayingProgressBar (event, song) Regresh progress bar of the song
MusicianFrame.TogglePreviewSong () Preview source song
MusicianFrame.TrackEditor () Open track editor
MusicianFrame.UpdateBandPlayButton () Update band play button
MusicianFrame.UpdatePlayButton (isEnabled, isPlaying) Update Play button


Functions

MusicianFrame.Clear (focus)
Clear import field

Parameters:

  • focus (boolean)
MusicianFrame.Focus ()
Set focus to import field
MusicianFrame.GetDefaultText ()
Return default text for import text field

Returns:

    (string)
MusicianFrame.ImportSource ()
Import source song
MusicianFrame.Init ()
Init
MusicianFrame.OnBandPlay (event, player, songCrc32)
OnBandPlay

Parameters:

  • event
  • player
  • songCrc32 Display "Started band play" emote in the chat
MusicianFrame.OnBandPlayReady (event, player, songCrc32, isReady)
OnBandPlayReady

Parameters:

  • event
  • player
  • songCrc32
  • isReady Display "Is ready" emote in the chat
MusicianFrame.OnBandStop (event, player, songCrc32)
OnBandStop

Parameters:

  • event
  • player
  • songCrc32 Display "Stopped band play" emote in the chat
MusicianFrame.OnCommChannelUpdate (event, isConnected)
OnCommChannelUpdate

Parameters:

  • event (string)
  • isConnected (boolean)
MusicianFrame.OnCommSendAction (event, action)
OnCommSendAction

Parameters:

  • event (string)
  • action (string)
MusicianFrame.OnRosterUpdate (event)
OnRosterUpdate

Parameters:

  • event
MusicianFrame.OnSongPlayOrStop (event, song)
OnCommSendAction

Parameters:

  • event (string)
  • song (Musician.Song)
MusicianFrame.OnSourceChanged (self, isUserInput)
OnSourceChanged

Parameters:

  • self
  • isUserInput
MusicianFrame.OnSourceSongUpdated (event, ...)
OnSourceSongUpdated

Parameters:

  • event
  • ...
MusicianFrame.RefreshBandwidthIndicator (event, bandwidth)
Regresh bandwidth indicator

Parameters:

  • event (string)
  • bandwidth (number)
MusicianFrame.RefreshLoadingProgressBar (event, song, progression)
Refresh loading progress bar

Parameters:

  • event (string)
  • song (Musician.Song)
  • progression (number)
MusicianFrame.RefreshPlayingProgressBar (event, song)
Regresh progress bar of the song

Parameters:

  • event (string)
  • song (Musician.Song) Can be the source song or the song currently playing
MusicianFrame.TogglePreviewSong ()
Preview source song
MusicianFrame.TrackEditor ()
Open track editor
MusicianFrame.UpdateBandPlayButton ()
Update band play button
MusicianFrame.UpdatePlayButton (isEnabled, isPlaying)
Update Play button

Parameters:

  • isEnabled (boolean)
  • isPlaying (boolean)
generated by LDoc 1.4.6 Last updated 2020-08-09 19:40:05