Flutter音频资源获取插件khinsider_sdk的使用

Khinsider SDK

一个用于从 Khinsider 获取游戏音乐文件的SDK。

特性

• 查询专辑列表。
• 查询特定专辑以获取所有可用的原声带。
• 获取特定原声带在所有可用格式下的下载链接。

开始使用

实例化一个 Khinsider 对象以访问可用的功能。

Khinsider client = Khinsider();

列出专辑

调用 searchAlbums(String query) 方法。此方法返回一个 Map 对象，键为专辑ID，值为专辑名称。

返回的 Map 是给定 query 的专辑列表。它的工作方式与在 Khinsider 中搜索专辑相同。

注意：查询字符串长度必须为3或以上。这是Khinsider的要求。

Map<String, String> albums = await client.searchAlbums('Hello');

// 获取第一个专辑ID
String firstAlbumId = albums.keys.first;
// 获取第一个专辑名称
String firstAlbumName = albums[firstAlbumId];

获取专辑

调用 getAlbum(String albumId) 方法。此方法返回一个 Album 对象。

Album 对象包含专辑的详细信息，例如可用歌曲ID列表、封面图像（如果有）以及其他相关专辑。

Album album = await client.getAlbum(firstAlbumId);

// 获取可用的原声带
List<Soundtrack> songs = album.soundtracks;
// 获取第一个原声带ID
String firstSongId = songs.first.id;

获取原声带下载链接

调用 getSoundFiles(String albumId, String soundId) 方法。这会返回一个 Map 对象，键为音轨文件格式，值为音轨的下载链接。

所有专辑都包含mp3格式。某些专辑可能还有其他格式，如FLAC、ogg、m4a等。

Map<String, Uri> soundFiles = await client.getSoundFiles(firstAlbumId, firstSongId);

// 使用文件格式作为键来获取下载链接
Uri mp3Link = soundFiles['mp3'];

示例代码

以下是一个完整的示例代码，展示了如何使用 khinsider_sdk 插件来获取音频资源。

import 'package:khinsider_sdk/src/core/khinsider.dart';

void main() async {
  // 创建客户端对象
  final khinsider = Khinsider();

  // 查询专辑列表
  print('/* 搜索 */');
  final albumsList = await khinsider.searchAlbums('Hello');

  albumsList.forEach((key, value) {
    print('$key: $value');
  });

  // 查询特定专辑以获取其原声带和相关专辑
  print('/* 专辑 */');
  final album = await khinsider.getAlbum('angel');

  final songs = album.soundtracks;

  songs.forEach((element) {
    print(element.name + " : " + element.id);
  });

  // 查询特定原声带以获取下载链接
  print('/* 获取音轨文件链接 */');
  final soundFiles = await khinsider.getSoundFiles(
    'best-of-amok-retro-c64-and-amiga-remixes',
    '09%2520-%2520Ice%2520Age%2520%2528Jeroen%2520Tel%2529.mp3',
  );

  soundFiles.forEach((format, link) {
    print('音轨格式 $format 的下载链接为 $link');
  });
}