https://github.com/ddddxxx/LyricsKit

Lyrics submodule for LyricsX
https://github.com/ddddxxx/LyricsKit

combine-compatible-package lyrics

Last synced: 3 months ago
JSON representation

Lyrics submodule for LyricsX

• Host: GitHub
• URL: https://github.com/ddddxxx/LyricsKit
• Owner: ddddxxx
• License: mpl-2.0
• Created: 2017-03-07T02:29:58.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-02-17T14:29:00.000Z (9 months ago)
• Last Synced: 2024-07-04T04:32:54.356Z (4 months ago)
• Topics: combine-compatible-package, lyrics
• Language: Swift
• Homepage: https://github.com/ddddxxx/LyricsX
• Size: 454 KB
• Stars: 125
• Watchers: 6
• Forks: 41
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# LyricsKit

Lyrics submodule for [LyricsX](https://github.com/ddddxxx/LyricsX).

## Supported Sources

- NetEase Music

- QQ Music

- Kugou Music

- TTPod

- Gecimi

- Syair

- Xiami Music (discontinued)

- ViewLyrics (not working anymore)

## Usage

#### Search lyrics from the internet

```swift

import LyricsService

// create a search request

let song = "Tranquilize"

let artist = "The Killers"

let duration = 225.2

let searchReq = LyricsSearchRequest(

    searchTerm: .info(title: song, artist: artist),

    duration: duration

)

// choose a lyrics service provider

let provider = LyricsProviders.Kugou()

// or search from multiple sources

let provider = LyricsProviders.Group(service: [.kugou, .netease, .qq])

// search

provider.lyricsPublisher(request: searchReq).sink { lyrics in

    print(lyrics)

}

```

## License

LyricsKit is part of LyricsX and licensed under MPL 2.0. See the [LICENSE file](LICENSE).

## LRCX file

### Specification

```

              ::=  (NEWLINE )*

              ::= 

                      | 

                      | 

                      | ""

            ::= 

               ::= "["  "]"

       ::= 

                      |  ":" 

           ::= [0-9a-zA-Z_-]+

         ::= +

        ::=  *

  ::=   

          ::= "[" ( ":")*  ("." )* "]"

            ::= 

           ::= 

                              | 

                              | 

     ::= +

    ::= +

    ::= +

       ::= "<"  ","  ">"

       ::= "<"  ","  ">"

             ::= ">

             ::= 

             ::=  "," 

```

### Predefined tags

Predefined ID tags:

| Tag | Key | Value Type | Description |

| --- | --- | --- | --- |

| title | ti | string | |

| album | al | string | |

| artist | ar | string | |

| offset | offset | integer | |

| length | length | decimal | |

Predefind attachment tags:

| Tag | Key | Value Type | Attachment type | Description |

| --- | --- | --- | --- | --- |

| translation | tr | [RFC 4646](https://www.ietf.org/rfc/rfc4646.txt) | plain text | |

| word time tag | tt | no value | index based (with timestamp in millisecond) | |

| furigana | fu | no value | range based | |

| romaji | ro | no value | range based | |