Skip to content

Extension API

Uwe Trottmann edited this page Aug 21, 2014 · 33 revisions

Learn how to build extensions for SeriesGuide.

An extension provides a piece of text and optionally a view intent for media items (currently only episodes). It might just link to external content (app deep-link, web page, ...) or trigger an action in another app (play, record, ...). Or just display some status information (e.g. "downloaded").

With SeriesGuide 13.1 and up users can add up to two extensions. Adding more is exclusive to X subscribers and X Pass holders. http://seriesgui.de/whypay Don't like? Email me at uwe AT seriesgui.de.

Get started

  1. If your Android project is built with Gradle or Maven, add the following dependency:
    com.uwetrottmann.seriesguide:seriesguide-api:1.1.+
    For everyone else, an API jar is available.
  2. Create a new class that extends SeriesGuideExtension.
  3. Add the required tags to your AndroidManifest.xml file. Read the class documentation of SeriesGuideExtension for details.

Install your extension side-by-side with SeriesGuide and you should be able to add it from the extension customization screen.

Sample extension

A sample extension Android project for Android Studio is available.

API Reference

Take a look at the API reference documentation.

Change log

1.1.1 (2014-08-21)

  • Updated Intents helper class to create intents that do not create new tasks.

1.1.0 (2014-04-02)

  • Create Intents class to create intents for viewing shows or episodes with SeriesGuide.

1.0.1 (2014-03-26)

  • Initial release. Extensions can provide actions for episodes.
Clone this wiki locally