MicroKaraokeCompletedSong

public struct MicroKaraokeCompletedSong : Content

Used to return a list of completed Micro Karaoke songs, that is, finished videos the user can watch.

Returned by:

  • GET /api/v3/karaoke/mk/songlist

See UsersController.headerHandler(_:), ClientController.userHeadersHandler(_:).

Show on GitHub

  • Each song the server works on collecting (via piecing together multiple song clips from users) gets an ID

    Declaration

    Swift

    var songID: Int
    Show on GitHub

  • Declaration

    Swift

    var songName: String
    Show on GitHub

  • The artist, as they’d appear in karaoke metadata

    Declaration

    Swift

    var artistName: String
    Show on GitHub

  • How many song slots this song has. NOT how many are currently filled. This number includes pre-filled ‘filler’ slots for instrumental sections.

    Declaration

    Swift

    var totalSnippetSlots: Int
    Show on GitHub

  • Always TRUE unless the user is a mod, in which case will be FALSE for songs that have all the necessary clips recorded but require mod approval to publish.

    Declaration

    Swift

    var modApproved: Bool
    Show on GitHub

  • When the song’s clips were last modified. Usually the time the final snippet gets uploaded (although ‘final’ means ‘30th out of 30’ and not ‘the one at the end of the song’). However, clips can get deleted via moderation, causing the server to re-issue an offer for the deleted clip, which may change the completion time. NIL if song isn’t complete

    Declaration

    Swift

    var completionTime: Date?
    Show on GitHub

  • TRUE if the current user contributed to the song

    Declaration

    Swift

    var userContributed: Bool
    Show on GitHub

  • Declaration

    Swift

    init(from song: MKSong, userContributed: Bool) throws
    Show on GitHub