ListenBrainzKit

ListenBrainzKit 是一个围绕 ListenBrainz API 构建的 Swift 封装库，最初是为我的 iOS 音乐应用 Jewelcase 而构建的。

要求

Swift 6
iOS 16+
macOS 13+
tvOS 16+
visionOS 1+
watchOS 9+

设置

在您的 Package.swift 文件中将 ListenBrainzKit 添加为依赖项

dependencies: [
    .package(url: "https://github.com/samglt/ListenBrainzKit.git", from: "0.1.0"),
],

或者在 Xcode 中通过选择 File > Add Package Dependencies... 并输入 https://github.com/samglt/ListenBrainzKit 来添加它

用法

您可以使用 ListenBrainz 令牌和一个可选的自定义根 URL 初始化客户端。如果您不使用官方的 ListenBrainz 端点（例如，如果您运行自己的实例）。

import ListenBrainzKit

let client = LBClient(token: token)
// or:
let client = LBClient(token: token, customRoot: URL(string: "https://10.0.0.10:1234")!)

提交收听记录

// Submit a single listen
try await client.core.submitListen(meta: .init(artist: "Kylie Minogue",
                                               track: "Come Into My World",
                                               release: "Fever",
                                               tracknumber: 7),
                                   at: time)

// Submit a batch of past listens
try await client.core.submitListens([
    .init(meta: .init(artist: "Kylie Minogue",
                      track: "Fever"),
          listenedAt: Date.now.addingTimeInterval(-180)),
    .init(meta: .init(artist: "Kylie Minogue",
                      track: "More More More"),
          listenedAt: Date.now.addingTimeInterval(-360))
])

开发

运行集成测试需要在环境变量 LISTENBRAINZ_TOKEN 中设置 ListenBrainz 令牌

支持的端点

核心
- GET /1/search/users/
- POST /1/submit-listens
- GET /1/user/(user_name)/listens
- GET /1/user/(user_name)/listen-count
- GET /1/user/(user_name)/playing-now
- GET /1/user/(user_name)/similar-users
- GET /1/user/(user_name)/similar-to/(other_user_name)
- GET /1/validate-token
- POST /1/delete-listen
- GET /1/user/(playlist_user_name)/playlists
- GET /1/user/(playlist_user_name)/playlists/createdfor
- GET /1/user/(playlist_user_name)/playlists/collaborator
- GET /1/user/(playlist_user_name)/playlists/recommendations
- GET /1/user/(playlist_user_name)/playlists/search
- GET /1/user/(user_name)/services
- GET /1/lb-radio/tags
- GET /1/lb-radio/artist/(seed_artist_mbid)
- GET /1/latest-import
- POST /1/latest-import
元数据
- GET /1/metadata/recording/
- POST /1/metadata/recording/
- GET /1/metadata/release_group/
- GET /1/metadata/lookup/
- POST /1/metadata/lookup/
- GET /1/metadata/artist/
- POST /1/metadata/submit_manual_mapping/
- GET /1/metadata/get_manual_mapping/
统计
- GET /1/stats/user/(user_name)/artists
- GET /1/stats/user/(user_name)/releases
- GET /1/stats/user/(user_name)/release-groups
- GET /1/stats/user/(user_name)/recordings
- GET /1/stats/user/(user_name)/listening-activity
- GET /1/stats/user/(user_name)/daily-activity
- GET /1/stats/user/(user_name)/artist-map
- GET /1/stats/artist/(artist_mbid)/listeners
- GET /1/stats/release-group/(release_group_mbid)/listeners
- GET /1/stats/sitewide/artists
- GET /1/stats/sitewide/releases
- GET /1/stats/sitewide/release-groups
- GET /1/stats/sitewide/recordings
- GET /1/stats/sitewide/listening-activity
- GET /1/stats/sitewide/artist-map
- GET /1/stats/user/(user_name)/year-in-music/(int: year)
- GET /1/stats/user/(user_name)/year-in-music
流行度
- GET /1/popularity/top-recordings-for-artist/(artist_mbid)
- GET /1/popularity/top-release-groups-for-artist/(artist_mbid)
- POST /1/popularity/recording
- POST /1/popularity/artist
- POST /1/popularity/release
- POST /1/popularity/release-group
播放列表
- GET /1/user/(playlist_user_name)/playlists
- GET /1/user/(playlist_user_name)/playlists/createdfor
- GET /1/user/(playlist_user_name)/playlists/collaborator
- POST /1/playlist/create
- GET /1/playlist/search
- POST /1/playlist/edit/(playlist_mbid)
- GET /1/playlist/(playlist_mbid)
- GET /1/playlist/(playlist_mbid)/xspf
- POST /1/playlist/(playlist_mbid)/item/add
- POST /1/playlist/(playlist_mbid)/item/add/(int: offset)
- POST /1/playlist/(playlist_mbid)/item/move
- POST /1/playlist/(playlist_mbid)/item/delete
- POST /1/playlist/(playlist_mbid)/delete
- POST /1/playlist/(playlist_mbid)/copy
- POST /1/playlist/(playlist_mbid)/export/(service)
- GET /1/playlist/import/(service)
- GET /1/playlist/(service)/(playlist_id)/tracks
- POST /1/playlist/export-jspf/(service)
录音
- POST /1/feedback/recording-feedback
- GET /1/feedback/user/(user_name)/get-feedback
- GET /1/feedback/recording/(recording_mbid)/get-feedback-mbid
- GET /1/feedback/recording/(recording_msid)/get-feedback
- GET /1/feedback/user/(user_name)/get-feedback-for-recordings
- POST /1/feedback/user/(user_name)/get-feedback-for-recordings
- POST /1/feedback/import
- 固定录音 API
  - POST /1/pin
  - POST /1/pin/unpin
  - POST /1/pin/delete/(row_id)
  - GET /1/(user_name)/pins
  - GET /1/(user_name)/pins/following
  - GET /1/(user_name)/pins/current
  - POST /1/pin/update/(row_id)
社交
- POST /1/user/(user_name)/timeline-event/create/recording
- POST /1/user/(user_name)/timeline-event/create/notification
- POST /1/user/(user_name)/timeline-event/create/review
- GET /1/user/(user_name)/feed/events
- GET /1/user/(user_name)/feed/events/listens/following
- GET /1/user/(user_name)/feed/events/listens/similar
- POST /1/user/(user_name)/feed/events/delete
- POST /1/user/(user_name)/feed/events/hide
- POST /1/user/(user_name)/feed/events/unhide
- POST /1/user/(user_name)/timeline-event/create/recommend-personal
- 关注 API
  - GET /1/user/(user_name)/followers
  - GET /1/user/(user_name)/following
  - POST /1/user/(user_name)/follow
  - POST /1/user/(user_name)/unfollow
推荐
- GET /1/cf/recommendation/user/(user_name)/recording
- 反馈
  - POST /1/recommendation/feedback/submit
  - POST /1/recommendation/feedback/delete
  - GET /1/recommendation/feedback/user/(user_name)
  - GET /1/recommendation/feedback/user/(user_name)/recordings
艺术
- POST /1/art/grid/
- GET /1/art/grid-stats/(user_name)/(time_range)/(int: dimension)/(int: layout)/(int: image_size)
- GET /1/art/(custom_name)/(user_name)/(time_range)/(int: image_size)
- GET /1/art/year-in-music/(int: year)/(user_name)
其他
- 探索
  - GET /1/explore/fresh-releases/
  - GET /1/explore/color/(color)
  - GET /1/explore/lb-radio
- 状态
  - GET /1/status/get-dump-info