Skip to content

Latest commit

 

History

History
173 lines (117 loc) · 5.63 KB

json-rpc-api.md

File metadata and controls

173 lines (117 loc) · 5.63 KB
Raw

Butter JSON-RPC 2 Api

The JSON-RPC api built into the Butter app is an interface other programs can use to communicate with Butter. It uses basic http authentication and opens an endpoint port, both of which that you can set up in popocorn time's settings view.

Every response is an object containing the version of Butter in the key 'butterVersion'.

Here are the currently supported procedures, the arguments they require, and the response they send:

ping()

  • An empty method you can call to test the connection to the API. It needs no arguments.

volume([double volume] = optional)

  • You can use this to get or set the volume if currently in the player view. If you want to set the volume then it should be a decimal number equal to or between 0 and 1.

toggleplaying()

  • Toggles whether the video is playing.

togglemute()

  • Toggles whether the video is muted.

togglefullscreen()

  • Toggles full screen mode of the app.

togglefavourite()

  • Toggles favourite status of the currently selected item.

toggletab()

  • Toggles between tabs.

togglewatched()

  • Toggles watched status of the currently selected item.

togglequality()

  • Simulates a keyboard q button click which toggles quality if on movie detail view.

showslist()

  • Opens the shows tab.

movieslist()

  • Opens the movies tab.

animelist()

  • Opens the anime tab.

showwatchlist()

  • Opens the watchlist view.

showfavourites()

  • Opens the favourites view.

showabout()

  • Opens the about view.

showsettings()

  • Opens the settings view.

getviewstack()

  • Gets the views stack. Responds with the array of currently stacked views.

getgenres()

  • Gets the available genres for the current tab. Responds with the array of genres with the key 'genres' in the main object.

getsorters()

  • Gets the available sorters for the current tab. Responds with the array of sorters with the key 'sorters' in the main object.

gettypes()

  • Gets the available sorters for the current tab. Responds with the array of sorters with the key 'types' in the main object.

getloading()

  • Gets information about the current loading video. Responds with the main object which contains the current buffer state, download speed, upload speed, active peers and title.

getplaying()

  • Gets information about the current playing video. Responds with the main object which contains the current playing state, download speed, upload speed, active peers, volume, title, quality, current time, duration, movie (true/false), imdb id (if movie = true), tvdb id (if movie = false), season (if movie = false) and episode (if movie = false).

getcurrenttab()

  • Gets the current tab.

getfullscreen()

  • Gets the fullscreen status.

getselection([integer index] = optional)

  • Gets the current highlighted item in de list or the details of the opened view.

getcurrentlist([integer page] = optional)

  • Gets the items of the current showing list.

getplayers()

  • Gets the available mediaplayers.

getsubtitles()

  • Gets the available subtitles for this movie. Responds with a list of subtitles as the first language

filtergenre([string genre])

  • Set the filter for the given genre.

filtersorter([string sorter])

  • Set the filter for the given sorter.

filtertype([string type])

  • Set the filter for the given type.

filtersearch([string term])

  • Set the filter search for the given term.

clearsearch()

  • Clear the search field.

startstream(string imdb_id, string torrent_url, string backdrop, [subtitles], string selected_subtitle, string title == undefined, string quality, string type, string tvdb_id == undefined, number season == undefined, number episode == undefined, string episode_id == undefined, object epInfo == undefined)

  • Start the torrent stream with the given values.
  • Parameter epInfo is used to fetch subtitles from various providers and should be defined as { type: string (eg. 'tvshow'), imdbid: string, tvdbid: string, episode_id: string (usually equals tvdbid), season: number, episode: number }

seek(double amount)

  • Seek through the video by the given time amount in seconds.

up()

  • Simulates a keyboard up button click

down()

  • Simulates a keyboard down button click

left()

  • Simulates a keyboard left button click

right()

  • Simulates a keyboard right button click

enter()

  • Simulates a keyboard enter button click

back()

    • Simulates a keyboard backspace button click

watchtrailer()

  • Open the trailer

previousseason()

  • Go to previous season in show details view. Simulates ctrl+up click

nextseason()

  • Go to next season in show details view. Simulates ctrl+up click

selectepisode([int season, int episode])

  • Select the specified season and episode in the show-detail

subtitleoffset([double amount])

  • Adjusts subtitle offset by the given decimal amount

setsubtitle()

  • Sets the subtitle for this movie.

setplayer([string player_id])

  • Sets the mediaplayer for playback.

setselection([string index])

  • Select the item at index in the list browser

getstreamurl()

  • Get the stream URL of playing video.

listennotifications()

  • This function is meant to be used for retrieving notifications from the app with the long-polling method.

  • This function returns when something happens with the app. Because HTTP methods have a timeout, you should keep calling this function at some interval.

  • This function responds with an object of events that happened in the app as the first argument. Currently, the following events are supported:

  • volumechange: the player volume has been changed
  • viewstack: the view stack has been changed
  • fullscreenchange: the player fullscreens status has been changed