Archive:XBMC v12 (Frodo) API changes

From Official Kodi Wiki
Revision as of 11:16, 4 October 2012 by >Montellese (→‎Changed Methods)
Jump to navigation Jump to search

Template:Frodo Frodo will represent the second repository update. Any add-ons that are submitted for inclusion in Frodo-pre and Frodo will require compatibility with the new APIs.

The Frodo-pre repository will be created soon, while the APIs may still change somewhat. When the APIs are frozen, the final Frodo repository will open and final API compatibility will be enforced.

Be sure to read the Official Repository Guidlines before submitting a pull request.

Scripts and Plugins

Skins

  • ?

JSON-RPC

API

Changed Methods

  • General / Global
    • albums: added property "playcount"
    • filter: a new parameter "filter" has been added which can either take a certain property (e.g. "genre", "actor", "studio", ...) and a value to filter by or a complex rule-based filter
    • movies
      • properties "set" and "setid" are no longer arrays but a single string/integer
      • properties like "country", "director" etc are no longer returned as concatenated strings but as arrays of strings
      • properties "productioncode" and "premiered" have been removed
      • added property "tag"
    • musicvideos: added property "tag"
    • songs: added property "lastplayed"
    • sort: cleaned up sort methods and added a few new ones (e.g. "dateadded")
    • tvshows: added properties "lastplayed" and "tag"
  • Application
    • SetVolume: added support for "increment" and "decrement"
  • Files
    • GetDirectory: added properties "size", "lastmodified", "mimetype"
  • Player
    • GoNext: merged into GoTo
    • GoPrevious: merged into GoTo
    • MoveDown: merged into Move
    • MoveLeft: merged into Move
    • MoveRight: merged into Move
    • MoveUp: merged into Move
    • Open:
      • added optional "options" parameter which can have the properties "shuffled", "repeat" and "resume"
      • added "partymode" property to be able to start the music/video partymode or a specific smartplaylist in partymode
    • PlayPause: added optional "play" parameter
    • Repeat: renamed to SetRepeat
    • SetSubtitle: added optional "enable" parameter
    • Shuffle: merged into SetShuffle
    • UnShuffle: merged into SetShuffle
    • ZoomIn: merged into Zoom
    • ZoomOut: merged into Zoom
  • VideoLibrary
    • GetTVShows: added properties "season", "watchedepisodes"
    • GetSeasons: added property "watchedepisodes"

New Methods

  • Addons
    • ExecuteAddon
    • GetAddons
    • GetAddonDetails
    • SetAddonEnabled
  • AudioLibrary
    • GetRecentlyPlayedAlbums
    • GetRecentlyPlayedSongs
    • SetAlbumDetails
    • SetArtistDetails
    • SetSongDetails
  • Files
    • GetFileDetails
  • GUI
    • ActivateWindow
    • GetProperties
    • SetFullscreen
    • ShowNotification
  • Input
    • ContextMenu
    • ExecuteAction
    • Info
    • SendText
    • ShowCodec
    • ShowOSD
  • Player
    • Move
    • SetPartymode
    • SetRepeat
    • SetShuffle
    • Zoom
  • System
    • EjectOpticalDrive
  • VideoLibrary
    • RemoveEpisode
    • RemoveMovie
    • RemoteMusicVideo
    • RemoveTVShow
    • SetEpisodeDetails
    • SetMovieDetails
    • SetMusicVideoDetails
    • SetTVShowDetails

New Notifications

  • Application
    • OnVolumeChanged
  • AudioLibrary
    • OnScanStarted
    • OnScanFinished
  • Input
    • OnInputRequested
    • OnInputFinished
  • Playlist
    • OnAdd
    • OnRemove
    • OnClear
  • VideoLibrary
    • OnScanStarted
    • OnScanFinished

Miscellaneous

Webserver

  • /image handler to provide access to cached images (thumbnails, fanart, ...) of media items. The image URL (image://) returned by JSON-RPC needs to be URL encoded before appending it like a path to
http://<your-ip>:<configured port>/image/<url-encoded image:// path>

Scrapers

  • ?

Screensavers and visualizations

  • ?

See also