-
-
Notifications
You must be signed in to change notification settings - Fork 7
API SongLinks
Song links module
-
Functions
- Musician.SongLinks.Init
- Musician.SongLinks.NormalizeTitleForLinks
- Musician.SongLinks.GetHyperlink
- Musician.SongLinks.GetChatLink
- Musician.SongLinks.HyperlinksToChatLinks
- Musician.SongLinks.ChatLinksToHyperlinks
- Musician.SongLinks.ChatLinksToChatBubble
- Musician.SongLinks.OnChatBubbleMsg
- Musician.SongLinks.AddSong
- Musician.SongLinks.AddSongData
- Musician.SongLinks.GetRequestingSong
- Musician.SongLinks.RequestSong
- Musician.SongLinks.RemoveRequest
- Musician.SongLinks.CancelRequest
- Musician.SongLinks.OnRequestSong
- Musician.SongLinks.OnSongError
- Musician.SongLinks.SendSong
- Musician.SongLinks.SendSongData
- Musician.SongLinks.OnSongData
- Musician.SongLinks.OnSongImportProgress
- Musician.SongLinks.OnSongReceived
Initialize song links
Musician.SongLinks.Init()Normalize song title for links
normalizedTitle = Musician.SongLinks.NormalizeTitleForLinks(title)Arguments
- title (string)
Returns
- normalizedTitle (string)
Format song hyperlink
link = Musician.SongLinks.GetHyperlink(title, playerName)Arguments
- title (string)
- playerName (string) (optional)
Returns
- link (string)
Format song link for chat
link = Musician.SongLinks.GetChatLink(title, playerName)Arguments
- title (string)
- playerName (string) (optional)
Returns
- link (string)
Convert hyperlinks into text links for sending in the chat
msg = Musician.SongLinks.HyperlinksToChatLinks(text)Arguments
- text (string)
Returns
- msg (string)
Convert chat text links into hyperlinks
text = Musician.SongLinks.ChatLinksToHyperlinks(msg, playerName)Arguments
- msg (string)
- playerName (string) (optional)
Returns
- text (string)
Convert chat links for chat bubbles
text = Musician.SongLinks.ChatLinksToChatBubble(msg)Arguments
- msg (string)
Returns
- text (string)
OnChatBubbleMsg
Replace chat links in chat bubbles
Musician.SongLinks.OnChatBubbleMsg()Export and add song for sharing
Musician.SongLinks.AddSong(song, title, onComplete)Arguments
- song (Musician.Song)
- title (string) (optional)
- onComplete (function) (optional)
Add song data for sharing
Musician.SongLinks.AddSongData(songData, title)Arguments
- songData (string)
- title (string)
Returns requestedSong data for the player
requestedSong = Musician.SongLinks.GetRequestingSong(playerName)Arguments
- playerName (string)
Returns
- requestedSong (table)
Request a song for download to a player
Musician.SongLinks.RequestSong(title, playerName, dataOnly, context)Arguments
- title (string)
- playerName (string)
- dataOnly (boolean) _(default=false)
- context (table) Reference to the module that initiated the song request. (optional)
Remove a song download request
Musician.SongLinks.RemoveRequest(playerName)Arguments
- playerName (string)
Cancel a song download request
Musician.SongLinks.CancelRequest(playerName)Arguments
- playerName (string)
OnRequestSong
Musician.SongLinks.OnRequestSong()OnSongError
Musician.SongLinks.OnSongError()Send song to another player by title
Musician.SongLinks.SendSong(title, playerName)Arguments
- title (string)
- playerName (string)
Send song data to another player
Musician.SongLinks.SendSongData(title, playerName, songData)Arguments
- title (string)
- playerName (string)
- songData (string)
OnSongData
Notify download progression
Musician.SongLinks.OnSongData()OnSongImportProgress
Notify import progression
Musician.SongLinks.OnSongImportProgress()OnSongReceived
Song data has been received
Musician.SongLinks.OnSongReceived()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