Flutter音频房间管理插件on_audio_room的使用

Flutter音频房间管理插件on_audio_room的使用

on_audio_room 是一个用于创建存储音频部分（如收藏夹、内部播放列表、最常播放等）的“房间”的 Flutter 包。

该包作为 on_audio_query 的扩展工作，某些方法需要它。

帮助

如有任何问题，请在 GitHub issues 提交。 如有任何建议，请在 GitHub pull requests 提交。

翻译

请注意，您可以自由帮助进行 readme 翻译。

• English
• Portuguese

主题

• 如何安装
• 如何使用
• 示例
• 许可证

如何安装

在您的 pubspec.yaml 文件中添加以下代码：

dependencies:
  on_audio_room: ^2.2.1+1

一些功能

• 收藏夹部分
• 最近播放部分
• 最常播放部分
• 内部播放列表部分

待办事项

• 提高所有插件的性能。
• 添加功能。
• 修复错误。

如何使用

在调用任何方法之前，您需要初始化房间/房间：

void main() async {
  // 初始化一个房间
  await OnAudioRoom().initRoom(RoomType.FAVORITES); // 添加 RoomType
  runApp(MaterialApp(home: MyApp()));
}

// 或者

void main() async {
  // 初始化所有房间
  await OnAudioRoom().initRoom(); // 不要添加 RoomType
  runApp(MaterialApp(home: MyApp()));
}

重要提示：

• 此方法只有在使用 async/await 时才能 100% 工作，否则小部件将在几乎相同的时间加载并抛出错误。
• 记得在 dispose 中关闭房间。
• 查看 文档

OnAudioRoom() // 启动插件的主要方法

房间方法

全局方法

查询方法

播放列表方法

示例

所有示例将使用 [on_audio_query] 插件来获取歌曲/音频信息

addTo

  // 如果你使用 `[on_audio_query]`，只需扩展 SongModel 来创建任何实体。
  someName() async {
    // 返回将是歌曲在房间中的 ID。
    int? addToResult = await OnAudioRoom().addTo(
      RoomType.FAVORITES, 
      entity[index].getMap.toFavoritesEntity(),
    );
  }

  // 如果你不使用 `[on_audio_query]`，只需创建一个包含所有信息的 Map。
  someOtherName() async {
    Map<dynamic, dynamic> favoritesEntity = {
      "_data": song.data,
      "_display_name": song.displayName,
      "_id": song.id,
      "album": song.album,
      "album_id": song.albumId,
      "artist": song.artist,
      "artist_id": song.artistId,
      "date_added": song.dateAdded,
      "duration": song.duration,
      "title": song.title,
      "artwork": song.artwork,
    };

    // 现在，将其添加到房间中。
    // 返回将是歌曲在房间中的键。
    int? addToResult = await OnAudioRoom().addTo(
      RoomType.FAVORITES, 
      favoritesEntity.toFavoritesEntity(),
    ); 
  }

addAllTo

  // 如果你使用 `[on_audio_query]`，只需扩展 SongModel 来创建任何实体。
  someName() async {
    // 创建一个包含所有 SongModel 的列表。
    List<SongModel> listOfSongs;
    List<dynamic> listOfEntities;
    
    // 将所有歌曲从模型添加到实体。
    listOfSongs.forEach((element) {
      listOfEntities.add(element.getMap.toFavoritesEntity());
    });

    // 现在，将其添加到房间中。
    // 返回将是一个包含歌曲在房间中的 ID 的列表。
    List<int> addAllToResult = await OnAudioRoom().addAllTo(
      RoomType.FAVORITES, 
      listOfEntities,
      // playlistKey,
    );
  }

  // 如果你不使用 `[on_audio_query]`，只需创建一个包含所有信息的 Map 列表。
  someOtherName() async {
    List<dynamic> listOfEntities;

    listOfSongs.forEach((element) {
      Map<dynamic, dynamic> favoritesEntity = {
      "last_data": song.data,
      "display_name": song.displayName,
      "id": song.id,
      "album": song.album,
      "album_id": song.albumId,
      "artist": song.artist,
      "artist_id": song.artistId,
      "date_added": song.dateAdded,
      "duration": song.duration,
      "title": song.title,
      "artwork": song.artwork,
      };

      listOfEntities.add(favoritesEntity.toFavoritesEntity());
    });

    // 现在，将其添加到房间中。
    // 返回将是一个包含歌曲在房间中的 ID 的列表。
    List<int> addAllToResult = await OnAudioRoom().addAllTo(
      RoomType.FAVORITES, 
      favoritesEntity,
      // playlistKey,
    ); 
  }

deleteFrom

  someName() async {
    // 如果歌曲已删除，返回为 [true]，否则为 [false]。
    bool deleteFromResult = await OnAudioRoom().deleteFrom(
      RoomType.FAVORITES,
      EntityKey,
      // playlistKey,
    );
  }

  // 当向播放列表添加/删除/检查歌曲时，记得添加 [PlaylistKey]，否则会抛出异常。
  someName() async {
    // 如果歌曲已删除，返回为 [true]，否则为 [false]。
    bool deleteFromResult = await OnAudioRoom().deleteFrom(
      RoomType.PLAYLIST,
      EntityKey,
      PlaylistKey: PlaylistKey,
    );
  }

deleteAllFrom

  someName() async {
    List<int> listOfKeysToDelete = [...];
    // 如果所有歌曲已删除，返回为 [true]，否则为 [false]。
    bool deleteAllFromResult = await OnAudioRoom().deleteAllFrom(
      RoomType.FAVORITES,
      listOfKeysToDelete,
      // playlistKey,
    );
  }

clearRoom

  // 这个方法非常简单。
  someName() async {
    // 如果所有歌曲已删除，返回为 [true]，否则为 [false]。
    bool deleteAllFromResult = await OnAudioRoom().clearRoom(
      RoomType.FAVORITES,
      // playlistKey,
    );
  }

checkIn

  // 使用此方法来检查某个歌曲是否已添加。
  // 为什么？如果你尝试两次添加同一首歌，它仍然可以工作。为了避免这种情况，检查是否存在。
  someName() async {
    // 如果歌曲已添加，返回为 [true]，否则为 [false]。
    bool checkInResult = await OnAudioRoom().checkIn(
      RoomType.FAVORITES,
      EntityKey,
      // playlistKey,
    );
  }

queryFromFavorites

  someName() async {
    // 使用此方法定义一个键，并将返回关于此收藏歌曲的所有信息。
    FavoritesEntity? queryFromResult = await OnAudioRoom().queryFromFavorites(
      EntityKey,
    );
  }

queryFavorites

  someName() async {
    // 使用此方法根据类型 [Entity] 获取所有歌曲及其所有信息。
    //
    // 可以添加一个 [int] 参数来定义此查询将返回多少首歌曲。
    // 可以添加一个 [bool] 参数来定义列表是否反转。
    // 可以添加一个 [RoomSortType] 参数来定义列表的排序类型。
    List<FavoritesEntity> queryResult = await OnAudioRoom().queryFavorites(
      100, // 默认：50
      true, // 默认：false
      RoomSortType.TITLE // 默认：null
    );
  }