View on GitHub
KaraokeSongData Structure Reference
KaraokeSongData
public struct KaraokeSongData : ContentReturns information about a song in the Karaoke Song Library.
Returned by: GET /api/v3/karaoke/:song_id
Incorporated into: KaraokeSongResponseData
-
The database ID of the song. Used to mark favorite songs and to log song performances.
Declaration
Swift
var songID: UUID -
The artist or band that produced the song.
Declaration
Swift
var artist: String -
The title of the song
Declaration
Swift
var songName: String -
If TRUE, this song is a MIDI track.
Declaration
Swift
var isMidi: Bool -
If TRUE, this track is the regular released version of the song, post-processed with voice removal software. If FALSE, the track is (assumedly) the karaoke mix of the track.
Declaration
Swift
var isVoiceReduced: Bool -
TRUE if this user has favorited this song. Always FALSE if not logged in.
Declaration
Swift
var isFavorite: Bool -
An array of performances of this song in the Karaoke Lounge on boat this year. [] if the song hasn’t been performed.
Declaration
Swift
var performances: [KaraokePerformedSongsData] -
Declaration
Swift
init(with song: KaraokeSong, isFavorite: Bool) throws