API for Third-Party Apps & Services

  • Updated

Overview

Developers of third-party apps and services can leverage Infuse's powerful video playback features to play, bookmark, and download videos using flexible URL schemes. Support for x-callback is also available which allows for returning back to another app once an action has been completed.

Available platforms: iPhone, iPad, Apple TV, Mac, and Vision

Sending Videos to Infuse for Playback

Play a single file, and return to another app when finished

infuse://x-callback-url/play?
x-success=some-app://x-callback-url/playbackDidFinish&
x-error=some-app://x-callback-url/playbackDidFail&
url=http://192.168.162.100/Movies/movie.mkv

Play a single file with external subtitles added

infuse://x-callback-url/play?
x-success=some-app://x-callback-url/playbackDidFinish&
x-error=some-app://x-callback-url/playbackDidFail&
url=http://192.168.162.100/Movies/movie.mkv&
sub=http://192.168.162.100/Movies/movie.srt

Save (bookmark) a video URL to play later

infuse://x-callback-url/save?
x-success=some-app://x-callback-url/playbackDidFinish&
x-error=some-app://x-callback-url/playbackDidFail&
url=http://192.168.162.100/Movies/movie.mkv

Save (bookmark) a video URL and begin downloading it (iOS/macOS/visionOS only)

infuse://x-callback-url/save?
x-success=some-app://x-callback-url/playbackDidFinish&
x-error=some-app://x-callback-url/playbackDidFail&
url=http://192.168.162.100/Movies/movie.mkv&
download=1

URL Encoding

Per the x-callback-url spec, all querystring values should be url-safe or encoded. Unencoded URLs may work in some cases, but when using actions with multiple parameters or URLs with multiple keys you will probably need to manually encode your URLs.

Examples

Unencoded URL

http://192.168.162.100/Movies/movie.mkv

Encoded URL

http%3A%2F%2F192.168.162.100%2FMovies%2Fmovie.mkv

Deep Linking to Infuse Library Items

Apps can link directly to items in the Infuse library using the appropriate TMDB ID numbers.

Link to a movie

infuse://movie/{tmdb_id}

Link to a TV series

infuse://series/{tmdb_id}

Link to a TV series seasons

infuse://series/{tmdb_id}-{season_number}

Link to a TV series episode

infuse://series/{tmdb_id}-{season_number}-{episode_number}
Share this article

Was this article helpful?

73 out of 117 found this helpful

Have more questions? Submit a request