Skip to content
This repository has been archived by the owner on Feb 16, 2019. It is now read-only.

Latest commit

 

History

History
61 lines (37 loc) · 4.05 KB

stream.response.md

File metadata and controls

61 lines (37 loc) · 4.05 KB
Raw

Stream Response

One of the following must be passed to point to the stream itself

  • url - direct URL to a video stream - http, https, rtmp protocols supported
  • yt_id - youtube video ID, plays using the built-in YouTube player
  • infoHash and/or fileIdx - info hash of a torrent file, and fileIdx is the index of the video file within the torrent; if fileIdx is not specified, the largest file in the torrent will be selected
  • mapIdx - obsolete/legacy alias to fileIdx, specifies index of file in case of BitTorrent
  • externalUrl - URL to the video, which should be opened in a browser (webpage), e.g. link to Netflix
  • externalUris - an array of objects that represent URI to the video; supports linking to iOS or Android apps (see externalUri docs below)

Additional properties to provide information / behaviour flags

name - optional - name of the stream, e.g. "Netflix"; the add-on name will be used if not specified

title - optional - title of the stream; usually used for stream quality

availability - optional - 0-3 integer representing stream availability, in the context of P2P streams - 0 not available, 1 barely available, 2 OK, 3 highly available

tag - optional - array, optional tags of the stream; use "480p", "720p", "1080p"/"hd" or "2160p" to specify quality

isFree - optional - set this to true if the stream si free of charge

isSubscription - optional - set this to true if this stream requires a subscription (e.g. Netflix)

isPeered - optional - set this to true if this stream is peered locally and therefore delivered with a high speed; useful for areas with slow internet connections, such as India

subtitles - optional - Subtitles Objects representing subtitles for this stream. Use the exclusive flag under subtitles if you want Stremio_not to_ try to get subtitles from other add-ons

live - optional - boolean, specify if this is a live stream; this will be auto-detected if you're using HLS

repeat - optional - boolean, true if you want stremio to do stream.find again with the same arguments when the video ends, and play the result

geos - optional - use if the stream is geo-restricted - array of ISO 3166-1 alpha-2 country codes in lowercase in which the stream is accessible

widgetSidebar - optional - URL to a page that will be shown in the Player sidebar instead of usual contents; the page will be rendered in a restricted web view, appending "?item_hash=" at the end with Item Hash

widgetPlayer - optional - URL to a page that will replace the sit on top of the entire Player; the page will be rendered in a restricted web view, appending "?item_hash=" at the end with Item Hash; useful for things like YouTube/Vimeo embeds, as well as showing additional information/functionality when player is paused

widgetPlayerStates - optional - array of the states in which the widgetPlayer is shown; default is ["buffering", "loading"], which means it will be shown during loading

Possible states are:

  • buffering - while the video is buffering
  • loading - white the video is initially loading
  • paused - while the video is paused
  • postplay - after the video has finished playing
  • error - upon player error
  • device - when casting to a device
  • replaceplayer - entirely replaces the default player with the widget

meta - optional - object, used to specify { season: X, episode: Y } in case you're using a Stream Object for videos for a series

externalUris

externalUris is an array of objects containing three properties:

  • platform - platform for which the URI is relevant - possible values are android and ios
  • uri - URI to the video; example: aiv://aiv/play?asin=B012HPO8TE
  • appUri - URI to download the app required, if any; example: itms-apps://itunes.apple.com/app/amazon-instant-video/id5455193