Flutter播客索引管理插件podcastindex_dart的使用

Flutter播客索引管理插件podcastindex_dart的使用

介绍

此库提供了对PodcastIndex API的便捷访问，以便查找播客源（feeds）和集数（episodes）。

功能

目前只实现了PodcastIndex API中最重要的一部分（共实现15/40个端点）。 有关术语，请参阅官方的API文档。

注意事项

• 当前进度：已实现15/40个端点。
• 说明：一个feed代表整个播客；一个episode代表特定feed的一个单独集数。PodcastIndex将feed和podcast互换使用，尽管有些混淆，我们在这里也这样做。

提示

• 注意方法名中的单复数使用。例如，findFeedById 返回 Future<Feed>，而 findFeedsByTerm 返回 Future<List<Feed>>。
• 所有方法都返回 Future<...>，因为HTTP调用是异步的。只需在方法调用前使用 await，并将调用方法标记为 async。

void f() async {
  List<Feed> results = await feedService.findFeedsByTerm("some term"); 

  // 注意，由于使用了 await，返回类型不是 Future
}

搜索功能

重要：搜索类别中的端点同时使用了 FeedService 和 EpisodeService！最好一次性实例化两者。

播客源（feeds）

注意：GUID是播客的唯一全局标识符。详情请参见 guid 规范。

集数（episodes）

警告：不要混淆！Podcast GUID 不等于 GUID。前者是该集数所属feed的GUID，后者是单个具体集数的GUID。最后，ID 是PodcastIndex内部的ID（一个整数）。

其他端点

PodcastIndex API 还暴露了许多其他端点！以下类别尚未实现：

• Recent
• Value
• Stats
• Categories
• Hub
• Add
• Apple Replacement

请注意，您可以手动调用尚未实现的端点，使用以下代码：

HttpUtil.get(endpoint)

其中 endpoint 形式为 /some-endpoint。此函数会为您处理身份验证。返回的是标准的 Future<Response>。

开始使用

1. 安装库：

   dart pub add podcastindex_dart
   

   或者，如果使用Flutter：

   dart pub add podcastindex_dart
   

2. 如果还没有 .env 文件，创建一个位于项目根目录的 .env 文件，并粘贴以下内容：

   PODCASTINDEX_API_KEY='your_api_key'
   PODCASTINDEX_API_SECRET='your_api_secret'
   

   您可以通过 这里 注册一个免费的PodcastIndex账户获取这些值。

3. 在文件中导入库：

   import 'package:podcastindex_dart/src/entity/episode.dart';
   import 'package:podcastindex_dart/src/service/episode_service.dart';
   import 'package:podcastindex_dart/src/service/feed_service.dart';
   

使用方法

主要有两个服务处理API返回的两种基本类型：FeedService 和 EpisodeService。

只需实例化所需的服务：

var feedService = FeedService();
var episodeService = EpisodeService();

这些对象上的方法名称反映了PodcastIndex API端点的名称，且非常直观。

如需更多信息，请参阅 官方API文档。

示例

假设我们要根据给定的词匹配所有播客（feeds）（典型搜索栏用途）。

这是如何实现的：

String term = searchBarInput.value; /*Dumb code, just for you to get the idea!*/

List<Feed> searchResults = feedService.findFeedsByTerm(term);

要限制搜索结果到前10个，我们可以修改代码以包含 max 可选参数：

List<Feed> searchResults = feedService.findFeedsByTerm(term, max: 10);

此外，为了排除明确内容，我们可以设置 clean 标志：

List<Feed> searchResults = feedService.findFeedsByTerm(term, max: 10, clean: true);

要播放一个集数（实际上是获取特定集数的流URL），我们可以这样写：

int episodeId = 16795089; // 通过其他调用找到
Episode episode = await episodeService.findEpisodeById(episodeId);
String playbackUrl = episode.enclosureUrl.toString();

audioplayer.play(playbackUrl); // Dumb code, to get the idea!