PodcastIndex Library for Dart/Flutter

ℹ️ This library provides easy access to the PodcastIndex API to find podcasts feeds & episodes.

📱 This library can be used in Flutter apps, too!

Features

Only the most important part of the PodcastIndex API has been implemented (for now). For terminology, please refer to the official API Docs.

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

// Notice that the return type is not wrapped in a Future, because we called 		the method with await
}

Search

Podcasts (Feeds)

Episodes

Other Endpoints

The PodcastIndex API exposes many more endpoints! Following categories hasn't been implemented at all:

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

Please note that you can manually call not-yet-implemented endpoints using

HttpUtil.get(endpoint)

from this library, where endpoint is of the form /some-endpoint. This function will take care of authentication for you. A standard Future<Response> will be returned.

Getting started

1. Install the library as usual:

   dart pub add podcastindex_dart
   

   or, if using Flutter:

   dart pub add podcastindex_dart
   

2. If you don't have one already, create a .env file at the root of your project.

   Paste following content:

    PODCASTINDEX_API_KEY='your_api_key'
    PODCASTINDEX_API_SECRET='your_api_secret'
   

3. Import the library in your files:

    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';
   

Usage

There are essentially two services that deal with the two fundamentals type returned by the API: FeedService and EpisodeService.

Simply instantiate the desired service:

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

On these objects, method names reflects that of the PodcastIndex API's endpoints and are pretty self-explanatory.

As usual, please refer to the official API Docs.

Example

Let's suppose we want to match all podcasts (feeds) with a given word (a typical usage for a search bar!).

This is how I'd do it:

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

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

To limit the search at the first 10 results, we can modify the code to include the max optional parameter:

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

Additionally, to let explicit contents out of the results, we can set the clean flag:

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

To play an episode (in reality, to get the stream URL of a specific episode), we would write the following:

  int episodeId = 16795089; // found with some other calls.
  Episode episode = await episodeService.findEpisodeById(episodeId);
  String playbackUrl = episode.enclosureUrl.toString();

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