Official Kodi Wiki - User contributions [en]

InfoLabels

2025-04-14T05:45:19Z

CastagnaIT: Add to ListItem.AudioCodec new AAC codec variants

{{mininav|[[Development]]|[[Add-on development]]|[[Skinning]]}}

<section begin="main content" />
Skins can use infolabels with '''$INFO[infolabel]''' or the '''<info>''' tag. Scripts can read infolabels with <code>'''xbmc.getInfoLabel('infolabel')'''</code>.

=== Addon ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Addon.SettingInt(addon_id,setting_id)</code>
| '''Returns'''
:The integer value of the setting <code>setting_id</code> belonging to the addon with the id <code>addon_id</code>.
'''Parameters'''
:'''addon_id''' - The id of the addon
:'''setting_id''' - The addon setting
{{highlight|'''Note'''<br>
The provided setting with <code>setting_id</code> must be an integer setting type.<br>
Otherwise it will return the integer info default value (which is 0).}}
| [https://forum.kodi.tv/showthread.php?tid=363553&pid=3098121#pid3098121 v20]
|-
| <code>Addon.SettingStr(addon_id,setting_id)</code>
| '''Returns'''
:The string value of the setting <code>setting_id</code> belonging to the addon with the id <code>addon_id</code>.
'''Parameters'''
:'''addon_id''' - The id of the addon
:'''setting_id''' - The addon setting
| [https://forum.kodi.tv/showthread.php?tid=363553&pid=3098121#pid3098121 v20]
|}

=== Container ===
{{highlight|'''Note'''<br>
If no <code>id</code> is specified it grabs the current container.}}

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Container(id).Column</code>
| '''Returns'''
:The column number of the focused position in a panel container.
|
|-
| <code>Container(id).CurrentItem</code>
| '''Returns'''
:The current item in the container or grouplist with given id.
|
|-
| <code>Container(id).CurrentPage</code>
| '''Returns'''
:The current page in the container with given id.
|
|-
| <code>Container(id).ListItem(offset).Property</code>
| '''Returns'''
:The property of the ListItem with a given offset.
'''Parameters'''
:'''offset''' - The offset for the listitem.
{{highlight|'''Note'''<br>
<code>Property</code> has to be replaced with <code>Label</code>, <code>Label2</code>, <code>Icon</code>, etc.<br>
'''Example:''' <code>Container(50).Listitem(2).Label</code>}}
|
|-
| <code>Container(id).ListItemAbsolute(x).[infolabel]</code>
| '''Returns'''
:The infolabel for an item in a container.
'''Parameters'''
:'''x''' - The absolute position in the container.
{{highlight|'''Note'''<br>
'''Example:''' <code>Container(50).ListItemAbsolute(4).Genre</code>}}
|
|-
| <code>Container(id).ListItemNoWrap(offset).Property</code>
| '''Returns'''
:The same as Container(id).ListItemNoWrap(offset).Property but it won't wrap.<br>
:This means if the last item of a list is focused, <code>ListItemNoWrap(1)</code> will be empty while <code>ListItem(1)</code> will return the first item of the list.<br>
'''Parameters'''
:'''offset''' - The offset for the listitem.
{{highlight|'''Note'''<br>
<code>Property</code> has to be replaced with <code>Label</code>, <code>Label2</code>, <code>Icon</code>, etc.<br>
'''Example''': <code>Container(50).ListitemNoWrap(1).Plot</code>}}
|
|-
| <code>Container(id).ListItemPosition(x).[infolabel]</code>
| '''Returns'''
:The infolabel for an item in a container.
'''Parameters'''
:'''x''' - The position in the container relative to the cursor position.
{{highlight|'''Note'''<br>
'''Example:''' <code>Container(50).ListItemAbsolute(4).Genre</code>}}
|
|-
| <code>Container(id).NumAllItems</code>
| '''Returns'''
:The number of all items in the container or grouplist with given id including parent folder item.
| [https://forum.kodi.tv/showthread.php?tid=298565&pid=2553240#pid2553240 v18]
|-
| <code>Container(id).NumItems</code>
| '''Returns'''
:The number of items in the container or grouplist with given id excluding parent folder item.
|
|-
| <code>Container(id).NumNonFolderItems</code>
| '''Returns'''
:The number of items in the container or grouplist with given id excluding all folder items (e.g. pvr recordings folders, parent ".." folder, "All albums", etc).
| [https://forum.kodi.tv/showthread.php?tid=298565&pid=2553240#pid2553240 v18]
|-
| <code>Container(id).NumPages</code>
| '''Returns'''
:The number of pages in the container with given id.
|
|-
| <code>Container(id).Position</code>
| '''Returns'''
:The current focused position of container / grouplist (id) as a numeric label.
|
|-
| <code>Container(id).Row</code>
| '''Returns'''
:The row number of the focused position in a panel container.
|
|-
| <code>Container.Art(type)</code>
| '''Returns'''
:The path to the art image file for the given type of the current container.
'''Parameters'''
:'''type''' - The art type to request.
{{highlight|'''Todo'''<br>
List of all art types.}}
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2095396#pid2095396 v16]
[https://forum.kodi.tv/showthread.php?tid=211896&pid=1866664#pid1866664 v15]
|-
| <code>Container.Content</code>
| '''Returns'''
:The content of the current container.
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2109488#pid2109488 v16]
|-
| <code>Container.FolderName</code>
| '''Returns'''
:The top most folder in currently displayed folder.
|
|-
| <code>Container.FolderPath</code>
| '''Returns'''
:The complete path of currently displayed folder.
|
|-
| <code>Container.PluginCategory</code>
| '''Returns'''
:The current plugins category (set by the scripter).
| [https://forum.kodi.tv/showthread.php?tid=250862&pid=2300634#pid2300634 v17]
|-
| <code>Container.PluginName</code>
| '''Returns'''
:The current plugins base folder name.
|
|-
| <code>Container.Property(addoncategory)</code>
| '''Returns'''
:The current add-on category.
|
|-
| <code>Container.Property(reponame)</code>
| '''Returns'''
:The current add-on repository name.
|
|-
| <code>Container.ShowPlot</code>
| '''Returns'''
:The TV Show plot of the current container and can be used at season and episode level.
|
|-
| <code>Container.ShowTitle</code>
| '''Returns'''
:The TV Show title of the current container and can be used at season and episode level.
| [https://forum.kodi.tv/showthread.php?tid=250862&pid=2284876#pid2284876 v17]
|-
| <code>Container.SortMethod</code>
| '''Returns'''
:The current sort method (returns a localized value).
|
|-
| <code>Container.SortOrder</code>
| '''Returns'''
:The current sort order (Ascending/Descending).
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052012#pid2052012 v16]
|-
| <code>Container(id).TotalUnWatched</code>
| '''Returns'''
:The number of unwatched items in the container.
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052026#pid2052026 v16]
|-
| <code>Container(id).TotalWatched</code>
| '''Returns'''
:The number of watched items in the container.
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052026#pid2052026 v16]
|-
| <code>Container.Totaltime</code>
| '''Returns'''
:The total time of all items in the current container.
|
|-
| <code>Container.ViewCount</code>
| '''Returns'''
:The number of available skin view modes for the current container listing.
| [https://forum.kodi.tv/showthread.php?tid=250862&pid=2278045#pid2278045 v17]
|-
| <code>Container.Viewmode</code>
| '''Returns'''
:The current viewmode (e.g. list, icons, etc).
|
|}

=== Control ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Control.GetLabel(id)[.index()]</code>
| '''Returns'''
:The label value or texture name of the control with the given id.
'''Parameters'''
:'''id''' - The id of the control.
:'''index''' - [opt] Optionally you can specify index(1) to retrieve label2 from an Edit control.
| [https://forum.kodi.tv/showthread.php?tid=211896&pid=1937160#pid1937160 v15]
|}

=== Fanart ===
{{highlight|'''Note'''<br>
Colors are arranged Lightest to Darkest.}}

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Fanart.Color1</code>
| Returns the first of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show.
|
|-
| <code>Fanart.Color2</code>
| Returns the second of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show.
|
|-
| <code>Fanart.Color3</code>
| Returns the third of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show.
|
|}

=== Game ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Game.Developer</code>
| '''Returns'''
: The developer of the game (e.g. Activision).
| v18
|-
| <code>Game.GameClient</code>
| '''Returns'''
: The add-on ID of the emulator used to play the game.
| v18
|-
| <code>Game.Genres</code>
| '''Returns'''
: The genre of the game (e.g. Action).
| v18
|-
| <code>Game.Overview</code>
| '''Returns'''
: The game description.
| v18
|-
| <code>Game.Platform</code>
| '''Returns'''
: The platform the game runs on (e.g. Atari 2600).
| v18
|-
| <code>Game.Publisher</code>
| '''Returns'''
: The publishing company of the game (e.g. Nintendo).
| v18
|-
| <code>Game.Title</code>
| '''Returns'''
: The name of the game.
| v18
|-
| <code>Game.Year</code>
| '''Returns'''
: The year the game was released.
| v18
|}

=== ListItem ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>ListItem.AddonBroken</code>
| Deprecated! use ListItem.AddonLifecycleDesc instead.
|
|-
| <code>ListItem.AddonCreator</code>
| '''Returns'''
:The name of the author the currently selected addon.
|
|-
| <code>ListItem.AddonDescription</code>
| '''Returns'''
:The full description of the currently selected addon.
|
|-
| <code>ListItem.AddonDisclaimer</code>
| '''Returns'''
:The disclaimer of the currently selected addon.
|
|-
| <code>ListItem.AddonInstallDate</code>
| '''Returns'''
:The date the addon was installed.
|
|-
| <code>ListItem.AddonLastUpdated</code>
| '''Returns'''
:The date the addon was last updated.
|
|-
| <code>ListItem.AddonLastUsed</code>
| '''Returns'''
:The date the addon was used last.
|
|-
| <code>ListItem.AddonLifecycleDesc</code>
| '''Returns'''
:The description of the lifecycle type (e.g. broken due to website changes).
| v19
|-
| <code>ListItem.AddonLifecycleType</code>
| '''Returns'''
:The lifecycle type of the addon as a localized string (e.g. normal, broken, or deprecated).
| v19
|-
| <code>ListItem.AddonName</code>
| '''Returns'''
:The name of the currently selected addon.
|
|-
| <code>ListItem.AddonNews</code>
| '''Returns'''
:A brief changelog, taken from the addons' addon.xml file.
|
|-
| <code>ListItem.AddonSize</code>
| '''Returns'''
:The filesize of the addon.
|
|-
| <code>ListItem.AddonSummary</code>
| '''Returns'''
:A short description of the currently selected addon.
|
|-
| <code>ListItem.AddonType</code>
| '''Returns'''
:The type of the currently selected addon (e.g. screensaver, script, skin, etc).
|
|-
| <code>ListItem.AddonVersion</code>
| '''Returns'''
:The version of the currently selected addon.
|
|-
| <code>ListItem.Album</code>
| '''Returns'''
:The album of the currently selected song in a container.
|
|-
| <code>ListItem.AlbumArtist</code>
| '''Returns'''
:The artist of the currently selected album in a list.
|
|-
| <code>ListItem.AlbumStatus</code>
| '''Returns'''
:The Musicbrainz release status of the album (e.g. offical, bootleg, promotion, etc).
| v19
|-
| <code>ListItem.Appearances</code>
| '''Returns'''
:The number of movies featuring the selected actor or directed by the selected director.
| v17
|-
| <code>ListItem.Artist</code>
| '''Returns'''
:The artist of the currently selected song in a container.
|
|-
| <code>ListItem.AudioChannels</code>
| '''Returns'''
:The number of audio channels of the currently selected video (e.g. 1, 2, 4, 5, 6, 7, 8, 10, etc).
|
|-
| <code>ListItem.AudioCodec</code>
| '''Returns'''
:The audio codec of the currently selected video.<br>
:Possible values:
:*aac
:*aac_lc*
:*he_aac*
:*he_aac_v2*
:*aac_ssr*
:*aac_ltp*
:*aac_latm
:*ac3
:*aif
:*aifc
:*aiff
:*alac
:*ape
:*avc
:*cdda
:*dca
:*dolbydigital
:*dts
:*dtshd_hra
:*dtshd_ma
:*dtshd_ma_x*
:*dtshd_ma_x_imax*
:*dtsma
:*eac3
:*eac3_ddp_atmos*
:*flac
:*mp1
:*mp3
:*mp3float
:*ogg
:*opus
:*pcm
:*pcm_bluray
:*pcm_s16le
:*pcm_s24le
:*truehd
:*truehd_atmos*
:*vorbis
:*wav
:*wavpack
:*wmapro
:*wmav2
| *v22
|-
| <code>ListItem.AudioLanguage</code>
| '''Returns'''
:The audio language of the currently selected video as an ISO 639-2 three character code (e.g. eng, epo, deu).
|
|-
| <code>ListItem.BitRate</code>
| '''Returns'''
:The actual bitrate for CBR or average bitrate for VBR of the currently selected song.
| v19
|-
| <code>ListItem.BPM</code>
| '''Returns'''
:The Beats Per Minute of the currently selected song.
| v19
|-
| <code>ListItem.Cast</code>
| '''Returns'''
:The list of cast members, separated by carriage returns, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.CastAndRole</code>
| '''Returns'''
:The list of cast members and roles, separated by carriage returns. Every cast/role combination is formatted 'cast' as 'role' where 'as' is localised, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.ChannelLogo</code>
| '''Returns'''
:The logo of the currently selected radio or TV channel (PVR).
| v22
|-
| <code>ListItem.ChannelName</code>
| '''Returns'''
:The name of current selected TV channel in a container (PVR).
|
|-
| <code>ListItem.ChannelName</code>
| '''Returns'''
:The channel name of the selected item (PVR).
|
|-
| <code>ListItem.ChannelNumber</code>
| '''Returns'''
:The channel number of the selected item (PVR).
|
|-
| <code>ListItem.ChannelNumberLabel</code>
| '''Returns'''
:The channel and subchannel number of the currently selected channel that's currently playing (PVR).
|
|-
| <code>ListItem.Comment</code>
| '''Returns'''
:The comment assigned to the item (PVR/MUSIC).
|
|-
| <code>ListItem.ContributorAndRole</code>
| '''Returns'''
:The list of all people and their role who've contributed to the selected song.
|
|-
| <code>ListItem.Contributors</code>
| '''Returns'''
:The list of all people who've contributed to the selected song.
|
|-
| <code>ListItem.Country</code>
| '''Returns'''
:The production country of the currently selected movie in a container.
|
|-
| <code>ListItem.CurrentItem</code>
| '''Returns'''
:The current index of the item in a container starting at 1.
| v19
|-
| <code>ListItem.Date</code>
| '''Returns'''
:The file date of the currently selected song or movie in a container, the aired date of an episode, or the day, start time, and end time of the currently selected TV programme (PVR).
|
|-
| <code>ListItem.DateAdded</code>
| '''Returns'''
:The date the currently selected item was added to the library or date and time of an event in the EventLog window.
|
|-
| <code>ListItem.DBID</code>
| '''Returns'''
:The database id of the currently selected ListItem in a container.
|
|-
| <code>ListItem.DBTYPE</code>
| '''Returns'''
:The database type of the ListItem.DBID for videos (video, movie, set, TV show, season, episode, musicvideo) or for audio (music, song, album, artist).
{{highlight|'''Note'''<br>
With season, the "*all seasons" entry does give a DBTYPE "season" and a DBID, but you can't get the details of that entry since it's a virtual entry in the Video Library.}}
|
|-
| <code>ListItem.DecodedFileNameAndPath</code>
| '''Returns'''
:The full path with filename of the currently selected song or movie in a container decoded.
|
|-
| <code>ListItem.Director</code>
| '''Returns'''
:The director of the currently selected movie in a container.
|
|-
| <code>ListItem.DiscNumber</code>
| '''Returns'''
:The disc number of the currently selected song in a container.
|
|-
| <code>ListItem.DiscTitle</code>
| '''Returns'''
:The disc title of the currently selected album or song.
| v19
|-
| <code>ListItem.Duration[(format)]</code>
| '''Returns'''
:The song or movie duration of the currently selected movie in a container. Optionally specify a time format, hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>ListItem.EndDate</code>
| '''Returns'''
:The end date of the selected item (PVR).
|
|-
| <code>ListItem.EndTime</code>
| '''Returns'''
:The end time of current selected TV programme in a container (PVR).
|
|-
| <code>ListItem.EndTimeResume</code>
| '''Returns'''
:The time a video will end if you resume it, instead of playing it from the beginning.
|
|-
| <code>ListItem.Episode</code>
| '''Returns'''
:The episode number value for the currently selected episode. It also shows the number of total, watched or unwatched episodes for the currently selected TV show or season, based on the the current watched filter.
|
|-
| <code>ListItem.EpisodeName</code>
| '''Returns'''
:The name of the episode if the selected EPG item is a TV Show (PVR).
|
|-
| <code>ListItem.FileExtension</code>
| '''Returns'''
:The file extension (without leading dot) of the currently selected item in a container.
|
|-
| <code>ListItem.FileName</code>
| '''Returns'''
:The filename of the currently selected song or movie in a container.
|
|-
| <code>ListItem.FileNameAndPath</code>
| '''Returns'''
:The full path with filename of the currently selected song or movie in a container.
|
|-
| <code>ListItem.FileNameNoExtension</code>
| '''Returns'''
:The filename without its extension.
| v19
|-
| <code>ListItem.FolderName</code>
| '''Returns'''
:The top most folder of the path of the currently selected song or movie in a container.
|
|-
| <code>ListItem.FolderPath</code>
| '''Returns'''
:The complete path of the currently selected song or movie in a container (without user details).
|
|-
| <code>ListItem.Genre</code>
| '''Returns'''
:The genre of the currently selected song, album, or movie in a container.
|
|-
| <code>ListItem.HdrType</code>
| '''Returns'''
:The HDR type of the currently selected video (e.g. hdr10, dolbyvision, or hlg).
| v20
|-
| <code>ListItem.IMDBNumber</code>
| '''Returns'''
:The IMDB iD of the selected Video in a container.
|
|-
| <code>ListItem.Label</code>
| '''Returns'''
:The left label of the currently selected item in a container.
|
|-
| <code>ListItem.Label2</code>
| '''Returns'''
:The right label of the currently selected item in a container.
|
|-
| <code>ListItem.LastPlayed</code>
| '''Returns'''
:The last play date of video in a container.
|
|-
| <code>ListItem.Mood</code>
| '''Returns'''
:The mood of the selected song.
|
|-
| <code>ListItem.Mpaa</code>
| '''Returns'''
:The MPAA rating of the currently selected movie in a container.
|
|-
| <code>ListItem.MusicChannels</code>
| '''Returns'''
:The number of audio channels for a song.
| v19
|-
| <code>ListItem.NextDuration</code>
| '''Returns'''
:The duration of the next item (PVR).
| v18
|-
| <code>ListItem.NextEndDate</code>
| '''Returns'''
:The end date of the next item (PVR).
|
|-
| <code>ListItem.NextEndTime</code>
| '''Returns'''
:The end of the next item (PVR).
|
|-
| <code>ListItem.NextGenre</code>
| '''Returns'''
:The genre of the next item (PVR).
|
|-
| <code>ListItem.NextPlot</code>
| '''Returns'''
:The plot of the next item (PVR).
|
|-
| <code>ListItem.NextPlotOutline</code>
| '''Returns'''
:The plot outline of the next item (PVR).
|
|-
| <code>ListItem.NextStartDate</code>
| '''Returns'''
:The start date of the next item (PVR).
|
|-
| <code>ListItem.NextStartTime</code>
| '''Returns'''
:The start time of the next item (PVR).
|
|-
| <code>ListItem.NextTitle</code>
| '''Returns'''
:The title of the next item (PVR).
|
|-
| <code>ListItem.OriginalDate</code>
| '''Returns'''
:The original release date of the item.
| v19
|-
| <code>ListItem.OriginalTitle</code>
| '''Returns'''
:The original title of the currently selected movie in a container.
|
|-
| <code>ListItem.ParentalRatingCode</code>
| '''Returns'''
:The parental rating code.
| v22
|-
| <code>ListItem.ParentalRatingIcon</code>
| '''Returns'''
:The parental rating icon.
| v22
|-
| <code>ListItem.ParentalRatingSource</code>
| '''Returns'''
:The parental rating source.
| v22
|-
| <code>ListItem.Path</code>
| '''Returns'''
:The complete path of the currently selected song or movie in a container.
|
|-
| <code>ListItem.PercentPlayed</code>
| '''Returns'''
:The returns percentage value [0-100] of how far the selected video has been played.
|
|-
| <code>ListItem.PictureAperture</code>
| '''Returns'''
:The f-stop used to take the selected picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
|
|-
| <code>ListItem.PictureAuthor</code>
| '''Returns'''
:The name of the person involved in writing about the selected picture. This is the value of the IPTC Writer tag (hex code 0x7A).
|
|-
| <code>ListItem.PictureByline</code>
| '''Returns'''
:The name of the person who created the selected picture. This is the value of the IPTC Byline tag (hex code 0x50).
|
|-
| <code>ListItem.PictureBylineTitle</code>
| '''Returns'''
:The title of the person who created the selected picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
|
|-
| <code>ListItem.PictureCamMake</code>
| '''Returns'''
:The manufacturer of the camera used to take the selected picture. This is the value of the EXIF Make tag (hex code 0x010F).
|
|-
| <code>ListItem.PictureCamModel</code>
| '''Returns'''
:The manufacturer's model name or number of the camera used to take the selected picture. This is the value of the EXIF Model tag (hex code 0x0110).
|
|-
| <code>ListItem.PictureCaption</code>
| '''Returns'''
:The description of the selected picture. This is the value of the IPTC Caption tag (hex code 0x78).
|
|-
| <code>ListItem.PictureCategory</code>
| '''Returns'''
:The subject of the selected picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
|
|-
| <code>ListItem.PictureCCDWidth</code>
| '''Returns'''
:The width of the CCD in the camera used to take the selected picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
|
|-
| <code>ListItem.PictureCity</code>
| '''Returns'''
:The city where the selected picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
|
|-
| <code>ListItem.PictureColour</code>
| '''Returns'''
:Whether the selected picture is "Colour" or "Black and White".
|
|-
| <code>ListItem.PictureComment</code>
| '''Returns'''
:The description of the selected picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
|
|-
| <code>ListItem.PictureCopyrightNotice</code>
| '''Returns'''
:The copyright notice of the selected picture. This is the value of the IPTC Copyright tag (hex code 0x74).
|
|-
| <code>ListItem.PictureCountry</code>
| '''Returns'''
:The full name of the country where the selected picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).
|
|-
| <code>ListItem.PictureCountryCode</code>
| '''Returns'''
:The country code of the country where the selected picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).
|
|-
| <code>ListItem.PictureCredit</code>
| '''Returns'''
:The provider of the selected picture. This is the value of the IPTC Credit tag (hex code 0x6E).
|
|-
| <code>ListItem.PictureDate</code>
| '''Returns'''
:The localized date of the selected picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureDatetime</code>
| '''Returns'''
:The date/timestamp of the selected picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureDesc</code>
| '''Returns'''
:The short description of the selected picture. The SlideComment, EXIFComment, or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E).
|
|-
| <code>ListItem.PictureDigitalZoom</code>
| '''Returns'''
:The digital zoom ratio when the selected picture was taken. This is the value of the EXIF DigitalZoomRatio tag (hex code 0xA404).
|
|-
| <code>ListItem.PictureExpMode</code>
| '''Returns'''
:The exposure mode of the selected picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402).
|
|-
| <code>ListItem.PictureExposure</code>
| '''Returns'''
:The class of the program used by the camera to set exposure when the selected picture was taken. Values include "Manual", "Program (Auto)", "Aperture priority (Semi-Auto)", "Shutter priority (semi-auto)", etc. This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
|
|-
| <code>ListItem.PictureExposureBias</code>
| '''Returns'''
:The exposure bias of the selected picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
|
|-
| <code>ListItem.PictureExpTime</code>
| '''Returns'''
:The exposure time of the selected picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
|
|-
| <code>ListItem.PictureFlashUsed</code>
| '''Returns'''
:The status of flash when the selected picture was taken. The value will be either "Yes" or "No", and might include additional information. This is the value of the EXIF Flash tag (hex code 0x9209).
|
|-
| <code>ListItem.PictureFocalLen</code>
| '''Returns'''
:The lens focal length of the selected picture.
|
|-
| <code>ListItem.PictureFocusDist</code>
| '''Returns'''
:The focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
|
|-
| <code>ListItem.PictureGPSAlt</code>
| '''Returns'''
:The altitude in meters where the selected picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
|
|-
| <code>ListItem.PictureGPSLat</code>
| '''Returns'''
:The latitude where the selected picture was taken (degrees, minutes, seconds North or South). This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
|
|-
| <code>ListItem.PictureGPSLon</code>
| '''Returns'''
:The longitude where the selected picture was taken (degrees, minutes, seconds East or West). This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
|
|-
| <code>ListItem.PictureHeadline</code>
| '''Returns'''
:The synopsis of the contents of the selected picture. This is the value of the IPTC Headline tag (hex code 0x69).
|
|-
| <code>ListItem.PictureImageType</code>
| '''Returns'''
:The color components of the selected picture. This is the value of the IPTC ImageType tag (hex code 0x82).
|
|-
| <code>ListItem.PictureIPTCDate</code>
| '''Returns'''
:The date when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37).
|
|-
| <code>ListItem.PictureIPTCTime</code>
| '''Returns'''
:The time when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C).
|
|-
| <code>ListItem.PictureISO</code>
| '''Returns'''
:The ISO speed of the camera when the selected picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
|
|-
| <code>ListItem.PictureKeywords</code>
| '''Returns'''
:The keywords assigned to the selected picture. This is the value of the IPTC Keywords tag (hex code 0x19).
|
|-
| <code>ListItem.PictureLightSource</code>
| '''Returns'''
:The kind of light source when the picture was taken. Possible values include "Daylight", "Fluorescent", "Incandescent", etc. This is the value of the EXIF LightSource tag (hex code 0x9208).
|
|-
| <code>ListItem.PictureLongDate</code>
| '''Returns'''
:The localized date of the selected picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureLongDatetime</code>
| '''Returns'''
:The date/timestamp of the selected picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureMeteringMode</code>
| '''Returns'''
:The metering mode used when the selected picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207).
|
|-
| <code>ListItem.PictureObjectName</code>
| '''Returns'''
:The shorthand reference for the selected picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
|
|-
| <code>ListItem.PictureOrientation</code>
| '''Returns'''
:The orientation of the selected picture. Possible values are "Top Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112).
|
|-
| <code>ListItem.PicturePath</code>
| '''Returns'''
:The filename and path of the selected picture.
|
|-
| <code>ListItem.PictureProcess</code>
| '''Returns'''
:The process used to compress the selected picture.
|
|-
| <code>ListItem.PictureReferenceService</code>
| '''Returns'''
:The service identifier of a prior envelope to which the selected picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D).
|
|-
| <code>ListItem.PictureResolution</code>
| '''Returns'''
:The dimensions of the selected picture.
|
|-
| <code>ListItem.PictureSource</code>
| '''Returns'''
:The original owner of the selected picture. This is the value of the IPTC Source tag (hex code 0x73).
|
|-
| <code>ListItem.PictureSpecialInstructions</code>
| '''Returns'''
:The editorial instructions concerning the use of the selected picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
|
|-
| <code>ListItem.PictureState</code>
| '''Returns'''
:The State/Province where the selected picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
|
|-
| <code>ListItem.PictureSublocation</code>
| '''Returns'''
:The location within a city where the selected picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C).
|
|-
| <code>ListItem.PictureSupplementalCategories</code>
| '''Returns'''
:The supplemental category codes to further refine the subject of the selected picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).
|
|-
| <code>ListItem.PictureTransmissionReference</code>
| '''Returns'''
:The code representing the location of original transmission of the selected picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).
|
|-
| <code>ListItem.PictureUrgency</code>
| '''Returns'''
:The urgency of the selected picture. Values are 1-9. The "1" is most urgent. Some image management programs use urgency to indicate picture rating, where urgency "1" is 5 stars and urgency "5" is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A).
|
|-
| <code>ListItem.PictureWhiteBalance</code>
| '''Returns'''
:The white balance mode set when the selected picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
|
|-
| <code>ListItem.PlayCount</code>
| '''Returns'''
:The playcount of video in a container.
|
|-
| <code>ListItem.Plot</code>
| '''Returns'''
:The complete text summary of video in a container.
|
|-
| <code>ListItem.PlotOutline</code>
| '''Returns'''
:The small summary of current video in a container.
|
|-
| <code>ListItem.Premiered</code>
| '''Returns'''
:The release/aired date of the currently selected episode, show, movie, or EPG item in a container.
|
|-
| <code>ListItem.PrivacyPolicy</code>
| '''Returns'''
:The official Kodi privacy-policy.
| v17
|-
| <code>ListItem.ProgramCount</code>
| '''Returns'''
:The number of times an xbe has been run from "my programs".
|
|-
| <code>ListItem.Progress</code>
| '''Returns'''
:The part of the programme that's being played (PVR).
|
|-
| <code>ListItem.Property(Addon.Changelog)</code>
| '''Returns'''
:The changelog of the currently selected addon.
|
|-
| <code>ListItem.Property(Addon.ID)</code>
| '''Returns'''
:The identifier of the currently selected addon.
|
|-
| <code>ListItem.Property(Addon.Path)</code>
| '''Returns'''
:The path of the currently selected addon.
|
|-
| <code>ListItem.Property(Addon.Status)</code>
| '''Returns'''
:The status of the currently selected addon.
|
|-
| <code>ListItem.Property(Album_Description)</code>
| '''Returns'''
:The review of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Duration)</code>
| '''Returns'''
:The duration of an album in HH:MM:SS.
| v19
|-
| <code>ListItem.Property(Album_Label)</code>
| '''Returns'''
:The record label of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Mood)</code>
| '''Returns'''
:The moods of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Rating)</code>
| '''Returns'''
:The scraped rating of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Style)</code>
| '''Returns'''
:The styles of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Theme)</code>
| '''Returns'''
:The themes of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Type)</code>
| '''Returns'''
:The album type of the currently selected album (e.g. compilation, enhanced, or explicit lyrics).
|
|-
| <code>ListItem.Property(Album_UserRating)</code>
| '''Returns'''
:The user rating of the currently selected album.
|
|-
| <code>ListItem.Property(Artist_Born)</code>
| '''Returns'''
:The Date of Birth of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Description)</code>
| '''Returns'''
:The biography of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Died)</code>
| '''Returns'''
:The Date of Death of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Disambiguation)</code>
| '''Returns'''
:The brief description of the currently selected artist that differentiates them from others with the same name.
| v18
|-
| <code>ListItem.Property(Artist_Disbanded)</code>
| '''Returns'''
:The disbanding date of the currently selected band.
|
|-
| <code>ListItem.Property(Artist_Formed)</code>
| '''Returns'''
:The formation date of the currently selected band.
|
|-
| <code>ListItem.Property(Artist_Gender)</code>
| '''Returns'''
:The gender of the currently selected artist (e.g.male, female, or other).
| v18
|-
| <code>ListItem.Property(Artist_Genre)</code>
| '''Returns'''
:The genre of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Instrument)</code>
| '''Returns'''
:The instruments played by the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Mood)</code>
| '''Returns'''
:The moods of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Sortname)</code>
| '''Returns'''
:The sortname of the currently selected artist.
| v18
|-
| <code>ListItem.Property(Artist_Style)</code>
| '''Returns'''
:The styles of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Type)</code>
| '''Returns'''
:The type of the currently selected artist (person, group, orchestra, choir, etc).
| v18
|-
| <code>ListItem.Property(Artist_YearsActive)</code>
| '''Returns'''
:The years the currently selected artist has been active.
|
|-
| <code>ListItem.Property(AudioChannels.[n])</code>
| '''Returns'''
:The number of audio channels of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioChannels).
|
|-
| <code>ListItem.Property(AudioCodec.[n])</code>
| '''Returns'''
:The audio codec of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioCodec).
|
|-
| <code>ListItem.Property(AudioLanguage.[n])</code>
| '''Returns'''
:The audio language of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioLanguage).
|
|-
| <code>ListItem.Property(game.stretchmode)</code>
| '''Returns'''
:The name of the stretch mode (e.g. Stretch 4:3).
| v18
|-
| <code>ListItem.Property(game.videofilter)</code>
| '''Returns'''
:The name of the video filter (e.g. Bilinear).
| v18
|-
| <code>ListItem.Property(game.videorotation)</code>
| '''Returns'''
:The angle of the rotation.
| v18
|-
| <code>ListItem.Property(NumEpisodes)</code>
| '''Returns'''
:The number of total, watched, or unwatched episodes for the currently selected TV show or season, based on the the current watched filter.
|
|-
| <code>ListItem.Property(Role.Arranger)</code>
| '''Returns'''
:The name of the person who arranged the selected song.
|
|-
| <code>ListItem.Property(Role.Composer)</code>
| '''Returns'''
:The name of the person who composed the selected song.
|
|-
| <code>ListItem.Property(Role.Conductor)</code>
| '''Returns'''
:The name of the person who conducted the selected song.
|
|-
| <code>ListItem.Property(Role.DJMixer)</code>
| '''Returns'''
:The name of the DJ who remixed the selected song.
|
|-
| <code>ListItem.Property(Role.Engineer)</code>
| '''Returns'''
:The name of the person who was the engineer of the selected song.
|
|-
| <code>ListItem.Property(Role.Lyricist)</code>
| '''Returns'''
:The name of the person who wrote the lyrics of the selected song.
|
|-
| <code>ListItem.Property(Role.Mixer)</code>
| '''Returns'''
:The name of the person who mixed the selected song.
|
|-
| <code>ListItem.Property(Role.Orchestra)</code>
| '''Returns'''
:The name of the orchestra performing the selected song.
|
|-
| <code>ListItem.Property(Role.Producer)</code>
| '''Returns'''
:The name of the person who produced the selected song.
|
|-
| <code>ListItem.Property(Role.Remixer)</code>
| '''Returns'''
:The name of the person who remixed the selected song.
|
|-
| <code>ListItem.Property(Stream.Bitrate)</code>
| '''Returns'''
:The video bitrate of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.Channels)</code>
| '''Returns'''
:The number of audio channels of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.Codec)</code>
| '''Returns'''
:The video codec of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.CodecDesc)</code>
| '''Returns'''
:The audio codec of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.Description)</code>
| '''Returns'''
:The audio description of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.FPS)</code>
| '''Returns'''
:The Frames per Second of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.HDRType)</code>
| '''Returns'''
:The HDR type of the currently playing video (e.g. hdr10, dolbyvision, or hlg).
| v22
|-
| <code>ListItem.Property(Stream.Language)</code>
| '''Returns'''
:The audio language of the currently playing video as an ISO 639-2 three character code (e.g. eng, epo, deu, etc).
| v22
|-
| <code>ListItem.Property(Stream.Resolution)</code>
| '''Returns'''
:The video resolution of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.StereoMode)</code>
| '''Returns'''
:The stereomode of the playing video (e.g. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, or anaglyph_green_magenta).
| v22
|-
| <code>ListItem.Property(SubtitleLanguage.[n])</code>
| '''Returns'''
:The subtitle language of the currently selected video, 'n' defines the number of the subtitle (values: see ListItem.SubtitleLanguage).
|
|-
| <code>ListItem.Property(TotalEpisodes)</code>
| '''Returns'''
:The total number of episodes for the currently selected TV show or season.
|
|-
| <code>ListItem.Property(TotalSeasons)</code>
| '''Returns'''
:The total number of seasons for the currently selected TV show.
|
|-
| <code>ListItem.Property(UnWatchedEpisodes)</code>
| '''Returns'''
:The number of unwatched episodes for the currently selected TV show or season.
|
|-
| <code>ListItem.Property(WatchedEpisodes)</code>
| '''Returns'''
:The number of watched episodes for the currently selected TV show or season.
|
|-
| <code>ListItem.PVRClientName</code>
| '''Returns'''
:The name of the PVR client addon for the selected PVR list item.
| v22
|-
| <code>ListItem.PVRInstanceName</code>
| '''Returns'''
:The name of the instance of the PVR client addon for the selected PVR list item.
| v22
|-
| <code>ListItem.Rating[(name)]</code>
| '''Returns'''
:The scraped rating of the currently selected item in a container. Optionally you can specify the name of the scraper to retrieve a specific rating, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.RatingAndVotes[(name)]</code>
| '''Returns'''
:The IMDB rating and votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve a specific rating and votes, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.ReleaseDate</code>
| '''Returns'''
:The release date of the current item.
| v19
|-
| <code>ListItem.SampleRate</code>
| '''Returns'''
:The sample rate of a song / 1000.0 (e.g. 44.1, 48, 96 etc).
| v19
|-
| <code>ListItem.Season</code>
| '''Returns'''
:The season value for the currently selected TV show.
|
|-
| <code>ListItem.Set</code>
| '''Returns'''
:The name of the set the movie is part of.
|
|-
| <code>ListItem.SetId</code>
| '''Returns'''
:The id of the set the movie is part of.
|
|-
| <code>ListItem.Size</code>
| '''Returns'''
:The file size of the currently selected song or movie in a container.
|
|-
| <code>ListItem.SortLetter</code>
| '''Returns'''
:The first letter of the current file in a container.
|
|-
| <code>ListItem.StartDate</code>
| '''Returns'''
:The start date of current selected TV programme in a container.
|
|-
| <code>ListItem.StartDate</code>
| '''Returns'''
:The start date of the selected item (PVR).
|
|-
| <code>ListItem.StartTime</code>
| '''Returns'''
:The start time of current selected TV programme in a container.
|
|-
| <code>ListItem.StartTime</code>
| '''Returns'''
:The start time of the selected item (PVR).
|
|-
| <code>ListItem.Status</code>
| '''Returns'''
:The status of the selected TV show (e.g. 'returning series','in production','planned','cancelled' or 'ended').
|
|-
| <code>ListItem.StereoscopicMode</code>
| '''Returns'''
:The stereomode of the selected video (ie.g. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, or anaglyph_green_magenta).
|
|-
| <code>ListItem.Studio</code>
| '''Returns'''
:The studio of current selected music video in a container.
|
|-
| <code>ListItem.SubtitleLanguage</code>
| '''Returns'''
:The subtitle language of the currently selected video as an ISO 639-2 three character code (e.g. eng, epo, deu).
|
|-
| <code>ListItem.Tag</code>
| '''Returns'''
:The name of the 'tag' this movie is part of.
|
|-
| <code>ListItem.Tagline</code>
| '''Returns'''
:The small summary of current video in a container.
|
|-
| <code>ListItem.Title</code>
| '''Returns'''
:The title of the currently selected song or movie in a container.
|
|-
| <code>ListItem.Top250</code>
| '''Returns'''
:The IMDB top 250 position of the currently selected ListItem in a container.
|
|-
| <code>ListItem.TotalDiscs</code>
| '''Returns'''
:The total amount of discs belonging to an album.
| v19
|-
| <code>ListItem.TrackNumber</code>
| '''Returns'''
:The track number of the currently selected song in a container.
|
|-
| <code>ListItem.Trailer</code>
| '''Returns'''
:The full trailer path with filename of the currently selected movie in a container.
|
|-
| <code>ListItem.TVShowDBID</code>
| '''Returns'''
:The TV show DBID of the selected season or episode a container.
| v19
|-
| <code>ListItem.TVShowTitle</code>
| '''Returns'''
:The name value for the currently selected TV show in the season and episode depth of the video library.
|
|-
| <code>ListItem.UniqueID()</code>
| '''Returns'''
:The UniqueID of the selected item in a container.
| v19
|-
| <code>ListItem.UserRating</code>
| '''Returns'''
:The user rating of the currently selected item in a container.
|
|-
| <code>ListItem.VideoAspect</code>
| '''Returns'''
:The aspect ratio of the currently selected video.<br>
:Possible values:
:*1.00*
:*1.19*
:*1.33
:*1.37
:*1.66
:*1.78
:*1.85
:*2.00*
:*2.20
:*2.35
:*2.40
:*2.55
:*2.76
| *v20
|-
| <code>ListItem.VideoCodec</code>
| '''Returns'''
:The video codec of the currently selected video.<br>
:Possible values:
:*3iv2
:*av1
:*avc1
:*div2
:*div3
:*divx
:*divx 4
:*dx50
:*flv
:*h264
:*hev1
:*hevc
:*hvc1
:*microsoft
:*mp42
:*mp43
:*mp4v
:*mpeg1
:*mpeg1video
:*mpeg2
:*mpeg2video
:*mpeg4
:*mpg4
:*rv40
:*svq1
:*svq3
:*theora
:*vc-1
:*vc1
:*vp6f
:*vp8
:*vp9
:*wmv
:*wmv2
:*wmv3
:*wvc1
:*xvid
|
|-
| <code>ListItem.VideoResolution</code>
| '''Returns'''
:The resolution of the currently selected video.<br>
:Possible values:
:*480
:*576
:*540
:*720
:*1080
:*4K
:*8K*
{{highlight|'''Note'''<br>
That 540 usually means a widescreen format (around 960x540) while 576 means PAL resolutions (normally 720x576), therefore 540 is actually better resolution than 576.}}
| *v18
|-
| <code>ListItem.VideoVersionName</code>
| '''Returns'''
:The name of the video version.
| v21
|-
| <code>ListItem.Votes[(name)]</code>
| '''Returns'''
:The IMDB votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve specific votes, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.Writer</code>
| '''Returns'''
:The name of Writer of current video in a container.
|
|-
| <code>ListItem.Year</code>
| '''Returns'''
:The year of the currently selected song, album, or movie in a container.
|}

=== MusicPartyMode ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>MusicPartyMode.SongsPlayed</code>
| '''Returns'''
:The number of songs played during Party Mode.
|
|-
| <code>MusicPartyMode.MatchingSongs</code>
| '''Returns'''
:The number of songs available to Party Mode.
|
|-
| <code>MusicPartyMode.MatchingSongsPicked</code>
| '''Returns'''
:The number of songs picked already for Party Mode.
|
|-
| <code>MusicPartyMode.MatchingSongsLeft</code>
| '''Returns'''
:The number of songs left to be picked from for Party Mode.
|
|-
| <code>MusicPartyMode.RelaxedSongsPicked</code>
| '''Returns'''
:The number of relaxed songs picked during Party Mode.
|
|-
| <code>MusicPartyMode.RandomSongsPicked</code>
| '''Returns'''
:The number of unique random songs picked during Party Mode.
|
|}

=== Network ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Network.LinkState</code>
| '''Returns'''
:The network linkstate (e.g. 10mbit/100mbit etc).
|
|-
| <code>Network.MacAddress</code>
| '''Returns'''
:The system's mac address.
|
|-
| <code>Network.SubnetMask</code>
| '''Returns'''
:The network subnet mask.
|
|-
| <code>Network.GatewayAddress</code>
| '''Returns'''
:The network gateway address.
|
|-
| <code>Network.DNS1Address</code>
| '''Returns'''
:The network dns server 1 address.
|
|-
| <code>Network.DNS2Address</code>
| '''Returns'''
:The network dns server 2 address.
|
|-
| <code>Network.DHCPAddress</code>
| '''Returns'''
:The DHCP server ip address.
|
|}

=== Player labels ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Player.FinishTime</code>
| Time playing media will end
|
|-
| <code>Player.FinishTime(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Chapter</code>
| Current chapter of current playing media
|
|-
| <code>Player.ChapterCount</code>
| Total number of chapters of current playing media
|
|-
| <code>Player.Time</code>
| Elapsed time of current playing media
|
|-
| <code>Player.Time(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.TimeRemaining</code>
| Remaining time of current playing media
|
|-
| <code>Player.TimeRemaining(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Duration</code>
| Total duration of the current playing media
|
|-
| <code>Player.Duration(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.SeekTime</code>
| Time to which the user is seeking
|
|-
| <code>Player.SeekBar</code>
| Time to which the user is seeking as a percentage (for use in slider controls)
|
|-
| <code>Player.SeekOffset</code>
| Indicates the seek offset after a seek press (e.g. user presses BigStepForward, player.seekoffset returns +10:00)
|
|-
| <code>Player.SeekOffset(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.SeekStepSize</code>
| Displays the seek step size. (v15 addition)
|
|-
| <code>Player.Progress</code>
| Shows how much (percentage) of the file has been played
|
|-
| <code>Player.ProgressCache</code>
| Shows how much of the file is cached above current play percentage
|
|-
| <code>Player.Folderpath</code>
| Shows the full path of the currently playing song or movie. (supports .offset() and .position())
|
|-
| <code>Player.Filenameandpath</code>
| Shows the full path with filename of the currently playing song or movie. (supports .offset() and .position())
|
|-
| <code>Player.StartTime</code>
| Returns the starttime (from the epg) of a tv program, for all other videos it will return the time you started watching this video.
|
|-
| <code>Player.StartTime(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Title</code>
| Returns the musicplayer title for audio and the videoplayer title for videos. (supports .offset() and .position())
|
|-
| <code>Player.Filename</code>
| Returns the filename of the currently playing media. (supports .offset() and .position())
|
|-
| <code>Player.Volume</code>
| Returns the volume level in dB
|
|-
| <code>Player.PlaySpeed</code>
| Current playspeed. (range:0.8 to 1.5)
|
|-
| <code>Player.Process(AudioBitsPerSample)</code>
| Bits per sample of the currently playing item
|
|-
| <code>Player.Process(AudioChannels)</code>
| Number of audiochannels of the currently playing item
|
|-
| <code>Player.Process(AudioDecoder)</code>
| Audiodecoder name of the currently playing item
|
|-
| <code>Player.Process(AudioSamplerate)</code>
| Samplerate f the currently playing item
|
|-
| <code>Player.Process(DeintMethod)</code>
| Deinterlace method of the currently playing video
|
|-
| <code>Player.Process(PixFormat)</code>
| Pixel format of the currently playing video
|
|-
| <code>Player.Process(VideoDAR)</code>
| Display aspect ratio of the currently playing video
|
|-
| <code>Player.Process(VideoFPS)</code>
| Video framerate of the currently playing video
|
|-
| <code>Player.Process(VideoHeight)</code>
| Height of the currently playing video
|
|-
| <code>Player.Process(VideoDecoder)</code>
| Videodecoder name of the currently playing video
|
|-
| <code>Player.Process(VideoWidth)</code>
| Width of the currently playing video
|
|-
| <code>Player.Process(VideoScanType)</code>
| The scan type identifier of the currently playing video '''p''' (for progressive) or '''i''' (for interlaced)
| v20
|-
| <code>Player.CutList</code>
| this infolabel can be used with the [[Ranges Control]], as EDL and chapter markers
| v19
|-
| <code>Player.Chapters</code>
| this infolabel can be used with the [[Ranges Control]], as EDL and chapter markers
| v19
|}

==== Music player ====

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>MusicPlayer.ParentalRatingCode</code>
| Shows the parental rating code
| v22
|-
| <code>MusicPlayer.ParentalRatingIcon</code>
| Shows the parental rating icon
| v22
|-
| <code>MusicPlayer.ParentalRatingSource</code>
| Shows the parental rating source
| v22
|-
| <code>MusicPlayer.ChannelLogo</code>
| Shows the logo of the currently selected radio or TV channel
| v22
|-
| <code>MusicPlayer.Title</code>
| Title of the currently playing song, also available are "MusicPlayer.offset(number).Title" offset is relative to the current playing item and "MusicPlayer.Position(number).Title" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Album</code>
| Album from which the current song is from, also available are "MusicPlayer.offset(number).Album" offset is relative to the current playing item and "MusicPlayer.Position(number).Album" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Property(Album_Mood)</code>
| Shows the moods of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Style)</code>
| Shows the styles of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Theme)</code>
| Shows the themes of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Type)</code>
| Shows the Album Type (e.g. compilation, enhanced, explicit lyrics) of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Label)</code>
| Shows the record label of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Description)</code>
| Shows a review of the currently playing Album
|
|-
| <code>MusicPlayer.Artist</code>
| Artist(s) of current song, also available are "MusicPlayer.offset(number).Artist" offset is relative to the current playing item and "MusicPlayer.Position(number).Artist" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Property(Artist_Born)</code>
| Date of Birth of the currently playing Artist
|
|-
| <code>MusicPlayer.Property(Artist_Died)</code>
| Date of Death of the currently playing Artist
|
|-
| <code>MusicPlayer.Property(Artist_Formed)</code>
| Formation date of the currently playing Artist/Band
|
|-
| <code>MusicPlayer.Property(Artist_Disbanded)</code>
| Disbanding date of the currently playing Artist/Band
|
|-
| <code>MusicPlayer.Property(Artist_YearsActive)</code>
| Years the currently Playing artist has been active
|
|-
| <code>MusicPlayer.Property(Artist_Instrument)</code>
| Instruments played by the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Description)</code>
| Shows a biography of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Mood)</code>
| Shows the moods of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Style)</code>
| Shows the styles of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Genre)</code>
| Shows the genre of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Sortname)</code>
| Sortname of the currently playing Artist
| v18
|-
| <code>MusicPlayer.Property(Artist_Type)</code>
| Type of the currently playing Artist - person, group, orchestra, choir, etc.
| v18
|-
| <code>MusicPlayer.Property(Artist_Gender)</code>
| Gender of the currently playing Artist - male, female, other
| v18
|-
| <code>MusicPlayer.Property(Artist_Disambiguation)</code>
| Brief description of the currently playing Artist that differentiates them from others with the same name
| v18
|-
| <code>MusicPlayer.Genre</code>
| Genre(s) of current song, also available are "MusicPlayer.offset(number).Genre" offset is relative to the current playing item and "MusicPlayer.Position(number).Genre" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Lyrics</code>
| Lyrics of current song stored in ID tag info
|
|-
| <code>MusicPlayer.Year</code>
| Year of release of current song, also available are "MusicPlayer.offset(number).Year" offset is relative to the current playing item and "MusicPlayer.Position(number).Year" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Rating</code>
| Numeric Rating of current song, also available are "MusicPlayer.offset(number).Rating" offset is relative to the current playing item and "MusicPlayer.Position(number).Rating" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.DiscNumber</code>
| Disc Number of current song stored in ID tag info, also available are "MusicPlayer.offset(number).DiscNumber" offset is relative to the current playing item and "MusicPlayer.Position(number).DiscNumber" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Comment</code>
| Comment of current song stored in ID tag info, also available are "MusicPlayer.offset(number).Comment" offset is relative to the current playing item and "MusicPlayer.Position(number).Comment" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Time</code>
| Current time in song
|
|-
| <code>MusicPlayer.TimeRemaining</code>
| Current remaining time in song
|
|-
| <code>MusicPlayer.TimeSpeed</code>
| Both the time and the playspeed formatted up. e.g. 1:23 (2x)
|
|-
| <code>MusicPlayer.TrackNumber</code>
| Track number of current song, also available are "MusicPlayer.offset(number).TrackNumber" offset is relative to the current playing item and "MusicPlayer.Position(number).TrackNumber" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Duration</code>
| Duration of current song, also available are "MusicPlayer.offset(number).Duration" offset is relative to the current playing item and "MusicPlayer.Position(number).Duration" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.BitRate</code>
| Bitrate of current song
|
|-
| <code>MusicPlayer.Channels</code>
| Number of channels of current song
|
|-
| <code>MusicPlayer.BitsPerSample</code>
| Number of bits per sample of current song
|
|-
| <code>MusicPlayer.SampleRate</code>
| Samplerate of current song
|
|-
| <code>MusicPlayer.Codec</code>
| Codec of current song
|
|-
| <code>MusicPlayer.PlaylistPosition</code>
| Position of the current song in the current music playlist
|
|-
| <code>MusicPlayer.PlaylistLength</code>
| Total size of the current music playlist
|
|-
| <code>MusicPlayer.ChannelName</code>
| Channel name of the radio programme that's currently playing (PVR).
|
|-
| <code>MusicPlayer.ChannelNumberLabel</code>
| Channel and subchannel number of the radio channel that's currently playing (PVR).
|
|-
| <code>MusicPlayer.ChannelGroup</code>
| Channel group of of the radio programme that's currently playing (PVR).
|
|-
| <code>MusicPlayer.Contributors</code>
| List of all people who've contributed to the currently playing song
|
|-
| <code>MusicPlayer.ContributorAndRole</code>
| List of all people and their role who've contributed to the currently playing song
|
|-
| <code>MusicPlayer.Mood</code>
| Mood of the currently playing song
|
|-
| <code>MusicPlayer.Property(Role.Arranger)</code>
| Returns the name of the person who arranged the selected song
|
|-
| <code>MusicPlayer.Property(Role.Composer)</code>
| Returns the name of the person who composed the selected song
|
|-
| <code>MusicPlayer.Property(Role.Conductor)</code>
| Returns the name of the person who conducted the selected song
|
|-
| <code>MusicPlayer.Property(Role.DJMixer)</code>
| Returns the name of the dj who remixed the selected song
|
|-
| <code>MusicPlayer.Property(Role.Engineer)</code>
| Returns the name of the person who was the engineer of the selected song
|
|-
| <code>MusicPlayer.Property(Role.Lyricist)</code>
| Returns the name of the person who wrote the lyrics of the selected song
|
|-
| <code>MusicPlayer.Property(Role.Mixer)</code>
| Returns the name of the person who mixed the selected song
|
|-
| <code>MusicPlayer.Property(Role.Orchestra)</code>
| Returns the name of the orchestra performing the selected song
|
|-
| <code>MusicPlayer.Property(Role.Producer)</code>
| Returns the name of the person who produced the selected song
|
|-
| <code>MusicPlayer.Property(Role.Remixer)</code>
| Returns the name of the person who remixed the selected song
|
|-
| <code>MusicPlayer.UserRating</code>
| The rating the user gave to the currently playing song
|
|-
| <code>MusicPlayer.DBID</code>
| The database id of the currently playing song
| v17
|-
| <code>MusicPlayer.DiscTitle</code>
| The title of the disc currently playing
| v19
|-
| <code>MusicPlayer.ReleaseDate</code>
| Returns the release date of the song currently playing
| v19
|-
| <code>MusicPlayer.OriginalDate</code>
| Returns the original release date of the song currently playing
| v19
|-
| <code>MusicPlayer.BPM</code>
| Returns the Beats Per Minute of the currently playing song
| v19
|-
| <code>MusicPlayer.TotalDiscs</code>
| Returns the number of discs associated with the album of the currently playing song
| v19
|}

==== Video player ====

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>VideoPlayer.AudioStreamCount</code>
| Returns the number of audio streams of the currently playing video
| v21
|-
| <code>VideoPlayer.VideoStreamCount</code>
| Returns the number of video streams of the currently playing video
| v22
|-
| <code>VideoPlayer.ParentalRatingCode</code>
| Shows the parental rating code
| v22
|-
| <code>VideoPlayer.ParentalRatingIcon</code>
| Shows the parental rating icon
| v22
|-
| <code>VideoPlayer.ParentalRatingSource</code>
| Shows the parental rating source
| v22
|-
| <code>VideoPlayer.ChannelLogo</code>
| Shows the logo of the currently selected radio or TV channel
| v22
|-
| <code>VideoPlayer.VideoVersionName</code>
| Show the name of the video version
| v21
|-
| <code>VideoPlayer.Time</code>
| Current time in movie
|
|-
| <code>VideoPlayer.TimeRemaining</code>
| Current remaining time in movie
|
|-
| <code>VideoPlayer.TimeSpeed</code>
| Current time + playspeed. e.g. 1:23:14 (-4x)
|
|-
| <code>VideoPlayer.Duration</code>
| Length of current movie
|
|-
| <code>VideoPlayer.Title</code>
| Title of currently playing video. If it's in the database it will return the database title, else the filename. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.OriginalTitle</code>
| The original title of currently playing video. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.TVShowTitle</code>
| Title of currently playing episode's tvshow name. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Season</code>
| Season number of the currently playing episode, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Episode</code>
| Episode number of the currently playing episode. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Genre</code>
| Genre(s) of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Director</code>
| Director of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Country</code>
| Production country of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Year</code>
| Year of release of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Premiered</code>
| The release/aired date of the currently selected episode, show, movie or EPG item. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Rating</code>
| IMDb user rating of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.UserRating</code>
| Shows the user rating of the currently playing item. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Votes</code>
| IMDb votes of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.RatingAndVotes</code>
| IMDb user rating and votes of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.mpaa</code>
| MPAA rating of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.IMDBNumber</code>
| The IMDB iD of the current video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.EpisodeName</code>
| (PVR only) The name of the episode if the playing video is a TV Show, if it's in the database
|
|-
| <code>VideoPlayer.PlaylistPosition</code>
| Position of the current song in the current video playlist
|
|-
| <code>VideoPlayer.PlaylistLength</code>
| Total size of the current video playlist
|
|-
| <code>VideoPlayer.Cast</code>
| A list of cast members, separated by carriage returns, if it's in the database
|
|-
| <code>VideoPlayer.CastAndRole</code>
| A list of cast members and roles, separated by carriage returns. Every cast/role combination is formatted 'cast' as 'role' where 'as' is localised, if it's in the database
|
|-
| <code>VideoPlayer.Trailer</code>
| The trailer of the current movie. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Album</code>
| Album from which the current Music Video is from, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Artist</code>
| Artist(s) of current Music Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Studio</code>
| Studio of current Music Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Writer</code>
| Name of Writer of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Tagline</code>
| Small Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.PlotOutline</code>
| Small Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Plot</code>
| Complete Text Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Top250</code>
| Shows the IMDb top250 position of the current playing Video. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.LastPlayed</code>
| Last play date of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.PlayCount</code>
| Playcount of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.HdrType</code>
| Shows the HDR type of the currently playing video (possible values: hdr10, dolbyvision and hlg)
| v20
|-
| <code>VideoPlayer.VideoCodec</code>
| Shows the video codec of the currently playing video (common values: see ListItem.VideoCodec)
|
|-
| <code>VideoPlayer.VideoResolution</code>
| Shows the video resolution of the currently playing video (possible values: see ListItem.VideoResolution)
|
|-
| <code>VideoPlayer.VideoAspect</code>
| Shows the aspect ratio of the currently playing video (possible values: see ListItem.VideoAspect)
|
|-
| <code>VideoPlayer.AudioCodec</code>
| Shows the audio codec of the currently playing video, optionally 'n' defines the number of the audiostream (common values: see ListItem.AudioCodec)
|
|-
| <code>VideoPlayer.AudioChannels</code>
| Shows the number of audio channels of the currently playing video (possible values: see ListItem.AudioChannels)
|
|-
| <code>VideoPlayer.AudioLanguage</code>
| Shows the language of the audio of the currently playing video(possible values: see ListItem.AudioLanguage)
|
|-
| <code>VideoPlayer.SubtitlesLanguage</code>
| Shows the language of the subtitle of the currently playing video (possible values: see ListItem.SubtitlesLanguage)
|
|-
| <code>VideoPlayer.StereoscopicMode</code>
| Shows the stereoscopic mode of the currently playing video (possible values: see ListItem.StereoscopicMode)
|
|-
| <code>VideoPlayer.EndTime</code>
| End date of the currently playing programme (PVR).
|
|-
| <code>VideoPlayer.NextTitle</code>
| Title of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextGenre</code>
| Genre of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextPlot</code>
| Plot of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextPlotOutline</code>
| Plot outline of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextStartTime</code>
| Start time of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextEndTime</code>
| End time of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextDuration</code>
| Duration of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.ChannelName</code>
| Name of the curently tuned channel (PVR).
|
|-
| <code>VideoPlayer.ChannelNumberLabel</code>
| Channel and subchannel number of the tv channel that's currently playing (PVR).
|
|-
| <code>VideoPlayer.ChannelGroup</code>
| Group of the curently tuned channel (PVR).
|
|-
| <code>VideoPlayer.ParentalRating</code>
| Parental rating of the currently playing programme (PVR).
|
|-
| <code>VideoPlayer.DBID</code>
| The database id of the currently playing video. (supports .offset() and .position())
| v17
|-
| <code>VideoPlayer.UniqueID()</code>
| Returns the UniqueID of the currently playing video
| v19
|-
| <code>VideoPlayer.TvShowDBID</code>
| Returns the tv show DBID of the currently playing episode
| v19
|}

=== Playlist ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Playlist.Length(media)</code>
| Total size of the current playlist. optional parameter media is either video or music.
|
|-
| <code>Playlist.Position(media)</code>
| Position of the current item in the current playlist. optional parameter media is either video or music.
|
|-
| <code>Playlist.Random</code>
| Returns 'On' or 'Off'
|
|-
| <code>Playlist.Repeat</code>
| Returns string ID's 592 (Repeat One), 593 (Repeat All), or 594 (Repeat Off)
|
|}

=== PVR ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>PVR.NowRecordingTitle</code>
| Title of the programme being recorded
|
|-
| <code>PVR.NowRecordingDateTime</code>
| Start date and time of the current recording
|
|-
| <code>PVR.NowRecordingChannel</code>
| Channel number that's being recorded
|
|-
| <code>PVR.NextRecordingTitle</code>
| Title of the next programme that will be recorded
|
|-
| <code>PVR.NextRecordingDateTime</code>
| Start date and time of the next recording
|
|-
| <code>PVR.NextRecordingChannel</code>
| Channel name of the next recording
|
|-
| <code>PVR.BackendName</code>
| Name of the backend being used
|
|-
| <code>PVR.BackendVersion</code>
| version of the backend that's being used
|
|-
| <code>PVR.BackendHost</code>
| Backend hostname
|
|-
| <code>PVR.BackendDiskSpace</code>
| Available diskspace on the backend
|
|-
| <code>PVR.BackendChannels</code>
| Number of available channels the backend provides
|
|-
| <code>PVR.BackendTimers</code>
| Number of timers set for the backend
|
|-
| <code>PVR.BackendRecordings</code>
| Number of recording available on the backend
|
|-
| <code>PVR.BackendDiskspace</code>
| Free diskspace available for recordings on the backend
|
|-
| <code>PVR.BackendNumber</code>
| Backend number
|
|-
| <code>PVR.ClientCount</code>
| Number of PVR clients enabled
| v22
|-
| <code>PVR.TotalDiscSpace</code>
| Total diskspace available for recordings
|
|-
| <code>PVR.NextTimer</code>
| Next timer date
|
|-
| <code>PVR.EpgEventDuration[(format)]</code>
| Returns the duration of the currently played title on TV. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.EpgEventElapsedTime[(format)]</code>
| Returns the time position of the currently played title on TV. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.EpgEventRemainingTime[(format)]</code>
| Returns the remaining time for currently playing epg event. See ListItem.Duration for optinional formatting options
| v18
|-
| <code>PVR.EpgEventFinishTime[(format)]</code>
| Returns the time the currently playing epg event will end. See ListItem.Duration for optinional formatting options
| v18
|-
| <code>PVR.EpgEventSeekTime[(format)]</code>
| Returns the seek time of the currently playing epg event. See ListItem.Duration for optinional formatting options
| v18
|-
| <code>PVR.EpgEventProgress</code>
| Returns the position of currently played title on TV as integer
|
|-
| <code>PVR.TimeShiftStart[(format)]</code>
| Start position of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.TimeShiftEnd[(format)]</code>
| End position of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.TimeShiftCur[(format)]</code>
| Current position of the timeshift. See ListItem.Duration for optinional formatting options
|-
| <code>PVR.TimeShiftOffset[(format)]</code>
| Current offset of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.TimeShiftProgress</code>
| Returns the position of currently timeshifted title on TV as interger
|
|-
| <code>PVR.ActStreamClient</code>
| Stream client name
|
|-
| <code>PVR.ActStreamDevice</code>
| Stream device name
|
|-
| <code>PVR.ActStreamStatus</code>
| Status of the stream
|
|-
| <code>PVR.ActStreamSignal</code>
| Signal quality of the stream
|
|-
| <code>PVR.ActStreamSnr</code>
| Signal to noise ratio of the stream
|
|-
| <code>PVR.ActStreamBer</code>
| Bit error rate of the stream
|
|-
| <code>PVR.ActStreamUnc</code>
| UNC value of the stream
|
|-
| <code>PVR.ActStreamVideoBitRate</code>
| Video bitrate of the stream
|
|-
| <code>PVR.ActStreamAudioBitRate</code>
| Audio bitrate of the stream
|
|-
| <code>PVR.ActStreamDolbyBitRate</code>
| Dolby bitrate of the stream
|
|-
| <code>PVR.ActStreamProgrSignal</code>
| Signal quality of the programme
|
|-
| <code>PVR.ActStreamProgrSnr</code>
| Signal to noise ratio of the programme
|
|-
| <code>PVR.ActStreamEncryptionName</code>
| Encryption used on the stream
|
|-
| <code>PVR.TVNowRecordingTitle</code>
| Title of the tv programme being recorded
| v17
|-
| <code>PVR.TVNowRecordingDateTime</code>
| Start date and time of the current tv recording
| v17
|-
| <code>PVR.TVNowRecordingChannel</code>
| Channel name of the current tv recording
| v17
|-
| <code>PVR.TVNowRecordingChannelIcon</code>
| Icon of the current recording TV channel
| v17
|-
| <code>PVR.TVNextRecordingTitle</code>
| Title of the next tv programme that will be recorded
| v17
|-
| <code>PVR.TVNextRecordingDateTime</code>
| Start date and time of the next tv recording
| v17
|-
| <code>PVR.TVNextRecordingChannel</code>
| Channel name of the next tv recording
| v17
|-
| <code>PVR.TVNextRecordingChannelIcon</code>
| Icon of the next recording tv channel
| v17
|-
| <code>PVR.RadioNowRecordingTitle</code>
| Title of the radio programme being recorded
| v17
|-
| <code>PVR.RadioNowRecordingDateTime</code>
| Start date and time of the current radio recording
| v17
|-
| <code>PVR.RadioNowRecordingChannel</code>
| Channel name of the current radio recording
| v17
|-
| <code>PVR.RadioNowRecordingChannelIcon</code>
| Icon of the current recording radio channel
| v17
|-
| <code>PVR.RadioNextRecordingTitle</code>
| Title of the next radio programme that will be recorded
| v17
|-
| <code>PVR.RadioNextRecordingDateTime</code>
| Start date and time of the next radio recording
| v17
|-
| <code>PVR.RadioNextRecordingChannel</code>
| Channel name of the next radio recording
| v17
|-
| <code>PVR.ChannelNumberInput</code>
| Label displaying the number the user entered on remote or keyboard
| v18
|-
| <code>PVR.TimeshiftProgressDuration</code>
| Returns the duration of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| <code>PVR.TimeshiftProgressDuration(format)</code>
| Returns the duration of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| <code>PVR.TimeshiftProgressStartTime</code>
| Returns the start time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| <code>PVR.TimeshiftProgressStartTime(format)</code>
| Returns the start time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| <code>PVR.TimeshiftProgressEndTime</code>
| Returns the end time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| <code>PVR.TimeshiftProgressEndTime(format)</code>
| Returns the end time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| <code>PVR.TimeshiftProgressPlayPos</code>
| Returns the percentage of the current play position within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressEpgStart</code>
| Returns the percentage of the start of the currently playing epg event within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressEpgEnd</code>
| Returns the percentage of the end of the currently playing epg event within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressBufferStart</code>
| Returns the percentage of the start of the timeshift buffer within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressBufferEnd</code>
| Returns the percentage of the end of the timeshift buffer within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeShiftSeekbar</code>
| This is the equivalent of Player.Seekbar, but for LiveTV (can be used in a slider control and indicates the position being seeked to)
| v19
|}

=== RDS ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>RDS.AudioLanguage</code>
| The from RDS reported audio language of channel
|
|-
| <code>RDS.ChannelCountry</code>
| Country where the radio channel is sended
|
|-
| <code>RDS.GetLine(number)</code>
| Returns the last sended RDS text messages on givern number, 0 is thelast and 4 rows are supported (0-3)
|
|-
| <code>RDS.Title</code>
| Title of item; e.g. track title of an album (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Artist</code>
| A person or band/collective generally considered responsible for the work (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Band</code>
| Band/orchestra/accompaniment/musician (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Composer</code>
| Name of the original composer/author (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Conductor</code>
| The artist(s) who performed the work. In classical music this would bethe conductor (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Album</code>
| The collection name to which this track belongs (Only be available on RadiotextPlus)
|
|-
| <code>RDS.TrackNumber</code>
| The track number of the item on the album on which it was originallyreleased. (Only be available on RadiotextPlus)
|
|-
| <code>RDS.RadioStyle</code>
| The from radio channel used style of currently played part, e.g "popmusic", "news" or "weather"
|
|-
| <code>RDS.Comment</code>
| Radio station comment string if available (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoNews</code>
| Message / headline (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoNewsLocal</code>
| Local information news sended from radio channel (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoStock</code>
| Quote information; either as one part or as several distinct parts:"name 99latest value 99change 99high 99low 99volume" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoStockSize</code>
| Number of rows present in stock information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoSport</code>
| Result of a game; either as one part or as several distinct parts:"match 99result", e.g. "Bayern München : Borussia 995:5" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoSportSize</code>
| Number of rows present in sport information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoLottery</code>
| Raffle / lottery: "key word 99values" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoLotterySize</code>
| Number of rows present in lottery information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoWeather</code>
| Weather informations sended from radio channel (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoWeatherSize</code>
| Number of rows present in weather information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoCinema</code>
| Information about movies in cinema (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoCinemaSize</code>
| Number of rows present in cinema information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoHoroscope</code>
| Horoscope; either as one part or as two distinct parts:"key word 99text", e.g. "sign of the zodiac 99blablabla" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoHoroscopeSize</code>
| Number of rows present in horoscope information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoOther</code>
| Other information, not especially specified: "key word 99info" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoOtherSize</code>
| Number of rows present with other informations (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ProgStation</code>
| Name of the radio channel@note becomes also be set from epg if from RDS not available
|
|-
| <code>RDS.ProgNow</code>
| Now played program name@note becomes also be set from epg if from RDS not available
|
|-
| <code>RDS.ProgNext</code>
| Next played program name (if available)@note becomes also be set from epg if from RDS not available
|
|-
| <code>RDS.ProgHost</code>
| Name of the host of the radio show
|
|-
| <code>RDS.ProgEditStaff</code>
| Name of the editorial staff; e.g. name of editorial journalist (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ProgHomepage</code>
| Link to radio station homepage (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ProgStyle</code>
| Human readable string about radiostyle defined from RDS or RBDS
|
|-
| <code>RDS.PhoneHotline</code>
| The telephone number of the radio station's hotline (Only be available on RadiotextPlus)
|
|-
| <code>RDS.PhoneStudio</code>
| The telephone number of the radio station's studio (Only be available on RadiotextPlus)
|
|-
| <code>RDS.SmsStudio</code>
| The sms number of the radio stations studio (to send directly a sms to the studio) (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.EmailHotline</code>
| The email adress of the radio stations hotline (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.EmailStudio</code>
| The email adress of the radio stations studio (if available) (Only be available on RadiotextPlus)
|
|}

=== Skin ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Skin.CurrentTheme</code>
| Returns the current selected skin theme.
|
|-
| <code>Skin.CurrentColourTheme</code>
| Returns the current selected colour theme of the skin.
|
|-
| <code>Skin.Font</code>
| Returns the current fontset from Font.xml.
| v18 addition
|-
| <code>Skin.String(name)</code>
| Returns the <span class="nobr">user-set</span> skin string, set via the Skin.SetString(name) '''[[List of Built In Functions]]'''. Allows skinners to have <span class="nobr">user-customisable</span> labels.
|
|-
| <code>Skin.AspectRatio</code>
| Returns the closest aspect ratio match using the resolution info from the skin's addon.xml file.
|
|}

=== Slideshow ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Slideshow.Altitude</code>
| Shows the altitude in meters where the current picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
|
|-
| <code>Slideshow.Aperture</code>
| Shows the F-stop used to take the current picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
|
|-
| <code>Slideshow.Author</code>
| Shows the name of the person involved in writing about the current picture. This is the value of the IPTC Writer tag (hex code 0x7A).
|
|-
| <code>Slideshow.Byline</code>
| Shows the name of the person who created the current picture. This is the value of the IPTC Byline tag (hex code 0x50).
|
|-
| <code>Slideshow.BylineTitle</code>
| Shows the title of the person who created the current picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
|
|-
| <code>Slideshow.CameraMake</code>
| Shows the manufacturer of the camera used to take the current picture. This is the value of the EXIF Make tag (hex code 0x010F).
|
|-
| <code>Slideshow.CameraModel</code>
| Shows the manufacturer's model name or number of the camera used to take the current picture. This is the value of the EXIF Model tag (hex code 0x0110).
|
|-
| <code>Slideshow.Caption</code>
| Shows a description of the current picture. This is the value of the IPTC Caption tag (hex code 0x78).
|
|-
| <code>Slideshow.Category</code>
| Shows the subject of the current picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
|
|-
| <code>Slideshow.CCDWidth</code>
| Shows the width of the CCD in the camera used to take the current picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
|
|-
| <code>Slideshow.City</code>
| Shows the city where the current picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
|
|-
| <code>Slideshow.Colour</code>
| Shows whether the current picture is "Colour" or "Black and White".
|
|-
| <code>Slideshow.CopyrightNotice</code>
| Shows the copyright notice of the current picture. This is the value of the IPTC Copyright tag (hex code 0x74).
|
|-
| <code>Slideshow.Country</code>
| Shows the full name of the country where the current picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).
|
|-
| <code>Slideshow.CountryCode</code>
| Shows the country code of the country where the current picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).
|
|-
| <code>Slideshow.Credit</code>
| Shows who provided the current picture. This is the value of the IPTC Credit tag (hex code 0x6E).
|
|-
| <code>Slideshow.DigitalZoom</code>
| Shows the digital zoom ratio when the current picture was taken. This is the value of the EXIF .DigitalZoomRatio tag (hex code 0xA404).
|
|-
| <code>Slideshow.EXIFComment</code>
| Shows a description of the current picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
|
|-
| <code>Slideshow.EXIFDate</code>
| Shows the localized date of the current picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.EXIFDescription</code>
| Shows a short description of the current picture. The SlideComment, EXIFComment, or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E).
|
|-
| <code>Slideshow.EXIFSoftware</code>
| Shows the name and version of the firmware used by the camera that took the current picture. This is the value of the EXIF Software tag (hex code 0x0131).
|
|-
| <code>Slideshow.EXIFTime</code>
| Shows the date/timestamp of the current picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.Exposure</code>
| Shows the class of the program used by the camera to set exposure when the current picture was taken. Values include "Manual", "Program (Auto)", "Aperture priority (Semi-Auto)", "Shutter priority (semi-auto)", etc. This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
|
|-
| <code>Slideshow.ExposureBias</code>
| Shows the exposure bias of the current picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
|
|-
| <code>Slideshow.ExposureMode</code>
| Shows the exposure mode of the current picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402).
|
|-
| <code>Slideshow.ExposureTime</code>
| Shows the exposure time of the current picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
|
|-
| <code>Slideshow.Filedate</code>
| Shows the file date of the current picture
|
|-
| <code>Slideshow.Filename</code>
| Shows the file name of the current picture
|
|-
| <code>Slideshow.Filesize</code>
| Shows the file size of the current picture
|
|-
| <code>Slideshow.FlashUsed</code>
| Shows the status of flash when the current picture was taken. The value will be either "Yes" or "No", and might include additional information. This is the value of the EXIF Flash tag (hex code 0x9209).
|
|-
| <code>Slideshow.FocalLength</code>
| Shows the focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
|
|-
| <code>Slideshow.FocusDistance</code>
| Shows the distance to the subject, in meters. This is the value of the EXIF SubjectDistance tag (hex code 0x9206).
|
|-
| <code>Slideshow.Headline</code>
| Shows a synopsis of the contents of the current picture. This is the value of the IPTC Headline tag (hex code 0x69).
|
|-
| <code>Slideshow.ImageType</code>
| Shows the color components of the current picture. This is the value of the IPTC ImageType tag (hex code 0x82).
|
|-
| <code>Slideshow.IPTCDate</code>
| Shows the date when the intellectual content of the current picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37).
|
|-
| <code>Slideshow.ISOEquivalence</code>
| Shows the ISO speed of the camera when the current picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
|
|-
| <code>Slideshow.Keywords</code>
| Shows keywords assigned to the current picture. This is the value of the IPTC Keywords tag (hex code 0x19).
|
|-
| <code>Slideshow.Latitude</code>
| Shows the latitude where the current picture was taken (degrees, minutes, seconds North or South). This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
|
|-
| <code>Slideshow.LightSource</code>
| Shows the kind of light source when the picture was taken. Possible values include "Daylight", "Fluorescent", "Incandescent", etc. This is the value of the EXIF LightSource tag (hex code 0x9208).
|
|-
| <code>Slideshow.LongEXIFDate</code>
| Shows only the localized date of the current picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.LongEXIFTime</code>
| Shows the date/timestamp of the current picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.Longitude</code>
| Shows the longitude where the current picture was taken (degrees, minutes, seconds East or West). This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
|
|-
| <code>Slideshow.MeteringMode</code>
| Shows the metering mode used when the current picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207).
|
|-
| <code>Slideshow.ObjectName</code>
| Shows a shorthand reference for the current picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
|
|-
| <code>Slideshow.Orientation</code>
| Shows the orientation of the current picture. Possible values are "Top Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112).
|
|-
| <code>Slideshow.Path</code>
| Shows the file path of the current picture
|
|-
| <code>Slideshow.Process</code>
| Shows the process used to compress the current picture
|
|-
| <code>Slideshow.ReferenceService</code>
| Shows the Service Identifier of a prior envelope to which the current picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D).
|
|-
| <code>Slideshow.Resolution</code>
| Shows the dimensions of the current picture (Width x Height)
|
|-
| <code>Slideshow.SlideComment</code>
| Shows a description of the current picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.EXIFComment.
|
|-
| <code>Slideshow.SlideIndex</code>
| Shows the slide index of the current picture
|
|-
| <code>Slideshow.Source</code>
| Shows the original owner of the current picture. This is the value of the IPTC Source tag (hex code 0x73).
|
|-
| <code>Slideshow.SpecialInstructions</code>
| Shows other editorial instructions concerning the use of the current picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
|
|-
| <code>Slideshow.State</code>
| Shows the State/Province where the current picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
|
|-
| <code>Slideshow.Sublocation</code>
| Shows the location within a city where the current picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C).
|
|-
| <code>Slideshow.SupplementalCategories</code>
| Shows supplemental category codes to further refine the subject of the current picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).
|
|-
| <code>Slideshow.TimeCreated</code>
| Shows the time when the intellectual content of the current picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C).
|
|-
| <code>Slideshow.TransmissionReference</code>
| Shows a code representing the location of original transmission of the current picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).
|
|-
| <code>Slideshow.Urgency</code>
| Shows the urgency of the current picture. Values are 1-9. The 1 is most urgent. Some image management programs use urgency to indicate picture rating, where urgency 1 is 5 stars and urgency 5 is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A).
|
|-
| <code>Slideshow.WhiteBalance</code>
| Shows the white balance mode set when the current picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
|
|}

=== System ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>System.Time</code>
| Current time
|
|-
| <code>System.Time(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss). (xx) option added after dharma
|
|-
| <code>System.Date</code>
| Current date
|
|-
| <code>System.Date(format)</code>
| Show current date using format, available markings: d (day of month 1-31), dd (day of month 01-31), ddd (short day of the week Mon-Sun), DDD (long day of the week Monday-Sunday), m (month 1-12), mm (month 01-12), mmm (short month name Jan-Dec), MMM (long month name January-December), yy (2-digit year), yyyy (4-digit year). Added after dharma.
|
|-
| <code>System.AlarmPos</code>
| Shutdown Timer position
|
|-
| <code>System.BatteryLevel</code>
| Returns the remaining battery level in range 0-100
|
|-
| <code>System.FreeSpace</code>
| Total Freespace on the drive
|
|-
| <code>System.UsedSpace</code>
| Total Usedspace on the drive
|
|-
| <code>System.TotalSpace</code>
| Totalspace on the drive
|
|-
| <code>System.UsedSpacePercent</code>
| Total Usedspace Percent on the drive
|
|-
| <code>System.FreeSpacePercent</code>
| Total Freespace Percent on the drive
|
|-
| <code>System.CPUTemperature</code>
| Current CPU temperature
|
|-
| <code>System.CpuUsage</code>
| Displays the cpu usage for each individual cpu core.
|
|-
| <code>System.CoreUsage(id)</code>
| Displays the usage of the cpu core with the given 'id'
|
|-
| <code>System.GPUTemperature</code>
| Current GPU temperature
|
|-
| <code>System.FanSpeed</code>
| Current fan speed
|
|-
| <code>System.BuildVersion</code>
| version of build
|
|-
| <code>System.BuildDate</code>
| Date of build
|
|-
| <code>System.FriendlyName</code>
| Returns the Kodi instance name. It will auto append (%hostname%) in case the device name was not changed. e.g. "Kodi (htpc)"
|
|-
| <code>System.FPS</code>
| Current rendering speed (frames per second)
|
|-
| <code>System.FreeMemory</code>
| Amount of free memory in Mb
|
|-
| <code>System.Memory(format)</code>
| Available formats: used, used.percent, free, free.percent, total
|
|-
| <code>System.ScreenMode</code>
| Screenmode (e.g. windowed / fullscreen)
|
|-
| <code>System.ScreenWidth</code>
| Width of screen in pixels
|
|-
| <code>System.ScreenHeight</code>
| Height of screen in pixels
|
|-
| <code>System.StartupWindow</code>
| The Window Kodi will load on startup
|
|-
| <code>System.CurrentWindow</code>
| Current Window we are in
|
|-
| <code>System.CurrentControl</code>
| Current focused control
|
|-
| <code>System.CurrentControlID</code>
| ID of the currently focused control.
|
|-
| <code>System.DVDLabel</code>
| Label of the disk in the <span class="nobr">DVD-ROM</span> drive
|
|-
| <code>System.HddTemperature</code>
| Hdd temperature
|
|-
| <code>System.OSVersionInfo</code>
| System name + kernel version
|
|-
| <code>System.KernelVersion (deprecated)</code>
| System name + kernel version
|
|-
| <code>System.Uptime</code>
| System current uptime
|
|-
| <code>System.TotalUptime</code>
| System total uptime
|
|-
| <code>System.CpuFrequency</code>
| System cpu frequency
|
|-
| <code>System.ScreenResolution</code>
| Screen resolution
|
|-
| <code>System.VideoEncoderInfo</code>
| video encoder info
|
|-
| <code>System.InternetState</code>
| Will return the internet state, 'connected' or 'not connected' (localized)
|
|-
| <code>System.Language</code>
| Shows the current language
|
|-
| <code>System.ProfileName</code>
| Shows the User name of the currently logged in Kodi user
|
|-
| <code>System.ProfileCount</code>
| Shows the number of defined profiles
|
|-
| <code>System.ProfileAutoLogin</code>
| The profile Kodi will auto login to
|
|-
| <code>System.Progressbar</code>
| The percentage of the currently active progress.
|
|-
| <code>System.StereoscopicMode</code>
| The prefered stereoscopic mode (settings > video > playback)
|
|-
| <code>System.TemperatureUnits</code>
| Shows Celsius or Fahrenheit symbol
|
|-
| <code>System.AddonTitle(id)</code>
| Returns the title of the addon with the given id
|
|-
| <code>System.AddonVersion(id)</code>
| Returns the version of the addon with the given id
|
|-
| <code>System.BuildVersionCode</code>
| The internal version of the kodi build
| v19
|-
| <code>System.BuildVersionGit</code>
| The git version (sha) of the kodi build
| v19
|-
| <code>System.AddonUpdateCount</code>
| The number of available addon updates
| v19
|}

=== Visualisation ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Visualisation.Preset</code>
| Shows the current preset of the visualisation.
|
|-
| <code>Visualisation.Name</code>
| Shows the name of the visualisation.
|
|}

=== Weather labels ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Weather.Conditions</code>
| Current weather conditions – this is looked up in a background process.
|
|-
| <code>Weather.Temperature</code>
| Current weather temperature
|
|-
| <code>Weather.Location</code>
| City/town which the above two items are for
|
|-
| <code>Weather.fanartcode</code>
| Current weather fanartcode.
|
|-
| <code>Weather.plugin</code>
| Current weather plugin.
|
|}

=== Window ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Window([window]).Property(key)</code>
| Window property. (key can be any value, optional window can be id or name)
|
|-
| <code>Window.Property(xmlfile)</code>
| Displays the name of the xml file currently shown
|
|-
| <code>Window.Property(IsRadio)</code>
| Returns "true" if the window is a radio window, empty string otherwise (for use in the PVR windows)
|
|-
| <code>Window(AddonBrowser).Property(Updated)</code>
| Shows the date and time the addon repo was last checked for updates
|
|-
| <code>Window.Property(Addon.ID)</code>
| Returns the id of the selected addon, in DialogAddonSettings.xml
|
|-
| <code>Window(Home).Property(key)</code>
| The home window has the following info labels.
Movies.Count, Movies.Watched, Movies.UnWatched, TVShows.Count, TVShows.Watched, TVShows.UnWatched, Episodes.Count, Episodes.Watched, Episodes.UnWatched, MusicVideos.Count, MusicVideos.Watched, MusicVideos.UnWatched, Music.SongsCount, Music.AlbumsCount, Music.ArtistsCount

LatestMovie.[1-10].Title, LatestMovie.[1-10].Year, LatestMovie.[1-10].RunningTime, LatestMovie.[1-10].Rating, LatestMovie.[1-10].Plot, LatestMovie.[1-10].Trailer, LatestMovie.[1-10].Thumb, LatestMovie.[1-10].Fanart, LatestMovie.[1-10].Path

LatestEpisode.[1-10].ShowTitle, LatestEpisode.[1-10].EpisodeTitle, LatestEpisode.[1-10].EpisodeNo, LatestEpisode.[1-10].EpisodeSeason, LatestEpisode.[1-10].EpisodeNumber, LatestEpisode.[1-10].Rating, LatestEpisode.[1-10].Plot, LatestEpisode.[1-10].Thumb, LatestEpisode.[1-10].ShowThumb, LatestEpisode.[1-10].SeasonThumb, LatestEpisode.[1-10].Fanart, LatestEpisode.[1-10].Path

LatestMusicVideo.[1-10].Title, LatestMusicVideo.[1-10].Thumb, LatestMusicVideo.[1-10].Year, LatestMusicVideo.[1-10].Plot, LatestMusicVideo.[1-10].RunningTime, LatestMusicVideo.[1-10].Path, LatestMusicVideo.[1-10].Artist, LatestMusicVideo.[1-10].Fanart

LatestSong.[1-10].Title, LatestSong.[1-10].Artist, LatestSong.[1-10].Album, LatestSong.[1-10].Year, LatestSong.[1-10].Rating, LatestSong.[1-10].Thumb, LatestSong.[1-10].Fanart, LatestSong.[1-10].Path

LatestAlbum.[1-10].Title, LatestAlbum.[1-10].Artist, LatestAlbum.[1-10].Year, LatestAlbum.[1-10].Rating, LatestAlbum.[1-10].Thumb, LatestAlbum.[1-10].Fanart, LatestAlbum.[1-10].Path
|
|-
| <code>Window(Weather).Property(key)</code>
| The weather window has the following info labels.
Location, Updated, Current.Condition, Current.Temperature, Current.FeelsLike, Current.UVIndex, Current.Wind (From <wind dir.> at <speed> <unit>), Current.WindSpeed, Current.WindDirection, Current.DewPoint, Current.Humidity, Day[0-6].Title, Day[0-6].HighTemp, Day[0-6].LowTemp, Day[0-6].Outlook, WeatherProvider

Data set in Current.Temperature, Current.FeelsLike, Day[0-6].HighTemp, Day[0-6].LowTemp should be provided in Celsius, and will be autoconverted according to System.TemperatureUnits
|
|}

=== Images Available in Kodi ===

See '''[[Artwork/Accessing with skins and JSON-RPC]]''' for the general pattern of accessing artwork for media items. Below is a list of other possible images available as InfoLabels.

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>ListItem.Art(type)</code>
| Artwork for the current listitem.
|
|-
| <code>Fanart.Image</code>
| Fanart image for the parent TV Show. Note: Deprecated, use ListItem.Art(tvshow.fanart) instead.
|
|-
| <code>ListItem.Thumb</code>
| Shows the thumbnail (if it exists) of the currently selected item in a list or thumb control. Note: Deprecated but still available, returns the same as ListItem.Art(thumb).
|
|-
| <code>ListItem.Icon</code>
| Shows the thumbnail (if it exists) of the currently selected item in a list or thumb control. If no thumbnail image exists, it will show the default icon.
|
|-
| <code>ListItem.ActualIcon</code>
| Shows the default icon of the currently selected item in a list or thumb control.
|
|-
| <code>ListItem.Overlay</code>
| Shows the Overlay Icon status (compressed file [OverlayRAR.png], watched [OverlayWatched.png], unwatched [OverlayUnwatched.png], locked [OverlayLocked.png]) of the currently selected item in a list or thumb control.
|
|-
| <code>ListItem.EPGEventIcon</code>
| Returns the icon of the EPG programme (if available).
| v18
|-
| <code>ListItem.Property(Fanart_Image)</code>
| Fanart Image currently selected item or of the parent TV show. Note: Deprecated, use ListItem.Art(fanart) or ListItem.Art(tvshow.fanart) instead.
|
|-
| <code>MusicPlayer.Cover</code>
| Cover of currently playing album
|
|-
| <code>MusicPlayer.Property(Fanart_Image)</code>
| Fanart image of the currently playing artist
|
|-
| <code>Player.Art(type)</code>
| Artwork for the currently playing item.
|
|-
| <code>Player.Icon</code>
| Shows the thumbnail (if it exists) of the currently playing item. If no thumbnail image exists, it will show the icon.
| v18
|-
| <code>Player.StarRating</code>
| Returns a value of 0 to 5 as a graphical display from images named rating0.png to rating5.png of the skin
|
|-
| <code>Pvr.NowRecordingChannelIcon</code>
| Channel icon of the programme currently being recorded.
|
|-
| <code>Pvr.NextRecordingChannelIcon</code>
| Channel icon of the programme that will be recorded next.
|
|-
| <code>Pvr.EPGEventIcon</code>
| Returns the icon of the currently playing EPG programme (if available).
| v18
|-
| <code>Skin.String(name)</code>
| Returns the image or image folder set by the user via a Skin.SetPath(name) or Skin.SetImage(name) '''[[List of Built In Functions]]'''. Allows skinners to have <span class="nobr">user-customisable</span> images and multiimages.
|
|-
| <code>System.AddonIcon(id)</code>
| Returns the Icon of the specified addon. Instead of specifying the id directly, one can also use an infolabel (e.g. $INFO[Skin.String(Foo)])
|
|-
| <code>System.ProfileThumb</code>
| Shows the Thumbnail image of the currently logged in Kodi user
|
|-
| <code>VideoPlayer.Cover</code>
| Cover of currently playing movie. Note: Deprecated, use Player.Art(type) instead.
|
|-
| <code>Weather.ConditionsIcon</code>
| Image of current weather conditions (NOTE: Can be used to load/refresh weather conditions)
|
|-
| <code>Window([window]).Property(key)</code>
| Window property. (key can be any value, optional window can be id or name)
|
|-
| <code>Window(Weather).Property(key)</code>
| The weather window has the following info images.
Current.ConditionIcon, Day[0-6].OutlookIcon, Current.FanartCode, Day[0-6].FanartCode, WeatherProviderLogo
|
|}

<section end="main content" />

{{top}}

[[Category:Skin development]]
[[Category:Add-on development]]

Action IDs

2024-12-04T07:09:14Z

CastagnaIT: add PreviousSubtitle, add missing CycleSubtitle

<section begin="Action IDs" />
;Main actions
{| class="prettytable sort sortable"
|-
! Action
! Description
|-
| <code>Left</code> || Move left off a control.
|-
| <code>Right</code> || Move right off a control.
|-
| <code>Up</code> || Move up off a control.
|-
| <code>Down</code> || Move down off a control.
|-
| <code>Select</code> || Select a button, or an item from a list of thumb view.
|-
| <code>Enter</code> || '''?''' (ACTION_ENTER) Not sure about all areas, but on some windows this will be the same as the "done" on screen button.
|-
| <code>PageUp</code> || Scroll up on page in a list, thumb, or text view.
|-
| <code>PageDown</code> || Scroll down on page in a list, thumb, or text view.
|-
| <code>Highlight</code> || Highlight an item in a list or thumb view.
|-
| <code>ParentDir</code> || Go up a folder to the parent folder. '''(deprecated, same meaning of "Back" action)'''
|-
| <code>ParentFolder</code> || Go up a folder to the parent folder.
|-
| <code>PreviousMenu</code> || Go back to the previous menu screen.
|-
| <code>Back</code> || Go back in navigation.
|-
| <code>Info</code> || Show the information about the currently highlighted item, or currently playing item.
|-
| <code>Pause</code> || Pause the currently playing item.
|-
| <code>Stop</code> || Stop the currently playing item.
|-
| <code>SkipNext</code> || Skip to next video in playlist. If no playlist, then skip to next chapter in video.
|-
| <code>SkipPrevious</code> || Skip to previous video in playlist. If no playlist, then skip to previous chapter in video.
|-
| <code>FullScreen</code> || Toggles full-screen content playback (either visualisation or video playback)
|-
| <code>togglefullscreen</code> || Changes whether the app is displayed full-screen or windowed (on windowing OSs)
|-
| <code>AspectRatio</code> || Toggle through the various aspect ratio modes (Normal is the preferred option).
|-
| <code>StepForward</code> || Step forward 30 seconds in a video.
|-
| <code>StepBack</code> || Step back 30 seconds in a video.
|-
| <code>BigStepForward</code> || Step forward 10 minutes in video.
|-
| <code>BigStepBack</code> || Step back 10 minutes in video.
|-
| <code>SmallStepBack</code> || Step back 7 seconds in the current video.
|-
| <code>Seek(''##'')</code> || A definable seek action, where <code>''##''</code> is a number of seconds. For example, to make a seek action that goes forward 25 seconds use <code>Seek(25)</code>, and to make a seek action that goes back 36 seconds use <code>Seek(-36)</code>. '''(v15 Isengard addition)'''
|-
| <code>ChapterOrBigStepForward</code> || Go to to next chapter in video. If no chapters, then step forward 10 minutes in video. '''(v13 Gotham addition)'''
|-
| <code>ChapterOrBigStepBack</code> || Go to previous chapter in video, If no chapters, then step back 10 minutes in video. '''(v13 Gotham addition)'''
|-
| <code>NextScene</code> || Go to next scene that is marked in an [[Edit_decision_list]] file.
|-
| <code>PreviousScene</code> || Go to previous scene that is marked in an [[Edit_decision_list]] file.
|-
| <code>OSD</code> || Toggles the OSD (On Screen Display) while playing an item.
|-
| <code>PlayDVD</code> || Start playing a DVD (goes to the DVD menu)
|-
| <code>ShowVideoMenu</code> || Go to the DVD Video menu when playing a DVD.
|-
| <code>ShowSubtitles</code> || Toggles whether subtitles are shown or not.
|-
| <code>NextSubtitle</code> || Change to the next subtitle language, if there is more than one (does not allow subtitles to be disabled).
|-
| <code>PreviousSubtitle</code> || Change to the previous subtitle language, if there is more than one (does not allow subtitles to be disabled). '''(v22 Piers addition)'''
|-
| <code>CycleSubtitle</code> || Change to the next subtitle language, if there is more than one (it also allow subtitles to be disabled).
|-
| <code>SubtitleShiftUp</code> || Move subtitles up
|-
| <code>SubtitleShiftDown</code> || Move subtitles down
|-
| <code>SubtitleAlign</code> || Subtitle position control
|-
| <code>CodecInfo</code> || Show codec information about the currently playing item (during video or visualisation playback)
|-
| <code>PlayerProcessInfo</code> || Show player process information about the currently playing item (during video or visualisation playback)
|-
| <code>PlayerProgramSelect</code> || Show dialog to select a program tv channel (during video playback)
|-
| <code>NextPicture</code> || Move to the next picture in a slideshow.
|-
| <code>PreviousPicture</code> || Move to the previous picture in a slideshow.
|-
| <code>ZoomOut</code> || Used in picture, slideshow or video fullscreen to zoom out of the current image/video.
|-
| <code>ZoomIn</code> || Used in picture, slideshow or video fullscreen to zoom in to the current image/video.
|-
| <code>IncreasePAR</code> || Used in video fullscreen to increase the pixel aspect ratio (stretch).
|-
| <code>DecreasePAR</code> || Used in video fullscreen to decrease the pixel aspect ratio (stretch).
|-
| <code>Queue</code> || Queue the item to the current playlist
|-
| <code>PlayNext</code> || Queue the item to the next position in the current playlist
|-
| <code>Filter</code> || Opens the mediafilter dialog in the video and musiclibrary. Used in the [[Advanced_library_filtering|advanced filter]] for the video library.
|-
| <code>Playlist</code> || Toggle to playlist view from My Music or My Videos
|-
| <code>ZoomNormal</code> || Normal (fullscreen) viewing in My Pictures
|-
| <code>ZoomLevel1</code> || Zoom to 120% in My Pictures
|-
| <code>ZoomLevel2</code> || Zoom to 150% in My Pictures
|-
| <code>ZoomLevel3</code> || Zoom to 200% in My Pictures
|-
| <code>ZoomLevel4</code> || Zoom to 280% in My Pictures
|-
| <code>ZoomLevel5</code> || Zoom to 400% in My Pictures
|-
| <code>ZoomLevel6</code> || Zoom to 600% in My Pictures
|-
| <code>ZoomLevel7</code> || Zoom to 900% in My Pictures
|-
| <code>ZoomLevel8</code> || Zoom to 1350% in My Pictures
|-
| <code>ZoomLevel9</code> || Zoom to 2000% in My Pictures
|-
| <code>NextCalibration</code> || Used in Video + GUI calibration
|-
| <code>ResetCalibration</code> || Used in Video + GUI calibration
|-
| <code>AnalogMove</code> || Move in the calibration screens, and while zoomed in My Pictures.
|-
| <code>Rotate</code> || Rotate a picture in My Pictures
|-
| <code>rotateccw</code> || Rotate current picture counterclockwise during slideshow.
|-
| <code>Close</code> || Used to close a dialog
|-
| <code>subtitledelay</code> || Show the current delay amount of subtitles.
|-
| <code>SubtitleDelayMinus</code> || Decrease the delay amount of subtitles (use if subtitles are displaying too late)
|-
| <code>SubtitleDelayPlus</code> || Increase the delay amount of subtitles (use if subtitles are displaying too early)
|-
| <code>audiodelay</code> || Show the current delay amount of audio.
|-
| <code>AudioDelayMinus</code> || Decrease the delay amount of audio (use if audio is being heard too early)
|-
| <code>AudioDelayPlus</code> || Increase the delay amount of audio (use if audio is being heard too late)
|-
| <code>AudioNextLanguage</code> || Change to the next audio track in a video with multiple audio tracks.
|-
| <code>NextResolution</code> || Used in Video calibration
|-
| <code>Number''<0-9>''</code> || Used to input the number 0 through 9
|-
| <code>FastForward</code> || Toggle the fastforward speed between normal play, 2x, 4x, 8x, 16x, and 32x.
|-
| <code>Rewind</code> || Toggle the rewind speed between normal play, 2x, 4x, 8x, 16x, and 32x.
|-
| <code>Play</code> || Play the selected item (or folder of items).
|-
| <code>PlayPause</code> || Play the selected item (or folder of items). Will also pause media when something is already playing.
|-
| <code>Delete</code> || Used in My Files to delete a file.
|-
| <code>Copy</code> || Used in My Files to copy a file.
|-
| <code>Move</code> || Used in My Files to move a file.
|-
| <code>Rename</code> || Used in My Files to rename a file.
|-
| <code>HideSubmenu</code> || <depreciated>
|-
| <code>Screenshot</code> || Take a screenshot of the current screen.
|-
| <code>Reboot</code> || Reboot
|-
| <code>ShutDown()</code> || Shutdown and power off
|-
| <code>VolumeUp</code> || Increase the volume of playback.
|-
| <code>VolumeDown</code> || Decrease the volume of playback.
|-
| <code>Mute</code> || Mute the volume.
|-
| <code>volampup</code> || Increase volume amplification.
|-
| <code>volampdown</code> || Decrease volume amplification.
|-
| <code>audiotoggledigital</code> || Switch between digital / analog audio.
|-
| <code>BackSpace</code> || Used in the virtual keyboards to delete one letter.
|-
| <code>ScrollUp</code> || Variable speed scroll up for analog keys (stick or triggers)
|-
| <code>ScrollDown</code> || Variable speed scroll down for analog keys (stick or triggers)
|-
| <code>AnalogFastForward</code> || Variable speed fast forward for analog keys (stick or triggers)
|-
| <code>AnalogRewind</code> || Variable speed rewind for analog keys (stick or triggers)
|-
| <code>AnalogSeekForward</code> || Variable speed seeking for analog keys (stick or triggers)
|-
| <code>AnalogSeekBack</code> || Variable speed seeking for analog keys (stick or triggers)
|-
| <code>MoveItemUp</code> || Used to rearrange playlists
|-
| <code>MoveItemDown</code> || Used to rearrange playlists
|-
| <code>Menu</code> || Focus the menu control (e.g. sidebar in confluence) which is specified by the skin in different windows (e.g. Movies, Music, PVR etc.) '''(v16 Jarvis addition)'''
|-
| <code>ContextMenu</code> || Pops up a contextual menu
|-
| <code>Shift</code> || Used in Virtual Keyboard to switch to upper or lower case letters
|-
| <code>Symbols</code> || Used in Virtual Keyboard to switch to or from symbols mode
|-
| <code>CursorLeft</code> || Used in Virtual Keyboard to move the current cursor point to the left
|-
| <code>CursorRight</code> || Used in Virtual Keyboard to move the current cursor point to the right
|-
| <code>ShowTime</code> || Used to show the current play time in music + video playback
|-
| <code>visualisationpresetlist</code> || Shows the visualisation preset list
|-
| <code>ShowPreset</code> || Shows the current visualisation preset (milkdrop/spectrum)
|-
| <code>NextPreset</code> || Next visualisation preset
|-
| <code>PreviousPreset</code> || Previous visualisation preset
|-
| <code>LockPreset</code> || Lock the current visualisation preset
|-
| <code>RandomPreset</code> || Switch to a new random preset
|-
| <code>IncreaseRating</code> || Used to increase track rating in full screen playback (press info on track and use pageplus on keyboard/remote
|-
| <code>DecreaseRating</code> || Used to decrease track rating in full screen playback (press info on track and use pageminus on keyboard/remote
|-
| <code>ToggleWatched</code> || Toggles watched/unwatched status for Videos
|-
| <code>NextLetter</code> || Move to the next letter in a list or thumb panel. Note that SHIFT-B on the keyboard will take you to the B's.
|-
| <code>PrevLetter</code> || Move to the previous letter in a list or thumb panel. Note that SHIFT-Z on the keyboard will take you to the Z's.
|-
| <code>JumpSMS''<2-9>''</code> || Jump through a list using SMS-style input (eg press 2 twice to jump to the B's.)
|-
| <code>FilterSMS''<2-9>''</code> || Filter a list in music or videos using SMS-style input.
|-
| <code>verticalshiftup</code> || Shift up video image currently played.
|-
| <code>verticalshiftdown</code> || Shift down video image currently played.
|-
| <code>scanitem</code> || Scan selected item for video or music files.
|-
| <code>reloadkeymaps</code> || Reload keymap, loading any changes made to the keymap since started up.
|-
| <code>increasevisrating</code> || Increase the preset rate for visualization.
|-
| <code>decreasevisrating</code> || Decrease the preset rate for visualization.
|-
| <code>firstpage</code> || Move to the first element of the page.
|-
| <code>lastpage</code> || Move to the last element of the page.
|-
| <code>guiprofile</code> || '''?''' (ACTION_GUIPROFILE_BEGIN)
|-
| <code>red</code> || Used to simulate red button click for the teletext.
|-
| <code>green</code> || Used to simulate green button click for the teletext.
|-
| <code>yellow</code> || Used to simulate yellow button click for the teletext.
|-
| <code>blue</code> || Used to simulate blue button click for the teletext.
|-
| <code>CreateBookmark</code> || Creates a bookmark of the currently playing Video '''(v13 Gotham addition)'''
|-
| <code>CreatEpisodeBookmark</code> || Creates an episode bookmark of the currently playing multi-episode file (e.g. S01E01E02). An episode bookmark specifies the end of the one and the begin of the other episode '''(v13 Gotham addition)'''
|-
| <code>NextChannelGroup</code> || [[PVR]] Goes to the next channel group when using live TV. Works only within PVR windows + channel osd. '''(v13 Gotham addition)'''
|-
| <code>PreviousChannelGroup</code> || [[PVR]] Goes to the previous channel group when using live TV. Works only within PVR windows + channel osd. '''(v13 Gotham addition)'''
|-
| <code>ChannelUp</code> || [[PVR]] Used to switch up to the next channel. Works only if you playback TV or radio '''(v13 Gotham addition)'''
|-
| <code>ChannelDown</code> || [[PVR]] Used to switch down to the previous channel. Works only if you playback TV or radio'''(v13 Gotham addition)'''
|-
| <code>PlayPvr</code> || [[PVR]] Starts playback a TV or radio channel depends on the last played channel. '''(v13 Gotham addition)'''
|-
| <code>PlayPvrTV</code> || [[PVR]] Starts playback a TV channel. Will playback the last played channel if available. '''(v13 Gotham addition)'''
|-
| <code>PlayPvrRadio</code> || [[PVR]] Starts playback a radio channel. Will playback the last played channel if available. '''(v13 Gotham addition)'''
|-
| <code>Record</code> || [[PVR]] record current playing channel or selected item in windows like EPG '''(v13 Gotham addition)'''
|-
| <code>ToggleCommSkip</code> || Enable / Disable commercial skipping (based on [[Edit_decision_list]] file) during video playback.
|-
| <code>StereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|-
| <code>ToggleStereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|-
| <code>SwitchPlayer</code> || Select player to use, such as internal (DVDPlayer/PAPlayer), UPnP "play using" targets, external players. '''(v13 Gotham addition)'''
|-
| <code>UpdateLibrary(video)</code> || Update Movie/TV-Show library (only tested with v13 Gotham addition).
|-
| <code>SetRating</code> || For use when playing music. Will pop-up a 1-10 userrating select dialog, to rate the currently playing song. '''(v17 Krypton addition)'''
|-
| <code>DialogSelectVideo</code> || Open a window dialog to select a video stream. '''(v22 Piers addition)'''
|-
| <code>DialogSelectAudio</code> || Open a window dialog to select an audio stream. '''(v22 Piers addition)'''
|-
| <code>DialogSelectSubtitle</code> || Open a window dialog to select a subtitle stream. '''(v22 Piers addition)'''
|-
|}

;Other
{| class="prettytable"
! Action
! Description
|-
| <code>noop</code> || No action. Used to specifically disable a key.
|}
<section end="Action IDs" />

== Removed action IDs ==
* <code>PresetList</code> - replaced with <code>visualisationpresetlist</code> in a previous version (unknown?)

== See also ==
* [[Keymaps]]
* [[Window IDs]]
* [[Built-in scripting]]

{{updated|21}}

[[Category:Remotes]]
[[Category:Skin development]]

Action IDs

2024-10-18T12:11:17Z

CastagnaIT: Add DialogSelectVideo,DialogSelectAudio,DialogSelectSubtitle

<section begin="Action IDs" />
;Main actions
{| class="prettytable sort sortable"
|-
! Action
! Description
|-
| <code>Left</code> || Move left off a control.
|-
| <code>Right</code> || Move right off a control.
|-
| <code>Up</code> || Move up off a control.
|-
| <code>Down</code> || Move down off a control.
|-
| <code>Select</code> || Select a button, or an item from a list of thumb view.
|-
| <code>Enter</code> || '''?''' (ACTION_ENTER) Not sure about all areas, but on some windows this will be the same as the "done" on screen button.
|-
| <code>PageUp</code> || Scroll up on page in a list, thumb, or text view.
|-
| <code>PageDown</code> || Scroll down on page in a list, thumb, or text view.
|-
| <code>Highlight</code> || Highlight an item in a list or thumb view.
|-
| <code>ParentDir</code> || Go up a folder to the parent folder. '''(deprecated, same meaning of "Back" action)'''
|-
| <code>ParentFolder</code> || Go up a folder to the parent folder.
|-
| <code>PreviousMenu</code> || Go back to the previous menu screen.
|-
| <code>Back</code> || Go back in navigation.
|-
| <code>Info</code> || Show the information about the currently highlighted item, or currently playing item.
|-
| <code>Pause</code> || Pause the currently playing item.
|-
| <code>Stop</code> || Stop the currently playing item.
|-
| <code>SkipNext</code> || Skip to next video in playlist. If no playlist, then skip to next chapter in video.
|-
| <code>SkipPrevious</code> || Skip to previous video in playlist. If no playlist, then skip to previous chapter in video.
|-
| <code>FullScreen</code> || Toggles full-screen content playback (either visualisation or video playback)
|-
| <code>togglefullscreen</code> || Changes whether the app is displayed full-screen or windowed (on windowing OSs)
|-
| <code>AspectRatio</code> || Toggle through the various aspect ratio modes (Normal is the preferred option).
|-
| <code>StepForward</code> || Step forward 30 seconds in a video.
|-
| <code>StepBack</code> || Step back 30 seconds in a video.
|-
| <code>BigStepForward</code> || Step forward 10 minutes in video.
|-
| <code>BigStepBack</code> || Step back 10 minutes in video.
|-
| <code>SmallStepBack</code> || Step back 7 seconds in the current video.
|-
| <code>Seek(''##'')</code> || A definable seek action, where <code>''##''</code> is a number of seconds. For example, to make a seek action that goes forward 25 seconds use <code>Seek(25)</code>, and to make a seek action that goes back 36 seconds use <code>Seek(-36)</code>. '''(v15 Isengard addition)'''
|-
| <code>ChapterOrBigStepForward</code> || Go to to next chapter in video. If no chapters, then step forward 10 minutes in video. '''(v13 Gotham addition)'''
|-
| <code>ChapterOrBigStepBack</code> || Go to previous chapter in video, If no chapters, then step back 10 minutes in video. '''(v13 Gotham addition)'''
|-
| <code>NextScene</code> || Go to next scene that is marked in an [[Edit_decision_list]] file.
|-
| <code>PreviousScene</code> || Go to previous scene that is marked in an [[Edit_decision_list]] file.
|-
| <code>OSD</code> || Toggles the OSD (On Screen Display) while playing an item.
|-
| <code>PlayDVD</code> || Start playing a DVD (goes to the DVD menu)
|-
| <code>ShowVideoMenu</code> || Go to the DVD Video menu when playing a DVD.
|-
| <code>ShowSubtitles</code> || Toggles whether subtitles are shown or not.
|-
| <code>NextSubtitle</code> || Change to the next subtitle language, if there is more than one.
|-
| <code>SubtitleShiftUp</code> || Move subtitles up
|-
| <code>SubtitleShiftDown</code> || Move subtitles down
|-
| <code>SubtitleAlign</code> || Subtitle position control
|-
| <code>CodecInfo</code> || Show codec information about the currently playing item (during video or visualisation playback)
|-
| <code>PlayerProcessInfo</code> || Show player process information about the currently playing item (during video or visualisation playback)
|-
| <code>PlayerProgramSelect</code> || Show dialog to select a program tv channel (during video playback)
|-
| <code>NextPicture</code> || Move to the next picture in a slideshow.
|-
| <code>PreviousPicture</code> || Move to the previous picture in a slideshow.
|-
| <code>ZoomOut</code> || Used in picture, slideshow or video fullscreen to zoom out of the current image/video.
|-
| <code>ZoomIn</code> || Used in picture, slideshow or video fullscreen to zoom in to the current image/video.
|-
| <code>IncreasePAR</code> || Used in video fullscreen to increase the pixel aspect ratio (stretch).
|-
| <code>DecreasePAR</code> || Used in video fullscreen to decrease the pixel aspect ratio (stretch).
|-
| <code>Queue</code> || Queue the item to the current playlist
|-
| <code>PlayNext</code> || Queue the item to the next position in the current playlist
|-
| <code>Filter</code> || Opens the mediafilter dialog in the video and musiclibrary. Used in the [[Advanced_library_filtering|advanced filter]] for the video library.
|-
| <code>Playlist</code> || Toggle to playlist view from My Music or My Videos
|-
| <code>ZoomNormal</code> || Normal (fullscreen) viewing in My Pictures
|-
| <code>ZoomLevel1</code> || Zoom to 120% in My Pictures
|-
| <code>ZoomLevel2</code> || Zoom to 150% in My Pictures
|-
| <code>ZoomLevel3</code> || Zoom to 200% in My Pictures
|-
| <code>ZoomLevel4</code> || Zoom to 280% in My Pictures
|-
| <code>ZoomLevel5</code> || Zoom to 400% in My Pictures
|-
| <code>ZoomLevel6</code> || Zoom to 600% in My Pictures
|-
| <code>ZoomLevel7</code> || Zoom to 900% in My Pictures
|-
| <code>ZoomLevel8</code> || Zoom to 1350% in My Pictures
|-
| <code>ZoomLevel9</code> || Zoom to 2000% in My Pictures
|-
| <code>NextCalibration</code> || Used in Video + GUI calibration
|-
| <code>ResetCalibration</code> || Used in Video + GUI calibration
|-
| <code>AnalogMove</code> || Move in the calibration screens, and while zoomed in My Pictures.
|-
| <code>Rotate</code> || Rotate a picture in My Pictures
|-
| <code>rotateccw</code> || Rotate current picture counterclockwise during slideshow.
|-
| <code>Close</code> || Used to close a dialog
|-
| <code>subtitledelay</code> || Show the current delay amount of subtitles.
|-
| <code>SubtitleDelayMinus</code> || Decrease the delay amount of subtitles (use if subtitles are displaying too late)
|-
| <code>SubtitleDelayPlus</code> || Increase the delay amount of subtitles (use if subtitles are displaying too early)
|-
| <code>audiodelay</code> || Show the current delay amount of audio.
|-
| <code>AudioDelayMinus</code> || Decrease the delay amount of audio (use if audio is being heard too early)
|-
| <code>AudioDelayPlus</code> || Increase the delay amount of audio (use if audio is being heard too late)
|-
| <code>AudioNextLanguage</code> || Change to the next audio track in a video with multiple audio tracks.
|-
| <code>NextResolution</code> || Used in Video calibration
|-
| <code>Number''<0-9>''</code> || Used to input the number 0 through 9
|-
| <code>FastForward</code> || Toggle the fastforward speed between normal play, 2x, 4x, 8x, 16x, and 32x.
|-
| <code>Rewind</code> || Toggle the rewind speed between normal play, 2x, 4x, 8x, 16x, and 32x.
|-
| <code>Play</code> || Play the selected item (or folder of items).
|-
| <code>PlayPause</code> || Play the selected item (or folder of items). Will also pause media when something is already playing.
|-
| <code>Delete</code> || Used in My Files to delete a file.
|-
| <code>Copy</code> || Used in My Files to copy a file.
|-
| <code>Move</code> || Used in My Files to move a file.
|-
| <code>Rename</code> || Used in My Files to rename a file.
|-
| <code>HideSubmenu</code> || <depreciated>
|-
| <code>Screenshot</code> || Take a screenshot of the current screen.
|-
| <code>Reboot</code> || Reboot
|-
| <code>ShutDown()</code> || Shutdown and power off
|-
| <code>VolumeUp</code> || Increase the volume of playback.
|-
| <code>VolumeDown</code> || Decrease the volume of playback.
|-
| <code>Mute</code> || Mute the volume.
|-
| <code>volampup</code> || Increase volume amplification.
|-
| <code>volampdown</code> || Decrease volume amplification.
|-
| <code>audiotoggledigital</code> || Switch between digital / analog audio.
|-
| <code>BackSpace</code> || Used in the virtual keyboards to delete one letter.
|-
| <code>ScrollUp</code> || Variable speed scroll up for analog keys (stick or triggers)
|-
| <code>ScrollDown</code> || Variable speed scroll down for analog keys (stick or triggers)
|-
| <code>AnalogFastForward</code> || Variable speed fast forward for analog keys (stick or triggers)
|-
| <code>AnalogRewind</code> || Variable speed rewind for analog keys (stick or triggers)
|-
| <code>AnalogSeekForward</code> || Variable speed seeking for analog keys (stick or triggers)
|-
| <code>AnalogSeekBack</code> || Variable speed seeking for analog keys (stick or triggers)
|-
| <code>MoveItemUp</code> || Used to rearrange playlists
|-
| <code>MoveItemDown</code> || Used to rearrange playlists
|-
| <code>Menu</code> || Focus the menu control (e.g. sidebar in confluence) which is specified by the skin in different windows (e.g. Movies, Music, PVR etc.) '''(v16 Jarvis addition)'''
|-
| <code>ContextMenu</code> || Pops up a contextual menu
|-
| <code>Shift</code> || Used in Virtual Keyboard to switch to upper or lower case letters
|-
| <code>Symbols</code> || Used in Virtual Keyboard to switch to or from symbols mode
|-
| <code>CursorLeft</code> || Used in Virtual Keyboard to move the current cursor point to the left
|-
| <code>CursorRight</code> || Used in Virtual Keyboard to move the current cursor point to the right
|-
| <code>ShowTime</code> || Used to show the current play time in music + video playback
|-
| <code>visualisationpresetlist</code> || Shows the visualisation preset list
|-
| <code>ShowPreset</code> || Shows the current visualisation preset (milkdrop/spectrum)
|-
| <code>NextPreset</code> || Next visualisation preset
|-
| <code>PreviousPreset</code> || Previous visualisation preset
|-
| <code>LockPreset</code> || Lock the current visualisation preset
|-
| <code>RandomPreset</code> || Switch to a new random preset
|-
| <code>IncreaseRating</code> || Used to increase track rating in full screen playback (press info on track and use pageplus on keyboard/remote
|-
| <code>DecreaseRating</code> || Used to decrease track rating in full screen playback (press info on track and use pageminus on keyboard/remote
|-
| <code>ToggleWatched</code> || Toggles watched/unwatched status for Videos
|-
| <code>NextLetter</code> || Move to the next letter in a list or thumb panel. Note that SHIFT-B on the keyboard will take you to the B's.
|-
| <code>PrevLetter</code> || Move to the previous letter in a list or thumb panel. Note that SHIFT-Z on the keyboard will take you to the Z's.
|-
| <code>JumpSMS''<2-9>''</code> || Jump through a list using SMS-style input (eg press 2 twice to jump to the B's.)
|-
| <code>FilterSMS''<2-9>''</code> || Filter a list in music or videos using SMS-style input.
|-
| <code>verticalshiftup</code> || Shift up video image currently played.
|-
| <code>verticalshiftdown</code> || Shift down video image currently played.
|-
| <code>scanitem</code> || Scan selected item for video or music files.
|-
| <code>reloadkeymaps</code> || Reload keymap, loading any changes made to the keymap since started up.
|-
| <code>increasevisrating</code> || Increase the preset rate for visualization.
|-
| <code>decreasevisrating</code> || Decrease the preset rate for visualization.
|-
| <code>firstpage</code> || Move to the first element of the page.
|-
| <code>lastpage</code> || Move to the last element of the page.
|-
| <code>guiprofile</code> || '''?''' (ACTION_GUIPROFILE_BEGIN)
|-
| <code>red</code> || Used to simulate red button click for the teletext.
|-
| <code>green</code> || Used to simulate green button click for the teletext.
|-
| <code>yellow</code> || Used to simulate yellow button click for the teletext.
|-
| <code>blue</code> || Used to simulate blue button click for the teletext.
|-
| <code>CreateBookmark</code> || Creates a bookmark of the currently playing Video '''(v13 Gotham addition)'''
|-
| <code>CreatEpisodeBookmark</code> || Creates an episode bookmark of the currently playing multi-episode file (e.g. S01E01E02). An episode bookmark specifies the end of the one and the begin of the other episode '''(v13 Gotham addition)'''
|-
| <code>NextChannelGroup</code> || [[PVR]] Goes to the next channel group when using live TV. Works only within PVR windows + channel osd. '''(v13 Gotham addition)'''
|-
| <code>PreviousChannelGroup</code> || [[PVR]] Goes to the previous channel group when using live TV. Works only within PVR windows + channel osd. '''(v13 Gotham addition)'''
|-
| <code>ChannelUp</code> || [[PVR]] Used to switch up to the next channel. Works only if you playback TV or radio '''(v13 Gotham addition)'''
|-
| <code>ChannelDown</code> || [[PVR]] Used to switch down to the previous channel. Works only if you playback TV or radio'''(v13 Gotham addition)'''
|-
| <code>PlayPvr</code> || [[PVR]] Starts playback a TV or radio channel depends on the last played channel. '''(v13 Gotham addition)'''
|-
| <code>PlayPvrTV</code> || [[PVR]] Starts playback a TV channel. Will playback the last played channel if available. '''(v13 Gotham addition)'''
|-
| <code>PlayPvrRadio</code> || [[PVR]] Starts playback a radio channel. Will playback the last played channel if available. '''(v13 Gotham addition)'''
|-
| <code>Record</code> || [[PVR]] record current playing channel or selected item in windows like EPG '''(v13 Gotham addition)'''
|-
| <code>ToggleCommSkip</code> || Enable / Disable commercial skipping (based on [[Edit_decision_list]] file) during video playback.
|-
| <code>StereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|-
| <code>ToggleStereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|-
| <code>SwitchPlayer</code> || Select player to use, such as internal (DVDPlayer/PAPlayer), UPnP "play using" targets, external players. '''(v13 Gotham addition)'''
|-
| <code>UpdateLibrary(video)</code> || Update Movie/TV-Show library (only tested with v13 Gotham addition).
|-
| <code>SetRating</code> || For use when playing music. Will pop-up a 1-10 userrating select dialog, to rate the currently playing song. '''(v17 Krypton addition)'''
|-
| <code>DialogSelectVideo</code> || Open a window dialog to select a video stream. '''(v22 Piers addition)'''
|-
| <code>DialogSelectAudio</code> || Open a window dialog to select an audio stream. '''(v22 Piers addition)'''
|-
| <code>DialogSelectSubtitle</code> || Open a window dialog to select a subtitle stream. '''(v22 Piers addition)'''
|-
|}

;Other
{| class="prettytable"
! Action
! Description
|-
| <code>noop</code> || No action. Used to specifically disable a key.
|}
<section end="Action IDs" />

== Removed action IDs ==
* <code>PresetList</code> - replaced with <code>visualisationpresetlist</code> in a previous version (unknown?)

== See also ==
* [[Keymaps]]
* [[Window IDs]]
* [[Built-in scripting]]

{{updated|21}}

[[Category:Remotes]]
[[Category:Skin development]]

Action IDs

2024-10-17T14:35:38Z

CastagnaIT: reworded text

<section begin="Action IDs" />
;Main actions
{| class="prettytable sort sortable"
|-
! Action
! Description
|-
| <code>Left</code> || Move left off a control.
|-
| <code>Right</code> || Move right off a control.
|-
| <code>Up</code> || Move up off a control.
|-
| <code>Down</code> || Move down off a control.
|-
| <code>Select</code> || Select a button, or an item from a list of thumb view.
|-
| <code>Enter</code> || '''?''' (ACTION_ENTER) Not sure about all areas, but on some windows this will be the same as the "done" on screen button.
|-
| <code>PageUp</code> || Scroll up on page in a list, thumb, or text view.
|-
| <code>PageDown</code> || Scroll down on page in a list, thumb, or text view.
|-
| <code>Highlight</code> || Highlight an item in a list or thumb view.
|-
| <code>ParentDir</code> || Go up a folder to the parent folder. '''(deprecated, same meaning of "Back" action)'''
|-
| <code>ParentFolder</code> || Go up a folder to the parent folder.
|-
| <code>PreviousMenu</code> || Go back to the previous menu screen.
|-
| <code>Back</code> || Go back in navigation.
|-
| <code>Info</code> || Show the information about the currently highlighted item, or currently playing item.
|-
| <code>Pause</code> || Pause the currently playing item.
|-
| <code>Stop</code> || Stop the currently playing item.
|-
| <code>SkipNext</code> || Skip to next video in playlist. If no playlist, then skip to next chapter in video.
|-
| <code>SkipPrevious</code> || Skip to previous video in playlist. If no playlist, then skip to previous chapter in video.
|-
| <code>FullScreen</code> || Toggles full-screen content playback (either visualisation or video playback)
|-
| <code>togglefullscreen</code> || Changes whether the app is displayed full-screen or windowed (on windowing OSs)
|-
| <code>AspectRatio</code> || Toggle through the various aspect ratio modes (Normal is the preferred option).
|-
| <code>StepForward</code> || Step forward 30 seconds in a video.
|-
| <code>StepBack</code> || Step back 30 seconds in a video.
|-
| <code>BigStepForward</code> || Step forward 10 minutes in video.
|-
| <code>BigStepBack</code> || Step back 10 minutes in video.
|-
| <code>SmallStepBack</code> || Step back 7 seconds in the current video.
|-
| <code>Seek(''##'')</code> || A definable seek action, where <code>''##''</code> is a number of seconds. For example, to make a seek action that goes forward 25 seconds use <code>Seek(25)</code>, and to make a seek action that goes back 36 seconds use <code>Seek(-36)</code>. '''(v15 Isengard addition)'''
|-
| <code>ChapterOrBigStepForward</code> || Go to to next chapter in video. If no chapters, then step forward 10 minutes in video. '''(v13 Gotham addition)'''
|-
| <code>ChapterOrBigStepBack</code> || Go to previous chapter in video, If no chapters, then step back 10 minutes in video. '''(v13 Gotham addition)'''
|-
| <code>NextScene</code> || Go to next scene that is marked in an [[Edit_decision_list]] file.
|-
| <code>PreviousScene</code> || Go to previous scene that is marked in an [[Edit_decision_list]] file.
|-
| <code>OSD</code> || Toggles the OSD (On Screen Display) while playing an item.
|-
| <code>PlayDVD</code> || Start playing a DVD (goes to the DVD menu)
|-
| <code>ShowVideoMenu</code> || Go to the DVD Video menu when playing a DVD.
|-
| <code>ShowSubtitles</code> || Toggles whether subtitles are shown or not.
|-
| <code>NextSubtitle</code> || Change to the next subtitle language, if there is more than one.
|-
| <code>SubtitleShiftUp</code> || Move subtitles up
|-
| <code>SubtitleShiftDown</code> || Move subtitles down
|-
| <code>SubtitleAlign</code> || Subtitle position control
|-
| <code>CodecInfo</code> || Show codec information about the currently playing item (during video or visualisation playback)
|-
| <code>PlayerProcessInfo</code> || Show player process information about the currently playing item (during video or visualisation playback)
|-
| <code>PlayerProgramSelect</code> || Show dialog to select a program tv channel (during video playback)
|-
| <code>NextPicture</code> || Move to the next picture in a slideshow.
|-
| <code>PreviousPicture</code> || Move to the previous picture in a slideshow.
|-
| <code>ZoomOut</code> || Used in picture, slideshow or video fullscreen to zoom out of the current image/video.
|-
| <code>ZoomIn</code> || Used in picture, slideshow or video fullscreen to zoom in to the current image/video.
|-
| <code>IncreasePAR</code> || Used in video fullscreen to increase the pixel aspect ratio (stretch).
|-
| <code>DecreasePAR</code> || Used in video fullscreen to decrease the pixel aspect ratio (stretch).
|-
| <code>Queue</code> || Queue the item to the current playlist
|-
| <code>PlayNext</code> || Queue the item to the next position in the current playlist
|-
| <code>Filter</code> || Opens the mediafilter dialog in the video and musiclibrary. Used in the [[Advanced_library_filtering|advanced filter]] for the video library.
|-
| <code>Playlist</code> || Toggle to playlist view from My Music or My Videos
|-
| <code>ZoomNormal</code> || Normal (fullscreen) viewing in My Pictures
|-
| <code>ZoomLevel1</code> || Zoom to 120% in My Pictures
|-
| <code>ZoomLevel2</code> || Zoom to 150% in My Pictures
|-
| <code>ZoomLevel3</code> || Zoom to 200% in My Pictures
|-
| <code>ZoomLevel4</code> || Zoom to 280% in My Pictures
|-
| <code>ZoomLevel5</code> || Zoom to 400% in My Pictures
|-
| <code>ZoomLevel6</code> || Zoom to 600% in My Pictures
|-
| <code>ZoomLevel7</code> || Zoom to 900% in My Pictures
|-
| <code>ZoomLevel8</code> || Zoom to 1350% in My Pictures
|-
| <code>ZoomLevel9</code> || Zoom to 2000% in My Pictures
|-
| <code>NextCalibration</code> || Used in Video + GUI calibration
|-
| <code>ResetCalibration</code> || Used in Video + GUI calibration
|-
| <code>AnalogMove</code> || Move in the calibration screens, and while zoomed in My Pictures.
|-
| <code>Rotate</code> || Rotate a picture in My Pictures
|-
| <code>rotateccw</code> || Rotate current picture counterclockwise during slideshow.
|-
| <code>Close</code> || Used to close a dialog
|-
| <code>subtitledelay</code> || Show the current delay amount of subtitles.
|-
| <code>SubtitleDelayMinus</code> || Decrease the delay amount of subtitles (use if subtitles are displaying too late)
|-
| <code>SubtitleDelayPlus</code> || Increase the delay amount of subtitles (use if subtitles are displaying too early)
|-
| <code>audiodelay</code> || Show the current delay amount of audio.
|-
| <code>AudioDelayMinus</code> || Decrease the delay amount of audio (use if audio is being heard too early)
|-
| <code>AudioDelayPlus</code> || Increase the delay amount of audio (use if audio is being heard too late)
|-
| <code>AudioNextLanguage</code> || Change to the next audio track in a video with multiple audio tracks.
|-
| <code>NextResolution</code> || Used in Video calibration
|-
| <code>Number''<0-9>''</code> || Used to input the number 0 through 9
|-
| <code>FastForward</code> || Toggle the fastforward speed between normal play, 2x, 4x, 8x, 16x, and 32x.
|-
| <code>Rewind</code> || Toggle the rewind speed between normal play, 2x, 4x, 8x, 16x, and 32x.
|-
| <code>Play</code> || Play the selected item (or folder of items).
|-
| <code>PlayPause</code> || Play the selected item (or folder of items). Will also pause media when something is already playing.
|-
| <code>Delete</code> || Used in My Files to delete a file.
|-
| <code>Copy</code> || Used in My Files to copy a file.
|-
| <code>Move</code> || Used in My Files to move a file.
|-
| <code>Rename</code> || Used in My Files to rename a file.
|-
| <code>HideSubmenu</code> || <depreciated>
|-
| <code>Screenshot</code> || Take a screenshot of the current screen.
|-
| <code>Reboot</code> || Reboot
|-
| <code>ShutDown()</code> || Shutdown and power off
|-
| <code>VolumeUp</code> || Increase the volume of playback.
|-
| <code>VolumeDown</code> || Decrease the volume of playback.
|-
| <code>Mute</code> || Mute the volume.
|-
| <code>volampup</code> || Increase volume amplification.
|-
| <code>volampdown</code> || Decrease volume amplification.
|-
| <code>audiotoggledigital</code> || Switch between digital / analog audio.
|-
| <code>BackSpace</code> || Used in the virtual keyboards to delete one letter.
|-
| <code>ScrollUp</code> || Variable speed scroll up for analog keys (stick or triggers)
|-
| <code>ScrollDown</code> || Variable speed scroll down for analog keys (stick or triggers)
|-
| <code>AnalogFastForward</code> || Variable speed fast forward for analog keys (stick or triggers)
|-
| <code>AnalogRewind</code> || Variable speed rewind for analog keys (stick or triggers)
|-
| <code>AnalogSeekForward</code> || Variable speed seeking for analog keys (stick or triggers)
|-
| <code>AnalogSeekBack</code> || Variable speed seeking for analog keys (stick or triggers)
|-
| <code>MoveItemUp</code> || Used to rearrange playlists
|-
| <code>MoveItemDown</code> || Used to rearrange playlists
|-
| <code>Menu</code> || Focus the menu control (e.g. sidebar in confluence) which is specified by the skin in different windows (e.g. Movies, Music, PVR etc.) '''(v16 Jarvis addition)'''
|-
| <code>ContextMenu</code> || Pops up a contextual menu
|-
| <code>Shift</code> || Used in Virtual Keyboard to switch to upper or lower case letters
|-
| <code>Symbols</code> || Used in Virtual Keyboard to switch to or from symbols mode
|-
| <code>CursorLeft</code> || Used in Virtual Keyboard to move the current cursor point to the left
|-
| <code>CursorRight</code> || Used in Virtual Keyboard to move the current cursor point to the right
|-
| <code>ShowTime</code> || Used to show the current play time in music + video playback
|-
| <code>visualisationpresetlist</code> || Shows the visualisation preset list
|-
| <code>ShowPreset</code> || Shows the current visualisation preset (milkdrop/spectrum)
|-
| <code>NextPreset</code> || Next visualisation preset
|-
| <code>PreviousPreset</code> || Previous visualisation preset
|-
| <code>LockPreset</code> || Lock the current visualisation preset
|-
| <code>RandomPreset</code> || Switch to a new random preset
|-
| <code>IncreaseRating</code> || Used to increase track rating in full screen playback (press info on track and use pageplus on keyboard/remote
|-
| <code>DecreaseRating</code> || Used to decrease track rating in full screen playback (press info on track and use pageminus on keyboard/remote
|-
| <code>ToggleWatched</code> || Toggles watched/unwatched status for Videos
|-
| <code>NextLetter</code> || Move to the next letter in a list or thumb panel. Note that SHIFT-B on the keyboard will take you to the B's.
|-
| <code>PrevLetter</code> || Move to the previous letter in a list or thumb panel. Note that SHIFT-Z on the keyboard will take you to the Z's.
|-
| <code>JumpSMS''<2-9>''</code> || Jump through a list using SMS-style input (eg press 2 twice to jump to the B's.)
|-
| <code>FilterSMS''<2-9>''</code> || Filter a list in music or videos using SMS-style input.
|-
| <code>verticalshiftup</code> || Shift up video image currently played.
|-
| <code>verticalshiftdown</code> || Shift down video image currently played.
|-
| <code>scanitem</code> || Scan selected item for video or music files.
|-
| <code>reloadkeymaps</code> || Reload keymap, loading any changes made to the keymap since started up.
|-
| <code>increasevisrating</code> || Increase the preset rate for visualization.
|-
| <code>decreasevisrating</code> || Decrease the preset rate for visualization.
|-
| <code>firstpage</code> || Move to the first element of the page.
|-
| <code>lastpage</code> || Move to the last element of the page.
|-
| <code>guiprofile</code> || '''?''' (ACTION_GUIPROFILE_BEGIN)
|-
| <code>red</code> || Used to simulate red button click for the teletext.
|-
| <code>green</code> || Used to simulate green button click for the teletext.
|-
| <code>yellow</code> || Used to simulate yellow button click for the teletext.
|-
| <code>blue</code> || Used to simulate blue button click for the teletext.
|-
| <code>CreateBookmark</code> || Creates a bookmark of the currently playing Video '''(v13 Gotham addition)'''
|-
| <code>CreatEpisodeBookmark</code> || Creates an episode bookmark of the currently playing multi-episode file (e.g. S01E01E02). An episode bookmark specifies the end of the one and the begin of the other episode '''(v13 Gotham addition)'''
|-
| <code>NextChannelGroup</code> || [[PVR]] Goes to the next channel group when using live TV. Works only within PVR windows + channel osd. '''(v13 Gotham addition)'''
|-
| <code>PreviousChannelGroup</code> || [[PVR]] Goes to the previous channel group when using live TV. Works only within PVR windows + channel osd. '''(v13 Gotham addition)'''
|-
| <code>ChannelUp</code> || [[PVR]] Used to switch up to the next channel. Works only if you playback TV or radio '''(v13 Gotham addition)'''
|-
| <code>ChannelDown</code> || [[PVR]] Used to switch down to the previous channel. Works only if you playback TV or radio'''(v13 Gotham addition)'''
|-
| <code>PlayPvr</code> || [[PVR]] Starts playback a TV or radio channel depends on the last played channel. '''(v13 Gotham addition)'''
|-
| <code>PlayPvrTV</code> || [[PVR]] Starts playback a TV channel. Will playback the last played channel if available. '''(v13 Gotham addition)'''
|-
| <code>PlayPvrRadio</code> || [[PVR]] Starts playback a radio channel. Will playback the last played channel if available. '''(v13 Gotham addition)'''
|-
| <code>Record</code> || [[PVR]] record current playing channel or selected item in windows like EPG '''(v13 Gotham addition)'''
|-
| <code>ToggleCommSkip</code> || Enable / Disable commercial skipping (based on [[Edit_decision_list]] file) during video playback.
|-
| <code>StereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|-
| <code>ToggleStereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|-
| <code>SwitchPlayer</code> || Select player to use, such as internal (DVDPlayer/PAPlayer), UPnP "play using" targets, external players. '''(v13 Gotham addition)'''
|-
| <code>UpdateLibrary(video)</code> || Update Movie/TV-Show library (only tested with v13 Gotham addition).
|-
| <code>SetRating</code> || For use when playing music. Will pop-up a 1-10 userrating select dialog, to rate the currently playing song. '''(v17 Krypton addition)'''
|-
|}

;Other
{| class="prettytable"
! Action
! Description
|-
| <code>noop</code> || No action. Used to specifically disable a key.
|}
<section end="Action IDs" />

== Removed action IDs ==
* <code>PresetList</code> - replaced with <code>visualisationpresetlist</code> in a previous version (unknown?)

== See also ==
* [[Keymaps]]
* [[Window IDs]]
* [[Built-in scripting]]

{{updated|21}}

[[Category:Remotes]]
[[Category:Skin development]]

Action IDs

2024-10-17T14:28:48Z

CastagnaIT: Updated for v21

<section begin="Action IDs" />
;Main actions
{| class="prettytable sort sortable"
|-
! Action
! Description
|-
| <code>Left</code> || Move left off a control.
|-
| <code>Right</code> || Move right off a control.
|-
| <code>Up</code> || Move up off a control.
|-
| <code>Down</code> || Move down off a control.
|-
| <code>Select</code> || Select a button, or an item from a list of thumb view.
|-
| <code>Enter</code> || '''?''' (ACTION_ENTER) Not sure about all areas, but on some windows this will be the same as the "done" on screen button.
|-
| <code>PageUp</code> || Scroll up on page in a list, thumb, or text view.
|-
| <code>PageDown</code> || Scroll down on page in a list, thumb, or text view.
|-
| <code>Highlight</code> || Highlight an item in a list or thumb view.
|-
| <code>ParentDir</code> || Go up a folder to the parent folder. '''(deprecated, same meaning of "Back" code)'''
|-
| <code>ParentFolder</code> || Go up a folder to the parent folder.
|-
| <code>PreviousMenu</code> || Go back to the previous menu screen.
|-
| <code>Back</code> || Go back in navigation.
|-
| <code>Info</code> || Show the information about the currently highlighted item, or currently playing item.
|-
| <code>Pause</code> || Pause the currently playing item.
|-
| <code>Stop</code> || Stop the currently playing item.
|-
| <code>SkipNext</code> || Skip to next video in playlist. If no playlist, then skip to next chapter in video.
|-
| <code>SkipPrevious</code> || Skip to previous video in playlist. If no playlist, then skip to previous chapter in video.
|-
| <code>FullScreen</code> || Toggles full-screen content playback (either visualisation or video playback)
|-
| <code>togglefullscreen</code> || Changes whether the app is displayed full-screen or windowed (on windowing OSs)
|-
| <code>AspectRatio</code> || Toggle through the various aspect ratio modes (Normal is the preferred option).
|-
| <code>StepForward</code> || Step forward 30 seconds in a video.
|-
| <code>StepBack</code> || Step back 30 seconds in a video.
|-
| <code>BigStepForward</code> || Step forward 10 minutes in video.
|-
| <code>BigStepBack</code> || Step back 10 minutes in video.
|-
| <code>SmallStepBack</code> || Step back 7 seconds in the current video.
|-
| <code>Seek(''##'')</code> || A definable seek action, where <code>''##''</code> is a number of seconds. For example, to make a seek action that goes forward 25 seconds use <code>Seek(25)</code>, and to make a seek action that goes back 36 seconds use <code>Seek(-36)</code>. '''(v15 Isengard addition)'''
|-
| <code>ChapterOrBigStepForward</code> || Go to to next chapter in video. If no chapters, then step forward 10 minutes in video. '''(v13 Gotham addition)'''
|-
| <code>ChapterOrBigStepBack</code> || Go to previous chapter in video, If no chapters, then step back 10 minutes in video. '''(v13 Gotham addition)'''
|-
| <code>NextScene</code> || Go to next scene that is marked in an [[Edit_decision_list]] file.
|-
| <code>PreviousScene</code> || Go to previous scene that is marked in an [[Edit_decision_list]] file.
|-
| <code>OSD</code> || Toggles the OSD (On Screen Display) while playing an item.
|-
| <code>PlayDVD</code> || Start playing a DVD (goes to the DVD menu)
|-
| <code>ShowVideoMenu</code> || Go to the DVD Video menu when playing a DVD.
|-
| <code>ShowSubtitles</code> || Toggles whether subtitles are shown or not.
|-
| <code>NextSubtitle</code> || Change to the next subtitle language, if there is more than one.
|-
| <code>SubtitleShiftUp</code> || Move subtitles up
|-
| <code>SubtitleShiftDown</code> || Move subtitles down
|-
| <code>SubtitleAlign</code> || Subtitle position control
|-
| <code>CodecInfo</code> || Show codec information about the currently playing item (during video or visualisation playback)
|-
| <code>PlayerProcessInfo</code> || Show player process information about the currently playing item (during video or visualisation playback)
|-
| <code>PlayerProgramSelect</code> || Show dialog to select a program tv channel (during video playback)
|-
| <code>NextPicture</code> || Move to the next picture in a slideshow.
|-
| <code>PreviousPicture</code> || Move to the previous picture in a slideshow.
|-
| <code>ZoomOut</code> || Used in picture, slideshow or video fullscreen to zoom out of the current image/video.
|-
| <code>ZoomIn</code> || Used in picture, slideshow or video fullscreen to zoom in to the current image/video.
|-
| <code>IncreasePAR</code> || Used in video fullscreen to increase the pixel aspect ratio (stretch).
|-
| <code>DecreasePAR</code> || Used in video fullscreen to decrease the pixel aspect ratio (stretch).
|-
| <code>Queue</code> || Queue the item to the current playlist
|-
| <code>PlayNext</code> || Queue the item to the next position in the current playlist
|-
| <code>Filter</code> || Opens the mediafilter dialog in the video and musiclibrary. Used in the [[Advanced_library_filtering|advanced filter]] for the video library.
|-
| <code>Playlist</code> || Toggle to playlist view from My Music or My Videos
|-
| <code>ZoomNormal</code> || Normal (fullscreen) viewing in My Pictures
|-
| <code>ZoomLevel1</code> || Zoom to 120% in My Pictures
|-
| <code>ZoomLevel2</code> || Zoom to 150% in My Pictures
|-
| <code>ZoomLevel3</code> || Zoom to 200% in My Pictures
|-
| <code>ZoomLevel4</code> || Zoom to 280% in My Pictures
|-
| <code>ZoomLevel5</code> || Zoom to 400% in My Pictures
|-
| <code>ZoomLevel6</code> || Zoom to 600% in My Pictures
|-
| <code>ZoomLevel7</code> || Zoom to 900% in My Pictures
|-
| <code>ZoomLevel8</code> || Zoom to 1350% in My Pictures
|-
| <code>ZoomLevel9</code> || Zoom to 2000% in My Pictures
|-
| <code>NextCalibration</code> || Used in Video + GUI calibration
|-
| <code>ResetCalibration</code> || Used in Video + GUI calibration
|-
| <code>AnalogMove</code> || Move in the calibration screens, and while zoomed in My Pictures.
|-
| <code>Rotate</code> || Rotate a picture in My Pictures
|-
| <code>rotateccw</code> || Rotate current picture counterclockwise during slideshow.
|-
| <code>Close</code> || Used to close a dialog
|-
| <code>subtitledelay</code> || Show the current delay amount of subtitles.
|-
| <code>SubtitleDelayMinus</code> || Decrease the delay amount of subtitles (use if subtitles are displaying too late)
|-
| <code>SubtitleDelayPlus</code> || Increase the delay amount of subtitles (use if subtitles are displaying too early)
|-
| <code>audiodelay</code> || Show the current delay amount of audio.
|-
| <code>AudioDelayMinus</code> || Decrease the delay amount of audio (use if audio is being heard too early)
|-
| <code>AudioDelayPlus</code> || Increase the delay amount of audio (use if audio is being heard too late)
|-
| <code>AudioNextLanguage</code> || Change to the next audio track in a video with multiple audio tracks.
|-
| <code>NextResolution</code> || Used in Video calibration
|-
| <code>Number''<0-9>''</code> || Used to input the number 0 through 9
|-
| <code>FastForward</code> || Toggle the fastforward speed between normal play, 2x, 4x, 8x, 16x, and 32x.
|-
| <code>Rewind</code> || Toggle the rewind speed between normal play, 2x, 4x, 8x, 16x, and 32x.
|-
| <code>Play</code> || Play the selected item (or folder of items).
|-
| <code>PlayPause</code> || Play the selected item (or folder of items). Will also pause media when something is already playing.
|-
| <code>Delete</code> || Used in My Files to delete a file.
|-
| <code>Copy</code> || Used in My Files to copy a file.
|-
| <code>Move</code> || Used in My Files to move a file.
|-
| <code>Rename</code> || Used in My Files to rename a file.
|-
| <code>HideSubmenu</code> || <depreciated>
|-
| <code>Screenshot</code> || Take a screenshot of the current screen.
|-
| <code>Reboot</code> || Reboot
|-
| <code>ShutDown()</code> || Shutdown and power off
|-
| <code>VolumeUp</code> || Increase the volume of playback.
|-
| <code>VolumeDown</code> || Decrease the volume of playback.
|-
| <code>Mute</code> || Mute the volume.
|-
| <code>volampup</code> || Increase volume amplification.
|-
| <code>volampdown</code> || Decrease volume amplification.
|-
| <code>audiotoggledigital</code> || Switch between digital / analog audio.
|-
| <code>BackSpace</code> || Used in the virtual keyboards to delete one letter.
|-
| <code>ScrollUp</code> || Variable speed scroll up for analog keys (stick or triggers)
|-
| <code>ScrollDown</code> || Variable speed scroll down for analog keys (stick or triggers)
|-
| <code>AnalogFastForward</code> || Variable speed fast forward for analog keys (stick or triggers)
|-
| <code>AnalogRewind</code> || Variable speed rewind for analog keys (stick or triggers)
|-
| <code>AnalogSeekForward</code> || Variable speed seeking for analog keys (stick or triggers)
|-
| <code>AnalogSeekBack</code> || Variable speed seeking for analog keys (stick or triggers)
|-
| <code>MoveItemUp</code> || Used to rearrange playlists
|-
| <code>MoveItemDown</code> || Used to rearrange playlists
|-
| <code>Menu</code> || Focus the menu control (e.g. sidebar in confluence) which is specified by the skin in different windows (e.g. Movies, Music, PVR etc.) '''(v16 Jarvis addition)'''
|-
| <code>ContextMenu</code> || Pops up a contextual menu
|-
| <code>Shift</code> || Used in Virtual Keyboard to switch to upper or lower case letters
|-
| <code>Symbols</code> || Used in Virtual Keyboard to switch to or from symbols mode
|-
| <code>CursorLeft</code> || Used in Virtual Keyboard to move the current cursor point to the left
|-
| <code>CursorRight</code> || Used in Virtual Keyboard to move the current cursor point to the right
|-
| <code>ShowTime</code> || Used to show the current play time in music + video playback
|-
| <code>visualisationpresetlist</code> || Shows the visualisation preset list
|-
| <code>ShowPreset</code> || Shows the current visualisation preset (milkdrop/spectrum)
|-
| <code>NextPreset</code> || Next visualisation preset
|-
| <code>PreviousPreset</code> || Previous visualisation preset
|-
| <code>LockPreset</code> || Lock the current visualisation preset
|-
| <code>RandomPreset</code> || Switch to a new random preset
|-
| <code>IncreaseRating</code> || Used to increase track rating in full screen playback (press info on track and use pageplus on keyboard/remote
|-
| <code>DecreaseRating</code> || Used to decrease track rating in full screen playback (press info on track and use pageminus on keyboard/remote
|-
| <code>ToggleWatched</code> || Toggles watched/unwatched status for Videos
|-
| <code>NextLetter</code> || Move to the next letter in a list or thumb panel. Note that SHIFT-B on the keyboard will take you to the B's.
|-
| <code>PrevLetter</code> || Move to the previous letter in a list or thumb panel. Note that SHIFT-Z on the keyboard will take you to the Z's.
|-
| <code>JumpSMS''<2-9>''</code> || Jump through a list using SMS-style input (eg press 2 twice to jump to the B's.)
|-
| <code>FilterSMS''<2-9>''</code> || Filter a list in music or videos using SMS-style input.
|-
| <code>verticalshiftup</code> || Shift up video image currently played.
|-
| <code>verticalshiftdown</code> || Shift down video image currently played.
|-
| <code>scanitem</code> || Scan selected item for video or music files.
|-
| <code>reloadkeymaps</code> || Reload keymap, loading any changes made to the keymap since started up.
|-
| <code>increasevisrating</code> || Increase the preset rate for visualization.
|-
| <code>decreasevisrating</code> || Decrease the preset rate for visualization.
|-
| <code>firstpage</code> || Move to the first element of the page.
|-
| <code>lastpage</code> || Move to the last element of the page.
|-
| <code>guiprofile</code> || '''?''' (ACTION_GUIPROFILE_BEGIN)
|-
| <code>red</code> || Used to simulate red button click for the teletext.
|-
| <code>green</code> || Used to simulate green button click for the teletext.
|-
| <code>yellow</code> || Used to simulate yellow button click for the teletext.
|-
| <code>blue</code> || Used to simulate blue button click for the teletext.
|-
| <code>CreateBookmark</code> || Creates a bookmark of the currently playing Video '''(v13 Gotham addition)'''
|-
| <code>CreatEpisodeBookmark</code> || Creates an episode bookmark of the currently playing multi-episode file (e.g. S01E01E02). An episode bookmark specifies the end of the one and the begin of the other episode '''(v13 Gotham addition)'''
|-
| <code>NextChannelGroup</code> || [[PVR]] Goes to the next channel group when using live TV. Works only within PVR windows + channel osd. '''(v13 Gotham addition)'''
|-
| <code>PreviousChannelGroup</code> || [[PVR]] Goes to the previous channel group when using live TV. Works only within PVR windows + channel osd. '''(v13 Gotham addition)'''
|-
| <code>ChannelUp</code> || [[PVR]] Used to switch up to the next channel. Works only if you playback TV or radio '''(v13 Gotham addition)'''
|-
| <code>ChannelDown</code> || [[PVR]] Used to switch down to the previous channel. Works only if you playback TV or radio'''(v13 Gotham addition)'''
|-
| <code>PlayPvr</code> || [[PVR]] Starts playback a TV or radio channel depends on the last played channel. '''(v13 Gotham addition)'''
|-
| <code>PlayPvrTV</code> || [[PVR]] Starts playback a TV channel. Will playback the last played channel if available. '''(v13 Gotham addition)'''
|-
| <code>PlayPvrRadio</code> || [[PVR]] Starts playback a radio channel. Will playback the last played channel if available. '''(v13 Gotham addition)'''
|-
| <code>Record</code> || [[PVR]] record current playing channel or selected item in windows like EPG '''(v13 Gotham addition)'''
|-
| <code>ToggleCommSkip</code> || Enable / Disable commercial skipping (based on [[Edit_decision_list]] file) during video playback.
|-
| <code>StereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|-
| <code>ToggleStereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|-
| <code>SwitchPlayer</code> || Select player to use, such as internal (DVDPlayer/PAPlayer), UPnP "play using" targets, external players. '''(v13 Gotham addition)'''
|-
| <code>UpdateLibrary(video)</code> || Update Movie/TV-Show library (only tested with v13 Gotham addition).
|-
| <code>SetRating</code> || For use when playing music. Will pop-up a 1-10 userrating select dialog, to rate the currently playing song. '''(v17 Krypton addition)'''
|-
|}

;Other
{| class="prettytable"
! Action
! Description
|-
| <code>noop</code> || No action. Used to specifically disable a key.
|}
<section end="Action IDs" />

== Removed action IDs ==
* <code>PresetList</code> - replaced with <code>visualisationpresetlist</code> in a previous version (unknown?)

== See also ==
* [[Keymaps]]
* [[Window IDs]]
* [[Built-in scripting]]

{{updated|21}}

[[Category:Remotes]]
[[Category:Skin development]]

Action IDs

2024-10-17T09:35:00Z

CastagnaIT: Add link to EDL

<section begin="Action IDs" />
;Main actions
{| class="prettytable sort sortable"
|-
! Action
! Description
|-
| <code>Left</code> || Move left off a control.
|-
| <code>Right</code> || Move right off a control.
|-
| <code>Up</code> || Move up off a control.
|-
| <code>Down</code> || Move down off a control.
|-
| <code>Select</code> || Select a button, or an item from a list of thumb view.
|-
| <code>Enter</code> || '''?''' (ACTION_ENTER) Not sure about all areas, but on some windows this will be the same as the "done" on screen button.
|-
| <code>PageUp</code> || Scroll up on page in a list, thumb, or text view.
|-
| <code>PageDown</code> || Scroll down on page in a list, thumb, or text view.
|-
| <code>Highlight</code> || Highlight an item in a list or thumb view.
|-
| <code>ParentDir</code> || Go up a folder to the parent folder. '''(deprecated, same meaning of "Back" code)'''
|-
| <code>ParentFolder</code> || Go up a folder to the parent folder.
|-
| <code>PreviousMenu</code> || Go back to the previous menu screen.
|-
| <code>Back</code> || Go back in navigation.
|-
| <code>Info</code> || Show the information about the currently highlighted item, or currently playing item.
|-
| <code>Pause</code> || Pause the currently playing item.
|-
| <code>Stop</code> || Stop the currently playing item.
|-
| <code>SkipNext</code> || Skip to next video in playlist. If no playlist, then skip to next chapter in video.
|-
| <code>SkipPrevious</code> || Skip to previous video in playlist. If no playlist, then skip to previous chapter in video.
|-
| <code>FullScreen</code> || Toggles full-screen content playback (either visualisation or video playback)
|-
| <code>togglefullscreen</code> || Changes whether the app is displayed full-screen or windowed (on windowing OSs)
|-
| <code>AspectRatio</code> || Toggle through the various aspect ratio modes (Normal is the preferred option).
|-
| <code>StepForward</code> || Step forward 30 seconds in a video.
|-
| <code>StepBack</code> || Step back 30 seconds in a video.
|-
| <code>BigStepForward</code> || Step forward 10 minutes in video.
|-
| <code>BigStepBack</code> || Step back 10 minutes in video.
|-
| <code>SmallStepBack</code> || Step back 7 seconds in the current video.
|-
| <code>Seek(''##'')</code> || A definable seek action, where <code>''##''</code> is a number of seconds. For example, to make a seek action that goes forward 25 seconds use <code>Seek(25)</code>, and to make a seek action that goes back 36 seconds use <code>Seek(-36)</code>. '''(v15 Isengard addition)'''
|-
| <code>ChapterOrBigStepForward</code> || Go to to next chapter in video. If no chapters, then step forward 10 minutes in video. '''(v13 Gotham addition)'''
|-
| <code>ChapterOrBigStepBack</code> || Go to previous chapter in video, If no chapters, then step back 10 minutes in video. '''(v13 Gotham addition)'''
|-
| <code>NextScene</code> || Go to next scene that is marked in an [[Edit_decision_list]] file.
|-
| <code>PreviousScene</code> || Go to previous scene that is marked in an [[Edit_decision_list]] file.
|-
| <code>OSD</code> || Toggles the OSD (On Screen Display) while playing an item.
|-
| <code>PlayDVD</code> || Start playing a DVD (goes to the DVD menu)
|-
| <code>ShowVideoMenu</code> || Go to the DVD Video menu when playing a DVD.
|-
| <code>ShowSubtitles</code> || Toggles whether subtitles are shown or not.
|-
| <code>NextSubtitle</code> || Change to the next subtitle language, if there is more than one.
|-
| <code>SubtitleShiftUp</code> || Move subtitles up
|-
| <code>SubtitleShiftDown</code> || Move subtitles down
|-
| <code>SubtitleAlign</code> || Subtitle position control
|-
| <code>CodecInfo</code> || Show codec information about the currently playing item (during video or visualisation playback)
|-
| <code>PlayerProcessInfo</code> || Show player process information about the currently playing item (during video or visualisation playback)
|-
| <code>PlayerProgramSelect</code> || Show dialog to select a program tv channel (during video playback)
|-
| <code>NextPicture</code> || Move to the next picture in a slideshow.
|-
| <code>PreviousPicture</code> || Move to the previous picture in a slideshow.
|-
| <code>ZoomOut</code> || Used in picture, slideshow or video fullscreen to zoom out of the current image/video.
|-
| <code>ZoomIn</code> || Used in picture, slideshow or video fullscreen to zoom in to the current image/video.
|-
| <code>IncreasePAR</code> || Used in video fullscreen to increase the pixel aspect ratio (stretch).
|-
| <code>DecreasePAR</code> || Used in video fullscreen to decrease the pixel aspect ratio (stretch).
|-
| <code>Queue</code> || Queue the item to the current playlist
|-
| <code>PlayNext</code> || Queue the item to the next position in the current playlist
|-
| <code>Filter</code> || Opens the mediafilter dialog in the video and musiclibrary. Used in the [[Advanced_library_filtering|advanced filter]] for the video library.
|-
| <code>Playlist</code> || Toggle to playlist view from My Music or My Videos
|-
| <code>ZoomNormal</code> || Normal (fullscreen) viewing in My Pictures
|-
| <code>ZoomLevel1</code> || Zoom to 120% in My Pictures
|-
| <code>ZoomLevel2</code> || Zoom to 150% in My Pictures
|-
| <code>ZoomLevel3</code> || Zoom to 200% in My Pictures
|-
| <code>ZoomLevel4</code> || Zoom to 280% in My Pictures
|-
| <code>ZoomLevel5</code> || Zoom to 400% in My Pictures
|-
| <code>ZoomLevel6</code> || Zoom to 600% in My Pictures
|-
| <code>ZoomLevel7</code> || Zoom to 900% in My Pictures
|-
| <code>ZoomLevel8</code> || Zoom to 1350% in My Pictures
|-
| <code>ZoomLevel9</code> || Zoom to 2000% in My Pictures
|-
| <code>NextCalibration</code> || Used in Video + GUI calibration
|-
| <code>ResetCalibration</code> || Used in Video + GUI calibration
|-
| <code>AnalogMove</code> || Move in the calibration screens, and while zoomed in My Pictures.
|-
| <code>Rotate</code> || Rotate a picture in My Pictures
|-
| <code>rotateccw</code> || '''?''' (ACTION_ROTATE_PICTURE_CCW)
|-
| <code>Close</code> || Used to close a dialog
|-
| <code>subtitledelay</code> || '''?''' (ACTION_SUBTITLE_DELAY)
|-
| <code>SubtitleDelayMinus</code> || Decrease the delay amount of subtitles (use if subtitles are displaying too late)
|-
| <code>SubtitleDelayPlus</code> || Increase the delay amount of subtitles (use if subtitles are displaying too early)
|-
| <code>audiodelay</code> || '''?''' (ACTION_AUDIO_DELAY)
|-
| <code>AudioDelayMinus</code> || Decrease the delay amount of audio (use if audio is being heard too early)
|-
| <code>AudioDelayPlus</code> || Increase the delay amount of audio (use if audio is being heard too late)
|-
| <code>AudioNextLanguage</code> || Change to the next audio track in a video with multiple audio tracks.
|-
| <code>NextResolution</code> || Used in Video calibration
|-
| <code>Number''<0-9>''</code> || Used to input the number 0 through 9
|-
| <code>FastForward</code> || Toggle the fastforward speed between normal play, 2x, 4x, 8x, 16x, and 32x.
|-
| <code>Rewind</code> || Toggle the rewind speed between normal play, 2x, 4x, 8x, 16x, and 32x.
|-
| <code>Play</code> || Play the selected item (or folder of items).
|-
| <code>PlayPause</code> || Play the selected item (or folder of items). Will also pause media when something is already playing.
|-
| <code>Delete</code> || Used in My Files to delete a file.
|-
| <code>Copy</code> || Used in My Files to copy a file.
|-
| <code>Move</code> || Used in My Files to move a file.
|-
| <code>Rename</code> || Used in My Files to rename a file.
|-
| <code>HideSubmenu</code> || <depreciated>
|-
| <code>Screenshot</code> || Take a screenshot of the current screen.
|-
| <code>Reboot</code> || Reboot
|-
| <code>ShutDown()</code> || Shutdown and power off
|-
| <code>VolumeUp</code> || Increase the volume of playback.
|-
| <code>VolumeDown</code> || Decrease the volume of playback.
|-
| <code>Mute</code> || Mute the volume.
|-
| <code>volampup</code> || '''?''' (ACTION_VOLAMP_UP)
|-
| <code>volampdown</code> || '''?''' (ACTION_VOLAMP_DOWN)
|-
| <code>audiotoggledigital</code> || '''?''' (ACTION_TOGGLE_DIGITAL_ANALOG)
|-
| <code>BackSpace</code> || Used in the virtual keyboards to delete one letter.
|-
| <code>ScrollUp</code> || Variable speed scroll up for analog keys (stick or triggers)
|-
| <code>ScrollDown</code> || Variable speed scroll down for analog keys (stick or triggers)
|-
| <code>AnalogFastForward</code> || Variable speed fast forward for analog keys (stick or triggers)
|-
| <code>AnalogRewind</code> || Variable speed rewind for analog keys (stick or triggers)
|-
| <code>AnalogSeekForward</code> || Variable speed seeking for analog keys (stick or triggers)
|-
| <code>AnalogSeekBack</code> || Variable speed seeking for analog keys (stick or triggers)
|-
| <code>MoveItemUp</code> || Used to rearrange playlists
|-
| <code>MoveItemDown</code> || Used to rearrange playlists
|-
| <code>Menu</code> || Focus the menu control (e.g. sidebar in confluence) which is specified by the skin in different windows (e.g. Movies, Music, PVR etc.) '''(v16 Jarvis addition)'''
|-
| <code>ContextMenu</code> || Pops up a contextual menu
|-
| <code>Shift</code> || Used in Virtual Keyboard to switch to upper or lower case letters
|-
| <code>Symbols</code> || Used in Virtual Keyboard to switch to or from symbols mode
|-
| <code>CursorLeft</code> || Used in Virtual Keyboard to move the current cursor point to the left
|-
| <code>CursorRight</code> || Used in Virtual Keyboard to move the current cursor point to the right
|-
| <code>ShowTime</code> || Used to show the current play time in music + video playback
|-
| <code>visualisationpresetlist</code> || Shows the visualisation preset list
|-
| <code>ShowPreset</code> || Shows the current visualisation preset (milkdrop/spectrum)
|-
| <code>NextPreset</code> || Next visualisation preset
|-
| <code>PreviousPreset</code> || Previous visualisation preset
|-
| <code>LockPreset</code> || Lock the current visualisation preset
|-
| <code>RandomPreset</code> || Switch to a new random preset
|-
| <code>IncreaseRating</code> || Used to increase track rating in full screen playback (press info on track and use pageplus on keyboard/remote
|-
| <code>DecreaseRating</code> || Used to decrease track rating in full screen playback (press info on track and use pageminus on keyboard/remote
|-
| <code>ToggleWatched</code> || Toggles watched/unwatched status for Videos
|-
| <code>NextLetter</code> || Move to the next letter in a list or thumb panel. Note that SHIFT-B on the keyboard will take you to the B's.
|-
| <code>PrevLetter</code> || Move to the previous letter in a list or thumb panel. Note that SHIFT-Z on the keyboard will take you to the Z's.
|-
| <code>JumpSMS''<2-9>''</code> || Jump through a list using SMS-style input (eg press 2 twice to jump to the B's.)
|-
| <code>FilterSMS''<2-9>''</code> || Filter a list in music or videos using SMS-style input.
|-
| <code>verticalshiftup</code> || '''?''' (ACTION_VSHIFT_UP)
|-
| <code>verticalshiftdown</code> || '''?''' (ACTION_VSHIFT_DOWN)
|-
| <code>scanitem</code> || '''?''' (ACTION_SCAN_ITEM)
|-
| <code>reloadkeymaps</code> || Reload keymap, loading any changes made to the keymap since started up.
|-
| <code>increasevisrating</code> || '''?''' (ACTION_VIS_RATE_PRESET_PLUS)
|-
| <code>decreasevisrating</code> || '''?''' (ACTION_VIS_RATE_PRESET_MINUS)
|-
| <code>firstpage</code> || '''?''' (ACTION_FIRST_PAGE)
|-
| <code>lastpage</code> || '''?''' (ACTION_LAST_PAGE)
|-
| <code>guiprofile</code> || '''?''' (ACTION_GUIPROFILE_BEGIN)
|-
| <code>red</code> || '''?''' (ACTION_TELETEXT_RED)
|-
| <code>green</code> || '''?''' (ACTION_TELETEXT_GREEN)
|-
| <code>yellow</code> || '''?''' (ACTION_TELETEXT_YELLOW)
|-
| <code>blue</code> || '''?''' (ACTION_TELETEXT_BLUE)
|-
| <code>CreateBookmark</code> || Creates a bookmark of the currently playing Video '''(v13 Gotham addition)'''
|-
| <code>CreatEpisodeBookmark</code> || Creates an episode bookmark of the currently playing multi-episode file (e.g. S01E01E02). An episode bookmark specifies the end of the one and the begin of the other episode '''(v13 Gotham addition)'''
|-
| <code>NextChannelGroup</code> || [[PVR]] Goes to the next channel group when using live TV. Works only within PVR windows + channel osd. '''(v13 Gotham addition)'''
|-
| <code>PreviousChannelGroup</code> || [[PVR]] Goes to the previous channel group when using live TV. Works only within PVR windows + channel osd. '''(v13 Gotham addition)'''
|-
| <code>ChannelUp</code> || [[PVR]] Used to switch up to the next channel. Works only if you playback TV or radio '''(v13 Gotham addition)'''
|-
| <code>ChannelDown</code> || [[PVR]] Used to switch down to the previous channel. Works only if you playback TV or radio'''(v13 Gotham addition)'''
|-
| <code>PlayPvr</code> || [[PVR]] Starts playback a TV or radio channel depends on the last played channel. '''(v13 Gotham addition)'''
|-
| <code>PlayPvrTV</code> || [[PVR]] Starts playback a TV channel. Will playback the last played channel if available. '''(v13 Gotham addition)'''
|-
| <code>PlayPvrRadio</code> || [[PVR]] Starts playback a radio channel. Will playback the last played channel if available. '''(v13 Gotham addition)'''
|-
| <code>Record</code> || [[PVR]] record current playing channel or selected item in windows like EPG '''(v13 Gotham addition)'''
|-
| <code>ToggleCommSkip</code> || Enable / Disable commercial skipping (based on [[Edit_decision_list]] file) during video playback.
|-
| <code>StereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|-
| <code>ToggleStereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|-
| <code>SwitchPlayer</code> || Select player to use, such as internal (DVDPlayer/PAPlayer), UPnP "play using" targets, external players. '''(v13 Gotham addition)'''
|-
| <code>UpdateLibrary(video)</code> || Update Movie/TV-Show library (only tested with v13 Gotham addition).
|-
| <code>SetRating</code> || For use when playing music. Will pop-up a 1-10 userrating select dialog, to rate the currently playing song. '''(v17 Krypton addition)'''
|-
|}

;Other
{| class="prettytable"
! Action
! Description
|-
| <code>noop</code> || No action. Used to specifically disable a key.
|}
<section end="Action IDs" />

== Removed action IDs ==
* <code>PresetList</code> - replaced with <code>visualisationpresetlist</code> in a previous version (unknown?)

== See also ==
* [[Keymaps]]
* [[Window IDs]]
* [[Built-in scripting]]

{{Isengard updated}}

[[Category:Remotes]]
[[Category:Skin development]]

Action IDs

2024-10-17T08:25:23Z

CastagnaIT: Add missing code's until to kodi 21

<section begin="Action IDs" />
;Main actions
{| class="prettytable sort sortable"
|-
! Action
! Description
|-
| <code>Left</code> || Move left off a control.
|-
| <code>Right</code> || Move right off a control.
|-
| <code>Up</code> || Move up off a control.
|-
| <code>Down</code> || Move down off a control.
|-
| <code>Select</code> || Select a button, or an item from a list of thumb view.
|-
| <code>Enter</code> || '''?''' (ACTION_ENTER) Not sure about all areas, but on some windows this will be the same as the "done" on screen button.
|-
| <code>PageUp</code> || Scroll up on page in a list, thumb, or text view.
|-
| <code>PageDown</code> || Scroll down on page in a list, thumb, or text view.
|-
| <code>Highlight</code> || Highlight an item in a list or thumb view.
|-
| <code>ParentDir</code> || Go up a folder to the parent folder. '''(deprecated, same meaning of "Back" code)'''
|-
| <code>ParentFolder</code> || Go up a folder to the parent folder.
|-
| <code>PreviousMenu</code> || Go back to the previous menu screen.
|-
| <code>Back</code> || Go back in navigation.
|-
| <code>Info</code> || Show the information about the currently highlighted item, or currently playing item.
|-
| <code>Pause</code> || Pause the currently playing item.
|-
| <code>Stop</code> || Stop the currently playing item.
|-
| <code>SkipNext</code> || Skip to next video in playlist. If no playlist, then skip to next chapter in video.
|-
| <code>SkipPrevious</code> || Skip to previous video in playlist. If no playlist, then skip to previous chapter in video.
|-
| <code>FullScreen</code> || Toggles full-screen content playback (either visualisation or video playback)
|-
| <code>togglefullscreen</code> || Changes whether the app is displayed full-screen or windowed (on windowing OSs)
|-
| <code>AspectRatio</code> || Toggle through the various aspect ratio modes (Normal is the preferred option).
|-
| <code>StepForward</code> || Step forward 30 seconds in a video.
|-
| <code>StepBack</code> || Step back 30 seconds in a video.
|-
| <code>BigStepForward</code> || Step forward 10 minutes in video.
|-
| <code>BigStepBack</code> || Step back 10 minutes in video.
|-
| <code>SmallStepBack</code> || Step back 7 seconds in the current video.
|-
| <code>Seek(''##'')</code> || A definable seek action, where <code>''##''</code> is a number of seconds. For example, to make a seek action that goes forward 25 seconds use <code>Seek(25)</code>, and to make a seek action that goes back 36 seconds use <code>Seek(-36)</code>. '''(v15 Isengard addition)'''
|-
| <code>ChapterOrBigStepForward</code> || Go to to next chapter in video. If no chapters, then step forward 10 minutes in video. '''(v13 Gotham addition)'''
|-
| <code>ChapterOrBigStepBack</code> || Go to previous chapter in video, If no chapters, then step back 10 minutes in video. '''(v13 Gotham addition)'''
|-
| <code>NextScene</code> || Go to next scene that is marked in an [[Edit_decision_list]] file.
|-
| <code>PreviousScene</code> || Go to previous scene that is marked in an [[Edit_decision_list]] file.
|-
| <code>OSD</code> || Toggles the OSD (On Screen Display) while playing an item.
|-
| <code>PlayDVD</code> || Start playing a DVD (goes to the DVD menu)
|-
| <code>ShowVideoMenu</code> || Go to the DVD Video menu when playing a DVD.
|-
| <code>ShowSubtitles</code> || Toggles whether subtitles are shown or not.
|-
| <code>NextSubtitle</code> || Change to the next subtitle language, if there is more than one.
|-
| <code>SubtitleShiftUp</code> || Move subtitles up
|-
| <code>SubtitleShiftDown</code> || Move subtitles down
|-
| <code>SubtitleAlign</code> || Subtitle position control
|-
| <code>CodecInfo</code> || Show codec information about the currently playing item (during video or visualisation playback)
|-
| <code>PlayerProcessInfo</code> || Show player process information about the currently playing item (during video or visualisation playback)
|-
| <code>PlayerProgramSelect</code> || Show dialog to select a program tv channel (during video playback)
|-
| <code>NextPicture</code> || Move to the next picture in a slideshow.
|-
| <code>PreviousPicture</code> || Move to the previous picture in a slideshow.
|-
| <code>ZoomOut</code> || Used in picture, slideshow or video fullscreen to zoom out of the current image/video.
|-
| <code>ZoomIn</code> || Used in picture, slideshow or video fullscreen to zoom in to the current image/video.
|-
| <code>IncreasePAR</code> || Used in video fullscreen to increase the pixel aspect ratio (stretch).
|-
| <code>DecreasePAR</code> || Used in video fullscreen to decrease the pixel aspect ratio (stretch).
|-
| <code>Queue</code> || Queue the item to the current playlist
|-
| <code>PlayNext</code> || Queue the item to the next position in the current playlist
|-
| <code>Filter</code> || Opens the mediafilter dialog in the video and musiclibrary. Used in the [[Advanced_library_filtering|advanced filter]] for the video library.
|-
| <code>Playlist</code> || Toggle to playlist view from My Music or My Videos
|-
| <code>ZoomNormal</code> || Normal (fullscreen) viewing in My Pictures
|-
| <code>ZoomLevel1</code> || Zoom to 120% in My Pictures
|-
| <code>ZoomLevel2</code> || Zoom to 150% in My Pictures
|-
| <code>ZoomLevel3</code> || Zoom to 200% in My Pictures
|-
| <code>ZoomLevel4</code> || Zoom to 280% in My Pictures
|-
| <code>ZoomLevel5</code> || Zoom to 400% in My Pictures
|-
| <code>ZoomLevel6</code> || Zoom to 600% in My Pictures
|-
| <code>ZoomLevel7</code> || Zoom to 900% in My Pictures
|-
| <code>ZoomLevel8</code> || Zoom to 1350% in My Pictures
|-
| <code>ZoomLevel9</code> || Zoom to 2000% in My Pictures
|-
| <code>NextCalibration</code> || Used in Video + GUI calibration
|-
| <code>ResetCalibration</code> || Used in Video + GUI calibration
|-
| <code>AnalogMove</code> || Move in the calibration screens, and while zoomed in My Pictures.
|-
| <code>Rotate</code> || Rotate a picture in My Pictures
|-
| <code>rotateccw</code> || '''?''' (ACTION_ROTATE_PICTURE_CCW)
|-
| <code>Close</code> || Used to close a dialog
|-
| <code>subtitledelay</code> || '''?''' (ACTION_SUBTITLE_DELAY)
|-
| <code>SubtitleDelayMinus</code> || Decrease the delay amount of subtitles (use if subtitles are displaying too late)
|-
| <code>SubtitleDelayPlus</code> || Increase the delay amount of subtitles (use if subtitles are displaying too early)
|-
| <code>audiodelay</code> || '''?''' (ACTION_AUDIO_DELAY)
|-
| <code>AudioDelayMinus</code> || Decrease the delay amount of audio (use if audio is being heard too early)
|-
| <code>AudioDelayPlus</code> || Increase the delay amount of audio (use if audio is being heard too late)
|-
| <code>AudioNextLanguage</code> || Change to the next audio track in a video with multiple audio tracks.
|-
| <code>NextResolution</code> || Used in Video calibration
|-
| <code>Number''<0-9>''</code> || Used to input the number 0 through 9
|-
| <code>FastForward</code> || Toggle the fastforward speed between normal play, 2x, 4x, 8x, 16x, and 32x.
|-
| <code>Rewind</code> || Toggle the rewind speed between normal play, 2x, 4x, 8x, 16x, and 32x.
|-
| <code>Play</code> || Play the selected item (or folder of items).
|-
| <code>PlayPause</code> || Play the selected item (or folder of items). Will also pause media when something is already playing.
|-
| <code>Delete</code> || Used in My Files to delete a file.
|-
| <code>Copy</code> || Used in My Files to copy a file.
|-
| <code>Move</code> || Used in My Files to move a file.
|-
| <code>Rename</code> || Used in My Files to rename a file.
|-
| <code>HideSubmenu</code> || <depreciated>
|-
| <code>Screenshot</code> || Take a screenshot of the current screen.
|-
| <code>Reboot</code> || Reboot
|-
| <code>ShutDown()</code> || Shutdown and power off
|-
| <code>VolumeUp</code> || Increase the volume of playback.
|-
| <code>VolumeDown</code> || Decrease the volume of playback.
|-
| <code>Mute</code> || Mute the volume.
|-
| <code>volampup</code> || '''?''' (ACTION_VOLAMP_UP)
|-
| <code>volampdown</code> || '''?''' (ACTION_VOLAMP_DOWN)
|-
| <code>audiotoggledigital</code> || '''?''' (ACTION_TOGGLE_DIGITAL_ANALOG)
|-
| <code>BackSpace</code> || Used in the virtual keyboards to delete one letter.
|-
| <code>ScrollUp</code> || Variable speed scroll up for analog keys (stick or triggers)
|-
| <code>ScrollDown</code> || Variable speed scroll down for analog keys (stick or triggers)
|-
| <code>AnalogFastForward</code> || Variable speed fast forward for analog keys (stick or triggers)
|-
| <code>AnalogRewind</code> || Variable speed rewind for analog keys (stick or triggers)
|-
| <code>AnalogSeekForward</code> || Variable speed seeking for analog keys (stick or triggers)
|-
| <code>AnalogSeekBack</code> || Variable speed seeking for analog keys (stick or triggers)
|-
| <code>MoveItemUp</code> || Used to rearrange playlists
|-
| <code>MoveItemDown</code> || Used to rearrange playlists
|-
| <code>Menu</code> || Focus the menu control (e.g. sidebar in confluence) which is specified by the skin in different windows (e.g. Movies, Music, PVR etc.) '''(v16 Jarvis addition)'''
|-
| <code>ContextMenu</code> || Pops up a contextual menu
|-
| <code>Shift</code> || Used in Virtual Keyboard to switch to upper or lower case letters
|-
| <code>Symbols</code> || Used in Virtual Keyboard to switch to or from symbols mode
|-
| <code>CursorLeft</code> || Used in Virtual Keyboard to move the current cursor point to the left
|-
| <code>CursorRight</code> || Used in Virtual Keyboard to move the current cursor point to the right
|-
| <code>ShowTime</code> || Used to show the current play time in music + video playback
|-
| <code>visualisationpresetlist</code> || Shows the visualisation preset list
|-
| <code>ShowPreset</code> || Shows the current visualisation preset (milkdrop/spectrum)
|-
| <code>NextPreset</code> || Next visualisation preset
|-
| <code>PreviousPreset</code> || Previous visualisation preset
|-
| <code>LockPreset</code> || Lock the current visualisation preset
|-
| <code>RandomPreset</code> || Switch to a new random preset
|-
| <code>IncreaseRating</code> || Used to increase track rating in full screen playback (press info on track and use pageplus on keyboard/remote
|-
| <code>DecreaseRating</code> || Used to decrease track rating in full screen playback (press info on track and use pageminus on keyboard/remote
|-
| <code>ToggleWatched</code> || Toggles watched/unwatched status for Videos
|-
| <code>NextLetter</code> || Move to the next letter in a list or thumb panel. Note that SHIFT-B on the keyboard will take you to the B's.
|-
| <code>PrevLetter</code> || Move to the previous letter in a list or thumb panel. Note that SHIFT-Z on the keyboard will take you to the Z's.
|-
| <code>JumpSMS''<2-9>''</code> || Jump through a list using SMS-style input (eg press 2 twice to jump to the B's.)
|-
| <code>FilterSMS''<2-9>''</code> || Filter a list in music or videos using SMS-style input.
|-
| <code>verticalshiftup</code> || '''?''' (ACTION_VSHIFT_UP)
|-
| <code>verticalshiftdown</code> || '''?''' (ACTION_VSHIFT_DOWN)
|-
| <code>scanitem</code> || '''?''' (ACTION_SCAN_ITEM)
|-
| <code>reloadkeymaps</code> || Reload keymap, loading any changes made to the keymap since started up.
|-
| <code>increasevisrating</code> || '''?''' (ACTION_VIS_RATE_PRESET_PLUS)
|-
| <code>decreasevisrating</code> || '''?''' (ACTION_VIS_RATE_PRESET_MINUS)
|-
| <code>firstpage</code> || '''?''' (ACTION_FIRST_PAGE)
|-
| <code>lastpage</code> || '''?''' (ACTION_LAST_PAGE)
|-
| <code>guiprofile</code> || '''?''' (ACTION_GUIPROFILE_BEGIN)
|-
| <code>red</code> || '''?''' (ACTION_TELETEXT_RED)
|-
| <code>green</code> || '''?''' (ACTION_TELETEXT_GREEN)
|-
| <code>yellow</code> || '''?''' (ACTION_TELETEXT_YELLOW)
|-
| <code>blue</code> || '''?''' (ACTION_TELETEXT_BLUE)
|-
| <code>CreateBookmark</code> || Creates a bookmark of the currently playing Video '''(v13 Gotham addition)'''
|-
| <code>CreatEpisodeBookmark</code> || Creates an episode bookmark of the currently playing multi-episode file (e.g. S01E01E02). An episode bookmark specifies the end of the one and the begin of the other episode '''(v13 Gotham addition)'''
|-
| <code>NextChannelGroup</code> || [[PVR]] Goes to the next channel group when using live TV. Works only within PVR windows + channel osd. '''(v13 Gotham addition)'''
|-
| <code>PreviousChannelGroup</code> || [[PVR]] Goes to the previous channel group when using live TV. Works only within PVR windows + channel osd. '''(v13 Gotham addition)'''
|-
| <code>ChannelUp</code> || [[PVR]] Used to switch up to the next channel. Works only if you playback TV or radio '''(v13 Gotham addition)'''
|-
| <code>ChannelDown</code> || [[PVR]] Used to switch down to the previous channel. Works only if you playback TV or radio'''(v13 Gotham addition)'''
|-
| <code>PlayPvr</code> || [[PVR]] Starts playback a TV or radio channel depends on the last played channel. '''(v13 Gotham addition)'''
|-
| <code>PlayPvrTV</code> || [[PVR]] Starts playback a TV channel. Will playback the last played channel if available. '''(v13 Gotham addition)'''
|-
| <code>PlayPvrRadio</code> || [[PVR]] Starts playback a radio channel. Will playback the last played channel if available. '''(v13 Gotham addition)'''
|-
| <code>Record</code> || [[PVR]] record current playing channel or selected item in windows like EPG '''(v13 Gotham addition)'''
|-
| <code>ToggleCommSkip</code> || Enable / Disable commercial skipping (EDL based) during video playback.
|-
| <code>StereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|-
| <code>ToggleStereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|-
| <code>SwitchPlayer</code> || Select player to use, such as internal (DVDPlayer/PAPlayer), UPnP "play using" targets, external players. '''(v13 Gotham addition)'''
|-
| <code>UpdateLibrary(video)</code> || Update Movie/TV-Show library (only tested with v13 Gotham addition).
|-
| <code>SetRating</code> || For use when playing music. Will pop-up a 1-10 userrating select dialog, to rate the currently playing song. '''(v17 Krypton addition)'''
|-
|}

;Other
{| class="prettytable"
! Action
! Description
|-
| <code>noop</code> || No action. Used to specifically disable a key.
|}
<section end="Action IDs" />

== Removed action IDs ==
* <code>PresetList</code> - replaced with <code>visualisationpresetlist</code> in a previous version (unknown?)

== See also ==
* [[Keymaps]]
* [[Window IDs]]
* [[Built-in scripting]]

{{Isengard updated}}

[[Category:Remotes]]
[[Category:Skin development]]

Advancedsettings.xml

2023-12-04T14:45:02Z

CastagnaIT: languagecodes - Add note for MKV files about workaround for language code with subtags

{{TOC right}}{{mininav|[[Settings]]|page=advancedsettings.xml}}
{{bigger|{{note|'''The advancedsettings.xml file does not exist by default. You have to create it first!'''}} }}

<section begin="intro" />The [[advancedsettings.xml]] file, which does not exist by default, can be created by a user in their '''[[Userdata|userdata folder]]'''.

This file is used for advanced settings and options that do not have GUI controls inside of {{kodi}}. Some settings are experimental or very rarely set, so they can only be used via the advancedsettings.xml file. The file is simply a plain text file and can be edited by various text editors, so long as the name is "advancedsettings.xml". These advanced settings can be used to tweak various things such as episode naming patterns, special network ports, special behaviors, and more.<section end="intro" />

The following page will describe the structure of the advancedsettings.xml file and the various individual settings.

{{note|
# All XML tags must be lowercase. The start and end of the advancedsettings.xml file must have the <advancedsettings> and </advancedsettings> tags.
# Kodi will only read the advancedsettings.xml file when it starts up. If you make changes while it is running then you must restart Kodi.
# For some Windows versions, Kodi has two <code>\userdata\</code> folders. The correct one to put the advancedsettings.xml file in is not the one in Program Files, but in <code>%appdata%\Kodi\userdata\.</code>}}

== Layout ==

The layout of <code>advancedsettings.xml</code> is as follows:

<syntaxhighlight lang=xml enclose="div">
<advancedsettings version="1.0">
<setting>value</setting>
...
<setting>value</setting>
</advancedsettings>
</syntaxhighlight>

where "setting" gives the name of the setting, and "value" gives its value.

A list of the available "setting" strings and their values is given below.

= List of available settings =
List of available settings that are recognised in the advancedsettings.xml file <ref>https://github.com/xbmc/xbmc/blob/master/xbmc/settings/AdvancedSettings.cpp</ref>

Recommended: Use the table of contents or the search function in your browser to locate items.

== Troubleshooting settings ==

=== loglevel ===
{{Anchor|.3Cloglevel.3E}}

<section begin="loglevel" />
Sets the logging level used to log errors and information. The "hide" attribute is optional.

<syntaxhighlight lang=xml>
<loglevel hide="attribute">options</loglevel>
</syntaxhighlight>

{| class="mw-collapsible mw-collapsed wikitable"
|-
! style="width:100px;" | Attribute
! style="width:500px;" | Action
|-
! '''true'''
| Hides the "enable debugging" setting in the Settings page. (default)
|-
! '''false'''
| Allows "enable debugging" setting to switch between '''0''' and '''2'''.
|}

{| class="mw-collapsible mw-collapsed wikitable"
|-
! style="width:100px;" | Option
! style="width:500px;" | Action
|-
! '''-1'''
| No logging, suppresses all log output
|-
! '''0'''
| Normal logging, only logging errors (default)
|-
! '''1'''
| Debug logging with freemem, fps and cpu usage (no on screen)
|-
! '''2'''
| Same as 1 (with on screen display)
|-
! '''3'''
| Same as 1 + full smb logging
|}

{| class="wikitable"
|-
! style="width:100px;" | Example
! style="width:500px;" |
|-
! Example 1:
|<syntaxhighlight lang=xml enclose="div">
<advancedsettings>
<loglevel>2</loglevel>
</advancedsettings>
</syntaxhighlight>
|-
! Example 2:
|<syntaxhighlight lang=xml enclose="div">
<advancedsettings>
<loglevel hide="true">2</loglevel>
</advancedsettings>
</syntaxhighlight>
|}

'''Note:''' The setting is persistent through shutdown and restarts.<br>
'''Note:''' If debugging is enabled in the GUI, loglevel will be set to '''2'''. This will over-ride the <code>advancedsettings.xml</code> setting. You must disable the GUI Setting before adding the entry to <code>advancedsettings.xml</code>.<br />
<section end="loglevel" />
:''{{see also|Log_file|label 1=Debug Log}}''

=== jsonrpc ===
{{Anchor|.3Cjsonrpc.3E}}
To make it easier for developers using the [[JSON-RPC_API]] API in their (third party) applications to debug during development the json output of Kodi can be prettified by setting '''compactoutput''' to '''false'''. Default json output mode is a compact print which does not contain any unnecessary whitespaces and therefore is difficult to read for humans.
Furthermore using the '''tcpport''' setting it is possible to change the default TCP port used by Kodi for JSON RPC (which is 9090) to any other valid port.

Example:
<syntaxhighlight lang=xml enclose="div">
<jsonrpc>
<compactoutput>false</compactoutput>
<tcpport>9999</tcpport>
</jsonrpc>
</syntaxhighlight>

== Audio/video playback settings ==

=== skiploopfilter ===
{{anchor|.3Cskiploopfilter.3E}}
The amount of the loop filter to skip on h.264 decoding. This can help the performance of slower machines when decoding h264 content. Values, in decreasing CPU usage (and decreasing quality)
* -16 None
* 0 Skip only empty frames (default)
* 8 Skip non-reference frames
* 16 Skip bi-dir frames
* 32 Skip all non-key frames
* 48 Skip all frames
Example:
<syntaxhighlight lang=xml enclose="div">
<skiploopfilter>8</skiploopfilter>
</syntaxhighlight>

=== video ===
{{anchor|.3Cvideo.3E}}

The <video> section also includes the following child-tags, which have their own sections:
*[[#cleandatetime]]
*[[#cleanstrings]]
*[[#excludefromscan]]
*[[#excludefromlisting]]
*[[#excludetvshowsfromscan]]

{{note|Some tags that have a "third-level" and are grouped together are highlighted in color.}}

{| class="prettytable"
! Tag !! Description
|-
|
<syntaxhighlight lang=xml>
<video>
</syntaxhighlight>
| Parent tag that all other child tags need to be placed inside of. Do not use more than one '''<code><video></code>''' tag, but instead place all other child-tags within a single '''<code><video></video></code>''' set.
|-
|
<syntaxhighlight lang=xml>
<subsdelayrange>10</subsdelayrange>
</syntaxhighlight>
| Delay range for subtitles, in seconds.
|-
|
<syntaxhighlight lang=xml>
<maxtempo>2.1</maxtempo>
</syntaxhighlight>
| Allow further increase of playback speed over the default of 1.5<br>
maxtempo must be in the range of 1.5 to 2.1 <br>
Be aware of the limitations of your platform / hardware as not all are capable of the increased maxtempo <ref>https://forum.kodi.tv/showthread.php?tid=10023&pid=2795069#pid2795069</ref>
|-
|
<syntaxhighlight lang=xml>
<audiodelayrange>10</audiodelayrange>
</syntaxhighlight>
| Delay range for audio/video sync, in seconds.
|-
|
<syntaxhighlight lang=xml>
<usetimeseeking>true</usetimeseeking>
</syntaxhighlight>
| Whether to use time based or percentage based seeking. {{small see also|Skip steps}}
|-
|
<syntaxhighlight lang=xml>
<timeseekforwardbig>600</timeseekforwardbig>
<timeseekbackwardbig>-600</timeseekbackwardbig>
</syntaxhighlight>
| Time to seek forward in seconds when doing a long seek. Defaults to 600 (10 minutes) and -600 (-10 minutes) respectively. ''{{small|See also: [[Skip steps]] }}''
|-
|
<syntaxhighlight lang=xml>
<percentseekforward>2</percentseekforward>
<percentseekbackward>-2</percentseekbackward>
</syntaxhighlight>
| Amount to seek forward as a percentage, when doing a short seek. Defaults to 2 (2%) and -2 (2%) respectively. ''{{small|See also: [[Skip steps]] }}''
|-
|
<syntaxhighlight lang=xml>
<percentseekforwardbig>10</percentseekforwardbig>
<percentseekbackwardbig>-10</percentseekbackwardbig>
</syntaxhighlight>
| Amount to seek forward as a percentage, when doing a long seek. Defaults to 10 (10%) and -10 (10%) respectively. ''{{small|See also: [[Skip steps]] }}''
|-
|
<syntaxhighlight lang=xml>
<fullscreenonmoviestart>true</fullscreenonmoviestart>
</syntaxhighlight>
| Whether to go to fullscreen or not when starting a movie. Defaults to true.
|-
|
<syntaxhighlight lang=xml>
<defaultplayer>VideoPlayer</defaultplayer>
</syntaxhighlight>
| Set the default video player: VideoPlayer or an external player. See '''[[External players]]''' for more info.
|-
|
<syntaxhighlight lang=xml>
<excludefromscan>
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromscan>
</syntaxhighlight>
| Regular expressions that if evaluated to true won't be added to library. It is possible to add multiple <code><regexp></code> tags to match multiple patterns
|-
|
<syntaxhighlight lang=xml>
<excludefromlisting>
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromlisting>
</syntaxhighlight>
| Regular expressions that if evaluated to true won't be displayed in files view.
|-
|
<syntaxhighlight lang=xml>
<playcountminimumpercent>90</playcountminimumpercent>
</syntaxhighlight>
| Minimum percentage that has to be played before it is marked as watched. Set to 101 to never auto-mark items as watched. ''{{small|See also: [[HOW-TO:Modify automatic watch and resume points]] }}''
|-
|
<syntaxhighlight lang=xml>
<ignoresecondsatstart>180</ignoresecondsatstart>
</syntaxhighlight>
| Number of seconds to ignore at video start after which a resume point is created. ''{{small|See also: [[HOW-TO:Modify automatic watch and resume points]] }}''
|-
|
<syntaxhighlight lang=xml>
<ignorepercentatend>8</ignorepercentatend>
</syntaxhighlight>
| Percentage of video to ignore at the end. If you stop watching the video here no resume point is created. Set to 101 to never save a resume point. The video is already marked as watched at 90%, see above. ''{{small|See also: [[HOW-TO:Modify automatic watch and resume points]] }}''
|-
|
<syntaxhighlight lang=xml>
<vdpauscaling>true</vdpauscaling>
</syntaxhighlight>
| Scales with vdpau instead of opengl and turns on its HQ scaler when available, enabling this might slow down rendering and cause framedrops especially on ION systems, this setting requires a vdpau feature set C GPU.
|-
|
<syntaxhighlight lang=xml>
<ppffmpegdeinterlacing>linblenddeint</ppffmpegdeinterlacing>
</syntaxhighlight>
| Override the deinterlacing options passed to libpostproc.
|-
|
<syntaxhighlight lang=xml>
<ppffmpegpostprocessing>ha:128:7,va,dr</ppffmpegpostprocessing>
</syntaxhighlight>
| Override the post processing options passed to libpostproc when 'Video post-processing' is activated in GUI Videos-Settings-Playback.
|-
|
<syntaxhighlight lang=xml>
<autoscalemaxfps>30</autoscalemaxfps>
</syntaxhighlight>
| When scaling method is set to auto, bilinear is chosen when the fps is higher than this limit, the default is 30.
|-
|
<syntaxhighlight lang=xml>
<adjustrefreshrate>
</syntaxhighlight>
| style="background:#CADCFB;" | Settings for when "Adjust refreshrate to match video fps" is enabled in the video playback GUI settings.
|-
|
<syntaxhighlight lang=xml>
<override>
<fps>23.976</fps>
<refresh>60.0</refresh>
</override>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -''' "Adjust refreshrate to match video fps" will try to select the best refreshrate for the video fps but it doesn't always get it right, for example it might switch to an unsupported refreshrate. You can add overrides here to switch to a certain refreshrate based on video fps. It's possible to add as many overrides as you need. Overrides are processed in order, if the first one doesn't match the fps or no refreshrates match that override, it will try the next one until no overrides are left.

* '''fps''' - if the fps is between 23.966 and 23.986
* '''refresh''' - switch to the first found refreshrate that is between 59.99 and 60.01
|-
|
<syntaxhighlight lang=xml>
<override>
<fpsmin>29.96</fpsmin>
<fpsmax>30.01</fpsmax>
<refreshmin>59.0</refreshmin>
<refreshmax>61.0</refreshmax>
</override>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -'''
* '''fpsmin''' / '''fpsmin''' - You can also specify the fps range yourself.
* '''refreshmin''' / '''refreshmax''' - Same for the refreshrate
|-
|
<syntaxhighlight lang=xml>
<fallback>
<refresh>50.0</refresh>
</fallback>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -''' If none of the overrides match, or none of the refreshrates match any of the fps matching overrides, it will choose a fallback refreshrate. Fallbacks are process in order, if the first fallback doesn't match any refreshrate, it will try the next one until no fallbacks are left.

* '''refresh''' - Switch to the first found refreshrate that is between 49.99 and 50.01.
|-
|
<syntaxhighlight lang=xml>
<fallback>
<refreshmin>49.0</refreshmin>
<refreshmax>51.0</refreshmax>
</fallback>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -''' You can also specify the range for the fallback yourself.

If none of the overrides match the video fps, or no refreshrates match any of the fps matching overrides, and no fallbacks are specified or no refreshrates match any fallbacks, it will automatically choose the best refreshrate (same as having no overrides and fallbacks).
|-
|
<syntaxhighlight lang=xml>
</adjustrefreshrate>
</syntaxhighlight>
| style="background:#CADCFB;" |
|-
|
<syntaxhighlight lang=xml>
<checkdxvacompatibility>value</checkdxvacompatibility>
</syntaxhighlight>
| Advanced setting not present: let Kodi autodetect cards that support H.264 profile > L4.1. Set value to false to enable DXVA no matter what. Set value to true if Kodi doesn't autodetect that the graphics card doesn't support > L4.1.
|-
|
<syntaxhighlight lang=xml>
<useocclusionquery>-1</useocclusionquery>
</syntaxhighlight>
| Use an occlusion query when capturing videoframes, -1 means auto detect, 0 means disabled, 1 means enabled, the default is -1.
|-
|
<syntaxhighlight lang=xml>
<fpsdetect>1</fpsdetect>
</syntaxhighlight>
| FPS detection for video playback
* 0 = trust codec fps
* 1 = recalculate from video timestamps with uniform spacing
* 2 = recalculate from video timestamps always
|-
|
<syntaxhighlight lang=xml>
<latency>
</syntaxhighlight>
| style="background:#F0E68C;"| Start of '''latency''' tags. Display latency (video lag). Latency is given in msecs.
|-
|
<syntaxhighlight lang=xml>
<delay>0</delay>
</syntaxhighlight>
| style="background:#F0E68C;" | Global default display latency.
|-
|
<syntaxhighlight lang=xml>
<refresh></refresh>
</syntaxhighlight>
| style="background:#F0E68C;" | Override latency for given display (not video) refresh rates. When Kodi is in windowed mode, override is ignored. Multiple overrides are allowed.

Syntax of an override entry:
<syntaxhighlight lang=xml>
<refresh>
<min>, <max> refresh rate range, OR
<rate> exact refresh rate
<delay> display latency for the given refresh rate
</refresh>
</syntaxhighlight>
|-
|
<syntaxhighlight lang=xml>
<refresh>
<min>23</min>
<max>24</max>
<delay>125</delay>
</refresh>
</syntaxhighlight>
| style="background:#F0E68C;" | '''Example:''' display has 125 msec latency at 23-24 Hz
|-
|
<syntaxhighlight lang=xml>
<refresh>
<rate>50</rate>
<delay>50</delay>
</refresh>
</syntaxhighlight>
| style="background:#F0E68C;" | '''Example:''' display has 50 msec latency at 50 (+/-0.01) Hz
|-
|
<syntaxhighlight lang=xml>
</latency>
</syntaxhighlight>
| style="background:#F0E68C;" |
|-
|
<syntaxhighlight lang=xml>
<stereoscopicregex3d>[-. _]3d[-. _]</stereoscopicregex3d>
<stereoscopicregexsbs>[-. _]h?sbs[-. _]</stereoscopicregexsbs>
<stereoscopicregextab>[-. _]h?tab[-. _]</stereoscopicregextab>
</syntaxhighlight>
| Filename triggers for 3D (stereoscopic) mode.
|-
|
<syntaxhighlight lang=xml>
<assfixedworks>false</assfixedworks>
</syntaxhighlight>
| Position behavior of ass subtitiles when setting "subtitle position on screen" set to "fixed". True to show at the fixed position set in video calibration. False to show at the bottom of video (default). {{note|Removed in Kodi v20.}}
|-
|
<syntaxhighlight lang=xml>
<subtitleverticalmargin>120</subtitleverticalmargin>
</syntaxhighlight>
| Allows to customise the vertical margin of text based subtitles, which will be applied to each type of subtitle position in subtitle settings. {{note|Available in Kodi v20 and above.}}
|-
|
<syntaxhighlight lang=xml>
</video>
</syntaxhighlight>
|
|}

=== audio ===
{{anchor|.3Caudio.3E}}
<syntaxhighlight lang=xml enclose="div">
<audio>

<headroom>0</headroom>

<defaultplayer>paplayer</defaultplayer>

<excludefromscan>
<regexp>[-\._ ](podcast)[-\._ ]</regexp>
</excludefromscan>

<excludefromlisting>
<regexp>[-\._ ](podcast)[-\._ ]</regexp>
</excludefromlisting>

<ac3downmixgain>12.0</ac3downmixgain>

<usetimeseeking>true</usetimeseeking>

<timeseekforwardbig>600</timeseekfowardbig>

<timeseekbackwardbig>-600</timeseekbackward>

<playcountminimumpercent>99</playcountminimumpercent>

<applydrc>-1.0</applydrc>

<limiterhold>0.025</limiterhold>

<limiterrelease>0.1</limiterrelease>

<maxpassthroughoffsyncduration>10</maxpassthroughoffsyncduration>
</audio>
</syntaxhighlight>

=== forcedswaptime ===
{{anchor|.3Cforcedswaptime.3E}}
Use to force a backbuffer->frontbuffer swap while vsync is enabled. Set to the time (in ms) to allow for the swap (e.g. <forcedswaptime>1</forcedswaptime> is typical).

Default: Off

=== edl ===
{{anchor|.3Cedl.3E}}
{{main|Edit_decision_list}}
Commercial break detection not as good you think it could be? Are some commercial breaks in a series of adverts not being skipped? Are some parts being skipped that are clearly not commercials? Does the end of the previous recording still show? The following advanced settings can be used to better identify full commercial break sequences, remove incorrectly flagged commercial breaks, and have playback start at the actual beginning of the recording.

<syntaxhighlight lang=xml enclose="div">
<edl>

<mergeshortcommbreaks>false</mergeshortcommbreaks>

<maxcommbreaklength>250</maxcommbreaklength>

<mincommbreaklength>90</mincommbreaklength>

<maxcommbreakgap>120</maxcommbreakgap>

<commbreakautowait>0</commbreakautowait>

<commbreakautowind>0</commbreakautowind>

<displaycommbreaknotifications>false</displaycommbreaknotifications>
</edl>
</syntaxhighlight>
'''Notes:'''
* displaycommbreaknotifications<ref>https://github.com/xbmc/xbmc/pull/20711</ref>

== PVR & Live TV ==
{{anchor|.3Cpvr.3E}}
Settings available for PVR, EPG and Live TV. Edit Decision List settings are located in the previous section.

=== pvr ===
<syntaxhighlight lang="xml" line='line'>
<pvr>
<timecorrection>0</timecorrection> 
<infotoggleinterval>3000</infotoggleinterval> 
<channeliconsautoscan>true</channeliconsautoscan> 
<autoscaniconsuserset>false</autoscaniconsuserset> 
<numericchannelswitchtimeout>1000</numericchannelswitchtimeout> 
</pvr>
</syntaxhighlight>

==== pvrrecordings ====
In v19 and later, allows users to modify sort type and order of pvr recordings. <ref>https://github.com/xbmc/xbmc/pull/18605</ref>

;Note- These settings are child tags to the ''<pvr>'' tag in the previous section.

<syntaxhighlight lang="xml" line='line'>
<pvr>
<pvrrecordings>
<sortmethod>2</sortmethod> 
<sortorder>2</sortorder> 
</pvrrecordings>
</pvr>
</syntaxhighlight>

=== epg ===
{{anchor|.3Cpvr.3E}}
<syntaxhighlight lang="xml" line='line'>
<epg>
<updatecheckinterval>300</updatecheckinterval> 
<updateemptytagsinterval>60</updateemptytagsinterval> 
<cleanupinterval>900</cleanupinterval> 
<activetagcheckinterval>60</activetagcheckinterval> 
<retryinterruptedupdateinterval>60</retryinterruptedupdateinterval> 
<displayupdatepopup>true</displayupdatepopup> 
<displayincrementalupdatepopup>false</displayincrementalupdatepopup> 
</epg>
</syntaxhighlight>

== Video library settings ==

=== videoextensions ===
{{anchor|.3Cvideoextensions.3E}}<section begin="videoextensions" />
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Video windows.

Default extensions for VIDEOS:
<pre>
.m4v .3g2 .3gp .nsv .tp .ts .ty .strm .pls .rm .rmvb .mpd .m3u .m3u8 .ifo .mov .qt .divx .xvid
.bivx .vob .nrg .img .iso .udf .pva .wmv .asf .asx .ogm .m2v .avi .bin .dat .mpg .mpeg .mp4
.mkv .mk3d .avc .vp3 .svq3 .nuv .viv .dv .fli .flv .001 .wpl .xspf .zip .vdr .dvr-ms .xsp .mts
.m2t .m2ts .evo .ogv .sdp .avs .rec .url .pxml .vc1 .h264 .rcv .rss .mpls .mpl .webm .bdmv
.bdm .wtv .trp .f4v
</pre>
Examples:
<pre>
<videoextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</videoextensions>
</pre>
<section end="videoextensions" />

=== discstubextensions ===
{{main|Media stubs}}

<section begin="discstubextensions" />
The default filename extension for Disc Stubs is:
<syntaxhighlight lang=xml enclose="div">
.disc
</syntaxhighlight>
Using the following tags, it is possible to <tt><add></tt> additional or <tt><remove></tt> existing disc stub extensions to better suit your requirements.
<syntaxhighlight lang=xml enclose="div">
<discstubextensions>
<add>.disk|.stub</add>
<remove>.disc</remove>
</discstubextensions>
</syntaxhighlight>
<section end="discstubextensions" />

=== languagecodes ===
{{anchor|.3Clanguagecodes.3E}}
User-defined translation table for language codes used in subtitles and audio.
It can be used to add, extend or override Kodi's language codes.

'''How to add a new language code:'''

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>alt</short>
<long>Alternate</long>
</code>
</languagecodes>
</syntaxhighlight>

'''How to add a new language code with subtag (e.g. pt-BR):'''
{{note|This support is available from Kodi v20}}

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>pt-BR</short>
<long>Portuguese - Brazil</long>
</code>
</languagecodes>
</syntaxhighlight>

''NOTE FOR MKV FILES:''<br/>
MKV files that contain audio/subtitle tracks with language codes with subtags are not yet supported, but from <code>Kodi v21</code> a workaround was introduced that allows Kodi to recognize language codes with subtags.
To use the workaround, you must open the MKV file with an editor and in the metadata of the desired audio/subtitle track, edit the track Name (or Title field) by adding the language code wrapped in curly brackets, as in following example:
<br/><code>Original track name: Audio portuguese/brazil</code>
<br/><code>Modified track name: Audio portuguese/brazil {pt-BR}</code>

'''How to extend an existing language code:'''

Set the same "long" description of the existing language, for example we reuse the Portughese language for another language code:

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>pt-BR</short>
<long>Portuguese</long>
</code>
</languagecodes>
</syntaxhighlight>

In this case when in Kodi settings you set the "Portuguese" language, when in playing according to availability the track "pt" or "pt-BR" will be chosen.

'''How to override an existing language code:'''

This allow you to rename an existing language. Set to an existing language code your preferred "long" name description.

''WARNING: This can cause problems with add-ons, so do not override languages if you are not aware of the side effects.''

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>en</short>
<long>English example</long>
</code>
<code>
<short>en-GB</short>
<long>English example</long>
</code>
</languagecodes>
</syntaxhighlight>

=== moviestacking ===
{{anchor|.3Cmoviestacking.3E}}<section begin="moviestacking" />
{{main|Naming_video_files/Movies}}
This is used by the [[Naming_video_files/Movies#Split_Video_Files|file stacking]] algorithm to combine multi-part files and contains a list of regular expressions. For stacking videos that are contained in folders, such as VIDEO_TS folders, see '''[[advancedsettings.xml#folderstacking|<folderstacking>]]'''

As of v9.11, video stacking regular expressions '''must''' contain exactly four (4) capture expressions.

Default:
<syntaxhighlight lang=xml enclose="div">
<moviestacking>

<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck])[ _.-]*[0-9]+)(.*?)(\.[^.]+)$</regexp>

<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck])[ _.-]*[a-d])(.*?)(\.[^.]+)$</regexp>

<regexp>(.*?)([ ._-]*[a-d])(.*?)(\.[^.]+)$</regexp>
</moviestacking>
</syntaxhighlight>

If the argument <tt>action="append"</tt> or <tt>append="yes"</tt> is supplied, the default moviestacking regular expressions will remain intact and the user specified ones will be added to the end.

Example:
<syntaxhighlight lang=xml enclose="div">
<moviestacking action="append">

<regexp>(.*?)([ ._-]*[0-9])(.*?)(\.[^.]+)$</regexp>
</moviestacking>
</syntaxhighlight>

If the argument <tt>action="prepend"</tt> is supplied, the default moviestacking regular expressions will remain intact and the user specified ones will be added to the beginning.

Example:
<syntaxhighlight lang=xml enclose="div">
<moviestacking action="prepend">
<regexp>(Title)(Volume)(Ignore)(Extension)</regexp>
</moviestacking>
</syntaxhighlight>

If no argument is supplied, or the argument <tt>append="no"</tt> is supplied, the default moviestacking regular expressions are overwritten by the user specified ones.
<section end="moviestacking" />

=== folderstacking ===
{{main|Naming_video_files/Movies}}
This is similar to '''[[advancedsettings.xml#moviestacking|<moviestacking>]]''', but is used for videos that are contained in folders that use the folder names to stack, such as VIDEO_TS folders (DVD rips that are not in ISO format).

Default:
<syntaxhighlight lang=xml enclose="div">
<folderstacking>

<regexp>((cd|dvd|dis[ck])[0-9]+)$</regexp>
</folderstacking>
</syntaxhighlight>

=== cleandatetime ===
{{anchor|.3Ccleandatetime.3E}}
Matches a year number in a string using a Regular Expression

Default expression:
<syntaxhighlight lang=xml enclose="div">
<video>
<cleandatetime>(.*[^ _\,\.\[\]\-])[ _\.\[\]\-]+(19[0-9][0-9]|20[0-9][0-9])([ _\,\.\[\]\-]|[^0-9]$)?</cleandatetime>
</video>
</syntaxhighlight>
:* The string found before will be used as basis string getting cleaned by the cleanstrings expressions.
:* By default date formats like MM:YY are ignored.

=== cleanstrings ===
{{anchor|.3Ccleanstrings.3E}}
Clean unwanted characters from filenames or folders by using a list of Regular Expressions. Please note that everything right of the match (at the end of the file name) is removed, so if you would have a file named ''Super movie.mp4'' and would add <tt><regexp> </regexp></tt> (only a space), the only thing that would be left is ''Super'', which is probably not what you want.

{{Github_link|[https://github.com/xbmc/xbmc/blob/Nexus/xbmc/settings/AdvancedSettings.cpp#L201-L211 Code in Github]}}

Default expressions:
<syntaxhighlight lang=xml enclose="div">
<video>
<cleanstrings>
<regexp>([ _\\,\\.\$\$\\[\\]\\-](10bit|480p|480i|576p|576i|720p|720i|1080p|1080i|2160p|3d|aac|ac3|aka|atmos|avi|bd5|bdrip|bluray|brrip|cam|cd[1-9]|custom|dc|ddp|divx|divx5|dolbydigital|dolbyvision|dsr|dsrip|dts|dts-hdma|dts-hra|dts-x|dv|dvd|dvd5|dvd9|dvdivx|dvdrip|dvdscr|dvdscreener|extended|fragment|fs|h264|h265|hdr|hdr10|hevc|hddvd|hdrip|hdtv|hdtvrip|hrhd|hrhdtv|internal|limited|multisubs|nfofix|ntsc|ogg|ogm|pal|pdtv|proper|r3|r5|read.nfo|remastered|remux|repack|rerip|retail|screener|se|svcd|tc|telecine|telesync|truehd|ts|uhd|unrated|ws|x264|x265|xvid|xvidvd|xxx|web-dl|webrip|www.www|\\[.*\\])([ _\\,\\.\$\$\\[\\]\\-]|$)");</regexp>
<regexp>(\[.*\])</regexp>
</cleanstrings>
</video>
</syntaxhighlight>
Updated in v20<ref>https://github.com/xbmc/xbmc/pull/20549</ref>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)

=== tvshowmatching ===
{{anchor|.3Ctvshowmatching.3E}}
Matches the season and episode numbers in file paths by using a list of Regular Expressions

{{Github_link|[https://github.com/xbmc/xbmc/blob/Matrix/xbmc/settings/AdvancedSettings.cpp#L232 Code in Github]}}

Defaults:
<syntaxhighlight lang=xml enclose="div">
<tvshowmatching>
<regexp>s([0-9]+)[ ._x-]*e([0-9]+(?:(?:[a-i]|\\.[1-9])(?![0-9]))?)([^\\\\/]*)$</regexp> 
<regexp>[\._ -]()[Ee][Pp]_?([0-9]+)([^\\/]*)$</regexp> 
<regexp>([0-9]{4})[\.-]([0-9]{2})[\.-]([0-9]{2})</regexp> 
<regexp>([0-9]{2})[\.-]([0-9]{2})[\.-]([0-9]{4})</regexp> 
<regexp>[\\/\._ \[\(-]([0-9]+)x([0-9]+)([^\\/]*)$</regexp> 
<regexp>[\\/\._ -]([0-9]+)([0-9][0-9])([\._ -][^\\/]*)$</regexp> 
<regexp>[\/._ -]p(?:ar)?t[_. -]()([ivx]+)([._ -][^\/]*)$</regexp> 
</tvshowmatching>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)
:* Paths are converted to lower case before matching.
:* For multi-episode matching to work, there needs to be a third set of parentheses '()' at the end, this part is fed back into the regexp engine.
:* A [https://forum.kodi.tv/showthread.php?tid=51614 forum thread] has a discussion of pre-made regex lists to match common names. These might improve Kodi's ability to match TV show names in some situations, at the risk of additional false positives.

==== Filenames without Season ====
There are two methods to add episodes without a season in their file path. Both ways will force the season to '1' by default, so that you can use
the 'Use Absolute Ordering (Single Season)' setting from the TheTvDb.com scraper.

; Simple Method ''(XBMC v9.11 onwards and Kodi)''
: Use only one pair of parentheses
<syntaxhighlight lang=xml enclose="div"><regexp>[/\._ \-]([0-9]+)</regexp></syntaxhighlight>
; Advanced Method ''(XBMC v10.05 onwards and Kodi)''
: Supports multi-episode files without season
: Use an empty pair of parentheses for the season
<syntaxhighlight lang=xml enclose="div"><regexp>[/\._ \-]()([0-9]+)(-[0-9]+)?</regexp></syntaxhighlight>

; Specifying Default Season ''(XBMC v12.0 onwards and Kodi)''
It is possible to set the default season for specific regular expressions by setting the 'defaultseason' attribute.
: Works with both the simple method and advanced method
: If not used, the season will be set to '1'
: Useful for setting specials to season '0'
<syntaxhighlight lang=xml enclose="div"><regexp defaultseason="0">[/\._ \-]X()([0-9]+)(-[0-9]+)?</regexp>
<regexp defaultseason="1">[/\._ \-]E()([0-9]+)(-[0-9]+)?</regexp></syntaxhighlight>

=== tvmultipartmatching ===
{{anchor|.3Ctvmultipartmatching.3E}}
Matches a multipart episode number based on a previously identified episode file, using a list of Regular Expressions.

Default:
<syntaxhighlight lang=xml enclose="div">
<tvmultipartmatching>^[-_ex]+([0-9]+(?:(?:[a-i]|\\.[1-9])(?![0-9]))?)</tvmultipartmatching>
</syntaxhighlight>
:* Text matching is compared case-insensitive.
:* Specifying this option '''replaces''' the default value

=== excludefromscan ===
{{anchor|.3Cexcludefromscan.3E}}
Matches filenames or folders which should be excluded from a library scan (except tvshows) using a list of Regular Expressions. This can be for both Video or Audio sections of <tt>advancedsettings.xml</tt>.

Defaults:
<syntaxhighlight lang=xml enclose="div">
<video>
<excludefromscan>
<regexp>-trailer</regexp>
<regexp>[!-._ \\/]sample[-._ \\/]</regexp>
</excludefromscan>
</video>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)

=== excludefromlisting ===
{{anchor|.3Cexcludefromlisting.3E}}
<syntaxhighlight lang=xml enclose="div">
<video>
<excludefromlisting> 
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromlisting>
</video>
</syntaxhighlight>

=== excludetvshowsfromscan ===
{{anchor|.3Cexcludetvshowsfromscan.3E}}
Matches filenames or folders which should be excluded from a tvshow library scan using a list of Regular Expressions

Defaults:
<syntaxhighlight lang=xml enclose="div">
<video>
<excludetvshowsfromscan>
<regexp>[!-._ \\/]sample[-._ \\/]</regexp>
</excludetvshowsfromscan>
</video>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)

=== trailermatching ===
{{anchor|.3Ctrailermatching.3E}}
Contains Regular Expression syntax to match the locally stored trailers to movies in the library.

<syntaxhighlight lang=xml enclose="div">
<trailermatching>

<regexp>(.*?)(_Trailer)(\.[^.]+)$</regexp>
</trailermatching>
</syntaxhighlight>

=== videolibrary ===
{{anchor|.3Cvideolibrary.3E}}
Options specific to the Video Library

{{Note|Kodi v20 users don't need set "importwatched" or "importresumepoint" to true anymore as that's the default then <ref>https://github.com/xbmc/xbmc/pull/20842</ref>}}

<syntaxhighlight lang="xml" line='line'>
<videolibrary>
<allitemsonbottom>false</allitemsonbottom> 
<cleanonupdate>false</cleanonupdate> 
<usefasthash>true</usefasthash> 
<recentlyaddeditems>35</recentlyaddeditems> 
<itemseparator> / </itemseparator> 
<exportautothumbs>false</exportautothumbs> 
<importwatchedstate>false</importwatchedstate> 
<importresumepoint>false</importresumepoint> 
<dateadded>1</dateadded> 
</videolibrary>
</syntaxhighlight>

=== videoscanner ===
{{anchor|.3Cvideoscanner.3E}}
Options specific to the Video scanner
<syntaxhighlight lang=xml enclose="div">
<videoscanner>
<ignoreerrors>true</ignoreerrors> 
</videoscanner>
</syntaxhighlight>

== Library artwork ==

{{note|Using <imageres>9999</imageres> and <fanartres>9999</fanartres> will allow caching artwork at original size.}}

=== imageres ===
{{anchor|.3Cimageres.3E}}

<section begin="imageres description" />Specify the maximum resolution that [[Artwork/Cache#Texture optimization| cached artwork]] (other than fanart / 16:9 images) should be resized to in pixels. The width is automatically calculated as being 16/9*height. The image will be resized to fit within this size. e.g. an image that is 2000x500 will be cached at size 1280x320. An image that is 500x800 will be cached at size 450x720 using the default value of 720.<section end="imageres description" />

<syntaxhighlight lang=xml enclose="div">
<imageres>720</imageres>
</syntaxhighlight>

=== fanartres ===
{{anchor|.3Cfanartres.3E}}

<section begin="fanartres description" />Specify the maximum resolution that [[Artwork/Cache#Texture optimization| cached fanart]] should be resized to in pixels. The width is automatically calculated as being 16/9*height. Only images that are exactly 16x9 and equal to or greater than this resolution will be cached at this size - all other images will be cached using <imageres>. The default value is 1080.<section end="fanartres description" />

<syntaxhighlight lang=xml enclose="div">
<fanartres>1080</fanartres>
</syntaxhighlight>

=== imagescalingalgorithm ===
Specify the image scaling algorithm for image resizing when [[Artwork/Cache#Texture optimization| caching artwork]] to the local texture cache.
<br />
<syntaxhighlight lang=xml enclose="div">
<imagescalingalgorithm>bicubic</imagescalingalgorithm>
</syntaxhighlight>

[https://github.com/xbmc/xbmc/blob/master/xbmc/pictures/PictureScalingAlgorithm.cpp#L20-L32 Available image scaling algorithms]

<syntaxhighlight lang=text enclose="div">
fast_bilinear
bilinear
bicubic
experimental
nearest_neighbor
averaging_area
bicublin
gaussian
sinc
lanczos
bicubic_spline
</syntaxhighlight>

=== imagequalityjpeg ===
This specifies the quality of the images when stored in jpeg format. By default kodi uses a quality of 4 which is a good compromise between size and quality. If you want to reduce the thumbnail sizes (decreasing quality) choose a higher value up to 21. If high quality (large thumbnail size) is needed, chose a smaller value, e.g. 0,1,2 or 3. (Added in v20 <ref>https://github.com/xbmc/xbmc/pull/21418</ref>)
<br />
<syntaxhighlight lang=xml enclose="div">
<imagequalityjpeg>4</imagequalityjpeg>
</syntaxhighlight>

== Video and music library settings ==

=== playlistasfolders ===
{{anchor|.3Cplaylistasfolders.3E}}
In the recent releases, playlists are treated as folders. Selecting a playlist no longer plays it, but opens it, as if it were a folder.

Set to false to revert to the previous behaviour. When you select a playlist, its content is added to the list of elements to be played.

:{{note|This setting will not affect smart playlists, they will always show as folders.}}

;Example
<syntaxhighlight lang=xml enclose="div">
<playlistasfolders>true</playlistasfolders>
</syntaxhighlight>

=== playlistretries ===
{{anchor|.3Cplaylistretries.3E}}
The number of retries attempted if a source is offline. With this control you can alter the number of consecutive failed items before a playlist fails.

Default:
<syntaxhighlight lang=xml enclose="div">
<playlistretries>100</playlistretries>
</syntaxhighlight>

=== playlisttimeout ===
{{anchor|.3Cplaylisttimeout.3E}}
The timeout, in seconds, before item failure.

Default:
<syntaxhighlight lang=xml enclose="div">
<playlisttimeout>20</playlisttimeout>
</syntaxhighlight>

=== sorttokens ===
Allows you to specify additional tokens that will be ignored at the start of lines during sorting.
{{note|Sort tokens are case sensitive.}}
<syntaxhighlight lang=xml enclose="div">
<sorttokens>
<token>the</token>
</sorttokens>
</syntaxhighlight>

In the above example "the ", "the." and "the_" will be ignored at the start of titles or names when sorting items, in both video and music libraries. A separator can also be specified, for example
<syntaxhighlight lang=xml enclose="div">
<sorttokens>
<token separators="'">L</token>
</sorttokens>
</syntaxhighlight>
In that case the value L', as in French movie name ''L'argent'', will be ignored and the item listed under "A".

=== musicdatabase/videodatabase ===
{{anchor|.3Cmusicdatabase.3E/.3Cvideodatabase.3E|musicdatabase/videodatabase|database tags music/video/tv/epg/adsp}}
{{main|MySQL}}
<section begin="videodatabase" />
Allows advanced customization of the default database settings for music, video, TV, EPG, and ADSP databases.

:{{note| '''It is HIGHLY recommended that you not attempt to place an sqlite3 database outside of kodi's path. sqlite3 contains no filesystem abstraction, so this will plain break on any non-local (as far as Kodi is concerned) paths. Use this for mysql only.'''}}

'''Parent tags:'''

* '''<videodatabase>'''
* '''<musicdatabase>'''
* '''<tvdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''
* '''<epgdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''
* '''<adspdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''
{{MySQL warning}}

'''Child tags: '''

;<type>
: ''Required'' - Can be either "sqlite3" or "mysql" (default: sqlite3)

;<host>
:''Required'' -
* sqlite3: defines the relative path to the database file (eg. /usr/local/kodi/databases).
* mysql: defines the host of the mysql socket (eg. localhost, 192.168.0.1, etc)

;<port>
: ''Optional'' -
* sqlite3: silently ignored
* mysql: defines the port of the mysql socket (default: 3306)

;<name>
: ''Optional'' -
:by default "MyVideos"+DB number will be used.
* sqlite3: defines the name of the database file to read from, excluding the ".db" extension.
* mysql: defines the name of the database to use

;<user>
: ''Required for MySQL'' -
* sqlite3: silently ignored
* mysql: defines the user with privileged access to the database

;<pass>
: ''Required for MySQL'' -
* sqlite3: silently ignored
* mysql: defines the password for the user with privileged access to the database

;<compression>
: ''Optional'' - Defaults to false. Set to "true" to enable MySQL compression protocol. Performance benefit is going to be largely dependent on the network bandwidth, latency between database and clients and on the size of the result sets. [https://github.com/xbmc/xbmc/pull/6484]
: {{Note|Slower clients (such as the RPi and others) won't benefit from it as the zlib de-compression overhead is higher than the actual compression savings}}

;<key>
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

;<cert>
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

;<ca>
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

;<capath>
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

;<ciphers>
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

'''Examples:'''

1) Configure a database for MySQL.
:{{note| ''The '''<videodatabase>''', '''<musicdatabase>''', '''<tvdatabase>''', '''<epgdatabase>''', and '''<adspdatabase>''' tags are interchangeable here.''}}
<syntaxhighlight lang=xml enclose="div">
<videodatabase>
<type>mysql</type>
<host>192.168.0.10</host>
<name>kodi_video</name>
<user>kodi</user>
<pass>kodi</pass>
</videodatabase>
</syntaxhighlight>

2) Configure a database for an sqlite database.
:{{note| ''The '''<videodatabase>''', '''<musicdatabase>''', '''<tvdatabase>''', '''<epgdatabase>''', and '''<adspdatabase>''' tags are interchangeable here.''}}
<syntaxhighlight lang=xml enclose="div">
<musicdatabase>
<type>sqlite3</type>
<host>/usr/local/share/kodi/databases</host>
</musicdatabase>
</syntaxhighlight>

<section end="videodatabase" />

=== externalplayer ===
{{anchor|.3Cexternalplayer.3E}}
{{see|External players}}

== Music settings ==

=== musicextensions ===
{{anchor|.3Cmusicextensions.3E}}
<section begin="musicextensions" />
Default extensions for MUSIC:
<pre>
.nsv .m4a .flac .aac .strm .pls .rm .rma .mpa .wav .wma .ogg .mp3 .mp2 .m3u .gdm .imf .m15 .sfx
.uni .ac3 .dts .cue .aif .aiff .wpl .xspf .ape .mac .mpc .mp+ .mpp .shn .zip .wv .dsp .xsp .xwav
.waa .wvs .wam .gcm .idsp .mpdsp .mss .spt .rsd .sap .cmc .cmr .dmc .mpt .mpd .rmt .tmc .tm8
.tm2 .oga .url .pxml .tta .rss .wtv .mka .tak .opus .dff .dsf .m4b .dtshd
</pre>

It is possible to add or remove extensions for Music, using the following XML tags. Useful if you keep, say, FLAC and mp3 versions of music in the same folder. The <remove> tag can be used to remove mp3 from being listed in the library, leaving only the higher quality FLAC being displayed.

<musicextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</musicextensions>

<section end="musicextensions" />

=== cddbaddress ===
{{anchor|.3Ccddbaddress.3E}}
The address of the online CDDb database. You may set this to another freedb mirror if there is a more suitable one.

Default:
<syntaxhighlight lang=xml enclose="div>
<cddbaddress>freedb.freedb.org</cddbaddress>
</syntaxhighlight>

=== songinfoduration ===
{{anchor|.3Csonginfoduration.3E}}
This controls how long the song information will remain onscreen when the song changes during visualisations. The valid range is "1" to "Indefinite (0)", in seconds. This does not include the duration of any transition effects.

Default:
<syntaxhighlight lang=xml enclose="div">
<songinfoduration>10</songinfoduration>
</syntaxhighlight>

=== musicfilenamefilters ===
{{anchor|.3Cmusicfilenamefilters.3E}}
Contains filters to match music information (artist, title etc.) from a tag-less music filename. The first <filter> to match completely is used. Matched items include:

<pre>
%A - Artist
%T - Title
%B - Album
%N - Track number
%S - Part of set (disk number)
%D - Duration
%G - Genre
%Y - Year
%R - Rating
</pre>

Example:
<syntaxhighlight lang=xml enclose="div">
<musicfilenamefilters>
<filter>%A - %T</filter>
</musicfilenamefilters>
</syntaxhighlight>

=== musiclibrary ===
Options specific to the Music Library
<section begin="MusicLibrary" />
<syntaxhighlight lang="xml" line='line'>
<musiclibrary>
<allitemsonbottom>true</allitemsonbottom> 
<cleanonupdate>false</cleanonupdate> 
<recentlyaddeditems>35</recentlyaddeditems> 
<albumformat>%B - %Y</albumformat> 
<prioritiseapetags>true</prioritiseapetags> 
<itemseparator> / </itemseparator> 
<artistseparators> 
<separator>;</separator>
<separator>:</separator>
<separator>|</separator>
<separator> feat. </separator>
<separator> ft. </separator>
</artistseparators>
<dateadded>1</dateadded> 


<useisodates>false</useisodates> 
</musiclibrary>
</syntaxhighlight>
{{Note|Changing the <itemseparator> or <artistseparators> will only affect newly added items. A rescan won't change the existing ones. Remove the Source(s) or delete the Music DB and rebuild. This process should be made easier from v18 and up using <promptfulltagscan>}}<section end="MusicLibrary" />

== Photos settings ==

=== pictureextensions ===
{{anchor|.3Cpictureextensions.3E}}
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Pictures window.

Default extensions for PICTURES:
<pre>
.png .jpg .jpeg .bmp .gif .ico .tif .tiff .tga .pcx .cbz .zip .rss .webp .jp2 .apng
</pre>

Examples:
<syntaxhighlight lang=xml enclose="div">
<pictureextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</pictureextensions>
</syntaxhighlight>

=== pictureexcludes ===
{{anchor|.3Cpictureexcludes.3E}}
Matches filenames or folders which should be excluded from being displayed in My Pictures using a list of Regular Expressions

<syntaxhighlight lang=xml enclose="div">
<pictureexcludes> 
<regexp>small</regexp>
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</pictureexcludes>
</syntaxhighlight>

=== slideshow ===
{{anchor|.3Cslideshow.3E}}
<syntaxhighlight lang=xml enclose="div">
<slideshow>

<panamount>2.5</panamount>

<zoomamount>5.0</zoomamount>



<blackbarcompensation>20</blackbarcompensation>
</slideshow>
</syntaxhighlight>

== Network settings ==

=== ftp ===
{{anchor|.3Cftp.3DE}}
Specific settings if a ftp server is in use as a source

<syntaxhighlight lang=xml enclose="div">
<ftp>
<remotethumbs>true</remotethumbs> 
</ftp>
</syntaxhighlight>

=== samba ===
{{anchor|.3Csamba.3E}}
<syntaxhighlight lang=xml enclose="div">
<samba>
<doscodepage></doscodepage> 
<clienttimeout>10</clienttimeout> 
<statfiles>true</statfiles> 
</samba>
</syntaxhighlight>

=== hosts ===
{{anchor|.3Cfhosts.3E}}
Static dns entries which take precedence over your dns server.
<syntaxhighlight lang=xml enclose="div">
<hosts>
<entry name="HOSTNAME">IPADDRESS</entry>
</hosts>
</syntaxhighlight>

=== network ===
{{anchor|.3Cnetwork.3E}}

<syntaxhighlight lang=xml line='line'>
<network>
<curlclienttimeout>10</curlclienttimeout> 
<curllowspeedtime>20</curllowspeedtime> 
<curlretries>2</curlretries> 
<httpproxyusername></httpproxyusername> 
<httpproxypassword></httpproxypassword> 
<disableipv6>false</disableipv6> 
<disablehttp2>false</disablehttp2> 
<nfstimeout>30</nfstimeout> 
<catrustfile>filepath</catrustfile> 
<curlkeepaliveinterval>30</curlkeepaliveinterval> 
<nfsretries>0</nfsretries> 
</network>
</syntaxhighlight>

'''More information:'''<br>
* <curlkeepaliveinterval><ref>https://github.com/xbmc/xbmc/pull/19319</ref><br>
* <nfsretries><ref>https://github.com/xbmc/xbmc/pull/19513</ref>

=== cache ===
{{see also|HOW-TO:Modify_the_video_cache}}
<syntaxhighlight lang=xml enclose="div">
<cache>
<memorysize>0</memorysize> 
<buffermode>0</buffermode> 
<readfactor>4.0</readfactor> 
<chunksize>65536</chunksize> 
</cache>
</syntaxhighlight>

=== airtunesport ===
{{anchor|.3Cairtunesport.3E}}<section begin="airtunesport" />
This overwrites the defalt listening port of the AirTunes server (announced via zeroconf).
<section end="airtunesport" />

=== airplayport ===
{{anchor|.3Cairplayport.3E}}<section begin="airplayport" />
This overwrites the default listening port of the AirPlay server (announced via zeroconf).
<section end="airplayport" />

== File system settings ==

=== packagefoldersize ===
<section begin="packagefoldersize" />
{{anchor|.3Cpackagefoldersize.3E}}
{{xml setting
| tag name = packagefoldersize
| option type = numerical
| option values =
| default values = 200
| platform = all
| XBMC version = 12
| description = The amount (in megabytes) of add-on zip packages saved from previous add-on installs. These packages are mainly used for the [[Add-ons|add-on]] rollback feature. Increasing the size should increase the amount of past versions saved. Defaults to 200 MB.
| example = Example: <syntaxhighlight lang=xml enclose="div"><packagefoldersize>200</packagefoldersize> </syntaxhighlight>
}}
<section end="packagefoldersize" />

=== detectasudf ===
{{anchor|.3Cdetectasudf.3E}}
{{xml setting
| tag name = detectasudf
| option type = binary
| option values = true, false
| default values = false
| platform = all
| XBMC version =
| description = Set to true if you wish to detect joint ISO9660/UDF disks as UDF.
| example = Example: <syntaxhighlight lang=xml enclose="div"><detectasudf>false</detectasudf></syntaxhighlight>
}}

=== handlemounting ===
{{anchor|.3Chandlemounting.3E}}
{{xml setting
| tag name = handlemounting
| option type = binary
| option values = true, false
| default values = false
| platform = Linux
| XBMC version =
| description = Only used in Linux, it defines if Kodi should attempt to mount media drives (via udisks or udisks2).<br/>Default: False. If kodi is executed with the --standalone option (e.g. as done by kodi-standalone.sh) it by default will be True.
| example = Example: <syntaxhighlight lang=xml enclose="div"><handlemounting>false</handlemounting></syntaxhighlight>
}}

=== automountopticalmedia ===
{{xml setting
| tag name = automountopticalmedia
| option type = binary
| option values = true, false
| default values = false
| platform = Linux
| XBMC version =
| description = Only used in linux for the udisks and udisks2 providers<br/>defines if kodi should automount optical discs<ref>https://github.com/xbmc/xbmc/pull/20840</ref>
| example = Example: <syntaxhighlight lang=xml enclose="div"><automountopticalmedia>true</automountopticalmedia></syntaxhighlight>
}}

=== pathsubstitution ===
{{anchor|.3Cpathsubstitution.3E}}
{{main|Path substitution}}

{{divbox|red||'''Note:''' Path substition for "sources" and profiles is broken, and will '''NOT''' be fixed.}}

Path substitutions are for use for redirecting file paths. These are processed in order, and are useful for substituting an absolute path on a PC with a path suitable for Kodi to handle.

Default: No path substitutions defined.

Example:
<syntaxhighlight lang=xml enclose="div">
<pathsubstitution>
<substitute>
<from>G:\dvds\</from>
<to>smb://somecomputer/g-share/dvds/</to> 
</substitute>
</pathsubstitution>
</syntaxhighlight>

== Input control settings ==

=== remotedelay ===
{{anchor|.3Cremotedelay.3E}}
The repeat delay for a LIRC remote control. A delay value between 1 and 20 before a remote button starts repeating on a long keypress (i.e. continuously sending button pushes while it's held down).

Default: 3
<syntaxhighlight lang=xml enclose="div">
<remotedelay>10</remotedelay>
</syntaxhighlight>

=== controllerdeadzone ===
{{anchor|.3Ccontrollerdeadzone.3E}}
This advanced settings has been removed.
Since v17, the [[Advancedsettings.xml#controllerdeadzone|<controllerdeadzone>]] advanced setting has been removed. Deadzones can now be configured by plugging in the controller and selecting it in Settings -> System settings -> Input -> Peripherals.

=== enablemultimediakeys ===
{{anchor|.3Cenablemultimediakeys.3E}}
This setting only has any effect on Windows versions of Kodi, and only applies to builds from 28th May 2011 onwards.
In Windows the multimedia keys generate a WM_APPCOMMAND message in addition the keypress. Kodi processes both keypresses and the WM_APPCOMMAND messages, and the end result would be that the command is executed twice. To avoid this, by default multimedia keypresses are disabled. Although it should rarely be necessary, the enablemultimediakeys setting allows you to enable the multimedia keys.

Example:
<syntaxhighlight lang=xml enclose="div">
<enablemultimediakeys>true</enablemultimediakeys>
</syntaxhighlight>

=== seeksteps ===
{{Main|Skip steps}}

This setting changes which increments are available in the settings GUI for additive seeking. Note that <code><seeksteps></code> is not used to actually choose which seek steps are enabled.

'''Default:'''
<syntaxhighlight lang=xml enclose="div">
<seeksteps>7, 15, 30, 60, 180, 300, 600, 900, 1800</seeksteps>
</syntaxhighlight>

{{editor note|the defaults need to be updated for seeksteps.}}

=== touchscreen ===
{{anchor|.3Ctouchscreen.3E}}
This setting allows you to move/align the origin of the touch screen with the origin of the display used. If touch input does not result in a correct movement of the mouse pointer, the behaviour can be corrected with an offset and a stretch/compress factor.

Example:
<syntaxhighlight lang=xml enclose="div">
<touchscreen>
<x_offset>0</x_offset> 
<y_offset>0</y_offset> 
<x_stretch_factor>1.0</x_stretch_factor> 
<y_stretch_factor>1.0</y_stretch_factor> 
</touchscreen>
</syntaxhighlight>

=== scanirserver ===
Introduced in v18 and used in MS Windows setups only.<ref>https://github.com/xbmc/xbmc/pull/13896</ref>
Used to disable the regular connection attempts to the IR Server Suite when there is no remote to connect to.

The default setting is to allow connection attempts. To disable connection attempts change value to '''false'''.
<syntaxhighlight lang=xml enclose="div">
<scanirserver>true</scanirserver>
</syntaxhighlight>

== Other interface settings ==

=== window ===
{{anchor|.3Cwindow.3E}}
{{note|This is a "hidden" guisettings.xml setting (defined by the mouse moving the window size), but it is mentioned here because it is a particularly useful override when used in advancedsettings.xml}}
This allows you to manually set the default size of Kodi's windowed mode. If you resize the window, it will return to the set size when restarting.

WIDTH and HEIGHT are the values for each dimension, in pixels.

<syntaxhighlight lang=xml enclose="div">
<window>
<width>WIDTH</width>
<height>HEIGHT</height>
</window>
</syntaxhighlight>

=== restrictcapsmask ===
{{anchor|.3Crestrictcapsmask.3E}}
Windows only. A bitmask to prevent Kodi from using detected texture capabilities of the GPU. This helps work around buggy hardware/drivers.

1: prevent the use of compressed textures (DXT1, DXT3, DXT5)
2: prevent the use of non-power-of-two dimensions for textures
4: prevent the use of compressed textures with non-power-of-two dimensions.

<syntaxhighlight lang=xml enclose="div">
<restrictcapsmask>0</restrictcapsmask>
</syntaxhighlight>

=== algorithmdirtyregions ===
{{anchor|.3Calgorithmdirtyregions.3E}}
{{see also|HOW-TO:Modify dirty regions}}
<section begin="algorithmdirtyregions" />{{note|Some GPU/hardware configurations will have some minor issues (such as a visual "flicker"). For those situations try mode 2 or use the default (mode 3, which requires no advancedsetting). Almost all ARM-based devices (such as [[Android]]) willl likely have flickering issues.}}

Enable dirty-region processing. Dirty regions are any parts of the screen that have changed since the last frame. By not re-rendering what hasn't changed the GUI can be sped up. Because all GPUs work differently, only Mode 3 is guaranteed to work for everyone without flickering issues. This mode will reduce CPU/GPU usage, but will not increase GUI speed.

{| class="prettytable"
! value !! result !! description
|-
! 0
| Off
| The entire viewport is always rendered.
|-
! 1
|Union
|All dirty regions are grouped into the smallest possible rectangle. This is typically the fastest mode for slower GPUs due to only making one pass.
|-
! 2
| {{nowrap|Cost reduction}}
| Each dirty region is presented separately, in as many passes as there are regions.
|-
! 3
| {{nowrap|Whole Screen}}
| The entire screen is rendered if there are any dirty regions. This is a safe default for drivers that clear buffer contents (manifests as blinking or vibrating images). '''Default'''
|}<section end="algorithmdirtyregions" />

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<algorithmdirtyregions>1</algorithmdirtyregions>
</gui>
</syntaxhighlight>

=== visualizedirtyregions ===
{{anchor|.3Cvisualizedirtyregions.3E}}
{{see also|HOW-TO:Modify dirty regions}}
<section begin="visualizedirtyregions" />Enable dirty-region visualization. Paints a rectangle over marked controls.

* true: on
* false: off '''(Default)'''

{{note|This is only a development mode and isn't of use to normal users.}}
<section end="visualizedirtyregions" />
Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<visualizedirtyregions>true</visualizedirtyregions>
</gui>
</syntaxhighlight>

=== smartredraw ===

{{note|This is an experimental feature and you might face issues using it. So please be aware of that.}}

This new feature was introduced in Kodi 18 and if enabled, the GUI process call (and therefore the render call) is only done if anything has changed. The result will be a faster GUI and less load if Kodi plays a video

* true: on
* false: off '''(Default)'''

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<smartredraw>true</smartredraw>
</gui>
</syntaxhighlight>

=== showexitbutton ===
{{anchor|.3Cshowexitbutton.3E}}
Setting to hide the exit button, useful for people running appliance based setups where exit would only confuse/complicate the user. Modifiable via the advancedsettings.xml by setting showexitbutton to false, default is true (show)

Example:
<syntaxhighlight lang=xml enclose="div">
<showexitbutton>true</showexitbutton>
</syntaxhighlight>

=== fullscreen ===
{{anchor|.3Cfullscreen.3E}}
Starts Kodi in full screen (check resolutions!).

<syntaxhighlight lang=xml enclose="div">
<fullscreen>false</fullscreen>
</syntaxhighlight>

=== splash ===
{{anchor|.3Csplash.3E}}
Set to false if you wish to disable the startup splash image. Defaults to true.

<syntaxhighlight lang=xml enclose="div">
<splash>true</splash>
</syntaxhighlight>

=== cputempcommand ===
{{anchor|.3Ccputempcommand.3E}}
Provide a shell command Kodi will use to get CPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]".<br />
;<u>For Nvidia and Raspberry Pi</u>
<syntaxhighlight lang=xml enclose="div">
<cputempcommand>sed -e 's/$[0-9]*$[0-9]\{3\}.*/\1 C/' /sys/class/thermal/thermal_zone0/temp</cputempcommand>
</syntaxhighlight>
or
<syntaxhighlight lang=xml enclose="div">
<cputempcommand>echo "$(sensors -u | tail -n64 | grep temp1_input | awk '{print $2 }' |awk '{printf("%d\n",$1 + 0.5);}') C"</cputempcommand>
</syntaxhighlight>
;<u>For ATI/AMD</u>
<syntaxhighlight lang=xml enclose="div">
<cputempcommand>sensors|sed -ne "s/temp1: \+[-+]$[0-9]\+$.*/\1 C/p"</cputempcommand>
</syntaxhighlight>

=== gputempcommand ===
{{anchor|.3Cgputempcommand.3E}}
Provide a shell command Kodi will use to get GPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]".<br />
;<u>For Nvidia</u>
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>echo "$(nvidia-settings -tq gpuCoreTemp) C"</gputempcommand>
</syntaxhighlight>
or
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>echo "$(nvidia-smi -q -d TEMPERATURE | grep Gpu | cut -c35-36) C"</gputempcommand>
</syntaxhighlight>
;<u>For ATI/AMD</u>
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>/usr/bin/aticonfig --od-gettemperature | grep Temperature | cut -f 2 -d "-" | cut -f 1 -d "." | sed -e "s, ,," | sed 's/$/ C/'</gputempcommand>
</syntaxhighlight>

;<u>For Raspberry Pi</u>
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>/opt/vc/bin/vcgencmd measure_temp | sed -e "s/temp=//" -e "s/\..*'/ /"</gputempcommand>
</syntaxhighlight>

=== glrectanglehack ===
{{anchor|.3Cglrectanglehack.3E}}
Problems with ghosting or videos which are only played back in the left upper quarter? The following ATI hack may solve it.
<syntaxhighlight lang=xml enclose="div">
<glrectanglehack>yes</glrectanglehack>
</syntaxhighlight>

=== alwaysontop ===
{{anchor|.3Calwaysontop.3E}}
Added in XBMC v9.11 (Windows OS only). Keeps Kodi always on top when windowed.
<syntaxhighlight lang=xml enclose="div">
<alwaysontop>yes</alwaysontop>
</syntaxhighlight>

There is also a fake fullscreen GUI option in Kodi's settings.

=== minimizetotray ===
{{anchor|.3Cminimizetotray.3E}}
{{note|Available in Kodi v20 and above.}}

Windows only. Minimizes Kodi to the system tray. Defaults to false.
<syntaxhighlight lang=xml enclose="div">
<minimizetotray>true</minimizetotray>
</syntaxhighlight>

= Removed tags =
{{anchor|Recently removed tags}}
* {{anchor|.3Cthumbsize.3E}}'''<thumbsize>''' - replaced by <[[#imageres|imageres]]> in v12 Frodo
* {{anchor|.3Cfanartheight.3E}}'''<fanartheight>''' - replaced by <[[#fanartres|fanartres]]> in v12 Frodo
* {{anchor|.3Cdvdthumbs.3E}}'''<dvdthumbs>''' - removed in v12 Frodo
* {{anchor|.3Cbusydialogdelayms.3E}}'''<busydialogdelayms>''' - removed in v12 Frodo
* {{anchor|.3Cbginfoloadermaxthreads.3E}}'''<bginfoloadermaxthreads>''' - removed in v13 Gotham
* '''<showepginfoonselect>''' - replaced by a GUI setting in v13 Gotham
* '''<resample>''', '''<forceDirectSound>''', '''<audiophile>''', '''<audiosinkbufferdurationmsec>''', '''<allowtranscode44100>''', and '''<streamsilence>''' - These were various sub-tags for <audio> that were removed in v13 Gotham and either replaced by GUI settings or were no longer needed.
* {{anchor|.3Cenableairtunesdebuglog.3E}}'''<enableairtunesdebuglog>''' - replaced by a GUI option in v14 Helix
* '''<videoDisableHi10pMultithreading>''' - renamed to <disableswmultithreading> in v14 Helix
* '''<hideallitems>''' - For both the <code><videolibrary></code> and <code><musiclibrary></code> sections, this is replaced by a GUI option in v15 Isengard
* '''<SmallStepBackSeconds>''' - In v15 the <code>SmallStepBack</code> [[Action_IDs]] has been replaced by <code>seek(-7)</code> in default keymaps. See '''[[skip steps]]''' for details. When the original <code>SmallStepBack</code> action ID is used it defaults to the first backwards [[skip steps|additive seeking value]].
* '''<timeseekforward>/<timeseekbackward>''' - In v15 these tags are replaced by GUI options via [[skip steps|additive seeking]], which is configured in the GUI. See '''[[skip steps]]''' for details.
* {{anchor|.3Ckaraoke.3E}}'''<karaoke>''' - In v16 all of the karaoke features in Kodi were removed.
* '''<useddsfanart>''' - removed in v17 Krypton.
* '''<cachemembuffersize>''' and '''<readbufferfactor>''' - In v17 '''<cachemembuffersize>''' is renamed to '''<memorysize>''' and <code><readbufferfactor></code> is renamed to <code><readfactor></code>. In addition, all three buffer related settings in <network> are moved out of <network> and into a new <cache> parent tag.
* '''<minvideocachelevel>''', '''<minaudiocachelevel>''', and '''<cacheindvdplayer>''' have been removed in v17.
* '''<useffmpegvda>''' - Tag was only used for development testing. Removed in v17.
* '''<nofliptimeout>''' - Removed in v17
* '''<blackbarcolour>''' - Removed in v17 (maybe?)
* '''<disableswmultithreading>''' - Removed in v17 (maybe?)
* '''<controllerdeadzone>''' - Removed in v17
* {{anchor|.3Cmeasurerefreshrate.3E}}'''<measurerefreshrate>''' - Removed in v17 or v18?
* {{anchor|.3Cmyth.3E}}'''<myth>''' - Removed sometime between v16 to v18
* {{anchor|.3Ctuxbox.3E}}'''<tuxbox>''' - Removed
* '''<backgroundupdate>''' - Removed
* '''<hideemptyseries>''' - Replaced by a GUI option.
* '''<mymovies>''' and child tag '''<categoriestogenres>''' - Removed
* '''<albumssortbyartistthenyear'''> - Removed
* '''<albumformatright>''' - Removed
* {{anchor|.3Cremoterepeat.3E}}'''<remoterepeat>''' - Removed
* {{anchor|.3Callowd3d9ex.3E}}'''<allowd3d9ex>''' and {{anchor|.3Cforced3d9ex.3E}}'''<forced3d9ex>''' - Removed sometime between v16 to v18
* '''<lingertime>''' - Replaced by a GUI setting in v18
* '''<forcevaapienabled>''' - Removed in v18
* '''<dxvaallowhqscaling>''' - Removed in v18 <ref>https://github.com/xbmc/xbmc/pull/15466</ref>
* '''<promptfulltagscan>false</promptfulltagscan>''' Removed in v18. Now automatically asked each time a scan is conducted.
* '''<omxdecodestartwithvalidframe>''' - This tag is only in some Raspberry Pi specific distributions, such as OpenELEC. As of March 2015, this tag has not been merged into "vanilla" Kodi builds
* '''<musicthumbs>''' Replaced in v19 by the GUI setting '''Thumbnail image files''' found in Media -> Music
* '''<artistextraart>''' Replaced in v19 by the GUI setting '''Artist art types whitelist''' found in Media -> Music
* '''<albumextraart>''' Replaced in v19 by the GUI setting '''Album art types whitelist''' found in Media -> Music
* '''<episodeextraart>''' Replaced in v19 by the GUI setting '''Episode art types whitelist''' found in Media -> Videos
* '''<tvshowextraart>''' Replaced in v19 by the GUI setting '''TV show art types whitelist''' found in Media -> Videos
* '''<tvseasonextraart>''' Replaced in v19 by the GUI setting '''TV show art types whitelist''' found in Media -> Videos
* '''<movieextraart>''' Replaced in v19 by the GUI setting '''Movie art types whitelist''' found in Media -> Videos
* '''<moviesetextraart>''' Replaced in v19 by the GUI setting '''Movie art types whitelist''' found in Media -> Videos
* '''<musicvideoextraart>''' Replaced in v19 by the GUI setting '''Music video art types whitelist''' found in Media -> Videos
* '''<fanart>''' Removed in v19
* '''<assfixedworks>''' Removed in v20
* '''<try10bitoutput>''' Removed in v20 and replaced with [[Settings/System/Display#Use_10_bit_for_SDR|Use 10 bit for SDR]] setting <ref>https://github.com/xbmc/xbmc/pull/20014</ref>
* '''<enablehighqualityhwscalers>''' Removed in v20 <ref>https://github.com/xbmc/xbmc/pull/21537</ref>

= guisettings.xml Setting Conversion =
It is possible to convert settings found in the '''[[Settings]]''' ''(guisettings.xml)'' pages of {{kodi}} into entries for the advancedsettings.xml file.

When a setting from the guisettings.xml is added to the advancedsettings.xml file, it will override the existing guisettings.xml values and the setting will be removed from the settings pages.

Why would I need to do this?
* You set up multiple devices and then need to individually change settings and preferences on each device. Using this conversion method, you save those settings in the advancedsettings.xml file and simply add the file to each device
* You need to hide settings to prevent those settings from being modified

To convert a guisetting to advancedsettings.xml follow these steps:
# In the {{kodi}} settings pages, adjust the setting(s) to your preference.
# Back out of the settings pages to the main menu, which forces {{kodi}} to save the adjusted settings to the guisettings.xml file
# Locate the guisettings.xml file in the [[Userdata]] folder and open it
# Locate the setting(s) to be converted. The list can be overwhelming so make use of the Search feature of whichever editor you are using
# Using the following setting as an example:
<syntaxhighlight lang="xml">
<setting id="videolibrary.showemptytvshows">true</setting>
</syntaxhighlight>
: Breaking down the string:
::'''videolibrary'''- parent tag
::'''showemptytvshows'''- child tag
::'''true'''- value
: The conversion is as follows and place this in the advancedsettings.xml file
<syntaxhighlight lang="xml">
<advancedsettings version="1.0">
<videolibrary>
<showemptytvshows>true</showemptytvshows>
</videolibrary>
</advancedsettings>
</syntaxhighlight>

'''Note:''' Some parent tags may already be in use in your advancedsettings.xml file. Do not duplicate them, but add the child tag beneath the existing parent tag.

= References =
<references />

{{Updated|18}}
{{DISPLAYTITLE:advancedsettings.xml}}

[[Category:Advanced topics]]
[[Category:Manual]]
[[Category:Settings]]

HOW-TO:Install Kodi for Android

2023-10-26T06:54:44Z

CastagnaIT: /* Google Play - stable */ add "TV" to android

{{mininav| [[Android]] }}
<section begin="intro" />This page describes how to install Kodi, either from an app "store" such as Google Play, or manually from an APK file.<section end="intro" />

= Installing Kodi from the Google Play Store =

== Google Play - stable ==

Kodi is now available on Google Play:

{{Google Play}}<br />
'''https://play.google.com/store/apps/details?id=org.xbmc.kodi'''

Google Play will automatically select which version (ARM(32bit), ARM(64bit) or x86) of Kodi you need, and will also automatically handle updates (unless you change your Google Play preferences).

{{#widget:YouTube|id=hmO_qVDoXCk}}

{{big|'''Files permissions on Android TV 11 or higher:'''}}

On Android TV 11 or higher by default Kodi dont have local files access permissions,
this means that if you try to open any local files through Kodi, these files although existing will not be visible.

To allow Kodi to have access to local files you need to manually set app files permissions.
On Android TV settings go to "Settings -> Apps - Kodi -> Permissions -> Files and Media" and select "Allow all the time".

== Google Play - beta testing ==
{{see also|Development builds}}

In order to test Kodi nightlies on your Android device, just download them from here:

http://mirrors.kodi.tv/nightlies/android/




{{note|Be sure to '''[[backup]]''' before you install this!

These alpha and beta builds are considered "semi stable", and contain the latest changes to Kodi. They may contain bugs and/or drastically change how the program works.}}

Please report any bugs and issues you come across to the '''[http://forum.kodi.tv Kodi forum]'''.



If you want to go back to the most recent stable version, uninstall the Kodi nightly first and reinstall Kodi either via Google Play or the manual installation which is explained in this article. Uninstalling the Kodi nightly and reinstalling Kodi will reset all Kodi settings. So make sure to '''[[backup]]''' your stable Kodi settings before testing nightlies and then restore from that backup once you have stable Kodi installed again.

= Manual installation =

== Enabling installation ==
===Android (normal)===
This includes installation instructions for phones, tablets and most boxes running Android.

Here's how to install Kodi from an .APK file. This is commonly known as "sideloading".

<gallery widths="500px" heights="313">
File:Android install step01.jpg|{{big|'''Step 1:'''}} First located the settings menu on your Android device and search for the "security" menu.
File:Android install step02.jpg|{{big|'''Step 2:'''}} Now enable "Unknown sources" option. This will allow you to directly install Kodi as easy as you would install it from Play Store.
</gallery>

=== Android TV ===
<gallery widths="500px" heights="313">
File:Android TV install step01.jpg|{{big|'''Step 1:'''}} From the Android TV launcher, scroll down to and select "Settings".
File:Android TV install step02.jpg|{{big|'''Step 2:'''}} From the "Settings" menu, scroll down and select the "Security & Restrictions" menu.
File:Android TV install step03.jpg|{{big|'''Step 3:'''}} In the "Security & Restrictions" menu, turn on "Unknown Sources".
</gallery>

== Download ==
Download Kodi for Android from the Kodi.tv servers. Official stable builds can be found here: '''http://kodi.tv/download/''' You need to either select the '''ARM''' or '''x86''' version depending on your hardware.

===Android TV===
# From a desktop computer or phone/tablet, go to http://play.google.com using the same Google account as used in your Android TV device.
# Install a browser such as Chrome. Select your Android TV box from the popup menu after clicking the install/get button.
# To make things easy, connect a USB or Bluetooth mouse.
# Open the browser either by voice remote (for example, say "Open Chrome") or from something such as Sideload Launcher.
# Follow the rest of the steps below for "'Normal' Android"

===Android (normal)===
<gallery widths="500px" heights="313px">
File:Android_install_step03.png|{{big|'''Step 1:'''}} Load up '''http://kodi.tv/download/''' in your Android web browser. Most users will want to use the '''ARM''' link, unless you have an Intel or AMD CPU. You may get a warning trying to download the file depending on which browser you use. You should say "OK" to actually download it.
File:Android_install_step04.png|{{big|'''Step 2:'''}} Wait for the "apk" to download.
</gallery>

== Install ==

Installing the Kodi app package is as simple as just finding the .apk you just downloaded and opening it up. You can do this either though the download menu in the web browser or selecting it with a file explorer.

<gallery widths="500px" heights="313px">
File:Android install step05.png| {{big|'''Step 1:'''}} After selecting the Kodi apk file you might be asked to select something to open it with. "Package installer", "Google Play", or some similar option will be what you want.
File:Android install step06.png| {{big|'''Step 2:'''}} You will get another confirmation screen where you will need to select "install".
File:Android install step07.png| {{big|'''Step 3:'''}} Wait for the installation to complete.
File:Android install step08.png| {{big|'''Step 4:'''}} You've now installed Kodi for Android!
File:Android install step09.png| {{big|'''First run:'''}} The first time you run Kodi it will take slightly longer than normal in order to finish some final installation steps. When it is done Kodi will open normally. This is only done once per installation/update, so the next time Kodi will start up a little faster.
File:Android install step10.png| {{big|'''All done!:'''}} Once started you are on Kodi home menu just like on any other platform.
</gallery>

If you are new to Kodi you might wish to check out this section of the wiki: '''[[First time user]]'''.

=== Install on Fire TV ===

{{#lst:HOW-TO:Install Kodi on Fire TV|intro}}
{{See also|HOW-TO:Install Kodi on Fire TV}}

== Tidy up ==

After Kodi has installed you can delete the downloaded Kodi APK file to save some disk space.

== Update ==
To update Kodi for Android simply follow the normal install steps with the newer version. All your settings and files will be preserved as they are located in a different place in the userdata folder. Be sure to make a backup of the userdata folder when doing updates in case something goes wrong.

{{note|Since Kodi for Android is signed with our own signatures you will be able to install all succeeding versions without a problem. If you are using a non-official version not signed by us you may be required to un-install Kodi and you will loose all your settings due to this. Be warned before trying.}}

== Uninstall ==

To un-install Kodi just go to your Android settings menu and select "apps". From there you will be able to un-install Kodi like any other Android app.

===Android (normal)===
{{note|Unlike other OSes, uninstalling Kodi on Android will also erase your [[Userdata|userdata folder]] and all of your settings.}}

<gallery widths="500px" heights="313px">
File:Android install step13.jpg| {{big|'''Step 1:'''}} Go into your Android "Settings" app and then select "Apps".
File:Android install step14.jpg| {{big|'''Step 2:'''}} Select Kodi from the list.
File:Android install step15.jpg| {{big|'''Step 3:'''}} Select uninstall and confirm.
</gallery>

===Android TV===
<gallery widths="500px" heights="313px">
File:Android TV install step12.jpg| {{big|'''Step 1:'''}} Go into your Android TV '''Settings''' menu and then select '''Apps'''.
File:Android TV install step13.jpg| {{big|'''Step 2:'''}} Go to the '''Downloaded apps''' then select Kodi.
File:Android TV install step14.jpg| {{big|'''Step 3:'''}} Select uninstall.
File:Android TV install step15.jpg| {{big|'''Step 4:'''}} Select Ok.
</gallery>

= See also =
* [[Android]]
* [[Android hardware]]
* [[Development builds]]

{{Updated|16}}

[[Category:Manual]]
[[Category:Installation|Android]]
[[Category:Android]]
[[Category:How-to]]

HOW-TO:Install Kodi for Android

2023-10-26T06:51:21Z

CastagnaIT: Google Play - stable - Add Android TV mandatory local files permissions

{{mininav| [[Android]] }}
<section begin="intro" />This page describes how to install Kodi, either from an app "store" such as Google Play, or manually from an APK file.<section end="intro" />

= Installing Kodi from the Google Play Store =

== Google Play - stable ==

Kodi is now available on Google Play:

{{Google Play}}<br />
'''https://play.google.com/store/apps/details?id=org.xbmc.kodi'''

Google Play will automatically select which version (ARM(32bit), ARM(64bit) or x86) of Kodi you need, and will also automatically handle updates (unless you change your Google Play preferences).

{{#widget:YouTube|id=hmO_qVDoXCk}}

{{big|'''Files permissions on Android 11 or higher:'''}}

On Android TV 11 or higher by default Kodi dont have local files access permissions,
this means that if you try to open any local files through Kodi, these files although existing will not be visible.

To allow Kodi to have access to local files you need to manually set app files permissions.
On Android TV settings go to "Settings -> Apps - Kodi -> Permissions -> Files and Media" and select "Allow all the time".

== Google Play - beta testing ==
{{see also|Development builds}}

In order to test Kodi nightlies on your Android device, just download them from here:

http://mirrors.kodi.tv/nightlies/android/




{{note|Be sure to '''[[backup]]''' before you install this!

These alpha and beta builds are considered "semi stable", and contain the latest changes to Kodi. They may contain bugs and/or drastically change how the program works.}}

Please report any bugs and issues you come across to the '''[http://forum.kodi.tv Kodi forum]'''.



If you want to go back to the most recent stable version, uninstall the Kodi nightly first and reinstall Kodi either via Google Play or the manual installation which is explained in this article. Uninstalling the Kodi nightly and reinstalling Kodi will reset all Kodi settings. So make sure to '''[[backup]]''' your stable Kodi settings before testing nightlies and then restore from that backup once you have stable Kodi installed again.

= Manual installation =

== Enabling installation ==
===Android (normal)===
This includes installation instructions for phones, tablets and most boxes running Android.

Here's how to install Kodi from an .APK file. This is commonly known as "sideloading".

<gallery widths="500px" heights="313">
File:Android install step01.jpg|{{big|'''Step 1:'''}} First located the settings menu on your Android device and search for the "security" menu.
File:Android install step02.jpg|{{big|'''Step 2:'''}} Now enable "Unknown sources" option. This will allow you to directly install Kodi as easy as you would install it from Play Store.
</gallery>

=== Android TV ===
<gallery widths="500px" heights="313">
File:Android TV install step01.jpg|{{big|'''Step 1:'''}} From the Android TV launcher, scroll down to and select "Settings".
File:Android TV install step02.jpg|{{big|'''Step 2:'''}} From the "Settings" menu, scroll down and select the "Security & Restrictions" menu.
File:Android TV install step03.jpg|{{big|'''Step 3:'''}} In the "Security & Restrictions" menu, turn on "Unknown Sources".
</gallery>

== Download ==
Download Kodi for Android from the Kodi.tv servers. Official stable builds can be found here: '''http://kodi.tv/download/''' You need to either select the '''ARM''' or '''x86''' version depending on your hardware.

===Android TV===
# From a desktop computer or phone/tablet, go to http://play.google.com using the same Google account as used in your Android TV device.
# Install a browser such as Chrome. Select your Android TV box from the popup menu after clicking the install/get button.
# To make things easy, connect a USB or Bluetooth mouse.
# Open the browser either by voice remote (for example, say "Open Chrome") or from something such as Sideload Launcher.
# Follow the rest of the steps below for "'Normal' Android"

===Android (normal)===
<gallery widths="500px" heights="313px">
File:Android_install_step03.png|{{big|'''Step 1:'''}} Load up '''http://kodi.tv/download/''' in your Android web browser. Most users will want to use the '''ARM''' link, unless you have an Intel or AMD CPU. You may get a warning trying to download the file depending on which browser you use. You should say "OK" to actually download it.
File:Android_install_step04.png|{{big|'''Step 2:'''}} Wait for the "apk" to download.
</gallery>

== Install ==

Installing the Kodi app package is as simple as just finding the .apk you just downloaded and opening it up. You can do this either though the download menu in the web browser or selecting it with a file explorer.

<gallery widths="500px" heights="313px">
File:Android install step05.png| {{big|'''Step 1:'''}} After selecting the Kodi apk file you might be asked to select something to open it with. "Package installer", "Google Play", or some similar option will be what you want.
File:Android install step06.png| {{big|'''Step 2:'''}} You will get another confirmation screen where you will need to select "install".
File:Android install step07.png| {{big|'''Step 3:'''}} Wait for the installation to complete.
File:Android install step08.png| {{big|'''Step 4:'''}} You've now installed Kodi for Android!
File:Android install step09.png| {{big|'''First run:'''}} The first time you run Kodi it will take slightly longer than normal in order to finish some final installation steps. When it is done Kodi will open normally. This is only done once per installation/update, so the next time Kodi will start up a little faster.
File:Android install step10.png| {{big|'''All done!:'''}} Once started you are on Kodi home menu just like on any other platform.
</gallery>

If you are new to Kodi you might wish to check out this section of the wiki: '''[[First time user]]'''.

=== Install on Fire TV ===

{{#lst:HOW-TO:Install Kodi on Fire TV|intro}}
{{See also|HOW-TO:Install Kodi on Fire TV}}

== Tidy up ==

After Kodi has installed you can delete the downloaded Kodi APK file to save some disk space.

== Update ==
To update Kodi for Android simply follow the normal install steps with the newer version. All your settings and files will be preserved as they are located in a different place in the userdata folder. Be sure to make a backup of the userdata folder when doing updates in case something goes wrong.

{{note|Since Kodi for Android is signed with our own signatures you will be able to install all succeeding versions without a problem. If you are using a non-official version not signed by us you may be required to un-install Kodi and you will loose all your settings due to this. Be warned before trying.}}

== Uninstall ==

To un-install Kodi just go to your Android settings menu and select "apps". From there you will be able to un-install Kodi like any other Android app.

===Android (normal)===
{{note|Unlike other OSes, uninstalling Kodi on Android will also erase your [[Userdata|userdata folder]] and all of your settings.}}

<gallery widths="500px" heights="313px">
File:Android install step13.jpg| {{big|'''Step 1:'''}} Go into your Android "Settings" app and then select "Apps".
File:Android install step14.jpg| {{big|'''Step 2:'''}} Select Kodi from the list.
File:Android install step15.jpg| {{big|'''Step 3:'''}} Select uninstall and confirm.
</gallery>

===Android TV===
<gallery widths="500px" heights="313px">
File:Android TV install step12.jpg| {{big|'''Step 1:'''}} Go into your Android TV '''Settings''' menu and then select '''Apps'''.
File:Android TV install step13.jpg| {{big|'''Step 2:'''}} Go to the '''Downloaded apps''' then select Kodi.
File:Android TV install step14.jpg| {{big|'''Step 3:'''}} Select uninstall.
File:Android TV install step15.jpg| {{big|'''Step 4:'''}} Select Ok.
</gallery>

= See also =
* [[Android]]
* [[Android hardware]]
* [[Development builds]]

{{Updated|16}}

[[Category:Manual]]
[[Category:Installation|Android]]
[[Category:Android]]
[[Category:How-to]]

Android

2023-10-26T06:43:03Z

CastagnaIT: Tips and tricks - Add mandatory permissions on Android 11+ for local files

<span style="float:right;">{{Google Play}} [https://f-droid.org/en/packages/org.xbmc.kodi/ <img src="https://cloud.githubusercontent.com/assets/9103935/14702535/45f6326a-07ab-11e6-9256-469c1dd51c22.png" width="224">]</span>
{{mininav|[[Devices]]}}
:''Looking for information on the Kodi remote control app for Android? See '''[[Kore|Kore -The official Kodi Remote for Android]]'''.''
{{forum link2|1=Read this page and still need help? Check out the [http://forum.kodi.tv/forumdisplay.php?fid=164 ''Kodi for Android'' support forum].}}
<section begin="intro" />Kodi for Android is a full port of the complete Kodi application to Google's [[w:Android (operating system)|Android operating-system]]. With the Android NDK (Native Development Kit for Android) Kodi runs natively under Android as a Native Activity application. The main goal for the Android port is to have Kodi working on inexpensive Android set-top-boxes. And whole Android smartphones and tablets are not the main target platforms they do have limited support as well.<section end="intro" />

== Main topics ==
Other Android-specific wiki pages for topics, guides, and advice. For '''[[Main_Page|everything else]]''' standard Kodi pages will normally apply.
{{Index two column
| image 1 = Gnome-emblem-downloads.png
| link 1 = HOW-TO:Install Kodi for Android
| image 2 = Nuvola apps ksim.png
| link 2 = Android hardware
| image 3 = Applications-development.png
| link 3 = Android_development
| link 4 = Touch controls
}}

== Requirements ==
{{Main|Android hardware}} {{see also|Supported hardware}}
{{#lst:Supported hardware|Android}}

== How-tos ==
Assorted how-tos related to the video library that have been added to the wiki:


<dpl>
category = How-to
category = Android
format = ,{{list2|%PAGE%}}
</dpl>

== Tips and tricks ==
<section begin="FAQ Performance notes" />
* On Android TV 11 or higher to allow Kodi access to local files you need to manually set files permissions. On Android TV go to "Settings -> Apps - Kodi -> Permissions -> Files and Media" and select "Allow all the time".
* Avoid using wireless. A lot of Android boxes and "sticks" have weak wifi, even those that advertise as being wireless-n. It may be possible to use a USB-to-ethernet dongle on some devices, or even a USB wifi adapter that has a better wifi radio than what is built-in.
* Switch to a different network protocol to see if that has any effect, i.e. [[SMB|SMB/CIFS]], [[NFS]], [[FTP]], WebDAV, etc.
* Try sharing the media on another device to rule out a device-specific (or network) issue.
* Turn off thumbnails, Kodi -> Settings -> Video -> File and deselect 'generate thumbnails'.
* H.264 videos encoded with Hi10P profile will not work on some Android hardware as some ARM processors are not powerful enough to software decode it, and no hardware decoders exist for it. However, some newer/faster processors are able to playback Hi10P video using software decoding.
* If RSS feed is enabled, disable it in settings. This can make the main menu a bit faster.
* Running out of disk space storage, or want to try tweaking caching and other performance settings to achieve faster response times? <section end="FAQ Performance notes" />

=== Helpful applications ===
Some helpful Kodi related Android applications, as suggested by the community. This list should not be seen as any kind of official endorsement by Kodi.


:{| class="plainlinks" width="100%" cellspacing="5px"
| [[File:com.finalwire.aida64.png|50px|link=https://play.google.com/store/apps/details?id=com.finalwire.aida64]]
| [https://play.google.com/store/apps/details?id=com.finalwire.aida64 '''AIDA64''']
: A free app that reports your device's system info, including CPU type, codec support, and more.
|-
| [[File:com.autostart.png|50px|link=https://play.google.com/store/apps/details?id=com.autostart]]
| [https://play.google.com/store/apps/details?id=com.autostart '''AutoStart''']
: Another auto launcher
|-
| [[File:com.nolanlawson.logcat.png|50px|link=https://play.google.com/store/apps/details?id=com.nolanlawson.logcat]]
| [https://play.google.com/store/apps/details?id=com.nolanlawson.logcat '''CatLog'''] ''(requires root)''
: Useful for sending system logs to developers when trying to troubleshoot issues. If someone asks you for a "Log Cat" or a "crash log", this application will get that log.
|-
| [[File:Firestarter.png|50px|link=http://forum.xda-developers.com/fire-tv/themes-apps/app-root-home-launcher-replacement-app-t3118135]]
| [http://forum.xda-developers.com/fire-tv/themes-apps/app-root-home-launcher-replacement-app-t3118135 '''FireStarter'''] ''(Fire TV/stick only)''
: Fire TV replacement launcher that can also launch Kodi by default. Also includes options to both install and update official Kodi versions.
|-
| [[File:se.ollan.kodiupdater.png|50px|link=https://play.google.com/store/apps/details?id=se.ollan.kodiupdater]]
| [https://play.google.com/store/apps/details?id=se.ollan.kodiupdater '''Kodi Updater''']
: Easily update or install Kodi without having to manually sideload.
|-
| [[File:net.tyniw.mediacodecinfo.application.png|50px|link=https://play.google.com/store/apps/details?id=net.tyniw.mediacodecinfo.application]]
| [https://play.google.com/store/apps/details?id=net.tyniw.mediacodecinfo.application '''Media Codec Info''']
: A tool to display what video codecs are enabled for your device. In theory, anything that your device has enabled for media codec should then work in Kodi.
|-
| [[File:innerlife.keyboard.multilanguagekeymapredefiner.png|50px|link=https://play.google.com/store/apps/details?id=innerlife.keyboard.multilanguagekeymapredefiner]]
| [https://play.google.com/store/apps/details?id=innerlife.keyboard.multilanguagekeymapredefiner '''Multilanguage Keymap Redefiner''']
: Remap keys on the Android level without having to use Kodi keymaps
|-
| [[File:com.woodslink.android.wiredheadphoneroutingfix.png|50px|link=https://play.google.com/store/apps/details?id=com.woodslink.android.wiredheadphoneroutingfix]]
| [https://play.google.com/store/apps/details?id=com.woodslink.android.wiredheadphoneroutingfix '''SoundAbout''']
: Automatic bluetooth audio routing. Useful for switching between bluetooth headphones and TV audio automatically.
|-
| [[File:imoblife.startupmanager.jpg|50px|link=https://play.google.com/store/apps/details?id=imoblife.startupmanager]]
| [https://play.google.com/store/apps/details?id=imoblife.startupmanager '''Startup Manager (Free)''']
: Allows an app, such as Kodi, to be launched when the Android device starts up.
|-
| [[File:fr.xgouchet.texteditor.png|50px|link=https://play.google.com/store/apps/details?id=fr.xgouchet.texteditor]]
| [https://play.google.com/store/apps/details?id=fr.xgouchet.texteditor '''Ted (Text Editor)''']
: Free and open source text editor that is useful for editing various files, such as [[keymaps]] and [[advancedsettings.xml]]
|-
| [[File:se.blunden.xbmclauncher.png|50px|link=https://play.google.com/store/apps/details?id=se.blunden.xbmclauncher]]
| [https://play.google.com/store/apps/details?id=se.blunden.xbmclauncher '''XBMC Launcher''']
: Set Kodi (and various forks) as a Launcher without having to mod the APK
|}

{{updated|16}}

[[Category:Android|*]]
[[Category:Hardware]]
[[Category:Index]]
[[Category:Manual]]

Supported hardware

2023-10-26T06:39:23Z

CastagnaIT: Add Android TV mandatory permissions for local files

{{mininav|[[General topics]]{{l2|[[Hardware]]}}|[[Installing]]}}
{{forum link2|1=Want to discuss or ask about what hardware is good for Kodi? Check out the [http://forum.kodi.tv/forumdisplay.php?fid=112 Hardware for Kodi subforum]}}
<section begin="intro" />Kodi is officially supported on a number of operating systems and hardware devices that are designed to be connected directly to a TV. Kodi runs well on what are relatively "underpowered" systems, thanks to hardware video decoding being common on nearly all supported platforms. These requirements don't include what might be required for some "advanced" features, such as PVR, which might require additional hardware. <section end="intro" />

== Android ==
{{see also|Android|Android hardware}}
<section begin="Android" />{{Warning|It is highly recommended for users to not make any hardware purchases in anticipation of running Kodi on Android without first researching the device you want to buy. Before you do buy, make sure multiple people have verified that it works! <big><u>'''''If in doubt, do not buy any hardware!'''''</u></big>}}
* Kodi v17 and later requires Android 5.0 or higher.
* x86 (Intel) or a NEON-compatible ARM-processor, (for example: Nvidia Tegra 3 and newer are fully supported by Kodi, while Tegra 2 and older are not).
* The main aim for the Android port of Kodi is to foremost target media-players/set-top-boxes/sticks that connect to a large screen television and uses a standard remote control as its main interface device, (that is the same market as for HTPC).<section end="Android" />
* Android TV 11 or higher to allow Kodi access to local files you need to manually set files permissions. On Android TV go to "Settings -> Apps - Kodi -> Permissions -> Files and Media" and select "Allow all the time".

== iOS and iPadOS ==
{{see also|iOS}}
<section begin="iOS" />
*To '''[[HOW-TO:Install Kodi for iOS|install Kodi for iOS/iPadOS]]''' you must have one of the following:
** a jailbroken [[w:iDevice|iDevice]] running iOS 6.0 or higher, though iOS 8.0 or higher is recommended
** a normal iDevice running iOS 6.0 or higher and a Mac running Xcode 7 and higher
* For hardware: iPad, iPhone and iPod touch.<section end="iOS" />

== tvOS ==
{{see also|tvOS}}
<section begin="tvOS" />
=== Apple TV 2 ===
<section begin="Apple TV 2" />* As of v15.0, Kodi no longer supports the Apple TV 2.<section end="Apple TV 2" />

=== Apple TV 3 ===
<section begin="Apple TV 3" />* Kodi is not supported on Apple TV 3 because there is no jailbreak for this device and it's impossible to sideload an application on it.<section end="Apple TV 3" />

=== Apple TV 4 and 5 (HD and 4K) ===
<section begin="ATV4" />* Apple TV 4 and 5 (also called Apple TV HD and Apple TV 4K) are supported by Kodi. For step by step Installation guide, follow '''[[HOW-TO:Install Kodi on Apple TV 4 and 5 (HD and 4K)|HOW-TO:Install Kodi on Apple TV 4 and 5 (HD and 4K)]]'''.<section end="ATV4" /><section end="tvOS" />

== Linux ==
{{See also|Linux}}

=== Desktop ===
<section begin="Linux" />
{| class="prettytable" style="background-color:#FFFFFF;"
! CPU
| x86 or x86-64 processor such as: Intel Pentium 4/ Pentium M, AMD Athlon 64 / Opteron, or newer CPU (that support [[w:Streaming SIMD Extensions|SSE2]], which all CPUs made within the last 10-years does).
* If your GPU/VPU does not support hardware video decoding then you will require a fast modern processor is required to decode some 1080p videos encoded in H.264, VC-1/WMV9, HEVC/H.265 VP9, etc
|-
! RAM
|
* '''Recommended:''' 1GB or more in a HTPC media player appliance-like computer dedicated for Kodi, and 2GB or more in a computer for multipurpose use.
|-
! Graphics
|
Kodi will run on most graphics cards made within the last 10-years or so, though for good hardware video decoding support a little newer graphics cards can be required. This includes most cards from AMD/ATI, Intel, or NVIDIA which support OpenGL 2.0 or later.

'''AMD/Intel'''
* '''Minimum:''' [[w:Mesa_(computer_graphics)|Mesa 11.3]] or later
* '''Recommended:''' [[w:Mesa_(computer_graphics)|Mesa 17.1]] or later (required for 10 bit HEVC)
|-
! Video decoding
| For hardware video decoding, which may be necessary on low-performance CPUs to playback 1080p content, make sure your GPU or VPU supports either VAAPI or VDPAU. For everything but older AMD cards and Nvidia, VAAPI is recommended. On AMD, you might have to start with the environment variable <code>KODI_GL_INTERFACE</code> set to <code>GLX</code> in order to get VDPAU support.

{| class="datatable" width="100%"
! !! ATI/AMD ( [[w:Video Acceleration API|VA-API]] 2.0.0 or [[w:VDPAU|VDPAU]] ) !! Intel ( [[w:Video Acceleration API|VA-API]] 1.7.1 ) !! Nvidia ( [[w:VDPAU|VDPAU]] )
|-
| '''Minimum without HW decoding:''' || [[w:Radeon|ATI Radeon RV710/M92 (HD 4300/4500)]] [[w:Unified Video Decoder#UVD enabled GPUs|Note: These are uvd2.2 cards]] || [[w:Intel HD and Iris Graphics| Arrandale / Clarkdale]] or newer || [[w:GeForce|Nvidia GeForce 6-Series]]
|-
| '''Minimum for HW decoding of 8-bit H.264 and VC-1:''' || [[w:Radeon HD 5000 series|Radeon HD 5000 series]] or newer || [[w:Sandy Bridge|Sandy Bridge]] / [[w:Silvermont|Silvermont]] or newer || [[w:GeForce 8 series|GeForce 8 series]] or newer <small>(released 2006)</small>
|-
| '''Minimum for HW decoding of 8-bit HEVC (H.265):''' || [[w:AMD_Radeon_Rx_300_series|AMD Radeon Rx 300 series]] or newer || [[w:Intel HD and Iris Graphics| Braswell / Skylake]] or newer || [[w:GeForce|Nvidia GeForce 900 series (GM20x)]] or newer
|-
| '''Minimum for HW decoding of 10-bit HEVC (H.265):''' || [[w:AMD_Radeon_400_series|AMD Radeon 400 series]] or newer || [[w:Intel_HD_and_Iris_Graphic| Apollo Lake / Kaby Lake]] or newer || Not available
|-
| '''Minimum for HW decoding of VP9:''' || Stoney Ridge [[w:AMD_Accelerated_Processing_Unit|APU]] or newer; not available for desktop GPUs at the moment || [[w:Intel_HD_and_Iris_Graphic| Apollo Lake / Kaby Lake]] or newer || Not available
|}
|-
! Drive space
| The Kodi application generally only takes up between 100 to 200 MB of space, depending on how the binary is compiled. Technically speaking, if your hardware supports netbooting, you do not even require a internal storage for either the operating-system or for Kodi.
* '''Minimum:''' 4 to 8GB
* '''Recommended:''' 16GB or more
: Depending on how big your video library is. Most of the space required for Kodi comes from the images/artwork cache.
|}

{{note|There´s no 304.xxx driver for Ubuntu 18.04 available anymore from the "Graphic Drivers"-ppa. Users who are using GeForce 6-series cards should either stay on an older Ubuntu version or use newer cards}}
<section end="Linux" />

=== Embedded systems (ARM/MIPS-based hardware) ===
Other than OpenGL ES 2.0 graphics support being a must it is very hard to generalize Kodi hardware requirements for Linux-based operating-system distributions on ARM or MIPS based embedded systems. This is partially due to most of the work in this area still being early/on-going in development. For most ARM and MIPS-based devices, hardware video decoding support will also be needed for most high-definition videos, (and possibly even some standard-definition videos). Some newer and faster high-end ARM/MIPS chipset can decode some high-definition video using software video decoding, but those encoded with the latest video codecs.

'''Here are a few popular embedded hardware devices that are known to work with Kodi and Linux:'''

* '''[[Raspberry Pi]]''' - Hardware video decoding support for H.264, MPEG-2, and VC-1. GUI is responsive on most light skins. Official supported by many third-party JeOS (Just enough Operating System) Linux distributions made for Kodi such as [[LibreELEC]], GeeXboX, XBian, and [[OSMC]]
* '''SolidRun_CuBox-i''' - Official supported by [[LibreELEC]], GeeXboX and XBian
* '''Various "Android" boxes''' - can run reinstalled with a Linux firmware and boot directly into Kodi. Hardware video decoding for most video codecs, GUI is very responsive on most skins. Running Linux and Kodi on these "Android boxes" will likely result in better performance and enhanced playback capabilities than running Kodi under Android.

=== JeOS implementations for Kodi ===
{{main|JeOS implementations for Kodi}}
{{#lst:JeOS implementations for Kodi|JeOS for Kodi}}

== Mac OS X ==
{{see also|Mac OS X}}
<section begin="Mac OS X" />
*Kodi v17 requires Mac OS X 10.8 or later.
*Kodi v18 (and its nightlies) will at least require 10.9)
*Kodi v20 and above requires an Intel Mac running OS X 10.13 or higher.<section end="Mac OS X" />

== Windows ==
{{See also|Windows}}
{{Note|Due to changes in code it may be possible that older hardware/videocards are no longer supported. If starting of Kodi fails then try upgrading to last available drivers (or beta drivers).}}
<section begin="Windows" />
{| class="prettytable" style="background-color:#FFFFFF;"
! Windows Version
|
* '''Minimum:''' Windows 7
* '''Recommended:''' Windows 10
|-
! CPU
| x86 or x86-64 processor such as: Intel Pentium 4/ Pentium M, AMD Athlon 64 / Opteron, or newer CPU (that support [[w:Streaming SIMD Extensions|SSE2]], which all CPUs made within the last 10-years does).
* If your GPU/VPU does not support hardware video decoding then you will require a fast modern processor is required to decode some 1080p videos encoded in H.264, VC-1/WMV9, HEVC/H.265 VP9, etc
|-
! RAM
|
* '''Recommended:''' 1GB or more in a HTPC media player appliance-like computer dedicated for Kodi, and 2GB or more in a computer for multipurpose use.
|-
! Graphics
|
GPU hardware must support at least level [[w:DirectX|DirectX version 9.0c]] however the GPU software drivers must support the [[w:Feature_levels_in_Direct3D#Direct3D_11| DirectX 11 Feature Level 9.1]] (which means the DX11 API has been implemented in the GPU software driver to be compatible with DX9 hardware)
|-
! Video decoding
| On low-performance CPUs to playback 1080p content then hardware video decoding maybe necessary.
{| class="datatable" width="100%"
! !! AMD/ATI !! Intel !! Nvidia
|-
| '''Minimum without HW decoding:''' || [[w:Radeon|ATI Radeon R300 Series (Radeon 9500)]] || [[w:Intel HD and Iris Graphics| Arrandale / Clarkdale]] or newer || [[w:GeForce|Nvidia GeForce 4-Series]]
|-
| '''Minimum for HW decoding of 8-bit H.264 and VC-1:''' || [[w:Radeon| AMD/ATI Radeon HD 3000 Series ]] or newer || [[w:Intel HD and Iris Graphics| Bay Trail /Sandybridge]] or newer || [[w:GeForce|Nvidia GeForce 4-Series]] or newer
|-
| '''Minimum for HW decoding of 8-bit HEVC (H.265) and VP9:''' || [[w:Radeon|AMD Radeon RX 300 series]] or newer || [[w:Intel HD and Iris Graphics| Braswell / Skylake]] or newer || [[w:GeForce|Nvidia GeForce 8-Series]] or newer
|-
| '''Minimum for HW decoding of 10-bit HEVC (H.265) and VP9:''' || [[w:Radeon|AMD Radeon 400 series]] or newer || [[w:Intel_HD_and_Iris_Graphic| Apollo Lake / Kaby Lake]] or newer || [[w:GeForce|Nvidia GeForce 8-Series]] or newer
|}
|-
! Drive space
| The Kodi application generally only takes up between 100 to 200 MB of space, depending on how the binary is compiled. Technically speaking, if your hardware supports netbooting, you do not even require a internal storage for either the operating-system or for Kodi.
* '''Minimum:''' 4 to 8GB
* '''Recommended:''' 16GB or more
: Depending on how big your video library is. Most of the space required for Kodi comes from the images/artwork cache.
|}<section end="Windows" />

{{Updated|17}}

[[Category:Manual]]
[[Category:Hardware|*]]
[[Category:Installation]]
[[Category:General topics]]

Advancedsettings.xml

2023-02-14T07:16:33Z

CastagnaIT: Add kodi version to maxpassthroughoffsyncduration

{{TOC right}}{{mininav|[[Settings]]|page=advancedsettings.xml}}
{{bigger|{{note|'''The advancedsettings.xml file does not exist by default. You have to create it first!'''}} }}

<section begin="intro" />The [[advancedsettings.xml]] file, which does not exist by default, can be created by a user in their '''[[Userdata|userdata folder]]'''.

This file is used for advanced settings and options that do not have GUI controls inside of {{kodi}}. Some settings are experimental or very rarely set, so they can only be used via the advancedsettings.xml file. The file is simply a plain text file and can be edited by various text editors, so long as the name is "advancedsettings.xml". These advanced settings can be used to tweak various things such as episode naming patterns, special network ports, special behaviors, and more.<section end="intro" />

The following page will describe the structure of the advancedsettings.xml file and the various individual settings.

{{note|
# All XML tags must be lowercase. The start and end of the advancedsettings.xml file must have the <advancedsettings> and </advancedsettings> tags.
# Kodi will only read the advancedsettings.xml file when it starts up. If you make changes while it is running then you must restart Kodi.
# For some Windows versions, Kodi has two <code>\userdata\</code> folders. The correct one to put the advancedsettings.xml file in is not the one in Program Files, but in <code>%appdata%\Kodi\userdata\.</code>}}

== Layout ==

The layout of <code>advancedsettings.xml</code> is as follows:

<syntaxhighlight lang=xml enclose="div">
<advancedsettings version="1.0">
<setting>value</setting>
...
<setting>value</setting>
</advancedsettings>
</syntaxhighlight>

where "setting" gives the name of the setting, and "value" gives its value.

A list of the available "setting" strings and their values is given below.

= List of available settings =
List of available settings that are recognised in the advancedsettings.xml file <ref>https://github.com/xbmc/xbmc/blob/master/xbmc/settings/AdvancedSettings.cpp</ref>

Recommended: Use the table of contents or the search function in your browser to locate items.

== Troubleshooting settings ==

=== loglevel ===
{{Anchor|.3Cloglevel.3E}}

<section begin="loglevel" />
Sets the logging level used to log errors and information. The "hide" attribute is optional.

<syntaxhighlight lang=xml>
<loglevel hide="attribute">options</loglevel>
</syntaxhighlight>

{| class="mw-collapsible mw-collapsed wikitable"
|-
! style="width:100px;" | Attribute
! style="width:500px;" | Action
|-
! '''true'''
| Hides the "enable debugging" setting in the Settings page. (default)
|-
! '''false'''
| Allows "enable debugging" setting to switch between '''0''' and '''2'''.
|}

{| class="mw-collapsible mw-collapsed wikitable"
|-
! style="width:100px;" | Option
! style="width:500px;" | Action
|-
! '''-1'''
| No logging, suppresses all log output
|-
! '''0'''
| Normal logging, only logging errors (default)
|-
! '''1'''
| Debug logging with freemem, fps and cpu usage (no on screen)
|-
! '''2'''
| Same as 1 (with on screen display)
|-
! '''3'''
| Same as 1 + full smb logging
|}

{| class="wikitable"
|-
! style="width:100px;" | Example
! style="width:500px;" |
|-
! Example 1:
|<syntaxhighlight lang=xml enclose="div">
<advancedsettings>
<loglevel>2</loglevel>
</advancedsettings>
</syntaxhighlight>
|-
! Example 2:
|<syntaxhighlight lang=xml enclose="div">
<advancedsettings>
<loglevel hide="true">2</loglevel>
</advancedsettings>
</syntaxhighlight>
|}

'''Note:''' The setting is persistent through shutdown and restarts.<br>
'''Note:''' If debugging is enabled in the GUI, loglevel will be set to '''2'''. This will over-ride the <code>advancedsettings.xml</code> setting. You must disable the GUI Setting before adding the entry to <code>advancedsettings.xml</code>.<br />
<section end="loglevel" />
:''{{see also|Log_file|label 1=Debug Log}}''

=== jsonrpc ===
{{Anchor|.3Cjsonrpc.3E}}
To make it easier for developers using the [[JSON-RPC_API]] API in their (third party) applications to debug during development the json output of Kodi can be prettified by setting '''compactoutput''' to '''false'''. Default json output mode is a compact print which does not contain any unnecessary whitespaces and therefore is difficult to read for humans.
Furthermore using the '''tcpport''' setting it is possible to change the default TCP port used by Kodi for JSON RPC (which is 9090) to any other valid port.

Example:
<syntaxhighlight lang=xml enclose="div">
<jsonrpc>
<compactoutput>false</compactoutput>
<tcpport>9999</tcpport>
</jsonrpc>
</syntaxhighlight>

== Audio/video playback settings ==

=== skiploopfilter ===
{{anchor|.3Cskiploopfilter.3E}}
The amount of the loop filter to skip on h.264 decoding. This can help the performance of slower machines when decoding h264 content. Values, in decreasing CPU usage (and decreasing quality)
* -16 None
* 0 Skip only empty frames (default)
* 8 Skip non-reference frames
* 16 Skip bi-dir frames
* 32 Skip all non-key frames
* 48 Skip all frames
Example:
<syntaxhighlight lang=xml enclose="div">
<skiploopfilter>8</skiploopfilter>
</syntaxhighlight>

=== video ===
{{anchor|.3Cvideo.3E}}

The <video> section also includes the following child-tags, which have their own sections:
*[[#cleandatetime]]
*[[#cleanstrings]]
*[[#excludefromscan]]
*[[#excludefromlisting]]
*[[#excludetvshowsfromscan]]

{{note|Some tags that have a "third-level" and are grouped together are highlighted in color.}}

{| class="prettytable"
! Tag !! Description
|-
|
<syntaxhighlight lang=xml>
<video>
</syntaxhighlight>
| Parent tag that all other child tags need to be placed inside of. Do not use more than one '''<code><video></code>''' tag, but instead place all other child-tags within a single '''<code><video></video></code>''' set.
|-
|
<syntaxhighlight lang=xml>
<subsdelayrange>10</subsdelayrange>
</syntaxhighlight>
| Delay range for subtitles, in seconds.
|-
|
<syntaxhighlight lang=xml>
<maxtempo>2.1</maxtempo>
</syntaxhighlight>
| Allow further increase of playback speed over the default of 1.5<br>
maxtempo must be in the range of 1.5 to 2.1 <br>
Be aware of the limitations of your platform / hardware as not all are capable of the increased maxtempo <ref>https://forum.kodi.tv/showthread.php?tid=10023&pid=2795069#pid2795069</ref>
|-
|
<syntaxhighlight lang=xml>
<audiodelayrange>10</audiodelayrange>
</syntaxhighlight>
| Delay range for audio/video sync, in seconds.
|-
|
<syntaxhighlight lang=xml>
<usetimeseeking>true</usetimeseeking>
</syntaxhighlight>
| Whether to use time based or percentage based seeking. {{small see also|Skip steps}}
|-
|
<syntaxhighlight lang=xml>
<timeseekforwardbig>600</timeseekforwardbig>
<timeseekbackwardbig>-600</timeseekbackwardbig>
</syntaxhighlight>
| Time to seek forward in seconds when doing a long seek. Defaults to 600 (10 minutes) and -600 (-10 minutes) respectively. ''{{small|See also: [[Skip steps]] }}''
|-
|
<syntaxhighlight lang=xml>
<percentseekforward>2</percentseekforward>
<percentseekbackward>-2</percentseekbackward>
</syntaxhighlight>
| Amount to seek forward as a percentage, when doing a short seek. Defaults to 2 (2%) and -2 (2%) respectively. ''{{small|See also: [[Skip steps]] }}''
|-
|
<syntaxhighlight lang=xml>
<percentseekforwardbig>10</percentseekforwardbig>
<percentseekbackwardbig>-10</percentseekbackwardbig>
</syntaxhighlight>
| Amount to seek forward as a percentage, when doing a long seek. Defaults to 10 (10%) and -10 (10%) respectively. ''{{small|See also: [[Skip steps]] }}''
|-
|
<syntaxhighlight lang=xml>
<fullscreenonmoviestart>true</fullscreenonmoviestart>
</syntaxhighlight>
| Whether to go to fullscreen or not when starting a movie. Defaults to true.
|-
|
<syntaxhighlight lang=xml>
<defaultplayer>VideoPlayer</defaultplayer>
</syntaxhighlight>
| Set the default video player: VideoPlayer or an external player. See '''[[External players]]''' for more info.
|-
|
<syntaxhighlight lang=xml>
<excludefromscan>
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromscan>
</syntaxhighlight>
| Regular expressions that if evaluated to true won't be added to library. It is possible to add multiple <code><regexp></code> tags to match multiple patterns
|-
|
<syntaxhighlight lang=xml>
<excludefromlisting>
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromlisting>
</syntaxhighlight>
| Regular expressions that if evaluated to true won't be displayed in files view.
|-
|
<syntaxhighlight lang=xml>
<playcountminimumpercent>90</playcountminimumpercent>
</syntaxhighlight>
| Minimum percentage that has to be played before it is marked as watched. Set to 101 to never auto-mark items as watched. ''{{small|See also: [[HOW-TO:Modify automatic watch and resume points]] }}''
|-
|
<syntaxhighlight lang=xml>
<ignoresecondsatstart>180</ignoresecondsatstart>
</syntaxhighlight>
| Number of seconds to ignore at video start after which a resume point is created. ''{{small|See also: [[HOW-TO:Modify automatic watch and resume points]] }}''
|-
|
<syntaxhighlight lang=xml>
<ignorepercentatend>8</ignorepercentatend>
</syntaxhighlight>
| Percentage of video to ignore at the end. If you stop watching the video here no resume point is created. Set to 101 to never save a resume point. The video is already marked as watched at 90%, see above. ''{{small|See also: [[HOW-TO:Modify automatic watch and resume points]] }}''
|-
|
<syntaxhighlight lang=xml>
<vdpauscaling>true</vdpauscaling>
</syntaxhighlight>
| Scales with vdpau instead of opengl and turns on its HQ scaler when available, enabling this might slow down rendering and cause framedrops especially on ION systems, this setting requires a vdpau feature set C GPU.
|-
|
<syntaxhighlight lang=xml>
<enablehighqualityhwscalers>true</enablehighqualityhwscalers>
</syntaxhighlight>
| Allow turning on the spline36 and lanczos3 shader (for GL builds).
|-
|
<syntaxhighlight lang=xml>
<dxvaallowhqscaling>false</dxvaallowhqscaling>
</syntaxhighlight>
| Enables high quality video upscaling for Windows.
|-
|
<syntaxhighlight lang=xml>
<ppffmpegdeinterlacing>linblenddeint</ppffmpegdeinterlacing>
</syntaxhighlight>
| Override the deinterlacing options passed to libpostproc.
|-
|
<syntaxhighlight lang=xml>
<ppffmpegpostprocessing>ha:128:7,va,dr</ppffmpegpostprocessing>
</syntaxhighlight>
| Override the post processing options passed to libpostproc when 'Video post-processing' is activated in GUI Videos-Settings-Playback.
|-
|
<syntaxhighlight lang=xml>
<autoscalemaxfps>30</autoscalemaxfps>
</syntaxhighlight>
| When scaling method is set to auto, bilinear is chosen when the fps is higher than this limit, the default is 30.
|-
|
<syntaxhighlight lang=xml>
<adjustrefreshrate>
</syntaxhighlight>
| style="background:#CADCFB;" | Settings for when "Adjust refreshrate to match video fps" is enabled in the video playback GUI settings.
|-
|
<syntaxhighlight lang=xml>
<override>
<fps>23.976</fps>
<refresh>60.0</refresh>
</override>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -''' "Adjust refreshrate to match video fps" will try to select the best refreshrate for the video fps but it doesn't always get it right, for example it might switch to an unsupported refreshrate. You can add overrides here to switch to a certain refreshrate based on video fps. It's possible to add as many overrides as you need. Overrides are processed in order, if the first one doesn't match the fps or no refreshrates match that override, it will try the next one until no overrides are left.

* '''fps''' - if the fps is between 23.966 and 23.986
* '''refresh''' - switch to the first found refreshrate that is between 59.99 and 60.01
|-
|
<syntaxhighlight lang=xml>
<override>
<fpsmin>29.96</fpsmin>
<fpsmax>30.01</fpsmax>
<refreshmin>59.0</refreshmin>
<refreshmax>61.0</refreshmax>
</override>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -'''
* '''fpsmin''' / '''fpsmin''' - You can also specify the fps range yourself.
* '''refreshmin''' / '''refreshmax''' - Same for the refreshrate
|-
|
<syntaxhighlight lang=xml>
<fallback>
<refresh>50.0</refresh>
</fallback>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -''' If none of the overrides match, or none of the refreshrates match any of the fps matching overrides, it will choose a fallback refreshrate. Fallbacks are process in order, if the first fallback doesn't match any refreshrate, it will try the next one until no fallbacks are left.

* '''refresh''' - Switch to the first found refreshrate that is between 49.99 and 50.01.
|-
|
<syntaxhighlight lang=xml>
<fallback>
<refreshmin>49.0</refreshmin>
<refreshmax>51.0</refreshmax>
</fallback>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -''' You can also specify the range for the fallback yourself.

If none of the overrides match the video fps, or no refreshrates match any of the fps matching overrides, and no fallbacks are specified or no refreshrates match any fallbacks, it will automatically choose the best refreshrate (same as having no overrides and fallbacks).
|-
|
<syntaxhighlight lang=xml>
</adjustrefreshrate>
</syntaxhighlight>
| style="background:#CADCFB;" |
|-
|
<syntaxhighlight lang=xml>
<checkdxvacompatibility>value</checkdxvacompatibility>
</syntaxhighlight>
| Advanced setting not present: let Kodi autodetect cards that support H.264 profile > L4.1. Set value to false to enable DXVA no matter what. Set value to true if Kodi doesn't autodetect that the graphics card doesn't support > L4.1.
|-
|
<syntaxhighlight lang=xml>
<useocclusionquery>-1</useocclusionquery>
</syntaxhighlight>
| Use an occlusion query when capturing videoframes, -1 means auto detect, 0 means disabled, 1 means enabled, the default is -1.
|-
|
<syntaxhighlight lang=xml>
<fpsdetect>1</fpsdetect>
</syntaxhighlight>
| FPS detection for video playback
* 0 = trust codec fps
* 1 = recalculate from video timestamps with uniform spacing
* 2 = recalculate from video timestamps always
|-
|
<syntaxhighlight lang=xml>
<latency>
</syntaxhighlight>
| style="background:#F0E68C;"| Start of '''latency''' tags. Display latency (video lag). Latency is given in msecs.
|-
|
<syntaxhighlight lang=xml>
<delay>0</delay>
</syntaxhighlight>
| style="background:#F0E68C;" | Global default display latency.
|-
|
<syntaxhighlight lang=xml>
<refresh></refresh>
</syntaxhighlight>
| style="background:#F0E68C;" | Override latency for given display (not video) refresh rates. When Kodi is in windowed mode, override is ignored. Multiple overrides are allowed.

Syntax of an override entry:
<syntaxhighlight lang=xml>
<refresh>
<min>, <max> refresh rate range, OR
<rate> exact refresh rate
<delay> display latency for the given refresh rate
</refresh>
</syntaxhighlight>
|-
|
<syntaxhighlight lang=xml>
<refresh>
<min>23</min>
<max>24</max>
<delay>125</delay>
</refresh>
</syntaxhighlight>
| style="background:#F0E68C;" | '''Example:''' display has 125 msec latency at 23-24 Hz
|-
|
<syntaxhighlight lang=xml>
<refresh>
<rate>50</rate>
<delay>50</delay>
</refresh>
</syntaxhighlight>
| style="background:#F0E68C;" | '''Example:''' display has 50 msec latency at 50 (+/-0.01) Hz
|-
|
<syntaxhighlight lang=xml>
</latency>
</syntaxhighlight>
| style="background:#F0E68C;" |
|-
|
<syntaxhighlight lang=xml>
<stereoscopicregex3d>[-. _]3d[-. _]</stereoscopicregex3d>
<stereoscopicregexsbs>[-. _]h?sbs[-. _]</stereoscopicregexsbs>
<stereoscopicregextab>[-. _]h?tab[-. _]</stereoscopicregextab>
</syntaxhighlight>
| Filename triggers for 3D (stereoscopic) mode.
|-
|
<syntaxhighlight lang=xml>
<assfixedworks>false</assfixedworks>
</syntaxhighlight>
| Position behavior of ass subtitiles when setting "subtitle position on screen" set to "fixed". True to show at the fixed position set in video calibration. False to show at the bottom of video (default). {{note|Removed in Kodi v20.}}
|-
|
<syntaxhighlight lang=xml>
<subtitleverticalmargin>120</subtitleverticalmargin>
</syntaxhighlight>
| Allows to customise the vertical margin of text based subtitles, which will be applied to each type of subtitle position in subtitle settings. {{note|Available in Kodi v20 and above.}}
|-
|
<syntaxhighlight lang=xml>
</video>
</syntaxhighlight>
|
|}

=== audio ===
{{anchor|.3Caudio.3E}}
<syntaxhighlight lang=xml enclose="div">
<audio>

<headroom>0</headroom>

<defaultplayer>paplayer</defaultplayer>

<excludefromscan>
<regexp>[-\._ ](podcast)[-\._ ]</regexp>
</excludefromscan>

<excludefromlisting>
<regexp>[-\._ ](podcast)[-\._ ]</regexp>
</excludefromlisting>

<ac3downmixgain>12.0</ac3downmixgain>

<usetimeseeking>true</usetimeseeking>

<timeseekforwardbig>600</timeseekfowardbig>

<timeseekbackwardbig>-600</timeseekbackward>

<playcountminimumpercent>99</playcountminimumpercent>

<applydrc>-1.0</applydrc>

<limiterhold>0.025</limiterhold>

<limiterrelease>0.1</limiterrelease>

<maxpassthroughoffsyncduration>10</maxpassthroughoffsyncduration>
</audio>
</syntaxhighlight>

=== forcedswaptime ===
{{anchor|.3Cforcedswaptime.3E}}
Use to force a backbuffer->frontbuffer swap while vsync is enabled. Set to the time (in ms) to allow for the swap (e.g. <forcedswaptime>1</forcedswaptime> is typical).

Default: Off

=== edl ===
{{anchor|.3Cedl.3E}}
{{main|Edit_decision_list}}
Commercial break detection not as good you think it could be? Are some commercial breaks in a series of adverts not being skipped? Are some parts being skipped that are clearly not commercials? Does the end of the previous recording still show? The following advanced settings can be used to better identify full commercial break sequences, remove incorrectly flagged commercial breaks, and have playback start at the actual beginning of the recording.

<syntaxhighlight lang=xml enclose="div">
<edl>

<mergeshortcommbreaks>false</mergeshortcommbreaks>

<maxcommbreaklength>250</maxcommbreaklength>

<mincommbreaklength>90</mincommbreaklength>

<maxcommbreakgap>120</maxcommbreakgap>

<commbreakautowait>0</commbreakautowait>

<commbreakautowind>0</commbreakautowind>
</edl>
</syntaxhighlight>

== PVR & Live TV ==
{{anchor|.3Cpvr.3E}}
Settings available for PVR, EPG and Live TV. Edit Decision List settings are located in the previous section.

=== pvr ===
<syntaxhighlight lang="xml" line='line'>
<pvr>
<timecorrection>0</timecorrection> 
<infotoggleinterval>3000</infotoggleinterval> 
<channeliconsautoscan>true</channeliconsautoscan> 
<autoscaniconsuserset>false</autoscaniconsuserset> 
<numericchannelswitchtimeout>1000</numericchannelswitchtimeout> 
</pvr>
</syntaxhighlight>

==== pvrrecordings ====
In v19 and later, allows users to modify sort type and order of pvr recordings. <ref>https://github.com/xbmc/xbmc/pull/18605</ref>

;Note- These settings are child tags to the ''<pvr>'' tag in the previous section.

<syntaxhighlight lang="xml" line='line'>
<pvr>
<pvrrecordings>
<sortmethod>2</sortmethod> 
<sortorder>2</sortorder> 
</pvrrecordings>
</pvr>
</syntaxhighlight>

=== epg ===
{{anchor|.3Cpvr.3E}}
<syntaxhighlight lang="xml" line='line'>
<epg>
<updatecheckinterval>300</updatecheckinterval> 
<updateemptytagsinterval>60</updateemptytagsinterval> 
<cleanupinterval>900</cleanupinterval> 
<activetagcheckinterval>60</activetagcheckinterval> 
<retryinterruptedupdateinterval>60</retryinterruptedupdateinterval> 
<displayupdatepopup>true</displayupdatepopup> 
<displayincrementalupdatepopup>false</displayincrementalupdatepopup> 
</epg>
</syntaxhighlight>

== Video library settings ==

=== videoextensions ===
{{anchor|.3Cvideoextensions.3E}}<section begin="videoextensions" />
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Video windows.

Default extensions for VIDEOS:
<pre>
.m4v .3g2 .3gp .nsv .tp .ts .ty .strm .pls .rm .rmvb .mpd .m3u .m3u8 .ifo .mov .qt .divx .xvid
.bivx .vob .nrg .img .iso .udf .pva .wmv .asf .asx .ogm .m2v .avi .bin .dat .mpg .mpeg .mp4
.mkv .mk3d .avc .vp3 .svq3 .nuv .viv .dv .fli .flv .001 .wpl .xspf .zip .vdr .dvr-ms .xsp .mts
.m2t .m2ts .evo .ogv .sdp .avs .rec .url .pxml .vc1 .h264 .rcv .rss .mpls .mpl .webm .bdmv
.bdm .wtv .trp .f4v
</pre>
Examples:
<pre>
<videoextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</videoextensions>
</pre>
<section end="videoextensions" />

=== discstubextensions ===
{{main|Media stubs}}

<section begin="discstubextensions" />
The default filename extension for Disc Stubs is:
<syntaxhighlight lang=xml enclose="div">
.disc
</syntaxhighlight>
Using the following tags, it is possible to <tt><add></tt> additional or <tt><remove></tt> existing disc stub extensions to better suit your requirements.
<syntaxhighlight lang=xml enclose="div">
<discstubextensions>
<add>.disk|.stub</add>
<remove>.disc</remove>
</discstubextensions>
</syntaxhighlight>
<section end="discstubextensions" />

=== languagecodes ===
{{anchor|.3Clanguagecodes.3E}}
User-defined translation table for language codes used in subtitles and audio.
It can be used to add, extend or override Kodi's language codes.

'''How to add a new language code:'''

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>alt</short>
<long>Alternate</long>
</code>
</languagecodes>
</syntaxhighlight>

'''How to add a new language code with subtag (e.g. pt-BR):'''
{{note|This support is available from Kodi v20}}

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>pt-BR</short>
<long>Portuguese - Brazil</long>
</code>
</languagecodes>
</syntaxhighlight>

'''How to extend an existing language code:'''

Set the same "long" description of the existing language, for example we reuse the Portughese language for another language code:

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>pt-BR</short>
<long>Portuguese</long>
</code>
</languagecodes>
</syntaxhighlight>

In this case when in Kodi settings you set the "Portuguese" language, when in playing according to availability the track "pt" or "pt-BR" will be chosen.

'''How to override an existing language code:'''

This allow you to rename an existing language. Set to an existing language code your preferred "long" name description.

''WARNING: This can cause problems with add-ons, so do not override languages if you are not aware of the side effects.''

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>en</short>
<long>English example</long>
</code>
<code>
<short>en-GB</short>
<long>English example</long>
</code>
</languagecodes>
</syntaxhighlight>

=== moviestacking ===
{{anchor|.3Cmoviestacking.3E}}<section begin="moviestacking" />
{{main|Naming_video_files/Movies}}
This is used by the [[Naming_video_files/Movies#Split_Video_Files|file stacking]] algorithm to combine multi-part files and contains a list of regular expressions. For stacking videos that are contained in folders, such as VIDEO_TS folders, see '''[[advancedsettings.xml#folderstacking|<folderstacking>]]'''

As of v9.11, video stacking regular expressions '''must''' contain exactly four (4) capture expressions.

Default:
<syntaxhighlight lang=xml enclose="div">
<moviestacking>

<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck])[ _.-]*[0-9]+)(.*?)(\.[^.]+)$</regexp>

<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck])[ _.-]*[a-d])(.*?)(\.[^.]+)$</regexp>

<regexp>(.*?)([ ._-]*[a-d])(.*?)(\.[^.]+)$</regexp>
</moviestacking>
</syntaxhighlight>

If the argument <tt>action="append"</tt> or <tt>append="yes"</tt> is supplied, the default moviestacking regular expressions will remain intact and the user specified ones will be added to the end.

Example:
<syntaxhighlight lang=xml enclose="div">
<moviestacking action="append">

<regexp>(.*?)([ ._-]*[0-9])(.*?)(\.[^.]+)$</regexp>
</moviestacking>
</syntaxhighlight>

If the argument <tt>action="prepend"</tt> is supplied, the default moviestacking regular expressions will remain intact and the user specified ones will be added to the beginning.

Example:
<syntaxhighlight lang=xml enclose="div">
<moviestacking action="prepend">
<regexp>(Title)(Volume)(Ignore)(Extension)</regexp>
</moviestacking>
</syntaxhighlight>

If no argument is supplied, or the argument <tt>append="no"</tt> is supplied, the default moviestacking regular expressions are overwritten by the user specified ones.
<section end="moviestacking" />

=== folderstacking ===
{{main|Naming_video_files/Movies}}
This is similar to '''[[advancedsettings.xml#moviestacking|<moviestacking>]]''', but is used for videos that are contained in folders that use the folder names to stack, such as VIDEO_TS folders (DVD rips that are not in ISO format).

Default:
<syntaxhighlight lang=xml enclose="div">
<folderstacking>

<regexp>((cd|dvd|dis[ck])[0-9]+)$</regexp>
</folderstacking>
</syntaxhighlight>

=== cleandatetime ===
{{anchor|.3Ccleandatetime.3E}}
Matches a year number in a string using a Regular Expression

Default expression:
<syntaxhighlight lang=xml enclose="div">
<video>
<cleandatetime>(.*[^ _\,\.\[\]\-])[ _\.\[\]\-]+(19[0-9][0-9]|20[0-9][0-9])([ _\,\.\[\]\-]|[^0-9]$)?</cleandatetime>
</video>
</syntaxhighlight>
:* The string found before will be used as basis string getting cleaned by the cleanstrings expressions.
:* By default date formats like MM:YY are ignored.

=== cleanstrings ===
{{anchor|.3Ccleanstrings.3E}}
Clean unwanted characters from filenames or folders by using a list of Regular Expressions. Please note that everything right of the match (at the end of the file name) is removed, so if you would have a file named ''Super movie.mp4'' and would add <tt><regexp> </regexp></tt> (only a space), the only thing that would be left is ''Super'', which is probably not what you want.

{{Github_link|[https://github.com/xbmc/xbmc/blob/Matrix/xbmc/settings/AdvancedSettings.cpp#L188 Code in Github]}}

Default expressions:
<syntaxhighlight lang=xml enclose="div">
<video>
<cleanstrings>
<regexp>[ _\,\.\[\]\-](aka|ac3|dts|custom|dc|remastered|divx|divx5|dsr|dsrip|dutch|dvd|dvd5|dvd9|dvdrip|dvdscr|dvdscreener|screener|dvdivx|cam|fragment|fs|hdtv|hdrip|hdtvrip|internal|limited|multisubs|ntsc|ogg|ogm|pal|pdtv|proper|repack|rerip|retail|r3|r5|bd5|se|svcd|swedish|german|read.nfo|nfofix|unrated|extended|ws|telesync|ts|telecine|tc|brrip|bdrip|480p|480i|576p|576i|720p|720i|1080p|1080i|3d|hrhd|hrhdtv|hddvd|bluray|x264|h264|xvid|xvidvd|xxx|www.www|cd[1-9]|\[.*\])([ _\,\.\[\]\-]|$)</regexp>
<regexp>(\[.*\])</regexp>
</cleanstrings>
</video>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)

=== tvshowmatching ===
{{anchor|.3Ctvshowmatching.3E}}
Matches the season and episode numbers in file paths by using a list of Regular Expressions

{{Github_link|[https://github.com/xbmc/xbmc/blob/Matrix/xbmc/settings/AdvancedSettings.cpp#L232 Code in Github]}}

Defaults:
<syntaxhighlight lang=xml enclose="div">
<tvshowmatching>
<regexp>s([0-9]+)[ ._x-]*e([0-9]+(?:(?:[a-i]|\\.[1-9])(?![0-9]))?)([^\\\\/]*)$</regexp> 
<regexp>[\._ -]()[Ee][Pp]_?([0-9]+)([^\\/]*)$</regexp> 
<regexp>([0-9]{4})[\.-]([0-9]{2})[\.-]([0-9]{2})</regexp> 
<regexp>([0-9]{2})[\.-]([0-9]{2})[\.-]([0-9]{4})</regexp> 
<regexp>[\\/\._ \[\(-]([0-9]+)x([0-9]+)([^\\/]*)$</regexp> 
<regexp>[\\/\._ -]([0-9]+)([0-9][0-9])([\._ -][^\\/]*)$</regexp> 
<regexp>[\/._ -]p(?:ar)?t[_. -]()([ivx]+)([._ -][^\/]*)$</regexp> 
</tvshowmatching>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)
:* Paths are converted to lower case before matching.
:* For multi-episode matching to work, there needs to be a third set of parentheses '()' at the end, this part is fed back into the regexp engine.
:* A [https://forum.kodi.tv/showthread.php?tid=51614 forum thread] has a discussion of pre-made regex lists to match common names. These might improve Kodi's ability to match TV show names in some situations, at the risk of additional false positives.

==== Filenames without Season ====
There are two methods to add episodes without a season in their file path. Both ways will force the season to '1' by default, so that you can use
the 'Use Absolute Ordering (Single Season)' setting from the TheTvDb.com scraper.

; Simple Method ''(XBMC v9.11 onwards and Kodi)''
: Use only one pair of parentheses
<syntaxhighlight lang=xml enclose="div"><regexp>[/\._ \-]([0-9]+)</regexp></syntaxhighlight>
; Advanced Method ''(XBMC v10.05 onwards and Kodi)''
: Supports multi-episode files without season
: Use an empty pair of parentheses for the season
<syntaxhighlight lang=xml enclose="div"><regexp>[/\._ \-]()([0-9]+)(-[0-9]+)?</regexp></syntaxhighlight>

; Specifying Default Season ''(XBMC v12.0 onwards and Kodi)''
It is possible to set the default season for specific regular expressions by setting the 'defaultseason' attribute.
: Works with both the simple method and advanced method
: If not used, the season will be set to '1'
: Useful for setting specials to season '0'
<syntaxhighlight lang=xml enclose="div"><regexp defaultseason="0">[/\._ \-]X()([0-9]+)(-[0-9]+)?</regexp>
<regexp defaultseason="1">[/\._ \-]E()([0-9]+)(-[0-9]+)?</regexp></syntaxhighlight>

=== tvmultipartmatching ===
{{anchor|.3Ctvmultipartmatching.3E}}
Matches a multipart episode number based on a previously identified episode file, using a list of Regular Expressions.

Default:
<syntaxhighlight lang=xml enclose="div">
<tvmultipartmatching>^[-_ex]+([0-9]+(?:(?:[a-i]|\\.[1-9])(?![0-9]))?)</tvmultipartmatching>
</syntaxhighlight>
:* Text matching is compared case-insensitive.
:* Specifying this option '''replaces''' the default value

=== excludefromscan ===
{{anchor|.3Cexcludefromscan.3E}}
Matches filenames or folders which should be excluded from a library scan (except tvshows) using a list of Regular Expressions. This can be for both Video or Audio sections of <tt>advancedsettings.xml</tt>.

Defaults:
<syntaxhighlight lang=xml enclose="div">
<video>
<excludefromscan>
<regexp>-trailer</regexp>
<regexp>[!-._ \\/]sample[-._ \\/]</regexp>
</excludefromscan>
</video>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)

=== excludefromlisting ===
{{anchor|.3Cexcludefromlisting.3E}}
<syntaxhighlight lang=xml enclose="div">
<video>
<excludefromlisting> 
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromlisting>
</video>
</syntaxhighlight>

=== excludetvshowsfromscan ===
{{anchor|.3Cexcludetvshowsfromscan.3E}}
Matches filenames or folders which should be excluded from a tvshow library scan using a list of Regular Expressions

Defaults:
<syntaxhighlight lang=xml enclose="div">
<video>
<excludetvshowsfromscan>
<regexp>[!-._ \\/]sample[-._ \\/]</regexp>
</excludetvshowsfromscan>
</video>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)

=== trailermatching ===
{{anchor|.3Ctrailermatching.3E}}
Contains Regular Expression syntax to match the locally stored trailers to movies in the library.

<syntaxhighlight lang=xml enclose="div">
<trailermatching>

<regexp>(.*?)(_Trailer)(\.[^.]+)$</regexp>
</trailermatching>
</syntaxhighlight>

=== videolibrary ===
{{anchor|.3Cvideolibrary.3E}}
Options specific to the Video Library

{{Note|Kodi v20 users don't need set "importwatched" or "importresumepoint" to true anymore as that's the default then <ref>https://github.com/xbmc/xbmc/pull/20842</ref>}}

<syntaxhighlight lang="xml" line='line'>
<videolibrary>
<allitemsonbottom>false</allitemsonbottom> 
<cleanonupdate>false</cleanonupdate> 
<usefasthash>true</usefasthash> 
<recentlyaddeditems>35</recentlyaddeditems> 
<itemseparator> / </itemseparator> 
<exportautothumbs>false</exportautothumbs> 
<importwatchedstate>false</importwatchedstate> 
<importresumepoint>false</importresumepoint> 
<dateadded>1</dateadded> 
</videolibrary>
</syntaxhighlight>

=== videoscanner ===
{{anchor|.3Cvideoscanner.3E}}
Options specific to the Video scanner
<syntaxhighlight lang=xml enclose="div">
<videoscanner>
<ignoreerrors>true</ignoreerrors> 
</videoscanner>
</syntaxhighlight>

== Library artwork ==

{{note|Using <imageres>9999</imageres> and <fanartres>9999</fanartres> will allow caching artwork at original size.}}

=== imageres ===
{{anchor|.3Cimageres.3E}}

<section begin="imageres description" />Specify the maximum resolution that [[Artwork/Cache#Texture optimization| cached artwork]] (other than fanart / 16:9 images) should be resized to in pixels. The width is automatically calculated as being 16/9*height. The image will be resized to fit within this size. e.g. an image that is 2000x500 will be cached at size 1280x320. An image that is 500x800 will be cached at size 450x720 using the default value of 720.<section end="imageres description" />

<syntaxhighlight lang=xml enclose="div">
<imageres>720</imageres>
</syntaxhighlight>

=== fanartres ===
{{anchor|.3Cfanartres.3E}}

<section begin="fanartres description" />Specify the maximum resolution that [[Artwork/Cache#Texture optimization| cached fanart]] should be resized to in pixels. The width is automatically calculated as being 16/9*height. Only images that are exactly 16x9 and equal to or greater than this resolution will be cached at this size - all other images will be cached using <imageres>. The default value is 1080.<section end="fanartres description" />

<syntaxhighlight lang=xml enclose="div">
<fanartres>1080</fanartres>
</syntaxhighlight>

=== imagescalingalgorithm ===
Specify the image scaling algorithm for image resizing when [[Artwork/Cache#Texture optimization| caching artwork]] to the local texture cache.
<br />
<syntaxhighlight lang=xml enclose="div">
<imagescalingalgorithm>bicubic</imagescalingalgorithm>
</syntaxhighlight>

[https://github.com/xbmc/xbmc/blob/1a8753d5cd93890dc6a9f9d4b2ce8848066ea5d0/xbmc/pictures/PictureScalingAlgorithm.cpp#L32-L43 Available image scaling algorithms]

<syntaxhighlight lang=text enclose="div">
fast_bilinear
bilinear
bicubic
experimental
nearest_neighbor
averaging_area
bicublin
gaussian
sinc
lanczos
bicubic_spline
</syntaxhighlight>

=== imagequalityjpeg ===
This specifies the quality of the images when stored in jpeg format. By default kodi uses a quality of 4 which is a good compromise between size and quality. If you want to reduce the thumbnail sizes (decreasing quality) choose a higher value up to 21. If high quality (large thumbnail size) is needed, chose a smaller value, e.g. 0,1,2 or 3. (Added in v20 <ref>https://github.com/xbmc/xbmc/pull/21418</ref>)
<br />
<syntaxhighlight lang=xml enclose="div">
<imagequalityjpeg>4</imagequalityjpeg>
</syntaxhighlight>

== Video and music library settings ==

=== playlistasfolders ===
{{anchor|.3Cplaylistasfolders.3E}}
In the recent releases, playlists are treated as folders. Selecting a playlist no longer plays it, but opens it, as if it were a folder.

Set to false to revert to the previous behaviour. When you select a playlist, its content is added to the list of elements to be played.

:{{note|This setting will not affect smart playlists, they will always show as folders.}}

;Example
<syntaxhighlight lang=xml enclose="div">
<playlistasfolders>true</playlistasfolders>
</syntaxhighlight>

=== playlistretries ===
{{anchor|.3Cplaylistretries.3E}}
The number of retries attempted if a source is offline. With this control you can alter the number of consecutive failed items before a playlist fails.

Default:
<syntaxhighlight lang=xml enclose="div">
<playlistretries>100</playlistretries>
</syntaxhighlight>

=== playlisttimeout ===
{{anchor|.3Cplaylisttimeout.3E}}
The timeout, in seconds, before item failure.

Default:
<syntaxhighlight lang=xml enclose="div">
<playlisttimeout>20</playlisttimeout>
</syntaxhighlight>

=== sorttokens ===
Allows you to specify additional tokens that will be ignored at the start of lines during sorting.
{{note|Sort tokens are case sensitive.}}
<syntaxhighlight lang=xml enclose="div">
<sorttokens>
<token>the</token>
</sorttokens>
</syntaxhighlight>

In the above example "the ", "the." and "the_" will be ignored at the start of titles or names when sorting items, in both video and music libraries. A separator can also be specified, for example
<syntaxhighlight lang=xml enclose="div">
<sorttokens>
<token separators="'">L</token>
</sorttokens>
</syntaxhighlight>
In that case the value L', as in French movie name ''L'argent'', will be ignored and the item listed under "A".

=== musicdatabase/videodatabase ===
{{anchor|.3Cmusicdatabase.3E/.3Cvideodatabase.3E|musicdatabase/videodatabase|database tags music/video/tv/epg/adsp}}
{{main|MySQL}}
<section begin="videodatabase" />
Allows advanced customization of the default database settings for music, video, TV, EPG, and ADSP databases.

:{{note| '''It is HIGHLY recommended that you not attempt to place an sqlite3 database outside of kodi's path. sqlite3 contains no filesystem abstraction, so this will plain break on any non-local (as far as Kodi is concerned) paths. Use this for mysql only.'''}}

'''Parent tags:'''

* '''<videodatabase>'''
* '''<musicdatabase>'''
* '''<tvdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''
* '''<epgdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''
* '''<adspdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''
{{MySQL warning}}

'''Child tags: '''

;<type>
: ''Required'' - Can be either "sqlite3" or "mysql" (default: sqlite3)

;<host>
:''Required'' -
* sqlite3: defines the relative path to the database file (eg. /usr/local/kodi/databases).
* mysql: defines the host of the mysql socket (eg. localhost, 192.168.0.1, etc)

;<port>
: ''Optional'' -
* sqlite3: silently ignored
* mysql: defines the port of the mysql socket (default: 3306)

;<name>
: ''Optional'' -
:by default "MyVideos"+DB number will be used.
* sqlite3: defines the name of the database file to read from, excluding the ".db" extension.
* mysql: defines the name of the database to use

;<user>
: ''Required for MySQL'' -
* sqlite3: silently ignored
* mysql: defines the user with privileged access to the database

;<pass>
: ''Required for MySQL'' -
* sqlite3: silently ignored
* mysql: defines the password for the user with privileged access to the database

;<compression>
: ''Optional'' - Defaults to false. Set to "true" to enable MySQL compression protocol. Performance benefit is going to be largely dependent on the network bandwidth, latency between database and clients and on the size of the result sets. [https://github.com/xbmc/xbmc/pull/6484]
: {{Note|Slower clients (such as the RPi and others) won't benefit from it as the zlib de-compression overhead is higher than the actual compression savings}}

;<key>
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

;<cert>
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

;<ca>
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

;<capath>
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

;<ciphers>
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

'''Examples:'''

1) Configure a database for MySQL.
:{{note| ''The '''<videodatabase>''', '''<musicdatabase>''', '''<tvdatabase>''', '''<epgdatabase>''', and '''<adspdatabase>''' tags are interchangeable here.''}}
<syntaxhighlight lang=xml enclose="div">
<videodatabase>
<type>mysql</type>
<host>192.168.0.10</host>
<name>kodi_video</name>
<user>kodi</user>
<pass>kodi</pass>
</videodatabase>
</syntaxhighlight>

2) Configure a database for an sqlite database.
:{{note| ''The '''<videodatabase>''', '''<musicdatabase>''', '''<tvdatabase>''', '''<epgdatabase>''', and '''<adspdatabase>''' tags are interchangeable here.''}}
<syntaxhighlight lang=xml enclose="div">
<musicdatabase>
<type>sqlite3</type>
<host>/usr/local/share/kodi/databases</host>
</musicdatabase>
</syntaxhighlight>

<section end="videodatabase" />

=== externalplayer ===
{{anchor|.3Cexternalplayer.3E}}
{{see|External players}}

== Music settings ==

=== musicextensions ===
{{anchor|.3Cmusicextensions.3E}}
<section begin="musicextensions" />
Default extensions for MUSIC:
<pre>
.nsv .m4a .flac .aac .strm .pls .rm .rma .mpa .wav .wma .ogg .mp3 .mp2 .m3u .gdm .imf .m15 .sfx
.uni .ac3 .dts .cue .aif .aiff .wpl .xspf .ape .mac .mpc .mp+ .mpp .shn .zip .wv .dsp .xsp .xwav
.waa .wvs .wam .gcm .idsp .mpdsp .mss .spt .rsd .sap .cmc .cmr .dmc .mpt .mpd .rmt .tmc .tm8
.tm2 .oga .url .pxml .tta .rss .wtv .mka .tak .opus .dff .dsf .m4b .dtshd
</pre>

It is possible to add or remove extensions for Music, using the following XML tags. Useful if you keep, say, FLAC and mp3 versions of music in the same folder. The <remove> tag can be used to remove mp3 from being listed in the library, leaving only the higher quality FLAC being displayed.

<musicextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</musicextensions>

<section end="musicextensions" />

=== cddbaddress ===
{{anchor|.3Ccddbaddress.3E}}
The address of the online CDDb database. You may set this to another freedb mirror if there is a more suitable one.

Default:
<syntaxhighlight lang=xml enclose="div>
<cddbaddress>freedb.freedb.org</cddbaddress>
</syntaxhighlight>

=== songinfoduration ===
{{anchor|.3Csonginfoduration.3E}}
This controls how long the song information will remain onscreen when the song changes during visualisations. The valid range is "1" to "Indefinite (0)", in seconds. This does not include the duration of any transition effects.

Default:
<syntaxhighlight lang=xml enclose="div">
<songinfoduration>10</songinfoduration>
</syntaxhighlight>

=== musicfilenamefilters ===
{{anchor|.3Cmusicfilenamefilters.3E}}
Contains filters to match music information (artist, title etc.) from a tag-less music filename. The first <filter> to match completely is used. Matched items include:

<pre>
%A - Artist
%T - Title
%B - Album
%N - Track number
%S - Part of set (disk number)
%D - Duration
%G - Genre
%Y - Year
%R - Rating
</pre>

Example:
<syntaxhighlight lang=xml enclose="div">
<musicfilenamefilters>
<filter>%A - %T</filter>
</musicfilenamefilters>
</syntaxhighlight>

=== musiclibrary ===
Options specific to the Music Library
<section begin="MusicLibrary" />
<syntaxhighlight lang="xml" line='line'>
<musiclibrary>
<allitemsonbottom>true</allitemsonbottom> 
<cleanonupdate>false</cleanonupdate> 
<recentlyaddeditems>35</recentlyaddeditems> 
<albumformat>%B - %Y</albumformat> 
<prioritiseapetags>true</prioritiseapetags> 
<itemseparator> / </itemseparator> 
<artistseparators> 
<separator>;</separator>
<separator>:</separator>
<separator>|</separator>
<separator> feat. </separator>
<separator> ft. </separator>
</artistseparators>
<dateadded>1</dateadded> 


<useisodates>false</useisodates> 
</musiclibrary>
</syntaxhighlight>
{{Note|Changing the <itemseparator> or <artistseparators> will only affect newly added items. A rescan won't change the existing ones. Remove the Source(s) or delete the Music DB and rebuild. This process should be made easier from v18 and up using <promptfulltagscan>}}<section end="MusicLibrary" />

== Photos settings ==

=== pictureextensions ===
{{anchor|.3Cpictureextensions.3E}}
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Pictures window.

Default extensions for PICTURES:
<pre>
.png .jpg .jpeg .bmp .gif .ico .tif .tiff .tga .pcx .cbz .zip .rss .webp .jp2 .apng
</pre>

Examples:
<syntaxhighlight lang=xml enclose="div">
<pictureextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</pictureextensions>
</syntaxhighlight>

=== pictureexcludes ===
{{anchor|.3Cpictureexcludes.3E}}
Matches filenames or folders which should be excluded from being displayed in My Pictures using a list of Regular Expressions

<syntaxhighlight lang=xml enclose="div">
<pictureexcludes> 
<regexp>small</regexp>
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</pictureexcludes>
</syntaxhighlight>

=== slideshow ===
{{anchor|.3Cslideshow.3E}}
<syntaxhighlight lang=xml enclose="div">
<slideshow>

<panamount>2.5</panamount>

<zoomamount>5.0</zoomamount>



<blackbarcompensation>20</blackbarcompensation>
</slideshow>
</syntaxhighlight>

== Network settings ==

=== ftp ===
{{anchor|.3Cftp.3DE}}
Specific settings if a ftp server is in use as a source

<syntaxhighlight lang=xml enclose="div">
<ftp>
<remotethumbs>true</remotethumbs> 
</ftp>
</syntaxhighlight>

=== samba ===
{{anchor|.3Csamba.3E}}
<syntaxhighlight lang=xml enclose="div">
<samba>
<doscodepage></doscodepage> 
<clienttimeout>10</clienttimeout> 
<statfiles>true</statfiles> 
</samba>
</syntaxhighlight>

=== hosts ===
{{anchor|.3Cfhosts.3E}}
Static dns entries which take precedence over your dns server.
<syntaxhighlight lang=xml enclose="div">
<hosts>
<entry name="HOSTNAME">IPADDRESS</entry>
</hosts>
</syntaxhighlight>

=== network ===
{{anchor|.3Cnetwork.3E}}

<syntaxhighlight lang=xml line='line'>
<network>
<curlclienttimeout>10</curlclienttimeout> 
<curllowspeedtime>20</curllowspeedtime> 
<curlretries>2</curlretries> 
<httpproxyusername></httpproxyusername> 
<httpproxypassword></httpproxypassword> 
<disableipv6>false</disableipv6> 
<disablehttp2>false</disablehttp2> 
<nfstimeout>30</nfstimeout> 
<catrustfile>filepath</catrustfile> 
<curlkeepaliveinterval>30</curlkeepaliveinterval> 
</network>
</syntaxhighlight>

{{Note|In Kodi v17, the three buffer settings are removed from the <code><network></code> tag and now placed under the new <code><cache></code> tag. See '''[[#cache]]''' for full details.}}

<curlkeepaliveinterval><ref>https://github.com/xbmc/xbmc/pull/19319</ref>

=== cache ===
{{see also|HOW-TO:Modify_the_video_cache}}
<syntaxhighlight lang=xml enclose="div">
<cache>
<memorysize>0</memorysize> 
<buffermode>0</buffermode> 
<readfactor>4.0</readfactor> 
</cache>
</syntaxhighlight>

=== airtunesport ===
{{anchor|.3Cairtunesport.3E}}<section begin="airtunesport" />
This overwrites the defalt listening port of the AirTunes server (announced via zeroconf).
<section end="airtunesport" />

=== airplayport ===
{{anchor|.3Cairplayport.3E}}<section begin="airplayport" />
This overwrites the default listening port of the AirPlay server (announced via zeroconf).
<section end="airplayport" />

== File system settings ==

=== packagefoldersize ===
<section begin="packagefoldersize" />
{{anchor|.3Cpackagefoldersize.3E}}
{{xml setting
| tag name = packagefoldersize
| option type = numerical
| option values =
| default values = 200
| platform = all
| XBMC version = 12
| description = The amount (in megabytes) of add-on zip packages saved from previous add-on installs. These packages are mainly used for the [[Add-ons|add-on]] rollback feature. Increasing the size should increase the amount of past versions saved. Defaults to 200 MB.
| example = Example: <syntaxhighlight lang=xml enclose="div"><packagefoldersize>200</packagefoldersize> </syntaxhighlight>
}}
<section end="packagefoldersize" />

=== detectasudf ===
{{anchor|.3Cdetectasudf.3E}}
Set to true if you wish to detect joint ISO9660/UDF disks as UDF.

Default: False

=== handlemounting ===
{{anchor|.3Chandlemounting.3E}}
Only used in Linux, it defines if Kodi should attempt to mount media drives (via udisks or udisks2).

Default: False. If kodi is executed with the --standalone option (e.g. as done by kodi-standalone.sh) it by default will be True.

=== pathsubstitution ===
{{anchor|.3Cpathsubstitution.3E}}
{{main|Path substitution}}

{{divbox|red||'''Note:''' Path substition for "sources" and profiles is broken, and will '''NOT''' be fixed.}}

Path substitutions are for use for redirecting file paths. These are processed in order, and are useful for substituting an absolute path on a PC with a path suitable for Kodi to handle.

Default: No path substitutions defined.

Example:
<syntaxhighlight lang=xml enclose="div">
<pathsubstitution>
<substitute>
<from>G:\dvds\</from>
<to>smb://somecomputer/g-share/dvds/</to> 
</substitute>
</pathsubstitution>
</syntaxhighlight>

== Input control settings ==

=== remotedelay ===
{{anchor|.3Cremotedelay.3E}}
The repeat delay for a LIRC remote control. A delay value between 1 and 20 before a remote button starts repeating on a long keypress (i.e. continuously sending button pushes while it's held down).

Default: 3
<syntaxhighlight lang=xml enclose="div">
<remotedelay>10</remotedelay>
</syntaxhighlight>

=== controllerdeadzone ===
{{anchor|.3Ccontrollerdeadzone.3E}}
This advanced settings has been removed.
Since v17, the [[Advancedsettings.xml#controllerdeadzone|<controllerdeadzone>]] advanced setting has been removed. Deadzones can now be configured by plugging in the controller and selecting it in Settings -> System settings -> Input -> Peripherals.

=== enablemultimediakeys ===
{{anchor|.3Cenablemultimediakeys.3E}}
This setting only has any effect on Windows versions of Kodi, and only applies to builds from 28th May 2011 onwards.
In Windows the multimedia keys generate a WM_APPCOMMAND message in addition the keypress. Kodi processes both keypresses and the WM_APPCOMMAND messages, and the end result would be that the command is executed twice. To avoid this, by default multimedia keypresses are disabled. Although it should rarely be necessary, the enablemultimediakeys setting allows you to enable the multimedia keys.

Example:
<syntaxhighlight lang=xml enclose="div">
<enablemultimediakeys>true</enablemultimediakeys>
</syntaxhighlight>

=== seeksteps ===
{{Main|Skip steps}}

This setting changes which increments are available in the settings GUI for additive seeking. Note that <code><seeksteps></code> is not used to actually choose which seek steps are enabled.

'''Default:'''
<syntaxhighlight lang=xml enclose="div">
<seeksteps>7, 15, 30, 60, 180, 300, 600, 900, 1800</seeksteps>
</syntaxhighlight>

{{editor note|the defaults need to be updated for seeksteps.}}

=== touchscreen ===
{{anchor|.3Ctouchscreen.3E}}
This setting allows you to move/align the origin of the touch screen with the origin of the display used. If touch input does not result in a correct movement of the mouse pointer, the behaviour can be corrected with an offset and a stretch/compress factor.

Example:
<syntaxhighlight lang=xml enclose="div">
<touchscreen>
<x_offset>0</x_offset> 
<y_offset>0</y_offset> 
<x_stretch_factor>1.0</x_stretch_factor> 
<y_stretch_factor>1.0</y_stretch_factor> 
</touchscreen>
</syntaxhighlight>

=== scanirserver ===
Introduced in v18 and used in MS Windows setups only.<ref>https://github.com/xbmc/xbmc/pull/13896</ref>
Used to disable the regular connection attempts to the IR Server Suite when there is no remote to connect to.

The default setting is to allow connection attempts. To disable connection attempts change value to '''false'''.
<syntaxhighlight lang=xml enclose="div">
<scanirserver>true</scanirserver>
</syntaxhighlight>

== Other interface settings ==

=== window ===
{{anchor|.3Cwindow.3E}}
{{note|This is a "hidden" guisettings.xml setting (defined by the mouse moving the window size), but it is mentioned here because it is a particularly useful override when used in advancedsettings.xml}}
This allows you to manually set the default size of Kodi's windowed mode. If you resize the window, it will return to the set size when restarting.

WIDTH and HEIGHT are the values for each dimension, in pixels.

<syntaxhighlight lang=xml enclose="div">
<window>
<width>WIDTH</width>
<height>HEIGHT</height>
</window>
</syntaxhighlight>

=== restrictcapsmask ===
{{anchor|.3Crestrictcapsmask.3E}}
Windows only. A bitmask to prevent Kodi from using detected texture capabilities of the GPU. This helps work around buggy hardware/drivers.

1: prevent the use of compressed textures (DXT1, DXT3, DXT5)
2: prevent the use of non-power-of-two dimensions for textures
4: prevent the use of compressed textures with non-power-of-two dimensions.

<syntaxhighlight lang=xml enclose="div">
<restrictcapsmask>0</restrictcapsmask>
</syntaxhighlight>

=== algorithmdirtyregions ===
{{anchor|.3Calgorithmdirtyregions.3E}}
{{see also|HOW-TO:Modify dirty regions}}
<section begin="algorithmdirtyregions" />{{note|Some GPU/hardware configurations will have some minor issues (such as a visual "flicker"). For those situations try mode 2 or use the default (mode 3, which requires no advancedsetting). Almost all ARM-based devices (such as [[Android]]) willl likely have flickering issues.}}

Enable dirty-region processing. Dirty regions are any parts of the screen that have changed since the last frame. By not re-rendering what hasn't changed the GUI can be sped up. Because all GPUs work differently, only Mode 3 is guaranteed to work for everyone without flickering issues. This mode will reduce CPU/GPU usage, but will not increase GUI speed.

{| class="prettytable"
! value !! result !! description
|-
! 0
| Off
| The entire viewport is always rendered.
|-
! 1
|Union
|All dirty regions are grouped into the smallest possible rectangle. This is typically the fastest mode for slower GPUs due to only making one pass.
|-
! 2
| {{nowrap|Cost reduction}}
| Each dirty region is presented separately, in as many passes as there are regions.
|-
! 3
| {{nowrap|Whole Screen}}
| The entire screen is rendered if there are any dirty regions. This is a safe default for drivers that clear buffer contents (manifests as blinking or vibrating images). '''Default'''
|}<section end="algorithmdirtyregions" />

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<algorithmdirtyregions>1</algorithmdirtyregions>
</gui>
</syntaxhighlight>

=== visualizedirtyregions ===
{{anchor|.3Cvisualizedirtyregions.3E}}
{{see also|HOW-TO:Modify dirty regions}}
<section begin="visualizedirtyregions" />Enable dirty-region visualization. Paints a rectangle over marked controls.

* true: on
* false: off '''(Default)'''

{{note|This is only a development mode and isn't of use to normal users.}}
<section end="visualizedirtyregions" />
Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<visualizedirtyregions>true</visualizedirtyregions>
</gui>
</syntaxhighlight>

=== smartredraw ===

{{note|This is an experimental feature and you might face issues using it. So please be aware of that.}}

This new feature was introduced in Kodi 18 and if enabled, the GUI process call (and therefore the render call) is only done if anything has changed. The result will be a faster GUI and less load if Kodi plays a video

* true: on
* false: off '''(Default)'''

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<smartredraw>true</smartredraw>
</gui>
</syntaxhighlight>

=== showexitbutton ===
{{anchor|.3Cshowexitbutton.3E}}
Setting to hide the exit button, useful for people running appliance based setups where exit would only confuse/complicate the user. Modifiable via the advancedsettings.xml by setting showexitbutton to false, default is true (show)

Example:
<syntaxhighlight lang=xml enclose="div">
<showexitbutton>true</showexitbutton>
</syntaxhighlight>

=== fullscreen ===
{{anchor|.3Cfullscreen.3E}}
Starts Kodi in full screen (check resolutions!).

<syntaxhighlight lang=xml enclose="div">
<fullscreen>false</fullscreen>
</syntaxhighlight>

=== splash ===
{{anchor|.3Csplash.3E}}
Set to false if you wish to disable the startup splash image. Defaults to true.

<syntaxhighlight lang=xml enclose="div">
<splash>true</splash>
</syntaxhighlight>

=== cputempcommand ===
{{anchor|.3Ccputempcommand.3E}}
Provide a shell command Kodi will use to get CPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]".<br />
;<u>For Nvidia and Raspberry Pi</u>
<syntaxhighlight lang=xml enclose="div">
<cputempcommand>sed -e 's/$[0-9]*$[0-9]\{3\}.*/\1 C/' /sys/class/thermal/thermal_zone0/temp</cputempcommand>
</syntaxhighlight>
or
<syntaxhighlight lang=xml enclose="div">
<cputempcommand>echo "$(sensors -u | tail -n64 | grep temp1_input | awk '{print $2 }' |awk '{printf("%d\n",$1 + 0.5);}') C"</cputempcommand>
</syntaxhighlight>
;<u>For ATI/AMD</u>
<syntaxhighlight lang=xml enclose="div">
<cputempcommand>sensors|sed -ne "s/temp1: \+[-+]$[0-9]\+$.*/\1 C/p"</cputempcommand>
</syntaxhighlight>

=== gputempcommand ===
{{anchor|.3Cgputempcommand.3E}}
Provide a shell command Kodi will use to get GPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]".<br />
;<u>For Nvidia</u>
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>echo "$(nvidia-settings -tq gpuCoreTemp) C"</gputempcommand>
</syntaxhighlight>
or
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>echo "$(nvidia-smi -q -d TEMPERATURE | grep Gpu | cut -c35-36) C"</gputempcommand>
</syntaxhighlight>
;<u>For ATI/AMD</u>
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>/usr/bin/aticonfig --od-gettemperature | grep Temperature | cut -f 2 -d "-" | cut -f 1 -d "." | sed -e "s, ,," | sed 's/$/ C/'</gputempcommand>
</syntaxhighlight>

;<u>For Raspberry Pi</u>
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>/opt/vc/bin/vcgencmd measure_temp | sed -e "s/temp=//" -e "s/\..*'/ /"</gputempcommand>
</syntaxhighlight>

=== glrectanglehack ===
{{anchor|.3Cglrectanglehack.3E}}
Problems with ghosting or videos which are only played back in the left upper quarter? The following ATI hack may solve it.
<syntaxhighlight lang=xml enclose="div">
<glrectanglehack>yes</glrectanglehack>
</syntaxhighlight>

=== alwaysontop ===
{{anchor|.3Calwaysontop.3E}}
Added in XBMC v9.11 (Windows OS only). Keeps Kodi always on top when windowed.
<syntaxhighlight lang=xml enclose="div">
<alwaysontop>yes</alwaysontop>
</syntaxhighlight>

There is also a fake fullscreen GUI option in Kodi's settings.

=== minimizetotray ===
{{anchor|.3Cminimizetotray.3E}}
{{note|Available in Kodi v20 and above.}}

Windows only. Minimizes Kodi to the system tray. Defaults to false.
<syntaxhighlight lang=xml enclose="div">
<minimizetotray>true</minimizetotray>
</syntaxhighlight>

= Removed tags =
{{anchor|Recently removed tags}}
* {{anchor|.3Cthumbsize.3E}}'''<thumbsize>''' - replaced by <[[#imageres|imageres]]> in v12 Frodo
* {{anchor|.3Cfanartheight.3E}}'''<fanartheight>''' - replaced by <[[#fanartres|fanartres]]> in v12 Frodo
* {{anchor|.3Cdvdthumbs.3E}}'''<dvdthumbs>''' - removed in v12 Frodo
* {{anchor|.3Cbusydialogdelayms.3E}}'''<busydialogdelayms>''' - removed in v12 Frodo
* {{anchor|.3Cbginfoloadermaxthreads.3E}}'''<bginfoloadermaxthreads>''' - removed in v13 Gotham
* '''<showepginfoonselect>''' - replaced by a GUI setting in v13 Gotham
* '''<resample>''', '''<forceDirectSound>''', '''<audiophile>''', '''<audiosinkbufferdurationmsec>''', '''<allowtranscode44100>''', and '''<streamsilence>''' - These were various sub-tags for <audio> that were removed in v13 Gotham and either replaced by GUI settings or were no longer needed.
* {{anchor|.3Cenableairtunesdebuglog.3E}}'''<enableairtunesdebuglog>''' - replaced by a GUI option in v14 Helix
* '''<videoDisableHi10pMultithreading>''' - renamed to <disableswmultithreading> in v14 Helix
* '''<hideallitems>''' - For both the <code><videolibrary></code> and <code><musiclibrary></code> sections, this is replaced by a GUI option in v15 Isengard
* '''<SmallStepBackSeconds>''' - In v15 the <code>SmallStepBack</code> [[Action_IDs]] has been replaced by <code>seek(-7)</code> in default keymaps. See '''[[skip steps]]''' for details. When the original <code>SmallStepBack</code> action ID is used it defaults to the first backwards [[skip steps|additive seeking value]].
* '''<timeseekforward>/<timeseekbackward>''' - In v15 these tags are replaced by GUI options via [[skip steps|additive seeking]], which is configured in the GUI. See '''[[skip steps]]''' for details.
* {{anchor|.3Ckaraoke.3E}}'''<karaoke>''' - In v16 all of the karaoke features in Kodi were removed.
* '''<useddsfanart>''' - removed in v17 Krypton.
* '''<cachemembuffersize>''' and '''<readbufferfactor>''' - In v17 '''<cachemembuffersize>''' is renamed to '''<memorysize>''' and <code><readbufferfactor></code> is renamed to <code><readfactor></code>. In addition, all three buffer related settings in <network> are moved out of <network> and into a new <cache> parent tag.
* '''<minvideocachelevel>''', '''<minaudiocachelevel>''', and '''<cacheindvdplayer>''' have been removed in v17.
* '''<useffmpegvda>''' - Tag was only used for development testing. Removed in v17.
* '''<nofliptimeout>''' - Removed in v17
* '''<blackbarcolour>''' - Removed in v17 (maybe?)
* '''<disableswmultithreading>''' - Removed in v17 (maybe?)
* {{anchor|.3Cmeasurerefreshrate.3E}}'''<measurerefreshrate>''' - Removed in v17 or v18?
* {{anchor|.3Cmyth.3E}}'''<myth>''' - Removed sometime between v16 to v18
* {{anchor|.3Ctuxbox.3E}}'''<tuxbox>''' - Removed
* '''<backgroundupdate>''' - Removed
* '''<hideemptyseries>''' - Replaced by a GUI option.
* '''<mymovies>''' and child tag '''<categoriestogenres>''' - Removed
* '''<albumssortbyartistthenyear'''> - Removed
* '''<albumformatright>''' - Removed
* {{anchor|.3Cremoterepeat.3E}}'''<remoterepeat>''' - Removed
* {{anchor|.3Callowd3d9ex.3E}}'''<allowd3d9ex>''' and {{anchor|.3Cforced3d9ex.3E}}'''<forced3d9ex>''' - Removed sometime between v16 to v18
* '''<lingertime>''' - Replaced by a GUI setting in v18
* '''<forcevaapienabled>''' - Removed in v18
* '''<promptfulltagscan>false</promptfulltagscan>''' Removed in v18. Now automatically asked each time a scan is conducted.
* '''<controllerdeadzone>''' - Removed in v17
* '''<omxdecodestartwithvalidframe>''' - This tag is only in some Raspberry Pi specific distributions, such as OpenELEC. As of March 2015, this tag has not been merged into "vanilla" Kodi builds
* '''<musicthumbs>''' Replaced in v19 by the GUI setting '''Thumbnail image files''' found in Media -> Music
* '''<artistextraart>''' Replaced in v19 by the GUI setting '''Artist art types whitelist''' found in Media -> Music
* '''<albumextraart>''' Replaced in v19 by the GUI setting '''Album art types whitelist''' found in Media -> Music
* '''<episodeextraart>''' Replaced in v19 by the GUI setting '''Episode art types whitelist''' found in Media -> Videos
* '''<tvshowextraart>''' Replaced in v19 by the GUI setting '''TV show art types whitelist''' found in Media -> Videos
* '''<tvseasonextraart>''' Replaced in v19 by the GUI setting '''TV show art types whitelist''' found in Media -> Videos
* '''<movieextraart>''' Replaced in v19 by the GUI setting '''Movie art types whitelist''' found in Media -> Videos
* '''<moviesetextraart>''' Replaced in v19 by the GUI setting '''Movie art types whitelist''' found in Media -> Videos
* '''<musicvideoextraart>''' Replaced in v19 by the GUI setting '''Music video art types whitelist''' found in Media -> Videos
* '''<fanart>''' Removed in v19
* '''<assfixedworks>''' Removed in v20
* '''<try10bitoutput>''' Removed in v20 and replaced with [[Settings/System/Display#Use_10_bit_for_SDR|Use 10 bit for SDR]] setting <ref>https://github.com/xbmc/xbmc/pull/20014</ref>

= guisettings.xml Setting Conversion =
It is possible to convert settings found in the '''[[Settings]]''' ''(guisettings.xml)'' pages of {{kodi}} into entries for the advancedsettings.xml file.

When a setting from the guisettings.xml is added to the advancedsettings.xml file, it will override the existing guisettings.xml values and the setting will be removed from the settings pages.

Why would I need to do this?
* You set up multiple devices and then need to individually change settings and preferences on each device. Using this conversion method, you save those settings in the advancedsettings.xml file and simply add the file to each device
* You need to hide settings to prevent those settings from being modified

To convert a guisetting to advancedsettings.xml follow these steps:
# In the {{kodi}} settings pages, adjust the setting(s) to your preference.
# Back out of the settings pages to the main menu, which forces {{kodi}} to save the adjusted settings to the guisettings.xml file
# Locate the guisettings.xml file in the [[Userdata]] folder and open it
# Locate the setting(s) to be converted. The list can be overwhelming so make use of the Search feature of whichever editor you are using
# Using the following setting as an example:
<syntaxhighlight lang="xml">
<setting id="videolibrary.showemptytvshows">true</setting>
</syntaxhighlight>
: Breaking down the string:
::'''videolibrary'''- parent tag
::'''showemptytvshows'''- child tag
::'''true'''- value
: The conversion is as follows and place this in the advancedsettings.xml file
<syntaxhighlight lang="xml">
<advancedsettings version="1.0">
<videolibrary>
<showemptytvshows>true</showemptytvshows>
</videolibrary>
</advancedsettings>
</syntaxhighlight>

'''Note:''' Some parent tags may already be in use in your advancedsettings.xml file. Do not duplicate them, but add the child tag beneath the existing parent tag.

= References =
<references />

{{Updated|18}}
{{DISPLAYTITLE:advancedsettings.xml}}

[[Category:Advanced topics]]
[[Category:Manual]]
[[Category:Settings]]

MySQL/Setting up MySQL

2023-02-07T07:12:54Z

CastagnaIT: Restricting MySQL access rights - Fix wrong command for MySQL 8.0 Server and upwards

{{:MySQL/Contents}}
{{mininav| [[MySQL]] }}
You'll need to choose which of your computers, Kodi devices, or NAS will be the MySQL server. The server needs to be on 24/7 or have wake-on-lan (preferably the former), and needs to have a local static IP. You will probably want the Kodi device that is hosting most or all of your videos and music to also be the MySQL server, but this is not required.
{{-}}

{{redv|'''Please Note:'''| Do not manually create the MySQL/MariaDB databases on your database server. Set up the MySQL/MariaDB server, and Kodi will create the specific databases for you.}}
{{redv|'''Also:'''| Some versions of MySQL set their passwords to expire by default, '''even the root password'''! If the password expires, Kodi cannot access the database and the TV Series and Movies libraries will disappear.<br />
To avoid this and/or fix it after it happens, make sure the account's password does not expire. (See: https://dev.mysql.com/doc/refman/5.7/en/password-management.html )}}

MySQL/MariaDB can be installed on just about every major OS and NAS:

{{redv|'''Important:'''| Please use only supported versions of the MySQL or MariaDB server. As of January 2019, this is MySQL in at least version 5.7 or MariaDB in at least version 5.5, but version 10.3+ is recommended.}}

=Ubuntu Linux=
'''Ubuntu Linux:'''
#<code>$sudo apt-get install mysql-server</code> ''(see also: https://help.ubuntu.com/18.04/serverguide/mysql.html )''
#Create a password when asked
#To configure MySQL to listen for connections from network hosts, edit ''/etc/mysql/mysql.conf.d/mysqld.cnf'' and change the bind-address directive to the server's IP address:
##from: <code>bind-address = 127.0.0.1</code>
##to: <code>bind-address = 192.168.0.5</code>
#*Note: Replace 192.168.0.5 with the appropriate address.
#*Note: To allow both local and remote access (i.e. from both the MySQL host to itself and also from other clients), either comment out the bind-address using a hash (#) to disable it, or use <code>bind-address = 0.0.0.0</code> to open it completely.
#When using MySQL8 or higher (Ubuntu 20.04 or later), add the following line at the end of ''/etc/mysql/mysql.conf.d/mysqld.cnf'':
##<code>default_authentication_plugin=mysql_native_password</code>
#Restart your MySQL server. <code>sudo service mysql restart</code>
#Get into the MySQL command line utility: <code>mysql -u root -p</code>
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##*Note: When using MySQL8 or higher, there are additional password requirements and new authentication methods. Using the following command should avoid errors. Type in: <code>CREATE USER 'kodi' IDENTIFIED WITH mysql_native_password BY 'kodi123#';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=Arch Linux=
'''Arch Linux:'''
*Please note: Arch, along with many other distributions, has migrated to the faster and more open MariaDB. It is a drop in replacement to MySQL and, thus, Kodi will require no modifications to work with it.
#Install MariaDB: <code>$ sudo pacman -S mariadb</code>
#Start the service: <code>$ sudo systemctl start mysqld</code>
#To have it automatically launch at startup: <code>$ sudo systemctl enable mysqld</code>
#Create a password: <code>$ /usr/bin/mysql_secure_installation</code> ''This will also clean up the demo database.''
#Get into the MariaDB command line utility: <code>$ mysql -u root -p</code>
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=RedHat based Linux=
'''RedHat based Linux (RHEL, CentOS, Fedora):'''
#<code>$sudo yum install mysql-server</code>
#Create a password when asked
#To configure MySQL to listen for connections only from network hosts, edit ''/etc/mysql/my.cnf'' and add the bind-address directive to the server's IP address:<br /><code>bind-address = 192.168.0.5</code>
#*Note: Replace 192.168.0.5 with the appropriate address.
#*Note: Alternatively you can leave this file as is to allow local and remote access.
#Restart your MySQL server. <code>$sudo /sbin/service mysqld restart</code>
#*Recommended - Set your MySQL root password with <code>/usr/bin/mysqladmin -u root password 'new-password'</code>
#Get into the MySQL command line utility: <code>$mysql -u root -p</code>
#*Enter your MySQL root password as set above, or just press enter if you didn't set one to log in with a blank password
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=RaspberryPi Raspbian=

'''RaspberryPi Raspbian:'''
#<code>$sudo apt-get update && sudo apt-get dist-upgrade</code> to ensure that you have the very latest iteration of Raspbian. ''(September 2017 as of writing this)''
#<code>$sudo apt-get install mysql-server</code> to install ''MYSQL Server''.
#To configure MySQL to listen for connections from network hosts, <code>$sudo nano /etc/mysql/mariadb.conf.d/50-server.cnf</code> and change the bind-address directive to the server's IP address:
##from: <code>bind-address = 127.0.0.1</code>
##to: <code>bind-address = 192.168.0.5</code>
#*Note: Replace 192.168.0.5 with the appropriate address.
#*Note: To allow both local and remote access (i.e. from both the MySQL host to itself and also from other clients), either comment out the bind-address using a hash (#) to disable it, or use <code>bind-address = 0.0.0.0</code> to open it completely.
#Restart your MySQL server: <code>sudo service mysql restart</code>
#Get into the MySQL command line utility: <code>sudo mysql</code>
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=Mac OS X=
'''Mac OS X:'''
#Download a copy of MySQL server from http://dev.mysql.com/downloads/mysql/
#In Mac OS X, go to System Preferences -> MySQL, and click on “Start MySQL Server”. You’ll also want to tick to enable the “Automatically … on Startup” option.
#Now to set up the "kodi" user in MySQL and give it access. Launch Terminal.app on your Mac and issue the following commands, one line at a time:
##<code>sudo /usr/local/mysql/bin/mysql</code>
##<code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code>
##<code>GRANT ALL ON *.* TO 'kodi';</code>
##<code>exit</code>
#Remain in Terminal.app. Now you'll be giving other computers on your network access to MySQL. Enter the next set of commands, one line at a time:
##<code>cd /usr/local/mysql/support-files/</code>
##<code>sudo cp my-huge.cnf /etc/my.cnf</code>
##:''The command line will ask for your Mac OS X user password. Enter it and press return. No text will show when you type your password in, this is normal.
##<code>cd /etc</code>
##<code>sudo nano my.cnf</code>
##:''This opens a file in a command line text editor''
##Scroll down to the [mysqld] section and add or edit the following line so that it appears as:
##:<code>bind-address = ***.***.***.***</code>
##Save and exit from the command line text editor
#Reboot the Mac, or restart the MySQL service from the System Preferences pane you installed earlier

*Alternative guide for Mac OS X: http://forum.kodi.tv/showthread.php?tid=151631

=Windows=
== Installing MySQL on Windows ==
If you have chocolatey installed run '''choco install mysql'''
:'''or'''
#Download a copy of MySQL server from https://dev.mysql.com/downloads/windows/installer/8.0.html
#Select ''Archives'' when you want the last stable main version 5.7.36 instead of version 8.0.x.
#Create a password when asked
#Select that you want the database to have network access when prompted during installation.

If you're using a firewall such as the one that's built into Windows, you will need to follow the steps below for the version of windows you installed Kodi on.
=== Windows 7/8/8.1 Built-in Firewall ===
: Run the following command in powershell or execute all the steps below.
:::<syntaxhighlight lang="text" enclose="div">
New-NetFirewallRule -DisplayName "Allow inbound TCP Port 3306 for MySQL" -Direction inbound –LocalPort 3306 -Protocol TCP -Action Allow
</syntaxhighlight>
:#Go to control panel and open Windows Firewall
:#Click on Advanced Settings
:#Click on Inbound Rules, then New Rule
:#For the Rule Type, choose '''''Port''''' and hit Next
:#For Protocol and Ports, select TCP protocol and type in '''''3306''''' for the '''''Specific local ports''''' and hit Next
:#For Action, leave it at default which is '''''Allow the connection''''' and hit Next
:#For Profile, you can leave it as default (everything checked by default) and hit Next
:#For Name, set it to '''''MySQL''''' or any name that you will know what it is and click Finished

== Setup users in MySQL for Kodi clients ==

#Open the "MySQL Command Line Client" from the MySQL start menu
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool

{{Note|If Kodi is unable to connect to the MySQL server, returning an error code [1130]:}}<br/>
If this occurs to you, try amending Step 2 above to read <code>GRANT ALL ON *.* TO 'kodi'@'xxx.xxx.xxx.%';</code> where xxx.xxx.xxx is the first three quadrants of your home network's IP address (192.168.1 for example) and % as the last quadrant to allow addresses on the same subnet to connect.

=Other NAS=
MySQL can also be installed on some [[w:network-attached storage|network-attached storage (NAS)]] device devices. Here are some guides for various NAS devices that can have a MySQL server installed:

*Devices running Arch Linux ARM (such as the PogoPlug, Dockstar, etc) can use the [[Setting_up_MySQL|Arch Linux instructions]] on this page.
*[https://web.archive.org/web/20160329053954/http://quixventure.com/2011/12/configure-a-synology-nas-as-mysql-server-for-xbmc/ Synology NAS as MySQL server for XBMC] and http://youtu.be/3PmmDtK65ks
*http://www.robvanhamersveld.nl/2013/02/05/share-your-xbmc-12-0-library-on-a-synology-ds-or-other-nas/ Synology DS with MySQL guide based on Frodo
*http://forum.kodi.tv/showthread.php?tid=172548 - unRAID

After setting up a database server on you NAS, you should create a Kodi user with full administrative privileges. The user should be able to log in from your Kodi devices, so make sure you give the user login access from external machines.
You do not need to create a database as Kodi will create the required databases itself.

{{redv|'''Warning:'''| As you are giving the Kodi user full administrative privileges and external machine access it is recommended that you review your database security. It is highly recommenced that you block internet access to your database using an appropriate firewall. }}

=FreeNAS and freeBSD=

== About FreeNAS ==

http://www.freenas.org/

FreeNAS is a FreeBSD based NAS system that can be run on almost any hardware - it uses ZFS for disk and file management. It is used at home and in enterprise businesses. 99% of tasks can be done via the web interface.

Example below is based on FreeNAS 9.1.1 on 12/12/13, and assumes you have already configured your nas with drives, datasets etc

== How to ==

=== Make a jail ===

create a Jail via the FreeNAS webui - if unsure see here http://doc.freenas.org/index.php/Adding_Jails

make a note of the jail IP address shown - you will need this to put in the advancedsettings.xml file on the Kodi machine later

=== Prepare the jail ===

*ssh into FreeNAS
**If you have a windows PC use putty (http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html)
**(easiest) click the "shell" button in the left of the FreeNAS webui

type the following commands

*<code>jls</code>

Take note of the JID of the jail you created, use it in the command below and replace n with the number of the jail you just created

*<code>jexec n csh</code>

=== Install mysql ===
You are now inside your jail

*<code>pkg install mysql55-server</code>

*<code>pkg install nano</code>
**(nano is a text editor you will need shortly)

We now need to enable mysql in rc.conf

*<code>nano /etc/rc.conf</code>

insert the line below into the rc.conf file

*<code>mysql_enable="YES"</code>

save the file and exit (see bottom of nano edit page for keystrokes info)

*<code>service mysql-server start</code>

Optional step below - this is an automated script that will secure you mysql instance - it will prompt you for answers to questions. Its up to you if you do this.

*<code>mysql_secure_installation</code>

=== Configure mysql ready for Kodi to use ===

type in

*<code>mysql -u root -p</code>

You are now in mysql administration

* <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code>
* <code>GRANT ALL ON *.* TO 'kodi';</code>
* <code>flush privileges;</code>
* <code>quit;</code>

=Restricting MySQL access rights=
'''Optional:''' '''If you only use the MySQL server for Kodi and that server has non-critical data on it, then this probably not necessary.'''
For a more secure MySQL installation use these 2 commands to grant permission only to databases Kodi uses. This is useful if you plan on using your MySQL server for more than just Kodi, or if you're worried about your internal network being exposed and wanting to lock things down more, etc.

'''Upto MySQL Server 5.7 Server:'''
#<code>GRANT ALL ON `MyVideos%`.* TO 'kodi'@'%' IDENTIFIED BY 'kodi';</code>
#<code>GRANT ALL ON `MyMusic%`.* TO 'kodi'@'%' IDENTIFIED BY 'kodi';</code>

'''As per MySQL 8.0 Server and upwards:'''
#<code>GRANT ALL PRIVILEGES ON `MyVideos%`.* TO `kodi`@`%`;</code>
#<code>GRANT ALL PRIVILEGES ON `MyMusic%`.* TO `kodi`@`%`;</code>

{{redv|'''Careful'''|The limited grants on this page don't give the kodi user permissions to create required TRIGGERs during install or upgrade. '''Kodi requires these TRIGGERs to function properly.''' <br />
Use the broader grant *.* statement that is explained on the previous tabs while creating or upgrading the tables. Only restrict rights afterwards, if you need to. <br>
Alternatively, figure out how to specifically give the account the right to create the require TRIGGERS - this varies between MySQL versions. }}
<headertabs />

{{Next|[[MySQL/Setting up Kodi|Setting up Kodi]]}}

{{Isengard updated}}

Settings/Player/Subtitles

2023-01-17T08:05:41Z

CastagnaIT: Add note to "Position on screen" for reference to "Override subtitles styles" setting

{{mininav| [[Settings]] | [[Settings/Player|Player]] }}

__TOC__

= Styles for text based subtitles =
The settings in this section are for '''text based''' subtitles such as ''.ass,'' and ''.srt'' files.<br>
Image based subtitles, such as those from DVD (''VobSub'') or Bluray (''pgs''), are not affected by these settings.<ref>https://github.com/xbmc/xbmc/pull/20169</ref><br>
<br>
[[File:Settings-Player-Subtitles-01.jpg|600px]]

== Position on screen ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Adjust the on screen location of the subtitle.<br>
Differences between 'Bottom of screen' and 'Manual' positions:
; ''Manual'' position:
* Allow to set subtitle position by using the ''[[Settings/System/Display#Video_calibration | Screen Calibration]]'' subtitle adjustment.
* Allow to adjust position by using the [[Action_IDs|Action ID's]] ''SubtitleShiftUp'' and ''SubtitleShiftDown'' <ref>https://github.com/xbmc/xbmc/pull/21680</ref> or shortcut keys.
* The position, if changed, is permanently saved (persists over all videos or kodi reboot).
; ''Bottom of screen'' position:
* Allow to adjust position by using the [[Action_IDs|Action ID's]] ''SubtitleShiftUp'' and ''SubtitleShiftDown'' <ref>https://github.com/xbmc/xbmc/pull/21680</ref> or shortcut keys.
* The position, if changed, is temporary, e.g. playing another video will restore to the default position.
Some subtitle file formats do not allow the position of subtitles to be changed, see also ''Override subtitles styles'' setting.
|}

== Font ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Select the font for the subtitles.<br>
Additional ''.ttf'' and ''.otf'' type fonts can be added to the ''\media\fonts\'' folder located in the '''[[Kodi_data_folder#media| Kodi data folder]]'''
|}

== Size ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| Increase or decrease the size of the subtitles on screen.
|}

== Style ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| Add ''Bold, Italics'' or ''Bold italics'' effects to subtitles.
|}

== Colour ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| Change the colour of the subtitle text using the pop-up colour picker. May help reduce eyestrain caused by bright white HDR subtitles.
|}

== Opacity ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| Adjust the opacity of the subtitle
|}

== Border size ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| Apply a stroke (outline) to the text. Can help increase contrast between text and background.
|}

== Border colour ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| Change the colour of the stroke (outline) of the text using the pop-up colour picker.
|}

== Blur ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| Will apply a blur to the border.
|}

== Background type ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| Displays subtitles in a box which aids in readibility. When the type of background is selected, further settings will become visible which allow colouring of the box, shadow and opacity.<br>
Enabling this setting will disable the ''Border size'' and ''Border colour'' settings
|}

== Vertical margin ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| Adds a margin to top and bottom aligned text.<br>
This setting will affect the subtitle position set with the '''[[Settings/System/Display#Video_calibration | Video calibration setting]]'''.
|}

== Override subtitles fonts ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| Override the subtitle fonts specified in subtitle files such as ''*.ass'' and ''*.ssa''.
|}

== Override subtitles styles ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| Override the subtitle theme and alignments specified in subtitle files such as ''*.ass'', ''*.ssa'' and ''*.vtt'' (WebVTT).<br>
Enabling this setting may in some cases lead to subtitles being displayed incorrectly.
|}

== Stereoscopic 3D depth of subtitles ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Adjust the visual depth of subtitles for 3D videos. The higher the setting, the closer to the viewer the subtitles will appear.
|}

== Charater set ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Select the font character set to use for subtitles.
|}

= Closed caption subtitles =
[[File:Settings-Player-Subtitles-02.jpg|600px]]

== Enable parsing for closed captions ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Enable parsing for closed caption subtitles.
|}

= Download Services =
[[File:Settings-Player-Subtitles-03.jpg|600px]]

{{See|Subtitles}}

== Languages to download subtitles for ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Set which language subtitles to search and download.<br>
Check with your selected subtitle provider if subtitles are not found in the specified language.
|}

== Subtitle storage location ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Specify where downloaded subtitles should be saved, the same location as the video or a custom location.<br>
Options: ''Next to the video'' or ''Custom location''.
|}

== Custom subtitle folder ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| If you chose ''Custom location'' in the previous setting, set the location with this setting.
|}

== Pause when searching for subtitles ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Pause the current video while searching for subtitles and resume once the subtitle is available.
|}

== Auto download first subtitle ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Automatically download first subtitle from the search result list.
|}

== Default TV service ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Select the service that will be used as default to search for TV-show subtitles.<br>
If none are listed, use the ''Get more...'' button<br>
{{collapse top|Available subtitle providers (click 'expand' to view)}}
<dpl>
category = Nexus_add-on_repository
category = Subtitle_add-ons
notcategory = Outdated
</dpl>
{{collapse bottom}}
|}

== Default movie service ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Select the service that will be used as default to search for movie subtitles.<br>
If none are listed, use the ''Get more...'' button<br>
{{collapse top|Available subtitle providers (click 'expand' to view)}}
<dpl>
category = Nexus_add-on_repository
category = Subtitle_add-ons
notcategory = Outdated
</dpl>
{{collapse bottom}}
|}

= References =
<references />

{{top}}
{{updated|20}}

[[Category:Settings]]
[[Category:Subtitles]]

Settings/Player/Subtitles

2023-01-17T07:54:07Z

CastagnaIT: Details improvements for "Position on screen"

{{mininav| [[Settings]] | [[Settings/Player|Player]] }}

__TOC__

= Styles for text based subtitles =
The settings in this section are for '''text based''' subtitles such as ''.ass,'' and ''.srt'' files.<br>
Image based subtitles, such as those from DVD (''VobSub'') or Bluray (''pgs''), are not affected by these settings.<ref>https://github.com/xbmc/xbmc/pull/20169</ref><br>
<br>
[[File:Settings-Player-Subtitles-01.jpg|600px]]

== Position on screen ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Adjust the on screen location of the subtitle.<br>
Differences between 'Bottom of screen' and 'Manual' positions:
; ''Manual'' position:
* Allow to set subtitle position by using the ''[[Settings/System/Display#Video_calibration | Screen Calibration]]'' subtitle adjustment.
* Allow to adjust position by using the [[Action_IDs|Action ID's]] ''SubtitleShiftUp'' and ''SubtitleShiftDown'' <ref>https://github.com/xbmc/xbmc/pull/21680</ref> or shortcut keys.
* The position, if changed, is permanently saved (persists over all videos or kodi reboot).
; ''Bottom of screen'' position:
* Allow to adjust position by using the [[Action_IDs|Action ID's]] ''SubtitleShiftUp'' and ''SubtitleShiftDown'' <ref>https://github.com/xbmc/xbmc/pull/21680</ref> or shortcut keys.
* The position, if changed, is temporary, e.g. playing another video will restore to the default position.
|}

== Font ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Select the font for the subtitles.<br>
Additional ''.ttf'' and ''.otf'' type fonts can be added to the ''\media\fonts\'' folder located in the '''[[Kodi_data_folder#media| Kodi data folder]]'''
|}

== Size ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| Increase or decrease the size of the subtitles on screen.
|}

== Style ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| Add ''Bold, Italics'' or ''Bold italics'' effects to subtitles.
|}

== Colour ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| Change the colour of the subtitle text using the pop-up colour picker. May help reduce eyestrain caused by bright white HDR subtitles.
|}

== Opacity ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| Adjust the opacity of the subtitle
|}

== Border size ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| Apply a stroke (outline) to the text. Can help increase contrast between text and background.
|}

== Border colour ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| Change the colour of the stroke (outline) of the text using the pop-up colour picker.
|}

== Blur ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| Will apply a blur to the border.
|}

== Background type ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| Displays subtitles in a box which aids in readibility. When the type of background is selected, further settings will become visible which allow colouring of the box, shadow and opacity.<br>
Enabling this setting will disable the ''Border size'' and ''Border colour'' settings
|}

== Vertical margin ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| Adds a margin to top and bottom aligned text.<br>
This setting will affect the subtitle position set with the '''[[Settings/System/Display#Video_calibration | Video calibration setting]]'''.
|}

== Override subtitles fonts ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| Override the subtitle fonts specified in subtitle files such as ''*.ass'' and ''*.ssa''.
|}

== Override subtitles styles ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| Override the subtitle theme and alignments specified in subtitle files such as ''*.ass'', ''*.ssa'' and ''*.vtt'' (WebVTT).<br>
Enabling this setting may in some cases lead to subtitles being displayed incorrectly.
|}

== Stereoscopic 3D depth of subtitles ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Adjust the visual depth of subtitles for 3D videos. The higher the setting, the closer to the viewer the subtitles will appear.
|}

== Charater set ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Select the font character set to use for subtitles.
|}

= Closed caption subtitles =
[[File:Settings-Player-Subtitles-02.jpg|600px]]

== Enable parsing for closed captions ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Enable parsing for closed caption subtitles.
|}

= Download Services =
[[File:Settings-Player-Subtitles-03.jpg|600px]]

{{See|Subtitles}}

== Languages to download subtitles for ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Set which language subtitles to search and download.<br>
Check with your selected subtitle provider if subtitles are not found in the specified language.
|}

== Subtitle storage location ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Specify where downloaded subtitles should be saved, the same location as the video or a custom location.<br>
Options: ''Next to the video'' or ''Custom location''.
|}

== Custom subtitle folder ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| If you chose ''Custom location'' in the previous setting, set the location with this setting.
|}

== Pause when searching for subtitles ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Pause the current video while searching for subtitles and resume once the subtitle is available.
|}

== Auto download first subtitle ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Automatically download first subtitle from the search result list.
|}

== Default TV service ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Select the service that will be used as default to search for TV-show subtitles.<br>
If none are listed, use the ''Get more...'' button<br>
{{collapse top|Available subtitle providers (click 'expand' to view)}}
<dpl>
category = Nexus_add-on_repository
category = Subtitle_add-ons
notcategory = Outdated
</dpl>
{{collapse bottom}}
|}

== Default movie service ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Select the service that will be used as default to search for movie subtitles.<br>
If none are listed, use the ''Get more...'' button<br>
{{collapse top|Available subtitle providers (click 'expand' to view)}}
<dpl>
category = Nexus_add-on_repository
category = Subtitle_add-ons
notcategory = Outdated
</dpl>
{{collapse bottom}}
|}

= References =
<references />

{{top}}
{{updated|20}}

[[Category:Settings]]
[[Category:Subtitles]]

Settings/Player/Subtitles

2023-01-17T07:36:33Z

CastagnaIT: Add more "Override subtitles styles" details

{{mininav| [[Settings]] | [[Settings/Player|Player]] }}

__TOC__

= Styles for text based subtitles =
The settings in this section are for '''text based''' subtitles such as ''.ass,'' and ''.srt'' files.<br>
Image based subtitles, such as those from DVD (''VobSub'') or Bluray (''pgs''), are not affected by these settings.<ref>https://github.com/xbmc/xbmc/pull/20169</ref><br>
<br>
[[File:Settings-Player-Subtitles-01.jpg|600px]]

== Position on screen ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Adjust the on screen location of the subtitle.<br>
The ''Manual'' option can be set using the ''[[Settings/System/Display#Video_calibration | Screen Calibration]]'' subtitle adjustment, which now works only with the ''Manual'' option.<br>
During playback, ''Manual'' can also be adjusted using the [[Action_IDs|Action ID's]] ''SubtitleShiftUp'' and ''SubtitleShiftDown'' <ref>https://github.com/xbmc/xbmc/pull/21680</ref><br>
There is a difference between "Bottom screen" and "Manual" positions:
* with "manual", the subtitle position, if changed, is permanently saved (persists over different videos or kodi reboot), and can be changed also with Calibration screen
* with "bottom", the subtitle position, if changed, is temporary, e.g. playing another video will restore to the default position
|}

== Font ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Select the font for the subtitles.<br>
Additional ''.ttf'' and ''.otf'' type fonts can be added to the ''\media\fonts\'' folder located in the '''[[Kodi_data_folder#media| Kodi data folder]]'''
|}

== Size ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| Increase or decrease the size of the subtitles on screen.
|}

== Style ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| Add ''Bold, Italics'' or ''Bold italics'' effects to subtitles.
|}

== Colour ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| Change the colour of the subtitle text using the pop-up colour picker. May help reduce eyestrain caused by bright white HDR subtitles.
|}

== Opacity ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| Adjust the opacity of the subtitle
|}

== Border size ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| Apply a stroke (outline) to the text. Can help increase contrast between text and background.
|}

== Border colour ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| Change the colour of the stroke (outline) of the text using the pop-up colour picker.
|}

== Blur ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| Will apply a blur to the border.
|}

== Background type ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| Displays subtitles in a box which aids in readibility. When the type of background is selected, further settings will become visible which allow colouring of the box, shadow and opacity.<br>
Enabling this setting will disable the ''Border size'' and ''Border colour'' settings
|}

== Vertical margin ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| Adds a margin to top and bottom aligned text.<br>
This setting will affect the subtitle position set with the '''[[Settings/System/Display#Video_calibration | Video calibration setting]]'''.
|}

== Override subtitles fonts ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| Override the subtitle fonts specified in subtitle files such as ''*.ass'' and ''*.ssa''.
|}

== Override subtitles styles ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| Override the subtitle theme and alignments specified in subtitle files such as ''*.ass'', ''*.ssa'' and ''*.vtt'' (WebVTT).<br>
Enabling this setting may in some cases lead to subtitles being displayed incorrectly.
|}

== Stereoscopic 3D depth of subtitles ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Adjust the visual depth of subtitles for 3D videos. The higher the setting, the closer to the viewer the subtitles will appear.
|}

== Charater set ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Select the font character set to use for subtitles.
|}

= Closed caption subtitles =
[[File:Settings-Player-Subtitles-02.jpg|600px]]

== Enable parsing for closed captions ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Enable parsing for closed caption subtitles.
|}

= Download Services =
[[File:Settings-Player-Subtitles-03.jpg|600px]]

{{See|Subtitles}}

== Languages to download subtitles for ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Set which language subtitles to search and download.<br>
Check with your selected subtitle provider if subtitles are not found in the specified language.
|}

== Subtitle storage location ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Specify where downloaded subtitles should be saved, the same location as the video or a custom location.<br>
Options: ''Next to the video'' or ''Custom location''.
|}

== Custom subtitle folder ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| If you chose ''Custom location'' in the previous setting, set the location with this setting.
|}

== Pause when searching for subtitles ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Pause the current video while searching for subtitles and resume once the subtitle is available.
|}

== Auto download first subtitle ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Automatically download first subtitle from the search result list.
|}

== Default TV service ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Select the service that will be used as default to search for TV-show subtitles.<br>
If none are listed, use the ''Get more...'' button<br>
{{collapse top|Available subtitle providers (click 'expand' to view)}}
<dpl>
category = Nexus_add-on_repository
category = Subtitle_add-ons
notcategory = Outdated
</dpl>
{{collapse bottom}}
|}

== Default movie service ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Select the service that will be used as default to search for movie subtitles.<br>
If none are listed, use the ''Get more...'' button<br>
{{collapse top|Available subtitle providers (click 'expand' to view)}}
<dpl>
category = Nexus_add-on_repository
category = Subtitle_add-ons
notcategory = Outdated
</dpl>
{{collapse bottom}}
|}

= References =
<references />

{{top}}
{{updated|20}}

[[Category:Settings]]
[[Category:Subtitles]]

NFO files/Episodes

2022-12-26T10:33:31Z

CastagnaIT: Fixed <code> tag

{{NFO_content}}
{{mininav|[[NFO files]]}}

__TOC__

= Introduction =
'''Episodes must abide by the standard filenaming conventions even when using nfo files. {{kodi}} determines the season and episode numbering ''(S01E01)'' from the episode filename, not from the NFO file.'''

One nfo file for '''each''' episode is required. This file holds information specific to that episode.

Most metadata contained in a {{kodi}} exported NFO file is metadata inherited from the TV Show or are not used which is why the episode NFO template is relatively small.

= nfo Name and Location =
'''{{resize|1.2em|Regardless of what settings you have set for the source and scraper, {{Kodi}} will always search for and scan the nfo file first where available.}}'''

The episode nfo file is placed alongside each episode video file. The episode nfo filename is the same as the video filename but with the ''.nfo'' extension. See image below for examples.

<gallery mode="packed" widths="1000px" heights="562px">
File:LocalEpisodeArtwork01.jpg|'''''Episode Artwork and nfo files'''''
</gallery>

= nfo Tags =
The following table lists the available XML tags in the episode nfo file. <ref>https://github.com/xbmc/xbmc/blob/master/xbmc/video/VideoInfoTag.cpp</ref>

''Yes'' in the Inherited column indicates a tag that uses data from the parent TV Show. These tags are created in the exported nfo file but are ignored on import so it is not possible to change this data at the episode level.

Three XML tags are required and are indicated in the table below. All other tags are optional. Of course the less tags used, the less information scanned into the library.

{|class="prettytable"
! NFO (xml) Tag || Required || Multiple || Inherited || Notes
|-
|<episodedetails></episodedetails> || {{Yes}} || No/Yes || || The top level parent tag for the nfo file. All other tags must be contained within these two tags<br/>
Yes - When creating multi-episode nfo files. See next section. <br/>
No - In all other cases, a single instance is used.
|-
|<title></title> || {{Yes}} || No || || The title for the episode
|-
|<originaltitle></originaltitle> || No || No || Yes || Inherited from TV show
|-
|<showtitle></showtitle> || No || No || Yes || Inherited from TV show
|-
|<syntaxhighlight lang="xml">
<ratings>
<rating name="" max="10" default="">
<value></value>
<votes></votes>
</rating>
</ratings>
</syntaxhighlight>
|| No || No || || ''default="true"'' ''default="false"''<br>
::Only one rating can be set as ''default="true"'', additional ratings must be set as ''default="false"'' or ommitted<br>

''name="identifier"''. Do not use "default". Examples of identifier include...<br>
::''<rating name="imdb" max="10">''<br>
::''<rating name="trakt" max="10">''<br>
::''<rating name="tvmaze" max="10">''<br>
::''<rating name="metacritic" max="10">''<br>
::''<rating name="tomatometerallcritics" max="10">''<br>
::''<rating name="tomatometerallaudience" max="10">''<br>

Example of complete entry...
::''<rating name="themoviedb" max="10" default="true">''<br>
::''<rating name="imdb" max="10" default="false"> or <rating name="themoviedb" max="10">''<br>
|-
|<userrating></userrating> || No || No || || Personal rating set by the user
|-
|<top250></top250> || No || No || || Not used
|-
|<season></season> || No || No/Yes || || Season number is read from filename in all cases<br/>
Not required for single nfo files<br/>
Required for multi-episode nfo files to match the metadata to the correct episode. See next section
|-
|<episode></episode> || No || No/Yes || || Episode number is read from filename in all cases<br/>
Not required for single nfo files<br/>
Required for multi-episode nfo files to match the metadata to the correct episode. See next section
|-
|<displayepisode></displayepisode> || No || No || || Used to place Specials episodes in the correct episode order
|-
|<displayseason></displayseason> || No || No || || Used to place Specials episodes in the correct season
|-
|<outline></outline> || No || No || || Not used
|-
|<plot></plot> || No || No || || A description of the episode
|-
|<tagline></tagline> || No || No || || Short slogan of the episode. No skins use this.
|-
|<runtime></runtime> || No || No || || Minutes only. If ommitted, {{kodi}} will add runtime upon scanning of the video file
|-
|<thumb aspect="thumb" preview=""></thumb> || No || Yes || || Path to episode artwork. Not needed when using local artwork
|-
|<mpaa></mpaa> || No || No || Yes || Inherited from TV show
|-
|<playcount></playcount> || No || No || || Number of times episode has been played.<br>See... [[Import-export_library/Video#Watched.2C_PlayCount.2C_ResumePoints|Import-Export]]
|-
|<lastplayed></lastplayed> || No || No || || Date last played<br>
Format as ''yyyy-mm-dd''
|-
|<id></id> || No || No || || The default ID. <br>
Do not use. It is a deprecated Kodi generated tag. See next item.
|-
|<uniqueid type="" default=""></uniqueid> || {{Yes}} || Yes || || The ID from the scraper site.<br>
''type=""'' Identifier of the ID. Do not use "default". Examples of identifier include...<br>
::''<uniqueid type="imdb"''<br>
::''<uniqueid type="tvdb"''<br>
::''<uniqueid type="tmdb"''<br>
::For non-scraped items, use simple values like ''"home", "sport", "doco"'' etc<br>
::The value can be alpha-numeric eg ''tt3480556'' for imdb, ''286668'' for tmdb, ''home001'' for home movies, etc<br>
''default="true"'' ''default="false"''<br>
::Only one uniqueID can be set as ''default="true"'', additional uniqueIDs must be set as ''default="false"'' or ommit the default attribute <br/>
Example of complete entry...
::''<uniqueid type="tmdb" default="true">''<br>
::''<uniqueid type="imdb" default="false"> or <uniqueid type="imdb">''<br>
|-
|<genre></genre> || No || Yes || Yes || Inherited from TV show
|-
|<credits></credits> || No || Yes || || Field for writers.
|-
|<director></director> || No || Yes || || Director
|-
|<premiered></premiered> || No || No || Yes || Inherited from TV show<br>
Format as ''yyyy-mm-dd''
|-
|<year></year> || No || No || Yes || Inherited from TV show<br>
{{note|Kodi v17: Tag deprecated, use <premiered> tag instead.}}
{{note|Kodi v20: Use <premiered> tag only.}}
|-
|<status></status> || No || No || || Not used
|-
|<nowiki><code></code></nowiki> || No || No || || Not used
|-
|<aired></aired> || No || No || || Original air date of the episode<br>
Format as ''yyyy-mm-dd''
|-
|<studio></studio> || No || Yes || Yes || Production studio. Inherited from TV Show
|-
|<trailer></trailer> || No || No || ||Not used
|-
|<syntaxhighlight lang="xml">
<episodebookmark>
<position></position>
</episodebookmark>
</syntaxhighlight>
|| No || No || || Episode Bookmark in seconds. ''See: [[Bookmarks_and_chapters|Episode Bookmarks]]''<br>
Not used for Import
|-
|<syntaxhighlight lang="xml">
<fileinfo>
<streamdetails>
<video>
<codec></codec>
<aspect></aspect>
<width></width>
<height></height>
<durationinseconds></durationinseconds>
<stereomode></stereomode>
</video>
<audio>
<codec></codec>
<language></language>
<channels></channels>
</audio>
<subtitle>
<language></language>
</subtitle>
</streamdetails>
</fileinfo>
</syntaxhighlight>
|| No || Yes || || Multiple entries of <audio> and <subtitles> accepted<br>
In v17 and prior, {{kodi}} would overwrite these values on first play of the file.<br>
In v18 that process was removed and values in these tags will remain.<ref>https://github.com/xbmc/xbmc/pull/16342</ref><br>
If ommitted, {{kodi}} will add runtime upon scanning
|-
|<syntaxhighlight lang="xml">
<actor>
<name></name>
<role></role>
<order></order>
<thumb></thumb>
</actor>
</syntaxhighlight>
|| No || Yes || || The <order> tag determines where in the list the actor will appear. 0 = first in the list
Supports "clear" attribute
|-
|<syntaxhighlight lang="xml">
<resume>
<position></position>
<total></total>
</resume>
</syntaxhighlight>
|| No || No || || Set the resume position<br>See... [[Import-export_library/Video#Watched.2C_PlayCount.2C_ResumePoints|Import-Export]]
|-
|<dateadded></dateadded> || No || No || || mTime of the playable video file. Can be altered in advancedsettings.xml<br>See... '''[[Advancedsettings.xml#videolibrary]]'''
|}

= Multi-Episode Files =
There may be instances where a video file contains two or more episodes. This is common for ISO files.

Multi-episode video files still use a single nfo file. The metadata for each episode is stacked in the single nfo file. Below is an example of an abbreviated multi-episode nfo file containing 3 episodes.

One difference between the single and multi nfo file is that the ''<season></season>'' and ''<episode></episode>'' tags are required for each episode in the multi nfo file. {{kodi}} still requires the filename to contain the season and episode numbering, but it also requires these additional tags so it can match the metadata to the correct episode. The metadata for each episode must be in correct numerical order.

For correct naming of the video file, nfo file and artwork thumb, see: '''[[Naming_video_files/Episodes#Multi-Episode_Files|Naming Multi-Episode Files]]'''

<div class="toccolours mw-collapsible mw-collapsed" style="width:50%; overflow:auto;">
<center>'''Example Multi-Episode NFO File'''</center>
<div class="mw-collapsible-content">
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<episodedetails> 
<title>Episode 1</title>
<userrating></userrating>
<plot></plot>
<season>1</season>
<episode>1</episode>
<uniqueid type="" default="true"></uniqueid>
<credits></credits>
<director></director>
<aired></aired>
<actor>
<name></name>
<role></role>
<order></order>
<thumb></thumb>
</actor>
</episodedetails>
<episodedetails> 
<title>Episode 2</title>
<userrating></userrating>
<plot></plot>
<season>1</season>
<episode>2</episode>
<uniqueid type="" default="true"></uniqueid>
<credits></credits>
<director></director>
<aired></aired>
<actor>
<name></name>
<role></role>
<order></order>
<thumb></thumb>
</actor>
</episodedetails>
<episodedetails> 
<title>Episode 3</title>
<userrating></userrating>
<plot></plot>
<season>1</season>
<episode>3</episode>
<uniqueid type="" default="true"></uniqueid>
<credits></credits>
<director></director>
<aired></aired>
<actor>
<name></name>
<role></role>
<order></order>
<thumb></thumb>
</actor>
</episodedetails>

</syntaxhighlight>
</div>
</div>

= References =
<references />

{{top}}
{{updated|19}}

[[Category:Karellen]]
[[Category:Video library]]

NFO files/Movies

2022-12-26T10:33:10Z

CastagnaIT: Fixed <code> tag

{{NFO_content}}
{{mininav|[[NFO files]]}}

__TOC__

= Introduction =
NFO files to be scraped into the movie library are relatively simple and require only a single nfo file per title.

= nfo Name and Location =
'''{{resize|1.2em|Regardless of what settings you have set for the source and scraper, {{Kodi}} will always search for and scan the nfo file first where available.}}'''

There are two naming schemes for movie nfo files. Both are explained and {{kodi}} recommends using the ''<VideoFileName>.nfo'' format.

<section begin="MovieNFONaming" />;<VideoFileName>.nfo
:*NFO Files are named the same as the video file except with the ''.nfo'' extension.
:*We recommend using this filename format to name nfo files.

;movie.nfo
:{{Kodi}} may also scan nfo files named '''''movie.nfo'''''. To use this name, the setting '''Movies are in separate folders that match the movie title''' must be '''Enabled''' in the '''[[Adding_video_sources#Set_Content|Set Content Screen]]'''
:*If the above setting is not enabled, {{kodi}} will ignore the ''movie.nfo''. If the ''<VideoFileName>.nfo'' file is available, {{kodi}} will scan this one instead, otherwise an online scrape will be performed if a valid scraper is set for the Source.
:*If you use ''movie.nfo'' and later Export your library to Separate Files, {{kodi}} will still create the nfo file in the ''<VideoFileName>.nfo'' format and two nfo files will exist. If a Refresh or rescan is run in future, and the above setting is still enabled, the ''<VideoFileName>.nfo'' file will be ignored in favour of ''movie.nfo'', which means any changes you may have made to the library entry (play counts, watched status etc) will not be re-scanned back into the library.
:*We recommend using the ''<VideoFileName>.nfo'' format for nfo files to avoid the above traps.<section end="MovieNFONaming" />

The below image details naming and location for Single File, DVD and Bluray movies:

<gallery mode="packed" widths="1000px" heights="562px">
File:LocalMovieArtwork01.jpg|'''''Example of correct use of Movie Folder with artwork, nfo file, trailer and theme.<br> Take note of file naming and location.'''''
</gallery>

= nfo Tags =
The following table lists available XML tags. <ref>https://github.com/xbmc/xbmc/blob/master/xbmc/video/VideoInfoTag.cpp</ref>

The "Required" column indicates whether a tag can be optionally added or ommitted when creating the nfo to suit your purpose. The less tags used, the less information added to the library.

{|class="prettytable"
! width=430px | NFO (xml) Tag || Required || Multiple || Notes
|-
|<movie></movie> || {{Yes}} || No || The top level parent tag for the nfo file. All other tags must be contained within these two tags
|-
|<title></title> || {{Yes}} || No || The title for the movie
|-
|<originaltitle></originaltitle> || No || No || Displays the original title of the movie. <br>
For example, if the scraper is set to german language and the scraped movie in german is "Der mit dem Wolf tanzt" the original title will be "Dances with Wolves"
|-
|<sorttitle></sorttitle> || No || No || Allows alternate title sort without modifying movie title. Not displayed in any library listing. See: ''[[Movie_sets#Sort_Title|Sort Title]]''
|-
|
<ratings>
<rating name="" max="10" default="">
<value></value>
<votes></votes>
</rating>
</ratings>
|| No || No || ''default="true"'' ''default="false"''<br>
::Only one rating can be set as ''default="true"'', additional ratings must be set as ''default="false"'' or omit the default attribute<br>

''name="identifier"''. Do not use "default". Examples of identifier include...<br>
::''<rating name="imdb" max="10">''<br>
::''<rating name="trakt" max="10">''<br>
::''<rating name="themoviedb" max="10">''<br>
::''<rating name="metacritic" max="10">''<br>
::''<rating name="tomatometerallcritics" max="10">''<br>
::''<rating name="tomatometerallaudience" max="10">''<br>

Example of complete entry...
::''<rating name="themoviedb" max="10" default="true">''<br>
::''<rating name="imdb" max="10" default="false"> or <rating name="themoviedb" max="10">''<br>
|-
|<userrating></userrating> || No || No || Personal rating set by the user
|-
|<top250></top250> || No || No || Ranking in IMDB Top 250 movies
|-
|<outline></outline> || || || Should be short, will be displayed on a single line (scraped from IMDB only)
|-
|<plot></plot> || || || Can contain more information on multiple lines, will be wrapped
|-
|<tagline></tagline> || No || No || Short movie slogan. "The true story of a real fake" is the tagline for "Catch me if you can"
|-
|<runtime></runtime> || No || No || Minutes only. If ommitted, {{kodi}} will add runtime upon scanning
|-
|<thumb aspect="" preview=""></thumb> || No || Yes || Path to available Movie Posters. Not needed when using local artwork<br>
Example use of ''aspect=""''
:<thumb aspect="banner"
:<thumb aspect="clearart"
:<thumb aspect="clearlogo"
:<thumb aspect="discart"
:<thumb aspect="keyart"
:<thumb aspect="landscape"
:<thumb aspect="poster"
|-
|
<fanart>
<thumb preview=""></thumb>
</fanart>
|| No || Yes^ || Path to available movie fanart.<br>
:^ Multiple <thumb> entries allowed between the <fanart></fanart> tags
|-
|<mpaa></mpaa> || No || No || Country specific mpaa rating system. Check with skin author which prefix is required to diplay your country certification flags
|-
|<playcount></playcount> || No || No || Number of times movie has been played.<br>See... [[Import-export_library/Video#Watched.2C_PlayCount.2C_ResumePoints|Import-Export]]
|-
|<lastplayed></lastplayed> || No || No || Date last played as ''yyyy-mm-dd''
|-
|<id></id> || No || No || The default ID. <br>
Do not use. This is a Kodi generated tag. See next item.
|-
|<uniqueid type="" default=""></uniqueid> || {{Yes}} || Yes ||The ID from the scraper site.<br>
''type=""'' Identifier of the ID. Do not use "default". Examples of identifier include...<br>
::''<uniqueid type="imdb"''<br>
::''<uniqueid type="tvdb"''<br>
::''<uniqueid type="tmdb"''<br>
::For non-scraped items, use simple values like ''"home", "sport", "doco"'' etc<br>
::The value can be alpha-numeric eg ''tt3480556'' for imdb, ''286668'' for tmdb, ''home001'' for home movies, etc<br>
''default="true"'' ''default="false"''<br>
::Only one uniqueID can be set as ''default="true"'', additional uniqueID's must be set as ''default="false"'' or ommit the default attribute<br>
Example of complete entry...
::''<uniqueid type="tmdb" default="true">''<br>
::''<uniqueid type="imdb" default="false"> or <uniqueid type="imdb">''<br>
|-
|<genre></genre> || No || Yes || Movie genre.
|-
|<tag></tag> || No || Yes || Library Tags. See...'''[[Video library tags]]'''
|-
|
<set>
<name></name>
<overview></overview>
</set>
|| No || No || Movie set tags <br />
The <overview> tag allows a short summary of the movie set. It can be displayed by some skins.
<br />See... '''[[Movie sets]]'''
|-
|<country></country> || No || Yes || Country of origin
|-
|<credits></credits> || No || Yes || Field for writers.
|-
|<director></director> || No || Yes || Movie Director
|-
|<premiered></premiered> || No || No || Release date of movie. Format as ''yyyy-mm-dd''
|-
|<year></year> || No || No || Release Year.<br>
{{note|Kodi v17: Tag deprecated, use <premiered> tag instead.}}
{{note|Kodi v20: Use <premiered> tag only.}}
|-
|<status></status> || No || No || Not used
|-
|<nowiki><code></code></nowiki> || No || No || Not used
|-
|<aired></aired> || No || No || Not used
|-
|<studio></studio> || No || Yes || Production studio
|-
|<trailer></trailer> || No || No || Local or online path to movie trailer<br> Do not add local path to trailer. {{kodi}} will automatically scan for local trailers.<br> See... '''[[Trailers]]'''
|-
|
<fileinfo>
<streamdetails>
<video>
<codec></codec>
<aspect></aspect>
<width></width>
<height></height>
<durationinseconds></durationinseconds>
<stereomode></stereomode>
</video>
<audio>
<codec></codec>
<language></language>
<channels></channels>
</audio>
<subtitle>
<language></language>
</subtitle>
</streamdetails>
</fileinfo>
|| No || Yes || Multiple entries of <audio> and <subtitles> accepted<br>
In v17 and prior, {{kodi}} would overwrite these values on first play of the file.<br>
In v18 that process was removed and values in these tags will remain.<ref>https://github.com/xbmc/xbmc/pull/16342</ref>
|-
|
<actor>
<name></name>
<role></role>
<order></order>
<thumb></thumb>
</actor>
|| No || Yes || The <order> tag determines where in the list the actor will appear. 0 = first in the list
|-
|<showlink></showlink> || No || No || Connect movie to TV Show. Use the TV Show <title></title> name.
|-
|
<resume>
<position></position>
<total></total>
</resume>
|| No || No || Movie resume point in Seconds<br>See... [[Import-export_library/Video#Watched.2C_PlayCount.2C_ResumePoints|Import-Export]]
|-
|<dateadded></dateadded> || No || No || mTime of the playable video file. Can be altered in advancedsettings.xml<br>See... '''[[Advancedsettings.xml#videolibrary]]'''
|}

= References =
<references />

{{top}}
{{updated|19}}

[[Category:Karellen]]
[[Category:Video library]]

NFO files/Music videos

2022-12-26T10:32:40Z

CastagnaIT: Fixed <code> tag

{{NFO_content}}
{{mininav|[[NFO files]]}}

__TOC__

= Introduction =
The Music Video library uses the Video Library database. Music Video entries displayed in {{kodi}} can also access information from the Music Library if the same artist and album that contains the music video song is also in the Music Library.

= nfo Name and Location =
'''{{resize|1.2em|Regardless of what settings you have set for the source and scraper, {{Kodi}} will always search for and scan the nfo file first where available.}}'''

Music Videos require one nfo for '''each''' music video in the folder. These nfo files need to be named exactly as the Music Video file is named, but with the nfo extension.

The below image shows an example of correct naming and placement of the artwork alongside the '''''[[NFO_files|nfo]]''''' file and the Music Video media file.

<gallery mode="packed" widths="500px" heights="290px">
File:Artwork-MusicVideoExample01.jpg|Correct naming and placement of media, nfo and artwork files.
</gallery>

= Music Video Tags =
A list of all available tags that Kodi recognises follows in this section.

{|class="prettytable"
! NFO (xml) Tag || Required || Multiple || Notes
|-
|<musicvideo></musicvideo> || {{Yes}} || No || The top level parent tag for the nfo file. All other tags must be contained within these two tags
|-
|<title></title> || {{Yes}} || No || Name of music video
|-
|<userrating></userrating> || No || No || Personal rating applied by the user
|-
|<top250></top250> || No || No || Not Used
|-
|<track></track> || No || No || Not Used
|-
|<album></album> || No || No || Name of album the song appears on
|-
|<outline></outline> || No || No || Not Used
|-
|<plot></plot> || No || No || Review / information of music video
|-
|<tagline></tagline> || No || No || Not Used
|-
|<runtime></runtime> || No || No || Minutes only. If ommitted, {{kodi}} will add runtime upon scanning
|-
|<thumb aspect="thumb" preview=""></thumb> || No || Yes || Path to TV Show and Season artwork
|-
|<mpaa></mpaa> || No || No || Not Used
|-
|<playcount></playcount> || No || No || Setting this to 1 or greater will mark the Music Video
|-
|<lastplayed></lastplayed> || No || No || Date last played<br>
Format as ''yyyy-mm-dd''
|-
|<id></id> || No || No || Not Used
|-
|<genre></genre> || No || Yes || Genre
|-
|<tag></tag> || No || Yes || Video tags. See: '''[[Video library tags]]'''
|-
|<director></director> || No || Yes || Director of the music video
|-
|<premiered></premiered> || No || No || Release date.<br>
Format as ''yyyy-mm-dd''
|-
|<year></year> || No || No || Release Year.<br>
{{note|Kodi v17: Tag deprecated, use <premiered> tag instead.}}
{{note|Kodi v20: Use <premiered> tag only.}}
|-
|<status></status> || No || No || Not Used
|-
|<nowiki><code></code></nowiki> || No || No || Not Used
|-
|<aired></aired> || No || No || Not Used
|-
|<studio></studio> || No || Yes || Production studio
|-
|<trailer></trailer> || No || No || Not used
|-
|
<fileinfo>
<streamdetails>
<video>
<codec></codec>
<aspect></aspect>
<width></width>
<height></height>
<durationinseconds></durationinseconds>
<stereomode></stereomode>
</video>
<audio>
<codec></codec>
<language></language>
<channels></channels>
</audio>
</streamdetails>
</fileinfo>
|| No || No || While it is possible to manually set the information contained within the <streamdetails> tag, there is little point in doing so.
Kodi will always overwrite this data when it plays back the video file.<br />
In other words, no matter how many times you try to manually set it, it will be overwritten the moment the video is played
|-
|
<actor>
<name>Taylor Swift</name>
<role></role>
<order>0</order>
<thumb></thumb>
</actor>
|| No || Yes || The artist of the song
|-
| <artist></artist> || {{yes}} || Yes || The artists/actors in the music video
|-
|
<resume>
<position></position>
<total></total>
</resume>
|| No || No || Not Used
|-
|<dateadded></dateadded> || No || No || mTime of the playable video file. Can be altered in advancedsettings.xml<br>See... '''[[Advancedsettings.xml#videolibrary]]'''
|}

= References =
<references />

{{top}}
{{updated|19}}

[[Category:Karellen]]
[[Category:Music library]]
[[Category:Video library]]

NFO files/TV shows

2022-12-26T10:31:52Z

CastagnaIT: Fixed <code> tag

{{NFO_content}}
{{mininav|[[NFO files]]}}

__TOC__

= Introduction =
NFO files for TV Shows are a little bit more complex as they require the following NFO files:
* One nfo file for the TV Show. This file holds the overall TV show information
* One nfo file for '''each''' Episode. This file holds information specific to that episode
For one TV Show with 10 episodes, 11 nfo files are required.

= episodeguide URL =
The <episodeguide> is the tag that allows the scrapers to find the episodes belonging to the TV Show at the site of the information provider.

Due to an issue where the UniqueID for TV shows and movies across TV Maze, TMDB and TheTVDB are '''not''' unique, the episode guide was converted to a JSON format which clearly identified which site the UniqueID belongs to.

These changes have been incorporated into v19 and later releases of {{kodi}}. [https://forum.kodi.tv/showthread.php?tid=370489 Read more here]

= nfo Name and Location =
'''{{resize|1.2em|Regardless of what settings you have set for the source and scraper, {{Kodi}} will always search for and scan the nfo file first where available.}}'''

The tvshow.nfo file is placed inside the TV Show folder. The NFO filename is actually '''tvshow.nfo'''. Do not rename it with the title of the tv show. See image for example

<gallery mode="packed" widths="1000px" heights="562px">
File:LocalTVShowArtwork01.jpg|'''''Location of tvshow.nfo along with artwork'''''
</gallery>

= nfo Tags =
The following table lists available XML tags for TV Shows. <ref>https://github.com/xbmc/xbmc/blob/master/xbmc/video/VideoInfoTag.cpp</ref>

Two XML tags are required and are indicated in the table below. All other tags are optional. Of course the less tags used, the less information scanned into the library.

{|class="prettytable"
! NFO (xml) Tag || Required || Multiple || Notes
|-
|<tvshow></tvshow> || {{Yes}} || No || The top level parent tag for the nfo file. All other tags must be contained within these two tags
|-
|<title></title> || {{Yes}} || No || The title of the TV Show
|-
|<originaltitle></originaltitle> || No || No || The original title, usually in the language of the country of origin.
|-
|<showtitle></showtitle> || No || No || Not in common use, but some skins may display an alternate title
|-
|<sorttitle></sorttitle> || No || No || Allows alternate title sort without modifying the TV Show title. Not displayed in any library listing.
|-
|
<ratings>
<rating name="" max="10" default="">
<value></value>
<votes></votes>
</rating>
</ratings>
|| No || No || ''default="true"'' ''default="false"''<br>
::Only one rating can be set as ''default="true"'', additional ratings must be set as ''default="false"'' or ommitted<br>

''name="identifier"''. Do not use "default". Examples of identifier include...<br>
::''<rating name="imdb" max="10">''<br>
::''<rating name="trakt" max="10">''<br>
::''<rating name="tvmaze" max="10">''<br>
::''<rating name="metacritic" max="10">''<br>
::''<rating name="tomatometerallcritics" max="10">''<br>
::''<rating name="tomatometerallaudience" max="10">''<br>

Example of complete entry...
::''<rating name="themoviedb" max="10" default="true">''<br>
::''<rating name="imdb" max="10" default="false"> or <rating name="themoviedb" max="10">''<br>
|-
|<userrating></userrating> || No || No || Personal rating set by the user
|-
|<top250></top250> || No || No || Ranking in IMDB Top 250
|-
|<season></season> || No || No ||Number of seasons of this TV Show in the library
|-
|<episode></episode> || No || No || Number of episodes of this TV Show in the library
|-
|<displayepisode></displayepisode> || No || No || Not used
|-
|<displayseason></displayseason> || No || No || Not used
|-
|<outline></outline> || No || No || Not Used
|-
|<plot></plot> || No || No || Can contain more information on multiple lines, will be wrapped
|-
|<tagline></tagline> || No || No || Short TV Show slogan
|-
|<runtime></runtime> || No || No || Not used
|-
|<thumb aspect="" preview=""></thumb>
<thumb aspect="poster" type="season" season="" preview=""></thumb>
|| No || Yes || Path to available TV Show Posters. Not used for locally saved artwork<br>
Example use of ''aspect=""''
:<thumb aspect="banner"
:<thumb aspect="clearart"
:<thumb aspect="clearlogo"
:<thumb aspect="landscape"
:<thumb aspect="poster"<br>
''type="season"'' used for season specific artwork<br>
''season="2"'' nominates season number eg. season 2
|-
|
<fanart>
<thumb preview=""></thumb>
</fanart>
|| No || Yes^ || Path to available TV Show fanart.<br>
:^ Multiple <thumb> entries allowed between the <fanart></fanart> tags<br>
Not used for locally saved artwork
|-
|<mpaa></mpaa> || No || No || Country specific mpaa rating system. Check with skin author which prefix is required to diplay your country local rating system
|-
|<playcount></playcount> || No || No || Number of times TV show has been played. Will only ever show 0 or 1. Episodes track playcounts<br>See... [[Import-export_library/Video#Watched.2C_PlayCount.2C_ResumePoints|Import-Export]]
|-
|<lastplayed></lastplayed> || No || No || Date TV Show was last played
|-
|
<episodeguide>
{"tmdb": "76479", "imdb": "tt1190634", "tvdb": "355567"}
</episodeguide>
|| Yes/No || No || Read section ''1.1 episodeguide URL'' above.<br>
For v19 and later, a JSON format is used. ''[https://forum.kodi.tv/showthread.php?tid=370489 Read more here]''<br>
TVDB scraper uses TheTVDB v4 API<br>
Other providers: ''"tvmaze":'' and ''"tvrage":''
|-
|<id></id> || No || No || The default ID. <br>
Do not use as this is a Kodi generated tag. See next item.
|-
|<uniqueid type="" default=""></uniqueid> || {{Yes}} || Yes ||The ID from the scraper site.<br>
''type=""'' Identifier of the ID. Do not use "default". Examples of identifier include...<br>
::''<uniqueid type="imdb"''<br>
::''<uniqueid type="tvdb"''<br>
::''<uniqueid type="tmdb"''<br>
::For non-scraped items, use simple values like ''"home", "sport", "doco"'' etc<br>
::The value can be alpha-numeric eg ''tt3480556'' for imdb, ''286668'' for tmdb, ''home001'' for home movies, etc<br>
''default="true"'' ''default="false"''<br>
::Only one uniqueID can be set as ''default="true"'', additional uniqueID's must be set as ''default="false"'' or ommit the default attribute<br>
Example of complete entry...
::''<uniqueid type="tmdb" default="true">''<br>
::''<uniqueid type="imdb" default="false"> or <uniqueid type="imdb">''<br>
|-
|<genre></genre> || No || Yes || Genre
|-
|<tag></tag> || No || Yes || Tags. See: ''[[Video library tags]]''
|-
|<premiered></premiered> || No || No || Release date of TV Show. Comes from Aired Date of the first episode.<br>
Format as ''yyyy-mm-dd''
|-
|<year></year> || No || No || Release Year.<br>
{{note|Kodi v17: Tag deprecated, use <premiered> tag instead.}}
{{note|Kodi v20: Use <premiered> tag only.}}
|-
|<status></status> || No || No || Continuing or Ended show
|-
|<nowiki><code></code></nowiki> || No || No || Not used
|-
|<aired></aired> || No || No || Not used
|-
|<studio></studio> || No || Yes || Production studio
|-
|<trailer></trailer> || No || No || Local or online path to TV Show trailer
|-
|
<actor>
<name></name>
<role></role>
<order></order>
<thumb></thumb>
</actor>
|| No || Yes || The <order> tag determines where in the list the actor will appear. 0 = first in the list
Supports "clear" attribute
|-
| <namedseason number=""></namedseason> || No || Yes || Allows naming of Seasons. eg:<br>
<namedseason number="1">Season 1: The Maze</namedseason>
|-
|
<resume>
<position></position>
<total></total>
</resume>
|| No || No || Not used for TV Show
|-
|<dateadded></dateadded> || No || No || mTime of the playable video file. Can be altered in advancedsettings.xml<br>See... '''[[Advancedsettings.xml#videolibrary]]'''
|}

= References =
<references />

{{top}}
{{updated|19}}

[[Category:Karellen]]
[[Category:Video library]]

NFO files/Episodes

2022-12-25T10:18:47Z

CastagnaIT: More details for deprecated <year> tag

{{NFO_content}}
{{mininav|[[NFO files]]}}

__TOC__

= Introduction =
'''Episodes must abide by the standard filenaming conventions even when using nfo files. {{kodi}} determines the season and episode numbering ''(S01E01)'' from the episode filename, not from the NFO file.'''

One nfo file for '''each''' episode is required. This file holds information specific to that episode.

Most metadata contained in a {{kodi}} exported NFO file is metadata inherited from the TV Show or are not used which is why the episode NFO template is relatively small.

= nfo Name and Location =
'''{{resize|1.2em|Regardless of what settings you have set for the source and scraper, {{Kodi}} will always search for and scan the nfo file first where available.}}'''

The episode nfo file is placed alongside each episode video file. The episode nfo filename is the same as the video filename but with the ''.nfo'' extension. See image below for examples.

<gallery mode="packed" widths="1000px" heights="562px">
File:LocalEpisodeArtwork01.jpg|'''''Episode Artwork and nfo files'''''
</gallery>

= nfo Tags =
The following table lists the available XML tags in the episode nfo file. <ref>https://github.com/xbmc/xbmc/blob/master/xbmc/video/VideoInfoTag.cpp</ref>

''Yes'' in the Inherited column indicates a tag that uses data from the parent TV Show. These tags are created in the exported nfo file but are ignored on import so it is not possible to change this data at the episode level.

Three XML tags are required and are indicated in the table below. All other tags are optional. Of course the less tags used, the less information scanned into the library.

{|class="prettytable"
! NFO (xml) Tag || Required || Multiple || Inherited || Notes
|-
|<episodedetails></episodedetails> || {{Yes}} || No/Yes || || The top level parent tag for the nfo file. All other tags must be contained within these two tags<br/>
Yes - When creating multi-episode nfo files. See next section. <br/>
No - In all other cases, a single instance is used.
|-
|<title></title> || {{Yes}} || No || || The title for the episode
|-
|<originaltitle></originaltitle> || No || No || Yes || Inherited from TV show
|-
|<showtitle></showtitle> || No || No || Yes || Inherited from TV show
|-
|<syntaxhighlight lang="xml">
<ratings>
<rating name="" max="10" default="">
<value></value>
<votes></votes>
</rating>
</ratings>
</syntaxhighlight>
|| No || No || || ''default="true"'' ''default="false"''<br>
::Only one rating can be set as ''default="true"'', additional ratings must be set as ''default="false"'' or ommitted<br>

''name="identifier"''. Do not use "default". Examples of identifier include...<br>
::''<rating name="imdb" max="10">''<br>
::''<rating name="trakt" max="10">''<br>
::''<rating name="tvmaze" max="10">''<br>
::''<rating name="metacritic" max="10">''<br>
::''<rating name="tomatometerallcritics" max="10">''<br>
::''<rating name="tomatometerallaudience" max="10">''<br>

Example of complete entry...
::''<rating name="themoviedb" max="10" default="true">''<br>
::''<rating name="imdb" max="10" default="false"> or <rating name="themoviedb" max="10">''<br>
|-
|<userrating></userrating> || No || No || || Personal rating set by the user
|-
|<top250></top250> || No || No || || Not used
|-
|<season></season> || No || No/Yes || || Season number is read from filename in all cases<br/>
Not required for single nfo files<br/>
Required for multi-episode nfo files to match the metadata to the correct episode. See next section
|-
|<episode></episode> || No || No/Yes || || Episode number is read from filename in all cases<br/>
Not required for single nfo files<br/>
Required for multi-episode nfo files to match the metadata to the correct episode. See next section
|-
|<displayepisode></displayepisode> || No || No || || Used to place Specials episodes in the correct episode order
|-
|<displayseason></displayseason> || No || No || || Used to place Specials episodes in the correct season
|-
|<outline></outline> || No || No || || Not used
|-
|<plot></plot> || No || No || || A description of the episode
|-
|<tagline></tagline> || No || No || || Short slogan of the episode. No skins use this.
|-
|<runtime></runtime> || No || No || || Minutes only. If ommitted, {{kodi}} will add runtime upon scanning of the video file
|-
|<thumb aspect="thumb" preview=""></thumb> || No || Yes || || Path to episode artwork. Not needed when using local artwork
|-
|<mpaa></mpaa> || No || No || Yes || Inherited from TV show
|-
|<playcount></playcount> || No || No || || Number of times episode has been played.<br>See... [[Import-export_library/Video#Watched.2C_PlayCount.2C_ResumePoints|Import-Export]]
|-
|<lastplayed></lastplayed> || No || No || || Date last played<br>
Format as ''yyyy-mm-dd''
|-
|<id></id> || No || No || || The default ID. <br>
Do not use. It is a deprecated Kodi generated tag. See next item.
|-
|<uniqueid type="" default=""></uniqueid> || {{Yes}} || Yes || || The ID from the scraper site.<br>
''type=""'' Identifier of the ID. Do not use "default". Examples of identifier include...<br>
::''<uniqueid type="imdb"''<br>
::''<uniqueid type="tvdb"''<br>
::''<uniqueid type="tmdb"''<br>
::For non-scraped items, use simple values like ''"home", "sport", "doco"'' etc<br>
::The value can be alpha-numeric eg ''tt3480556'' for imdb, ''286668'' for tmdb, ''home001'' for home movies, etc<br>
''default="true"'' ''default="false"''<br>
::Only one uniqueID can be set as ''default="true"'', additional uniqueIDs must be set as ''default="false"'' or ommit the default attribute <br/>
Example of complete entry...
::''<uniqueid type="tmdb" default="true">''<br>
::''<uniqueid type="imdb" default="false"> or <uniqueid type="imdb">''<br>
|-
|<genre></genre> || No || Yes || Yes || Inherited from TV show
|-
|<credits></credits> || No || Yes || || Field for writers.
|-
|<director></director> || No || Yes || || Director
|-
|<premiered></premiered> || No || No || Yes || Inherited from TV show<br>
Format as ''yyyy-mm-dd''
|-
|<year></year> || No || No || Yes || Inherited from TV show<br>
{{note|Kodi v17: Tag deprecated, use <premiered> tag instead.}}
{{note|Kodi v20: Use <premiered> tag only.}}
|-
|<status></status> || No || No || || Not used
|-
|<code><code></code></code> || No || No || || Not used
|-
|<aired></aired> || No || No || || Original air date of the episode<br>
Format as ''yyyy-mm-dd''
|-
|<studio></studio> || No || Yes || Yes || Production studio. Inherited from TV Show
|-
|<trailer></trailer> || No || No || ||Not used
|-
|<syntaxhighlight lang="xml">
<episodebookmark>
<position></position>
</episodebookmark>
</syntaxhighlight>
|| No || No || || Episode Bookmark in seconds. ''See: [[Bookmarks_and_chapters|Episode Bookmarks]]''<br>
Not used for Import
|-
|<syntaxhighlight lang="xml">
<fileinfo>
<streamdetails>
<video>
<codec></codec>
<aspect></aspect>
<width></width>
<height></height>
<durationinseconds></durationinseconds>
<stereomode></stereomode>
</video>
<audio>
<codec></codec>
<language></language>
<channels></channels>
</audio>
<subtitle>
<language></language>
</subtitle>
</streamdetails>
</fileinfo>
</syntaxhighlight>
|| No || Yes || || Multiple entries of <audio> and <subtitles> accepted<br>
In v17 and prior, {{kodi}} would overwrite these values on first play of the file.<br>
In v18 that process was removed and values in these tags will remain.<ref>https://github.com/xbmc/xbmc/pull/16342</ref><br>
If ommitted, {{kodi}} will add runtime upon scanning
|-
|<syntaxhighlight lang="xml">
<actor>
<name></name>
<role></role>
<order></order>
<thumb></thumb>
</actor>
</syntaxhighlight>
|| No || Yes || || The <order> tag determines where in the list the actor will appear. 0 = first in the list
Supports "clear" attribute
|-
|<syntaxhighlight lang="xml">
<resume>
<position></position>
<total></total>
</resume>
</syntaxhighlight>
|| No || No || || Set the resume position<br>See... [[Import-export_library/Video#Watched.2C_PlayCount.2C_ResumePoints|Import-Export]]
|-
|<dateadded></dateadded> || No || No || || mTime of the playable video file. Can be altered in advancedsettings.xml<br>See... '''[[Advancedsettings.xml#videolibrary]]'''
|}

= Multi-Episode Files =
There may be instances where a video file contains two or more episodes. This is common for ISO files.

Multi-episode video files still use a single nfo file. The metadata for each episode is stacked in the single nfo file. Below is an example of an abbreviated multi-episode nfo file containing 3 episodes.

One difference between the single and multi nfo file is that the ''<season></season>'' and ''<episode></episode>'' tags are required for each episode in the multi nfo file. {{kodi}} still requires the filename to contain the season and episode numbering, but it also requires these additional tags so it can match the metadata to the correct episode. The metadata for each episode must be in correct numerical order.

For correct naming of the video file, nfo file and artwork thumb, see: '''[[Naming_video_files/Episodes#Multi-Episode_Files|Naming Multi-Episode Files]]'''

<div class="toccolours mw-collapsible mw-collapsed" style="width:50%; overflow:auto;">
<center>'''Example Multi-Episode NFO File'''</center>
<div class="mw-collapsible-content">
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<episodedetails> 
<title>Episode 1</title>
<userrating></userrating>
<plot></plot>
<season>1</season>
<episode>1</episode>
<uniqueid type="" default="true"></uniqueid>
<credits></credits>
<director></director>
<aired></aired>
<actor>
<name></name>
<role></role>
<order></order>
<thumb></thumb>
</actor>
</episodedetails>
<episodedetails> 
<title>Episode 2</title>
<userrating></userrating>
<plot></plot>
<season>1</season>
<episode>2</episode>
<uniqueid type="" default="true"></uniqueid>
<credits></credits>
<director></director>
<aired></aired>
<actor>
<name></name>
<role></role>
<order></order>
<thumb></thumb>
</actor>
</episodedetails>
<episodedetails> 
<title>Episode 3</title>
<userrating></userrating>
<plot></plot>
<season>1</season>
<episode>3</episode>
<uniqueid type="" default="true"></uniqueid>
<credits></credits>
<director></director>
<aired></aired>
<actor>
<name></name>
<role></role>
<order></order>
<thumb></thumb>
</actor>
</episodedetails>

</syntaxhighlight>
</div>
</div>

= References =
<references />

{{top}}
{{updated|19}}

[[Category:Karellen]]
[[Category:Video library]]

NFO files/Episodes

2022-12-25T10:16:24Z

CastagnaIT: Improved date format info

{{NFO_content}}
{{mininav|[[NFO files]]}}

__TOC__

= Introduction =
'''Episodes must abide by the standard filenaming conventions even when using nfo files. {{kodi}} determines the season and episode numbering ''(S01E01)'' from the episode filename, not from the NFO file.'''

One nfo file for '''each''' episode is required. This file holds information specific to that episode.

Most metadata contained in a {{kodi}} exported NFO file is metadata inherited from the TV Show or are not used which is why the episode NFO template is relatively small.

= nfo Name and Location =
'''{{resize|1.2em|Regardless of what settings you have set for the source and scraper, {{Kodi}} will always search for and scan the nfo file first where available.}}'''

The episode nfo file is placed alongside each episode video file. The episode nfo filename is the same as the video filename but with the ''.nfo'' extension. See image below for examples.

<gallery mode="packed" widths="1000px" heights="562px">
File:LocalEpisodeArtwork01.jpg|'''''Episode Artwork and nfo files'''''
</gallery>

= nfo Tags =
The following table lists the available XML tags in the episode nfo file. <ref>https://github.com/xbmc/xbmc/blob/master/xbmc/video/VideoInfoTag.cpp</ref>

''Yes'' in the Inherited column indicates a tag that uses data from the parent TV Show. These tags are created in the exported nfo file but are ignored on import so it is not possible to change this data at the episode level.

Three XML tags are required and are indicated in the table below. All other tags are optional. Of course the less tags used, the less information scanned into the library.

{|class="prettytable"
! NFO (xml) Tag || Required || Multiple || Inherited || Notes
|-
|<episodedetails></episodedetails> || {{Yes}} || No/Yes || || The top level parent tag for the nfo file. All other tags must be contained within these two tags<br/>
Yes - When creating multi-episode nfo files. See next section. <br/>
No - In all other cases, a single instance is used.
|-
|<title></title> || {{Yes}} || No || || The title for the episode
|-
|<originaltitle></originaltitle> || No || No || Yes || Inherited from TV show
|-
|<showtitle></showtitle> || No || No || Yes || Inherited from TV show
|-
|<syntaxhighlight lang="xml">
<ratings>
<rating name="" max="10" default="">
<value></value>
<votes></votes>
</rating>
</ratings>
</syntaxhighlight>
|| No || No || || ''default="true"'' ''default="false"''<br>
::Only one rating can be set as ''default="true"'', additional ratings must be set as ''default="false"'' or ommitted<br>

''name="identifier"''. Do not use "default". Examples of identifier include...<br>
::''<rating name="imdb" max="10">''<br>
::''<rating name="trakt" max="10">''<br>
::''<rating name="tvmaze" max="10">''<br>
::''<rating name="metacritic" max="10">''<br>
::''<rating name="tomatometerallcritics" max="10">''<br>
::''<rating name="tomatometerallaudience" max="10">''<br>

Example of complete entry...
::''<rating name="themoviedb" max="10" default="true">''<br>
::''<rating name="imdb" max="10" default="false"> or <rating name="themoviedb" max="10">''<br>
|-
|<userrating></userrating> || No || No || || Personal rating set by the user
|-
|<top250></top250> || No || No || || Not used
|-
|<season></season> || No || No/Yes || || Season number is read from filename in all cases<br/>
Not required for single nfo files<br/>
Required for multi-episode nfo files to match the metadata to the correct episode. See next section
|-
|<episode></episode> || No || No/Yes || || Episode number is read from filename in all cases<br/>
Not required for single nfo files<br/>
Required for multi-episode nfo files to match the metadata to the correct episode. See next section
|-
|<displayepisode></displayepisode> || No || No || || Used to place Specials episodes in the correct episode order
|-
|<displayseason></displayseason> || No || No || || Used to place Specials episodes in the correct season
|-
|<outline></outline> || No || No || || Not used
|-
|<plot></plot> || No || No || || A description of the episode
|-
|<tagline></tagline> || No || No || || Short slogan of the episode. No skins use this.
|-
|<runtime></runtime> || No || No || || Minutes only. If ommitted, {{kodi}} will add runtime upon scanning of the video file
|-
|<thumb aspect="thumb" preview=""></thumb> || No || Yes || || Path to episode artwork. Not needed when using local artwork
|-
|<mpaa></mpaa> || No || No || Yes || Inherited from TV show
|-
|<playcount></playcount> || No || No || || Number of times episode has been played.<br>See... [[Import-export_library/Video#Watched.2C_PlayCount.2C_ResumePoints|Import-Export]]
|-
|<lastplayed></lastplayed> || No || No || || Date last played<br>
Format as ''yyyy-mm-dd''
|-
|<id></id> || No || No || || The default ID. <br>
Do not use. It is a deprecated Kodi generated tag. See next item.
|-
|<uniqueid type="" default=""></uniqueid> || {{Yes}} || Yes || || The ID from the scraper site.<br>
''type=""'' Identifier of the ID. Do not use "default". Examples of identifier include...<br>
::''<uniqueid type="imdb"''<br>
::''<uniqueid type="tvdb"''<br>
::''<uniqueid type="tmdb"''<br>
::For non-scraped items, use simple values like ''"home", "sport", "doco"'' etc<br>
::The value can be alpha-numeric eg ''tt3480556'' for imdb, ''286668'' for tmdb, ''home001'' for home movies, etc<br>
''default="true"'' ''default="false"''<br>
::Only one uniqueID can be set as ''default="true"'', additional uniqueIDs must be set as ''default="false"'' or ommit the default attribute <br/>
Example of complete entry...
::''<uniqueid type="tmdb" default="true">''<br>
::''<uniqueid type="imdb" default="false"> or <uniqueid type="imdb">''<br>
|-
|<genre></genre> || No || Yes || Yes || Inherited from TV show
|-
|<credits></credits> || No || Yes || || Field for writers.
|-
|<director></director> || No || Yes || || Director
|-
|<premiered></premiered> || No || No || Yes || Inherited from TV show
|-
|<year></year> || No || No || Yes || Inherited from TV show
|-
|<status></status> || No || No || || Not used
|-
|<code><code></code></code> || No || No || || Not used
|-
|<aired></aired> || No || No || || Original air date of the episode<br>
Format as ''yyyy-mm-dd''
|-
|<studio></studio> || No || Yes || Yes || Production studio. Inherited from TV Show
|-
|<trailer></trailer> || No || No || ||Not used
|-
|<syntaxhighlight lang="xml">
<episodebookmark>
<position></position>
</episodebookmark>
</syntaxhighlight>
|| No || No || || Episode Bookmark in seconds. ''See: [[Bookmarks_and_chapters|Episode Bookmarks]]''<br>
Not used for Import
|-
|<syntaxhighlight lang="xml">
<fileinfo>
<streamdetails>
<video>
<codec></codec>
<aspect></aspect>
<width></width>
<height></height>
<durationinseconds></durationinseconds>
<stereomode></stereomode>
</video>
<audio>
<codec></codec>
<language></language>
<channels></channels>
</audio>
<subtitle>
<language></language>
</subtitle>
</streamdetails>
</fileinfo>
</syntaxhighlight>
|| No || Yes || || Multiple entries of <audio> and <subtitles> accepted<br>
In v17 and prior, {{kodi}} would overwrite these values on first play of the file.<br>
In v18 that process was removed and values in these tags will remain.<ref>https://github.com/xbmc/xbmc/pull/16342</ref><br>
If ommitted, {{kodi}} will add runtime upon scanning
|-
|<syntaxhighlight lang="xml">
<actor>
<name></name>
<role></role>
<order></order>
<thumb></thumb>
</actor>
</syntaxhighlight>
|| No || Yes || || The <order> tag determines where in the list the actor will appear. 0 = first in the list
Supports "clear" attribute
|-
|<syntaxhighlight lang="xml">
<resume>
<position></position>
<total></total>
</resume>
</syntaxhighlight>
|| No || No || || Set the resume position<br>See... [[Import-export_library/Video#Watched.2C_PlayCount.2C_ResumePoints|Import-Export]]
|-
|<dateadded></dateadded> || No || No || || mTime of the playable video file. Can be altered in advancedsettings.xml<br>See... '''[[Advancedsettings.xml#videolibrary]]'''
|}

= Multi-Episode Files =
There may be instances where a video file contains two or more episodes. This is common for ISO files.

Multi-episode video files still use a single nfo file. The metadata for each episode is stacked in the single nfo file. Below is an example of an abbreviated multi-episode nfo file containing 3 episodes.

One difference between the single and multi nfo file is that the ''<season></season>'' and ''<episode></episode>'' tags are required for each episode in the multi nfo file. {{kodi}} still requires the filename to contain the season and episode numbering, but it also requires these additional tags so it can match the metadata to the correct episode. The metadata for each episode must be in correct numerical order.

For correct naming of the video file, nfo file and artwork thumb, see: '''[[Naming_video_files/Episodes#Multi-Episode_Files|Naming Multi-Episode Files]]'''

<div class="toccolours mw-collapsible mw-collapsed" style="width:50%; overflow:auto;">
<center>'''Example Multi-Episode NFO File'''</center>
<div class="mw-collapsible-content">
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<episodedetails> 
<title>Episode 1</title>
<userrating></userrating>
<plot></plot>
<season>1</season>
<episode>1</episode>
<uniqueid type="" default="true"></uniqueid>
<credits></credits>
<director></director>
<aired></aired>
<actor>
<name></name>
<role></role>
<order></order>
<thumb></thumb>
</actor>
</episodedetails>
<episodedetails> 
<title>Episode 2</title>
<userrating></userrating>
<plot></plot>
<season>1</season>
<episode>2</episode>
<uniqueid type="" default="true"></uniqueid>
<credits></credits>
<director></director>
<aired></aired>
<actor>
<name></name>
<role></role>
<order></order>
<thumb></thumb>
</actor>
</episodedetails>
<episodedetails> 
<title>Episode 3</title>
<userrating></userrating>
<plot></plot>
<season>1</season>
<episode>3</episode>
<uniqueid type="" default="true"></uniqueid>
<credits></credits>
<director></director>
<aired></aired>
<actor>
<name></name>
<role></role>
<order></order>
<thumb></thumb>
</actor>
</episodedetails>

</syntaxhighlight>
</div>
</div>

= References =
<references />

{{top}}
{{updated|19}}

[[Category:Karellen]]
[[Category:Video library]]

NFO files/TV shows

2022-12-25T10:13:25Z

CastagnaIT: Improved date format info

{{NFO_content}}
{{mininav|[[NFO files]]}}

__TOC__

= Introduction =
NFO files for TV Shows are a little bit more complex as they require the following NFO files:
* One nfo file for the TV Show. This file holds the overall TV show information
* One nfo file for '''each''' Episode. This file holds information specific to that episode
For one TV Show with 10 episodes, 11 nfo files are required.

= episodeguide URL =
The <episodeguide> is the tag that allows the scrapers to find the episodes belonging to the TV Show at the site of the information provider.

Due to an issue where the UniqueID for TV shows and movies across TV Maze, TMDB and TheTVDB are '''not''' unique, the episode guide was converted to a JSON format which clearly identified which site the UniqueID belongs to.

These changes have been incorporated into v19 and later releases of {{kodi}}. [https://forum.kodi.tv/showthread.php?tid=370489 Read more here]

= nfo Name and Location =
'''{{resize|1.2em|Regardless of what settings you have set for the source and scraper, {{Kodi}} will always search for and scan the nfo file first where available.}}'''

The tvshow.nfo file is placed inside the TV Show folder. The NFO filename is actually '''tvshow.nfo'''. Do not rename it with the title of the tv show. See image for example

<gallery mode="packed" widths="1000px" heights="562px">
File:LocalTVShowArtwork01.jpg|'''''Location of tvshow.nfo along with artwork'''''
</gallery>

= nfo Tags =
The following table lists available XML tags for TV Shows. <ref>https://github.com/xbmc/xbmc/blob/master/xbmc/video/VideoInfoTag.cpp</ref>

Two XML tags are required and are indicated in the table below. All other tags are optional. Of course the less tags used, the less information scanned into the library.

{|class="prettytable"
! NFO (xml) Tag || Required || Multiple || Notes
|-
|<tvshow></tvshow> || {{Yes}} || No || The top level parent tag for the nfo file. All other tags must be contained within these two tags
|-
|<title></title> || {{Yes}} || No || The title of the TV Show
|-
|<originaltitle></originaltitle> || No || No || The original title, usually in the language of the country of origin.
|-
|<showtitle></showtitle> || No || No || Not in common use, but some skins may display an alternate title
|-
|<sorttitle></sorttitle> || No || No || Allows alternate title sort without modifying the TV Show title. Not displayed in any library listing.
|-
|
<ratings>
<rating name="" max="10" default="">
<value></value>
<votes></votes>
</rating>
</ratings>
|| No || No || ''default="true"'' ''default="false"''<br>
::Only one rating can be set as ''default="true"'', additional ratings must be set as ''default="false"'' or ommitted<br>

''name="identifier"''. Do not use "default". Examples of identifier include...<br>
::''<rating name="imdb" max="10">''<br>
::''<rating name="trakt" max="10">''<br>
::''<rating name="tvmaze" max="10">''<br>
::''<rating name="metacritic" max="10">''<br>
::''<rating name="tomatometerallcritics" max="10">''<br>
::''<rating name="tomatometerallaudience" max="10">''<br>

Example of complete entry...
::''<rating name="themoviedb" max="10" default="true">''<br>
::''<rating name="imdb" max="10" default="false"> or <rating name="themoviedb" max="10">''<br>
|-
|<userrating></userrating> || No || No || Personal rating set by the user
|-
|<top250></top250> || No || No || Ranking in IMDB Top 250
|-
|<season></season> || No || No ||Number of seasons of this TV Show in the library
|-
|<episode></episode> || No || No || Number of episodes of this TV Show in the library
|-
|<displayepisode></displayepisode> || No || No || Not used
|-
|<displayseason></displayseason> || No || No || Not used
|-
|<outline></outline> || No || No || Not Used
|-
|<plot></plot> || No || No || Can contain more information on multiple lines, will be wrapped
|-
|<tagline></tagline> || No || No || Short TV Show slogan
|-
|<runtime></runtime> || No || No || Not used
|-
|<thumb aspect="" preview=""></thumb>
<thumb aspect="poster" type="season" season="" preview=""></thumb>
|| No || Yes || Path to available TV Show Posters. Not used for locally saved artwork<br>
Example use of ''aspect=""''
:<thumb aspect="banner"
:<thumb aspect="clearart"
:<thumb aspect="clearlogo"
:<thumb aspect="landscape"
:<thumb aspect="poster"<br>
''type="season"'' used for season specific artwork<br>
''season="2"'' nominates season number eg. season 2
|-
|
<fanart>
<thumb preview=""></thumb>
</fanart>
|| No || Yes^ || Path to available TV Show fanart.<br>
:^ Multiple <thumb> entries allowed between the <fanart></fanart> tags<br>
Not used for locally saved artwork
|-
|<mpaa></mpaa> || No || No || Country specific mpaa rating system. Check with skin author which prefix is required to diplay your country local rating system
|-
|<playcount></playcount> || No || No || Number of times TV show has been played. Will only ever show 0 or 1. Episodes track playcounts<br>See... [[Import-export_library/Video#Watched.2C_PlayCount.2C_ResumePoints|Import-Export]]
|-
|<lastplayed></lastplayed> || No || No || Date TV Show was last played
|-
|
<episodeguide>
{"tmdb": "76479", "imdb": "tt1190634", "tvdb": "355567"}
</episodeguide>
|| Yes/No || No || Read section ''1.1 episodeguide URL'' above.<br>
For v19 and later, a JSON format is used. ''[https://forum.kodi.tv/showthread.php?tid=370489 Read more here]''<br>
TVDB scraper uses TheTVDB v4 API<br>
Other providers: ''"tvmaze":'' and ''"tvrage":''
|-
|<id></id> || No || No || The default ID. <br>
Do not use as this is a Kodi generated tag. See next item.
|-
|<uniqueid type="" default=""></uniqueid> || {{Yes}} || Yes ||The ID from the scraper site.<br>
''type=""'' Identifier of the ID. Do not use "default". Examples of identifier include...<br>
::''<uniqueid type="imdb"''<br>
::''<uniqueid type="tvdb"''<br>
::''<uniqueid type="tmdb"''<br>
::For non-scraped items, use simple values like ''"home", "sport", "doco"'' etc<br>
::The value can be alpha-numeric eg ''tt3480556'' for imdb, ''286668'' for tmdb, ''home001'' for home movies, etc<br>
''default="true"'' ''default="false"''<br>
::Only one uniqueID can be set as ''default="true"'', additional uniqueID's must be set as ''default="false"'' or ommit the default attribute<br>
Example of complete entry...
::''<uniqueid type="tmdb" default="true">''<br>
::''<uniqueid type="imdb" default="false"> or <uniqueid type="imdb">''<br>
|-
|<genre></genre> || No || Yes || Genre
|-
|<tag></tag> || No || Yes || Tags. See: ''[[Video library tags]]''
|-
|<premiered></premiered> || No || No || Release date of TV Show. Comes from Aired Date of the first episode.<br>
Format as ''yyyy-mm-dd''
|-
|<year></year> || No || No || Release Year.<br>
{{note|Kodi v17: Tag deprecated, use <premiered> tag instead.}}
{{note|Kodi v20: Use <premiered> tag only.}}
|-
|<status></status> || No || No || Continuing or Ended show
|-
| <code><code></code></code> || No || No || Not used
|-
|<aired></aired> || No || No || Not used
|-
|<studio></studio> || No || Yes || Production studio
|-
|<trailer></trailer> || No || No || Local or online path to TV Show trailer
|-
|
<actor>
<name></name>
<role></role>
<order></order>
<thumb></thumb>
</actor>
|| No || Yes || The <order> tag determines where in the list the actor will appear. 0 = first in the list
Supports "clear" attribute
|-
| <namedseason number=""></namedseason> || No || Yes || Allows naming of Seasons. eg:<br>
<namedseason number="1">Season 1: The Maze</namedseason>
|-
|
<resume>
<position></position>
<total></total>
</resume>
|| No || No || Not used for TV Show
|-
|<dateadded></dateadded> || No || No || mTime of the playable video file. Can be altered in advancedsettings.xml<br>See... '''[[Advancedsettings.xml#videolibrary]]'''
|}

= References =
<references />

{{top}}
{{updated|19}}

[[Category:Karellen]]
[[Category:Video library]]

NFO files/Music videos

2022-12-25T10:12:33Z

CastagnaIT: Improved date format info

{{NFO_content}}
{{mininav|[[NFO files]]}}

__TOC__

= Introduction =
The Music Video library uses the Video Library database. Music Video entries displayed in {{kodi}} can also access information from the Music Library if the same artist and album that contains the music video song is also in the Music Library.

= nfo Name and Location =
'''{{resize|1.2em|Regardless of what settings you have set for the source and scraper, {{Kodi}} will always search for and scan the nfo file first where available.}}'''

Music Videos require one nfo for '''each''' music video in the folder. These nfo files need to be named exactly as the Music Video file is named, but with the nfo extension.

The below image shows an example of correct naming and placement of the artwork alongside the '''''[[NFO_files|nfo]]''''' file and the Music Video media file.

<gallery mode="packed" widths="500px" heights="290px">
File:Artwork-MusicVideoExample01.jpg|Correct naming and placement of media, nfo and artwork files.
</gallery>

= Music Video Tags =
A list of all available tags that Kodi recognises follows in this section.

{|class="prettytable"
! NFO (xml) Tag || Required || Multiple || Notes
|-
|<musicvideo></musicvideo> || {{Yes}} || No || The top level parent tag for the nfo file. All other tags must be contained within these two tags
|-
|<title></title> || {{Yes}} || No || Name of music video
|-
|<userrating></userrating> || No || No || Personal rating applied by the user
|-
|<top250></top250> || No || No || Not Used
|-
|<track></track> || No || No || Not Used
|-
|<album></album> || No || No || Name of album the song appears on
|-
|<outline></outline> || No || No || Not Used
|-
|<plot></plot> || No || No || Review / information of music video
|-
|<tagline></tagline> || No || No || Not Used
|-
|<runtime></runtime> || No || No || Minutes only. If ommitted, {{kodi}} will add runtime upon scanning
|-
|<thumb aspect="thumb" preview=""></thumb> || No || Yes || Path to TV Show and Season artwork
|-
|<mpaa></mpaa> || No || No || Not Used
|-
|<playcount></playcount> || No || No || Setting this to 1 or greater will mark the Music Video
|-
|<lastplayed></lastplayed> || No || No || Date last played<br>
Format as ''yyyy-mm-dd''
|-
|<id></id> || No || No || Not Used
|-
|<genre></genre> || No || Yes || Genre
|-
|<tag></tag> || No || Yes || Video tags. See: '''[[Video library tags]]'''
|-
|<director></director> || No || Yes || Director of the music video
|-
|<premiered></premiered> || No || No || Release date.<br>
Format as ''yyyy-mm-dd''
|-
|<year></year> || No || No || Release Year.<br>
{{note|Kodi v17: Tag deprecated, use <premiered> tag instead.}}
{{note|Kodi v20: Use <premiered> tag only.}}
|-
|<status></status> || No || No || Not Used
|-
|<code><code></code></code> || No || No || Not Used
|-
|<aired></aired> || No || No || Not Used
|-
|<studio></studio> || No || Yes || Production studio
|-
|<trailer></trailer> || No || No || Not used
|-
|
<fileinfo>
<streamdetails>
<video>
<codec></codec>
<aspect></aspect>
<width></width>
<height></height>
<durationinseconds></durationinseconds>
<stereomode></stereomode>
</video>
<audio>
<codec></codec>
<language></language>
<channels></channels>
</audio>
</streamdetails>
</fileinfo>
|| No || No || While it is possible to manually set the information contained within the <streamdetails> tag, there is little point in doing so.
Kodi will always overwrite this data when it plays back the video file.<br />
In other words, no matter how many times you try to manually set it, it will be overwritten the moment the video is played
|-
|
<actor>
<name>Taylor Swift</name>
<role></role>
<order>0</order>
<thumb></thumb>
</actor>
|| No || Yes || The artist of the song
|-
| <artist></artist> || {{yes}} || Yes || The artists/actors in the music video
|-
|
<resume>
<position></position>
<total></total>
</resume>
|| No || No || Not Used
|-
|<dateadded></dateadded> || No || No || mTime of the playable video file. Can be altered in advancedsettings.xml<br>See... '''[[Advancedsettings.xml#videolibrary]]'''
|}

= References =
<references />

{{top}}
{{updated|19}}

[[Category:Karellen]]
[[Category:Music library]]
[[Category:Video library]]

NFO files/Music videos

2022-12-25T10:11:03Z

CastagnaIT: Added <premiered> and more details for deprecated <year>

{{NFO_content}}
{{mininav|[[NFO files]]}}

__TOC__

= Introduction =
The Music Video library uses the Video Library database. Music Video entries displayed in {{kodi}} can also access information from the Music Library if the same artist and album that contains the music video song is also in the Music Library.

= nfo Name and Location =
'''{{resize|1.2em|Regardless of what settings you have set for the source and scraper, {{Kodi}} will always search for and scan the nfo file first where available.}}'''

Music Videos require one nfo for '''each''' music video in the folder. These nfo files need to be named exactly as the Music Video file is named, but with the nfo extension.

The below image shows an example of correct naming and placement of the artwork alongside the '''''[[NFO_files|nfo]]''''' file and the Music Video media file.

<gallery mode="packed" widths="500px" heights="290px">
File:Artwork-MusicVideoExample01.jpg|Correct naming and placement of media, nfo and artwork files.
</gallery>

= Music Video Tags =
A list of all available tags that Kodi recognises follows in this section.

{|class="prettytable"
! NFO (xml) Tag || Required || Multiple || Notes
|-
|<musicvideo></musicvideo> || {{Yes}} || No || The top level parent tag for the nfo file. All other tags must be contained within these two tags
|-
|<title></title> || {{Yes}} || No || Name of music video
|-
|<userrating></userrating> || No || No || Personal rating applied by the user
|-
|<top250></top250> || No || No || Not Used
|-
|<track></track> || No || No || Not Used
|-
|<album></album> || No || No || Name of album the song appears on
|-
|<outline></outline> || No || No || Not Used
|-
|<plot></plot> || No || No || Review / information of music video
|-
|<tagline></tagline> || No || No || Not Used
|-
|<runtime></runtime> || No || No || Minutes only. If ommitted, {{kodi}} will add runtime upon scanning
|-
|<thumb aspect="thumb" preview=""></thumb> || No || Yes || Path to TV Show and Season artwork
|-
|<mpaa></mpaa> || No || No || Not Used
|-
|<playcount></playcount> || No || No || Setting this to 1 or greater will mark the Music Video
|-
|<lastplayed></lastplayed> || No || No || Date last played as ''yyyy-mm-dd''
|-
|<id></id> || No || No || Not Used
|-
|<genre></genre> || No || Yes || Genre
|-
|<tag></tag> || No || Yes || Video tags. See: '''[[Video library tags]]'''
|-
|<director></director> || No || Yes || Director of the music video
|-
|<premiered></premiered> || No || No || Release date.<br>
Format as ''2019-01-31''
|-
|<year></year> || No || No || Release Year.<br>
{{note|Kodi v17: Tag deprecated, use <premiered> tag instead.}}
{{note|Kodi v20: Use <premiered> tag only.}}
|-
|<status></status> || No || No || Not Used
|-
|<code><code></code></code> || No || No || Not Used
|-
|<aired></aired> || No || No || Not Used
|-
|<studio></studio> || No || Yes || Production studio
|-
|<trailer></trailer> || No || No || Not used
|-
|
<fileinfo>
<streamdetails>
<video>
<codec></codec>
<aspect></aspect>
<width></width>
<height></height>
<durationinseconds></durationinseconds>
<stereomode></stereomode>
</video>
<audio>
<codec></codec>
<language></language>
<channels></channels>
</audio>
</streamdetails>
</fileinfo>
|| No || No || While it is possible to manually set the information contained within the <streamdetails> tag, there is little point in doing so.
Kodi will always overwrite this data when it plays back the video file.<br />
In other words, no matter how many times you try to manually set it, it will be overwritten the moment the video is played
|-
|
<actor>
<name>Taylor Swift</name>
<role></role>
<order>0</order>
<thumb></thumb>
</actor>
|| No || Yes || The artist of the song
|-
| <artist></artist> || {{yes}} || Yes || The artists/actors in the music video
|-
|
<resume>
<position></position>
<total></total>
</resume>
|| No || No || Not Used
|-
|<dateadded></dateadded> || No || No || mTime of the playable video file. Can be altered in advancedsettings.xml<br>See... '''[[Advancedsettings.xml#videolibrary]]'''
|}

= References =
<references />

{{top}}
{{updated|19}}

[[Category:Karellen]]
[[Category:Music library]]
[[Category:Video library]]

NFO files/Movies

2022-12-25T09:47:51Z

CastagnaIT: More details for deprecated <year> tag

{{NFO_content}}
{{mininav|[[NFO files]]}}

__TOC__

= Introduction =
NFO files to be scraped into the movie library are relatively simple and require only a single nfo file per title.

= nfo Name and Location =
'''{{resize|1.2em|Regardless of what settings you have set for the source and scraper, {{Kodi}} will always search for and scan the nfo file first where available.}}'''

There are two naming schemes for movie nfo files. Both are explained and {{kodi}} recommends using the ''<VideoFileName>.nfo'' format.

<section begin="MovieNFONaming" />;<VideoFileName>.nfo
:*NFO Files are named the same as the video file except with the ''.nfo'' extension.
:*We recommend using this filename format to name nfo files.

;movie.nfo
:{{Kodi}} may also scan nfo files named '''''movie.nfo'''''. To use this name, the setting '''Movies are in separate folders that match the movie title''' must be '''Enabled''' in the '''[[Adding_video_sources#Set_Content|Set Content Screen]]'''
:*If the above setting is not enabled, {{kodi}} will ignore the ''movie.nfo''. If the ''<VideoFileName>.nfo'' file is available, {{kodi}} will scan this one instead, otherwise an online scrape will be performed if a valid scraper is set for the Source.
:*If you use ''movie.nfo'' and later Export your library to Separate Files, {{kodi}} will still create the nfo file in the ''<VideoFileName>.nfo'' format and two nfo files will exist. If a Refresh or rescan is run in future, and the above setting is still enabled, the ''<VideoFileName>.nfo'' file will be ignored in favour of ''movie.nfo'', which means any changes you may have made to the library entry (play counts, watched status etc) will not be re-scanned back into the library.
:*We recommend using the ''<VideoFileName>.nfo'' format for nfo files to avoid the above traps.<section end="MovieNFONaming" />

The below image details naming and location for Single File, DVD and Bluray movies:

<gallery mode="packed" widths="1000px" heights="562px">
File:LocalMovieArtwork01.jpg|'''''Example of correct use of Movie Folder with artwork, nfo file, trailer and theme.<br> Take note of file naming and location.'''''
</gallery>

= nfo Tags =
The following table lists available XML tags. <ref>https://github.com/xbmc/xbmc/blob/master/xbmc/video/VideoInfoTag.cpp</ref>

The "Required" column indicates whether a tag can be optionally added or ommitted when creating the nfo to suit your purpose. The less tags used, the less information added to the library.

{|class="prettytable"
! width=430px | NFO (xml) Tag || Required || Multiple || Notes
|-
|<movie></movie> || {{Yes}} || No || The top level parent tag for the nfo file. All other tags must be contained within these two tags
|-
|<title></title> || {{Yes}} || No || The title for the movie
|-
|<originaltitle></originaltitle> || No || No || Displays the original title of the movie. <br>
For example, if the scraper is set to german language and the scraped movie in german is "Der mit dem Wolf tanzt" the original title will be "Dances with Wolves"
|-
|<sorttitle></sorttitle> || No || No || Allows alternate title sort without modifying movie title. Not displayed in any library listing. See: ''[[Movie_sets#Sort_Title|Sort Title]]''
|-
|
<ratings>
<rating name="" max="10" default="">
<value></value>
<votes></votes>
</rating>
</ratings>
|| No || No || ''default="true"'' ''default="false"''<br>
::Only one rating can be set as ''default="true"'', additional ratings must be set as ''default="false"'' or omit the default attribute<br>

''name="identifier"''. Do not use "default". Examples of identifier include...<br>
::''<rating name="imdb" max="10">''<br>
::''<rating name="trakt" max="10">''<br>
::''<rating name="themoviedb" max="10">''<br>
::''<rating name="metacritic" max="10">''<br>
::''<rating name="tomatometerallcritics" max="10">''<br>
::''<rating name="tomatometerallaudience" max="10">''<br>

Example of complete entry...
::''<rating name="themoviedb" max="10" default="true">''<br>
::''<rating name="imdb" max="10" default="false"> or <rating name="themoviedb" max="10">''<br>
|-
|<userrating></userrating> || No || No || Personal rating set by the user
|-
|<top250></top250> || No || No || Ranking in IMDB Top 250 movies
|-
|<outline></outline> || || || Should be short, will be displayed on a single line (scraped from IMDB only)
|-
|<plot></plot> || || || Can contain more information on multiple lines, will be wrapped
|-
|<tagline></tagline> || No || No || Short movie slogan. "The true story of a real fake" is the tagline for "Catch me if you can"
|-
|<runtime></runtime> || No || No || Minutes only. If ommitted, {{kodi}} will add runtime upon scanning
|-
|<thumb aspect="" preview=""></thumb> || No || Yes || Path to available Movie Posters. Not needed when using local artwork<br>
Example use of ''aspect=""''
:<thumb aspect="banner"
:<thumb aspect="clearart"
:<thumb aspect="clearlogo"
:<thumb aspect="discart"
:<thumb aspect="keyart"
:<thumb aspect="landscape"
:<thumb aspect="poster"
|-
|
<fanart>
<thumb preview=""></thumb>
</fanart>
|| No || Yes^ || Path to available movie fanart.<br>
:^ Multiple <thumb> entries allowed between the <fanart></fanart> tags
|-
|<mpaa></mpaa> || No || No || Country specific mpaa rating system. Check with skin author which prefix is required to diplay your country certification flags
|-
|<playcount></playcount> || No || No || Number of times movie has been played.<br>See... [[Import-export_library/Video#Watched.2C_PlayCount.2C_ResumePoints|Import-Export]]
|-
|<lastplayed></lastplayed> || No || No || Date last played as ''yyyy-mm-dd''
|-
|<id></id> || No || No || The default ID. <br>
Do not use. This is a Kodi generated tag. See next item.
|-
|<uniqueid type="" default=""></uniqueid> || {{Yes}} || Yes ||The ID from the scraper site.<br>
''type=""'' Identifier of the ID. Do not use "default". Examples of identifier include...<br>
::''<uniqueid type="imdb"''<br>
::''<uniqueid type="tvdb"''<br>
::''<uniqueid type="tmdb"''<br>
::For non-scraped items, use simple values like ''"home", "sport", "doco"'' etc<br>
::The value can be alpha-numeric eg ''tt3480556'' for imdb, ''286668'' for tmdb, ''home001'' for home movies, etc<br>
''default="true"'' ''default="false"''<br>
::Only one uniqueID can be set as ''default="true"'', additional uniqueID's must be set as ''default="false"'' or ommit the default attribute<br>
Example of complete entry...
::''<uniqueid type="tmdb" default="true">''<br>
::''<uniqueid type="imdb" default="false"> or <uniqueid type="imdb">''<br>
|-
|<genre></genre> || No || Yes || Movie genre.
|-
|<tag></tag> || No || Yes || Library Tags. See...'''[[Video library tags]]'''
|-
|
<set>
<name></name>
<overview></overview>
</set>
|| No || No || Movie set tags <br />
The <overview> tag allows a short summary of the movie set. It can be displayed by some skins.
<br />See... '''[[Movie sets]]'''
|-
|<country></country> || No || Yes || Country of origin
|-
|<credits></credits> || No || Yes || Field for writers.
|-
|<director></director> || No || Yes || Movie Director
|-
|<premiered></premiered> || No || No || Release date of movie. Format as ''yyyy-mm-dd''
|-
|<year></year> || No || No || Release Year.<br>
{{note|Kodi v17: Tag deprecated, use <premiered> tag instead.}}
{{note|Kodi v20: Use <premiered> tag only.}}
|-
|<status></status> || No || No || Not used
|-
|<code><code></code></code> || No || No || Not used
|-
|<aired></aired> || No || No || Not used
|-
|<studio></studio> || No || Yes || Production studio
|-
|<trailer></trailer> || No || No || Local or online path to movie trailer<br> Do not add local path to trailer. {{kodi}} will automatically scan for local trailers.<br> See... '''[[Trailers]]'''
|-
|
<fileinfo>
<streamdetails>
<video>
<codec></codec>
<aspect></aspect>
<width></width>
<height></height>
<durationinseconds></durationinseconds>
<stereomode></stereomode>
</video>
<audio>
<codec></codec>
<language></language>
<channels></channels>
</audio>
<subtitle>
<language></language>
</subtitle>
</streamdetails>
</fileinfo>
|| No || Yes || Multiple entries of <audio> and <subtitles> accepted<br>
In v17 and prior, {{kodi}} would overwrite these values on first play of the file.<br>
In v18 that process was removed and values in these tags will remain.<ref>https://github.com/xbmc/xbmc/pull/16342</ref>
|-
|
<actor>
<name></name>
<role></role>
<order></order>
<thumb></thumb>
</actor>
|| No || Yes || The <order> tag determines where in the list the actor will appear. 0 = first in the list
|-
|<showlink></showlink> || No || No || Connect movie to TV Show. Use the TV Show <title></title> name.
|-
|
<resume>
<position></position>
<total></total>
</resume>
|| No || No || Movie resume point in Seconds<br>See... [[Import-export_library/Video#Watched.2C_PlayCount.2C_ResumePoints|Import-Export]]
|-
|<dateadded></dateadded> || No || No || mTime of the playable video file. Can be altered in advancedsettings.xml<br>See... '''[[Advancedsettings.xml#videolibrary]]'''
|}

= References =
<references />

{{top}}
{{updated|19}}

[[Category:Karellen]]
[[Category:Video library]]

NFO files/TV shows

2022-12-25T09:46:24Z

CastagnaIT: More details for deprecated <year> tag

{{NFO_content}}
{{mininav|[[NFO files]]}}

__TOC__

= Introduction =
NFO files for TV Shows are a little bit more complex as they require the following NFO files:
* One nfo file for the TV Show. This file holds the overall TV show information
* One nfo file for '''each''' Episode. This file holds information specific to that episode
For one TV Show with 10 episodes, 11 nfo files are required.

= episodeguide URL =
The <episodeguide> is the tag that allows the scrapers to find the episodes belonging to the TV Show at the site of the information provider.

Due to an issue where the UniqueID for TV shows and movies across TV Maze, TMDB and TheTVDB are '''not''' unique, the episode guide was converted to a JSON format which clearly identified which site the UniqueID belongs to.

These changes have been incorporated into v19 and later releases of {{kodi}}. [https://forum.kodi.tv/showthread.php?tid=370489 Read more here]

= nfo Name and Location =
'''{{resize|1.2em|Regardless of what settings you have set for the source and scraper, {{Kodi}} will always search for and scan the nfo file first where available.}}'''

The tvshow.nfo file is placed inside the TV Show folder. The NFO filename is actually '''tvshow.nfo'''. Do not rename it with the title of the tv show. See image for example

<gallery mode="packed" widths="1000px" heights="562px">
File:LocalTVShowArtwork01.jpg|'''''Location of tvshow.nfo along with artwork'''''
</gallery>

= nfo Tags =
The following table lists available XML tags for TV Shows. <ref>https://github.com/xbmc/xbmc/blob/master/xbmc/video/VideoInfoTag.cpp</ref>

Two XML tags are required and are indicated in the table below. All other tags are optional. Of course the less tags used, the less information scanned into the library.

{|class="prettytable"
! NFO (xml) Tag || Required || Multiple || Notes
|-
|<tvshow></tvshow> || {{Yes}} || No || The top level parent tag for the nfo file. All other tags must be contained within these two tags
|-
|<title></title> || {{Yes}} || No || The title of the TV Show
|-
|<originaltitle></originaltitle> || No || No || The original title, usually in the language of the country of origin.
|-
|<showtitle></showtitle> || No || No || Not in common use, but some skins may display an alternate title
|-
|<sorttitle></sorttitle> || No || No || Allows alternate title sort without modifying the TV Show title. Not displayed in any library listing.
|-
|
<ratings>
<rating name="" max="10" default="">
<value></value>
<votes></votes>
</rating>
</ratings>
|| No || No || ''default="true"'' ''default="false"''<br>
::Only one rating can be set as ''default="true"'', additional ratings must be set as ''default="false"'' or ommitted<br>

''name="identifier"''. Do not use "default". Examples of identifier include...<br>
::''<rating name="imdb" max="10">''<br>
::''<rating name="trakt" max="10">''<br>
::''<rating name="tvmaze" max="10">''<br>
::''<rating name="metacritic" max="10">''<br>
::''<rating name="tomatometerallcritics" max="10">''<br>
::''<rating name="tomatometerallaudience" max="10">''<br>

Example of complete entry...
::''<rating name="themoviedb" max="10" default="true">''<br>
::''<rating name="imdb" max="10" default="false"> or <rating name="themoviedb" max="10">''<br>
|-
|<userrating></userrating> || No || No || Personal rating set by the user
|-
|<top250></top250> || No || No || Ranking in IMDB Top 250
|-
|<season></season> || No || No ||Number of seasons of this TV Show in the library
|-
|<episode></episode> || No || No || Number of episodes of this TV Show in the library
|-
|<displayepisode></displayepisode> || No || No || Not used
|-
|<displayseason></displayseason> || No || No || Not used
|-
|<outline></outline> || No || No || Not Used
|-
|<plot></plot> || No || No || Can contain more information on multiple lines, will be wrapped
|-
|<tagline></tagline> || No || No || Short TV Show slogan
|-
|<runtime></runtime> || No || No || Not used
|-
|<thumb aspect="" preview=""></thumb>
<thumb aspect="poster" type="season" season="" preview=""></thumb>
|| No || Yes || Path to available TV Show Posters. Not used for locally saved artwork<br>
Example use of ''aspect=""''
:<thumb aspect="banner"
:<thumb aspect="clearart"
:<thumb aspect="clearlogo"
:<thumb aspect="landscape"
:<thumb aspect="poster"<br>
''type="season"'' used for season specific artwork<br>
''season="2"'' nominates season number eg. season 2
|-
|
<fanart>
<thumb preview=""></thumb>
</fanart>
|| No || Yes^ || Path to available TV Show fanart.<br>
:^ Multiple <thumb> entries allowed between the <fanart></fanart> tags<br>
Not used for locally saved artwork
|-
|<mpaa></mpaa> || No || No || Country specific mpaa rating system. Check with skin author which prefix is required to diplay your country local rating system
|-
|<playcount></playcount> || No || No || Number of times TV show has been played. Will only ever show 0 or 1. Episodes track playcounts<br>See... [[Import-export_library/Video#Watched.2C_PlayCount.2C_ResumePoints|Import-Export]]
|-
|<lastplayed></lastplayed> || No || No || Date TV Show was last played
|-
|
<episodeguide>
{"tmdb": "76479", "imdb": "tt1190634", "tvdb": "355567"}
</episodeguide>
|| Yes/No || No || Read section ''1.1 episodeguide URL'' above.<br>
For v19 and later, a JSON format is used. ''[https://forum.kodi.tv/showthread.php?tid=370489 Read more here]''<br>
TVDB scraper uses TheTVDB v4 API<br>
Other providers: ''"tvmaze":'' and ''"tvrage":''
|-
|<id></id> || No || No || The default ID. <br>
Do not use as this is a Kodi generated tag. See next item.
|-
|<uniqueid type="" default=""></uniqueid> || {{Yes}} || Yes ||The ID from the scraper site.<br>
''type=""'' Identifier of the ID. Do not use "default". Examples of identifier include...<br>
::''<uniqueid type="imdb"''<br>
::''<uniqueid type="tvdb"''<br>
::''<uniqueid type="tmdb"''<br>
::For non-scraped items, use simple values like ''"home", "sport", "doco"'' etc<br>
::The value can be alpha-numeric eg ''tt3480556'' for imdb, ''286668'' for tmdb, ''home001'' for home movies, etc<br>
''default="true"'' ''default="false"''<br>
::Only one uniqueID can be set as ''default="true"'', additional uniqueID's must be set as ''default="false"'' or ommit the default attribute<br>
Example of complete entry...
::''<uniqueid type="tmdb" default="true">''<br>
::''<uniqueid type="imdb" default="false"> or <uniqueid type="imdb">''<br>
|-
|<genre></genre> || No || Yes || Genre
|-
|<tag></tag> || No || Yes || Tags. See: ''[[Video library tags]]''
|-
|<premiered></premiered> || No || No || Release date of TV Show. Comes from Aired Date of the first episode.<br>
Format as ''2019-01-31''
|-
|<year></year> || No || No || Release Year.<br>
{{note|Kodi v17: Tag deprecated, use <premiered> tag instead.}}
{{note|Kodi v20: Use <premiered> tag only.}}
|-
|<status></status> || No || No || Continuing or Ended show
|-
| <code><code></code></code> || No || No || Not used
|-
|<aired></aired> || No || No || Not used
|-
|<studio></studio> || No || Yes || Production studio
|-
|<trailer></trailer> || No || No || Local or online path to TV Show trailer
|-
|
<actor>
<name></name>
<role></role>
<order></order>
<thumb></thumb>
</actor>
|| No || Yes || The <order> tag determines where in the list the actor will appear. 0 = first in the list
Supports "clear" attribute
|-
| <namedseason number=""></namedseason> || No || Yes || Allows naming of Seasons. eg:<br>
<namedseason number="1">Season 1: The Maze</namedseason>
|-
|
<resume>
<position></position>
<total></total>
</resume>
|| No || No || Not used for TV Show
|-
|<dateadded></dateadded> || No || No || mTime of the playable video file. Can be altered in advancedsettings.xml<br>See... '''[[Advancedsettings.xml#videolibrary]]'''
|}

= References =
<references />

{{top}}
{{updated|19}}

[[Category:Karellen]]
[[Category:Video library]]

JSON-RPC API/v13

2022-12-22T08:37:51Z

CastagnaIT: fixed Player.SetAudioDelay param

{{JSON-RPC_API_nav}}
{{mininav|[[Development]]|[[JSON-RPC API]]}}
Version 13 is the in development version of Kodi's JSON-RPC API and is published with the release of v21 (Omega).
This document has been updated to version 13.0.0. Recent changes are announced on the [https://forum.kodi.tv/forumdisplay.php?fid=174 forum]

It comes with support for [http://en.wikipedia.org/wiki/WebSocket WebSockets] as an alternative transport for third party clients. Using WebSockets will allow webinterfaces (which are currently restricted to the HTTP transport only) to get access to a bidirectional transport with Kodi's JSON-RPC API and can therefore also profit from additional features like notifications.

{{TOC right}}
== JSON-RPC 2.0 compatibility ==
{| class="prettytable" style="margin-right: 0;"
!style="padding-left: 5px; width: 7em; text-align: left;"|Version
!style="padding-left: 10px; padding-right: 10px;"|Method calls
!style="padding-left: 10px; padding-right: 10px;"|Notifications<br />(server-side)
!style="padding-left: 10px; padding-right: 10px;"|Notifications<br />(client-side)
!style="padding-left: 10px; padding-right: 10px;"|Parameters<br />by-name
!style="padding-left: 10px; padding-right: 10px;"|Parameters<br />by-position
!style="padding-left: 10px; padding-right: 10px;"|Batch requests
|-
|style="padding-left: 5px;"|Version 6
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|}

== Documentation (JSON Schema) ==
=== Supported features of JSON Schema ===
<div style="float:left; margin-right:2em">
{| class="prettytable" style="margin-right: 0;"
!style="width: 10em; text-align: left;"|Schema
!style="padding-left: 10px; padding-right: 10px;"|IETF Draft 03
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1 type]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.2 properties]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.3 patternProperties]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.4 additionalProperties]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.5 items]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.6 additionalItems]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.7 required]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.8 dependencies]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.9 minimum]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.10 maximum]
|{{yes}}
|-
|}
</div>

<div style="float:left; margin-right:2em">
{| class="prettytable" style="margin-right: 0;"
!style="width: 10em; text-align: left;"|Schema

!style="padding-left: 10px; padding-right: 10px;"|IETF Draft 03

|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.11 exclusiveMinimum]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.12 exclusiveMaximum]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.13 minItems]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.14 maxItems]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.15 uniqueItems]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.16 pattern]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.17 minLength]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.18 maxLength]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.19 enum]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.20 default]
|{{yes}}
|-
|}
</div>

<div style="float:left;">
{| class="prettytable" style="margin-right: 0;"
!style="width: 10em; text-align: left;"|Schema

!style="padding-left: 10px; padding-right: 10px;"|IETF Draft 03
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.21 title]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.22 description]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23 format]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.24 divisibleBy]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.25 disallow]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.26 extends]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.27 id]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.28 $ref]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.29 $schema]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-6 Hyper Schema]
|{{no}}
|-
|}
</div>
<div style="clear:left;"></div>

== Error message ==
If Kodi detects a bad or missing parameter in a JSON-RPC request it returns an error object. The JSON schema description of that error object is
{|
|
<syntaxhighlight lang="json" enclose="div">
{
"type": "object",
"properties": {
"code": { "type": "integer", "required": true },
"message": { "type": "string", "required": true },
"data": { "type": "object",
"properties": {
"method": { "type": "string", "required": true },
"stack": { "type": "object", "id": "Error.Stack",
"properties": {
"name": { "type": "string", "required": true },
"type": { "type": "string", "required": true },
"message": { "type": "string", "required": true },
"property": { "$ref": "Error.Stack" }
}
}
}
}
}
}
</syntaxhighlight>
|}

== Namespaces ==
The Kodi JSON-RPC API is split up into namespaces, which contain methods that can be called. These namespaces are:

{| class="prettytable" style="margin-right: 10;"
!style="padding-left: 10px; padding-right: 10px;"|Namespace
!style="padding-left: 10px; padding-right: 10px;"|Description
|-
|Addons
|List, enable and execute addons.
|-
|Application
|Application information and control.
|-
|AudioLibrary
|Audio Library information.
|-
|Favourites
|Favourites GetFavourites and AddFavourite.
|-
|Files
|Shares information & filesystem listings.
|-
|GUI
|Window properties and activation.
|-
|Input
|Allows limited navigation within Kodi.
|-
|JSONRPC
|A variety of standard JSONRPC calls.
|-
|PVR
|Live TV control.
|-
|Player
|Manages all available players.
|-
|Playlist
|Playlist modification.
|-
|Profiles
|Support for Profiles operations to Kodi.
|-
|Settings
|Allows manipulation of Kodi settings.
|-
|System
|System controls and information.
|-
|Textures
|Supplies GetTextures and RemoveTexture. Textures are images.
|-
|VideoLibrary
|Video Library information.
|-
|XBMC
|Dumping ground for very Kodi specific operations.
|}
== Methods ==
=== Addons ===
==== Addons.ExecuteAddon ====
Executes the given addon with the given parameters (if possible)<br />
'''Permissions:'''
* ExecuteAddon
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' addonid<br />
# [''mixed: object|array|string'' params = ""]<br />
# [''boolean'' wait = False]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Executes the given addon with the given parameters (if possible)",
"params": [
{
"name": "addonid",
"required": true,
"type": "string"
},
{
"default": "",
"name": "params",
"type": [
{
"additionalProperties": {
"default": "",
"type": "string"
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"description": "URL path (must start with / or ?",
"type": "string"
}
]
},
{
"default": false,
"name": "wait",
"type": "boolean"
}
],
"permission": "ExecuteAddon",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Addons.GetAddonDetails ====
Gets the details of a specific addon<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' addonid<br />
# [''[[#Addon.Fields|Addon.Fields]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#Addon.Details|Addon.Details]]'' addon<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Gets the details of a specific addon",
"params": [
{
"name": "addonid",
"required": true,
"type": "string"
},
{
"$ref": "Addon.Fields",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"addon": {
"$ref": "Addon.Details",
"required": true
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Addons.GetAddons ====
Gets all available addons<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Addon.Types|Addon.Types]]'' type = unknown]<br />
# [''[[#Addon.Content|Addon.Content]]'' content = unknown] (Content provided by the addon. Only considered for plugins and scripts.)<br />
# [''mixed: boolean|string'' enabled = all]<br />
# [''[[#Addon.Fields|Addon.Fields]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''mixed: boolean|string'' installed = True]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''array[ [[#Addon.Details|Addon.Details]] ]'' addons]<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Gets all available addons",
"params": [
{
"$ref": "Addon.Types",
"default": "unknown",
"name": "type"
},
{
"$ref": "Addon.Content",
"default": "unknown",
"description": "Content provided by the addon. Only considered for plugins and scripts.",
"name": "content"
},
{
"default": "all",
"name": "enabled",
"type": [
{
"type": "boolean"
},
{
"enums": [
"all"
],
"type": "string"
}
]
},
{
"$ref": "Addon.Fields",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"default": true,
"name": "installed",
"type": [
{
"type": "boolean"
},
{
"enums": [
"all"
],
"type": "string"
}
]
}
],
"permission": "ReadData",
"returns": {
"properties": {
"addons": {
"items": {
"$ref": "Addon.Details"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Addons.SetAddonEnabled ====
Enables/Disables a specific addon<br />
'''Permissions:'''
* ManageAddon
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' addonid<br />
# ''[[#Global.Toggle|Global.Toggle]]'' enabled<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Enables/Disables a specific addon",
"params": [
{
"name": "addonid",
"required": true,
"type": "string"
},
{
"$ref": "Global.Toggle",
"name": "enabled",
"required": true
}
],
"permission": "ManageAddon",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== Application ===
==== Application.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''array[ [[#Application.Property.Name|Application.Property.Name]] ]'' properties<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Application.Property.Value|Application.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the values of the given properties",
"params": [
{
"items": {
"$ref": "Application.Property.Name"
},
"name": "properties",
"required": true,
"type": "array",
"uniqueItems": true
}
],
"permission": "ReadData",
"returns": {
"$ref": "Application.Property.Value"
},
"type": "method"
}
</syntaxhighlight>}}
==== Application.Quit ====
Quit application<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Quit application",
"params": [],
"permission": "ControlPower",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Application.SetMute ====
Toggle mute/unmute<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Global.Toggle|Global.Toggle]]'' mute<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''boolean (Mute state)''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Toggle mute/unmute",
"params": [
{
"$ref": "Global.Toggle",
"name": "mute",
"required": true
}
],
"permission": "ControlPlayback",
"returns": {
"description": "Mute state",
"type": "boolean"
},
"type": "method"
}
</syntaxhighlight>}}
==== Application.SetVolume ====
Set the current volume<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''mixed: integer|[[#Global.IncrementDecrement|Global.IncrementDecrement]]'' volume<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''integer''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Set the current volume",
"params": [
{
"name": "volume",
"required": true,
"type": [
{
"maximum": 100,
"minimum": 0,
"type": "integer"
},
{
"$ref": "Global.IncrementDecrement"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "integer"
},
"type": "method"
}
</syntaxhighlight>}}
=== AudioLibrary ===
==== AudioLibrary.Clean ====
Cleans the audio library from non-existent items<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''boolean'' showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Cleans the audio library from non-existent items",
"params": [
{
"default": true,
"description": "Whether or not to show the progress bar or any other GUI dialog",
"name": "showdialogs",
"type": "boolean"
}
],
"permission": "RemoveData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.Export ====
Exports all items from the audio library<br />
'''Permissions:'''
* WriteFile
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''mixed: object|object'' options]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Exports all items from the audio library",
"params": [
{
"name": "options",
"type": [
{
"additionalProperties": false,
"properties": {
"path": {
"description": "Path to the directory to where the data should be exported",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"images": {
"default": false,
"description": "Whether to export thumbnails and fanart images",
"type": "boolean"
},
"overwrite": {
"default": false,
"description": "Whether to overwrite existing exported files",
"type": "boolean"
}
},
"type": "object"
}
]
}
],
"permission": "WriteFile",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetAlbumDetails ====
Retrieve details about a specific album<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' albumid<br />
# [''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#Audio.Details.Album|Audio.Details.Album]]'' albumdetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific album",
"params": [
{
"$ref": "Library.Id",
"name": "albumid",
"required": true
},
{
"$ref": "Audio.Fields.Album",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"albumdetails": {
"$ref": "Audio.Details.Album"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetAlbums ====
Retrieve all albums from specified artist (and role) or that has songs of the specified genre<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
# [''mixed: object|object|object|object|object|object|object|object|[[#List.Filter.Albums|List.Filter.Albums]]'' filter]<br />
# [''boolean'' includesingles = False]<br />
# [''boolean'' allroles = False] (Whether or not to include all roles when filtering by artist, rather than the default of excluding other contributions. When true it overrides any role filter value.)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''array[ [[#Audio.Details.Album|Audio.Details.Album]] ]'' albums]<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all albums from specified artist (and role) or that has songs of the specified genre",
"params": [
{
"$ref": "Audio.Fields.Album",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Song genre. Filter for existence of songs with this genre",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"description": "Song genre. Filter for existence of songs with this genre",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"role": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
},
"role": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Albums"
}
]
},
{
"default": false,
"name": "includesingles",
"type": "boolean"
},
{
"default": false,
"description": "Whether or not to include all roles when filtering by artist, rather than the default of excluding other contributions. When true it overrides any role filter value.",
"name": "allroles",
"type": "boolean"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"albums": {
"items": {
"$ref": "Audio.Details.Album"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetArtistDetails ====
Retrieve details about a specific artist<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' artistid<br />
# [''[[#Audio.Fields.Artist|Audio.Fields.Artist]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#Audio.Details.Artist|Audio.Details.Artist]]'' artistdetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific artist",
"params": [
{
"$ref": "Library.Id",
"name": "artistid",
"required": true
},
{
"$ref": "Audio.Fields.Artist",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"artistdetails": {
"$ref": "Audio.Details.Artist"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetArtists ====
Retrieve all artists. For backward compatibility by default this implicitly does not include those that only contribute other roles, however absolutely all artists can be returned using allroles=true<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Optional.Boolean|Optional.Boolean]]'' albumartistsonly = None] (Whether or not to only include album artists rather than the artists of only individual songs as well. If the parameter is not passed or is passed as null the GUI setting will be used)<br />
# [''[[#Audio.Fields.Artist|Audio.Fields.Artist]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
# [''mixed: object|object|object|object|object|object|object|object|object|object|object|object|object|object|object|[[#List.Filter.Artists|List.Filter.Artists]]'' filter]<br />
# [''boolean'' allroles = False] (Whether or not to include all artists irrespective of the role they contributed. When true it overrides any role filter value.)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''array[ [[#Audio.Details.Artist|Audio.Details.Artist]] ]'' artists]<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all artists. For backward compatibility by default this implicitly does not include those that only contribute other roles, however absolutely all artists can be returned using allroles=true",
"params": [
{
"$ref": "Optional.Boolean",
"default": null,
"description": "Whether or not to only include album artists rather than the artists of only individual songs as well. If the parameter is not passed or is passed as null the GUI setting will be used",
"name": "albumartistsonly"
},
{
"$ref": "Audio.Fields.Artist",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Deprecated, use songgenreid. Filter for existence of songs with this genre",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"songgenreid": {
"$ref": "Library.Id",
"description": "Song genreid. Filter for existence of songs with this genre",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"roleid": {
"$ref": "Library.Id",
"required": true
},
"songgenreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"role": {
"minLength": 1,
"required": true,
"type": "string"
},
"songgenreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"description": "Deprecated, use songgenre. Filter for existence of songs with this genre",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"songgenre": {
"description": "Song genre. Filter for existence of songs with this genre",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"roleid": {
"$ref": "Library.Id",
"required": true
},
"songgenre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"role": {
"minLength": 1,
"required": true,
"type": "string"
},
"songgenre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"albumid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"album": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"songid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"roleid": {
"$ref": "Library.Id",
"required": true
},
"songid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"role": {
"minLength": 1,
"required": true,
"type": "string"
},
"songid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"roleid": {
"$ref": "Library.Id",
"description": "Role contributed by artist. Overridden by allroles parameter",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"role": {
"description": "Role contributed by artist. Overridden by allroles parameter",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Artists"
}
]
},
{
"default": false,
"description": "Whether or not to include all artists irrespective of the role they contributed. When true it overrides any role filter value.",
"name": "allroles",
"type": "boolean"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"artists": {
"items": {
"$ref": "Audio.Details.Artist"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetAvailableArt ====
Retrieve all potential art URLs for a media item by art type<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''mixed: object|object'' item<br />
# [''string'' arttype = ""]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''array'' availableart<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all potential art URLs for a media item by art type",
"params": [
{
"name": "item",
"required": true,
"type": [
{
"additionalProperties": false,
"properties": {
"albumid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
}
]
},
{
"default": "",
"name": "arttype",
"type": "string"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"availableart": {
"items": {
"properties": {
"arttype": {
"required": true,
"type": "string"
},
"previewurl": {
"default": "",
"description": "URL to a preview thumbnail of the image",
"type": "string"
},
"url": {
"description": "URL to the original image",
"required": true,
"type": "string"
}
},
"type": "object"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetAvailableArtTypes ====
Retrieve a list of potential art types for a media item<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''mixed: object|object'' item<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''array'' availablearttypes<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve a list of potential art types for a media item",
"params": [
{
"name": "item",
"required": true,
"type": [
{
"additionalProperties": false,
"properties": {
"albumid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
}
]
}
],
"permission": "ReadData",
"returns": {
"properties": {
"availablearttypes": {
"items": {
"type": "string"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetGenres ====
Retrieve all genres<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Library.Fields.Genre|Library.Fields.Genre]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''array[ [[#Library.Details.Genre|Library.Details.Genre]] ]'' genres<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all genres",
"params": [
{
"$ref": "Library.Fields.Genre",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"genres": {
"items": {
"$ref": "Library.Details.Genre"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetProperties ====
Retrieves the values of the music library properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''array[ [[#Audio.Property.Name|Audio.Property.Name]] ]'' properties<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Audio.Property.Value|Audio.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the values of the music library properties",
"params": [
{
"items": {
"$ref": "Audio.Property.Name"
},
"name": "properties",
"required": true,
"type": "array",
"uniqueItems": true
}
],
"permission": "ReadData",
"returns": {
"$ref": "Audio.Property.Value"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetRecentlyAddedAlbums ====
Retrieve recently added albums<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''array[ [[#Audio.Details.Album|Audio.Details.Album]] ]'' albums]<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve recently added albums",
"params": [
{
"$ref": "Audio.Fields.Album",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"albums": {
"items": {
"$ref": "Audio.Details.Album"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetRecentlyAddedSongs ====
Retrieve recently added songs<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#List.Amount|List.Amount]]'' albumlimit = -1] (The amount of recently added albums from which to return the songs)<br />
# [''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# [''array[ [[#Audio.Details.Song|Audio.Details.Song]] ]'' songs]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve recently added songs",
"params": [
{
"$ref": "List.Amount",
"default": -1,
"description": "The amount of recently added albums from which to return the songs",
"name": "albumlimit"
},
{
"$ref": "Audio.Fields.Song",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"songs": {
"items": {
"$ref": "Audio.Details.Song"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetRecentlyPlayedAlbums ====
Retrieve recently played albums<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''array[ [[#Audio.Details.Album|Audio.Details.Album]] ]'' albums]<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve recently played albums",
"params": [
{
"$ref": "Audio.Fields.Album",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"albums": {
"items": {
"$ref": "Audio.Details.Album"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetRecentlyPlayedSongs ====
Retrieve recently played songs<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# [''array[ [[#Audio.Details.Song|Audio.Details.Song]] ]'' songs]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve recently played songs",
"params": [
{
"$ref": "Audio.Fields.Song",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"songs": {
"items": {
"$ref": "Audio.Details.Song"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetRoles ====
Retrieve all contributor roles<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Audio.Fields.Role|Audio.Fields.Role]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# ''array[ [[#Audio.Details.Role|Audio.Details.Role]] ]'' roles<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all contributor roles",
"params": [
{
"$ref": "Audio.Fields.Role",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"roles": {
"items": {
"$ref": "Audio.Details.Role"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetSongDetails ====
Retrieve details about a specific song<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' songid<br />
# [''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#Audio.Details.Song|Audio.Details.Song]]'' songdetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific song",
"params": [
{
"$ref": "Library.Id",
"name": "songid",
"required": true
},
{
"$ref": "Audio.Fields.Song",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"songdetails": {
"$ref": "Audio.Details.Song"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetSongs ====
Retrieve all songs from specified album, artist or genre<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
# [''mixed: object|object|object|object|object|object|object|object|object|object|[[#List.Filter.Songs|List.Filter.Songs]]'' filter]<br />
# [''boolean'' includesingles = True] (Only songs from albums are returned when false, but overridden when singlesonly parameter is true)<br />
# [''boolean'' allroles = False] (Whether or not to include all roles when filtering by artist, rather than default of excluding other contributors. When true it overrides any role filter value.)<br />
# [''boolean'' singlesonly = False] (Only singles are returned when true, and overrides includesingles parameter)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# [''array[ [[#Audio.Details.Song|Audio.Details.Song]] ]'' songs]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all songs from specified album, artist or genre",
"params": [
{
"$ref": "Audio.Fields.Song",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Song genre. Filter for existence of songs with this genre",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"description": "Song genre. Filter for existence of songs with this genre",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"role": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
},
"role": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"albumid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"album": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Songs"
}
]
},
{
"default": true,
"description": "Only songs from albums are returned when false, but overridden when singlesonly parameter is true",
"name": "includesingles",
"type": "boolean"
},
{
"default": false,
"description": "Whether or not to include all roles when filtering by artist, rather than default of excluding other contributors. When true it overrides any role filter value.",
"name": "allroles",
"type": "boolean"
},
{
"default": false,
"description": "Only singles are returned when true, and overrides includesingles parameter",
"name": "singlesonly",
"type": "boolean"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"songs": {
"items": {
"$ref": "Audio.Details.Song"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetSources ====
Get all music sources, including unique ID<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Library.Fields.Source|Library.Fields.Source]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# ''array[ [[#Library.Details.Source|Library.Details.Source]] ]'' sources<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get all music sources, including unique ID",
"params": [
{
"$ref": "Library.Fields.Source",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"sources": {
"items": {
"$ref": "Library.Details.Source"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.Scan ====
Scans the audio sources for new library items<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''string'' directory = ""]<br />
# [''boolean'' showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Scans the audio sources for new library items",
"params": [
{
"default": "",
"name": "directory",
"type": "string"
},
{
"default": true,
"description": "Whether or not to show the progress bar or any other GUI dialog",
"name": "showdialogs",
"type": "boolean"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.SetAlbumDetails ====
Update the given album with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' albumid<br />
# [''[[#Optional.String|Optional.String]]'' title = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' artist = None]<br />
# [''[[#Optional.String|Optional.String]]'' description = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' genre = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' theme = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' mood = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' style = None]<br />
# [''[[#Optional.String|Optional.String]]'' type = None]<br />
# [''[[#Optional.String|Optional.String]]'' albumlabel = None]<br />
# [''[[#Optional.Number|Optional.Number]]'' rating = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' year = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' votes = None]<br />
# [''[[#Optional.String|Optional.String]]'' musicbrainzalbumid = None]<br />
# [''[[#Optional.String|Optional.String]]'' musicbrainzreleasegroupid = None]<br />
# [''[[#Optional.String|Optional.String]]'' sortartist = None]<br />
# [''[[#Optional.String|Optional.String]]'' displayartist = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' musicbrainzalbumartistid = None]<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
# [''[[#Optional.Boolean|Optional.Boolean]]'' isboxset = None]<br />
# [''[[#Optional.String|Optional.String]]'' releasedate = None]<br />
# [''[[#Optional.String|Optional.String]]'' originaldate = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given album with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "albumid",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"name": "title"
},
{
"default": null,
"name": "artist",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "description"
},
{
"default": null,
"name": "genre",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "theme",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "mood",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "style",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "type"
},
{
"$ref": "Optional.String",
"default": null,
"name": "albumlabel"
},
{
"$ref": "Optional.Number",
"default": null,
"name": "rating"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "year"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "userrating"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "votes"
},
{
"$ref": "Optional.String",
"default": null,
"name": "musicbrainzalbumid"
},
{
"$ref": "Optional.String",
"default": null,
"name": "musicbrainzreleasegroupid"
},
{
"$ref": "Optional.String",
"default": null,
"name": "sortartist"
},
{
"$ref": "Optional.String",
"default": null,
"name": "displayartist"
},
{
"default": null,
"name": "musicbrainzalbumartistid",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
},
{
"$ref": "Optional.Boolean",
"default": null,
"name": "isboxset"
},
{
"$ref": "Optional.String",
"default": null,
"name": "releasedate"
},
{
"$ref": "Optional.String",
"default": null,
"name": "originaldate"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.SetArtistDetails ====
Update the given artist with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' artistid<br />
# [''[[#Optional.String|Optional.String]]'' artist = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' instrument = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' style = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' mood = None]<br />
# [''[[#Optional.String|Optional.String]]'' born = None]<br />
# [''[[#Optional.String|Optional.String]]'' formed = None]<br />
# [''[[#Optional.String|Optional.String]]'' description = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' genre = None]<br />
# [''[[#Optional.String|Optional.String]]'' died = None]<br />
# [''[[#Optional.String|Optional.String]]'' disbanded = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' yearsactive = None]<br />
# [''[[#Optional.String|Optional.String]]'' musicbrainzartistid = None]<br />
# [''[[#Optional.String|Optional.String]]'' sortname = None]<br />
# [''[[#Optional.String|Optional.String]]'' type = None]<br />
# [''[[#Optional.String|Optional.String]]'' gender = None]<br />
# [''[[#Optional.String|Optional.String]]'' disambiguation = None]<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given artist with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "artistid",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"name": "artist"
},
{
"default": null,
"name": "instrument",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "style",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "mood",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "born"
},
{
"$ref": "Optional.String",
"default": null,
"name": "formed"
},
{
"$ref": "Optional.String",
"default": null,
"name": "description"
},
{
"default": null,
"name": "genre",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "died"
},
{
"$ref": "Optional.String",
"default": null,
"name": "disbanded"
},
{
"default": null,
"name": "yearsactive",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "musicbrainzartistid"
},
{
"$ref": "Optional.String",
"default": null,
"name": "sortname"
},
{
"$ref": "Optional.String",
"default": null,
"name": "type"
},
{
"$ref": "Optional.String",
"default": null,
"name": "gender"
},
{
"$ref": "Optional.String",
"default": null,
"name": "disambiguation"
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.SetSongDetails ====
Update the given song with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' songid<br />
# [''[[#Optional.String|Optional.String]]'' title = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' artist = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' genre = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' year = None]<br />
# [''[[#Optional.Number|Optional.Number]]'' rating = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' track = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' disc = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' duration = None]<br />
# [''[[#Optional.String|Optional.String]]'' comment = None]<br />
# [''[[#Optional.String|Optional.String]]'' musicbrainztrackid = None]<br />
# [''[[#Optional.String|Optional.String]]'' musicbrainzartistid = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' playcount = None]<br />
# [''[[#Optional.String|Optional.String]]'' lastplayed = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' votes = None]<br />
# [''[[#Optional.String|Optional.String]]'' displayartist = None]<br />
# [''[[#Optional.String|Optional.String]]'' sortartist = None]<br />
# [''[[#Optional.String|Optional.String]]'' mood = None]<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
# [''[[#Optional.String|Optional.String]]'' disctitle = None]<br />
# [''[[#Optional.String|Optional.String]]'' releasedate = None]<br />
# [''[[#Optional.String|Optional.String]]'' originaldate = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' bpm = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given song with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "songid",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"name": "title"
},
{
"default": null,
"name": "artist",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "genre",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "year"
},
{
"$ref": "Optional.Number",
"default": null,
"name": "rating"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "track"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "disc"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "duration"
},
{
"$ref": "Optional.String",
"default": null,
"name": "comment"
},
{
"$ref": "Optional.String",
"default": null,
"name": "musicbrainztrackid"
},
{
"$ref": "Optional.String",
"default": null,
"name": "musicbrainzartistid"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "playcount"
},
{
"$ref": "Optional.String",
"default": null,
"name": "lastplayed"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "userrating"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "votes"
},
{
"$ref": "Optional.String",
"default": null,
"name": "displayartist"
},
{
"$ref": "Optional.String",
"default": null,
"name": "sortartist"
},
{
"$ref": "Optional.String",
"default": null,
"name": "mood"
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "disctitle"
},
{
"$ref": "Optional.String",
"default": null,
"name": "releasedate"
},
{
"$ref": "Optional.String",
"default": null,
"name": "originaldate"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "bpm"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== Favourites ===
==== Favourites.AddFavourite ====
Add a favourite with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' title<br />
# ''[[#Favourite.Type|Favourite.Type]]'' type<br />
# [''[[#Optional.String|Optional.String]]'' path = None] (Required for media, script and androidapp favourites types)<br />
# [''[[#Optional.String|Optional.String]]'' window = None] (Required for window favourite type)<br />
# [''[[#Optional.String|Optional.String]]'' windowparameter = None]<br />
# [''[[#Optional.String|Optional.String]]'' thumbnail = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Add a favourite with the given details",
"params": [
{
"name": "title",
"required": true,
"type": "string"
},
{
"$ref": "Favourite.Type",
"name": "type",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"description": "Required for media, script and androidapp favourites types",
"name": "path"
},
{
"$ref": "Optional.String",
"default": null,
"description": "Required for window favourite type",
"name": "window"
},
{
"$ref": "Optional.String",
"default": null,
"name": "windowparameter"
},
{
"$ref": "Optional.String",
"default": null,
"name": "thumbnail"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Favourites.GetFavourites ====
Retrieve all favourites<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''mixed: null|[[#Favourite.Type|Favourite.Type]]'' type = None]<br />
# [''[[#Favourite.Fields.Favourite|Favourite.Fields.Favourite]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''array[ [[#Favourite.Details.Favourite|Favourite.Details.Favourite]] ]'' favourites]<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all favourites",
"params": [
{
"default": null,
"name": "type",
"type": [
{
"type": "null"
},
{
"$ref": "Favourite.Type"
}
]
},
{
"$ref": "Favourite.Fields.Favourite",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"favourites": {
"items": {
"$ref": "Favourite.Details.Favourite"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
=== Files ===
==== Files.Download ====
Downloads the given file<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' path<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''any''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Downloads the given file",
"params": [
{
"name": "path",
"required": true,
"type": "string"
}
],
"permission": "ReadData",
"returns": {
"type": "any"
},
"type": "method"
}
</syntaxhighlight>}}
==== Files.GetDirectory ====
Get the directories and files in the given directory<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' directory<br />
# [''[[#Files.Media|Files.Media]]'' media = files]<br />
# [''[[#List.Fields.Files|List.Fields.Files]]'' properties]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
# [''[[#List.Limits|List.Limits]]'' limits] (Limits are applied after getting the directory content thus retrieval is not faster when they are applied.)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''array[ [[#List.Item.File|List.Item.File]] ]'' files<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get the directories and files in the given directory",
"params": [
{
"name": "directory",
"required": true,
"type": "string"
},
{
"$ref": "Files.Media",
"default": "files",
"name": "media"
},
{
"$ref": "List.Fields.Files",
"name": "properties"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"$ref": "List.Limits",
"description": "Limits are applied after getting the directory content thus retrieval is not faster when they are applied.",
"name": "limits"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"files": {
"items": {
"$ref": "List.Item.File"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Files.GetFileDetails ====
Get details for a specific file<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' file (Full path to the file)<br />
# [''[[#Files.Media|Files.Media]]'' media = files]<br />
# [''[[#List.Fields.Files|List.Fields.Files]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.Item.File|List.Item.File]]'' filedetails<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get details for a specific file",
"params": [
{
"description": "Full path to the file",
"name": "file",
"required": true,
"type": "string"
},
{
"$ref": "Files.Media",
"default": "files",
"name": "media"
},
{
"$ref": "List.Fields.Files",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"filedetails": {
"$ref": "List.Item.File",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Files.GetSources ====
Get the sources of the media windows<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Files.Media|Files.Media]]'' media<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# ''[[#List.Items.Sources|List.Items.Sources]]'' sources<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get the sources of the media windows",
"params": [
{
"$ref": "Files.Media",
"name": "media",
"required": true
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"sources": {
"$ref": "List.Items.Sources",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Files.PrepareDownload ====
Provides a way to download a given file (e.g. providing an URL to the real file location)<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' path<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''any'' details (Transport specific details on how/from where to download the given file)<br />
# ''string'' mode (Direct mode allows using Files.Download whereas redirect mode requires the usage of a different protocol)<br />
# ''string'' protocol<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Provides a way to download a given file (e.g. providing an URL to the real file location)",
"params": [
{
"name": "path",
"required": true,
"type": "string"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"details": {
"description": "Transport specific details on how/from where to download the given file",
"required": true,
"type": "any"
},
"mode": {
"description": "Direct mode allows using Files.Download whereas redirect mode requires the usage of a different protocol",
"enums": [
"redirect",
"direct"
],
"required": true,
"type": "string"
},
"protocol": {
"enums": [
"http"
],
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Files.SetFileDetails ====
Update the given specific file with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' file (Full path to the file)<br />
# ''[[#Files.Media|Files.Media]]'' media (File type to update correct database. Currently only "video" is supported.)<br />
# [''[[#Optional.Integer|Optional.Integer]]'' playcount = None]<br />
# [''[[#Optional.String|Optional.String]]'' lastplayed = None] (Setting a valid lastplayed without a playcount will force playcount to 1.)<br />
# [''mixed: null|[[#Video.Resume|Video.Resume]]'' resume = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given specific file with the given details",
"params": [
{
"description": "Full path to the file",
"name": "file",
"required": true,
"type": "string"
},
{
"$ref": "Files.Media",
"description": "File type to update correct database. Currently only \"video\" is supported.",
"name": "media",
"required": true
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "playcount"
},
{
"$ref": "Optional.String",
"default": null,
"description": "Setting a valid lastplayed without a playcount will force playcount to 1.",
"name": "lastplayed"
},
{
"default": null,
"name": "resume",
"type": [
{
"type": "null"
},
{
"$ref": "Video.Resume"
}
]
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== GUI ===
==== GUI.ActivateWindow ====
Activates the given window<br />
'''Permissions:'''
* ControlGUI
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#GUI.Window|GUI.Window]]'' window<br />
# [''array[string]'' parameters]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Activates the given window",
"params": [
{
"$ref": "GUI.Window",
"name": "window",
"required": true
},
{
"items": {
"minLength": 1,
"type": "string"
},
"minItems": 1,
"name": "parameters",
"type": "array"
}
],
"permission": "ControlGUI",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== GUI.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''array[ [[#GUI.Property.Name|GUI.Property.Name]] ]'' properties<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#GUI.Property.Value|GUI.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the values of the given properties",
"params": [
{
"items": {
"$ref": "GUI.Property.Name"
},
"name": "properties",
"required": true,
"type": "array",
"uniqueItems": true
}
],
"permission": "ReadData",
"returns": {
"$ref": "GUI.Property.Value"
},
"type": "method"
}
</syntaxhighlight>}}
==== GUI.GetStereoscopicModes ====
Returns the supported stereoscopic modes of the GUI<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''array[ [[#GUI.Stereoscopy.Mode|GUI.Stereoscopy.Mode]] ]'' stereoscopicmodes]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Returns the supported stereoscopic modes of the GUI",
"params": [],
"permission": "ReadData",
"returns": {
"properties": {
"stereoscopicmodes": {
"items": {
"$ref": "GUI.Stereoscopy.Mode"
},
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== GUI.SetFullscreen ====
Toggle fullscreen/GUI<br />
'''Permissions:'''
* ControlGUI
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Global.Toggle|Global.Toggle]]'' fullscreen<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''boolean (Fullscreen state)''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Toggle fullscreen/GUI",
"params": [
{
"$ref": "Global.Toggle",
"name": "fullscreen",
"required": true
}
],
"permission": "ControlGUI",
"returns": {
"description": "Fullscreen state",
"type": "boolean"
},
"type": "method"
}
</syntaxhighlight>}}
==== GUI.SetStereoscopicMode ====
Sets the stereoscopic mode of the GUI to the given mode<br />
'''Permissions:'''
* ControlGUI
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' mode<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Sets the stereoscopic mode of the GUI to the given mode",
"params": [
{
"enums": [
"toggle",
"tomono",
"next",
"previous",
"select",
"off",
"split_vertical",
"split_horizontal",
"row_interleaved",
"hardware_based",
"anaglyph_cyan_red",
"anaglyph_green_magenta",
"monoscopic"
],
"name": "mode",
"required": true,
"type": "string"
}
],
"permission": "ControlGUI",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== GUI.ShowNotification ====
Shows a GUI notification<br />
'''Permissions:'''
* ControlGUI
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' title<br />
# ''string'' message<br />
# [''mixed: string|string'' image = ""]<br />
# [''integer'' displaytime = 5000] (The time in milliseconds the notification will be visible)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Shows a GUI notification",
"params": [
{
"name": "title",
"required": true,
"type": "string"
},
{
"name": "message",
"required": true,
"type": "string"
},
{
"default": "",
"name": "image",
"type": [
{
"enums": [
"info",
"warning",
"error"
],
"type": "string"
},
{
"type": "string"
}
]
},
{
"default": 5000,
"description": "The time in milliseconds the notification will be visible",
"minimum": 1500,
"name": "displaytime",
"type": "integer"
}
],
"permission": "ControlGUI",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== Input ===
==== Input.Back ====
Goes back in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Goes back in GUI",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.ButtonEvent ====
Send a button press event<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' button (Button name)<br />
# ''string'' keymap (Keymap name (KB, XG, R1, or R2))<br />
# [''integer'' holdtime = 0] (Number of milliseconds to simulate button hold.)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Send a button press event",
"params": [
{
"description": "Button name",
"name": "button",
"required": true,
"type": "string"
},
{
"description": "Keymap name (KB, XG, R1, or R2)",
"enums": [
"KB",
"XG",
"R1",
"R2"
],
"name": "keymap",
"required": true,
"type": "string"
},
{
"default": 0,
"description": "Number of milliseconds to simulate button hold.",
"minimum": 0,
"name": "holdtime",
"type": "integer"
}
],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.ContextMenu ====
Shows the context menu<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Shows the context menu",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.Down ====
Navigate down in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Navigate down in GUI",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.ExecuteAction ====
Execute a specific action<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Input.Action|Input.Action]]'' action<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Execute a specific action",
"params": [
{
"$ref": "Input.Action",
"name": "action",
"required": true
}
],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.Home ====
Goes to home window in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Goes to home window in GUI",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.Info ====
Shows the information dialog<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Shows the information dialog",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.Left ====
Navigate left in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Navigate left in GUI",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.Right ====
Navigate right in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Navigate right in GUI",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.Select ====
Select current item in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Select current item in GUI",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.SendText ====
Send a generic (unicode) text<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' text (Unicode text)<br />
# [''boolean'' done = True] (Whether this is the whole input or not (closes an open input dialog if true).)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Send a generic (unicode) text",
"params": [
{
"description": "Unicode text",
"name": "text",
"required": true,
"type": "string"
},
{
"default": true,
"description": "Whether this is the whole input or not (closes an open input dialog if true).",
"name": "done",
"type": "boolean"
}
],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.ShowCodec ====
Show codec information of the playing item<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Show codec information of the playing item",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.ShowOSD ====
Show the on-screen display for the current player<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Show the on-screen display for the current player",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.ShowPlayerProcessInfo ====
Show player process information of the playing item, like video decoder, pixel format, pvr signal strength, ...<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Show player process information of the playing item, like video decoder, pixel format, pvr signal strength, ...",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.Up ====
Navigate up in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Navigate up in GUI",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== JSONRPC ===
==== JSONRPC.GetConfiguration ====
Get client-specific configurations<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Configuration|Configuration]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get client-specific configurations",
"params": [],
"permission": "ReadData",
"returns": {
"$ref": "Configuration"
},
"type": "method"
}
</syntaxhighlight>}}
==== JSONRPC.Introspect ====
Enumerates all actions and descriptions<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''boolean'' getdescriptions = True]<br />
# [''boolean'' getmetadata = False]<br />
# [''boolean'' filterbytransport = True]<br />
# [''object'' filter]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Enumerates all actions and descriptions",
"params": [
{
"default": true,
"name": "getdescriptions",
"type": "boolean"
},
{
"default": false,
"name": "getmetadata",
"type": "boolean"
},
{
"default": true,
"name": "filterbytransport",
"type": "boolean"
},
{
"name": "filter",
"properties": {
"getreferences": {
"default": true,
"description": "Whether or not to print the schema for referenced types",
"type": "boolean"
},
"id": {
"description": "Name of a namespace, method or type",
"required": true,
"type": "string"
},
"type": {
"description": "Type of the given name",
"enums": [
"method",
"namespace",
"type",
"notification"
],
"required": true,
"type": "string"
}
},
"type": "object"
}
],
"permission": "ReadData",
"returns": {
"additionalProperties": false,
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== JSONRPC.NotifyAll ====
Notify all other connected clients<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender<br />
# ''string'' message<br />
# [''any'' data = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''any''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Notify all other connected clients",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "message",
"required": true,
"type": "string"
},
{
"default": null,
"name": "data",
"type": "any"
}
],
"permission": "ReadData",
"returns": {
"type": "any"
},
"type": "method"
}
</syntaxhighlight>}}
==== JSONRPC.Permission ====
Retrieve the clients permissions<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''boolean'' controlgui<br />
# ''boolean'' controlnotify<br />
# ''boolean'' controlplayback<br />
# ''boolean'' controlpower<br />
# ''boolean'' controlpvr<br />
# ''boolean'' controlsystem<br />
# ''boolean'' executeaddon<br />
# ''boolean'' manageaddon<br />
# ''boolean'' navigate<br />
# ''boolean'' readdata<br />
# ''boolean'' removedata<br />
# ''boolean'' updatedata<br />
# ''boolean'' writefile<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve the clients permissions",
"params": [],
"permission": "ReadData",
"returns": {
"properties": {
"controlgui": {
"required": true,
"type": "boolean"
},
"controlnotify": {
"required": true,
"type": "boolean"
},
"controlplayback": {
"required": true,
"type": "boolean"
},
"controlpower": {
"required": true,
"type": "boolean"
},
"controlpvr": {
"required": true,
"type": "boolean"
},
"controlsystem": {
"required": true,
"type": "boolean"
},
"executeaddon": {
"required": true,
"type": "boolean"
},
"manageaddon": {
"required": true,
"type": "boolean"
},
"navigate": {
"required": true,
"type": "boolean"
},
"readdata": {
"required": true,
"type": "boolean"
},
"removedata": {
"required": true,
"type": "boolean"
},
"updatedata": {
"required": true,
"type": "boolean"
},
"writefile": {
"required": true,
"type": "boolean"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== JSONRPC.Ping ====
Ping responder<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Ping responder",
"params": [],
"permission": "ReadData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== JSONRPC.SetConfiguration ====
Change the client-specific configuration<br />
'''Permissions:'''
* ControlNotify
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''object'' notifications]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Configuration|Configuration]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Change the client-specific configuration",
"params": [
{
"name": "notifications",
"properties": {
"application": {
"$ref": "Optional.Boolean",
"default": null
},
"audiolibrary": {
"$ref": "Optional.Boolean",
"default": null
},
"gui": {
"$ref": "Optional.Boolean",
"default": null
},
"input": {
"$ref": "Optional.Boolean",
"default": null
},
"other": {
"$ref": "Optional.Boolean",
"default": null
},
"player": {
"$ref": "Optional.Boolean",
"default": null
},
"playlist": {
"$ref": "Optional.Boolean",
"default": null
},
"system": {
"$ref": "Optional.Boolean",
"default": null
},
"videolibrary": {
"$ref": "Optional.Boolean",
"default": null
}
},
"type": "object"
}
],
"permission": "ControlNotify",
"returns": {
"$ref": "Configuration"
},
"type": "method"
}
</syntaxhighlight>}}
==== JSONRPC.Version ====
Retrieve the JSON-RPC protocol version.<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''object'' version<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve the JSON-RPC protocol version.",
"params": [],
"permission": "ReadData",
"returns": {
"properties": {
"version": {
"properties": {
"major": {
"description": "Bumped on backwards incompatible changes to the API definition",
"minimum": 0,
"required": true,
"type": "integer"
},
"minor": {
"description": "Bumped on backwards compatible additions/changes to the API definition",
"minimum": 0,
"required": true,
"type": "integer"
},
"patch": {
"description": "Bumped on any changes to the internal implementation but not to the API definition",
"minimum": 0,
"required": true,
"type": "integer"
}
},
"required": true,
"type": "object"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
=== PVR ===
==== PVR.AddTimer ====
Adds a timer to record the given show one times or a timer rule to record all showings of the given show or adds a reminder timer or reminder timer rule<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' broadcastid (the broadcast id of the item to record)<br />
# [''boolean'' timerrule = False] (controls whether to create a timer rule or a onetime timer)<br />
# [''boolean'' reminder = False] (controls whether to create a reminder timer or a recording timer)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Adds a timer to record the given show one times or a timer rule to record all showings of the given show or adds a reminder timer or reminder timer rule",
"params": [
{
"$ref": "Library.Id",
"description": "the broadcast id of the item to record",
"name": "broadcastid",
"required": true
},
{
"default": false,
"description": "controls whether to create a timer rule or a onetime timer",
"name": "timerrule",
"type": "boolean"
},
{
"default": false,
"description": "controls whether to create a reminder timer or a recording timer",
"name": "reminder",
"type": "boolean"
}
],
"permission": "ControlPVR",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.DeleteTimer ====
Deletes a onetime timer or a timer rule<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' timerid (the id of the onetime timer or timer rule to delete)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Deletes a onetime timer or a timer rule",
"params": [
{
"$ref": "Library.Id",
"description": "the id of the onetime timer or timer rule to delete",
"name": "timerid",
"required": true
}
],
"permission": "ControlPVR",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetBroadcastDetails ====
Retrieves the details of a specific broadcast<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' broadcastid<br />
# [''[[#PVR.Fields.Broadcast|PVR.Fields.Broadcast]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#PVR.Details.Broadcast|PVR.Details.Broadcast]]'' broadcastdetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the details of a specific broadcast",
"params": [
{
"$ref": "Library.Id",
"name": "broadcastid",
"required": true
},
{
"$ref": "PVR.Fields.Broadcast",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"broadcastdetails": {
"$ref": "PVR.Details.Broadcast"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetBroadcastIsPlayable ====
Retrieves whether or not a broadcast is playable<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' broadcastid (the id of the broadcast to to check for playability)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''boolean''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves whether or not a broadcast is playable",
"params": [
{
"$ref": "Library.Id",
"description": "the id of the broadcast to to check for playability",
"name": "broadcastid",
"required": true
}
],
"permission": "ReadData",
"returns": {
"type": "boolean"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetBroadcasts ====
Retrieves the program of a specific channel<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' channelid<br />
# [''[[#PVR.Fields.Broadcast|PVR.Fields.Broadcast]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''array[ [[#PVR.Details.Broadcast|PVR.Details.Broadcast]] ]'' broadcasts<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the program of a specific channel",
"params": [
{
"$ref": "Library.Id",
"name": "channelid",
"required": true
},
{
"$ref": "PVR.Fields.Broadcast",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"broadcasts": {
"items": {
"$ref": "PVR.Details.Broadcast"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetChannelDetails ====
Retrieves the details of a specific channel<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' channelid<br />
# [''[[#PVR.Fields.Channel|PVR.Fields.Channel]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#PVR.Details.Channel|PVR.Details.Channel]]'' channeldetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the details of a specific channel",
"params": [
{
"$ref": "Library.Id",
"name": "channelid",
"required": true
},
{
"$ref": "PVR.Fields.Channel",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"channeldetails": {
"$ref": "PVR.Details.Channel"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetChannelGroupDetails ====
Retrieves the details of a specific channel group<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#PVR.ChannelGroup.Id|PVR.ChannelGroup.Id]]'' channelgroupid<br />
# [''object'' channels]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#PVR.Details.ChannelGroup.Extended|PVR.Details.ChannelGroup.Extended]]'' channelgroupdetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the details of a specific channel group",
"params": [
{
"$ref": "PVR.ChannelGroup.Id",
"name": "channelgroupid",
"required": true
},
{
"name": "channels",
"properties": {
"limits": {
"$ref": "List.Limits"
},
"properties": {
"$ref": "PVR.Fields.Channel"
}
},
"type": "object"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"channelgroupdetails": {
"$ref": "PVR.Details.ChannelGroup.Extended"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetChannelGroups ====
Retrieves the channel groups for the specified type<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''array[ [[#PVR.Details.ChannelGroup|PVR.Details.ChannelGroup]] ]'' channelgroups<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the channel groups for the specified type",
"params": [
{
"$ref": "PVR.Channel.Type",
"name": "channeltype",
"required": true
},
{
"$ref": "List.Limits",
"name": "limits"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"channelgroups": {
"items": {
"$ref": "PVR.Details.ChannelGroup"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetChannels ====
Retrieves the channel list<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#PVR.ChannelGroup.Id|PVR.ChannelGroup.Id]]'' channelgroupid<br />
# [''[[#PVR.Fields.Channel|PVR.Fields.Channel]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''array[ [[#PVR.Details.Channel|PVR.Details.Channel]] ]'' channels<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the channel list",
"params": [
{
"$ref": "PVR.ChannelGroup.Id",
"name": "channelgroupid",
"required": true
},
{
"$ref": "PVR.Fields.Channel",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"channels": {
"items": {
"$ref": "PVR.Details.Channel"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetClients ====
Retrieves the enabled PVR clients and their capabilities<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#List.Limits|List.Limits]]'' limits]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''array[ [[#PVR.Details.Client|PVR.Details.Client]] ]'' clients<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the enabled PVR clients and their capabilities",
"params": [
{
"$ref": "List.Limits",
"name": "limits"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"clients": {
"items": {
"$ref": "PVR.Details.Client"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''array[ [[#PVR.Property.Name|PVR.Property.Name]] ]'' properties<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#PVR.Property.Value|PVR.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the values of the given properties",
"params": [
{
"items": {
"$ref": "PVR.Property.Name"
},
"name": "properties",
"required": true,
"type": "array",
"uniqueItems": true
}
],
"permission": "ReadData",
"returns": {
"$ref": "PVR.Property.Value"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetRecordingDetails ====
Retrieves the details of a specific recording<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' recordingid<br />
# [''[[#PVR.Fields.Recording|PVR.Fields.Recording]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#PVR.Details.Recording|PVR.Details.Recording]]'' recordingdetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the details of a specific recording",
"params": [
{
"$ref": "Library.Id",
"name": "recordingid",
"required": true
},
{
"$ref": "PVR.Fields.Recording",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"recordingdetails": {
"$ref": "PVR.Details.Recording"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetRecordings ====
Retrieves the recordings<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#PVR.Fields.Recording|PVR.Fields.Recording]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# ''array[ [[#PVR.Details.Recording|PVR.Details.Recording]] ]'' recordings<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the recordings",
"params": [
{
"$ref": "PVR.Fields.Recording",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"recordings": {
"items": {
"$ref": "PVR.Details.Recording"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetTimerDetails ====
Retrieves the details of a specific timer<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' timerid<br />
# [''[[#PVR.Fields.Timer|PVR.Fields.Timer]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#PVR.Details.Timer|PVR.Details.Timer]]'' timerdetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the details of a specific timer",
"params": [
{
"$ref": "Library.Id",
"name": "timerid",
"required": true
},
{
"$ref": "PVR.Fields.Timer",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"timerdetails": {
"$ref": "PVR.Details.Timer"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetTimers ====
Retrieves the timers<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#PVR.Fields.Timer|PVR.Fields.Timer]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# ''array[ [[#PVR.Details.Timer|PVR.Details.Timer]] ]'' timers<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the timers",
"params": [
{
"$ref": "PVR.Fields.Timer",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"timers": {
"items": {
"$ref": "PVR.Details.Timer"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.Record ====
Toggle recording of a channel<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Global.Toggle|Global.Toggle]]'' record = toggle]<br />
# [''mixed: string|[[#Library.Id|Library.Id]]'' channel = current]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Toggle recording of a channel",
"params": [
{
"$ref": "Global.Toggle",
"default": "toggle",
"name": "record"
},
{
"default": "current",
"name": "channel",
"type": [
{
"enums": [
"current"
],
"type": "string"
},
{
"$ref": "Library.Id"
}
]
}
],
"permission": "ControlPVR",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.Scan ====
Starts a channel scan<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Library.Id|Library.Id]]'' clientid = -1] (Specify a PVR client id to avoid UI dialog, optional in kodi 19, required in kodi 20)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Starts a channel scan",
"params": [
{
"$ref": "Library.Id",
"default": -1,
"description": "Specify a PVR client id to avoid UI dialog, optional in kodi 19, required in kodi 20",
"name": "clientid"
}
],
"permission": "ControlPVR",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.ToggleTimer ====
Creates or deletes a onetime timer or timer rule for a given show. If it exists, it will be deleted. If it does not exist, it will be created<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' broadcastid (the broadcast id of the item to toggle a onetime timer or time rule for)<br />
# [''boolean'' timerrule = False] (controls whether to create / delete a timer rule or a onetime timer)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Creates or deletes a onetime timer or timer rule for a given show. If it exists, it will be deleted. If it does not exist, it will be created",
"params": [
{
"$ref": "Library.Id",
"description": "the broadcast id of the item to toggle a onetime timer or time rule for",
"name": "broadcastid",
"required": true
},
{
"default": false,
"description": "controls whether to create / delete a timer rule or a onetime timer",
"name": "timerrule",
"type": "boolean"
}
],
"permission": "ControlPVR",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== Player ===
==== Player.AddSubtitle ====
Add subtitle to the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# ''string'' subtitle (Local path or remote URL to the subtitle file to load)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Add subtitle to the player",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"description": "Local path or remote URL to the subtitle file to load",
"name": "subtitle",
"required": true,
"type": "string"
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.GetAudioDelay ====
Get the audio delay for the current playback<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[number]]'' offset] The offset value used in the current playback.<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Returns the offset value used in the current playback",
"params": [],
"permission": "ReadData",
"returns": {
"properties": {
"offset": {
"description": "The offset value used in the current playback.",
"required": true,
"type": "number"
}
},
"type": "object",
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.GetActivePlayers ====
Returns all active players<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''array''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Returns all active players",
"params": [],
"permission": "ReadData",
"returns": {
"items": {
"properties": {
"playerid": {
"$ref": "Player.Id",
"required": true
},
"playertype": {
"enums": [
"internal",
"external",
"remote"
],
"required": true,
"type": "string"
},
"type": {
"$ref": "Player.Type",
"required": true
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.GetItem ====
Retrieves the currently played item<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# [''[[#List.Fields.All|List.Fields.All]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.Item.All|List.Item.All]]'' item<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the currently played item",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"$ref": "List.Fields.All",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"item": {
"$ref": "List.Item.All",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.GetPlayers ====
Get a list of available players<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''string'' media = all]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''array''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get a list of available players",
"params": [
{
"default": "all",
"enums": [
"all",
"video",
"audio"
],
"name": "media",
"type": "string"
}
],
"permission": "ReadData",
"returns": {
"items": {
"properties": {
"name": {
"$ref": "Global.String.NotEmpty",
"required": true
},
"playsaudio": {
"required": true,
"type": "boolean"
},
"playsvideo": {
"required": true,
"type": "boolean"
},
"type": {
"enums": [
"internal",
"external",
"remote"
],
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# ''array[ [[#Player.Property.Name|Player.Property.Name]] ]'' properties<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Player.Property.Value|Player.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the values of the given properties",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"items": {
"$ref": "Player.Property.Name"
},
"name": "properties",
"required": true,
"type": "array",
"uniqueItems": true
}
],
"permission": "ReadData",
"returns": {
"$ref": "Player.Property.Value"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.GetViewMode ====
Get view mode of video player<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''boolean'' nonlinearstretch<br />
# ''number'' pixelratio<br />
# ''number'' verticalshift<br />
# ''[[#Player.ViewMode|Player.ViewMode]]'' viewmode<br />
# ''number'' zoom<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get view mode of video player",
"params": [],
"permission": "ReadData",
"returns": {
"properties": {
"nonlinearstretch": {
"required": true,
"type": "boolean"
},
"pixelratio": {
"required": true,
"type": "number"
},
"verticalshift": {
"required": true,
"type": "number"
},
"viewmode": {
"$ref": "Player.ViewMode",
"required": true
},
"zoom": {
"required": true,
"type": "number"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.GoTo ====
Go to previous/next/specific item in the playlist<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# ''mixed: string|[[#Playlist.Position|Playlist.Position]]'' to<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Go to previous/next/specific item in the playlist",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "to",
"required": true,
"type": [
{
"enums": [
"previous",
"next"
],
"type": "string"
},
{
"$ref": "Playlist.Position",
"description": "position in playlist"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.Move ====
If picture is zoomed move viewport left/right/up/down otherwise skip previous/next<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# ''string'' direction<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "If picture is zoomed move viewport left/right/up/down otherwise skip previous/next",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"enums": [
"left",
"right",
"up",
"down"
],
"name": "direction",
"required": true,
"type": "string"
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.Open ====
Start playback of either the playlist with the given ID, a slideshow with the pictures from the given directory or a single file or an item from the database.<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''mixed: object|[[#Playlist.Item|Playlist.Item]]|object|object|object|object|object'' item]<br />
# [''object'' options]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Start playback of either the playlist with the given ID, a slideshow with the pictures from the given directory or a single file or an item from the database.",
"params": [
{
"name": "item",
"type": [
{
"additionalProperties": false,
"properties": {
"playlistid": {
"$ref": "Playlist.Id",
"required": true
},
"position": {
"$ref": "Playlist.Position",
"default": 0
}
},
"type": "object"
},
{
"$ref": "Playlist.Item"
},
{
"additionalProperties": false,
"properties": {
"path": {
"required": true,
"type": "string"
},
"random": {
"default": true,
"description": "Deprecated, use the shuffled property of the options parameter instead",
"type": "boolean"
},
"recursive": {
"default": true,
"type": "boolean"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"partymode": {
"default": "",
"type": [
{
"enums": [
"music",
"video"
],
"type": "string"
},
{
"description": "Path to a smartplaylist (*.xsp) file",
"minLength": 5,
"type": "string"
}
]
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"broadcastid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"channelid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"recordingid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
}
]
},
{
"additionalProperties": false,
"name": "options",
"properties": {
"playername": {
"default": null,
"type": [
{
"type": "null"
},
{
"enums": [
"default"
],
"type": "string"
},
{
"description": "name of player",
"minLength": 1,
"type": "string"
}
]
},
"repeat": {
"default": null,
"type": [
{
"type": "null"
},
{
"$ref": "Player.Repeat"
}
]
},
"resume": {
"default": false,
"type": [
{
"description": "Whether to resume from the resume point or not",
"type": "boolean"
},
{
"$ref": "Player.Position.Percentage",
"description": "Percentage value to start from"
},
{
"$ref": "Player.Position.Time",
"description": "Time to start from"
}
]
},
"shuffled": {
"$ref": "Optional.Boolean",
"default": null
}
},
"type": "object"
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.PlayPause ====
Pauses or unpause playback and returns the new state<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# [''[[#Global.Toggle|Global.Toggle]]'' play = toggle]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Player.Speed|Player.Speed]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Pauses or unpause playback and returns the new state",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"$ref": "Global.Toggle",
"default": "toggle",
"name": "play"
}
],
"permission": "ControlPlayback",
"returns": {
"$ref": "Player.Speed"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.Rotate ====
Rotates current picture<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# [''string'' value = clockwise]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Rotates current picture",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"default": "clockwise",
"enums": [
"clockwise",
"counterclockwise"
],
"name": "value",
"type": "string"
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.Seek ====
Seek through the playing item<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# ''mixed: object|object|object|object'' value<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#Player.Position.Percentage|Player.Position.Percentage]]'' percentage]<br />
# [''[[#Global.Time|Global.Time]]'' time] (A duration.)<br />
# [''[[#Global.Time|Global.Time]]'' totaltime] (A duration.)<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Seek through the playing item",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "value",
"required": true,
"type": [
{
"additionalProperties": false,
"properties": {
"percentage": {
"$ref": "Player.Position.Percentage",
"description": "Percentage value to seek to",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"time": {
"$ref": "Player.Position.Time",
"description": "Time to seek to",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"step": {
"description": "Seek by predefined jumps",
"enums": [
"smallforward",
"smallbackward",
"bigforward",
"bigbackward"
],
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"seconds": {
"description": "Seek by the given number of seconds",
"required": true,
"type": "integer"
}
},
"type": "object"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"properties": {
"percentage": {
"$ref": "Player.Position.Percentage",
"default": 0.0
},
"time": {
"$ref": "Global.Time",
"description": "A duration."
},
"totaltime": {
"$ref": "Global.Time",
"description": "A duration."
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.SetAudioDelay ====
Set the audio delay for the current playback<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# ''mixed: number|[[#Global.IncrementDecrement|Global.IncrementDecrement]]'' offset
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[number]]'' offset] The offset value used in the current playback.<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"params": [
{
"name": "playerid",
"$ref": "Player.Id",
"required": true
},
{
"name": "offset",
"type": [
{
"type": "number",
"description": "The value should be a multiple of 0.025 in a range of +/-10 (the default range can be overriden by advancedsettings.xml).",
"required": true
},
{
"$ref": "Global.IncrementDecrement",
"required": true
}
],
"required": true
}
],
"permission": "ControlPlayback",
"returns": {
"type": "object",
"properties": {
"offset": {
"type": "number",
"description": "The offset value used in the current playback.",
"required": true
}
}
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.SetAudioStream ====
Set the audio stream played by the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# ''mixed: string|integer'' stream<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Set the audio stream played by the player",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "stream",
"required": true,
"type": [
{
"enums": [
"previous",
"next"
],
"type": "string"
},
{
"description": "Index of the audio stream to play",
"minimum": 0,
"type": "integer"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.SetPartymode ====
Turn partymode on or off<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# ''[[#Global.Toggle|Global.Toggle]]'' partymode<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Turn partymode on or off",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"$ref": "Global.Toggle",
"name": "partymode",
"required": true
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.SetRepeat ====
Set the repeat mode of the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# ''mixed: [[#Player.Repeat|Player.Repeat]]|string'' repeat<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Set the repeat mode of the player",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "repeat",
"required": true,
"type": [
{
"$ref": "Player.Repeat"
},
{
"enums": [
"cycle"
],
"type": "string"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.SetShuffle ====
Shuffle/Unshuffle items in the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# ''[[#Global.Toggle|Global.Toggle]]'' shuffle<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Shuffle/Unshuffle items in the player",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"$ref": "Global.Toggle",
"name": "shuffle",
"required": true
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.SetSpeed ====
Set the speed of the current playback<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# ''mixed: integer|[[#Global.IncrementDecrement|Global.IncrementDecrement]]'' speed<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Player.Speed|Player.Speed]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Set the speed of the current playback",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "speed",
"required": true,
"type": [
{
"enums": [
-32,
-16,
-8,
-4,
-2,
-1,
0,
1,
2,
4,
8,
16,
32
],
"type": "integer"
},
{
"$ref": "Global.IncrementDecrement"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"$ref": "Player.Speed"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.SetSubtitle ====
Set the subtitle displayed by the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# ''mixed: string|integer'' subtitle<br />
# [''boolean'' enable = False] (Whether to enable subtitles to be displayed after setting the new subtitle)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Set the subtitle displayed by the player",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "subtitle",
"required": true,
"type": [
{
"enums": [
"previous",
"next",
"off",
"on"
],
"type": "string"
},
{
"description": "Index of the subtitle to display",
"minimum": 0,
"type": "integer"
}
]
},
{
"default": false,
"description": "Whether to enable subtitles to be displayed after setting the new subtitle",
"name": "enable",
"type": "boolean"
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.SetVideoStream ====
Set the video stream played by the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# ''mixed: string|integer'' stream<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Set the video stream played by the player",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "stream",
"required": true,
"type": [
{
"enums": [
"previous",
"next"
],
"type": "string"
},
{
"description": "Index of the video stream to play",
"minimum": 0,
"type": "integer"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.SetViewMode ====
Set view mode of video player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''mixed: [[#Player.CustomViewMode|Player.CustomViewMode]]|[[#Player.ViewMode|Player.ViewMode]]'' viewmode<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Set view mode of video player",
"params": [
{
"name": "viewmode",
"required": true,
"type": [
{
"$ref": "Player.CustomViewMode",
"description": "Custom view mode"
},
{
"$ref": "Player.ViewMode"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.Stop ====
Stops playback<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Stops playback",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.Zoom ====
Zoom current picture<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# ''mixed: string|integer'' zoom<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Zoom current picture",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "zoom",
"required": true,
"type": [
{
"enums": [
"in",
"out"
],
"type": "string"
},
{
"description": "zoom level",
"maximum": 10,
"minimum": 1,
"type": "integer"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== Playlist ===
==== Playlist.Add ====
Add item(s) to playlist<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid<br />
# ''mixed: [[#Playlist.Item|Playlist.Item]]|array'' item<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Add item(s) to playlist",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"name": "item",
"required": true,
"type": [
{
"$ref": "Playlist.Item"
},
{
"items": {
"$ref": "Playlist.Item"
},
"type": "array"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Playlist.Clear ====
Clear playlist<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Clear playlist",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Playlist.GetItems ====
Get all items from playlist<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid<br />
# [''[[#List.Fields.All|List.Fields.All]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''array[ [[#List.Item.All|List.Item.All]] ]'' items<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get all items from playlist",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"$ref": "List.Fields.All",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"items": {
"items": {
"$ref": "List.Item.All"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Playlist.GetPlaylists ====
Returns all existing playlists<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''array''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Returns all existing playlists",
"params": [],
"permission": "ReadData",
"returns": {
"items": {
"properties": {
"playlistid": {
"$ref": "Playlist.Id",
"required": true
},
"type": {
"$ref": "Playlist.Type",
"required": true
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"type": "method"
}
</syntaxhighlight>}}
==== Playlist.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid<br />
# ''array[ [[#Playlist.Property.Name|Playlist.Property.Name]] ]'' properties<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Playlist.Property.Value|Playlist.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the values of the given properties",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"items": {
"$ref": "Playlist.Property.Name"
},
"name": "properties",
"required": true,
"type": "array",
"uniqueItems": true
}
],
"permission": "ReadData",
"returns": {
"$ref": "Playlist.Property.Value"
},
"type": "method"
}
</syntaxhighlight>}}
==== Playlist.Insert ====
Insert item(s) into playlist. Does not work for picture playlists (aka slideshows).<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid<br />
# ''[[#Playlist.Position|Playlist.Position]]'' position<br />
# ''mixed: [[#Playlist.Item|Playlist.Item]]|array'' item<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Insert item(s) into playlist. Does not work for picture playlists (aka slideshows).",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"$ref": "Playlist.Position",
"name": "position",
"required": true
},
{
"name": "item",
"required": true,
"type": [
{
"$ref": "Playlist.Item"
},
{
"items": {
"$ref": "Playlist.Item"
},
"type": "array"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Playlist.Remove ====
Remove item from playlist. Does not work for picture playlists (aka slideshows).<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid<br />
# ''[[#Playlist.Position|Playlist.Position]]'' position<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Remove item from playlist. Does not work for picture playlists (aka slideshows).",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"$ref": "Playlist.Position",
"name": "position",
"required": true
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Playlist.Swap ====
Swap items in the playlist. Does not work for picture playlists (aka slideshows).<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid<br />
# ''[[#Playlist.Position|Playlist.Position]]'' position1<br />
# ''[[#Playlist.Position|Playlist.Position]]'' position2<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Swap items in the playlist. Does not work for picture playlists (aka slideshows).",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"$ref": "Playlist.Position",
"name": "position1",
"required": true
},
{
"$ref": "Playlist.Position",
"name": "position2",
"required": true
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== Profiles ===
==== Profiles.GetCurrentProfile ====
Retrieve the current profile<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Profiles.Fields.Profile|Profiles.Fields.Profile]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Profiles.Details.Profile|Profiles.Details.Profile]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve the current profile",
"params": [
{
"$ref": "Profiles.Fields.Profile",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"$ref": "Profiles.Details.Profile"
},
"type": "method"
}
</syntaxhighlight>}}
==== Profiles.GetProfiles ====
Retrieve all profiles<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Profiles.Fields.Profile|Profiles.Fields.Profile]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# ''array[ [[#Profiles.Details.Profile|Profiles.Details.Profile]] ]'' profiles<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all profiles",
"params": [
{
"$ref": "Profiles.Fields.Profile",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"profiles": {
"items": {
"$ref": "Profiles.Details.Profile"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Profiles.LoadProfile ====
Load the specified profile<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' profile (Profile name)<br />
# [''boolean'' prompt = False] (Prompt for password)<br />
# [''[[#Profiles.Password|Profiles.Password]]'' password]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Load the specified profile",
"params": [
{
"description": "Profile name",
"name": "profile",
"required": true,
"type": "string"
},
{
"default": false,
"description": "Prompt for password",
"name": "prompt",
"type": "boolean"
},
{
"$ref": "Profiles.Password",
"name": "password"
}
],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== Settings ===
==== Settings.GetCategories ====
Retrieves all setting categories<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Setting.Level|Setting.Level]]'' level = standard]<br />
# [''string'' section = ""]<br />
# [''string'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''array[ [[#Setting.Details.Category|Setting.Details.Category]] ]'' categories]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves all setting categories",
"params": [
{
"$ref": "Setting.Level",
"default": "standard",
"name": "level"
},
{
"default": "",
"name": "section",
"type": "string"
},
{
"extends": "Item.Fields.Base",
"items": {
"enums": [
"settings"
],
"type": "string"
},
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"categories": {
"items": {
"$ref": "Setting.Details.Category"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Settings.GetSections ====
Retrieves all setting sections<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Setting.Level|Setting.Level]]'' level = standard]<br />
# [''[[#Setting.Level|Setting.Level]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''array[ [[#Setting.Details.Section|Setting.Details.Section]] ]'' sections]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves all setting sections",
"params": [
{
"$ref": "Setting.Level",
"default": "standard",
"name": "level"
},
{
"extends": "Item.Fields.Base",
"items": {
"enums": [
"categories"
],
"type": "string"
},
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"sections": {
"items": {
"$ref": "Setting.Details.Section"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Settings.GetSettingValue ====
Retrieves the value of a setting<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' setting<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#Setting.Value.Extended|Setting.Value.Extended]]'' value<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the value of a setting",
"params": [
{
"minLength": 1,
"name": "setting",
"required": true,
"type": "string"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"value": {
"$ref": "Setting.Value.Extended",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Settings.GetSettings ====
Retrieves all settings<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Setting.Level|Setting.Level]]'' level = standard]<br />
# [''mixed: object'' filter]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''array[ [[#Setting.Details.Setting|Setting.Details.Setting]] ]'' settings]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves all settings",
"params": [
{
"$ref": "Setting.Level",
"default": "standard",
"name": "level"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"category": {
"minLength": 1,
"required": true,
"type": "string"
},
"section": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
}
]
}
],
"permission": "ReadData",
"returns": {
"properties": {
"settings": {
"items": {
"$ref": "Setting.Details.Setting"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Settings.ResetSettingValue ====
Resets the value of a setting<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' setting<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Resets the value of a setting",
"params": [
{
"minLength": 1,
"name": "setting",
"required": true,
"type": "string"
}
],
"permission": "ReadData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Settings.SetSettingValue ====
Changes the value of a setting<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' setting<br />
# ''[[#Setting.Value.Extended|Setting.Value.Extended]]'' value<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''boolean''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Changes the value of a setting",
"params": [
{
"minLength": 1,
"name": "setting",
"required": true,
"type": "string"
},
{
"$ref": "Setting.Value.Extended",
"name": "value",
"required": true
}
],
"permission": "ReadData",
"returns": {
"type": "boolean"
},
"type": "method"
}
</syntaxhighlight>}}
=== System ===
==== System.EjectOpticalDrive ====
Ejects or closes the optical disc drive (if available)<br />
'''Permissions:'''
* ControlSystem
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Ejects or closes the optical disc drive (if available)",
"params": [],
"permission": "ControlSystem",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== System.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''array[ [[#System.Property.Name|System.Property.Name]] ]'' properties<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#System.Property.Value|System.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the values of the given properties",
"params": [
{
"items": {
"$ref": "System.Property.Name"
},
"name": "properties",
"required": true,
"type": "array",
"uniqueItems": true
}
],
"permission": "ReadData",
"returns": {
"$ref": "System.Property.Value"
},
"type": "method"
}
</syntaxhighlight>}}
==== System.Hibernate ====
Puts the system running Kodi into hibernate mode<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Puts the system running Kodi into hibernate mode",
"params": [],
"permission": "ControlPower",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== System.Reboot ====
Reboots the system running Kodi<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Reboots the system running Kodi",
"params": [],
"permission": "ControlPower",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== System.Shutdown ====
Shuts the system running Kodi down<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Shuts the system running Kodi down",
"params": [],
"permission": "ControlPower",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== System.Suspend ====
Suspends the system running Kodi<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Suspends the system running Kodi",
"params": [],
"permission": "ControlPower",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== Textures ===
==== Textures.GetTextures ====
Retrieve all textures<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Textures.Fields.Texture|Textures.Fields.Texture]]'' properties]<br />
# [''[[#List.Filter.Textures|List.Filter.Textures]]'' filter]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''array[ [[#Textures.Details.Texture|Textures.Details.Texture]] ]'' textures<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all textures",
"params": [
{
"$ref": "Textures.Fields.Texture",
"name": "properties"
},
{
"$ref": "List.Filter.Textures",
"name": "filter"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"textures": {
"items": {
"$ref": "Textures.Details.Texture"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Textures.RemoveTexture ====
Remove the specified texture<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' textureid (Texture database identifier)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Remove the specified texture",
"params": [
{
"$ref": "Library.Id",
"description": "Texture database identifier",
"name": "textureid",
"required": true
}
],
"permission": "RemoveData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== VideoLibrary ===
==== VideoLibrary.Clean ====
Cleans the video library for non-existent items<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''boolean'' showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)<br />
# [''string'' content = video] (Content type to clean for)<br />
# [''string'' directory = ""] (Path to the directory to clean up; performs a global cleanup if not specified)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Cleans the video library for non-existent items",
"params": [
{
"default": true,
"description": "Whether or not to show the progress bar or any other GUI dialog",
"name": "showdialogs",
"type": "boolean"
},
{
"default": "video",
"description": "Content type to clean for",
"enums": [
"video",
"movies",
"tvshows",
"musicvideos"
],
"name": "content",
"type": "string"
},
{
"default": "",
"description": "Path to the directory to clean up; performs a global cleanup if not specified",
"name": "directory",
"type": "string"
}
],
"permission": "RemoveData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.Export ====
Exports all items from the video library<br />
'''Permissions:'''
* WriteFile
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''mixed: object|object'' options]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Exports all items from the video library",
"params": [
{
"name": "options",
"type": [
{
"additionalProperties": false,
"properties": {
"path": {
"description": "Path to the directory to where the data should be exported",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"actorthumbs": {
"default": false,
"description": "Whether to export actor thumbnails",
"type": "boolean"
},
"images": {
"default": false,
"description": "Whether to export thumbnails and fanart images",
"type": "boolean"
},
"overwrite": {
"default": false,
"description": "Whether to overwrite existing exported files",
"type": "boolean"
}
},
"type": "object"
}
]
}
],
"permission": "WriteFile",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetAvailableArt ====
Retrieve all potential art URLs for a media item by art type<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''mixed: object|object|object|object|object|object'' item<br />
# [''string'' arttype = ""]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''array'' availableart<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all potential art URLs for a media item by art type",
"params": [
{
"name": "item",
"required": true,
"type": [
{
"additionalProperties": false,
"properties": {
"episodeid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"tvshowid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"seasonid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"movieid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"setid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"musicvideoid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
}
]
},
{
"default": "",
"name": "arttype",
"type": "string"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"availableart": {
"items": {
"properties": {
"arttype": {
"required": true,
"type": "string"
},
"previewurl": {
"default": "",
"description": "URL to a preview thumbnail of the image",
"type": "string"
},
"url": {
"description": "URL to the original image",
"required": true,
"type": "string"
}
},
"type": "object"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetAvailableArtTypes ====
Retrieve a list of potential art types for a media item<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''mixed: object|object|object|object|object|object'' item<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''array'' availablearttypes<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve a list of potential art types for a media item",
"params": [
{
"name": "item",
"required": true,
"type": [
{
"additionalProperties": false,
"properties": {
"episodeid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"tvshowid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"seasonid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"movieid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"setid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"musicvideoid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
}
]
}
],
"permission": "ReadData",
"returns": {
"properties": {
"availablearttypes": {
"items": {
"type": "string"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetEpisodeDetails ====
Retrieve details about a specific tv show episode<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' episodeid<br />
# [''[[#Video.Fields.Episode|Video.Fields.Episode]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#Video.Details.Episode|Video.Details.Episode]]'' episodedetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific tv show episode",
"params": [
{
"$ref": "Library.Id",
"name": "episodeid",
"required": true
},
{
"$ref": "Video.Fields.Episode",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"episodedetails": {
"$ref": "Video.Details.Episode"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetEpisodes ====
Retrieve all tv show episodes<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Library.Id|Library.Id]]'' tvshowid = -1]<br />
# [''integer'' season = -1]<br />
# [''[[#Video.Fields.Episode|Video.Fields.Episode]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
# [''mixed: object|object|object|object|object|[[#List.Filter.Episodes|List.Filter.Episodes]]'' filter]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''array[ [[#Video.Details.Episode|Video.Details.Episode]] ]'' episodes]<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all tv show episodes",
"params": [
{
"$ref": "Library.Id",
"default": -1,
"name": "tvshowid"
},
{
"default": -1,
"minimum": 0,
"name": "season",
"type": "integer"
},
{
"$ref": "Video.Fields.Episode",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Requires tvshowid to be set",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"description": "Requires tvshowid to be set",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"year": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"actor": {
"description": "Requires tvshowid to be set",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"director": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Episodes"
}
]
}
],
"permission": "ReadData",
"returns": {
"properties": {
"episodes": {
"items": {
"$ref": "Video.Details.Episode"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetGenres ====
Retrieve all genres<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' type<br />
# [''[[#Library.Fields.Genre|Library.Fields.Genre]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''array[ [[#Library.Details.Genre|Library.Details.Genre]] ]'' genres<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all genres",
"params": [
{
"enums": [
"movie",
"tvshow",
"musicvideo"
],
"name": "type",
"required": true,
"type": "string"
},
{
"$ref": "Library.Fields.Genre",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"genres": {
"items": {
"$ref": "Library.Details.Genre"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetInProgressTVShows ====
Retrieve all in progress tvshows<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Video.Fields.TVShow|Video.Fields.TVShow]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# [''array[ [[#Video.Details.TVShow|Video.Details.TVShow]] ]'' tvshows]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all in progress tvshows",
"params": [
{
"$ref": "Video.Fields.TVShow",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"tvshows": {
"items": {
"$ref": "Video.Details.TVShow"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetMovieDetails ====
Retrieve details about a specific movie<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' movieid<br />
# [''[[#Video.Fields.Movie|Video.Fields.Movie]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#Video.Details.Movie|Video.Details.Movie]]'' moviedetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific movie",
"params": [
{
"$ref": "Library.Id",
"name": "movieid",
"required": true
},
{
"$ref": "Video.Fields.Movie",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"moviedetails": {
"$ref": "Video.Details.Movie"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetMovieSetDetails ====
Retrieve details about a specific movie set<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' setid<br />
# [''[[#Video.Fields.MovieSet|Video.Fields.MovieSet]]'' properties]<br />
# [''object'' movies]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#Video.Details.MovieSet.Extended|Video.Details.MovieSet.Extended]]'' setdetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific movie set",
"params": [
{
"$ref": "Library.Id",
"name": "setid",
"required": true
},
{
"$ref": "Video.Fields.MovieSet",
"name": "properties"
},
{
"name": "movies",
"properties": {
"limits": {
"$ref": "List.Limits"
},
"properties": {
"$ref": "Video.Fields.Movie"
},
"sort": {
"$ref": "List.Sort"
}
},
"type": "object"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"setdetails": {
"$ref": "Video.Details.MovieSet.Extended"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetMovieSets ====
Retrieve all movie sets<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Video.Fields.MovieSet|Video.Fields.MovieSet]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# [''array[ [[#Video.Details.MovieSet|Video.Details.MovieSet]] ]'' sets]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all movie sets",
"params": [
{
"$ref": "Video.Fields.MovieSet",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"sets": {
"items": {
"$ref": "Video.Details.MovieSet"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetMovies ====
Retrieve all movies<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Video.Fields.Movie|Video.Fields.Movie]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
# [''mixed: object|object|object|object|object|object|object|object|object|object|[[#List.Filter.Movies|List.Filter.Movies]]'' filter]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# [''array[ [[#Video.Details.Movie|Video.Details.Movie]] ]'' movies]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all movies",
"params": [
{
"$ref": "Video.Fields.Movie",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"year": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"actor": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"director": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"studio": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"country": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"setid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"set": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"tag": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Movies"
}
]
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"movies": {
"items": {
"$ref": "Video.Details.Movie"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetMusicVideoDetails ====
Retrieve details about a specific music video<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' musicvideoid<br />
# [''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#Video.Details.MusicVideo|Video.Details.MusicVideo]]'' musicvideodetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific music video",
"params": [
{
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
},
{
"$ref": "Video.Fields.MusicVideo",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"musicvideodetails": {
"$ref": "Video.Details.MusicVideo"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetMusicVideos ====
Retrieve all music videos<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
# [''mixed: object|object|object|object|object|object|object|[[#List.Filter.MusicVideos|List.Filter.MusicVideos]]'' filter]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# [''array[ [[#Video.Details.MusicVideo|Video.Details.MusicVideo]] ]'' musicvideos]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all music videos",
"params": [
{
"$ref": "Video.Fields.MusicVideo",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"year": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"director": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"studio": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"tag": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.MusicVideos"
}
]
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"musicvideos": {
"items": {
"$ref": "Video.Details.MusicVideo"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetRecentlyAddedEpisodes ====
Retrieve all recently added tv episodes<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Video.Fields.Episode|Video.Fields.Episode]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''array[ [[#Video.Details.Episode|Video.Details.Episode]] ]'' episodes]<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all recently added tv episodes",
"params": [
{
"$ref": "Video.Fields.Episode",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"episodes": {
"items": {
"$ref": "Video.Details.Episode"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetRecentlyAddedMovies ====
Retrieve all recently added movies<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Video.Fields.Movie|Video.Fields.Movie]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# [''array[ [[#Video.Details.Movie|Video.Details.Movie]] ]'' movies]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all recently added movies",
"params": [
{
"$ref": "Video.Fields.Movie",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"movies": {
"items": {
"$ref": "Video.Details.Movie"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetRecentlyAddedMusicVideos ====
Retrieve all recently added music videos<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# [''array[ [[#Video.Details.MusicVideo|Video.Details.MusicVideo]] ]'' musicvideos]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all recently added music videos",
"params": [
{
"$ref": "Video.Fields.MusicVideo",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"musicvideos": {
"items": {
"$ref": "Video.Details.MusicVideo"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetSeasonDetails ====
Retrieve details about a specific tv show season<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' seasonid<br />
# [''[[#Video.Fields.Season|Video.Fields.Season]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#Video.Details.Season|Video.Details.Season]]'' seasondetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific tv show season",
"params": [
{
"$ref": "Library.Id",
"name": "seasonid",
"required": true
},
{
"$ref": "Video.Fields.Season",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"seasondetails": {
"$ref": "Video.Details.Season"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetSeasons ====
Retrieve all tv seasons<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Library.Id|Library.Id]]'' tvshowid = -1]<br />
# [''[[#Video.Fields.Season|Video.Fields.Season]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# [''array[ [[#Video.Details.Season|Video.Details.Season]] ]'' seasons]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all tv seasons",
"params": [
{
"$ref": "Library.Id",
"default": -1,
"name": "tvshowid"
},
{
"$ref": "Video.Fields.Season",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"seasons": {
"items": {
"$ref": "Video.Details.Season"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetTVShowDetails ====
Retrieve details about a specific tv show<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' tvshowid<br />
# [''[[#Video.Fields.TVShow|Video.Fields.TVShow]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#Video.Details.TVShow|Video.Details.TVShow]]'' tvshowdetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific tv show",
"params": [
{
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
},
{
"$ref": "Video.Fields.TVShow",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"tvshowdetails": {
"$ref": "Video.Details.TVShow"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetTVShows ====
Retrieve all tv shows<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Video.Fields.TVShow|Video.Fields.TVShow]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
# [''mixed: object|object|object|object|object|object|[[#List.Filter.TVShows|List.Filter.TVShows]]'' filter]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# [''array[ [[#Video.Details.TVShow|Video.Details.TVShow]] ]'' tvshows]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all tv shows",
"params": [
{
"$ref": "Video.Fields.TVShow",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"year": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"actor": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"studio": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"tag": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.TVShows"
}
]
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"tvshows": {
"items": {
"$ref": "Video.Details.TVShow"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetTags ====
Retrieve all tags<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' type<br />
# [''[[#Library.Fields.Tag|Library.Fields.Tag]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# ''array[ [[#Library.Details.Tag|Library.Details.Tag]] ]'' tags<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all tags",
"params": [
{
"enums": [
"movie",
"tvshow",
"musicvideo"
],
"name": "type",
"required": true,
"type": "string"
},
{
"$ref": "Library.Fields.Tag",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"tags": {
"items": {
"$ref": "Library.Details.Tag"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.RefreshEpisode ====
Refresh the given episode in the library<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' episodeid<br />
# [''boolean'' ignorenfo = False] (Whether or not to ignore a local NFO if present.)<br />
# [''string'' title = ""] (Title to use for searching (instead of determining it from the item's filename/path).)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Refresh the given episode in the library",
"params": [
{
"$ref": "Library.Id",
"name": "episodeid",
"required": true
},
{
"default": false,
"description": "Whether or not to ignore a local NFO if present.",
"name": "ignorenfo",
"type": "boolean"
},
{
"default": "",
"description": "Title to use for searching (instead of determining it from the item's filename/path).",
"name": "title",
"type": "string"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.RefreshMovie ====
Refresh the given movie in the library<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' movieid<br />
# [''boolean'' ignorenfo = False] (Whether or not to ignore a local NFO if present.)<br />
# [''string'' title = ""] (Title to use for searching (instead of determining it from the item's filename/path).)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Refresh the given movie in the library",
"params": [
{
"$ref": "Library.Id",
"name": "movieid",
"required": true
},
{
"default": false,
"description": "Whether or not to ignore a local NFO if present.",
"name": "ignorenfo",
"type": "boolean"
},
{
"default": "",
"description": "Title to use for searching (instead of determining it from the item's filename/path).",
"name": "title",
"type": "string"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.RefreshMusicVideo ====
Refresh the given music video in the library<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' musicvideoid<br />
# [''boolean'' ignorenfo = False] (Whether or not to ignore a local NFO if present.)<br />
# [''string'' title = ""] (Title to use for searching (instead of determining it from the item's filename/path).)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Refresh the given music video in the library",
"params": [
{
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
},
{
"default": false,
"description": "Whether or not to ignore a local NFO if present.",
"name": "ignorenfo",
"type": "boolean"
},
{
"default": "",
"description": "Title to use for searching (instead of determining it from the item's filename/path).",
"name": "title",
"type": "string"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.RefreshTVShow ====
Refresh the given tv show in the library<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' tvshowid<br />
# [''boolean'' ignorenfo = False] (Whether or not to ignore a local NFO if present.)<br />
# [''boolean'' refreshepisodes = False] (Whether or not to refresh all episodes belonging to the TV show.)<br />
# [''string'' title = ""] (Title to use for searching (instead of determining it from the item's filename/path).)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Refresh the given tv show in the library",
"params": [
{
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
},
{
"default": false,
"description": "Whether or not to ignore a local NFO if present.",
"name": "ignorenfo",
"type": "boolean"
},
{
"default": false,
"description": "Whether or not to refresh all episodes belonging to the TV show.",
"name": "refreshepisodes",
"type": "boolean"
},
{
"default": "",
"description": "Title to use for searching (instead of determining it from the item's filename/path).",
"name": "title",
"type": "string"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.RemoveEpisode ====
Removes the given episode from the library<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' episodeid<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Removes the given episode from the library",
"params": [
{
"$ref": "Library.Id",
"name": "episodeid",
"required": true
}
],
"permission": "RemoveData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.RemoveMovie ====
Removes the given movie from the library<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' movieid<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Removes the given movie from the library",
"params": [
{
"$ref": "Library.Id",
"name": "movieid",
"required": true
}
],
"permission": "RemoveData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.RemoveMusicVideo ====
Removes the given music video from the library<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' musicvideoid<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Removes the given music video from the library",
"params": [
{
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
}
],
"permission": "RemoveData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.RemoveTVShow ====
Removes the given tv show from the library<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' tvshowid<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Removes the given tv show from the library",
"params": [
{
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
}
],
"permission": "RemoveData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.Scan ====
Scans the video sources for new library items<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''string'' directory = ""]<br />
# [''boolean'' showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Scans the video sources for new library items",
"params": [
{
"default": "",
"name": "directory",
"type": "string"
},
{
"default": true,
"description": "Whether or not to show the progress bar or any other GUI dialog",
"name": "showdialogs",
"type": "boolean"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.SetEpisodeDetails ====
Update the given episode with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' episodeid<br />
# [''[[#Optional.String|Optional.String]]'' title = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' playcount = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' runtime = None] (Runtime in seconds)<br />
# [''mixed: null|[[#Array.String|Array.String]]'' director = None]<br />
# [''[[#Optional.String|Optional.String]]'' plot = None]<br />
# [''[[#Optional.Number|Optional.Number]]'' rating = None]<br />
# [''[[#Optional.String|Optional.String]]'' votes = None]<br />
# [''[[#Optional.String|Optional.String]]'' lastplayed = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' writer = None]<br />
# [''[[#Optional.String|Optional.String]]'' firstaired = None]<br />
# [''[[#Optional.String|Optional.String]]'' productioncode = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' season = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' episode = None]<br />
# [''[[#Optional.String|Optional.String]]'' originaltitle = None]<br />
# [''[[#Optional.String|Optional.String]]'' thumbnail = None]<br />
# [''[[#Optional.String|Optional.String]]'' fanart = None]<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
# [''mixed: null|[[#Video.Resume|Video.Resume]]'' resume = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br />
# [''[[#Video.Ratings.Set|Video.Ratings.Set]]'' ratings]<br />
# [''[[#Optional.String|Optional.String]]'' dateadded = None]<br />
# [''mixed: null|[[#Media.UniqueID.Set|Media.UniqueID.Set]]'' uniqueid = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given episode with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "episodeid",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"name": "title"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "playcount"
},
{
"$ref": "Optional.Integer",
"default": null,
"description": "Runtime in seconds",
"name": "runtime"
},
{
"default": null,
"name": "director",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "plot"
},
{
"$ref": "Optional.Number",
"default": null,
"name": "rating"
},
{
"$ref": "Optional.String",
"default": null,
"name": "votes"
},
{
"$ref": "Optional.String",
"default": null,
"name": "lastplayed"
},
{
"default": null,
"name": "writer",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "firstaired"
},
{
"$ref": "Optional.String",
"default": null,
"name": "productioncode"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "season"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "episode"
},
{
"$ref": "Optional.String",
"default": null,
"name": "originaltitle"
},
{
"$ref": "Optional.String",
"default": null,
"name": "thumbnail"
},
{
"$ref": "Optional.String",
"default": null,
"name": "fanart"
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
},
{
"default": null,
"name": "resume",
"type": [
{
"type": "null"
},
{
"$ref": "Video.Resume"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "userrating"
},
{
"$ref": "Video.Ratings.Set",
"name": "ratings"
},
{
"$ref": "Optional.String",
"default": null,
"name": "dateadded"
},
{
"default": null,
"name": "uniqueid",
"type": [
{
"type": "null"
},
{
"$ref": "Media.UniqueID.Set"
}
]
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.SetMovieDetails ====
Update the given movie with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' movieid<br />
# [''[[#Optional.String|Optional.String]]'' title = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' playcount = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' runtime = None] (Runtime in seconds)<br />
# [''mixed: null|[[#Array.String|Array.String]]'' director = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' studio = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' year = None] (linked with premiered. Overridden by premiered parameter)<br />
# [''[[#Optional.String|Optional.String]]'' plot = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' genre = None]<br />
# [''[[#Optional.Number|Optional.Number]]'' rating = None]<br />
# [''[[#Optional.String|Optional.String]]'' mpaa = None]<br />
# [''[[#Optional.String|Optional.String]]'' imdbnumber = None]<br />
# [''[[#Optional.String|Optional.String]]'' votes = None]<br />
# [''[[#Optional.String|Optional.String]]'' lastplayed = None]<br />
# [''[[#Optional.String|Optional.String]]'' originaltitle = None]<br />
# [''[[#Optional.String|Optional.String]]'' trailer = None]<br />
# [''[[#Optional.String|Optional.String]]'' tagline = None]<br />
# [''[[#Optional.String|Optional.String]]'' plotoutline = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' writer = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' country = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' top250 = None]<br />
# [''[[#Optional.String|Optional.String]]'' sorttitle = None]<br />
# [''[[#Optional.String|Optional.String]]'' set = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' showlink = None]<br />
# [''[[#Optional.String|Optional.String]]'' thumbnail = None]<br />
# [''[[#Optional.String|Optional.String]]'' fanart = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' tag = None]<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
# [''mixed: null|[[#Video.Resume|Video.Resume]]'' resume = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br />
# [''[[#Video.Ratings.Set|Video.Ratings.Set]]'' ratings]<br />
# [''[[#Optional.String|Optional.String]]'' dateadded = None]<br />
# [''[[#Optional.String|Optional.String]]'' premiered = None] (linked with year. Overrides year)<br />
# [''mixed: null|[[#Media.UniqueID.Set|Media.UniqueID.Set]]'' uniqueid = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given movie with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "movieid",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"name": "title"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "playcount"
},
{
"$ref": "Optional.Integer",
"default": null,
"description": "Runtime in seconds",
"name": "runtime"
},
{
"default": null,
"name": "director",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "studio",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"description": "linked with premiered. Overridden by premiered parameter",
"name": "year"
},
{
"$ref": "Optional.String",
"default": null,
"name": "plot"
},
{
"default": null,
"name": "genre",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.Number",
"default": null,
"name": "rating"
},
{
"$ref": "Optional.String",
"default": null,
"name": "mpaa"
},
{
"$ref": "Optional.String",
"default": null,
"name": "imdbnumber"
},
{
"$ref": "Optional.String",
"default": null,
"name": "votes"
},
{
"$ref": "Optional.String",
"default": null,
"name": "lastplayed"
},
{
"$ref": "Optional.String",
"default": null,
"name": "originaltitle"
},
{
"$ref": "Optional.String",
"default": null,
"name": "trailer"
},
{
"$ref": "Optional.String",
"default": null,
"name": "tagline"
},
{
"$ref": "Optional.String",
"default": null,
"name": "plotoutline"
},
{
"default": null,
"name": "writer",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "country",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "top250"
},
{
"$ref": "Optional.String",
"default": null,
"name": "sorttitle"
},
{
"$ref": "Optional.String",
"default": null,
"name": "set"
},
{
"default": null,
"name": "showlink",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "thumbnail"
},
{
"$ref": "Optional.String",
"default": null,
"name": "fanart"
},
{
"default": null,
"name": "tag",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
},
{
"default": null,
"name": "resume",
"type": [
{
"type": "null"
},
{
"$ref": "Video.Resume"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "userrating"
},
{
"$ref": "Video.Ratings.Set",
"name": "ratings"
},
{
"$ref": "Optional.String",
"default": null,
"name": "dateadded"
},
{
"$ref": "Optional.String",
"default": null,
"description": "linked with year. Overrides year",
"name": "premiered"
},
{
"default": null,
"name": "uniqueid",
"type": [
{
"type": "null"
},
{
"$ref": "Media.UniqueID.Set"
}
]
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.SetMovieSetDetails ====
Update the given movie set with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' setid<br />
# [''[[#Optional.String|Optional.String]]'' title = None]<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
# [''[[#Optional.String|Optional.String]]'' plot = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given movie set with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "setid",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"name": "title"
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "plot"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.SetMusicVideoDetails ====
Update the given music video with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' musicvideoid<br />
# [''[[#Optional.String|Optional.String]]'' title = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' playcount = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' runtime = None] (Runtime in seconds)<br />
# [''mixed: null|[[#Array.String|Array.String]]'' director = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' studio = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' year = None] (linked with premiered. Overridden by premiered parameter)<br />
# [''[[#Optional.String|Optional.String]]'' plot = None]<br />
# [''[[#Optional.String|Optional.String]]'' album = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' artist = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' genre = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' track = None]<br />
# [''[[#Optional.String|Optional.String]]'' lastplayed = None]<br />
# [''[[#Optional.String|Optional.String]]'' thumbnail = None]<br />
# [''[[#Optional.String|Optional.String]]'' fanart = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' tag = None]<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
# [''mixed: null|[[#Video.Resume|Video.Resume]]'' resume = None]<br />
# [''[[#Optional.Number|Optional.Number]]'' rating = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br />
# [''[[#Optional.String|Optional.String]]'' dateadded = None]<br />
# [''[[#Optional.String|Optional.String]]'' premiered = None] (linked with year. Overrides year)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given music video with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"name": "title"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "playcount"
},
{
"$ref": "Optional.Integer",
"default": null,
"description": "Runtime in seconds",
"name": "runtime"
},
{
"default": null,
"name": "director",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "studio",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"description": "linked with premiered. Overridden by premiered parameter",
"name": "year"
},
{
"$ref": "Optional.String",
"default": null,
"name": "plot"
},
{
"$ref": "Optional.String",
"default": null,
"name": "album"
},
{
"default": null,
"name": "artist",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "genre",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "track"
},
{
"$ref": "Optional.String",
"default": null,
"name": "lastplayed"
},
{
"$ref": "Optional.String",
"default": null,
"name": "thumbnail"
},
{
"$ref": "Optional.String",
"default": null,
"name": "fanart"
},
{
"default": null,
"name": "tag",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
},
{
"default": null,
"name": "resume",
"type": [
{
"type": "null"
},
{
"$ref": "Video.Resume"
}
]
},
{
"$ref": "Optional.Number",
"default": null,
"name": "rating"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "userrating"
},
{
"$ref": "Optional.String",
"default": null,
"name": "dateadded"
},
{
"$ref": "Optional.String",
"default": null,
"description": "linked with year. Overrides year",
"name": "premiered"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.SetSeasonDetails ====
Update the given season with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' seasonid<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br />
# [''[[#Optional.String|Optional.String]]'' title = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given season with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "seasonid",
"required": true
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "userrating"
},
{
"$ref": "Optional.String",
"default": null,
"name": "title"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.SetTVShowDetails ====
Update the given tvshow with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' tvshowid<br />
# [''[[#Optional.String|Optional.String]]'' title = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' playcount = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' studio = None]<br />
# [''[[#Optional.String|Optional.String]]'' plot = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' genre = None]<br />
# [''[[#Optional.Number|Optional.Number]]'' rating = None]<br />
# [''[[#Optional.String|Optional.String]]'' mpaa = None]<br />
# [''[[#Optional.String|Optional.String]]'' imdbnumber = None]<br />
# [''[[#Optional.String|Optional.String]]'' premiered = None]<br />
# [''[[#Optional.String|Optional.String]]'' votes = None]<br />
# [''[[#Optional.String|Optional.String]]'' lastplayed = None]<br />
# [''[[#Optional.String|Optional.String]]'' originaltitle = None]<br />
# [''[[#Optional.String|Optional.String]]'' sorttitle = None]<br />
# [''[[#Optional.String|Optional.String]]'' episodeguide = None]<br />
# [''[[#Optional.String|Optional.String]]'' thumbnail = None]<br />
# [''[[#Optional.String|Optional.String]]'' fanart = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' tag = None]<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br />
# [''[[#Video.Ratings.Set|Video.Ratings.Set]]'' ratings]<br />
# [''[[#Optional.String|Optional.String]]'' dateadded = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' runtime = None] (Runtime in seconds)<br />
# [''[[#Optional.String|Optional.String]]'' status = None] (Valid values: 'returning series', 'in production', 'planned', 'cancelled', 'ended')<br />
# [''mixed: null|[[#Media.UniqueID.Set|Media.UniqueID.Set]]'' uniqueid = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given tvshow with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"name": "title"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "playcount"
},
{
"default": null,
"name": "studio",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "plot"
},
{
"default": null,
"name": "genre",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.Number",
"default": null,
"name": "rating"
},
{
"$ref": "Optional.String",
"default": null,
"name": "mpaa"
},
{
"$ref": "Optional.String",
"default": null,
"name": "imdbnumber"
},
{
"$ref": "Optional.String",
"default": null,
"name": "premiered"
},
{
"$ref": "Optional.String",
"default": null,
"name": "votes"
},
{
"$ref": "Optional.String",
"default": null,
"name": "lastplayed"
},
{
"$ref": "Optional.String",
"default": null,
"name": "originaltitle"
},
{
"$ref": "Optional.String",
"default": null,
"name": "sorttitle"
},
{
"$ref": "Optional.String",
"default": null,
"name": "episodeguide"
},
{
"$ref": "Optional.String",
"default": null,
"name": "thumbnail"
},
{
"$ref": "Optional.String",
"default": null,
"name": "fanart"
},
{
"default": null,
"name": "tag",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "userrating"
},
{
"$ref": "Video.Ratings.Set",
"name": "ratings"
},
{
"$ref": "Optional.String",
"default": null,
"name": "dateadded"
},
{
"$ref": "Optional.Integer",
"default": null,
"description": "Runtime in seconds",
"name": "runtime"
},
{
"$ref": "Optional.String",
"default": null,
"description": "Valid values: 'returning series', 'in production', 'planned', 'cancelled', 'ended'",
"name": "status"
},
{
"default": null,
"name": "uniqueid",
"type": [
{
"type": "null"
},
{
"$ref": "Media.UniqueID.Set"
}
]
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== XBMC ===
==== XBMC.GetInfoBooleans ====
Retrieve info booleans about Kodi and the system<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''array[string]'' booleans<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object (Object containing key-value pairs of the retrieved info booleans)''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve info booleans about Kodi and the system",
"params": [
{
"items": {
"type": "string"
},
"minItems": 1,
"name": "booleans",
"required": true,
"type": "array"
}
],
"permission": "ReadData",
"returns": {
"additionalProperties": {
"default": "",
"type": "string"
},
"description": "Object containing key-value pairs of the retrieved info booleans",
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== XBMC.GetInfoLabels ====
Retrieve info labels about Kodi and the system<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''array[string]'' labels (See http://kodi.wiki/view/InfoLabels for a list of possible info labels)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object (Object containing key-value pairs of the retrieved info labels)''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve info labels about Kodi and the system",
"params": [
{
"description": "See http://kodi.wiki/view/InfoLabels for a list of possible info labels",
"items": {
"type": "string"
},
"minItems": 1,
"name": "labels",
"required": true,
"type": "array"
}
],
"permission": "ReadData",
"returns": {
"additionalProperties": {
"default": "",
"type": "string"
},
"description": "Object containing key-value pairs of the retrieved info labels",
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
== Global Types ==
=== Addon ===
==== Addon.Content ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "unknown",
"enums": [
"unknown",
"video",
"audio",
"image",
"executable"
],
"id": "Addon.Content",
"type": "string"
}
</syntaxhighlight>}}
==== Addon.Details ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' addonid
* [''string'' author]
* [''mixed: boolean|string'' broken]
* [''array'' dependencies]
* [''mixed: boolean|string'' deprecated]
* [''string'' description]
* [''string'' disclaimer]
* [''boolean'' enabled]
* [''array'' extrainfo]
* [''string'' fanart]
* [''boolean'' installed]
* [''string'' name]
* [''string'' path]
* [''integer'' rating]
* [''string'' summary]
* [''string'' thumbnail]
* ''[[#Addon.Types|Addon.Types]]'' type
* [''string'' version]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "Addon.Details",
"properties": {
"addonid": {
"required": true,
"type": "string"
},
"author": {
"default": "",
"type": "string"
},
"broken": {
"default": null,
"type": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"dependencies": {
"items": {
"properties": {
"addonid": {
"required": true,
"type": "string"
},
"optional": {
"required": true,
"type": "boolean"
},
"version": {
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"deprecated": {
"default": null,
"type": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"description": {
"default": "",
"type": "string"
},
"disclaimer": {
"default": "",
"type": "string"
},
"enabled": {
"default": false,
"type": "boolean"
},
"extrainfo": {
"items": {
"properties": {
"key": {
"required": true,
"type": "string"
},
"value": {
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"fanart": {
"default": "",
"type": "string"
},
"installed": {
"default": false,
"type": "boolean"
},
"name": {
"default": "",
"type": "string"
},
"path": {
"default": "",
"type": "string"
},
"rating": {
"default": 0,
"type": "integer"
},
"summary": {
"default": "",
"type": "string"
},
"thumbnail": {
"default": "",
"type": "string"
},
"type": {
"$ref": "Addon.Types",
"required": true
},
"version": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Addon.Fields ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Addon.Fields",
"items": {
"enums": [
"name",
"version",
"summary",
"description",
"path",
"author",
"thumbnail",
"disclaimer",
"fanart",
"dependencies",
"broken",
"extrainfo",
"rating",
"enabled",
"installed",
"deprecated"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Addon.Types ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "unknown",
"enums": [
"unknown",
"xbmc.player.musicviz",
"xbmc.gui.skin",
"kodi.pvrclient",
"kodi.inputstream",
"kodi.gameclient",
"kodi.peripheral",
"xbmc.python.script",
"xbmc.python.weather",
"xbmc.subtitle.module",
"xbmc.python.lyrics",
"xbmc.metadata.scraper.albums",
"xbmc.metadata.scraper.artists",
"xbmc.metadata.scraper.movies",
"xbmc.metadata.scraper.musicvideos",
"xbmc.metadata.scraper.tvshows",
"xbmc.ui.screensaver",
"xbmc.python.pluginsource",
"xbmc.addon.repository",
"xbmc.webinterface",
"xbmc.service",
"kodi.audioencoder",
"kodi.context.item",
"kodi.audiodecoder",
"kodi.resource.images",
"kodi.resource.language",
"kodi.resource.uisounds",
"kodi.resource.games",
"kodi.resource.font",
"kodi.vfs",
"kodi.imagedecoder",
"xbmc.metadata.scraper.library",
"xbmc.python.library",
"xbmc.python.module",
"kodi.game.controller",
"",
"xbmc.addon.video",
"xbmc.addon.audio",
"xbmc.addon.image",
"xbmc.addon.executable",
"kodi.addon.game"
],
"id": "Addon.Types",
"type": "string"
}
</syntaxhighlight>}}
=== Application ===
==== Application.Property.Name ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "volume",
"enums": [
"volume",
"muted",
"name",
"version",
"sorttokens",
"language"
],
"id": "Application.Property.Name",
"type": "string"
}
</syntaxhighlight>}}
==== Application.Property.Value ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' language]
* [''boolean'' muted]
* [''string'' name]
* [''[[#Array.String|Array.String]]'' sorttokens]
* [''object'' version]
* [''integer'' volume]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Application.Property.Value",
"properties": {
"language": {
"default": "",
"description": "Current language code and region e.g. en_GB",
"minLength": 1,
"type": "string"
},
"muted": {
"default": false,
"type": "boolean"
},
"name": {
"default": "",
"minLength": 1,
"type": "string"
},
"sorttokens": {
"$ref": "Array.String",
"description": "Articles ignored during sorting when ignorearticle is enabled."
},
"version": {
"properties": {
"major": {
"minimum": 0,
"required": true,
"type": "integer"
},
"minor": {
"minimum": 0,
"required": true,
"type": "integer"
},
"revision": {
"default": null,
"type": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"tag": {
"enums": [
"prealpha",
"alpha",
"beta",
"releasecandidate",
"stable"
],
"required": true,
"type": "string"
},
"tagversion": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"volume": {
"default": 0,
"maximum": 100,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
=== Array ===
==== Array.Integer ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Array.Integer",
"items": {
"type": "integer"
},
"type": "array"
}
</syntaxhighlight>}}
==== Array.String ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Array.String",
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
}
</syntaxhighlight>}}
=== Audio ===
==== Audio.Album.ReleaseType ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "album",
"enums": [
"album",
"single"
],
"id": "Audio.Album.ReleaseType",
"type": "string"
}
</syntaxhighlight>}}
==== Audio.Artist.Roles ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Audio.Artist.Roles",
"items": {
"additionalProperties": false,
"description": "The various roles contributed by an artist to one or more songs",
"properties": {
"role": {
"required": true,
"type": "string"
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
"type": "array"
}
</syntaxhighlight>}}
==== Audio.Contributors ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Audio.Contributors",
"items": {
"additionalProperties": false,
"description": "The artist and the role they contribute to a song",
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"name": {
"required": true,
"type": "string"
},
"role": {
"required": true,
"type": "string"
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
"type": "array"
}
</syntaxhighlight>}}
==== Audio.Details.Album ====
'''Extends:'''
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''integer'' albumduration]
* ''[[#Library.Id|Library.Id]]'' albumid
* [''string'' albumlabel]
* [''string'' albumstatus]
* [''boolean'' compilation]
* [''string'' description]
* [''boolean'' isboxset]
* [''string'' lastplayed]
* [''[[#Array.String|Array.String]]'' mood]
* [''string'' musicbrainzalbumid]
* [''string'' musicbrainzreleasegroupid]
* [''integer'' playcount]
* [''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' releasetype = album]
* [''[[#Audio.Details.Genres|Audio.Details.Genres]]'' songgenres]
* [''[[#Array.Integer|Array.Integer]]'' sourceid]
* [''[[#Array.String|Array.String]]'' style]
* [''[[#Array.String|Array.String]]'' theme]
* [''integer'' totaldiscs]
* [''string'' type]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Audio.Details.Media",
"id": "Audio.Details.Album",
"properties": {
"albumduration": {
"default": 0,
"type": "integer"
},
"albumid": {
"$ref": "Library.Id",
"required": true
},
"albumlabel": {
"default": "",
"type": "string"
},
"albumstatus": {
"default": "",
"type": "string"
},
"compilation": {
"default": false,
"type": "boolean"
},
"description": {
"default": "",
"type": "string"
},
"isboxset": {
"default": false,
"type": "boolean"
},
"lastplayed": {
"default": "",
"type": "string"
},
"mood": {
"$ref": "Array.String"
},
"musicbrainzalbumid": {
"default": "",
"type": "string"
},
"musicbrainzreleasegroupid": {
"default": "",
"type": "string"
},
"playcount": {
"default": 0,
"type": "integer"
},
"releasetype": {
"$ref": "Audio.Album.ReleaseType",
"default": "album"
},
"songgenres": {
"$ref": "Audio.Details.Genres"
},
"sourceid": {
"$ref": "Array.Integer"
},
"style": {
"$ref": "Array.String"
},
"theme": {
"$ref": "Array.String"
},
"totaldiscs": {
"default": 0,
"type": "integer"
},
"type": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Audio.Details.Artist ====
'''Extends:'''
* ''[[#Audio.Details.Base|Audio.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' artist
* ''[[#Library.Id|Library.Id]]'' artistid
* [''string'' born]
* [''boolean'' compilationartist]
* [''string'' description]
* [''string'' died]
* [''string'' disambiguation]
* [''string'' disbanded]
* [''string'' formed]
* [''string'' gender]
* [''[[#Array.String|Array.String]]'' instrument]
* [''boolean'' isalbumartist]
* [''[[#Array.String|Array.String]]'' mood]
* [''[[#Array.String|Array.String]]'' musicbrainzartistid]
* [''[[#Audio.Artist.Roles|Audio.Artist.Roles]]'' roles]
* [''[[#Audio.Details.Genres|Audio.Details.Genres]]'' songgenres]
* [''string'' sortname]
* [''[[#Array.Integer|Array.Integer]]'' sourceid]
* [''[[#Array.String|Array.String]]'' style]
* [''string'' type]
* [''[[#Array.String|Array.String]]'' yearsactive]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Audio.Details.Base",
"id": "Audio.Details.Artist",
"properties": {
"artist": {
"required": true,
"type": "string"
},
"artistid": {
"$ref": "Library.Id",
"required": true
},
"born": {
"default": "",
"type": "string"
},
"compilationartist": {
"default": false,
"type": "boolean"
},
"description": {
"default": "",
"type": "string"
},
"died": {
"default": "",
"type": "string"
},
"disambiguation": {
"default": "",
"type": "string"
},
"disbanded": {
"default": "",
"type": "string"
},
"formed": {
"default": "",
"type": "string"
},
"gender": {
"default": "",
"type": "string"
},
"instrument": {
"$ref": "Array.String"
},
"isalbumartist": {
"default": false,
"type": "boolean"
},
"mood": {
"$ref": "Array.String"
},
"musicbrainzartistid": {
"$ref": "Array.String"
},
"roles": {
"$ref": "Audio.Artist.Roles"
},
"songgenres": {
"$ref": "Audio.Details.Genres"
},
"sortname": {
"default": "",
"type": "string"
},
"sourceid": {
"$ref": "Array.Integer"
},
"style": {
"$ref": "Array.String"
},
"type": {
"default": "",
"type": "string"
},
"yearsactive": {
"$ref": "Array.String"
}
}
}
</syntaxhighlight>}}
==== Audio.Details.Base ====
'''Extends:'''
* ''[[#Media.Details.Base|Media.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Media.Artwork|Media.Artwork]]'' art]
* [''string'' dateadded]
* [''[[#Array.String|Array.String]]'' genre]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Media.Details.Base",
"id": "Audio.Details.Base",
"properties": {
"art": {
"$ref": "Media.Artwork"
},
"dateadded": {
"default": "",
"type": "string"
},
"genre": {
"$ref": "Array.String"
}
}
}
</syntaxhighlight>}}
==== Audio.Details.Genres ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Audio.Details.Genres",
"items": {
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
},
"title": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
</syntaxhighlight>}}
==== Audio.Details.Media ====
'''Extends:'''
* ''[[#Audio.Details.Base|Audio.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Array.String|Array.String]]'' artist]
* [''[[#Array.Integer|Array.Integer]]'' artistid]
* [''string'' displayartist]
* [''[[#Array.String|Array.String]]'' musicbrainzalbumartistid]
* [''string'' originaldate]
* [''number'' rating]
* [''string'' releasedate]
* [''string'' sortartist]
* [''string'' title]
* [''integer'' userrating]
* [''integer'' votes]
* [''integer'' year]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Audio.Details.Base",
"id": "Audio.Details.Media",
"properties": {
"artist": {
"$ref": "Array.String"
},
"artistid": {
"$ref": "Array.Integer"
},
"displayartist": {
"default": "",
"type": "string"
},
"musicbrainzalbumartistid": {
"$ref": "Array.String"
},
"originaldate": {
"default": "",
"type": "string"
},
"rating": {
"default": 0.0,
"type": "number"
},
"releasedate": {
"default": "",
"type": "string"
},
"sortartist": {
"default": "",
"type": "string"
},
"title": {
"default": "",
"type": "string"
},
"userrating": {
"default": 0,
"type": "integer"
},
"votes": {
"default": 0,
"type": "integer"
},
"year": {
"default": 0,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== Audio.Details.Role ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' roleid
* [''string'' title]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "Audio.Details.Role",
"properties": {
"roleid": {
"$ref": "Library.Id",
"required": true
},
"title": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Audio.Details.Song ====
'''Extends:'''
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' album]
* [''[[#Array.String|Array.String]]'' albumartist]
* [''[[#Array.Integer|Array.Integer]]'' albumartistid]
* [''[[#Library.Id|Library.Id]]'' albumid = -1]
* [''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' albumreleasetype = album]
* [''any'' bitrate]
* [''any'' bpm]
* [''any'' channels]
* [''string'' comment]
* [''[[#Audio.Contributors|Audio.Contributors]]'' contributors]
* [''integer'' disc]
* [''string'' disctitle]
* [''string'' displaycomposer]
* [''string'' displayconductor]
* [''string'' displaylyricist]
* [''string'' displayorchestra]
* [''integer'' duration]
* [''string'' file]
* [''[[#Array.Integer|Array.Integer]]'' genreid]
* [''string'' lastplayed]
* [''string'' lyrics]
* [''string'' mood]
* [''[[#Array.String|Array.String]]'' musicbrainzartistid]
* [''string'' musicbrainztrackid]
* [''integer'' playcount]
* [''any'' samplerate]
* ''[[#Library.Id|Library.Id]]'' songid
* [''[[#Array.Integer|Array.Integer]]'' sourceid]
* [''integer'' track]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Audio.Details.Media",
"id": "Audio.Details.Song",
"properties": {
"album": {
"default": "",
"type": "string"
},
"albumartist": {
"$ref": "Array.String"
},
"albumartistid": {
"$ref": "Array.Integer"
},
"albumid": {
"$ref": "Library.Id",
"default": -1
},
"albumreleasetype": {
"$ref": "Audio.Album.ReleaseType",
"default": "album"
},
"bitrate": {
"default": null,
"type": "any"
},
"bpm": {
"default": null,
"type": "any"
},
"channels": {
"default": null,
"type": "any"
},
"comment": {
"default": "",
"type": "string"
},
"contributors": {
"$ref": "Audio.Contributors"
},
"disc": {
"default": 0,
"type": "integer"
},
"disctitle": {
"default": "",
"type": "string"
},
"displaycomposer": {
"default": "",
"type": "string"
},
"displayconductor": {
"default": "",
"type": "string"
},
"displaylyricist": {
"default": "",
"type": "string"
},
"displayorchestra": {
"default": "",
"type": "string"
},
"duration": {
"default": 0,
"type": "integer"
},
"file": {
"default": "",
"type": "string"
},
"genreid": {
"$ref": "Array.Integer"
},
"lastplayed": {
"default": "",
"type": "string"
},
"lyrics": {
"default": "",
"type": "string"
},
"mood": {
"default": "",
"type": "string"
},
"musicbrainzartistid": {
"$ref": "Array.String"
},
"musicbrainztrackid": {
"default": "",
"type": "string"
},
"playcount": {
"default": 0,
"type": "integer"
},
"samplerate": {
"default": null,
"type": "any"
},
"songid": {
"$ref": "Library.Id",
"required": true
},
"sourceid": {
"$ref": "Array.Integer"
},
"track": {
"default": 0,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== Audio.Fields.Album ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Audio.Fields.Album",
"items": {
"description": "Requesting the songgenres, artistid and/or sourceid fields will result in increased response times",
"enums": [
"title",
"description",
"artist",
"genre",
"theme",
"mood",
"style",
"type",
"albumlabel",
"rating",
"votes",
"userrating",
"year",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"fanart",
"thumbnail",
"playcount",
"artistid",
"displayartist",
"compilation",
"releasetype",
"dateadded",
"sortartist",
"musicbrainzreleasegroupid",
"songgenres",
"art",
"lastplayed",
"sourceid",
"isboxset",
"totaldiscs",
"releasedate",
"originaldate",
"albumstatus",
"datemodified",
"datenew",
"albumduration"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Audio.Fields.Artist ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Audio.Fields.Artist",
"items": {
"description": "Requesting the (song)genreid/genre, roleid/role or sourceid fields will result in increased response times",
"enums": [
"instrument",
"style",
"mood",
"born",
"formed",
"description",
"genre",
"died",
"disbanded",
"yearsactive",
"musicbrainzartistid",
"fanart",
"thumbnail",
"compilationartist",
"dateadded",
"roles",
"songgenres",
"isalbumartist",
"sortname",
"type",
"gender",
"disambiguation",
"art",
"sourceid",
"datemodified",
"datenew"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Audio.Fields.Role ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Audio.Fields.Role",
"items": {
"enums": [
"title"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Audio.Fields.Song ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Audio.Fields.Song",
"items": {
"description": "Requesting the genreid, artistid, albumartistid and/or sourceid fields will result in increased response times",
"enums": [
"title",
"artist",
"albumartist",
"genre",
"year",
"rating",
"album",
"track",
"duration",
"comment",
"lyrics",
"musicbrainztrackid",
"musicbrainzartistid",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"playcount",
"fanart",
"thumbnail",
"file",
"albumid",
"lastplayed",
"disc",
"genreid",
"artistid",
"displayartist",
"albumartistid",
"albumreleasetype",
"dateadded",
"votes",
"userrating",
"mood",
"contributors",
"displaycomposer",
"displayconductor",
"displayorchestra",
"displaylyricist",
"sortartist",
"art",
"sourceid",
"disctitle",
"releasedate",
"originaldate",
"bpm",
"samplerate",
"bitrate",
"channels",
"datemodified",
"datenew"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Audio.Property.Name ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "missingartistid",
"enums": [
"missingartistid",
"librarylastupdated",
"librarylastcleaned",
"artistlinksupdated",
"songslastadded",
"albumslastadded",
"artistslastadded",
"genreslastadded",
"songsmodified",
"albumsmodified",
"artistsmodified"
],
"id": "Audio.Property.Name",
"type": "string"
}
</syntaxhighlight>}}
==== Audio.Property.Value ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' albumslastadded]
* [''string'' albumsmodified]
* [''string'' artistlinksupdated]
* [''string'' artistslastadded]
* [''string'' artistsmodified]
* [''string'' genreslastadded]
* [''string'' librarylastcleaned]
* [''string'' librarylastupdated]
* [''[[#Library.Id|Library.Id]]'' missingartistid = -1]
* [''string'' songslastadded]
* [''string'' songsmodified]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Audio.Property.Value",
"properties": {
"albumslastadded": {
"default": "",
"type": "string"
},
"albumsmodified": {
"default": "",
"type": "string"
},
"artistlinksupdated": {
"default": "",
"type": "string"
},
"artistslastadded": {
"default": "",
"type": "string"
},
"artistsmodified": {
"default": "",
"type": "string"
},
"genreslastadded": {
"default": "",
"type": "string"
},
"librarylastcleaned": {
"default": "",
"type": "string"
},
"librarylastupdated": {
"default": "",
"type": "string"
},
"missingartistid": {
"$ref": "Library.Id",
"default": -1
},
"songslastadded": {
"default": "",
"type": "string"
},
"songsmodified": {
"default": "",
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
=== Configuration ===
==== Configuration ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Configuration.Notifications|Configuration.Notifications]]'' notifications
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Configuration",
"properties": {
"notifications": {
"$ref": "Configuration.Notifications",
"required": true
}
},
"required": true,
"type": "object"
}
</syntaxhighlight>}}
==== Configuration.Notifications ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' application
* ''boolean'' audiolibrary
* ''boolean'' gui
* ''boolean'' input
* ''boolean'' other
* ''boolean'' player
* ''boolean'' playlist
* ''boolean'' pvr
* ''boolean'' system
* ''boolean'' videolibrary
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"id": "Configuration.Notifications",
"properties": {
"application": {
"required": true,
"type": "boolean"
},
"audiolibrary": {
"required": true,
"type": "boolean"
},
"gui": {
"required": true,
"type": "boolean"
},
"input": {
"required": true,
"type": "boolean"
},
"other": {
"required": true,
"type": "boolean"
},
"player": {
"required": true,
"type": "boolean"
},
"playlist": {
"required": true,
"type": "boolean"
},
"pvr": {
"required": true,
"type": "boolean"
},
"system": {
"required": true,
"type": "boolean"
},
"videolibrary": {
"required": true,
"type": "boolean"
}
},
"type": "object"
}
</syntaxhighlight>}}
=== Favourite ===
==== Favourite.Details.Favourite ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' path]
* [''string'' thumbnail]
* ''string'' title
* ''[[#Favourite.Type|Favourite.Type]]'' type
* [''string'' window]
* [''string'' windowparameter]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"id": "Favourite.Details.Favourite",
"properties": {
"path": {
"default": "",
"type": "string"
},
"thumbnail": {
"default": "",
"type": "string"
},
"title": {
"required": true,
"type": "string"
},
"type": {
"$ref": "Favourite.Type",
"required": true
},
"window": {
"default": "",
"type": "string"
},
"windowparameter": {
"default": "",
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Favourite.Fields.Favourite ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Favourite.Fields.Favourite",
"items": {
"enums": [
"window",
"windowparameter",
"thumbnail",
"path"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Favourite.Type ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "media",
"enums": [
"media",
"window",
"script",
"androidapp",
"unknown"
],
"id": "Favourite.Type",
"type": "string"
}
</syntaxhighlight>}}
=== Files ===
==== Files.Media ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "video",
"enums": [
"video",
"music",
"pictures",
"files",
"programs"
],
"id": "Files.Media",
"type": "string"
}
</syntaxhighlight>}}
=== GUI ===
==== GUI.Property.Name ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "currentwindow",
"enums": [
"currentwindow",
"currentcontrol",
"skin",
"fullscreen",
"stereoscopicmode"
],
"id": "GUI.Property.Name",
"type": "string"
}
</syntaxhighlight>}}
==== GUI.Property.Value ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''object'' currentcontrol]
* [''object'' currentwindow]
* [''boolean'' fullscreen]
* [''object'' skin]
* [''[[#GUI.Stereoscopy.Mode|GUI.Stereoscopy.Mode]]'' stereoscopicmode]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "GUI.Property.Value",
"properties": {
"currentcontrol": {
"properties": {
"label": {
"required": true,
"type": "string"
}
},
"type": "object"
},
"currentwindow": {
"properties": {
"id": {
"required": true,
"type": "integer"
},
"label": {
"required": true,
"type": "string"
}
},
"type": "object"
},
"fullscreen": {
"default": false,
"type": "boolean"
},
"skin": {
"properties": {
"id": {
"minLength": 1,
"required": true,
"type": "string"
},
"name": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"stereoscopicmode": {
"$ref": "GUI.Stereoscopy.Mode"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== GUI.Stereoscopy.Mode ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' label
* ''string'' mode
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "GUI.Stereoscopy.Mode",
"properties": {
"label": {
"required": true,
"type": "string"
},
"mode": {
"enums": [
"off",
"split_vertical",
"split_horizontal",
"row_interleaved",
"hardware_based",
"anaglyph_cyan_red",
"anaglyph_green_magenta",
"anaglyph_yellow_blue",
"monoscopic"
],
"required": true,
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== GUI.Window ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "addon",
"enums": [
"addon",
"addonbrowser",
"addoninformation",
"addonsettings",
"appearancesettings",
"busydialog",
"busydialognocancel",
"contentsettings",
"contextmenu",
"eventlog",
"extendedprogressdialog",
"favourites",
"filebrowser",
"filemanager",
"fullscreengame",
"fullscreeninfo",
"fullscreenlivetv",
"fullscreenlivetvinput",
"fullscreenlivetvpreview",
"fullscreenradio",
"fullscreenradioinput",
"fullscreenradiopreview",
"fullscreenvideo",
"gameadvancedsettings",
"gamecontrollers",
"gameosd",
"gamepadinput",
"games",
"gamesettings",
"gamestretchmode",
"gamevideofilter",
"gamevideorotation",
"gamevolume",
"home",
"infoprovidersettings",
"interfacesettings",
"libexportsettings",
"locksettings",
"loginscreen",
"mediafilter",
"mediasettings",
"mediasource",
"movieinformation",
"music",
"musicinformation",
"musicosd",
"musicplaylist",
"musicplaylisteditor",
"networksetup",
"notification",
"numericinput",
"okdialog",
"osdaudiosettings",
"osdcmssettings",
"osdsubtitlesettings",
"osdvideosettings",
"peripheralsettings",
"pictureinfo",
"pictures",
"playercontrols",
"playerprocessinfo",
"playersettings",
"profiles",
"profilesettings",
"programs",
"progressdialog",
"pvrchannelguide",
"pvrchannelmanager",
"pvrchannelscan",
"pvrgroupmanager",
"pvrguidecontrols",
"pvrguideinfo",
"pvrguidesearch",
"pvrosdchannels",
"pvrosdguide",
"pvrosdteletext",
"pvrradiordsinfo",
"pvrrecordinginfo",
"pvrsettings",
"pvrtimersetting",
"pvrupdateprogress",
"radiochannels",
"radioguide",
"radiorecordings",
"radiosearch",
"radiotimerrules",
"radiotimers",
"screencalibration",
"screensaver",
"seekbar",
"selectdialog",
"servicesettings",
"settings",
"shutdownmenu",
"skinsettings",
"sliderdialog",
"slideshow",
"smartplaylisteditor",
"smartplaylistrule",
"songinformation",
"splash",
"startup",
"startwindow",
"submenu",
"subtitlesearch",
"systeminfo",
"systemsettings",
"teletext",
"textviewer",
"tvchannels",
"tvguide",
"tvrecordings",
"tvsearch",
"tvtimerrules",
"tvtimers",
"videobookmarks",
"videomenu",
"videoosd",
"videoplaylist",
"videos",
"videotimeseek",
"virtualkeyboard",
"visualisation",
"visualisationpresetlist",
"volumebar",
"weather",
"yesnodialog"
],
"id": "GUI.Window",
"type": "string"
}
</syntaxhighlight>}}
=== Global ===
==== Global.IncrementDecrement ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "increment",
"enums": [
"increment",
"decrement"
],
"id": "Global.IncrementDecrement",
"type": "string"
}
</syntaxhighlight>}}
==== Global.String.NotEmpty ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "",
"id": "Global.String.NotEmpty",
"minLength": 1,
"type": "string"
}
</syntaxhighlight>}}
==== Global.Time ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''integer'' hours
* ''integer'' milliseconds
* ''integer'' minutes
* ''integer'' seconds
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"description": "A duration.",
"id": "Global.Time",
"properties": {
"hours": {
"minimum": 0,
"required": true,
"type": "integer"
},
"milliseconds": {
"maximum": 999,
"minimum": 0,
"required": true,
"type": "integer"
},
"minutes": {
"maximum": 59,
"minimum": 0,
"required": true,
"type": "integer"
},
"seconds": {
"maximum": 59,
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Global.Toggle ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": null,
"id": "Global.Toggle",
"type": [
{
"type": "boolean"
},
{
"enums": [
"toggle"
],
"type": "string"
}
]
}
</syntaxhighlight>}}
==== Global.Weekday ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "monday",
"enums": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
],
"id": "Global.Weekday",
"type": "string"
}
</syntaxhighlight>}}
=== Input ===
==== Input.Action ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "analogfastforward",
"enums": [
"analogfastforward",
"analogmove",
"analogmovexleft",
"analogmovexright",
"analogmoveydown",
"analogmoveyup",
"analogrewind",
"analogseekback",
"analogseekforward",
"aspectratio",
"audiodelay",
"audiodelayminus",
"audiodelayplus",
"audionextlanguage",
"audiotoggledigital",
"back",
"backspace",
"bigstepback",
"bigstepforward",
"blue",
"browsesubtitle",
"channeldown",
"channelnumberseparator",
"channelup",
"chapterorbigstepback",
"chapterorbigstepforward",
"close",
"codecinfo",
"contextmenu",
"copy",
"createbookmark",
"createepisodebookmark",
"cursorleft",
"cursorright",
"cyclesubtitle",
"cycletonemapmethod",
"decreasepar",
"decreaserating",
"decreasevisrating",
"delete",
"doubleclick",
"down",
"enter",
"error",
"fastforward",
"filter",
"filterclear",
"filtersms2",
"filtersms3",
"filtersms4",
"filtersms5",
"filtersms6",
"filtersms7",
"filtersms8",
"filtersms9",
"firstpage",
"fullscreen",
"green",
"guiprofile",
"hdrtoggle",
"highlight",
"increasepar",
"increaserating",
"increasevisrating",
"info",
"jumpsms2",
"jumpsms3",
"jumpsms4",
"jumpsms5",
"jumpsms6",
"jumpsms7",
"jumpsms8",
"jumpsms9",
"lastpage",
"left",
"leftclick",
"lockpreset",
"longclick",
"longpress",
"menu",
"middleclick",
"mousedrag",
"mousedragend",
"mousemove",
"move",
"moveitemdown",
"moveitemup",
"mute",
"nextcalibration",
"nextchannelgroup",
"nextletter",
"nextpicture",
"nextpreset",
"nextresolution",
"nextscene",
"nextstereomode",
"nextsubtitle",
"noop",
"number0",
"number1",
"number2",
"number3",
"number4",
"number5",
"number6",
"number7",
"number8",
"number9",
"osd",
"pagedown",
"pageup",
"pangesture",
"parentdir",
"parentfolder",
"pause",
"play",
"playerdebug",
"playerdebugvideo",
"playerprocessinfo",
"playerprogramselect",
"playerresolutionselect",
"playlist",
"playnext",
"playpause",
"playpvr",
"playpvrradio",
"playpvrtv",
"previouschannelgroup",
"previousmenu",
"previouspicture",
"previouspreset",
"previousscene",
"previousstereomode",
"prevletter",
"queue",
"randompreset",
"record",
"red",
"reloadkeymaps",
"rename",
"resetcalibration",
"rewind",
"right",
"rightclick",
"rotate",
"rotateccw",
"rotategesture",
"scanitem",
"screenshot",
"scrolldown",
"scrollup",
"select",
"setrating",
"settingslevelchange",
"settingsreset",
"shift",
"showpreset",
"showsubtitles",
"showtime",
"showtimerrule",
"showvideomenu",
"skipnext",
"skipprevious",
"smallstepback",
"stepback",
"stepforward",
"stereomode",
"stereomodetomono",
"stop",
"subtitlealign",
"subtitledelay",
"subtitledelayminus",
"subtitledelayplus",
"subtitleshiftdown",
"subtitleshiftup",
"swipedown",
"swipeleft",
"swiperight",
"swipeup",
"switchplayer",
"symbols",
"tap",
"togglecommskip",
"togglefont",
"togglefullscreen",
"togglestereomode",
"togglewatched",
"up",
"verticalshiftdown",
"verticalshiftup",
"videonextstream",
"voicerecognizer",
"volampdown",
"volampup",
"volumeamplification",
"volumedown",
"volumeup",
"wheeldown",
"wheelup",
"yellow",
"zoomgesture",
"zoomin",
"zoomlevel1",
"zoomlevel2",
"zoomlevel3",
"zoomlevel4",
"zoomlevel5",
"zoomlevel6",
"zoomlevel7",
"zoomlevel8",
"zoomlevel9",
"zoomnormal",
"zoomout"
],
"id": "Input.Action",
"type": "string"
}
</syntaxhighlight>}}
=== Item ===
==== Item.CustomProperties ====
'''Type:''' ''object''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": {
"$ref": "Global.String.NotEmpty",
"default": ""
},
"id": "Item.CustomProperties",
"type": "object"
}
</syntaxhighlight>}}
==== Item.Details.Base ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' label
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Item.Details.Base",
"properties": {
"label": {
"required": true,
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Item.Fields.Base ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Item.Fields.Base",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
</syntaxhighlight>}}
=== Library ===
==== Library.Details.Genre ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' genreid
* [''[[#Array.Integer|Array.Integer]]'' sourceid]
* [''string'' thumbnail]
* [''string'' title]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "Library.Details.Genre",
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
},
"sourceid": {
"$ref": "Array.Integer",
"description": "The ids of sources with songs of the genre"
},
"thumbnail": {
"default": "",
"type": "string"
},
"title": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Library.Details.Source ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' file
* [''[[#Array.String|Array.String]]'' paths]
* ''[[#Library.Id|Library.Id]]'' sourceid
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "Library.Details.Source",
"properties": {
"file": {
"description": "The url encoded multipath string combining all paths of the source ",
"required": true,
"type": "string"
},
"paths": {
"$ref": "Array.String",
"description": "The individual paths of the media source"
},
"sourceid": {
"$ref": "Library.Id",
"required": true
}
}
}
</syntaxhighlight>}}
==== Library.Details.Tag ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' tagid
* [''string'' title]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "Library.Details.Tag",
"properties": {
"tagid": {
"$ref": "Library.Id",
"required": true
},
"title": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Library.Fields.Genre ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Library.Fields.Genre",
"items": {
"enums": [
"title",
"thumbnail",
"sourceid"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Library.Fields.Source ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Library.Fields.Source",
"items": {
"enums": [
"file",
"paths"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Library.Fields.Tag ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Library.Fields.Tag",
"items": {
"enums": [
"title"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Library.Id ====
'''Type:''' ''integer''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": -1,
"id": "Library.Id",
"minimum": 1,
"type": "integer"
}
</syntaxhighlight>}}
=== List ===
==== List.Amount ====
'''Type:''' ''integer''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": -1,
"id": "List.Amount",
"minimum": 0,
"type": "integer"
}
</syntaxhighlight>}}
==== List.Fields.All ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "List.Fields.All",
"items": {
"enums": [
"title",
"artist",
"albumartist",
"genre",
"year",
"rating",
"album",
"track",
"duration",
"comment",
"lyrics",
"musicbrainztrackid",
"musicbrainzartistid",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"playcount",
"fanart",
"director",
"trailer",
"tagline",
"plot",
"plotoutline",
"originaltitle",
"lastplayed",
"writer",
"studio",
"mpaa",
"cast",
"country",
"imdbnumber",
"premiered",
"productioncode",
"runtime",
"set",
"showlink",
"streamdetails",
"top250",
"votes",
"firstaired",
"season",
"episode",
"showtitle",
"thumbnail",
"file",
"resume",
"artistid",
"albumid",
"tvshowid",
"setid",
"watchedepisodes",
"disc",
"tag",
"art",
"genreid",
"displayartist",
"albumartistid",
"description",
"theme",
"mood",
"style",
"albumlabel",
"sorttitle",
"episodeguide",
"uniqueid",
"dateadded",
"channel",
"channeltype",
"hidden",
"locked",
"channelnumber",
"subchannelnumber",
"starttime",
"endtime",
"specialsortseason",
"specialsortepisode",
"compilation",
"releasetype",
"albumreleasetype",
"contributors",
"displaycomposer",
"displayconductor",
"displayorchestra",
"displaylyricist",
"userrating",
"sortartist",
"musicbrainzreleasegroupid",
"mediapath",
"dynpath",
"isboxset",
"totaldiscs",
"disctitle",
"releasedate",
"originaldate",
"bpm",
"bitrate",
"samplerate",
"channels",
"albumstatus",
"datemodified",
"datenew",
"customproperties",
"albumduration"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== List.Fields.Files ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "List.Fields.Files",
"items": {
"enums": [
"title",
"artist",
"albumartist",
"genre",
"year",
"rating",
"album",
"track",
"duration",
"comment",
"lyrics",
"musicbrainztrackid",
"musicbrainzartistid",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"playcount",
"fanart",
"director",
"trailer",
"tagline",
"plot",
"plotoutline",
"originaltitle",
"lastplayed",
"writer",
"studio",
"mpaa",
"cast",
"country",
"imdbnumber",
"premiered",
"productioncode",
"runtime",
"set",
"showlink",
"streamdetails",
"top250",
"votes",
"firstaired",
"season",
"episode",
"showtitle",
"thumbnail",
"file",
"resume",
"artistid",
"albumid",
"tvshowid",
"setid",
"watchedepisodes",
"disc",
"tag",
"art",
"genreid",
"displayartist",
"albumartistid",
"description",
"theme",
"mood",
"style",
"albumlabel",
"sorttitle",
"episodeguide",
"uniqueid",
"dateadded",
"size",
"lastmodified",
"mimetype",
"specialsortseason",
"specialsortepisode",
"sortartist",
"musicbrainzreleasegroupid",
"isboxset",
"totaldiscs",
"disctitle",
"releasedate",
"originaldate",
"bpm",
"bitrate",
"samplerate",
"channels",
"datemodified",
"datenew",
"customproperties",
"albumduration"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== List.Filter.Albums ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.Albums",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.Albums"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.Albums"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Albums"
}
]
}
</syntaxhighlight>}}
==== List.Filter.Artists ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.Artists",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.Artists"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.Artists"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Artists"
}
]
}
</syntaxhighlight>}}
==== List.Filter.Episodes ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.Episodes",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.Episodes"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.Episodes"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Episodes"
}
]
}
</syntaxhighlight>}}
==== List.Filter.Fields.Albums ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "genre",
"enums": [
"genre",
"source",
"album",
"disctitle",
"totaldiscs",
"isboxset",
"artist",
"albumartist",
"year",
"originalyear",
"albumduration",
"review",
"themes",
"moods",
"styles",
"compilation",
"type",
"label",
"rating",
"userrating",
"playcount",
"lastplayed",
"path",
"albumstatus",
"dateadded",
"datemodified",
"datenew",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Albums",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Fields.Artists ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "artist",
"enums": [
"artist",
"source",
"genre",
"moods",
"styles",
"instruments",
"biography",
"artisttype",
"gender",
"disambiguation",
"born",
"bandformed",
"disbanded",
"died",
"role",
"path",
"dateadded",
"datemodified",
"datenew",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Artists",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Fields.Episodes ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "title",
"enums": [
"title",
"tvshow",
"originaltitle",
"plot",
"votes",
"rating",
"userrating",
"time",
"writers",
"airdate",
"playcount",
"lastplayed",
"inprogress",
"genre",
"year",
"director",
"actor",
"episode",
"season",
"filename",
"path",
"studio",
"mpaarating",
"dateadded",
"tag",
"videoresolution",
"audiochannels",
"audiocount",
"subtitlecount",
"videocodec",
"audiocodec",
"audiolanguage",
"subtitlelanguage",
"videoaspect",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Episodes",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Fields.Movies ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "title",
"enums": [
"title",
"originaltitle",
"plot",
"plotoutline",
"tagline",
"votes",
"rating",
"userrating",
"time",
"writers",
"playcount",
"lastplayed",
"inprogress",
"genre",
"country",
"year",
"director",
"actor",
"mpaarating",
"top250",
"studio",
"hastrailer",
"filename",
"path",
"set",
"tag",
"dateadded",
"videoresolution",
"audiochannels",
"audiocount",
"subtitlecount",
"videocodec",
"audiocodec",
"audiolanguage",
"subtitlelanguage",
"videoaspect",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Movies",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Fields.MusicVideos ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "title",
"enums": [
"title",
"genre",
"album",
"year",
"artist",
"filename",
"path",
"playcount",
"lastplayed",
"rating",
"userrating",
"time",
"director",
"studio",
"plot",
"tag",
"dateadded",
"videoresolution",
"audiochannels",
"audiocount",
"subtitlecount",
"videocodec",
"audiocodec",
"audiolanguage",
"subtitlelanguage",
"videoaspect",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.MusicVideos",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Fields.Songs ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "genre",
"enums": [
"genre",
"source",
"album",
"disctitle",
"artist",
"albumartist",
"title",
"year",
"originalyear",
"time",
"tracknumber",
"filename",
"path",
"playcount",
"lastplayed",
"rating",
"userrating",
"comment",
"moods",
"bpm",
"samplerate",
"bitrate",
"channels",
"dateadded",
"datemodified",
"datenew",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Songs",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Fields.TVShows ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "title",
"enums": [
"title",
"originaltitle",
"plot",
"status",
"votes",
"rating",
"userrating",
"year",
"genre",
"director",
"actor",
"numepisodes",
"numwatched",
"playcount",
"path",
"studio",
"mpaarating",
"dateadded",
"lastplayed",
"inprogress",
"tag",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.TVShows",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Fields.Textures ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "textureid",
"enums": [
"textureid",
"url",
"cachedurl",
"lasthashcheck",
"imagehash",
"width",
"height",
"usecount",
"lastused"
],
"id": "List.Filter.Fields.Textures",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Movies ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.Movies",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.Movies"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.Movies"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Movies"
}
]
}
</syntaxhighlight>}}
==== List.Filter.MusicVideos ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.MusicVideos",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.MusicVideos"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.MusicVideos"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.MusicVideos"
}
]
}
</syntaxhighlight>}}
==== List.Filter.Operators ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "contains",
"enums": [
"contains",
"doesnotcontain",
"is",
"isnot",
"startswith",
"endswith",
"greaterthan",
"lessthan",
"after",
"before",
"inthelast",
"notinthelast",
"true",
"false",
"between"
],
"id": "List.Filter.Operators",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Rule ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Operators|List.Filter.Operators]]'' operator
* ''mixed: string|array'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.Rule",
"properties": {
"operator": {
"$ref": "List.Filter.Operators",
"required": true
},
"value": {
"required": true,
"type": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"type": "object"
}
</syntaxhighlight>}}
==== List.Filter.Rule.Albums ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Albums|List.Filter.Fields.Albums]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Filter.Rule",
"id": "List.Filter.Rule.Albums",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Albums",
"required": true
}
}
}
</syntaxhighlight>}}
==== List.Filter.Rule.Artists ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Artists|List.Filter.Fields.Artists]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Filter.Rule",
"id": "List.Filter.Rule.Artists",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Artists",
"required": true
}
}
}
</syntaxhighlight>}}
==== List.Filter.Rule.Episodes ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Episodes|List.Filter.Fields.Episodes]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Filter.Rule",
"id": "List.Filter.Rule.Episodes",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Episodes",
"required": true
}
}
}
</syntaxhighlight>}}
==== List.Filter.Rule.Movies ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Movies|List.Filter.Fields.Movies]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Filter.Rule",
"id": "List.Filter.Rule.Movies",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Movies",
"required": true
}
}
}
</syntaxhighlight>}}
==== List.Filter.Rule.MusicVideos ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.MusicVideos|List.Filter.Fields.MusicVideos]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Filter.Rule",
"id": "List.Filter.Rule.MusicVideos",
"properties": {
"field": {
"$ref": "List.Filter.Fields.MusicVideos",
"required": true
}
}
}
</syntaxhighlight>}}
==== List.Filter.Rule.Songs ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Songs|List.Filter.Fields.Songs]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Filter.Rule",
"id": "List.Filter.Rule.Songs",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Songs",
"required": true
}
}
}
</syntaxhighlight>}}
==== List.Filter.Rule.TVShows ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.TVShows|List.Filter.Fields.TVShows]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Filter.Rule",
"id": "List.Filter.Rule.TVShows",
"properties": {
"field": {
"$ref": "List.Filter.Fields.TVShows",
"required": true
}
}
}
</syntaxhighlight>}}
==== List.Filter.Rule.Textures ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Textures|List.Filter.Fields.Textures]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Filter.Rule",
"id": "List.Filter.Rule.Textures",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Textures",
"required": true
}
}
}
</syntaxhighlight>}}
==== List.Filter.Songs ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.Songs",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.Songs"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.Songs"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Songs"
}
]
}
</syntaxhighlight>}}
==== List.Filter.TVShows ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.TVShows",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.TVShows"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.TVShows"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.TVShows"
}
]
}
</syntaxhighlight>}}
==== List.Filter.Textures ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.Textures",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.Textures"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.Textures"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Textures"
}
]
}
</syntaxhighlight>}}
==== List.Item.All ====
'''Extends:'''
* ''[[#List.Item.Base|List.Item.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' channel]
* [''integer'' channelnumber]
* [''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype = tv]
* [''string'' endtime]
* [''boolean'' hidden]
* [''boolean'' locked]
* [''string'' starttime]
* [''integer'' subchannelnumber]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Item.Base",
"id": "List.Item.All",
"properties": {
"channel": {
"default": "",
"type": "string"
},
"channelnumber": {
"default": 0,
"type": "integer"
},
"channeltype": {
"$ref": "PVR.Channel.Type",
"default": "tv"
},
"endtime": {
"default": "",
"type": "string"
},
"hidden": {
"default": false,
"type": "boolean"
},
"locked": {
"default": false,
"type": "boolean"
},
"starttime": {
"default": "",
"type": "string"
},
"subchannelnumber": {
"default": 0,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== List.Item.Base ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' album]
* [''[[#Array.String|Array.String]]'' albumartist]
* [''[[#Array.Integer|Array.Integer]]'' albumartistid]
* [''[[#Library.Id|Library.Id]]'' albumid = -1]
* [''string'' albumlabel]
* [''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' albumreleasetype = album]
* [''string'' albumstatus]
* [''integer'' bitrate]
* [''integer'' bpm]
* [''[[#Video.Cast|Video.Cast]]'' cast]
* [''integer'' channels]
* [''string'' comment]
* [''boolean'' compilation]
* [''[[#Audio.Contributors|Audio.Contributors]]'' contributors]
* [''[[#Array.String|Array.String]]'' country]
* [''[[#Item.CustomProperties|Item.CustomProperties]]'' customproperties]
* [''string'' description]
* [''integer'' disc]
* [''string'' disctitle]
* [''string'' displaycomposer]
* [''string'' displayconductor]
* [''string'' displaylyricist]
* [''string'' displayorchestra]
* [''integer'' duration]
* [''string'' dynpath]
* [''integer'' episode]
* [''string'' episodeguide]
* [''string'' firstaired]
* [''[[#Library.Id|Library.Id]]'' id = -1]
* [''string'' imdbnumber]
* [''boolean'' isboxset]
* [''string'' lyrics]
* [''string'' mediapath]
* [''[[#Array.String|Array.String]]'' mood]
* [''string'' mpaa]
* [''[[#Array.String|Array.String]]'' musicbrainzartistid]
* [''string'' musicbrainztrackid]
* [''string'' originaldate]
* [''string'' originaltitle]
* [''string'' plotoutline]
* [''string'' premiered]
* [''string'' productioncode]
* [''string'' releasedate]
* [''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' releasetype = album]
* [''integer'' samplerate]
* [''integer'' season]
* [''string'' set]
* [''[[#Library.Id|Library.Id]]'' setid = -1]
* [''[[#Array.String|Array.String]]'' showlink]
* [''string'' showtitle]
* [''string'' sorttitle]
* [''integer'' specialsortepisode]
* [''integer'' specialsortseason]
* [''[[#Array.String|Array.String]]'' studio]
* [''[[#Array.String|Array.String]]'' style]
* [''[[#Array.String|Array.String]]'' tag]
* [''string'' tagline]
* [''[[#Array.String|Array.String]]'' theme]
* [''integer'' top250]
* [''integer'' totaldiscs]
* [''integer'' track]
* [''string'' trailer]
* [''[[#Library.Id|Library.Id]]'' tvshowid = -1]
* [''string'' type = unknown]
* [''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid]
* [''string'' votes]
* [''integer'' watchedepisodes]
* [''[[#Array.String|Array.String]]'' writer]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": [
"Video.Details.File",
"Audio.Details.Media"
],
"id": "List.Item.Base",
"properties": {
"album": {
"default": "",
"type": "string"
},
"albumartist": {
"$ref": "Array.String"
},
"albumartistid": {
"$ref": "Array.Integer"
},
"albumid": {
"$ref": "Library.Id",
"default": -1
},
"albumlabel": {
"default": "",
"type": "string"
},
"albumreleasetype": {
"$ref": "Audio.Album.ReleaseType",
"default": "album"
},
"albumstatus": {
"default": "",
"type": "string"
},
"bitrate": {
"default": 0,
"type": "integer"
},
"bpm": {
"default": 0,
"type": "integer"
},
"cast": {
"$ref": "Video.Cast"
},
"channels": {
"default": 0,
"type": "integer"
},
"comment": {
"default": "",
"type": "string"
},
"compilation": {
"default": false,
"type": "boolean"
},
"contributors": {
"$ref": "Audio.Contributors"
},
"country": {
"$ref": "Array.String"
},
"customproperties": {
"$ref": "Item.CustomProperties"
},
"description": {
"default": "",
"type": "string"
},
"disc": {
"default": 0,
"type": "integer"
},
"disctitle": {
"default": "",
"type": "string"
},
"displaycomposer": {
"default": "",
"type": "string"
},
"displayconductor": {
"default": "",
"type": "string"
},
"displaylyricist": {
"default": "",
"type": "string"
},
"displayorchestra": {
"default": "",
"type": "string"
},
"duration": {
"default": 0,
"type": "integer"
},
"dynpath": {
"default": "",
"description": "An experimental property for debug purposes, often same as mediapath but when different gives the actual file playing that should also be in file property",
"type": "string"
},
"episode": {
"default": 0,
"type": "integer"
},
"episodeguide": {
"default": "",
"type": "string"
},
"firstaired": {
"default": "",
"type": "string"
},
"id": {
"$ref": "Library.Id",
"default": -1
},
"imdbnumber": {
"default": "",
"type": "string"
},
"isboxset": {
"default": false,
"type": "boolean"
},
"lyrics": {
"default": "",
"type": "string"
},
"mediapath": {
"default": "",
"description": "Media source path that identifies the item",
"type": "string"
},
"mood": {
"$ref": "Array.String"
},
"mpaa": {
"default": "",
"type": "string"
},
"musicbrainzartistid": {
"$ref": "Array.String"
},
"musicbrainztrackid": {
"default": "",
"type": "string"
},
"originaldate": {
"default": "",
"type": "string"
},
"originaltitle": {
"default": "",
"type": "string"
},
"plotoutline": {
"default": "",
"type": "string"
},
"premiered": {
"default": "",
"type": "string"
},
"productioncode": {
"default": "",
"type": "string"
},
"releasedate": {
"default": "",
"type": "string"
},
"releasetype": {
"$ref": "Audio.Album.ReleaseType",
"default": "album"
},
"samplerate": {
"default": 0,
"type": "integer"
},
"season": {
"default": 0,
"type": "integer"
},
"set": {
"default": "",
"type": "string"
},
"setid": {
"$ref": "Library.Id",
"default": -1
},
"showlink": {
"$ref": "Array.String"
},
"showtitle": {
"default": "",
"type": "string"
},
"sorttitle": {
"default": "",
"type": "string"
},
"specialsortepisode": {
"default": 0,
"type": "integer"
},
"specialsortseason": {
"default": 0,
"type": "integer"
},
"studio": {
"$ref": "Array.String"
},
"style": {
"$ref": "Array.String"
},
"tag": {
"$ref": "Array.String"
},
"tagline": {
"default": "",
"type": "string"
},
"theme": {
"$ref": "Array.String"
},
"top250": {
"default": 0,
"type": "integer"
},
"totaldiscs": {
"default": 0,
"type": "integer"
},
"track": {
"default": 0,
"type": "integer"
},
"trailer": {
"default": "",
"type": "string"
},
"tvshowid": {
"$ref": "Library.Id",
"default": -1
},
"type": {
"default": "unknown",
"enums": [
"unknown",
"movie",
"episode",
"musicvideo",
"song",
"picture",
"channel"
],
"type": "string"
},
"uniqueid": {
"$ref": "Media.UniqueID"
},
"votes": {
"default": "",
"type": "string"
},
"watchedepisodes": {
"default": 0,
"type": "integer"
},
"writer": {
"$ref": "Array.String"
}
}
}
</syntaxhighlight>}}
==== List.Item.File ====
'''Extends:'''
* ''[[#List.Item.Base|List.Item.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' file
* ''string'' filetype
* [''string'' lastmodified]
* [''string'' mimetype]
* [''integer'' size]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Item.Base",
"id": "List.Item.File",
"properties": {
"file": {
"required": true,
"type": "string"
},
"filetype": {
"enums": [
"file",
"directory"
],
"required": true,
"type": "string"
},
"lastmodified": {
"default": "",
"type": "string"
},
"mimetype": {
"default": "",
"type": "string"
},
"size": {
"default": 0,
"description": "Size of the file in bytes",
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== List.Items.Sources ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Items.Sources",
"items": {
"extends": "Item.Details.Base",
"properties": {
"file": {
"required": true,
"type": "string"
}
}
},
"type": "array"
}
</syntaxhighlight>}}
==== List.Limits ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#List.Amount|List.Amount]]'' end = -1]
* [''integer'' start]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"id": "List.Limits",
"properties": {
"end": {
"$ref": "List.Amount",
"default": -1,
"description": "Index of the last item to return"
},
"start": {
"default": 0,
"description": "Index of the first item to return",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== List.LimitsReturned ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#List.Amount|List.Amount]]'' end = -1]
* [''integer'' start]
* ''integer'' total
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"id": "List.LimitsReturned",
"properties": {
"end": {
"$ref": "List.Amount",
"default": -1
},
"start": {
"default": 0,
"minimum": 0,
"type": "integer"
},
"total": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== List.Sort ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''boolean'' ignorearticle]
* [''string'' method = none]
* [''string'' order = ascending]
* [''boolean'' useartistsortname]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Sort",
"properties": {
"ignorearticle": {
"default": false,
"type": "boolean"
},
"method": {
"default": "none",
"enums": [
"none",
"label",
"date",
"size",
"file",
"path",
"drivetype",
"title",
"track",
"time",
"artist",
"album",
"albumtype",
"genre",
"country",
"year",
"rating",
"userrating",
"votes",
"top250",
"programcount",
"playlist",
"episode",
"season",
"totalepisodes",
"watchedepisodes",
"tvshowstatus",
"tvshowtitle",
"sorttitle",
"productioncode",
"mpaa",
"studio",
"dateadded",
"lastplayed",
"playcount",
"listeners",
"bitrate",
"random",
"totaldiscs",
"originaldate",
"bpm"
],
"type": "string"
},
"order": {
"default": "ascending",
"enums": [
"ascending",
"descending"
],
"type": "string"
},
"useartistsortname": {
"default": false,
"type": "boolean"
}
},
"type": "object"
}
</syntaxhighlight>}}
=== Media ===
==== Media.Artwork ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' banner]
* [''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' fanart]
* [''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' poster]
* [''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' thumb]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": {
"$ref": "Global.String.NotEmpty",
"default": ""
},
"id": "Media.Artwork",
"properties": {
"banner": {
"$ref": "Global.String.NotEmpty",
"default": ""
},
"fanart": {
"$ref": "Global.String.NotEmpty",
"default": ""
},
"poster": {
"$ref": "Global.String.NotEmpty",
"default": ""
},
"thumb": {
"$ref": "Global.String.NotEmpty",
"default": ""
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Media.Artwork.Set ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''mixed: null|[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' banner]
* [''mixed: null|[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' fanart]
* [''mixed: null|[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' poster]
* [''mixed: null|[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' thumb]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": {
"default": null,
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
]
},
"id": "Media.Artwork.Set",
"properties": {
"banner": {
"default": "",
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
]
},
"fanart": {
"default": "",
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
]
},
"poster": {
"default": "",
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
]
},
"thumb": {
"default": "",
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
]
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Media.Details.Base ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' fanart]
* [''string'' thumbnail]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "Media.Details.Base",
"properties": {
"fanart": {
"default": "",
"type": "string"
},
"thumbnail": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Media.UniqueID ====
'''Type:''' ''object''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": {
"$ref": "Global.String.NotEmpty",
"default": ""
},
"id": "Media.UniqueID",
"type": "object"
}
</syntaxhighlight>}}
==== Media.UniqueID.Set ====
'''Type:''' ''object''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": {
"default": null,
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
]
},
"id": "Media.UniqueID.Set",
"type": "object"
}
</syntaxhighlight>}}
=== Notifications ===
==== Notifications.Item ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Notifications.Item",
"type": [
{
"description": "An unknown item does not have any additional information.",
"properties": {
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
},
{
"description": "An item known to the database has an identification.",
"properties": {
"id": {
"$ref": "Library.Id",
"required": true
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
},
{
"description": "A movie item has a title and may have a release year.",
"properties": {
"title": {
"required": true,
"type": "string"
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
},
"year": {
"default": 0,
"type": "integer"
}
},
"type": "object"
},
{
"description": "A tv episode has a title and may have an episode number, season number and the title of the show it belongs to.",
"properties": {
"episode": {
"default": 0,
"type": "integer"
},
"season": {
"default": 0,
"type": "integer"
},
"showtitle": {
"default": "",
"type": "string"
},
"title": {
"required": true,
"type": "string"
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
},
{
"description": "A music video has a title and may have an album and an artist.",
"properties": {
"album": {
"default": "",
"type": "string"
},
"artist": {
"default": "",
"type": "string"
},
"title": {
"required": true,
"type": "string"
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
},
{
"description": "A song has a title and may have an album, an artist and a track number.",
"properties": {
"album": {
"default": "",
"type": "string"
},
"artist": {
"default": "",
"type": "string"
},
"title": {
"required": true,
"type": "string"
},
"track": {
"default": 0,
"type": "integer"
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
},
{
"description": "A picture has a file path.",
"properties": {
"file": {
"required": true,
"type": "string"
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
},
{
"description": "A PVR channel is either a radio or tv channel and has a title.",
"properties": {
"channeltype": {
"$ref": "PVR.Channel.Type",
"required": true
},
"id": {
"$ref": "Library.Id",
"required": true
},
"title": {
"required": true,
"type": "string"
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
}
]
}
</syntaxhighlight>}}
==== Notifications.Item.Type ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "unknown",
"enums": [
"unknown",
"movie",
"episode",
"musicvideo",
"song",
"picture",
"channel"
],
"id": "Notifications.Item.Type",
"type": "string"
}
</syntaxhighlight>}}
=== Optional ===
==== Optional.Boolean ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": null,
"id": "Optional.Boolean",
"type": [
{
"type": "null"
},
{
"type": "boolean"
}
]
}
</syntaxhighlight>}}
==== Optional.Integer ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": null,
"id": "Optional.Integer",
"type": [
{
"type": "null"
},
{
"type": "integer"
}
]
}
</syntaxhighlight>}}
==== Optional.Number ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": null,
"id": "Optional.Number",
"type": [
{
"type": "null"
},
{
"type": "number"
}
]
}
</syntaxhighlight>}}
==== Optional.String ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": null,
"id": "Optional.String",
"type": [
{
"type": "null"
},
{
"type": "string"
}
]
}
</syntaxhighlight>}}
=== PVR ===
==== PVR.Channel.Type ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "tv",
"enums": [
"tv",
"radio"
],
"id": "PVR.Channel.Type",
"type": "string"
}
</syntaxhighlight>}}
==== PVR.ChannelGroup.Id ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": null,
"id": "PVR.ChannelGroup.Id",
"type": [
{
"$ref": "Library.Id"
},
{
"enums": [
"alltv",
"allradio"
],
"type": "string"
}
]
}
</syntaxhighlight>}}
==== PVR.Details.Broadcast ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' broadcastid
* [''string'' cast]
* [''[[#Library.Id|Library.Id]]'' clientid = -1]
* [''string'' director]
* [''string'' endtime]
* [''string'' episodename]
* [''integer'' episodenum]
* [''integer'' episodepart]
* [''string'' firstaired]
* [''string'' genre]
* [''boolean'' hasrecording]
* [''boolean'' hasreminder]
* [''boolean'' hastimer]
* [''boolean'' hastimerrule]
* [''integer'' imdbnumber]
* [''boolean'' isactive]
* [''boolean'' isplayable]
* [''boolean'' isseries]
* [''string'' originaltitle]
* [''integer'' parentalrating]
* [''string'' plot]
* [''string'' plotoutline]
* [''integer'' progress]
* [''number'' progresspercentage]
* [''integer'' rating]
* [''string'' recording]
* [''integer'' runtime]
* [''string'' starttime]
* [''string'' thumbnail]
* [''string'' title]
* [''boolean'' wasactive]
* [''string'' writer]
* [''integer'' year]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "PVR.Details.Broadcast",
"properties": {
"broadcastid": {
"$ref": "Library.Id",
"required": true
},
"cast": {
"default": "",
"type": "string"
},
"clientid": {
"$ref": "Library.Id",
"default": -1
},
"director": {
"default": "",
"type": "string"
},
"endtime": {
"default": "",
"type": "string"
},
"episodename": {
"default": "",
"type": "string"
},
"episodenum": {
"default": 0,
"type": "integer"
},
"episodepart": {
"default": 0,
"type": "integer"
},
"firstaired": {
"default": "",
"type": "string"
},
"genre": {
"default": "",
"type": "string"
},
"hasrecording": {
"default": false,
"type": "boolean"
},
"hasreminder": {
"default": false,
"type": "boolean"
},
"hastimer": {
"default": false,
"type": "boolean"
},
"hastimerrule": {
"default": false,
"type": "boolean"
},
"imdbnumber": {
"default": 0,
"type": "integer"
},
"isactive": {
"default": false,
"type": "boolean"
},
"isplayable": {
"default": false,
"description": "Deprecated - Use GetBroadcastIsPlayable instead",
"type": "boolean"
},
"isseries": {
"default": false,
"type": "boolean"
},
"originaltitle": {
"default": "",
"type": "string"
},
"parentalrating": {
"default": 0,
"type": "integer"
},
"plot": {
"default": "",
"type": "string"
},
"plotoutline": {
"default": "",
"type": "string"
},
"progress": {
"default": 0,
"type": "integer"
},
"progresspercentage": {
"default": 0.0,
"type": "number"
},
"rating": {
"default": 0,
"type": "integer"
},
"recording": {
"default": "",
"type": "string"
},
"runtime": {
"default": 0,
"type": "integer"
},
"starttime": {
"default": "",
"type": "string"
},
"thumbnail": {
"default": "",
"type": "string"
},
"title": {
"default": "",
"type": "string"
},
"wasactive": {
"default": false,
"type": "boolean"
},
"writer": {
"default": "",
"type": "string"
},
"year": {
"default": 0,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== PVR.Details.Channel ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#PVR.Details.Broadcast|PVR.Details.Broadcast]]'' broadcastnext]
* [''[[#PVR.Details.Broadcast|PVR.Details.Broadcast]]'' broadcastnow]
* [''string'' channel]
* ''[[#Library.Id|Library.Id]]'' channelid
* [''integer'' channelnumber]
* [''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype = tv]
* [''[[#Library.Id|Library.Id]]'' clientid = -1]
* [''boolean'' hasarchive]
* [''boolean'' hidden]
* [''string'' icon]
* [''boolean'' isrecording]
* [''string'' lastplayed]
* [''boolean'' locked]
* [''integer'' subchannelnumber]
* [''string'' thumbnail]
* ''integer'' uniqueid
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "PVR.Details.Channel",
"properties": {
"broadcastnext": {
"$ref": "PVR.Details.Broadcast"
},
"broadcastnow": {
"$ref": "PVR.Details.Broadcast"
},
"channel": {
"default": "",
"type": "string"
},
"channelid": {
"$ref": "Library.Id",
"required": true
},
"channelnumber": {
"default": 0,
"type": "integer"
},
"channeltype": {
"$ref": "PVR.Channel.Type",
"default": "tv"
},
"clientid": {
"$ref": "Library.Id",
"default": -1
},
"hasarchive": {
"default": false,
"type": "boolean"
},
"hidden": {
"default": false,
"type": "boolean"
},
"icon": {
"default": "",
"type": "string"
},
"isrecording": {
"default": false,
"type": "boolean"
},
"lastplayed": {
"default": "",
"type": "string"
},
"locked": {
"default": false,
"type": "boolean"
},
"subchannelnumber": {
"default": 0,
"type": "integer"
},
"thumbnail": {
"default": "",
"type": "string"
},
"uniqueid": {
"required": true,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== PVR.Details.ChannelGroup ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' channelgroupid
* ''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "PVR.Details.ChannelGroup",
"properties": {
"channelgroupid": {
"$ref": "Library.Id",
"required": true
},
"channeltype": {
"$ref": "PVR.Channel.Type",
"required": true
}
}
}
</syntaxhighlight>}}
==== PVR.Details.ChannelGroup.Extended ====
'''Extends:'''
* ''[[#PVR.Details.ChannelGroup|PVR.Details.ChannelGroup]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''array'' channels]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "PVR.Details.ChannelGroup",
"id": "PVR.Details.ChannelGroup.Extended",
"properties": {
"channels": {
"items": {
"$ref": "PVR.Details.Channel"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
</syntaxhighlight>}}
==== PVR.Details.Client ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' addonid]
* ''[[#Library.Id|Library.Id]]'' clientid
* [''boolean'' supportschannelgroups]
* [''boolean'' supportschannelscan]
* [''boolean'' supportsepg]
* [''boolean'' supportsradio]
* [''boolean'' supportsrecordings]
* [''boolean'' supportstimers]
* [''boolean'' supportstv]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "PVR.Details.Client",
"properties": {
"addonid": {
"default": "",
"type": "string"
},
"clientid": {
"$ref": "Library.Id",
"required": true
},
"supportschannelgroups": {
"default": false,
"type": "boolean"
},
"supportschannelscan": {
"default": false,
"type": "boolean"
},
"supportsepg": {
"default": false,
"type": "boolean"
},
"supportsradio": {
"default": false,
"type": "boolean"
},
"supportsrecordings": {
"default": false,
"type": "boolean"
},
"supportstimers": {
"default": false,
"type": "boolean"
},
"supportstv": {
"default": false,
"type": "boolean"
}
}
}
</syntaxhighlight>}}
==== PVR.Details.Recording ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Media.Artwork|Media.Artwork]]'' art]
* [''string'' channel]
* [''integer'' channeluid]
* [''[[#Library.Id|Library.Id]]'' clientid = -1]
* [''string'' directory]
* [''string'' endtime]
* [''integer'' epgeventid]
* [''integer'' episode]
* [''string'' file]
* [''string'' genre]
* [''string'' icon]
* [''boolean'' isdeleted]
* [''integer'' lifetime]
* [''integer'' playcount]
* [''string'' plot]
* [''string'' plotoutline]
* [''boolean'' radio]
* ''[[#Library.Id|Library.Id]]'' recordingid
* [''[[#Video.Resume|Video.Resume]]'' resume]
* [''integer'' runtime]
* [''integer'' season]
* [''string'' showtitle]
* [''string'' starttime]
* [''string'' streamurl]
* [''string'' title]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "PVR.Details.Recording",
"properties": {
"art": {
"$ref": "Media.Artwork"
},
"channel": {
"default": "",
"type": "string"
},
"channeluid": {
"default": 0,
"type": "integer"
},
"clientid": {
"$ref": "Library.Id",
"default": -1
},
"directory": {
"default": "",
"type": "string"
},
"endtime": {
"default": "",
"type": "string"
},
"epgeventid": {
"default": 0,
"type": "integer"
},
"episode": {
"default": 0,
"type": "integer"
},
"file": {
"default": "",
"type": "string"
},
"genre": {
"default": "",
"type": "string"
},
"icon": {
"default": "",
"type": "string"
},
"isdeleted": {
"default": false,
"type": "boolean"
},
"lifetime": {
"default": 0,
"type": "integer"
},
"playcount": {
"default": 0,
"type": "integer"
},
"plot": {
"default": "",
"type": "string"
},
"plotoutline": {
"default": "",
"type": "string"
},
"radio": {
"default": false,
"type": "boolean"
},
"recordingid": {
"$ref": "Library.Id",
"required": true
},
"resume": {
"$ref": "Video.Resume"
},
"runtime": {
"default": 0,
"type": "integer"
},
"season": {
"default": 0,
"type": "integer"
},
"showtitle": {
"default": "",
"type": "string"
},
"starttime": {
"default": "",
"type": "string"
},
"streamurl": {
"default": "",
"type": "string"
},
"title": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== PVR.Details.Timer ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Library.Id|Library.Id]]'' broadcastid = -1]
* [''[[#Library.Id|Library.Id]]'' channelid = -1]
* [''[[#Library.Id|Library.Id]]'' clientid = -1]
* [''string'' directory]
* [''boolean'' endanytime]
* [''integer'' endmargin]
* [''string'' endtime]
* [''string'' epgsearchstring]
* [''integer'' epguid]
* [''string'' file]
* [''string'' firstday]
* [''boolean'' fulltextepgsearch]
* [''boolean'' ismanual]
* [''boolean'' isradio]
* [''boolean'' isreadonly]
* [''boolean'' isreminder]
* [''boolean'' istimerrule]
* [''integer'' lifetime]
* [''integer'' maxrecordings]
* [''integer'' preventduplicateepisodes]
* [''integer'' priority]
* [''integer'' recordinggroup]
* [''integer'' runtime]
* [''boolean'' startanytime]
* [''integer'' startmargin]
* [''string'' starttime]
* [''[[#PVR.TimerState|PVR.TimerState]]'' state = unknown]
* [''string'' summary]
* ''[[#Library.Id|Library.Id]]'' timerid
* [''string'' title]
* [''array'' weekdays]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "PVR.Details.Timer",
"properties": {
"broadcastid": {
"$ref": "Library.Id",
"default": -1
},
"channelid": {
"$ref": "Library.Id",
"default": -1
},
"clientid": {
"$ref": "Library.Id",
"default": -1
},
"directory": {
"default": "",
"type": "string"
},
"endanytime": {
"default": false,
"type": "boolean"
},
"endmargin": {
"default": 0,
"type": "integer"
},
"endtime": {
"default": "",
"type": "string"
},
"epgsearchstring": {
"default": "",
"type": "string"
},
"epguid": {
"default": 0,
"type": "integer"
},
"file": {
"default": "",
"type": "string"
},
"firstday": {
"default": "",
"type": "string"
},
"fulltextepgsearch": {
"default": false,
"type": "boolean"
},
"ismanual": {
"default": false,
"type": "boolean"
},
"isradio": {
"default": false,
"type": "boolean"
},
"isreadonly": {
"default": false,
"type": "boolean"
},
"isreminder": {
"default": false,
"type": "boolean"
},
"istimerrule": {
"default": false,
"type": "boolean"
},
"lifetime": {
"default": 0,
"type": "integer"
},
"maxrecordings": {
"default": 0,
"type": "integer"
},
"preventduplicateepisodes": {
"default": 0,
"type": "integer"
},
"priority": {
"default": 0,
"type": "integer"
},
"recordinggroup": {
"default": 0,
"type": "integer"
},
"runtime": {
"default": 0,
"type": "integer"
},
"startanytime": {
"default": false,
"type": "boolean"
},
"startmargin": {
"default": 0,
"type": "integer"
},
"starttime": {
"default": "",
"type": "string"
},
"state": {
"$ref": "PVR.TimerState",
"default": "unknown"
},
"summary": {
"default": "",
"type": "string"
},
"timerid": {
"$ref": "Library.Id",
"required": true
},
"title": {
"default": "",
"type": "string"
},
"weekdays": {
"items": {
"$ref": "Global.Weekday"
},
"type": "array",
"uniqueItems": true
}
}
}
</syntaxhighlight>}}
==== PVR.Fields.Broadcast ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "PVR.Fields.Broadcast",
"items": {
"enums": [
"title",
"plot",
"plotoutline",
"starttime",
"endtime",
"runtime",
"progress",
"progresspercentage",
"genre",
"episodename",
"episodenum",
"episodepart",
"firstaired",
"hastimer",
"isactive",
"parentalrating",
"wasactive",
"thumbnail",
"rating",
"originaltitle",
"cast",
"director",
"writer",
"year",
"imdbnumber",
"hastimerrule",
"hasrecording",
"recording",
"isseries",
"isplayable",
"clientid",
"hasreminder"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== PVR.Fields.Channel ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "PVR.Fields.Channel",
"items": {
"enums": [
"thumbnail",
"channeltype",
"hidden",
"locked",
"channel",
"lastplayed",
"broadcastnow",
"broadcastnext",
"uniqueid",
"icon",
"channelnumber",
"subchannelnumber",
"isrecording",
"hasarchive",
"clientid"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== PVR.Fields.Client ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "PVR.Fields.Client",
"items": {
"enums": [
"addonid",
"supportstv",
"supportsradio",
"supportsepg",
"supportsrecordings",
"supportstimers",
"supportschannelgroups",
"supportschannelscan"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== PVR.Fields.Recording ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "PVR.Fields.Recording",
"items": {
"enums": [
"title",
"plot",
"plotoutline",
"genre",
"playcount",
"resume",
"channel",
"starttime",
"endtime",
"runtime",
"lifetime",
"icon",
"art",
"streamurl",
"file",
"directory",
"radio",
"isdeleted",
"epgeventid",
"channeluid",
"season",
"episode",
"showtitle",
"clientid"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== PVR.Fields.Timer ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "PVR.Fields.Timer",
"items": {
"enums": [
"title",
"summary",
"channelid",
"isradio",
"istimerrule",
"ismanual",
"starttime",
"endtime",
"runtime",
"lifetime",
"firstday",
"weekdays",
"priority",
"startmargin",
"endmargin",
"state",
"file",
"directory",
"preventduplicateepisodes",
"startanytime",
"endanytime",
"epgsearchstring",
"fulltextepgsearch",
"recordinggroup",
"maxrecordings",
"epguid",
"isreadonly",
"isreminder",
"clientid",
"broadcastid"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== PVR.Property.Name ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "available",
"enums": [
"available",
"recording",
"scanning"
],
"id": "PVR.Property.Name",
"type": "string"
}
</syntaxhighlight>}}
==== PVR.Property.Value ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''boolean'' available]
* [''boolean'' recording]
* [''boolean'' scanning]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "PVR.Property.Value",
"properties": {
"available": {
"default": false,
"type": "boolean"
},
"recording": {
"default": false,
"type": "boolean"
},
"scanning": {
"default": false,
"type": "boolean"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== PVR.TimerState ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "unknown",
"enums": [
"unknown",
"new",
"scheduled",
"recording",
"completed",
"aborted",
"cancelled",
"conflict_ok",
"conflict_notok",
"error",
"disabled"
],
"id": "PVR.TimerState",
"type": "string"
}
</syntaxhighlight>}}
=== Player ===
==== Player.Audio.Stream ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''integer'' bitrate
* ''integer'' channels
* ''string'' codec
* ''integer'' index
* ''boolean'' isdefault
* ''boolean'' isimpaired
* ''boolean'' isoriginal
* ''string'' language
* ''string'' name
* ''integer'' samplerate
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.Audio.Stream",
"properties": {
"bitrate": {
"required": true,
"type": "integer"
},
"channels": {
"required": true,
"type": "integer"
},
"codec": {
"required": true,
"type": "string"
},
"index": {
"minimum": 0,
"required": true,
"type": "integer"
},
"isdefault": {
"required": true,
"type": "boolean"
},
"isimpaired": {
"required": true,
"type": "boolean"
},
"isoriginal": {
"required": true,
"type": "boolean"
},
"language": {
"required": true,
"type": "string"
},
"name": {
"required": true,
"type": "string"
},
"samplerate": {
"required": true,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Player.CustomViewMode ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''mixed: string|[[#Optional.Boolean|Optional.Boolean]]'' nonlinearstretch]
* [''mixed: string|[[#Optional.Number|Optional.Number]]'' pixelratio]
* [''mixed: string|[[#Optional.Number|Optional.Number]]'' verticalshift]
* [''mixed: string|[[#Optional.Number|Optional.Number]]'' zoom]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.CustomViewMode",
"properties": {
"nonlinearstretch": {
"default": null,
"type": [
{
"enums": [
"increase",
"decrease"
],
"type": "string"
},
{
"$ref": "Optional.Boolean",
"description": "Flag to enable nonlinear stretch"
}
]
},
"pixelratio": {
"default": null,
"type": [
{
"enums": [
"increase",
"decrease"
],
"type": "string"
},
{
"$ref": "Optional.Number",
"description": "Pixel aspect ratio where 1.0 means square pixel"
}
]
},
"verticalshift": {
"default": null,
"type": [
{
"enums": [
"increase",
"decrease"
],
"type": "string"
},
{
"$ref": "Optional.Number",
"description": "Vertical shift 1.0 means shift to bottom"
}
]
},
"zoom": {
"default": null,
"type": [
{
"enums": [
"increase",
"decrease"
],
"type": "string"
},
{
"$ref": "Optional.Number",
"description": "Zoom where 1.0 means 100%"
}
]
}
},
"required": true,
"type": "object"
}
</syntaxhighlight>}}
==== Player.Id ====
'''Type:''' ''integer''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": -1,
"id": "Player.Id",
"maximum": 2,
"minimum": 0,
"type": "integer"
}
</syntaxhighlight>}}
==== Player.Notifications.Data ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Notifications.Item|Notifications.Item]]'' item
* ''[[#Player.Notifications.Player|Player.Notifications.Player]]'' player
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.Notifications.Data",
"properties": {
"item": {
"$ref": "Notifications.Item",
"required": true
},
"player": {
"$ref": "Player.Notifications.Player",
"required": true
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Player.Notifications.Player ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Player.Id|Player.Id]]'' playerid
* [''integer'' speed]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.Notifications.Player",
"properties": {
"playerid": {
"$ref": "Player.Id",
"required": true
},
"speed": {
"default": 0,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Player.Notifications.Player.Seek ====
'''Extends:'''
* ''[[#Player.Notifications.Player|Player.Notifications.Player]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Global.Time|Global.Time]]'' seekoffset]
* [''[[#Global.Time|Global.Time]]'' time]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Player.Notifications.Player",
"id": "Player.Notifications.Player.Seek",
"properties": {
"seekoffset": {
"$ref": "Global.Time",
"description": "A duration."
},
"time": {
"$ref": "Global.Time",
"description": "A duration."
}
}
}
</syntaxhighlight>}}
==== Player.Position.Percentage ====
'''Type:''' ''number''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": 0.0,
"id": "Player.Position.Percentage",
"maximum": 100.0,
"minimum": 0.0,
"type": "number"
}
</syntaxhighlight>}}
==== Player.Position.Time ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''integer'' hours]
* [''integer'' milliseconds]
* [''integer'' minutes]
* [''integer'' seconds]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"description": "A position in duration.",
"id": "Player.Position.Time",
"properties": {
"hours": {
"default": 0,
"minimum": 0,
"type": "integer"
},
"milliseconds": {
"default": 0,
"maximum": 999,
"minimum": 0,
"type": "integer"
},
"minutes": {
"default": 0,
"maximum": 59,
"minimum": 0,
"type": "integer"
},
"seconds": {
"default": 0,
"maximum": 59,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Player.Property.Name ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "type",
"enums": [
"type",
"partymode",
"speed",
"time",
"percentage",
"totaltime",
"playlistid",
"position",
"repeat",
"shuffled",
"canseek",
"canchangespeed",
"canmove",
"canzoom",
"canrotate",
"canshuffle",
"canrepeat",
"currentaudiostream",
"audiostreams",
"subtitleenabled",
"currentsubtitle",
"subtitles",
"live",
"currentvideostream",
"videostreams",
"cachepercentage"
],
"id": "Player.Property.Name",
"type": "string"
}
</syntaxhighlight>}}
==== Player.Property.Value ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''array'' audiostreams]
* [''[[#Player.Position.Percentage|Player.Position.Percentage]]'' cachepercentage]
* [''boolean'' canchangespeed]
* [''boolean'' canmove]
* [''boolean'' canrepeat]
* [''boolean'' canrotate]
* [''boolean'' canseek]
* [''boolean'' canshuffle]
* [''boolean'' canzoom]
* [''[[#Player.Audio.Stream|Player.Audio.Stream]]'' currentaudiostream]
* [''[[#Player.Subtitle|Player.Subtitle]]'' currentsubtitle]
* [''[[#Player.Video.Stream|Player.Video.Stream]]'' currentvideostream]
* [''boolean'' live]
* [''boolean'' partymode]
* [''[[#Player.Position.Percentage|Player.Position.Percentage]]'' percentage]
* [''[[#Playlist.Id|Playlist.Id]]'' playlistid = -1]
* [''[[#Playlist.Position|Playlist.Position]]'' position = -1]
* [''[[#Player.Repeat|Player.Repeat]]'' repeat = off]
* [''boolean'' shuffled]
* [''integer'' speed]
* [''boolean'' subtitleenabled]
* [''array'' subtitles]
* [''[[#Global.Time|Global.Time]]'' time]
* [''[[#Global.Time|Global.Time]]'' totaltime]
* [''[[#Player.Type|Player.Type]]'' type = video]
* [''array'' videostreams]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.Property.Value",
"properties": {
"audiostreams": {
"items": {
"$ref": "Player.Audio.Stream"
},
"type": "array"
},
"cachepercentage": {
"$ref": "Player.Position.Percentage",
"default": 0.0
},
"canchangespeed": {
"default": false,
"type": "boolean"
},
"canmove": {
"default": false,
"type": "boolean"
},
"canrepeat": {
"default": false,
"type": "boolean"
},
"canrotate": {
"default": false,
"type": "boolean"
},
"canseek": {
"default": false,
"type": "boolean"
},
"canshuffle": {
"default": false,
"type": "boolean"
},
"canzoom": {
"default": false,
"type": "boolean"
},
"currentaudiostream": {
"$ref": "Player.Audio.Stream"
},
"currentsubtitle": {
"$ref": "Player.Subtitle"
},
"currentvideostream": {
"$ref": "Player.Video.Stream"
},
"live": {
"default": false,
"type": "boolean"
},
"partymode": {
"default": false,
"type": "boolean"
},
"percentage": {
"$ref": "Player.Position.Percentage",
"default": 0.0
},
"playlistid": {
"$ref": "Playlist.Id",
"default": -1
},
"position": {
"$ref": "Playlist.Position",
"default": -1
},
"repeat": {
"$ref": "Player.Repeat",
"default": "off"
},
"shuffled": {
"default": false,
"type": "boolean"
},
"speed": {
"default": 0,
"type": "integer"
},
"subtitleenabled": {
"default": false,
"type": "boolean"
},
"subtitles": {
"items": {
"$ref": "Player.Subtitle"
},
"type": "array"
},
"time": {
"$ref": "Global.Time",
"description": "A duration."
},
"totaltime": {
"$ref": "Global.Time",
"description": "A duration."
},
"type": {
"$ref": "Player.Type",
"default": "video"
},
"videostreams": {
"items": {
"$ref": "Player.Video.Stream"
},
"type": "array"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Player.Repeat ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "off",
"enums": [
"off",
"one",
"all"
],
"id": "Player.Repeat",
"type": "string"
}
</syntaxhighlight>}}
==== Player.Speed ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''integer'' speed]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.Speed",
"properties": {
"speed": {
"default": 0,
"type": "integer"
}
},
"required": true,
"type": "object"
}
</syntaxhighlight>}}
==== Player.Subtitle ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''integer'' index
* ''boolean'' isdefault
* ''boolean'' isforced
* ''boolean'' isimpaired
* ''string'' language
* ''string'' name
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.Subtitle",
"properties": {
"index": {
"minimum": 0,
"required": true,
"type": "integer"
},
"isdefault": {
"required": true,
"type": "boolean"
},
"isforced": {
"required": true,
"type": "boolean"
},
"isimpaired": {
"required": true,
"type": "boolean"
},
"language": {
"required": true,
"type": "string"
},
"name": {
"required": true,
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Player.Type ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "video",
"enums": [
"video",
"audio",
"picture"
],
"id": "Player.Type",
"type": "string"
}
</syntaxhighlight>}}
==== Player.Video.Stream ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' codec
* ''integer'' height
* ''integer'' index
* ''string'' language
* ''string'' name
* ''integer'' width
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.Video.Stream",
"properties": {
"codec": {
"required": true,
"type": "string"
},
"height": {
"required": true,
"type": "integer"
},
"index": {
"minimum": 0,
"required": true,
"type": "integer"
},
"language": {
"required": true,
"type": "string"
},
"name": {
"required": true,
"type": "string"
},
"width": {
"required": true,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Player.ViewMode ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "normal",
"enums": [
"normal",
"zoom",
"stretch4x3",
"widezoom",
"stretch16x9",
"original",
"stretch16x9nonlin",
"zoom120width",
"zoom110width"
],
"id": "Player.ViewMode",
"type": "string"
}
</syntaxhighlight>}}
=== Playlist ===
==== Playlist.Id ====
'''Type:''' ''integer''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": -1,
"id": "Playlist.Id",
"maximum": 2,
"minimum": 0,
"type": "integer"
}
</syntaxhighlight>}}
==== Playlist.Item ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Playlist.Item",
"type": [
{
"additionalProperties": false,
"properties": {
"file": {
"description": "Path to a file (not a directory) to be added to the playlist",
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"directory": {
"required": true,
"type": "string"
},
"media": {
"$ref": "Files.Media",
"default": "files"
},
"recursive": {
"default": false,
"type": "boolean"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"movieid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"episodeid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"musicvideoid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"albumid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"songid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Identification of a genre from the AudioLibrary",
"required": true
}
},
"type": "object"
}
]
}
</syntaxhighlight>}}
==== Playlist.Position ====
'''Type:''' ''integer''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": -1,
"id": "Playlist.Position",
"minimum": 0,
"type": "integer"
}
</syntaxhighlight>}}
==== Playlist.Property.Name ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "type",
"enums": [
"type",
"size"
],
"id": "Playlist.Property.Name",
"type": "string"
}
</syntaxhighlight>}}
==== Playlist.Property.Value ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''integer'' size]
* [''[[#Playlist.Type|Playlist.Type]]'' type = unknown]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Playlist.Property.Value",
"properties": {
"size": {
"default": 0,
"minimum": 0,
"type": "integer"
},
"type": {
"$ref": "Playlist.Type",
"default": "unknown"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Playlist.Type ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "unknown",
"enums": [
"unknown",
"video",
"audio",
"picture",
"mixed"
],
"id": "Playlist.Type",
"type": "string"
}
</syntaxhighlight>}}
=== Profiles ===
==== Profiles.Details.Profile ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''integer'' lockmode]
* [''string'' thumbnail]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "Profiles.Details.Profile",
"properties": {
"lockmode": {
"default": 0,
"type": "integer"
},
"thumbnail": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Profiles.Fields.Profile ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Profiles.Fields.Profile",
"items": {
"enums": [
"thumbnail",
"lockmode"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Profiles.Password ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' encryption = md5]
* ''string'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Profiles.Password",
"properties": {
"encryption": {
"default": "md5",
"description": "Password Encryption",
"enums": [
"none",
"md5"
],
"type": "string"
},
"value": {
"description": "Password",
"required": true,
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
=== Setting ===
==== Setting.Details.Base ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' help]
* ''string'' id
* ''string'' label
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Setting.Details.Base",
"properties": {
"help": {
"default": "",
"type": "string"
},
"id": {
"minLength": 1,
"required": true,
"type": "string"
},
"label": {
"required": true,
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Setting.Details.Category ====
'''Extends:'''
* ''[[#Setting.Details.Base|Setting.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''array'' groups]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.Base",
"id": "Setting.Details.Category",
"properties": {
"groups": {
"items": {
"$ref": "Setting.Details.Group"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
}
}
</syntaxhighlight>}}
==== Setting.Details.Control ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Setting.Details.Control",
"type": [
{
"$ref": "Setting.Details.ControlCheckmark"
},
{
"$ref": "Setting.Details.ControlSpinner"
},
{
"$ref": "Setting.Details.ControlEdit"
},
{
"$ref": "Setting.Details.ControlButton"
},
{
"$ref": "Setting.Details.ControlList"
},
{
"$ref": "Setting.Details.ControlSlider"
},
{
"$ref": "Setting.Details.ControlRange"
},
{
"$ref": "Setting.Details.ControlLabel"
}
]
}
</syntaxhighlight>}}
==== Setting.Details.ControlBase ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' delayed
* ''string'' format
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Setting.Details.ControlBase",
"properties": {
"delayed": {
"required": true,
"type": "boolean"
},
"format": {
"required": true,
"type": "string"
},
"type": {
"required": true,
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Setting.Details.ControlButton ====
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlHeading",
"id": "Setting.Details.ControlButton",
"properties": {
"type": {
"enums": [
"button"
],
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.ControlCheckmark ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' format
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlBase",
"id": "Setting.Details.ControlCheckmark",
"properties": {
"format": {
"enums": [
"boolean"
],
"required": true,
"type": "string"
},
"type": {
"enums": [
"toggle"
],
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.ControlEdit ====
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' hidden
* ''string'' type
* ''boolean'' verifynewvalue
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlHeading",
"id": "Setting.Details.ControlEdit",
"properties": {
"hidden": {
"required": true,
"type": "boolean"
},
"type": {
"enums": [
"edit"
],
"required": true,
"type": "string"
},
"verifynewvalue": {
"required": true,
"type": "boolean"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.ControlHeading ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' heading]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlBase",
"id": "Setting.Details.ControlHeading",
"properties": {
"heading": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.ControlLabel ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' format
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlBase",
"id": "Setting.Details.ControlLabel",
"properties": {
"format": {
"enums": [
"string"
],
"required": true,
"type": "string"
},
"type": {
"enums": [
"label"
],
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.ControlList ====
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' multiselect
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlHeading",
"id": "Setting.Details.ControlList",
"properties": {
"multiselect": {
"required": true,
"type": "boolean"
},
"type": {
"enums": [
"list"
],
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.ControlRange ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' formatlabel
* ''string'' formatvalue
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlBase",
"id": "Setting.Details.ControlRange",
"properties": {
"formatlabel": {
"required": true,
"type": "string"
},
"formatvalue": {
"required": true,
"type": "string"
},
"type": {
"enums": [
"range"
],
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.ControlSlider ====
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' formatlabel
* ''boolean'' popup
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlHeading",
"id": "Setting.Details.ControlSlider",
"properties": {
"formatlabel": {
"required": true,
"type": "string"
},
"popup": {
"required": true,
"type": "boolean"
},
"type": {
"enums": [
"slider"
],
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.ControlSpinner ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' formatlabel]
* [''string'' minimumlabel]
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlBase",
"id": "Setting.Details.ControlSpinner",
"properties": {
"formatlabel": {
"default": "",
"type": "string"
},
"minimumlabel": {
"default": "",
"type": "string"
},
"type": {
"enums": [
"spinner"
],
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.Group ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' id
* [''array'' settings]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"id": "Setting.Details.Group",
"properties": {
"id": {
"minLength": 1,
"required": true,
"type": "string"
},
"settings": {
"items": {
"$ref": "Setting.Details.Setting"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Setting.Details.Section ====
'''Extends:'''
* ''[[#Setting.Details.Base|Setting.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''array'' categories]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.Base",
"id": "Setting.Details.Section",
"properties": {
"categories": {
"items": {
"$ref": "Setting.Details.Category"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
}
}
</syntaxhighlight>}}
==== Setting.Details.Setting ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Setting.Details.Setting",
"type": [
{
"$ref": "Setting.Details.SettingBool"
},
{
"$ref": "Setting.Details.SettingInt"
},
{
"$ref": "Setting.Details.SettingNumber"
},
{
"$ref": "Setting.Details.SettingString"
},
{
"$ref": "Setting.Details.SettingAction"
},
{
"$ref": "Setting.Details.SettingList"
},
{
"$ref": "Setting.Details.SettingPath"
},
{
"$ref": "Setting.Details.SettingAddon"
},
{
"$ref": "Setting.Details.SettingDate"
},
{
"$ref": "Setting.Details.SettingTime"
}
]
}
</syntaxhighlight>}}
==== Setting.Details.SettingAction ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingBase",
"id": "Setting.Details.SettingAction",
"properties": {
"data": {
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingAddon ====
'''Extends:'''
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Addon.Types|Addon.Types]]'' addontype
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingString",
"id": "Setting.Details.SettingAddon",
"properties": {
"addontype": {
"$ref": "Addon.Types",
"required": true
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingBase ====
'''Extends:'''
* ''[[#Setting.Details.Base|Setting.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Setting.Details.Control|Setting.Details.Control]]'' control]
* ''boolean'' enabled
* ''[[#Setting.Level|Setting.Level]]'' level
* [''string'' parent]
* ''[[#Setting.Type|Setting.Type]]'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.Base",
"id": "Setting.Details.SettingBase",
"properties": {
"control": {
"$ref": "Setting.Details.Control"
},
"enabled": {
"required": true,
"type": "boolean"
},
"level": {
"$ref": "Setting.Level",
"required": true
},
"parent": {
"default": "",
"type": "string"
},
"type": {
"$ref": "Setting.Type",
"required": true
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingBool ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' default
* ''boolean'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingBase",
"id": "Setting.Details.SettingBool",
"properties": {
"default": {
"required": true,
"type": "boolean"
},
"value": {
"required": true,
"type": "boolean"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingDate ====
'''Extends:'''
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingString",
"id": "Setting.Details.SettingDate"
}
</syntaxhighlight>}}
==== Setting.Details.SettingInt ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''integer'' default
* [''integer'' maximum]
* [''integer'' minimum]
* [''array'' options]
* [''integer'' step]
* ''integer'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingBase",
"id": "Setting.Details.SettingInt",
"properties": {
"default": {
"required": true,
"type": "integer"
},
"maximum": {
"default": 0,
"type": "integer"
},
"minimum": {
"default": 0,
"type": "integer"
},
"options": {
"items": {
"properties": {
"label": {
"required": true,
"type": "string"
},
"value": {
"required": true,
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"step": {
"default": 0,
"type": "integer"
},
"value": {
"required": true,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingList ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Setting.Value.List|Setting.Value.List]]'' default
* ''[[#Setting.Details.Setting|Setting.Details.Setting]]'' definition
* ''string'' delimiter
* ''[[#Setting.Type|Setting.Type]]'' elementtype
* [''integer'' maximumitems]
* [''integer'' minimumitems]
* ''[[#Setting.Value.List|Setting.Value.List]]'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingBase",
"id": "Setting.Details.SettingList",
"properties": {
"default": {
"$ref": "Setting.Value.List",
"required": true
},
"definition": {
"$ref": "Setting.Details.Setting",
"required": true
},
"delimiter": {
"required": true,
"type": "string"
},
"elementtype": {
"$ref": "Setting.Type",
"required": true
},
"maximumitems": {
"default": 0,
"type": "integer"
},
"minimumitems": {
"default": 0,
"type": "integer"
},
"value": {
"$ref": "Setting.Value.List",
"required": true
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingNumber ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''number'' default
* ''number'' maximum
* ''number'' minimum
* ''number'' step
* ''number'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingBase",
"id": "Setting.Details.SettingNumber",
"properties": {
"default": {
"required": true,
"type": "number"
},
"maximum": {
"required": true,
"type": "number"
},
"minimum": {
"required": true,
"type": "number"
},
"step": {
"required": true,
"type": "number"
},
"value": {
"required": true,
"type": "number"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingPath ====
'''Extends:'''
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''array'' sources]
* ''boolean'' writable
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingString",
"id": "Setting.Details.SettingPath",
"properties": {
"sources": {
"items": {
"type": "string"
},
"type": "array"
},
"writable": {
"required": true,
"type": "boolean"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingString ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' allowempty
* ''string'' default
* [''array'' options]
* ''string'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.SettingBase",
"id": "Setting.Details.SettingString",
"properties": {
"allowempty": {
"required": true,
"type": "boolean"
},
"default": {
"required": true,
"type": "string"
},
"options": {
"items": {
"properties": {
"label": {
"required": true,
"type": "string"
},
"value": {
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"value": {
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingTime ====
'''Extends:'''
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingString",
"id": "Setting.Details.SettingTime"
}
</syntaxhighlight>}}
==== Setting.Level ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "basic",
"enums": [
"basic",
"standard",
"advanced",
"expert"
],
"id": "Setting.Level",
"type": "string"
}
</syntaxhighlight>}}
==== Setting.Type ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "boolean",
"enums": [
"boolean",
"integer",
"number",
"string",
"action",
"list",
"path",
"addon",
"date",
"time"
],
"id": "Setting.Type",
"type": "string"
}
</syntaxhighlight>}}
==== Setting.Value ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": null,
"id": "Setting.Value",
"type": [
{
"type": "boolean"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
}
]
}
</syntaxhighlight>}}
==== Setting.Value.Extended ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": null,
"id": "Setting.Value.Extended",
"type": [
{
"type": "boolean"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
},
{
"$ref": "Setting.Value.List"
}
]
}
</syntaxhighlight>}}
==== Setting.Value.List ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Setting.Value.List",
"items": {
"$ref": "Setting.Value"
},
"type": "array"
}
</syntaxhighlight>}}
=== System ===
==== System.Property.Name ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "canshutdown",
"enums": [
"canshutdown",
"cansuspend",
"canhibernate",
"canreboot"
],
"id": "System.Property.Name",
"type": "string"
}
</syntaxhighlight>}}
==== System.Property.Value ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''boolean'' canhibernate]
* [''boolean'' canreboot]
* [''boolean'' canshutdown]
* [''boolean'' cansuspend]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "System.Property.Value",
"properties": {
"canhibernate": {
"default": false,
"type": "boolean"
},
"canreboot": {
"default": false,
"type": "boolean"
},
"canshutdown": {
"default": false,
"type": "boolean"
},
"cansuspend": {
"default": false,
"type": "boolean"
}
},
"type": "object"
}
</syntaxhighlight>}}
=== Textures ===
==== Textures.Details.Size ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''integer'' height]
* [''string'' lastused]
* [''integer'' size]
* [''integer'' usecount]
* [''integer'' width]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Textures.Details.Size",
"properties": {
"height": {
"default": 0,
"description": "Height of texture",
"type": "integer"
},
"lastused": {
"default": "",
"description": "Date of last use",
"type": "string"
},
"size": {
"default": 0,
"description": "Size of the texture (1 == largest)",
"type": "integer"
},
"usecount": {
"default": 0,
"description": "Number of uses",
"type": "integer"
},
"width": {
"default": 0,
"description": "Width of texture",
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Textures.Details.Texture ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' cachedurl]
* [''string'' imagehash]
* [''string'' lasthashcheck]
* [''array'' sizes]
* [''[[#Library.Id|Library.Id]]'' textureid = -1]
* [''string'' url]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Textures.Details.Texture",
"properties": {
"cachedurl": {
"default": "",
"description": "Cached URL on disk",
"type": "string"
},
"imagehash": {
"default": "",
"description": "Hash of image",
"type": "string"
},
"lasthashcheck": {
"default": "",
"description": "Last time source was checked for changes",
"type": "string"
},
"sizes": {
"items": {
"$ref": "Textures.Details.Size"
},
"type": "array"
},
"textureid": {
"$ref": "Library.Id",
"default": -1
},
"url": {
"default": "",
"description": "Original source URL",
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Textures.Fields.Texture ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Textures.Fields.Texture",
"items": {
"enums": [
"url",
"cachedurl",
"lasthashcheck",
"imagehash",
"sizes"
],
"type": "string"
}
}
</syntaxhighlight>}}
=== Video ===
==== Video.Cast ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Video.Cast",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"required": true,
"type": "string"
},
"order": {
"required": true,
"type": "integer"
},
"role": {
"required": true,
"type": "string"
},
"thumbnail": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
</syntaxhighlight>}}
==== Video.Details.Base ====
'''Extends:'''
* ''[[#Media.Details.Base|Media.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Media.Artwork|Media.Artwork]]'' art]
* [''integer'' playcount]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Media.Details.Base",
"id": "Video.Details.Base",
"properties": {
"art": {
"$ref": "Media.Artwork"
},
"playcount": {
"default": 0,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== Video.Details.Episode ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Video.Cast|Video.Cast]]'' cast]
* [''integer'' episode]
* ''[[#Library.Id|Library.Id]]'' episodeid
* [''string'' firstaired]
* [''string'' originaltitle]
* [''string'' productioncode]
* [''number'' rating]
* [''any'' ratings]
* [''integer'' season]
* [''[[#Library.Id|Library.Id]]'' seasonid = -1]
* [''string'' showtitle]
* [''integer'' specialsortepisode]
* [''integer'' specialsortseason]
* [''[[#Library.Id|Library.Id]]'' tvshowid = -1]
* [''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid]
* [''integer'' userrating]
* [''string'' votes]
* [''[[#Array.String|Array.String]]'' writer]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.File",
"id": "Video.Details.Episode",
"properties": {
"cast": {
"$ref": "Video.Cast"
},
"episode": {
"default": 0,
"type": "integer"
},
"episodeid": {
"$ref": "Library.Id",
"required": true
},
"firstaired": {
"default": "",
"type": "string"
},
"originaltitle": {
"default": "",
"type": "string"
},
"productioncode": {
"default": "",
"type": "string"
},
"rating": {
"default": 0.0,
"type": "number"
},
"ratings": {
"default": null,
"type": "any"
},
"season": {
"default": 0,
"type": "integer"
},
"seasonid": {
"$ref": "Library.Id",
"default": -1
},
"showtitle": {
"default": "",
"type": "string"
},
"specialsortepisode": {
"default": 0,
"type": "integer"
},
"specialsortseason": {
"default": 0,
"type": "integer"
},
"tvshowid": {
"$ref": "Library.Id",
"default": -1
},
"uniqueid": {
"$ref": "Media.UniqueID"
},
"userrating": {
"default": 0,
"type": "integer"
},
"votes": {
"default": "",
"type": "string"
},
"writer": {
"$ref": "Array.String"
}
}
}
</syntaxhighlight>}}
==== Video.Details.File ====
'''Extends:'''
* ''[[#Video.Details.Item|Video.Details.Item]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Array.String|Array.String]]'' director]
* [''[[#Video.Resume|Video.Resume]]'' resume]
* [''integer'' runtime]
* [''[[#Video.Streams|Video.Streams]]'' streamdetails]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.Item",
"id": "Video.Details.File",
"properties": {
"director": {
"$ref": "Array.String"
},
"resume": {
"$ref": "Video.Resume"
},
"runtime": {
"default": 0,
"description": "Runtime in seconds",
"type": "integer"
},
"streamdetails": {
"$ref": "Video.Streams"
}
}
}
</syntaxhighlight>}}
==== Video.Details.Item ====
'''Extends:'''
* ''[[#Video.Details.Media|Video.Details.Media]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' dateadded]
* [''string'' file]
* [''string'' lastplayed]
* [''string'' plot]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.Media",
"id": "Video.Details.Item",
"properties": {
"dateadded": {
"default": "",
"type": "string"
},
"file": {
"default": "",
"type": "string"
},
"lastplayed": {
"default": "",
"type": "string"
},
"plot": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Video.Details.Media ====
'''Extends:'''
* ''[[#Video.Details.Base|Video.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' title]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.Base",
"id": "Video.Details.Media",
"properties": {
"title": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Video.Details.Movie ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Video.Cast|Video.Cast]]'' cast]
* [''[[#Array.String|Array.String]]'' country]
* [''[[#Array.String|Array.String]]'' genre]
* [''string'' imdbnumber]
* ''[[#Library.Id|Library.Id]]'' movieid
* [''string'' mpaa]
* [''string'' originaltitle]
* [''string'' plotoutline]
* [''string'' premiered]
* [''number'' rating]
* [''any'' ratings]
* [''string'' set]
* [''[[#Library.Id|Library.Id]]'' setid = -1]
* [''[[#Array.String|Array.String]]'' showlink]
* [''string'' sorttitle]
* [''[[#Array.String|Array.String]]'' studio]
* [''[[#Array.String|Array.String]]'' tag]
* [''string'' tagline]
* [''integer'' top250]
* [''string'' trailer]
* [''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid]
* [''integer'' userrating]
* [''string'' votes]
* [''[[#Array.String|Array.String]]'' writer]
* [''integer'' year]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.File",
"id": "Video.Details.Movie",
"properties": {
"cast": {
"$ref": "Video.Cast"
},
"country": {
"$ref": "Array.String"
},
"genre": {
"$ref": "Array.String"
},
"imdbnumber": {
"default": "",
"type": "string"
},
"movieid": {
"$ref": "Library.Id",
"required": true
},
"mpaa": {
"default": "",
"type": "string"
},
"originaltitle": {
"default": "",
"type": "string"
},
"plotoutline": {
"default": "",
"type": "string"
},
"premiered": {
"default": "",
"type": "string"
},
"rating": {
"default": 0.0,
"type": "number"
},
"ratings": {
"default": null,
"type": "any"
},
"set": {
"default": "",
"type": "string"
},
"setid": {
"$ref": "Library.Id",
"default": -1
},
"showlink": {
"$ref": "Array.String"
},
"sorttitle": {
"default": "",
"type": "string"
},
"studio": {
"$ref": "Array.String"
},
"tag": {
"$ref": "Array.String"
},
"tagline": {
"default": "",
"type": "string"
},
"top250": {
"default": 0,
"type": "integer"
},
"trailer": {
"default": "",
"type": "string"
},
"uniqueid": {
"$ref": "Media.UniqueID"
},
"userrating": {
"default": 0,
"type": "integer"
},
"votes": {
"default": "",
"type": "string"
},
"writer": {
"$ref": "Array.String"
},
"year": {
"default": 0,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== Video.Details.MovieSet ====
'''Extends:'''
* ''[[#Video.Details.Media|Video.Details.Media]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' plot]
* ''[[#Library.Id|Library.Id]]'' setid
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.Media",
"id": "Video.Details.MovieSet",
"properties": {
"plot": {
"default": "",
"type": "string"
},
"setid": {
"$ref": "Library.Id",
"required": true
}
}
}
</syntaxhighlight>}}
==== Video.Details.MovieSet.Extended ====
'''Extends:'''
* ''[[#Video.Details.MovieSet|Video.Details.MovieSet]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [''array'' movies]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.MovieSet",
"id": "Video.Details.MovieSet.Extended",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"movies": {
"items": {
"$ref": "Video.Details.Movie"
},
"type": "array"
}
}
}
</syntaxhighlight>}}
==== Video.Details.MusicVideo ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' album]
* [''[[#Array.String|Array.String]]'' artist]
* [''[[#Array.String|Array.String]]'' genre]
* ''[[#Library.Id|Library.Id]]'' musicvideoid
* [''string'' premiered]
* [''number'' rating]
* [''[[#Array.String|Array.String]]'' studio]
* [''[[#Array.String|Array.String]]'' tag]
* [''integer'' track]
* [''integer'' userrating]
* [''integer'' year]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.File",
"id": "Video.Details.MusicVideo",
"properties": {
"album": {
"default": "",
"type": "string"
},
"artist": {
"$ref": "Array.String"
},
"genre": {
"$ref": "Array.String"
},
"musicvideoid": {
"$ref": "Library.Id",
"required": true
},
"premiered": {
"default": "",
"type": "string"
},
"rating": {
"default": 0.0,
"type": "number"
},
"studio": {
"$ref": "Array.String"
},
"tag": {
"$ref": "Array.String"
},
"track": {
"default": 0,
"type": "integer"
},
"userrating": {
"default": 0,
"type": "integer"
},
"year": {
"default": 0,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== Video.Details.Season ====
'''Extends:'''
* ''[[#Video.Details.Base|Video.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''integer'' episode]
* ''integer'' season
* ''[[#Library.Id|Library.Id]]'' seasonid
* [''string'' showtitle]
* [''string'' title]
* [''[[#Library.Id|Library.Id]]'' tvshowid = -1]
* [''integer'' userrating]
* [''integer'' watchedepisodes]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.Base",
"id": "Video.Details.Season",
"properties": {
"episode": {
"default": 0,
"type": "integer"
},
"season": {
"required": true,
"type": "integer"
},
"seasonid": {
"$ref": "Library.Id",
"required": true
},
"showtitle": {
"default": "",
"type": "string"
},
"title": {
"default": "",
"type": "string"
},
"tvshowid": {
"$ref": "Library.Id",
"default": -1
},
"userrating": {
"default": 0,
"type": "integer"
},
"watchedepisodes": {
"default": 0,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== Video.Details.TVShow ====
'''Extends:'''
* ''[[#Video.Details.Item|Video.Details.Item]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Video.Cast|Video.Cast]]'' cast]
* [''integer'' episode]
* [''string'' episodeguide]
* [''[[#Array.String|Array.String]]'' genre]
* [''string'' imdbnumber]
* [''string'' mpaa]
* [''string'' originaltitle]
* [''string'' premiered]
* [''number'' rating]
* [''any'' ratings]
* [''integer'' runtime]
* [''integer'' season]
* [''string'' sorttitle]
* [''string'' status]
* [''[[#Array.String|Array.String]]'' studio]
* [''[[#Array.String|Array.String]]'' tag]
* ''[[#Library.Id|Library.Id]]'' tvshowid
* [''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid]
* [''integer'' userrating]
* [''string'' votes]
* [''integer'' watchedepisodes]
* [''integer'' year]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.Item",
"id": "Video.Details.TVShow",
"properties": {
"cast": {
"$ref": "Video.Cast"
},
"episode": {
"default": 0,
"type": "integer"
},
"episodeguide": {
"default": "",
"type": "string"
},
"genre": {
"$ref": "Array.String"
},
"imdbnumber": {
"default": "",
"type": "string"
},
"mpaa": {
"default": "",
"type": "string"
},
"originaltitle": {
"default": "",
"type": "string"
},
"premiered": {
"default": "",
"type": "string"
},
"rating": {
"default": 0.0,
"type": "number"
},
"ratings": {
"default": null,
"type": "any"
},
"runtime": {
"default": 0,
"description": "Runtime in seconds",
"type": "integer"
},
"season": {
"default": 0,
"type": "integer"
},
"sorttitle": {
"default": "",
"type": "string"
},
"status": {
"default": "",
"description": "Returns 'returning series', 'in production', 'planned', 'cancelled' or 'ended'",
"type": "string"
},
"studio": {
"$ref": "Array.String"
},
"tag": {
"$ref": "Array.String"
},
"tvshowid": {
"$ref": "Library.Id",
"required": true
},
"uniqueid": {
"$ref": "Media.UniqueID"
},
"userrating": {
"default": 0,
"type": "integer"
},
"votes": {
"default": "",
"type": "string"
},
"watchedepisodes": {
"default": 0,
"type": "integer"
},
"year": {
"default": 0,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== Video.Fields.Episode ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Video.Fields.Episode",
"items": {
"description": "Requesting the cast, ratings, streamdetails, uniqueid and/or tag field will result in increased response times",
"enums": [
"title",
"plot",
"votes",
"rating",
"writer",
"firstaired",
"playcount",
"runtime",
"director",
"productioncode",
"season",
"episode",
"originaltitle",
"showtitle",
"cast",
"streamdetails",
"lastplayed",
"fanart",
"thumbnail",
"file",
"resume",
"tvshowid",
"dateadded",
"uniqueid",
"art",
"specialsortseason",
"specialsortepisode",
"userrating",
"seasonid",
"ratings"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Video.Fields.Movie ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Video.Fields.Movie",
"items": {
"description": "Requesting the cast, ratings, showlink, streamdetails, uniqueid and/or tag field will result in increased response times",
"enums": [
"title",
"genre",
"year",
"rating",
"director",
"trailer",
"tagline",
"plot",
"plotoutline",
"originaltitle",
"lastplayed",
"playcount",
"writer",
"studio",
"mpaa",
"cast",
"country",
"imdbnumber",
"runtime",
"set",
"showlink",
"streamdetails",
"top250",
"votes",
"fanart",
"thumbnail",
"file",
"sorttitle",
"resume",
"setid",
"dateadded",
"tag",
"art",
"userrating",
"ratings",
"premiered",
"uniqueid"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Video.Fields.MovieSet ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Video.Fields.MovieSet",
"items": {
"enums": [
"title",
"playcount",
"fanart",
"thumbnail",
"art",
"plot"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Video.Fields.MusicVideo ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Video.Fields.MusicVideo",
"items": {
"description": "Requesting the streamdetails and/or tag field will result in increased response times",
"enums": [
"title",
"playcount",
"runtime",
"director",
"studio",
"year",
"plot",
"album",
"artist",
"genre",
"track",
"streamdetails",
"lastplayed",
"fanart",
"thumbnail",
"file",
"resume",
"dateadded",
"tag",
"art",
"rating",
"userrating",
"premiered"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Video.Fields.Season ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Video.Fields.Season",
"items": {
"enums": [
"season",
"showtitle",
"playcount",
"episode",
"fanart",
"thumbnail",
"tvshowid",
"watchedepisodes",
"art",
"userrating",
"title"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Video.Fields.TVShow ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Video.Fields.TVShow",
"items": {
"description": "Requesting the cast, ratings, uniqueid and/or tag field will result in increased response times",
"enums": [
"title",
"genre",
"year",
"rating",
"plot",
"studio",
"mpaa",
"cast",
"playcount",
"episode",
"imdbnumber",
"premiered",
"votes",
"lastplayed",
"fanart",
"thumbnail",
"file",
"originaltitle",
"sorttitle",
"episodeguide",
"season",
"watchedepisodes",
"dateadded",
"tag",
"art",
"userrating",
"ratings",
"runtime",
"uniqueid"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Video.Rating ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''boolean'' default]
* ''number'' rating
* [''integer'' votes]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Video.Rating",
"properties": {
"default": {
"default": false,
"type": "boolean"
},
"rating": {
"required": true,
"type": "number"
},
"votes": {
"default": 0,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Video.Ratings ====
'''Type:''' ''object''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": {
"$ref": "Video.Rating"
},
"id": "Video.Ratings",
"type": "object"
}
</syntaxhighlight>}}
==== Video.Ratings.Set ====
'''Type:''' ''object''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": {
"default": null,
"type": [
{
"type": "null"
},
{
"$ref": "Video.Rating"
}
]
},
"id": "Video.Ratings.Set",
"type": "object"
}
</syntaxhighlight>}}
==== Video.Resume ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''number'' position]
* [''number'' total]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"id": "Video.Resume",
"properties": {
"position": {
"default": 0.0,
"minimum": 0.0,
"type": "number"
},
"total": {
"default": 0.0,
"minimum": 0.0,
"type": "number"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Video.Streams ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''array'' audio]
* [''array'' subtitle]
* [''array'' video]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"id": "Video.Streams",
"properties": {
"audio": {
"items": {
"additionalProperties": false,
"properties": {
"channels": {
"default": 0,
"type": "integer"
},
"codec": {
"default": "",
"type": "string"
},
"language": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"subtitle": {
"items": {
"additionalProperties": false,
"properties": {
"language": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"video": {
"items": {
"additionalProperties": false,
"properties": {
"aspect": {
"default": 0.0,
"type": "number"
},
"codec": {
"default": "",
"type": "string"
},
"duration": {
"default": 0,
"type": "integer"
},
"height": {
"default": 0,
"type": "integer"
},
"width": {
"default": 0,
"type": "integer"
}
},
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"type": "object"
}
</syntaxhighlight>}}
== Notifications ==
=== Application ===
==== Application.OnVolumeChanged ====
The volume of the application has changed.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data:
#* ''boolean'' muted
#* ''integer'' volume
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The volume of the application has changed.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"muted": {
"required": true,
"type": "boolean"
},
"volume": {
"maximum": 100,
"minimum": 0,
"required": true,
"type": "integer"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
=== AudioLibrary ===
==== AudioLibrary.OnCleanFinished ====
The audio library has been cleaned.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The audio library has been cleaned.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== AudioLibrary.OnCleanStarted ====
An audio library clean operation has started.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "An audio library clean operation has started.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== AudioLibrary.OnExport ====
An audio library export has finished.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# [''object'' data]:
#* [''integer'' failcount = 0]
#* [''string'' file = ""]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "An audio library export has finished.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"failcount": {
"default": 0,
"minimum": 0,
"required": false,
"type": "integer"
},
"file": {
"default": "",
"required": false,
"type": "string"
}
},
"required": false,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== AudioLibrary.OnRemove ====
An audio item has been removed.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data:
#* ''[[#Library.Id|Library.Id]]'' id
#* ''[[#Optional.Boolean|Optional.Boolean]]'' transaction
#* ''[[#Notifications.Library.Audio.Type|Notifications.Library.Audio.Type]]'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "An audio item has been removed.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"id": {
"$ref": "Library.Id",
"required": true
},
"transaction": {
"$ref": "Optional.Boolean",
"description": "True if the removal is being performed within a transaction."
},
"type": {
"$ref": "Notifications.Library.Audio.Type",
"required": true
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== AudioLibrary.OnScanFinished ====
Scanning the audio library has been finished.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Scanning the audio library has been finished.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== AudioLibrary.OnScanStarted ====
An audio library scan has started.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "An audio library scan has started.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== AudioLibrary.OnUpdate ====
An audio item has been updated.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data:
#* ''[[#Optional.Boolean|Optional.Boolean]]'' added
#* ''[[#Library.Id|Library.Id]]'' id
#* ''[[#Optional.Boolean|Optional.Boolean]]'' transaction
#* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "An audio item has been updated.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"added": {
"$ref": "Optional.Boolean",
"description": "True if the update is for a newly added item."
},
"id": {
"$ref": "Library.Id",
"required": true
},
"transaction": {
"$ref": "Optional.Boolean",
"description": "True if the update is being performed within a transaction."
},
"type": {
"enum": [
"song"
],
"id": "Notifications.Library.Audio.Type",
"required": true,
"type": "string"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
=== GUI ===
==== GUI.OnDPMSActivated ====
Energy saving/DPMS has been activated.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Energy saving/DPMS has been activated.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== GUI.OnDPMSDeactivated ====
Energy saving/DPMS has been deactivated.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Energy saving/DPMS has been deactivated.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== GUI.OnScreensaverActivated ====
The screensaver has been activated.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The screensaver has been activated.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== GUI.OnScreensaverDeactivated ====
The screensaver has been deactivated.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data:
#* ''boolean'' shuttingdown
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The screensaver has been deactivated.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"shuttingdown": {
"required": true,
"type": "boolean"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
=== Input ===
==== Input.OnInputFinished ====
The user has provided the requested input.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The user has provided the requested input.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== Input.OnInputRequested ====
The user is requested to provide some information.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data:
#* ''string'' title
#* ''string'' type
#* ''string'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The user is requested to provide some information.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"title": {
"type": "string"
},
"type": {
"enum": [
"keyboard",
"time",
"date",
"ip",
"password",
"numericpassword",
"number",
"seconds"
],
"required": true,
"type": "string"
},
"value": {
"required": true,
"type": "string"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
=== Player ===
==== Player.OnAVChange ====
Audio- or videostream has changed. If there is no ID available extra information will be provided.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''[[#Player.Notifications.Data|Player.Notifications.Data]]'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Audio- or videostream has changed. If there is no ID available extra information will be provided.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== Player.OnAVStart ====
Playback of a media item has been started and first frame is available. If there is no ID available extra information will be provided.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''[[#Player.Notifications.Data|Player.Notifications.Data]]'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Playback of a media item has been started and first frame is available. If there is no ID available extra information will be provided.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== Player.OnPause ====
Playback of a media item has been paused. If there is no ID available extra information will be provided.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''[[#Player.Notifications.Data|Player.Notifications.Data]]'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Playback of a media item has been paused. If there is no ID available extra information will be provided.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== Player.OnPlay ====
Playback of a media item has been started or the playback speed has changed. If there is no ID available extra information will be provided.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''[[#Player.Notifications.Data|Player.Notifications.Data]]'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Playback of a media item has been started or the playback speed has changed. If there is no ID available extra information will be provided.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== Player.OnPropertyChanged ====
A property of the playing items has changed.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data:
#* ''[[#Player.Notifications.Player|Player.Notifications.Player]]'' player
#* ''[[#Player.Property.Value|Player.Property.Value]]'' property
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A property of the playing items has changed.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"player": {
"$ref": "Player.Notifications.Player",
"required": true
},
"property": {
"$ref": "Player.Property.Value"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== Player.OnResume ====
Playback of a media item has been resumed. If there is no ID available extra information will be provided.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''[[#Player.Notifications.Data|Player.Notifications.Data]]'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Playback of a media item has been resumed. If there is no ID available extra information will be provided.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== Player.OnSeek ====
The playback position has been changed. If there is no ID available extra information will be provided.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data:
#* ''[[#Notifications.Item|Notifications.Item]]'' item
#* ''[[#Player.Notifications.Player.Seek|Player.Notifications.Player.Seek]]'' player
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The playback position has been changed. If there is no ID available extra information will be provided.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"item": {
"$ref": "Notifications.Item"
},
"player": {
"$ref": "Player.Notifications.Player.Seek",
"required": true
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== Player.OnSpeedChanged ====
Speed of the playback of a media item has been changed. If there is no ID available extra information will be provided.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''[[#Player.Notifications.Data|Player.Notifications.Data]]'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Speed of the playback of a media item has been changed. If there is no ID available extra information will be provided.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== Player.OnStop ====
Playback of a media item has been stopped. If there is no ID available extra information will be provided.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data:
#* ''boolean'' end
#* ''[[#Notifications.Item|Notifications.Item]]'' item
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Playback of a media item has been stopped. If there is no ID available extra information will be provided.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"end": {
"description": "Whether the player has reached the end of the playable item(s) or not",
"required": true,
"type": "boolean"
},
"item": {
"$ref": "Notifications.Item"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
=== Playlist ===
==== Playlist.OnAdd ====
A playlist item has been added.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data:
#* ''[[#Notifications.Item|Notifications.Item]]'' item
#* ''[[#Playlist.Id|Playlist.Id]]'' playlistid
#* ''[[#Playlist.Position|Playlist.Position]]'' position
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A playlist item has been added.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"item": {
"$ref": "Notifications.Item"
},
"playlistid": {
"$ref": "Playlist.Id",
"required": true
},
"position": {
"$ref": "Playlist.Position"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== Playlist.OnClear ====
A playlist item has been cleared.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data:
#* ''[[#Playlist.Id|Playlist.Id]]'' playlistid
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A playlist item has been cleared.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"playlistid": {
"$ref": "Playlist.Id",
"required": true
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== Playlist.OnRemove ====
A playlist item has been removed.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data:
#* ''[[#Playlist.Id|Playlist.Id]]'' playlistid
#* ''[[#Playlist.Position|Playlist.Position]]'' position
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A playlist item has been removed.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"playlistid": {
"$ref": "Playlist.Id",
"required": true
},
"position": {
"$ref": "Playlist.Position"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
=== System ===
==== System.OnLowBattery ====
The system is on low battery.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The system is on low battery.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== System.OnQuit ====
Kodi will be closed.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data:
#* ''integer'' exitcode
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Kodi will be closed.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"exitcode": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== System.OnRestart ====
The system will be restarted.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The system will be restarted.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== System.OnSleep ====
The system will be suspended.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The system will be suspended.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== System.OnWake ====
The system woke up from suspension.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The system woke up from suspension.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
=== VideoLibrary ===
==== VideoLibrary.OnCleanFinished ====
The video library has been cleaned.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The video library has been cleaned.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== VideoLibrary.OnCleanStarted ====
A video library clean operation has started.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A video library clean operation has started.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== VideoLibrary.OnExport ====
A video library export has finished.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# [''object'' data]:
#* [''integer'' failcount = 0]
#* [''string'' file = ""]
#* [''string'' root = ""]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A video library export has finished.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"failcount": {
"default": 0,
"minimum": 0,
"required": false,
"type": "integer"
},
"file": {
"default": "",
"required": false,
"type": "string"
},
"root": {
"default": "",
"required": false,
"type": "string"
}
},
"required": false,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== VideoLibrary.OnRefresh ====
The video library has been refreshed and a home screen reload might be necessary.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The video library has been refreshed and a home screen reload might be necessary.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== VideoLibrary.OnRemove ====
A video item has been removed.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data:
#* ''[[#Library.Id|Library.Id]]'' id
#* ''[[#Optional.Boolean|Optional.Boolean]]'' transaction
#* ''[[#Notifications.Library.Video.Type|Notifications.Library.Video.Type]]'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A video item has been removed.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"id": {
"$ref": "Library.Id",
"required": true
},
"transaction": {
"$ref": "Optional.Boolean",
"description": "True if the removal is being performed within a transaction."
},
"type": {
"$ref": "Notifications.Library.Video.Type",
"required": true
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== VideoLibrary.OnScanFinished ====
Scanning the video library has been finished.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Scanning the video library has been finished.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== VideoLibrary.OnScanStarted ====
A video library scan has started.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A video library scan has started.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== VideoLibrary.OnUpdate ====
A video item has been updated.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data:
#* ''[[#Optional.Boolean|Optional.Boolean]]'' added
#* ''[[#Library.Id|Library.Id]]'' id
#* ''integer'' playcount = -1
#* ''[[#Optional.Boolean|Optional.Boolean]]'' transaction
#* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A video item has been updated.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"added": {
"$ref": "Optional.Boolean",
"description": "True if the update is for a newly added item."
},
"id": {
"$ref": "Library.Id",
"required": true
},
"playcount": {
"default": -1,
"minimum": 0,
"type": "integer"
},
"transaction": {
"$ref": "Optional.Boolean",
"description": "True if the update is being performed within a transaction."
},
"type": {
"enum": [
"movie",
"tvshow",
"episode",
"musicvideo"
],
"id": "Notifications.Library.Video.Type",
"required": true,
"type": "string"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}

== External links ==
* [http://jsonrpc.org/spec.html JSON-RPC 2.0 specification]
* [http://tools.ietf.org/html/draft-zyp-json-schema-03 A JSON Media Type for Describing the Structure and Meaning of JSON Documents (Draft 03)]

{{updated|21}}
[[Category:JSON-RPC]]

JSON-RPC API/v13

2022-12-22T08:04:37Z

CastagnaIT: Added Player.GetAudioDelay, Player.SetAudioDelay

{{JSON-RPC_API_nav}}
{{mininav|[[Development]]|[[JSON-RPC API]]}}
Version 13 is the in development version of Kodi's JSON-RPC API and is published with the release of v21 (Omega).
This document has been updated to version 13.0.0. Recent changes are announced on the [https://forum.kodi.tv/forumdisplay.php?fid=174 forum]

It comes with support for [http://en.wikipedia.org/wiki/WebSocket WebSockets] as an alternative transport for third party clients. Using WebSockets will allow webinterfaces (which are currently restricted to the HTTP transport only) to get access to a bidirectional transport with Kodi's JSON-RPC API and can therefore also profit from additional features like notifications.

{{TOC right}}
== JSON-RPC 2.0 compatibility ==
{| class="prettytable" style="margin-right: 0;"
!style="padding-left: 5px; width: 7em; text-align: left;"|Version
!style="padding-left: 10px; padding-right: 10px;"|Method calls
!style="padding-left: 10px; padding-right: 10px;"|Notifications<br />(server-side)
!style="padding-left: 10px; padding-right: 10px;"|Notifications<br />(client-side)
!style="padding-left: 10px; padding-right: 10px;"|Parameters<br />by-name
!style="padding-left: 10px; padding-right: 10px;"|Parameters<br />by-position
!style="padding-left: 10px; padding-right: 10px;"|Batch requests
|-
|style="padding-left: 5px;"|Version 6
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|}

== Documentation (JSON Schema) ==
=== Supported features of JSON Schema ===
<div style="float:left; margin-right:2em">
{| class="prettytable" style="margin-right: 0;"
!style="width: 10em; text-align: left;"|Schema
!style="padding-left: 10px; padding-right: 10px;"|IETF Draft 03
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1 type]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.2 properties]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.3 patternProperties]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.4 additionalProperties]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.5 items]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.6 additionalItems]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.7 required]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.8 dependencies]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.9 minimum]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.10 maximum]
|{{yes}}
|-
|}
</div>

<div style="float:left; margin-right:2em">
{| class="prettytable" style="margin-right: 0;"
!style="width: 10em; text-align: left;"|Schema

!style="padding-left: 10px; padding-right: 10px;"|IETF Draft 03

|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.11 exclusiveMinimum]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.12 exclusiveMaximum]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.13 minItems]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.14 maxItems]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.15 uniqueItems]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.16 pattern]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.17 minLength]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.18 maxLength]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.19 enum]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.20 default]
|{{yes}}
|-
|}
</div>

<div style="float:left;">
{| class="prettytable" style="margin-right: 0;"
!style="width: 10em; text-align: left;"|Schema

!style="padding-left: 10px; padding-right: 10px;"|IETF Draft 03
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.21 title]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.22 description]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23 format]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.24 divisibleBy]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.25 disallow]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.26 extends]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.27 id]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.28 $ref]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.29 $schema]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-6 Hyper Schema]
|{{no}}
|-
|}
</div>
<div style="clear:left;"></div>

== Error message ==
If Kodi detects a bad or missing parameter in a JSON-RPC request it returns an error object. The JSON schema description of that error object is
{|
|
<syntaxhighlight lang="json" enclose="div">
{
"type": "object",
"properties": {
"code": { "type": "integer", "required": true },
"message": { "type": "string", "required": true },
"data": { "type": "object",
"properties": {
"method": { "type": "string", "required": true },
"stack": { "type": "object", "id": "Error.Stack",
"properties": {
"name": { "type": "string", "required": true },
"type": { "type": "string", "required": true },
"message": { "type": "string", "required": true },
"property": { "$ref": "Error.Stack" }
}
}
}
}
}
}
</syntaxhighlight>
|}

== Namespaces ==
The Kodi JSON-RPC API is split up into namespaces, which contain methods that can be called. These namespaces are:

{| class="prettytable" style="margin-right: 10;"
!style="padding-left: 10px; padding-right: 10px;"|Namespace
!style="padding-left: 10px; padding-right: 10px;"|Description
|-
|Addons
|List, enable and execute addons.
|-
|Application
|Application information and control.
|-
|AudioLibrary
|Audio Library information.
|-
|Favourites
|Favourites GetFavourites and AddFavourite.
|-
|Files
|Shares information & filesystem listings.
|-
|GUI
|Window properties and activation.
|-
|Input
|Allows limited navigation within Kodi.
|-
|JSONRPC
|A variety of standard JSONRPC calls.
|-
|PVR
|Live TV control.
|-
|Player
|Manages all available players.
|-
|Playlist
|Playlist modification.
|-
|Profiles
|Support for Profiles operations to Kodi.
|-
|Settings
|Allows manipulation of Kodi settings.
|-
|System
|System controls and information.
|-
|Textures
|Supplies GetTextures and RemoveTexture. Textures are images.
|-
|VideoLibrary
|Video Library information.
|-
|XBMC
|Dumping ground for very Kodi specific operations.
|}
== Methods ==
=== Addons ===
==== Addons.ExecuteAddon ====
Executes the given addon with the given parameters (if possible)<br />
'''Permissions:'''
* ExecuteAddon
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' addonid<br />
# [''mixed: object|array|string'' params = ""]<br />
# [''boolean'' wait = False]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Executes the given addon with the given parameters (if possible)",
"params": [
{
"name": "addonid",
"required": true,
"type": "string"
},
{
"default": "",
"name": "params",
"type": [
{
"additionalProperties": {
"default": "",
"type": "string"
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"description": "URL path (must start with / or ?",
"type": "string"
}
]
},
{
"default": false,
"name": "wait",
"type": "boolean"
}
],
"permission": "ExecuteAddon",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Addons.GetAddonDetails ====
Gets the details of a specific addon<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' addonid<br />
# [''[[#Addon.Fields|Addon.Fields]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#Addon.Details|Addon.Details]]'' addon<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Gets the details of a specific addon",
"params": [
{
"name": "addonid",
"required": true,
"type": "string"
},
{
"$ref": "Addon.Fields",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"addon": {
"$ref": "Addon.Details",
"required": true
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Addons.GetAddons ====
Gets all available addons<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Addon.Types|Addon.Types]]'' type = unknown]<br />
# [''[[#Addon.Content|Addon.Content]]'' content = unknown] (Content provided by the addon. Only considered for plugins and scripts.)<br />
# [''mixed: boolean|string'' enabled = all]<br />
# [''[[#Addon.Fields|Addon.Fields]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''mixed: boolean|string'' installed = True]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''array[ [[#Addon.Details|Addon.Details]] ]'' addons]<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Gets all available addons",
"params": [
{
"$ref": "Addon.Types",
"default": "unknown",
"name": "type"
},
{
"$ref": "Addon.Content",
"default": "unknown",
"description": "Content provided by the addon. Only considered for plugins and scripts.",
"name": "content"
},
{
"default": "all",
"name": "enabled",
"type": [
{
"type": "boolean"
},
{
"enums": [
"all"
],
"type": "string"
}
]
},
{
"$ref": "Addon.Fields",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"default": true,
"name": "installed",
"type": [
{
"type": "boolean"
},
{
"enums": [
"all"
],
"type": "string"
}
]
}
],
"permission": "ReadData",
"returns": {
"properties": {
"addons": {
"items": {
"$ref": "Addon.Details"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Addons.SetAddonEnabled ====
Enables/Disables a specific addon<br />
'''Permissions:'''
* ManageAddon
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' addonid<br />
# ''[[#Global.Toggle|Global.Toggle]]'' enabled<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Enables/Disables a specific addon",
"params": [
{
"name": "addonid",
"required": true,
"type": "string"
},
{
"$ref": "Global.Toggle",
"name": "enabled",
"required": true
}
],
"permission": "ManageAddon",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== Application ===
==== Application.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''array[ [[#Application.Property.Name|Application.Property.Name]] ]'' properties<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Application.Property.Value|Application.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the values of the given properties",
"params": [
{
"items": {
"$ref": "Application.Property.Name"
},
"name": "properties",
"required": true,
"type": "array",
"uniqueItems": true
}
],
"permission": "ReadData",
"returns": {
"$ref": "Application.Property.Value"
},
"type": "method"
}
</syntaxhighlight>}}
==== Application.Quit ====
Quit application<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Quit application",
"params": [],
"permission": "ControlPower",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Application.SetMute ====
Toggle mute/unmute<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Global.Toggle|Global.Toggle]]'' mute<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''boolean (Mute state)''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Toggle mute/unmute",
"params": [
{
"$ref": "Global.Toggle",
"name": "mute",
"required": true
}
],
"permission": "ControlPlayback",
"returns": {
"description": "Mute state",
"type": "boolean"
},
"type": "method"
}
</syntaxhighlight>}}
==== Application.SetVolume ====
Set the current volume<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''mixed: integer|[[#Global.IncrementDecrement|Global.IncrementDecrement]]'' volume<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''integer''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Set the current volume",
"params": [
{
"name": "volume",
"required": true,
"type": [
{
"maximum": 100,
"minimum": 0,
"type": "integer"
},
{
"$ref": "Global.IncrementDecrement"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "integer"
},
"type": "method"
}
</syntaxhighlight>}}
=== AudioLibrary ===
==== AudioLibrary.Clean ====
Cleans the audio library from non-existent items<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''boolean'' showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Cleans the audio library from non-existent items",
"params": [
{
"default": true,
"description": "Whether or not to show the progress bar or any other GUI dialog",
"name": "showdialogs",
"type": "boolean"
}
],
"permission": "RemoveData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.Export ====
Exports all items from the audio library<br />
'''Permissions:'''
* WriteFile
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''mixed: object|object'' options]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Exports all items from the audio library",
"params": [
{
"name": "options",
"type": [
{
"additionalProperties": false,
"properties": {
"path": {
"description": "Path to the directory to where the data should be exported",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"images": {
"default": false,
"description": "Whether to export thumbnails and fanart images",
"type": "boolean"
},
"overwrite": {
"default": false,
"description": "Whether to overwrite existing exported files",
"type": "boolean"
}
},
"type": "object"
}
]
}
],
"permission": "WriteFile",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetAlbumDetails ====
Retrieve details about a specific album<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' albumid<br />
# [''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#Audio.Details.Album|Audio.Details.Album]]'' albumdetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific album",
"params": [
{
"$ref": "Library.Id",
"name": "albumid",
"required": true
},
{
"$ref": "Audio.Fields.Album",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"albumdetails": {
"$ref": "Audio.Details.Album"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetAlbums ====
Retrieve all albums from specified artist (and role) or that has songs of the specified genre<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
# [''mixed: object|object|object|object|object|object|object|object|[[#List.Filter.Albums|List.Filter.Albums]]'' filter]<br />
# [''boolean'' includesingles = False]<br />
# [''boolean'' allroles = False] (Whether or not to include all roles when filtering by artist, rather than the default of excluding other contributions. When true it overrides any role filter value.)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''array[ [[#Audio.Details.Album|Audio.Details.Album]] ]'' albums]<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all albums from specified artist (and role) or that has songs of the specified genre",
"params": [
{
"$ref": "Audio.Fields.Album",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Song genre. Filter for existence of songs with this genre",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"description": "Song genre. Filter for existence of songs with this genre",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"role": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
},
"role": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Albums"
}
]
},
{
"default": false,
"name": "includesingles",
"type": "boolean"
},
{
"default": false,
"description": "Whether or not to include all roles when filtering by artist, rather than the default of excluding other contributions. When true it overrides any role filter value.",
"name": "allroles",
"type": "boolean"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"albums": {
"items": {
"$ref": "Audio.Details.Album"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetArtistDetails ====
Retrieve details about a specific artist<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' artistid<br />
# [''[[#Audio.Fields.Artist|Audio.Fields.Artist]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#Audio.Details.Artist|Audio.Details.Artist]]'' artistdetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific artist",
"params": [
{
"$ref": "Library.Id",
"name": "artistid",
"required": true
},
{
"$ref": "Audio.Fields.Artist",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"artistdetails": {
"$ref": "Audio.Details.Artist"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetArtists ====
Retrieve all artists. For backward compatibility by default this implicitly does not include those that only contribute other roles, however absolutely all artists can be returned using allroles=true<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Optional.Boolean|Optional.Boolean]]'' albumartistsonly = None] (Whether or not to only include album artists rather than the artists of only individual songs as well. If the parameter is not passed or is passed as null the GUI setting will be used)<br />
# [''[[#Audio.Fields.Artist|Audio.Fields.Artist]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
# [''mixed: object|object|object|object|object|object|object|object|object|object|object|object|object|object|object|[[#List.Filter.Artists|List.Filter.Artists]]'' filter]<br />
# [''boolean'' allroles = False] (Whether or not to include all artists irrespective of the role they contributed. When true it overrides any role filter value.)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''array[ [[#Audio.Details.Artist|Audio.Details.Artist]] ]'' artists]<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all artists. For backward compatibility by default this implicitly does not include those that only contribute other roles, however absolutely all artists can be returned using allroles=true",
"params": [
{
"$ref": "Optional.Boolean",
"default": null,
"description": "Whether or not to only include album artists rather than the artists of only individual songs as well. If the parameter is not passed or is passed as null the GUI setting will be used",
"name": "albumartistsonly"
},
{
"$ref": "Audio.Fields.Artist",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Deprecated, use songgenreid. Filter for existence of songs with this genre",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"songgenreid": {
"$ref": "Library.Id",
"description": "Song genreid. Filter for existence of songs with this genre",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"roleid": {
"$ref": "Library.Id",
"required": true
},
"songgenreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"role": {
"minLength": 1,
"required": true,
"type": "string"
},
"songgenreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"description": "Deprecated, use songgenre. Filter for existence of songs with this genre",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"songgenre": {
"description": "Song genre. Filter for existence of songs with this genre",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"roleid": {
"$ref": "Library.Id",
"required": true
},
"songgenre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"role": {
"minLength": 1,
"required": true,
"type": "string"
},
"songgenre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"albumid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"album": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"songid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"roleid": {
"$ref": "Library.Id",
"required": true
},
"songid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"role": {
"minLength": 1,
"required": true,
"type": "string"
},
"songid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"roleid": {
"$ref": "Library.Id",
"description": "Role contributed by artist. Overridden by allroles parameter",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"role": {
"description": "Role contributed by artist. Overridden by allroles parameter",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Artists"
}
]
},
{
"default": false,
"description": "Whether or not to include all artists irrespective of the role they contributed. When true it overrides any role filter value.",
"name": "allroles",
"type": "boolean"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"artists": {
"items": {
"$ref": "Audio.Details.Artist"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetAvailableArt ====
Retrieve all potential art URLs for a media item by art type<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''mixed: object|object'' item<br />
# [''string'' arttype = ""]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''array'' availableart<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all potential art URLs for a media item by art type",
"params": [
{
"name": "item",
"required": true,
"type": [
{
"additionalProperties": false,
"properties": {
"albumid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
}
]
},
{
"default": "",
"name": "arttype",
"type": "string"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"availableart": {
"items": {
"properties": {
"arttype": {
"required": true,
"type": "string"
},
"previewurl": {
"default": "",
"description": "URL to a preview thumbnail of the image",
"type": "string"
},
"url": {
"description": "URL to the original image",
"required": true,
"type": "string"
}
},
"type": "object"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetAvailableArtTypes ====
Retrieve a list of potential art types for a media item<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''mixed: object|object'' item<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''array'' availablearttypes<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve a list of potential art types for a media item",
"params": [
{
"name": "item",
"required": true,
"type": [
{
"additionalProperties": false,
"properties": {
"albumid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
}
]
}
],
"permission": "ReadData",
"returns": {
"properties": {
"availablearttypes": {
"items": {
"type": "string"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetGenres ====
Retrieve all genres<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Library.Fields.Genre|Library.Fields.Genre]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''array[ [[#Library.Details.Genre|Library.Details.Genre]] ]'' genres<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all genres",
"params": [
{
"$ref": "Library.Fields.Genre",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"genres": {
"items": {
"$ref": "Library.Details.Genre"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetProperties ====
Retrieves the values of the music library properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''array[ [[#Audio.Property.Name|Audio.Property.Name]] ]'' properties<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Audio.Property.Value|Audio.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the values of the music library properties",
"params": [
{
"items": {
"$ref": "Audio.Property.Name"
},
"name": "properties",
"required": true,
"type": "array",
"uniqueItems": true
}
],
"permission": "ReadData",
"returns": {
"$ref": "Audio.Property.Value"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetRecentlyAddedAlbums ====
Retrieve recently added albums<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''array[ [[#Audio.Details.Album|Audio.Details.Album]] ]'' albums]<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve recently added albums",
"params": [
{
"$ref": "Audio.Fields.Album",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"albums": {
"items": {
"$ref": "Audio.Details.Album"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetRecentlyAddedSongs ====
Retrieve recently added songs<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#List.Amount|List.Amount]]'' albumlimit = -1] (The amount of recently added albums from which to return the songs)<br />
# [''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# [''array[ [[#Audio.Details.Song|Audio.Details.Song]] ]'' songs]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve recently added songs",
"params": [
{
"$ref": "List.Amount",
"default": -1,
"description": "The amount of recently added albums from which to return the songs",
"name": "albumlimit"
},
{
"$ref": "Audio.Fields.Song",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"songs": {
"items": {
"$ref": "Audio.Details.Song"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetRecentlyPlayedAlbums ====
Retrieve recently played albums<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''array[ [[#Audio.Details.Album|Audio.Details.Album]] ]'' albums]<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve recently played albums",
"params": [
{
"$ref": "Audio.Fields.Album",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"albums": {
"items": {
"$ref": "Audio.Details.Album"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetRecentlyPlayedSongs ====
Retrieve recently played songs<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# [''array[ [[#Audio.Details.Song|Audio.Details.Song]] ]'' songs]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve recently played songs",
"params": [
{
"$ref": "Audio.Fields.Song",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"songs": {
"items": {
"$ref": "Audio.Details.Song"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetRoles ====
Retrieve all contributor roles<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Audio.Fields.Role|Audio.Fields.Role]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# ''array[ [[#Audio.Details.Role|Audio.Details.Role]] ]'' roles<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all contributor roles",
"params": [
{
"$ref": "Audio.Fields.Role",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"roles": {
"items": {
"$ref": "Audio.Details.Role"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetSongDetails ====
Retrieve details about a specific song<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' songid<br />
# [''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#Audio.Details.Song|Audio.Details.Song]]'' songdetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific song",
"params": [
{
"$ref": "Library.Id",
"name": "songid",
"required": true
},
{
"$ref": "Audio.Fields.Song",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"songdetails": {
"$ref": "Audio.Details.Song"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetSongs ====
Retrieve all songs from specified album, artist or genre<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
# [''mixed: object|object|object|object|object|object|object|object|object|object|[[#List.Filter.Songs|List.Filter.Songs]]'' filter]<br />
# [''boolean'' includesingles = True] (Only songs from albums are returned when false, but overridden when singlesonly parameter is true)<br />
# [''boolean'' allroles = False] (Whether or not to include all roles when filtering by artist, rather than default of excluding other contributors. When true it overrides any role filter value.)<br />
# [''boolean'' singlesonly = False] (Only singles are returned when true, and overrides includesingles parameter)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# [''array[ [[#Audio.Details.Song|Audio.Details.Song]] ]'' songs]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all songs from specified album, artist or genre",
"params": [
{
"$ref": "Audio.Fields.Song",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Song genre. Filter for existence of songs with this genre",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"description": "Song genre. Filter for existence of songs with this genre",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"role": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
},
"role": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"albumid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"album": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Songs"
}
]
},
{
"default": true,
"description": "Only songs from albums are returned when false, but overridden when singlesonly parameter is true",
"name": "includesingles",
"type": "boolean"
},
{
"default": false,
"description": "Whether or not to include all roles when filtering by artist, rather than default of excluding other contributors. When true it overrides any role filter value.",
"name": "allroles",
"type": "boolean"
},
{
"default": false,
"description": "Only singles are returned when true, and overrides includesingles parameter",
"name": "singlesonly",
"type": "boolean"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"songs": {
"items": {
"$ref": "Audio.Details.Song"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.GetSources ====
Get all music sources, including unique ID<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Library.Fields.Source|Library.Fields.Source]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# ''array[ [[#Library.Details.Source|Library.Details.Source]] ]'' sources<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get all music sources, including unique ID",
"params": [
{
"$ref": "Library.Fields.Source",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"sources": {
"items": {
"$ref": "Library.Details.Source"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.Scan ====
Scans the audio sources for new library items<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''string'' directory = ""]<br />
# [''boolean'' showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Scans the audio sources for new library items",
"params": [
{
"default": "",
"name": "directory",
"type": "string"
},
{
"default": true,
"description": "Whether or not to show the progress bar or any other GUI dialog",
"name": "showdialogs",
"type": "boolean"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.SetAlbumDetails ====
Update the given album with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' albumid<br />
# [''[[#Optional.String|Optional.String]]'' title = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' artist = None]<br />
# [''[[#Optional.String|Optional.String]]'' description = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' genre = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' theme = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' mood = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' style = None]<br />
# [''[[#Optional.String|Optional.String]]'' type = None]<br />
# [''[[#Optional.String|Optional.String]]'' albumlabel = None]<br />
# [''[[#Optional.Number|Optional.Number]]'' rating = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' year = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' votes = None]<br />
# [''[[#Optional.String|Optional.String]]'' musicbrainzalbumid = None]<br />
# [''[[#Optional.String|Optional.String]]'' musicbrainzreleasegroupid = None]<br />
# [''[[#Optional.String|Optional.String]]'' sortartist = None]<br />
# [''[[#Optional.String|Optional.String]]'' displayartist = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' musicbrainzalbumartistid = None]<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
# [''[[#Optional.Boolean|Optional.Boolean]]'' isboxset = None]<br />
# [''[[#Optional.String|Optional.String]]'' releasedate = None]<br />
# [''[[#Optional.String|Optional.String]]'' originaldate = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given album with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "albumid",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"name": "title"
},
{
"default": null,
"name": "artist",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "description"
},
{
"default": null,
"name": "genre",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "theme",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "mood",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "style",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "type"
},
{
"$ref": "Optional.String",
"default": null,
"name": "albumlabel"
},
{
"$ref": "Optional.Number",
"default": null,
"name": "rating"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "year"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "userrating"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "votes"
},
{
"$ref": "Optional.String",
"default": null,
"name": "musicbrainzalbumid"
},
{
"$ref": "Optional.String",
"default": null,
"name": "musicbrainzreleasegroupid"
},
{
"$ref": "Optional.String",
"default": null,
"name": "sortartist"
},
{
"$ref": "Optional.String",
"default": null,
"name": "displayartist"
},
{
"default": null,
"name": "musicbrainzalbumartistid",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
},
{
"$ref": "Optional.Boolean",
"default": null,
"name": "isboxset"
},
{
"$ref": "Optional.String",
"default": null,
"name": "releasedate"
},
{
"$ref": "Optional.String",
"default": null,
"name": "originaldate"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.SetArtistDetails ====
Update the given artist with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' artistid<br />
# [''[[#Optional.String|Optional.String]]'' artist = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' instrument = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' style = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' mood = None]<br />
# [''[[#Optional.String|Optional.String]]'' born = None]<br />
# [''[[#Optional.String|Optional.String]]'' formed = None]<br />
# [''[[#Optional.String|Optional.String]]'' description = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' genre = None]<br />
# [''[[#Optional.String|Optional.String]]'' died = None]<br />
# [''[[#Optional.String|Optional.String]]'' disbanded = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' yearsactive = None]<br />
# [''[[#Optional.String|Optional.String]]'' musicbrainzartistid = None]<br />
# [''[[#Optional.String|Optional.String]]'' sortname = None]<br />
# [''[[#Optional.String|Optional.String]]'' type = None]<br />
# [''[[#Optional.String|Optional.String]]'' gender = None]<br />
# [''[[#Optional.String|Optional.String]]'' disambiguation = None]<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given artist with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "artistid",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"name": "artist"
},
{
"default": null,
"name": "instrument",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "style",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "mood",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "born"
},
{
"$ref": "Optional.String",
"default": null,
"name": "formed"
},
{
"$ref": "Optional.String",
"default": null,
"name": "description"
},
{
"default": null,
"name": "genre",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "died"
},
{
"$ref": "Optional.String",
"default": null,
"name": "disbanded"
},
{
"default": null,
"name": "yearsactive",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "musicbrainzartistid"
},
{
"$ref": "Optional.String",
"default": null,
"name": "sortname"
},
{
"$ref": "Optional.String",
"default": null,
"name": "type"
},
{
"$ref": "Optional.String",
"default": null,
"name": "gender"
},
{
"$ref": "Optional.String",
"default": null,
"name": "disambiguation"
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== AudioLibrary.SetSongDetails ====
Update the given song with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' songid<br />
# [''[[#Optional.String|Optional.String]]'' title = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' artist = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' genre = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' year = None]<br />
# [''[[#Optional.Number|Optional.Number]]'' rating = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' track = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' disc = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' duration = None]<br />
# [''[[#Optional.String|Optional.String]]'' comment = None]<br />
# [''[[#Optional.String|Optional.String]]'' musicbrainztrackid = None]<br />
# [''[[#Optional.String|Optional.String]]'' musicbrainzartistid = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' playcount = None]<br />
# [''[[#Optional.String|Optional.String]]'' lastplayed = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' votes = None]<br />
# [''[[#Optional.String|Optional.String]]'' displayartist = None]<br />
# [''[[#Optional.String|Optional.String]]'' sortartist = None]<br />
# [''[[#Optional.String|Optional.String]]'' mood = None]<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
# [''[[#Optional.String|Optional.String]]'' disctitle = None]<br />
# [''[[#Optional.String|Optional.String]]'' releasedate = None]<br />
# [''[[#Optional.String|Optional.String]]'' originaldate = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' bpm = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given song with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "songid",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"name": "title"
},
{
"default": null,
"name": "artist",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "genre",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "year"
},
{
"$ref": "Optional.Number",
"default": null,
"name": "rating"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "track"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "disc"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "duration"
},
{
"$ref": "Optional.String",
"default": null,
"name": "comment"
},
{
"$ref": "Optional.String",
"default": null,
"name": "musicbrainztrackid"
},
{
"$ref": "Optional.String",
"default": null,
"name": "musicbrainzartistid"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "playcount"
},
{
"$ref": "Optional.String",
"default": null,
"name": "lastplayed"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "userrating"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "votes"
},
{
"$ref": "Optional.String",
"default": null,
"name": "displayartist"
},
{
"$ref": "Optional.String",
"default": null,
"name": "sortartist"
},
{
"$ref": "Optional.String",
"default": null,
"name": "mood"
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "disctitle"
},
{
"$ref": "Optional.String",
"default": null,
"name": "releasedate"
},
{
"$ref": "Optional.String",
"default": null,
"name": "originaldate"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "bpm"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== Favourites ===
==== Favourites.AddFavourite ====
Add a favourite with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' title<br />
# ''[[#Favourite.Type|Favourite.Type]]'' type<br />
# [''[[#Optional.String|Optional.String]]'' path = None] (Required for media, script and androidapp favourites types)<br />
# [''[[#Optional.String|Optional.String]]'' window = None] (Required for window favourite type)<br />
# [''[[#Optional.String|Optional.String]]'' windowparameter = None]<br />
# [''[[#Optional.String|Optional.String]]'' thumbnail = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Add a favourite with the given details",
"params": [
{
"name": "title",
"required": true,
"type": "string"
},
{
"$ref": "Favourite.Type",
"name": "type",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"description": "Required for media, script and androidapp favourites types",
"name": "path"
},
{
"$ref": "Optional.String",
"default": null,
"description": "Required for window favourite type",
"name": "window"
},
{
"$ref": "Optional.String",
"default": null,
"name": "windowparameter"
},
{
"$ref": "Optional.String",
"default": null,
"name": "thumbnail"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Favourites.GetFavourites ====
Retrieve all favourites<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''mixed: null|[[#Favourite.Type|Favourite.Type]]'' type = None]<br />
# [''[[#Favourite.Fields.Favourite|Favourite.Fields.Favourite]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''array[ [[#Favourite.Details.Favourite|Favourite.Details.Favourite]] ]'' favourites]<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all favourites",
"params": [
{
"default": null,
"name": "type",
"type": [
{
"type": "null"
},
{
"$ref": "Favourite.Type"
}
]
},
{
"$ref": "Favourite.Fields.Favourite",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"favourites": {
"items": {
"$ref": "Favourite.Details.Favourite"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
=== Files ===
==== Files.Download ====
Downloads the given file<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' path<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''any''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Downloads the given file",
"params": [
{
"name": "path",
"required": true,
"type": "string"
}
],
"permission": "ReadData",
"returns": {
"type": "any"
},
"type": "method"
}
</syntaxhighlight>}}
==== Files.GetDirectory ====
Get the directories and files in the given directory<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' directory<br />
# [''[[#Files.Media|Files.Media]]'' media = files]<br />
# [''[[#List.Fields.Files|List.Fields.Files]]'' properties]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
# [''[[#List.Limits|List.Limits]]'' limits] (Limits are applied after getting the directory content thus retrieval is not faster when they are applied.)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''array[ [[#List.Item.File|List.Item.File]] ]'' files<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get the directories and files in the given directory",
"params": [
{
"name": "directory",
"required": true,
"type": "string"
},
{
"$ref": "Files.Media",
"default": "files",
"name": "media"
},
{
"$ref": "List.Fields.Files",
"name": "properties"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"$ref": "List.Limits",
"description": "Limits are applied after getting the directory content thus retrieval is not faster when they are applied.",
"name": "limits"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"files": {
"items": {
"$ref": "List.Item.File"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Files.GetFileDetails ====
Get details for a specific file<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' file (Full path to the file)<br />
# [''[[#Files.Media|Files.Media]]'' media = files]<br />
# [''[[#List.Fields.Files|List.Fields.Files]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.Item.File|List.Item.File]]'' filedetails<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get details for a specific file",
"params": [
{
"description": "Full path to the file",
"name": "file",
"required": true,
"type": "string"
},
{
"$ref": "Files.Media",
"default": "files",
"name": "media"
},
{
"$ref": "List.Fields.Files",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"filedetails": {
"$ref": "List.Item.File",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Files.GetSources ====
Get the sources of the media windows<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Files.Media|Files.Media]]'' media<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# ''[[#List.Items.Sources|List.Items.Sources]]'' sources<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get the sources of the media windows",
"params": [
{
"$ref": "Files.Media",
"name": "media",
"required": true
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"sources": {
"$ref": "List.Items.Sources",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Files.PrepareDownload ====
Provides a way to download a given file (e.g. providing an URL to the real file location)<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' path<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''any'' details (Transport specific details on how/from where to download the given file)<br />
# ''string'' mode (Direct mode allows using Files.Download whereas redirect mode requires the usage of a different protocol)<br />
# ''string'' protocol<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Provides a way to download a given file (e.g. providing an URL to the real file location)",
"params": [
{
"name": "path",
"required": true,
"type": "string"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"details": {
"description": "Transport specific details on how/from where to download the given file",
"required": true,
"type": "any"
},
"mode": {
"description": "Direct mode allows using Files.Download whereas redirect mode requires the usage of a different protocol",
"enums": [
"redirect",
"direct"
],
"required": true,
"type": "string"
},
"protocol": {
"enums": [
"http"
],
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Files.SetFileDetails ====
Update the given specific file with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' file (Full path to the file)<br />
# ''[[#Files.Media|Files.Media]]'' media (File type to update correct database. Currently only "video" is supported.)<br />
# [''[[#Optional.Integer|Optional.Integer]]'' playcount = None]<br />
# [''[[#Optional.String|Optional.String]]'' lastplayed = None] (Setting a valid lastplayed without a playcount will force playcount to 1.)<br />
# [''mixed: null|[[#Video.Resume|Video.Resume]]'' resume = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given specific file with the given details",
"params": [
{
"description": "Full path to the file",
"name": "file",
"required": true,
"type": "string"
},
{
"$ref": "Files.Media",
"description": "File type to update correct database. Currently only \"video\" is supported.",
"name": "media",
"required": true
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "playcount"
},
{
"$ref": "Optional.String",
"default": null,
"description": "Setting a valid lastplayed without a playcount will force playcount to 1.",
"name": "lastplayed"
},
{
"default": null,
"name": "resume",
"type": [
{
"type": "null"
},
{
"$ref": "Video.Resume"
}
]
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== GUI ===
==== GUI.ActivateWindow ====
Activates the given window<br />
'''Permissions:'''
* ControlGUI
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#GUI.Window|GUI.Window]]'' window<br />
# [''array[string]'' parameters]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Activates the given window",
"params": [
{
"$ref": "GUI.Window",
"name": "window",
"required": true
},
{
"items": {
"minLength": 1,
"type": "string"
},
"minItems": 1,
"name": "parameters",
"type": "array"
}
],
"permission": "ControlGUI",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== GUI.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''array[ [[#GUI.Property.Name|GUI.Property.Name]] ]'' properties<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#GUI.Property.Value|GUI.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the values of the given properties",
"params": [
{
"items": {
"$ref": "GUI.Property.Name"
},
"name": "properties",
"required": true,
"type": "array",
"uniqueItems": true
}
],
"permission": "ReadData",
"returns": {
"$ref": "GUI.Property.Value"
},
"type": "method"
}
</syntaxhighlight>}}
==== GUI.GetStereoscopicModes ====
Returns the supported stereoscopic modes of the GUI<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''array[ [[#GUI.Stereoscopy.Mode|GUI.Stereoscopy.Mode]] ]'' stereoscopicmodes]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Returns the supported stereoscopic modes of the GUI",
"params": [],
"permission": "ReadData",
"returns": {
"properties": {
"stereoscopicmodes": {
"items": {
"$ref": "GUI.Stereoscopy.Mode"
},
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== GUI.SetFullscreen ====
Toggle fullscreen/GUI<br />
'''Permissions:'''
* ControlGUI
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Global.Toggle|Global.Toggle]]'' fullscreen<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''boolean (Fullscreen state)''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Toggle fullscreen/GUI",
"params": [
{
"$ref": "Global.Toggle",
"name": "fullscreen",
"required": true
}
],
"permission": "ControlGUI",
"returns": {
"description": "Fullscreen state",
"type": "boolean"
},
"type": "method"
}
</syntaxhighlight>}}
==== GUI.SetStereoscopicMode ====
Sets the stereoscopic mode of the GUI to the given mode<br />
'''Permissions:'''
* ControlGUI
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' mode<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Sets the stereoscopic mode of the GUI to the given mode",
"params": [
{
"enums": [
"toggle",
"tomono",
"next",
"previous",
"select",
"off",
"split_vertical",
"split_horizontal",
"row_interleaved",
"hardware_based",
"anaglyph_cyan_red",
"anaglyph_green_magenta",
"monoscopic"
],
"name": "mode",
"required": true,
"type": "string"
}
],
"permission": "ControlGUI",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== GUI.ShowNotification ====
Shows a GUI notification<br />
'''Permissions:'''
* ControlGUI
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' title<br />
# ''string'' message<br />
# [''mixed: string|string'' image = ""]<br />
# [''integer'' displaytime = 5000] (The time in milliseconds the notification will be visible)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Shows a GUI notification",
"params": [
{
"name": "title",
"required": true,
"type": "string"
},
{
"name": "message",
"required": true,
"type": "string"
},
{
"default": "",
"name": "image",
"type": [
{
"enums": [
"info",
"warning",
"error"
],
"type": "string"
},
{
"type": "string"
}
]
},
{
"default": 5000,
"description": "The time in milliseconds the notification will be visible",
"minimum": 1500,
"name": "displaytime",
"type": "integer"
}
],
"permission": "ControlGUI",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== Input ===
==== Input.Back ====
Goes back in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Goes back in GUI",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.ButtonEvent ====
Send a button press event<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' button (Button name)<br />
# ''string'' keymap (Keymap name (KB, XG, R1, or R2))<br />
# [''integer'' holdtime = 0] (Number of milliseconds to simulate button hold.)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Send a button press event",
"params": [
{
"description": "Button name",
"name": "button",
"required": true,
"type": "string"
},
{
"description": "Keymap name (KB, XG, R1, or R2)",
"enums": [
"KB",
"XG",
"R1",
"R2"
],
"name": "keymap",
"required": true,
"type": "string"
},
{
"default": 0,
"description": "Number of milliseconds to simulate button hold.",
"minimum": 0,
"name": "holdtime",
"type": "integer"
}
],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.ContextMenu ====
Shows the context menu<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Shows the context menu",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.Down ====
Navigate down in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Navigate down in GUI",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.ExecuteAction ====
Execute a specific action<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Input.Action|Input.Action]]'' action<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Execute a specific action",
"params": [
{
"$ref": "Input.Action",
"name": "action",
"required": true
}
],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.Home ====
Goes to home window in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Goes to home window in GUI",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.Info ====
Shows the information dialog<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Shows the information dialog",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.Left ====
Navigate left in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Navigate left in GUI",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.Right ====
Navigate right in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Navigate right in GUI",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.Select ====
Select current item in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Select current item in GUI",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.SendText ====
Send a generic (unicode) text<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' text (Unicode text)<br />
# [''boolean'' done = True] (Whether this is the whole input or not (closes an open input dialog if true).)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Send a generic (unicode) text",
"params": [
{
"description": "Unicode text",
"name": "text",
"required": true,
"type": "string"
},
{
"default": true,
"description": "Whether this is the whole input or not (closes an open input dialog if true).",
"name": "done",
"type": "boolean"
}
],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.ShowCodec ====
Show codec information of the playing item<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Show codec information of the playing item",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.ShowOSD ====
Show the on-screen display for the current player<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Show the on-screen display for the current player",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.ShowPlayerProcessInfo ====
Show player process information of the playing item, like video decoder, pixel format, pvr signal strength, ...<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Show player process information of the playing item, like video decoder, pixel format, pvr signal strength, ...",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Input.Up ====
Navigate up in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Navigate up in GUI",
"params": [],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== JSONRPC ===
==== JSONRPC.GetConfiguration ====
Get client-specific configurations<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Configuration|Configuration]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get client-specific configurations",
"params": [],
"permission": "ReadData",
"returns": {
"$ref": "Configuration"
},
"type": "method"
}
</syntaxhighlight>}}
==== JSONRPC.Introspect ====
Enumerates all actions and descriptions<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''boolean'' getdescriptions = True]<br />
# [''boolean'' getmetadata = False]<br />
# [''boolean'' filterbytransport = True]<br />
# [''object'' filter]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Enumerates all actions and descriptions",
"params": [
{
"default": true,
"name": "getdescriptions",
"type": "boolean"
},
{
"default": false,
"name": "getmetadata",
"type": "boolean"
},
{
"default": true,
"name": "filterbytransport",
"type": "boolean"
},
{
"name": "filter",
"properties": {
"getreferences": {
"default": true,
"description": "Whether or not to print the schema for referenced types",
"type": "boolean"
},
"id": {
"description": "Name of a namespace, method or type",
"required": true,
"type": "string"
},
"type": {
"description": "Type of the given name",
"enums": [
"method",
"namespace",
"type",
"notification"
],
"required": true,
"type": "string"
}
},
"type": "object"
}
],
"permission": "ReadData",
"returns": {
"additionalProperties": false,
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== JSONRPC.NotifyAll ====
Notify all other connected clients<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender<br />
# ''string'' message<br />
# [''any'' data = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''any''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Notify all other connected clients",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "message",
"required": true,
"type": "string"
},
{
"default": null,
"name": "data",
"type": "any"
}
],
"permission": "ReadData",
"returns": {
"type": "any"
},
"type": "method"
}
</syntaxhighlight>}}
==== JSONRPC.Permission ====
Retrieve the clients permissions<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''boolean'' controlgui<br />
# ''boolean'' controlnotify<br />
# ''boolean'' controlplayback<br />
# ''boolean'' controlpower<br />
# ''boolean'' controlpvr<br />
# ''boolean'' controlsystem<br />
# ''boolean'' executeaddon<br />
# ''boolean'' manageaddon<br />
# ''boolean'' navigate<br />
# ''boolean'' readdata<br />
# ''boolean'' removedata<br />
# ''boolean'' updatedata<br />
# ''boolean'' writefile<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve the clients permissions",
"params": [],
"permission": "ReadData",
"returns": {
"properties": {
"controlgui": {
"required": true,
"type": "boolean"
},
"controlnotify": {
"required": true,
"type": "boolean"
},
"controlplayback": {
"required": true,
"type": "boolean"
},
"controlpower": {
"required": true,
"type": "boolean"
},
"controlpvr": {
"required": true,
"type": "boolean"
},
"controlsystem": {
"required": true,
"type": "boolean"
},
"executeaddon": {
"required": true,
"type": "boolean"
},
"manageaddon": {
"required": true,
"type": "boolean"
},
"navigate": {
"required": true,
"type": "boolean"
},
"readdata": {
"required": true,
"type": "boolean"
},
"removedata": {
"required": true,
"type": "boolean"
},
"updatedata": {
"required": true,
"type": "boolean"
},
"writefile": {
"required": true,
"type": "boolean"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== JSONRPC.Ping ====
Ping responder<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Ping responder",
"params": [],
"permission": "ReadData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== JSONRPC.SetConfiguration ====
Change the client-specific configuration<br />
'''Permissions:'''
* ControlNotify
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''object'' notifications]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Configuration|Configuration]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Change the client-specific configuration",
"params": [
{
"name": "notifications",
"properties": {
"application": {
"$ref": "Optional.Boolean",
"default": null
},
"audiolibrary": {
"$ref": "Optional.Boolean",
"default": null
},
"gui": {
"$ref": "Optional.Boolean",
"default": null
},
"input": {
"$ref": "Optional.Boolean",
"default": null
},
"other": {
"$ref": "Optional.Boolean",
"default": null
},
"player": {
"$ref": "Optional.Boolean",
"default": null
},
"playlist": {
"$ref": "Optional.Boolean",
"default": null
},
"system": {
"$ref": "Optional.Boolean",
"default": null
},
"videolibrary": {
"$ref": "Optional.Boolean",
"default": null
}
},
"type": "object"
}
],
"permission": "ControlNotify",
"returns": {
"$ref": "Configuration"
},
"type": "method"
}
</syntaxhighlight>}}
==== JSONRPC.Version ====
Retrieve the JSON-RPC protocol version.<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''object'' version<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve the JSON-RPC protocol version.",
"params": [],
"permission": "ReadData",
"returns": {
"properties": {
"version": {
"properties": {
"major": {
"description": "Bumped on backwards incompatible changes to the API definition",
"minimum": 0,
"required": true,
"type": "integer"
},
"minor": {
"description": "Bumped on backwards compatible additions/changes to the API definition",
"minimum": 0,
"required": true,
"type": "integer"
},
"patch": {
"description": "Bumped on any changes to the internal implementation but not to the API definition",
"minimum": 0,
"required": true,
"type": "integer"
}
},
"required": true,
"type": "object"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
=== PVR ===
==== PVR.AddTimer ====
Adds a timer to record the given show one times or a timer rule to record all showings of the given show or adds a reminder timer or reminder timer rule<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' broadcastid (the broadcast id of the item to record)<br />
# [''boolean'' timerrule = False] (controls whether to create a timer rule or a onetime timer)<br />
# [''boolean'' reminder = False] (controls whether to create a reminder timer or a recording timer)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Adds a timer to record the given show one times or a timer rule to record all showings of the given show or adds a reminder timer or reminder timer rule",
"params": [
{
"$ref": "Library.Id",
"description": "the broadcast id of the item to record",
"name": "broadcastid",
"required": true
},
{
"default": false,
"description": "controls whether to create a timer rule or a onetime timer",
"name": "timerrule",
"type": "boolean"
},
{
"default": false,
"description": "controls whether to create a reminder timer or a recording timer",
"name": "reminder",
"type": "boolean"
}
],
"permission": "ControlPVR",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.DeleteTimer ====
Deletes a onetime timer or a timer rule<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' timerid (the id of the onetime timer or timer rule to delete)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Deletes a onetime timer or a timer rule",
"params": [
{
"$ref": "Library.Id",
"description": "the id of the onetime timer or timer rule to delete",
"name": "timerid",
"required": true
}
],
"permission": "ControlPVR",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetBroadcastDetails ====
Retrieves the details of a specific broadcast<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' broadcastid<br />
# [''[[#PVR.Fields.Broadcast|PVR.Fields.Broadcast]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#PVR.Details.Broadcast|PVR.Details.Broadcast]]'' broadcastdetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the details of a specific broadcast",
"params": [
{
"$ref": "Library.Id",
"name": "broadcastid",
"required": true
},
{
"$ref": "PVR.Fields.Broadcast",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"broadcastdetails": {
"$ref": "PVR.Details.Broadcast"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetBroadcastIsPlayable ====
Retrieves whether or not a broadcast is playable<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' broadcastid (the id of the broadcast to to check for playability)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''boolean''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves whether or not a broadcast is playable",
"params": [
{
"$ref": "Library.Id",
"description": "the id of the broadcast to to check for playability",
"name": "broadcastid",
"required": true
}
],
"permission": "ReadData",
"returns": {
"type": "boolean"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetBroadcasts ====
Retrieves the program of a specific channel<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' channelid<br />
# [''[[#PVR.Fields.Broadcast|PVR.Fields.Broadcast]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''array[ [[#PVR.Details.Broadcast|PVR.Details.Broadcast]] ]'' broadcasts<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the program of a specific channel",
"params": [
{
"$ref": "Library.Id",
"name": "channelid",
"required": true
},
{
"$ref": "PVR.Fields.Broadcast",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"broadcasts": {
"items": {
"$ref": "PVR.Details.Broadcast"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetChannelDetails ====
Retrieves the details of a specific channel<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' channelid<br />
# [''[[#PVR.Fields.Channel|PVR.Fields.Channel]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#PVR.Details.Channel|PVR.Details.Channel]]'' channeldetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the details of a specific channel",
"params": [
{
"$ref": "Library.Id",
"name": "channelid",
"required": true
},
{
"$ref": "PVR.Fields.Channel",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"channeldetails": {
"$ref": "PVR.Details.Channel"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetChannelGroupDetails ====
Retrieves the details of a specific channel group<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#PVR.ChannelGroup.Id|PVR.ChannelGroup.Id]]'' channelgroupid<br />
# [''object'' channels]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#PVR.Details.ChannelGroup.Extended|PVR.Details.ChannelGroup.Extended]]'' channelgroupdetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the details of a specific channel group",
"params": [
{
"$ref": "PVR.ChannelGroup.Id",
"name": "channelgroupid",
"required": true
},
{
"name": "channels",
"properties": {
"limits": {
"$ref": "List.Limits"
},
"properties": {
"$ref": "PVR.Fields.Channel"
}
},
"type": "object"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"channelgroupdetails": {
"$ref": "PVR.Details.ChannelGroup.Extended"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetChannelGroups ====
Retrieves the channel groups for the specified type<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''array[ [[#PVR.Details.ChannelGroup|PVR.Details.ChannelGroup]] ]'' channelgroups<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the channel groups for the specified type",
"params": [
{
"$ref": "PVR.Channel.Type",
"name": "channeltype",
"required": true
},
{
"$ref": "List.Limits",
"name": "limits"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"channelgroups": {
"items": {
"$ref": "PVR.Details.ChannelGroup"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetChannels ====
Retrieves the channel list<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#PVR.ChannelGroup.Id|PVR.ChannelGroup.Id]]'' channelgroupid<br />
# [''[[#PVR.Fields.Channel|PVR.Fields.Channel]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''array[ [[#PVR.Details.Channel|PVR.Details.Channel]] ]'' channels<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the channel list",
"params": [
{
"$ref": "PVR.ChannelGroup.Id",
"name": "channelgroupid",
"required": true
},
{
"$ref": "PVR.Fields.Channel",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"channels": {
"items": {
"$ref": "PVR.Details.Channel"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetClients ====
Retrieves the enabled PVR clients and their capabilities<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#List.Limits|List.Limits]]'' limits]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''array[ [[#PVR.Details.Client|PVR.Details.Client]] ]'' clients<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the enabled PVR clients and their capabilities",
"params": [
{
"$ref": "List.Limits",
"name": "limits"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"clients": {
"items": {
"$ref": "PVR.Details.Client"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''array[ [[#PVR.Property.Name|PVR.Property.Name]] ]'' properties<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#PVR.Property.Value|PVR.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the values of the given properties",
"params": [
{
"items": {
"$ref": "PVR.Property.Name"
},
"name": "properties",
"required": true,
"type": "array",
"uniqueItems": true
}
],
"permission": "ReadData",
"returns": {
"$ref": "PVR.Property.Value"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetRecordingDetails ====
Retrieves the details of a specific recording<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' recordingid<br />
# [''[[#PVR.Fields.Recording|PVR.Fields.Recording]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#PVR.Details.Recording|PVR.Details.Recording]]'' recordingdetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the details of a specific recording",
"params": [
{
"$ref": "Library.Id",
"name": "recordingid",
"required": true
},
{
"$ref": "PVR.Fields.Recording",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"recordingdetails": {
"$ref": "PVR.Details.Recording"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetRecordings ====
Retrieves the recordings<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#PVR.Fields.Recording|PVR.Fields.Recording]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# ''array[ [[#PVR.Details.Recording|PVR.Details.Recording]] ]'' recordings<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the recordings",
"params": [
{
"$ref": "PVR.Fields.Recording",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"recordings": {
"items": {
"$ref": "PVR.Details.Recording"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetTimerDetails ====
Retrieves the details of a specific timer<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' timerid<br />
# [''[[#PVR.Fields.Timer|PVR.Fields.Timer]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#PVR.Details.Timer|PVR.Details.Timer]]'' timerdetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the details of a specific timer",
"params": [
{
"$ref": "Library.Id",
"name": "timerid",
"required": true
},
{
"$ref": "PVR.Fields.Timer",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"timerdetails": {
"$ref": "PVR.Details.Timer"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.GetTimers ====
Retrieves the timers<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#PVR.Fields.Timer|PVR.Fields.Timer]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# ''array[ [[#PVR.Details.Timer|PVR.Details.Timer]] ]'' timers<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the timers",
"params": [
{
"$ref": "PVR.Fields.Timer",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"timers": {
"items": {
"$ref": "PVR.Details.Timer"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.Record ====
Toggle recording of a channel<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Global.Toggle|Global.Toggle]]'' record = toggle]<br />
# [''mixed: string|[[#Library.Id|Library.Id]]'' channel = current]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Toggle recording of a channel",
"params": [
{
"$ref": "Global.Toggle",
"default": "toggle",
"name": "record"
},
{
"default": "current",
"name": "channel",
"type": [
{
"enums": [
"current"
],
"type": "string"
},
{
"$ref": "Library.Id"
}
]
}
],
"permission": "ControlPVR",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.Scan ====
Starts a channel scan<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Library.Id|Library.Id]]'' clientid = -1] (Specify a PVR client id to avoid UI dialog, optional in kodi 19, required in kodi 20)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Starts a channel scan",
"params": [
{
"$ref": "Library.Id",
"default": -1,
"description": "Specify a PVR client id to avoid UI dialog, optional in kodi 19, required in kodi 20",
"name": "clientid"
}
],
"permission": "ControlPVR",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== PVR.ToggleTimer ====
Creates or deletes a onetime timer or timer rule for a given show. If it exists, it will be deleted. If it does not exist, it will be created<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' broadcastid (the broadcast id of the item to toggle a onetime timer or time rule for)<br />
# [''boolean'' timerrule = False] (controls whether to create / delete a timer rule or a onetime timer)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Creates or deletes a onetime timer or timer rule for a given show. If it exists, it will be deleted. If it does not exist, it will be created",
"params": [
{
"$ref": "Library.Id",
"description": "the broadcast id of the item to toggle a onetime timer or time rule for",
"name": "broadcastid",
"required": true
},
{
"default": false,
"description": "controls whether to create / delete a timer rule or a onetime timer",
"name": "timerrule",
"type": "boolean"
}
],
"permission": "ControlPVR",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== Player ===
==== Player.AddSubtitle ====
Add subtitle to the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# ''string'' subtitle (Local path or remote URL to the subtitle file to load)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Add subtitle to the player",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"description": "Local path or remote URL to the subtitle file to load",
"name": "subtitle",
"required": true,
"type": "string"
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.GetAudioDelay ====
Get the audio delay for the current playback<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[number]]'' offset] The offset value used in the current playback.<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Returns the offset value used in the current playback",
"params": [],
"permission": "ReadData",
"returns": {
"properties": {
"offset": {
"description": "The offset value used in the current playback.",
"required": true,
"type": "number"
}
},
"type": "object",
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.GetActivePlayers ====
Returns all active players<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''array''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Returns all active players",
"params": [],
"permission": "ReadData",
"returns": {
"items": {
"properties": {
"playerid": {
"$ref": "Player.Id",
"required": true
},
"playertype": {
"enums": [
"internal",
"external",
"remote"
],
"required": true,
"type": "string"
},
"type": {
"$ref": "Player.Type",
"required": true
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.GetItem ====
Retrieves the currently played item<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# [''[[#List.Fields.All|List.Fields.All]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.Item.All|List.Item.All]]'' item<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the currently played item",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"$ref": "List.Fields.All",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"item": {
"$ref": "List.Item.All",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.GetPlayers ====
Get a list of available players<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''string'' media = all]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''array''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get a list of available players",
"params": [
{
"default": "all",
"enums": [
"all",
"video",
"audio"
],
"name": "media",
"type": "string"
}
],
"permission": "ReadData",
"returns": {
"items": {
"properties": {
"name": {
"$ref": "Global.String.NotEmpty",
"required": true
},
"playsaudio": {
"required": true,
"type": "boolean"
},
"playsvideo": {
"required": true,
"type": "boolean"
},
"type": {
"enums": [
"internal",
"external",
"remote"
],
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# ''array[ [[#Player.Property.Name|Player.Property.Name]] ]'' properties<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Player.Property.Value|Player.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the values of the given properties",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"items": {
"$ref": "Player.Property.Name"
},
"name": "properties",
"required": true,
"type": "array",
"uniqueItems": true
}
],
"permission": "ReadData",
"returns": {
"$ref": "Player.Property.Value"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.GetViewMode ====
Get view mode of video player<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''boolean'' nonlinearstretch<br />
# ''number'' pixelratio<br />
# ''number'' verticalshift<br />
# ''[[#Player.ViewMode|Player.ViewMode]]'' viewmode<br />
# ''number'' zoom<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get view mode of video player",
"params": [],
"permission": "ReadData",
"returns": {
"properties": {
"nonlinearstretch": {
"required": true,
"type": "boolean"
},
"pixelratio": {
"required": true,
"type": "number"
},
"verticalshift": {
"required": true,
"type": "number"
},
"viewmode": {
"$ref": "Player.ViewMode",
"required": true
},
"zoom": {
"required": true,
"type": "number"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.GoTo ====
Go to previous/next/specific item in the playlist<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# ''mixed: string|[[#Playlist.Position|Playlist.Position]]'' to<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Go to previous/next/specific item in the playlist",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "to",
"required": true,
"type": [
{
"enums": [
"previous",
"next"
],
"type": "string"
},
{
"$ref": "Playlist.Position",
"description": "position in playlist"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.Move ====
If picture is zoomed move viewport left/right/up/down otherwise skip previous/next<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# ''string'' direction<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "If picture is zoomed move viewport left/right/up/down otherwise skip previous/next",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"enums": [
"left",
"right",
"up",
"down"
],
"name": "direction",
"required": true,
"type": "string"
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.Open ====
Start playback of either the playlist with the given ID, a slideshow with the pictures from the given directory or a single file or an item from the database.<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''mixed: object|[[#Playlist.Item|Playlist.Item]]|object|object|object|object|object'' item]<br />
# [''object'' options]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Start playback of either the playlist with the given ID, a slideshow with the pictures from the given directory or a single file or an item from the database.",
"params": [
{
"name": "item",
"type": [
{
"additionalProperties": false,
"properties": {
"playlistid": {
"$ref": "Playlist.Id",
"required": true
},
"position": {
"$ref": "Playlist.Position",
"default": 0
}
},
"type": "object"
},
{
"$ref": "Playlist.Item"
},
{
"additionalProperties": false,
"properties": {
"path": {
"required": true,
"type": "string"
},
"random": {
"default": true,
"description": "Deprecated, use the shuffled property of the options parameter instead",
"type": "boolean"
},
"recursive": {
"default": true,
"type": "boolean"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"partymode": {
"default": "",
"type": [
{
"enums": [
"music",
"video"
],
"type": "string"
},
{
"description": "Path to a smartplaylist (*.xsp) file",
"minLength": 5,
"type": "string"
}
]
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"broadcastid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"channelid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"recordingid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
}
]
},
{
"additionalProperties": false,
"name": "options",
"properties": {
"playername": {
"default": null,
"type": [
{
"type": "null"
},
{
"enums": [
"default"
],
"type": "string"
},
{
"description": "name of player",
"minLength": 1,
"type": "string"
}
]
},
"repeat": {
"default": null,
"type": [
{
"type": "null"
},
{
"$ref": "Player.Repeat"
}
]
},
"resume": {
"default": false,
"type": [
{
"description": "Whether to resume from the resume point or not",
"type": "boolean"
},
{
"$ref": "Player.Position.Percentage",
"description": "Percentage value to start from"
},
{
"$ref": "Player.Position.Time",
"description": "Time to start from"
}
]
},
"shuffled": {
"$ref": "Optional.Boolean",
"default": null
}
},
"type": "object"
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.PlayPause ====
Pauses or unpause playback and returns the new state<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# [''[[#Global.Toggle|Global.Toggle]]'' play = toggle]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Player.Speed|Player.Speed]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Pauses or unpause playback and returns the new state",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"$ref": "Global.Toggle",
"default": "toggle",
"name": "play"
}
],
"permission": "ControlPlayback",
"returns": {
"$ref": "Player.Speed"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.Rotate ====
Rotates current picture<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# [''string'' value = clockwise]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Rotates current picture",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"default": "clockwise",
"enums": [
"clockwise",
"counterclockwise"
],
"name": "value",
"type": "string"
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.Seek ====
Seek through the playing item<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# ''mixed: object|object|object|object'' value<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#Player.Position.Percentage|Player.Position.Percentage]]'' percentage]<br />
# [''[[#Global.Time|Global.Time]]'' time] (A duration.)<br />
# [''[[#Global.Time|Global.Time]]'' totaltime] (A duration.)<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Seek through the playing item",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "value",
"required": true,
"type": [
{
"additionalProperties": false,
"properties": {
"percentage": {
"$ref": "Player.Position.Percentage",
"description": "Percentage value to seek to",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"time": {
"$ref": "Player.Position.Time",
"description": "Time to seek to",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"step": {
"description": "Seek by predefined jumps",
"enums": [
"smallforward",
"smallbackward",
"bigforward",
"bigbackward"
],
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"seconds": {
"description": "Seek by the given number of seconds",
"required": true,
"type": "integer"
}
},
"type": "object"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"properties": {
"percentage": {
"$ref": "Player.Position.Percentage",
"default": 0.0
},
"time": {
"$ref": "Global.Time",
"description": "A duration."
},
"totaltime": {
"$ref": "Global.Time",
"description": "A duration."
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.SetAudioDelay ====
Set the audio delay for the current playback<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# ''number'' offset<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[number]]'' offset] The offset value used in the current playback.<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"params": [
{
"name": "playerid",
"$ref": "Player.Id",
"required": true
},
{
"name": "offset",
"type": [
{
"type": "number",
"description": "The value should be a multiple of 0.025 in a range of +/-10 (the default range can be overriden by advancedsettings.xml).",
"required": true
},
{
"$ref": "Global.IncrementDecrement",
"required": true
}
],
"required": true
}
],
"permission": "ControlPlayback",
"returns": {
"type": "object",
"properties": {
"offset": {
"type": "number",
"description": "The offset value used in the current playback.",
"required": true
}
}
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.SetAudioStream ====
Set the audio stream played by the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# ''mixed: string|integer'' stream<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Set the audio stream played by the player",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "stream",
"required": true,
"type": [
{
"enums": [
"previous",
"next"
],
"type": "string"
},
{
"description": "Index of the audio stream to play",
"minimum": 0,
"type": "integer"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.SetPartymode ====
Turn partymode on or off<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# ''[[#Global.Toggle|Global.Toggle]]'' partymode<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Turn partymode on or off",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"$ref": "Global.Toggle",
"name": "partymode",
"required": true
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.SetRepeat ====
Set the repeat mode of the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# ''mixed: [[#Player.Repeat|Player.Repeat]]|string'' repeat<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Set the repeat mode of the player",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "repeat",
"required": true,
"type": [
{
"$ref": "Player.Repeat"
},
{
"enums": [
"cycle"
],
"type": "string"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.SetShuffle ====
Shuffle/Unshuffle items in the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# ''[[#Global.Toggle|Global.Toggle]]'' shuffle<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Shuffle/Unshuffle items in the player",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"$ref": "Global.Toggle",
"name": "shuffle",
"required": true
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.SetSpeed ====
Set the speed of the current playback<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# ''mixed: integer|[[#Global.IncrementDecrement|Global.IncrementDecrement]]'' speed<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Player.Speed|Player.Speed]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Set the speed of the current playback",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "speed",
"required": true,
"type": [
{
"enums": [
-32,
-16,
-8,
-4,
-2,
-1,
0,
1,
2,
4,
8,
16,
32
],
"type": "integer"
},
{
"$ref": "Global.IncrementDecrement"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"$ref": "Player.Speed"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.SetSubtitle ====
Set the subtitle displayed by the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# ''mixed: string|integer'' subtitle<br />
# [''boolean'' enable = False] (Whether to enable subtitles to be displayed after setting the new subtitle)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Set the subtitle displayed by the player",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "subtitle",
"required": true,
"type": [
{
"enums": [
"previous",
"next",
"off",
"on"
],
"type": "string"
},
{
"description": "Index of the subtitle to display",
"minimum": 0,
"type": "integer"
}
]
},
{
"default": false,
"description": "Whether to enable subtitles to be displayed after setting the new subtitle",
"name": "enable",
"type": "boolean"
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.SetVideoStream ====
Set the video stream played by the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# ''mixed: string|integer'' stream<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Set the video stream played by the player",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "stream",
"required": true,
"type": [
{
"enums": [
"previous",
"next"
],
"type": "string"
},
{
"description": "Index of the video stream to play",
"minimum": 0,
"type": "integer"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.SetViewMode ====
Set view mode of video player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''mixed: [[#Player.CustomViewMode|Player.CustomViewMode]]|[[#Player.ViewMode|Player.ViewMode]]'' viewmode<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Set view mode of video player",
"params": [
{
"name": "viewmode",
"required": true,
"type": [
{
"$ref": "Player.CustomViewMode",
"description": "Custom view mode"
},
{
"$ref": "Player.ViewMode"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.Stop ====
Stops playback<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Stops playback",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Player.Zoom ====
Zoom current picture<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid<br />
# ''mixed: string|integer'' zoom<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Zoom current picture",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"name": "zoom",
"required": true,
"type": [
{
"enums": [
"in",
"out"
],
"type": "string"
},
{
"description": "zoom level",
"maximum": 10,
"minimum": 1,
"type": "integer"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== Playlist ===
==== Playlist.Add ====
Add item(s) to playlist<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid<br />
# ''mixed: [[#Playlist.Item|Playlist.Item]]|array'' item<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Add item(s) to playlist",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"name": "item",
"required": true,
"type": [
{
"$ref": "Playlist.Item"
},
{
"items": {
"$ref": "Playlist.Item"
},
"type": "array"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Playlist.Clear ====
Clear playlist<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Clear playlist",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Playlist.GetItems ====
Get all items from playlist<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid<br />
# [''[[#List.Fields.All|List.Fields.All]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''array[ [[#List.Item.All|List.Item.All]] ]'' items<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Get all items from playlist",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"$ref": "List.Fields.All",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"items": {
"items": {
"$ref": "List.Item.All"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Playlist.GetPlaylists ====
Returns all existing playlists<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''array''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Returns all existing playlists",
"params": [],
"permission": "ReadData",
"returns": {
"items": {
"properties": {
"playlistid": {
"$ref": "Playlist.Id",
"required": true
},
"type": {
"$ref": "Playlist.Type",
"required": true
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"type": "method"
}
</syntaxhighlight>}}
==== Playlist.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid<br />
# ''array[ [[#Playlist.Property.Name|Playlist.Property.Name]] ]'' properties<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Playlist.Property.Value|Playlist.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the values of the given properties",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"items": {
"$ref": "Playlist.Property.Name"
},
"name": "properties",
"required": true,
"type": "array",
"uniqueItems": true
}
],
"permission": "ReadData",
"returns": {
"$ref": "Playlist.Property.Value"
},
"type": "method"
}
</syntaxhighlight>}}
==== Playlist.Insert ====
Insert item(s) into playlist. Does not work for picture playlists (aka slideshows).<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid<br />
# ''[[#Playlist.Position|Playlist.Position]]'' position<br />
# ''mixed: [[#Playlist.Item|Playlist.Item]]|array'' item<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Insert item(s) into playlist. Does not work for picture playlists (aka slideshows).",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"$ref": "Playlist.Position",
"name": "position",
"required": true
},
{
"name": "item",
"required": true,
"type": [
{
"$ref": "Playlist.Item"
},
{
"items": {
"$ref": "Playlist.Item"
},
"type": "array"
}
]
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Playlist.Remove ====
Remove item from playlist. Does not work for picture playlists (aka slideshows).<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid<br />
# ''[[#Playlist.Position|Playlist.Position]]'' position<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Remove item from playlist. Does not work for picture playlists (aka slideshows).",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"$ref": "Playlist.Position",
"name": "position",
"required": true
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Playlist.Swap ====
Swap items in the playlist. Does not work for picture playlists (aka slideshows).<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid<br />
# ''[[#Playlist.Position|Playlist.Position]]'' position1<br />
# ''[[#Playlist.Position|Playlist.Position]]'' position2<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Swap items in the playlist. Does not work for picture playlists (aka slideshows).",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"$ref": "Playlist.Position",
"name": "position1",
"required": true
},
{
"$ref": "Playlist.Position",
"name": "position2",
"required": true
}
],
"permission": "ControlPlayback",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== Profiles ===
==== Profiles.GetCurrentProfile ====
Retrieve the current profile<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Profiles.Fields.Profile|Profiles.Fields.Profile]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Profiles.Details.Profile|Profiles.Details.Profile]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve the current profile",
"params": [
{
"$ref": "Profiles.Fields.Profile",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"$ref": "Profiles.Details.Profile"
},
"type": "method"
}
</syntaxhighlight>}}
==== Profiles.GetProfiles ====
Retrieve all profiles<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Profiles.Fields.Profile|Profiles.Fields.Profile]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# ''array[ [[#Profiles.Details.Profile|Profiles.Details.Profile]] ]'' profiles<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all profiles",
"params": [
{
"$ref": "Profiles.Fields.Profile",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"profiles": {
"items": {
"$ref": "Profiles.Details.Profile"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Profiles.LoadProfile ====
Load the specified profile<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' profile (Profile name)<br />
# [''boolean'' prompt = False] (Prompt for password)<br />
# [''[[#Profiles.Password|Profiles.Password]]'' password]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Load the specified profile",
"params": [
{
"description": "Profile name",
"name": "profile",
"required": true,
"type": "string"
},
{
"default": false,
"description": "Prompt for password",
"name": "prompt",
"type": "boolean"
},
{
"$ref": "Profiles.Password",
"name": "password"
}
],
"permission": "Navigate",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== Settings ===
==== Settings.GetCategories ====
Retrieves all setting categories<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Setting.Level|Setting.Level]]'' level = standard]<br />
# [''string'' section = ""]<br />
# [''string'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''array[ [[#Setting.Details.Category|Setting.Details.Category]] ]'' categories]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves all setting categories",
"params": [
{
"$ref": "Setting.Level",
"default": "standard",
"name": "level"
},
{
"default": "",
"name": "section",
"type": "string"
},
{
"extends": "Item.Fields.Base",
"items": {
"enums": [
"settings"
],
"type": "string"
},
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"categories": {
"items": {
"$ref": "Setting.Details.Category"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Settings.GetSections ====
Retrieves all setting sections<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Setting.Level|Setting.Level]]'' level = standard]<br />
# [''[[#Setting.Level|Setting.Level]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''array[ [[#Setting.Details.Section|Setting.Details.Section]] ]'' sections]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves all setting sections",
"params": [
{
"$ref": "Setting.Level",
"default": "standard",
"name": "level"
},
{
"extends": "Item.Fields.Base",
"items": {
"enums": [
"categories"
],
"type": "string"
},
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"sections": {
"items": {
"$ref": "Setting.Details.Section"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Settings.GetSettingValue ====
Retrieves the value of a setting<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' setting<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#Setting.Value.Extended|Setting.Value.Extended]]'' value<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the value of a setting",
"params": [
{
"minLength": 1,
"name": "setting",
"required": true,
"type": "string"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"value": {
"$ref": "Setting.Value.Extended",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Settings.GetSettings ====
Retrieves all settings<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Setting.Level|Setting.Level]]'' level = standard]<br />
# [''mixed: object'' filter]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''array[ [[#Setting.Details.Setting|Setting.Details.Setting]] ]'' settings]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves all settings",
"params": [
{
"$ref": "Setting.Level",
"default": "standard",
"name": "level"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"category": {
"minLength": 1,
"required": true,
"type": "string"
},
"section": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
}
]
}
],
"permission": "ReadData",
"returns": {
"properties": {
"settings": {
"items": {
"$ref": "Setting.Details.Setting"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Settings.ResetSettingValue ====
Resets the value of a setting<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' setting<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Resets the value of a setting",
"params": [
{
"minLength": 1,
"name": "setting",
"required": true,
"type": "string"
}
],
"permission": "ReadData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== Settings.SetSettingValue ====
Changes the value of a setting<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' setting<br />
# ''[[#Setting.Value.Extended|Setting.Value.Extended]]'' value<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''boolean''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Changes the value of a setting",
"params": [
{
"minLength": 1,
"name": "setting",
"required": true,
"type": "string"
},
{
"$ref": "Setting.Value.Extended",
"name": "value",
"required": true
}
],
"permission": "ReadData",
"returns": {
"type": "boolean"
},
"type": "method"
}
</syntaxhighlight>}}
=== System ===
==== System.EjectOpticalDrive ====
Ejects or closes the optical disc drive (if available)<br />
'''Permissions:'''
* ControlSystem
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Ejects or closes the optical disc drive (if available)",
"params": [],
"permission": "ControlSystem",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== System.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''array[ [[#System.Property.Name|System.Property.Name]] ]'' properties<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#System.Property.Value|System.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieves the values of the given properties",
"params": [
{
"items": {
"$ref": "System.Property.Name"
},
"name": "properties",
"required": true,
"type": "array",
"uniqueItems": true
}
],
"permission": "ReadData",
"returns": {
"$ref": "System.Property.Value"
},
"type": "method"
}
</syntaxhighlight>}}
==== System.Hibernate ====
Puts the system running Kodi into hibernate mode<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Puts the system running Kodi into hibernate mode",
"params": [],
"permission": "ControlPower",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== System.Reboot ====
Reboots the system running Kodi<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Reboots the system running Kodi",
"params": [],
"permission": "ControlPower",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== System.Shutdown ====
Shuts the system running Kodi down<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Shuts the system running Kodi down",
"params": [],
"permission": "ControlPower",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== System.Suspend ====
Suspends the system running Kodi<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Suspends the system running Kodi",
"params": [],
"permission": "ControlPower",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== Textures ===
==== Textures.GetTextures ====
Retrieve all textures<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Textures.Fields.Texture|Textures.Fields.Texture]]'' properties]<br />
# [''[[#List.Filter.Textures|List.Filter.Textures]]'' filter]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''array[ [[#Textures.Details.Texture|Textures.Details.Texture]] ]'' textures<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all textures",
"params": [
{
"$ref": "Textures.Fields.Texture",
"name": "properties"
},
{
"$ref": "List.Filter.Textures",
"name": "filter"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"textures": {
"items": {
"$ref": "Textures.Details.Texture"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== Textures.RemoveTexture ====
Remove the specified texture<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' textureid (Texture database identifier)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Remove the specified texture",
"params": [
{
"$ref": "Library.Id",
"description": "Texture database identifier",
"name": "textureid",
"required": true
}
],
"permission": "RemoveData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== VideoLibrary ===
==== VideoLibrary.Clean ====
Cleans the video library for non-existent items<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''boolean'' showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)<br />
# [''string'' content = video] (Content type to clean for)<br />
# [''string'' directory = ""] (Path to the directory to clean up; performs a global cleanup if not specified)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Cleans the video library for non-existent items",
"params": [
{
"default": true,
"description": "Whether or not to show the progress bar or any other GUI dialog",
"name": "showdialogs",
"type": "boolean"
},
{
"default": "video",
"description": "Content type to clean for",
"enums": [
"video",
"movies",
"tvshows",
"musicvideos"
],
"name": "content",
"type": "string"
},
{
"default": "",
"description": "Path to the directory to clean up; performs a global cleanup if not specified",
"name": "directory",
"type": "string"
}
],
"permission": "RemoveData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.Export ====
Exports all items from the video library<br />
'''Permissions:'''
* WriteFile
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''mixed: object|object'' options]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Exports all items from the video library",
"params": [
{
"name": "options",
"type": [
{
"additionalProperties": false,
"properties": {
"path": {
"description": "Path to the directory to where the data should be exported",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"actorthumbs": {
"default": false,
"description": "Whether to export actor thumbnails",
"type": "boolean"
},
"images": {
"default": false,
"description": "Whether to export thumbnails and fanart images",
"type": "boolean"
},
"overwrite": {
"default": false,
"description": "Whether to overwrite existing exported files",
"type": "boolean"
}
},
"type": "object"
}
]
}
],
"permission": "WriteFile",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetAvailableArt ====
Retrieve all potential art URLs for a media item by art type<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''mixed: object|object|object|object|object|object'' item<br />
# [''string'' arttype = ""]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''array'' availableart<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all potential art URLs for a media item by art type",
"params": [
{
"name": "item",
"required": true,
"type": [
{
"additionalProperties": false,
"properties": {
"episodeid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"tvshowid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"seasonid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"movieid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"setid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"musicvideoid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
}
]
},
{
"default": "",
"name": "arttype",
"type": "string"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"availableart": {
"items": {
"properties": {
"arttype": {
"required": true,
"type": "string"
},
"previewurl": {
"default": "",
"description": "URL to a preview thumbnail of the image",
"type": "string"
},
"url": {
"description": "URL to the original image",
"required": true,
"type": "string"
}
},
"type": "object"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetAvailableArtTypes ====
Retrieve a list of potential art types for a media item<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''mixed: object|object|object|object|object|object'' item<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''array'' availablearttypes<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve a list of potential art types for a media item",
"params": [
{
"name": "item",
"required": true,
"type": [
{
"additionalProperties": false,
"properties": {
"episodeid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"tvshowid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"seasonid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"movieid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"setid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"musicvideoid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
}
]
}
],
"permission": "ReadData",
"returns": {
"properties": {
"availablearttypes": {
"items": {
"type": "string"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetEpisodeDetails ====
Retrieve details about a specific tv show episode<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' episodeid<br />
# [''[[#Video.Fields.Episode|Video.Fields.Episode]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#Video.Details.Episode|Video.Details.Episode]]'' episodedetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific tv show episode",
"params": [
{
"$ref": "Library.Id",
"name": "episodeid",
"required": true
},
{
"$ref": "Video.Fields.Episode",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"episodedetails": {
"$ref": "Video.Details.Episode"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetEpisodes ====
Retrieve all tv show episodes<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Library.Id|Library.Id]]'' tvshowid = -1]<br />
# [''integer'' season = -1]<br />
# [''[[#Video.Fields.Episode|Video.Fields.Episode]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
# [''mixed: object|object|object|object|object|[[#List.Filter.Episodes|List.Filter.Episodes]]'' filter]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''array[ [[#Video.Details.Episode|Video.Details.Episode]] ]'' episodes]<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all tv show episodes",
"params": [
{
"$ref": "Library.Id",
"default": -1,
"name": "tvshowid"
},
{
"default": -1,
"minimum": 0,
"name": "season",
"type": "integer"
},
{
"$ref": "Video.Fields.Episode",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Requires tvshowid to be set",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"description": "Requires tvshowid to be set",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"year": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"actor": {
"description": "Requires tvshowid to be set",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"director": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Episodes"
}
]
}
],
"permission": "ReadData",
"returns": {
"properties": {
"episodes": {
"items": {
"$ref": "Video.Details.Episode"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetGenres ====
Retrieve all genres<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' type<br />
# [''[[#Library.Fields.Genre|Library.Fields.Genre]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''array[ [[#Library.Details.Genre|Library.Details.Genre]] ]'' genres<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all genres",
"params": [
{
"enums": [
"movie",
"tvshow",
"musicvideo"
],
"name": "type",
"required": true,
"type": "string"
},
{
"$ref": "Library.Fields.Genre",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"genres": {
"items": {
"$ref": "Library.Details.Genre"
},
"required": true,
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetInProgressTVShows ====
Retrieve all in progress tvshows<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Video.Fields.TVShow|Video.Fields.TVShow]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# [''array[ [[#Video.Details.TVShow|Video.Details.TVShow]] ]'' tvshows]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all in progress tvshows",
"params": [
{
"$ref": "Video.Fields.TVShow",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"tvshows": {
"items": {
"$ref": "Video.Details.TVShow"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetMovieDetails ====
Retrieve details about a specific movie<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' movieid<br />
# [''[[#Video.Fields.Movie|Video.Fields.Movie]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#Video.Details.Movie|Video.Details.Movie]]'' moviedetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific movie",
"params": [
{
"$ref": "Library.Id",
"name": "movieid",
"required": true
},
{
"$ref": "Video.Fields.Movie",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"moviedetails": {
"$ref": "Video.Details.Movie"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetMovieSetDetails ====
Retrieve details about a specific movie set<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' setid<br />
# [''[[#Video.Fields.MovieSet|Video.Fields.MovieSet]]'' properties]<br />
# [''object'' movies]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#Video.Details.MovieSet.Extended|Video.Details.MovieSet.Extended]]'' setdetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific movie set",
"params": [
{
"$ref": "Library.Id",
"name": "setid",
"required": true
},
{
"$ref": "Video.Fields.MovieSet",
"name": "properties"
},
{
"name": "movies",
"properties": {
"limits": {
"$ref": "List.Limits"
},
"properties": {
"$ref": "Video.Fields.Movie"
},
"sort": {
"$ref": "List.Sort"
}
},
"type": "object"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"setdetails": {
"$ref": "Video.Details.MovieSet.Extended"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetMovieSets ====
Retrieve all movie sets<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Video.Fields.MovieSet|Video.Fields.MovieSet]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# [''array[ [[#Video.Details.MovieSet|Video.Details.MovieSet]] ]'' sets]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all movie sets",
"params": [
{
"$ref": "Video.Fields.MovieSet",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"sets": {
"items": {
"$ref": "Video.Details.MovieSet"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetMovies ====
Retrieve all movies<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Video.Fields.Movie|Video.Fields.Movie]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
# [''mixed: object|object|object|object|object|object|object|object|object|object|[[#List.Filter.Movies|List.Filter.Movies]]'' filter]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# [''array[ [[#Video.Details.Movie|Video.Details.Movie]] ]'' movies]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all movies",
"params": [
{
"$ref": "Video.Fields.Movie",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"year": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"actor": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"director": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"studio": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"country": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"setid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"set": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"tag": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Movies"
}
]
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"movies": {
"items": {
"$ref": "Video.Details.Movie"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetMusicVideoDetails ====
Retrieve details about a specific music video<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' musicvideoid<br />
# [''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#Video.Details.MusicVideo|Video.Details.MusicVideo]]'' musicvideodetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific music video",
"params": [
{
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
},
{
"$ref": "Video.Fields.MusicVideo",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"musicvideodetails": {
"$ref": "Video.Details.MusicVideo"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetMusicVideos ====
Retrieve all music videos<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
# [''mixed: object|object|object|object|object|object|object|[[#List.Filter.MusicVideos|List.Filter.MusicVideos]]'' filter]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# [''array[ [[#Video.Details.MusicVideo|Video.Details.MusicVideo]] ]'' musicvideos]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all music videos",
"params": [
{
"$ref": "Video.Fields.MusicVideo",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"year": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"director": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"studio": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"tag": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.MusicVideos"
}
]
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"musicvideos": {
"items": {
"$ref": "Video.Details.MusicVideo"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetRecentlyAddedEpisodes ====
Retrieve all recently added tv episodes<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Video.Fields.Episode|Video.Fields.Episode]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''array[ [[#Video.Details.Episode|Video.Details.Episode]] ]'' episodes]<br />
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all recently added tv episodes",
"params": [
{
"$ref": "Video.Fields.Episode",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"episodes": {
"items": {
"$ref": "Video.Details.Episode"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetRecentlyAddedMovies ====
Retrieve all recently added movies<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Video.Fields.Movie|Video.Fields.Movie]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# [''array[ [[#Video.Details.Movie|Video.Details.Movie]] ]'' movies]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all recently added movies",
"params": [
{
"$ref": "Video.Fields.Movie",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"movies": {
"items": {
"$ref": "Video.Details.Movie"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetRecentlyAddedMusicVideos ====
Retrieve all recently added music videos<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# [''array[ [[#Video.Details.MusicVideo|Video.Details.MusicVideo]] ]'' musicvideos]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all recently added music videos",
"params": [
{
"$ref": "Video.Fields.MusicVideo",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"musicvideos": {
"items": {
"$ref": "Video.Details.MusicVideo"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetSeasonDetails ====
Retrieve details about a specific tv show season<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' seasonid<br />
# [''[[#Video.Fields.Season|Video.Fields.Season]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#Video.Details.Season|Video.Details.Season]]'' seasondetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific tv show season",
"params": [
{
"$ref": "Library.Id",
"name": "seasonid",
"required": true
},
{
"$ref": "Video.Fields.Season",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"seasondetails": {
"$ref": "Video.Details.Season"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetSeasons ====
Retrieve all tv seasons<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Library.Id|Library.Id]]'' tvshowid = -1]<br />
# [''[[#Video.Fields.Season|Video.Fields.Season]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# [''array[ [[#Video.Details.Season|Video.Details.Season]] ]'' seasons]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all tv seasons",
"params": [
{
"$ref": "Library.Id",
"default": -1,
"name": "tvshowid"
},
{
"$ref": "Video.Fields.Season",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"seasons": {
"items": {
"$ref": "Video.Details.Season"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetTVShowDetails ====
Retrieve details about a specific tv show<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' tvshowid<br />
# [''[[#Video.Fields.TVShow|Video.Fields.TVShow]]'' properties]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# [''[[#Video.Details.TVShow|Video.Details.TVShow]]'' tvshowdetails]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve details about a specific tv show",
"params": [
{
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
},
{
"$ref": "Video.Fields.TVShow",
"name": "properties"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"tvshowdetails": {
"$ref": "Video.Details.TVShow"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetTVShows ====
Retrieve all tv shows<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''[[#Video.Fields.TVShow|Video.Fields.TVShow]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
# [''mixed: object|object|object|object|object|object|[[#List.Filter.TVShows|List.Filter.TVShows]]'' filter]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# [''array[ [[#Video.Details.TVShow|Video.Details.TVShow]] ]'' tvshows]<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all tv shows",
"params": [
{
"$ref": "Video.Fields.TVShow",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"name": "filter",
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"year": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"actor": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"studio": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"tag": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.TVShows"
}
]
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"tvshows": {
"items": {
"$ref": "Video.Details.TVShow"
},
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.GetTags ====
Retrieve all tags<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' type<br />
# [''[[#Library.Fields.Tag|Library.Fields.Tag]]'' properties]<br />
# [''[[#List.Limits|List.Limits]]'' limits]<br />
# [''[[#List.Sort|List.Sort]]'' sort]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
# ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits<br />
# ''array[ [[#Library.Details.Tag|Library.Details.Tag]] ]'' tags<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve all tags",
"params": [
{
"enums": [
"movie",
"tvshow",
"musicvideo"
],
"name": "type",
"required": true,
"type": "string"
},
{
"$ref": "Library.Fields.Tag",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"permission": "ReadData",
"returns": {
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"tags": {
"items": {
"$ref": "Library.Details.Tag"
},
"required": true,
"type": "array"
}
},
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.RefreshEpisode ====
Refresh the given episode in the library<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' episodeid<br />
# [''boolean'' ignorenfo = False] (Whether or not to ignore a local NFO if present.)<br />
# [''string'' title = ""] (Title to use for searching (instead of determining it from the item's filename/path).)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Refresh the given episode in the library",
"params": [
{
"$ref": "Library.Id",
"name": "episodeid",
"required": true
},
{
"default": false,
"description": "Whether or not to ignore a local NFO if present.",
"name": "ignorenfo",
"type": "boolean"
},
{
"default": "",
"description": "Title to use for searching (instead of determining it from the item's filename/path).",
"name": "title",
"type": "string"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.RefreshMovie ====
Refresh the given movie in the library<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' movieid<br />
# [''boolean'' ignorenfo = False] (Whether or not to ignore a local NFO if present.)<br />
# [''string'' title = ""] (Title to use for searching (instead of determining it from the item's filename/path).)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Refresh the given movie in the library",
"params": [
{
"$ref": "Library.Id",
"name": "movieid",
"required": true
},
{
"default": false,
"description": "Whether or not to ignore a local NFO if present.",
"name": "ignorenfo",
"type": "boolean"
},
{
"default": "",
"description": "Title to use for searching (instead of determining it from the item's filename/path).",
"name": "title",
"type": "string"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.RefreshMusicVideo ====
Refresh the given music video in the library<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' musicvideoid<br />
# [''boolean'' ignorenfo = False] (Whether or not to ignore a local NFO if present.)<br />
# [''string'' title = ""] (Title to use for searching (instead of determining it from the item's filename/path).)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Refresh the given music video in the library",
"params": [
{
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
},
{
"default": false,
"description": "Whether or not to ignore a local NFO if present.",
"name": "ignorenfo",
"type": "boolean"
},
{
"default": "",
"description": "Title to use for searching (instead of determining it from the item's filename/path).",
"name": "title",
"type": "string"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.RefreshTVShow ====
Refresh the given tv show in the library<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' tvshowid<br />
# [''boolean'' ignorenfo = False] (Whether or not to ignore a local NFO if present.)<br />
# [''boolean'' refreshepisodes = False] (Whether or not to refresh all episodes belonging to the TV show.)<br />
# [''string'' title = ""] (Title to use for searching (instead of determining it from the item's filename/path).)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Refresh the given tv show in the library",
"params": [
{
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
},
{
"default": false,
"description": "Whether or not to ignore a local NFO if present.",
"name": "ignorenfo",
"type": "boolean"
},
{
"default": false,
"description": "Whether or not to refresh all episodes belonging to the TV show.",
"name": "refreshepisodes",
"type": "boolean"
},
{
"default": "",
"description": "Title to use for searching (instead of determining it from the item's filename/path).",
"name": "title",
"type": "string"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.RemoveEpisode ====
Removes the given episode from the library<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' episodeid<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Removes the given episode from the library",
"params": [
{
"$ref": "Library.Id",
"name": "episodeid",
"required": true
}
],
"permission": "RemoveData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.RemoveMovie ====
Removes the given movie from the library<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' movieid<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Removes the given movie from the library",
"params": [
{
"$ref": "Library.Id",
"name": "movieid",
"required": true
}
],
"permission": "RemoveData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.RemoveMusicVideo ====
Removes the given music video from the library<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' musicvideoid<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Removes the given music video from the library",
"params": [
{
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
}
],
"permission": "RemoveData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.RemoveTVShow ====
Removes the given tv show from the library<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' tvshowid<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Removes the given tv show from the library",
"params": [
{
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
}
],
"permission": "RemoveData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.Scan ====
Scans the video sources for new library items<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [''string'' directory = ""]<br />
# [''boolean'' showdialogs = True] (Whether or not to show the progress bar or any other GUI dialog)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Scans the video sources for new library items",
"params": [
{
"default": "",
"name": "directory",
"type": "string"
},
{
"default": true,
"description": "Whether or not to show the progress bar or any other GUI dialog",
"name": "showdialogs",
"type": "boolean"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.SetEpisodeDetails ====
Update the given episode with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' episodeid<br />
# [''[[#Optional.String|Optional.String]]'' title = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' playcount = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' runtime = None] (Runtime in seconds)<br />
# [''mixed: null|[[#Array.String|Array.String]]'' director = None]<br />
# [''[[#Optional.String|Optional.String]]'' plot = None]<br />
# [''[[#Optional.Number|Optional.Number]]'' rating = None]<br />
# [''[[#Optional.String|Optional.String]]'' votes = None]<br />
# [''[[#Optional.String|Optional.String]]'' lastplayed = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' writer = None]<br />
# [''[[#Optional.String|Optional.String]]'' firstaired = None]<br />
# [''[[#Optional.String|Optional.String]]'' productioncode = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' season = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' episode = None]<br />
# [''[[#Optional.String|Optional.String]]'' originaltitle = None]<br />
# [''[[#Optional.String|Optional.String]]'' thumbnail = None]<br />
# [''[[#Optional.String|Optional.String]]'' fanart = None]<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
# [''mixed: null|[[#Video.Resume|Video.Resume]]'' resume = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br />
# [''[[#Video.Ratings.Set|Video.Ratings.Set]]'' ratings]<br />
# [''[[#Optional.String|Optional.String]]'' dateadded = None]<br />
# [''mixed: null|[[#Media.UniqueID.Set|Media.UniqueID.Set]]'' uniqueid = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given episode with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "episodeid",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"name": "title"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "playcount"
},
{
"$ref": "Optional.Integer",
"default": null,
"description": "Runtime in seconds",
"name": "runtime"
},
{
"default": null,
"name": "director",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "plot"
},
{
"$ref": "Optional.Number",
"default": null,
"name": "rating"
},
{
"$ref": "Optional.String",
"default": null,
"name": "votes"
},
{
"$ref": "Optional.String",
"default": null,
"name": "lastplayed"
},
{
"default": null,
"name": "writer",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "firstaired"
},
{
"$ref": "Optional.String",
"default": null,
"name": "productioncode"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "season"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "episode"
},
{
"$ref": "Optional.String",
"default": null,
"name": "originaltitle"
},
{
"$ref": "Optional.String",
"default": null,
"name": "thumbnail"
},
{
"$ref": "Optional.String",
"default": null,
"name": "fanart"
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
},
{
"default": null,
"name": "resume",
"type": [
{
"type": "null"
},
{
"$ref": "Video.Resume"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "userrating"
},
{
"$ref": "Video.Ratings.Set",
"name": "ratings"
},
{
"$ref": "Optional.String",
"default": null,
"name": "dateadded"
},
{
"default": null,
"name": "uniqueid",
"type": [
{
"type": "null"
},
{
"$ref": "Media.UniqueID.Set"
}
]
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.SetMovieDetails ====
Update the given movie with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' movieid<br />
# [''[[#Optional.String|Optional.String]]'' title = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' playcount = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' runtime = None] (Runtime in seconds)<br />
# [''mixed: null|[[#Array.String|Array.String]]'' director = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' studio = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' year = None] (linked with premiered. Overridden by premiered parameter)<br />
# [''[[#Optional.String|Optional.String]]'' plot = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' genre = None]<br />
# [''[[#Optional.Number|Optional.Number]]'' rating = None]<br />
# [''[[#Optional.String|Optional.String]]'' mpaa = None]<br />
# [''[[#Optional.String|Optional.String]]'' imdbnumber = None]<br />
# [''[[#Optional.String|Optional.String]]'' votes = None]<br />
# [''[[#Optional.String|Optional.String]]'' lastplayed = None]<br />
# [''[[#Optional.String|Optional.String]]'' originaltitle = None]<br />
# [''[[#Optional.String|Optional.String]]'' trailer = None]<br />
# [''[[#Optional.String|Optional.String]]'' tagline = None]<br />
# [''[[#Optional.String|Optional.String]]'' plotoutline = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' writer = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' country = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' top250 = None]<br />
# [''[[#Optional.String|Optional.String]]'' sorttitle = None]<br />
# [''[[#Optional.String|Optional.String]]'' set = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' showlink = None]<br />
# [''[[#Optional.String|Optional.String]]'' thumbnail = None]<br />
# [''[[#Optional.String|Optional.String]]'' fanart = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' tag = None]<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
# [''mixed: null|[[#Video.Resume|Video.Resume]]'' resume = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br />
# [''[[#Video.Ratings.Set|Video.Ratings.Set]]'' ratings]<br />
# [''[[#Optional.String|Optional.String]]'' dateadded = None]<br />
# [''[[#Optional.String|Optional.String]]'' premiered = None] (linked with year. Overrides year)<br />
# [''mixed: null|[[#Media.UniqueID.Set|Media.UniqueID.Set]]'' uniqueid = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given movie with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "movieid",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"name": "title"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "playcount"
},
{
"$ref": "Optional.Integer",
"default": null,
"description": "Runtime in seconds",
"name": "runtime"
},
{
"default": null,
"name": "director",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "studio",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"description": "linked with premiered. Overridden by premiered parameter",
"name": "year"
},
{
"$ref": "Optional.String",
"default": null,
"name": "plot"
},
{
"default": null,
"name": "genre",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.Number",
"default": null,
"name": "rating"
},
{
"$ref": "Optional.String",
"default": null,
"name": "mpaa"
},
{
"$ref": "Optional.String",
"default": null,
"name": "imdbnumber"
},
{
"$ref": "Optional.String",
"default": null,
"name": "votes"
},
{
"$ref": "Optional.String",
"default": null,
"name": "lastplayed"
},
{
"$ref": "Optional.String",
"default": null,
"name": "originaltitle"
},
{
"$ref": "Optional.String",
"default": null,
"name": "trailer"
},
{
"$ref": "Optional.String",
"default": null,
"name": "tagline"
},
{
"$ref": "Optional.String",
"default": null,
"name": "plotoutline"
},
{
"default": null,
"name": "writer",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "country",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "top250"
},
{
"$ref": "Optional.String",
"default": null,
"name": "sorttitle"
},
{
"$ref": "Optional.String",
"default": null,
"name": "set"
},
{
"default": null,
"name": "showlink",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "thumbnail"
},
{
"$ref": "Optional.String",
"default": null,
"name": "fanart"
},
{
"default": null,
"name": "tag",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
},
{
"default": null,
"name": "resume",
"type": [
{
"type": "null"
},
{
"$ref": "Video.Resume"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "userrating"
},
{
"$ref": "Video.Ratings.Set",
"name": "ratings"
},
{
"$ref": "Optional.String",
"default": null,
"name": "dateadded"
},
{
"$ref": "Optional.String",
"default": null,
"description": "linked with year. Overrides year",
"name": "premiered"
},
{
"default": null,
"name": "uniqueid",
"type": [
{
"type": "null"
},
{
"$ref": "Media.UniqueID.Set"
}
]
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.SetMovieSetDetails ====
Update the given movie set with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' setid<br />
# [''[[#Optional.String|Optional.String]]'' title = None]<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
# [''[[#Optional.String|Optional.String]]'' plot = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given movie set with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "setid",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"name": "title"
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "plot"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.SetMusicVideoDetails ====
Update the given music video with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' musicvideoid<br />
# [''[[#Optional.String|Optional.String]]'' title = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' playcount = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' runtime = None] (Runtime in seconds)<br />
# [''mixed: null|[[#Array.String|Array.String]]'' director = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' studio = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' year = None] (linked with premiered. Overridden by premiered parameter)<br />
# [''[[#Optional.String|Optional.String]]'' plot = None]<br />
# [''[[#Optional.String|Optional.String]]'' album = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' artist = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' genre = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' track = None]<br />
# [''[[#Optional.String|Optional.String]]'' lastplayed = None]<br />
# [''[[#Optional.String|Optional.String]]'' thumbnail = None]<br />
# [''[[#Optional.String|Optional.String]]'' fanart = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' tag = None]<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
# [''mixed: null|[[#Video.Resume|Video.Resume]]'' resume = None]<br />
# [''[[#Optional.Number|Optional.Number]]'' rating = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br />
# [''[[#Optional.String|Optional.String]]'' dateadded = None]<br />
# [''[[#Optional.String|Optional.String]]'' premiered = None] (linked with year. Overrides year)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given music video with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"name": "title"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "playcount"
},
{
"$ref": "Optional.Integer",
"default": null,
"description": "Runtime in seconds",
"name": "runtime"
},
{
"default": null,
"name": "director",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "studio",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"description": "linked with premiered. Overridden by premiered parameter",
"name": "year"
},
{
"$ref": "Optional.String",
"default": null,
"name": "plot"
},
{
"$ref": "Optional.String",
"default": null,
"name": "album"
},
{
"default": null,
"name": "artist",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "genre",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "track"
},
{
"$ref": "Optional.String",
"default": null,
"name": "lastplayed"
},
{
"$ref": "Optional.String",
"default": null,
"name": "thumbnail"
},
{
"$ref": "Optional.String",
"default": null,
"name": "fanart"
},
{
"default": null,
"name": "tag",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
},
{
"default": null,
"name": "resume",
"type": [
{
"type": "null"
},
{
"$ref": "Video.Resume"
}
]
},
{
"$ref": "Optional.Number",
"default": null,
"name": "rating"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "userrating"
},
{
"$ref": "Optional.String",
"default": null,
"name": "dateadded"
},
{
"$ref": "Optional.String",
"default": null,
"description": "linked with year. Overrides year",
"name": "premiered"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.SetSeasonDetails ====
Update the given season with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' seasonid<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br />
# [''[[#Optional.String|Optional.String]]'' title = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given season with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "seasonid",
"required": true
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "userrating"
},
{
"$ref": "Optional.String",
"default": null,
"name": "title"
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
==== VideoLibrary.SetTVShowDetails ====
Update the given tvshow with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' tvshowid<br />
# [''[[#Optional.String|Optional.String]]'' title = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' playcount = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' studio = None]<br />
# [''[[#Optional.String|Optional.String]]'' plot = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' genre = None]<br />
# [''[[#Optional.Number|Optional.Number]]'' rating = None]<br />
# [''[[#Optional.String|Optional.String]]'' mpaa = None]<br />
# [''[[#Optional.String|Optional.String]]'' imdbnumber = None]<br />
# [''[[#Optional.String|Optional.String]]'' premiered = None]<br />
# [''[[#Optional.String|Optional.String]]'' votes = None]<br />
# [''[[#Optional.String|Optional.String]]'' lastplayed = None]<br />
# [''[[#Optional.String|Optional.String]]'' originaltitle = None]<br />
# [''[[#Optional.String|Optional.String]]'' sorttitle = None]<br />
# [''[[#Optional.String|Optional.String]]'' episodeguide = None]<br />
# [''[[#Optional.String|Optional.String]]'' thumbnail = None]<br />
# [''[[#Optional.String|Optional.String]]'' fanart = None]<br />
# [''mixed: null|[[#Array.String|Array.String]]'' tag = None]<br />
# [''mixed: null|[[#Media.Artwork.Set|Media.Artwork.Set]]'' art = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' userrating = None]<br />
# [''[[#Video.Ratings.Set|Video.Ratings.Set]]'' ratings]<br />
# [''[[#Optional.String|Optional.String]]'' dateadded = None]<br />
# [''[[#Optional.Integer|Optional.Integer]]'' runtime = None] (Runtime in seconds)<br />
# [''[[#Optional.String|Optional.String]]'' status = None] (Valid values: 'returning series', 'in production', 'planned', 'cancelled', 'ended')<br />
# [''mixed: null|[[#Media.UniqueID.Set|Media.UniqueID.Set]]'' uniqueid = None]<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Update the given tvshow with the given details",
"params": [
{
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
},
{
"$ref": "Optional.String",
"default": null,
"name": "title"
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "playcount"
},
{
"default": null,
"name": "studio",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.String",
"default": null,
"name": "plot"
},
{
"default": null,
"name": "genre",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"$ref": "Optional.Number",
"default": null,
"name": "rating"
},
{
"$ref": "Optional.String",
"default": null,
"name": "mpaa"
},
{
"$ref": "Optional.String",
"default": null,
"name": "imdbnumber"
},
{
"$ref": "Optional.String",
"default": null,
"name": "premiered"
},
{
"$ref": "Optional.String",
"default": null,
"name": "votes"
},
{
"$ref": "Optional.String",
"default": null,
"name": "lastplayed"
},
{
"$ref": "Optional.String",
"default": null,
"name": "originaltitle"
},
{
"$ref": "Optional.String",
"default": null,
"name": "sorttitle"
},
{
"$ref": "Optional.String",
"default": null,
"name": "episodeguide"
},
{
"$ref": "Optional.String",
"default": null,
"name": "thumbnail"
},
{
"$ref": "Optional.String",
"default": null,
"name": "fanart"
},
{
"default": null,
"name": "tag",
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
]
},
{
"default": null,
"name": "art",
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
]
},
{
"$ref": "Optional.Integer",
"default": null,
"name": "userrating"
},
{
"$ref": "Video.Ratings.Set",
"name": "ratings"
},
{
"$ref": "Optional.String",
"default": null,
"name": "dateadded"
},
{
"$ref": "Optional.Integer",
"default": null,
"description": "Runtime in seconds",
"name": "runtime"
},
{
"$ref": "Optional.String",
"default": null,
"description": "Valid values: 'returning series', 'in production', 'planned', 'cancelled', 'ended'",
"name": "status"
},
{
"default": null,
"name": "uniqueid",
"type": [
{
"type": "null"
},
{
"$ref": "Media.UniqueID.Set"
}
]
}
],
"permission": "UpdateData",
"returns": {
"type": "string"
},
"type": "method"
}
</syntaxhighlight>}}
=== XBMC ===
==== XBMC.GetInfoBooleans ====
Retrieve info booleans about Kodi and the system<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''array[string]'' booleans<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object (Object containing key-value pairs of the retrieved info booleans)''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve info booleans about Kodi and the system",
"params": [
{
"items": {
"type": "string"
},
"minItems": 1,
"name": "booleans",
"required": true,
"type": "array"
}
],
"permission": "ReadData",
"returns": {
"additionalProperties": {
"default": "",
"type": "string"
},
"description": "Object containing key-value pairs of the retrieved info booleans",
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
==== XBMC.GetInfoLabels ====
Retrieve info labels about Kodi and the system<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''array[string]'' labels (See http://kodi.wiki/view/InfoLabels for a list of possible info labels)<br />
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object (Object containing key-value pairs of the retrieved info labels)''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Retrieve info labels about Kodi and the system",
"params": [
{
"description": "See http://kodi.wiki/view/InfoLabels for a list of possible info labels",
"items": {
"type": "string"
},
"minItems": 1,
"name": "labels",
"required": true,
"type": "array"
}
],
"permission": "ReadData",
"returns": {
"additionalProperties": {
"default": "",
"type": "string"
},
"description": "Object containing key-value pairs of the retrieved info labels",
"type": "object"
},
"type": "method"
}
</syntaxhighlight>}}
== Global Types ==
=== Addon ===
==== Addon.Content ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "unknown",
"enums": [
"unknown",
"video",
"audio",
"image",
"executable"
],
"id": "Addon.Content",
"type": "string"
}
</syntaxhighlight>}}
==== Addon.Details ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' addonid
* [''string'' author]
* [''mixed: boolean|string'' broken]
* [''array'' dependencies]
* [''mixed: boolean|string'' deprecated]
* [''string'' description]
* [''string'' disclaimer]
* [''boolean'' enabled]
* [''array'' extrainfo]
* [''string'' fanart]
* [''boolean'' installed]
* [''string'' name]
* [''string'' path]
* [''integer'' rating]
* [''string'' summary]
* [''string'' thumbnail]
* ''[[#Addon.Types|Addon.Types]]'' type
* [''string'' version]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "Addon.Details",
"properties": {
"addonid": {
"required": true,
"type": "string"
},
"author": {
"default": "",
"type": "string"
},
"broken": {
"default": null,
"type": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"dependencies": {
"items": {
"properties": {
"addonid": {
"required": true,
"type": "string"
},
"optional": {
"required": true,
"type": "boolean"
},
"version": {
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"deprecated": {
"default": null,
"type": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"description": {
"default": "",
"type": "string"
},
"disclaimer": {
"default": "",
"type": "string"
},
"enabled": {
"default": false,
"type": "boolean"
},
"extrainfo": {
"items": {
"properties": {
"key": {
"required": true,
"type": "string"
},
"value": {
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"fanart": {
"default": "",
"type": "string"
},
"installed": {
"default": false,
"type": "boolean"
},
"name": {
"default": "",
"type": "string"
},
"path": {
"default": "",
"type": "string"
},
"rating": {
"default": 0,
"type": "integer"
},
"summary": {
"default": "",
"type": "string"
},
"thumbnail": {
"default": "",
"type": "string"
},
"type": {
"$ref": "Addon.Types",
"required": true
},
"version": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Addon.Fields ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Addon.Fields",
"items": {
"enums": [
"name",
"version",
"summary",
"description",
"path",
"author",
"thumbnail",
"disclaimer",
"fanart",
"dependencies",
"broken",
"extrainfo",
"rating",
"enabled",
"installed",
"deprecated"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Addon.Types ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "unknown",
"enums": [
"unknown",
"xbmc.player.musicviz",
"xbmc.gui.skin",
"kodi.pvrclient",
"kodi.inputstream",
"kodi.gameclient",
"kodi.peripheral",
"xbmc.python.script",
"xbmc.python.weather",
"xbmc.subtitle.module",
"xbmc.python.lyrics",
"xbmc.metadata.scraper.albums",
"xbmc.metadata.scraper.artists",
"xbmc.metadata.scraper.movies",
"xbmc.metadata.scraper.musicvideos",
"xbmc.metadata.scraper.tvshows",
"xbmc.ui.screensaver",
"xbmc.python.pluginsource",
"xbmc.addon.repository",
"xbmc.webinterface",
"xbmc.service",
"kodi.audioencoder",
"kodi.context.item",
"kodi.audiodecoder",
"kodi.resource.images",
"kodi.resource.language",
"kodi.resource.uisounds",
"kodi.resource.games",
"kodi.resource.font",
"kodi.vfs",
"kodi.imagedecoder",
"xbmc.metadata.scraper.library",
"xbmc.python.library",
"xbmc.python.module",
"kodi.game.controller",
"",
"xbmc.addon.video",
"xbmc.addon.audio",
"xbmc.addon.image",
"xbmc.addon.executable",
"kodi.addon.game"
],
"id": "Addon.Types",
"type": "string"
}
</syntaxhighlight>}}
=== Application ===
==== Application.Property.Name ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "volume",
"enums": [
"volume",
"muted",
"name",
"version",
"sorttokens",
"language"
],
"id": "Application.Property.Name",
"type": "string"
}
</syntaxhighlight>}}
==== Application.Property.Value ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' language]
* [''boolean'' muted]
* [''string'' name]
* [''[[#Array.String|Array.String]]'' sorttokens]
* [''object'' version]
* [''integer'' volume]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Application.Property.Value",
"properties": {
"language": {
"default": "",
"description": "Current language code and region e.g. en_GB",
"minLength": 1,
"type": "string"
},
"muted": {
"default": false,
"type": "boolean"
},
"name": {
"default": "",
"minLength": 1,
"type": "string"
},
"sorttokens": {
"$ref": "Array.String",
"description": "Articles ignored during sorting when ignorearticle is enabled."
},
"version": {
"properties": {
"major": {
"minimum": 0,
"required": true,
"type": "integer"
},
"minor": {
"minimum": 0,
"required": true,
"type": "integer"
},
"revision": {
"default": null,
"type": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"tag": {
"enums": [
"prealpha",
"alpha",
"beta",
"releasecandidate",
"stable"
],
"required": true,
"type": "string"
},
"tagversion": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"volume": {
"default": 0,
"maximum": 100,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
=== Array ===
==== Array.Integer ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Array.Integer",
"items": {
"type": "integer"
},
"type": "array"
}
</syntaxhighlight>}}
==== Array.String ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Array.String",
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
}
</syntaxhighlight>}}
=== Audio ===
==== Audio.Album.ReleaseType ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "album",
"enums": [
"album",
"single"
],
"id": "Audio.Album.ReleaseType",
"type": "string"
}
</syntaxhighlight>}}
==== Audio.Artist.Roles ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Audio.Artist.Roles",
"items": {
"additionalProperties": false,
"description": "The various roles contributed by an artist to one or more songs",
"properties": {
"role": {
"required": true,
"type": "string"
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
"type": "array"
}
</syntaxhighlight>}}
==== Audio.Contributors ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Audio.Contributors",
"items": {
"additionalProperties": false,
"description": "The artist and the role they contribute to a song",
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"name": {
"required": true,
"type": "string"
},
"role": {
"required": true,
"type": "string"
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
"type": "array"
}
</syntaxhighlight>}}
==== Audio.Details.Album ====
'''Extends:'''
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''integer'' albumduration]
* ''[[#Library.Id|Library.Id]]'' albumid
* [''string'' albumlabel]
* [''string'' albumstatus]
* [''boolean'' compilation]
* [''string'' description]
* [''boolean'' isboxset]
* [''string'' lastplayed]
* [''[[#Array.String|Array.String]]'' mood]
* [''string'' musicbrainzalbumid]
* [''string'' musicbrainzreleasegroupid]
* [''integer'' playcount]
* [''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' releasetype = album]
* [''[[#Audio.Details.Genres|Audio.Details.Genres]]'' songgenres]
* [''[[#Array.Integer|Array.Integer]]'' sourceid]
* [''[[#Array.String|Array.String]]'' style]
* [''[[#Array.String|Array.String]]'' theme]
* [''integer'' totaldiscs]
* [''string'' type]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Audio.Details.Media",
"id": "Audio.Details.Album",
"properties": {
"albumduration": {
"default": 0,
"type": "integer"
},
"albumid": {
"$ref": "Library.Id",
"required": true
},
"albumlabel": {
"default": "",
"type": "string"
},
"albumstatus": {
"default": "",
"type": "string"
},
"compilation": {
"default": false,
"type": "boolean"
},
"description": {
"default": "",
"type": "string"
},
"isboxset": {
"default": false,
"type": "boolean"
},
"lastplayed": {
"default": "",
"type": "string"
},
"mood": {
"$ref": "Array.String"
},
"musicbrainzalbumid": {
"default": "",
"type": "string"
},
"musicbrainzreleasegroupid": {
"default": "",
"type": "string"
},
"playcount": {
"default": 0,
"type": "integer"
},
"releasetype": {
"$ref": "Audio.Album.ReleaseType",
"default": "album"
},
"songgenres": {
"$ref": "Audio.Details.Genres"
},
"sourceid": {
"$ref": "Array.Integer"
},
"style": {
"$ref": "Array.String"
},
"theme": {
"$ref": "Array.String"
},
"totaldiscs": {
"default": 0,
"type": "integer"
},
"type": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Audio.Details.Artist ====
'''Extends:'''
* ''[[#Audio.Details.Base|Audio.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' artist
* ''[[#Library.Id|Library.Id]]'' artistid
* [''string'' born]
* [''boolean'' compilationartist]
* [''string'' description]
* [''string'' died]
* [''string'' disambiguation]
* [''string'' disbanded]
* [''string'' formed]
* [''string'' gender]
* [''[[#Array.String|Array.String]]'' instrument]
* [''boolean'' isalbumartist]
* [''[[#Array.String|Array.String]]'' mood]
* [''[[#Array.String|Array.String]]'' musicbrainzartistid]
* [''[[#Audio.Artist.Roles|Audio.Artist.Roles]]'' roles]
* [''[[#Audio.Details.Genres|Audio.Details.Genres]]'' songgenres]
* [''string'' sortname]
* [''[[#Array.Integer|Array.Integer]]'' sourceid]
* [''[[#Array.String|Array.String]]'' style]
* [''string'' type]
* [''[[#Array.String|Array.String]]'' yearsactive]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Audio.Details.Base",
"id": "Audio.Details.Artist",
"properties": {
"artist": {
"required": true,
"type": "string"
},
"artistid": {
"$ref": "Library.Id",
"required": true
},
"born": {
"default": "",
"type": "string"
},
"compilationartist": {
"default": false,
"type": "boolean"
},
"description": {
"default": "",
"type": "string"
},
"died": {
"default": "",
"type": "string"
},
"disambiguation": {
"default": "",
"type": "string"
},
"disbanded": {
"default": "",
"type": "string"
},
"formed": {
"default": "",
"type": "string"
},
"gender": {
"default": "",
"type": "string"
},
"instrument": {
"$ref": "Array.String"
},
"isalbumartist": {
"default": false,
"type": "boolean"
},
"mood": {
"$ref": "Array.String"
},
"musicbrainzartistid": {
"$ref": "Array.String"
},
"roles": {
"$ref": "Audio.Artist.Roles"
},
"songgenres": {
"$ref": "Audio.Details.Genres"
},
"sortname": {
"default": "",
"type": "string"
},
"sourceid": {
"$ref": "Array.Integer"
},
"style": {
"$ref": "Array.String"
},
"type": {
"default": "",
"type": "string"
},
"yearsactive": {
"$ref": "Array.String"
}
}
}
</syntaxhighlight>}}
==== Audio.Details.Base ====
'''Extends:'''
* ''[[#Media.Details.Base|Media.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Media.Artwork|Media.Artwork]]'' art]
* [''string'' dateadded]
* [''[[#Array.String|Array.String]]'' genre]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Media.Details.Base",
"id": "Audio.Details.Base",
"properties": {
"art": {
"$ref": "Media.Artwork"
},
"dateadded": {
"default": "",
"type": "string"
},
"genre": {
"$ref": "Array.String"
}
}
}
</syntaxhighlight>}}
==== Audio.Details.Genres ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Audio.Details.Genres",
"items": {
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
},
"title": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
</syntaxhighlight>}}
==== Audio.Details.Media ====
'''Extends:'''
* ''[[#Audio.Details.Base|Audio.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Array.String|Array.String]]'' artist]
* [''[[#Array.Integer|Array.Integer]]'' artistid]
* [''string'' displayartist]
* [''[[#Array.String|Array.String]]'' musicbrainzalbumartistid]
* [''string'' originaldate]
* [''number'' rating]
* [''string'' releasedate]
* [''string'' sortartist]
* [''string'' title]
* [''integer'' userrating]
* [''integer'' votes]
* [''integer'' year]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Audio.Details.Base",
"id": "Audio.Details.Media",
"properties": {
"artist": {
"$ref": "Array.String"
},
"artistid": {
"$ref": "Array.Integer"
},
"displayartist": {
"default": "",
"type": "string"
},
"musicbrainzalbumartistid": {
"$ref": "Array.String"
},
"originaldate": {
"default": "",
"type": "string"
},
"rating": {
"default": 0.0,
"type": "number"
},
"releasedate": {
"default": "",
"type": "string"
},
"sortartist": {
"default": "",
"type": "string"
},
"title": {
"default": "",
"type": "string"
},
"userrating": {
"default": 0,
"type": "integer"
},
"votes": {
"default": 0,
"type": "integer"
},
"year": {
"default": 0,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== Audio.Details.Role ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' roleid
* [''string'' title]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "Audio.Details.Role",
"properties": {
"roleid": {
"$ref": "Library.Id",
"required": true
},
"title": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Audio.Details.Song ====
'''Extends:'''
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' album]
* [''[[#Array.String|Array.String]]'' albumartist]
* [''[[#Array.Integer|Array.Integer]]'' albumartistid]
* [''[[#Library.Id|Library.Id]]'' albumid = -1]
* [''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' albumreleasetype = album]
* [''any'' bitrate]
* [''any'' bpm]
* [''any'' channels]
* [''string'' comment]
* [''[[#Audio.Contributors|Audio.Contributors]]'' contributors]
* [''integer'' disc]
* [''string'' disctitle]
* [''string'' displaycomposer]
* [''string'' displayconductor]
* [''string'' displaylyricist]
* [''string'' displayorchestra]
* [''integer'' duration]
* [''string'' file]
* [''[[#Array.Integer|Array.Integer]]'' genreid]
* [''string'' lastplayed]
* [''string'' lyrics]
* [''string'' mood]
* [''[[#Array.String|Array.String]]'' musicbrainzartistid]
* [''string'' musicbrainztrackid]
* [''integer'' playcount]
* [''any'' samplerate]
* ''[[#Library.Id|Library.Id]]'' songid
* [''[[#Array.Integer|Array.Integer]]'' sourceid]
* [''integer'' track]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Audio.Details.Media",
"id": "Audio.Details.Song",
"properties": {
"album": {
"default": "",
"type": "string"
},
"albumartist": {
"$ref": "Array.String"
},
"albumartistid": {
"$ref": "Array.Integer"
},
"albumid": {
"$ref": "Library.Id",
"default": -1
},
"albumreleasetype": {
"$ref": "Audio.Album.ReleaseType",
"default": "album"
},
"bitrate": {
"default": null,
"type": "any"
},
"bpm": {
"default": null,
"type": "any"
},
"channels": {
"default": null,
"type": "any"
},
"comment": {
"default": "",
"type": "string"
},
"contributors": {
"$ref": "Audio.Contributors"
},
"disc": {
"default": 0,
"type": "integer"
},
"disctitle": {
"default": "",
"type": "string"
},
"displaycomposer": {
"default": "",
"type": "string"
},
"displayconductor": {
"default": "",
"type": "string"
},
"displaylyricist": {
"default": "",
"type": "string"
},
"displayorchestra": {
"default": "",
"type": "string"
},
"duration": {
"default": 0,
"type": "integer"
},
"file": {
"default": "",
"type": "string"
},
"genreid": {
"$ref": "Array.Integer"
},
"lastplayed": {
"default": "",
"type": "string"
},
"lyrics": {
"default": "",
"type": "string"
},
"mood": {
"default": "",
"type": "string"
},
"musicbrainzartistid": {
"$ref": "Array.String"
},
"musicbrainztrackid": {
"default": "",
"type": "string"
},
"playcount": {
"default": 0,
"type": "integer"
},
"samplerate": {
"default": null,
"type": "any"
},
"songid": {
"$ref": "Library.Id",
"required": true
},
"sourceid": {
"$ref": "Array.Integer"
},
"track": {
"default": 0,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== Audio.Fields.Album ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Audio.Fields.Album",
"items": {
"description": "Requesting the songgenres, artistid and/or sourceid fields will result in increased response times",
"enums": [
"title",
"description",
"artist",
"genre",
"theme",
"mood",
"style",
"type",
"albumlabel",
"rating",
"votes",
"userrating",
"year",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"fanart",
"thumbnail",
"playcount",
"artistid",
"displayartist",
"compilation",
"releasetype",
"dateadded",
"sortartist",
"musicbrainzreleasegroupid",
"songgenres",
"art",
"lastplayed",
"sourceid",
"isboxset",
"totaldiscs",
"releasedate",
"originaldate",
"albumstatus",
"datemodified",
"datenew",
"albumduration"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Audio.Fields.Artist ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Audio.Fields.Artist",
"items": {
"description": "Requesting the (song)genreid/genre, roleid/role or sourceid fields will result in increased response times",
"enums": [
"instrument",
"style",
"mood",
"born",
"formed",
"description",
"genre",
"died",
"disbanded",
"yearsactive",
"musicbrainzartistid",
"fanart",
"thumbnail",
"compilationartist",
"dateadded",
"roles",
"songgenres",
"isalbumartist",
"sortname",
"type",
"gender",
"disambiguation",
"art",
"sourceid",
"datemodified",
"datenew"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Audio.Fields.Role ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Audio.Fields.Role",
"items": {
"enums": [
"title"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Audio.Fields.Song ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Audio.Fields.Song",
"items": {
"description": "Requesting the genreid, artistid, albumartistid and/or sourceid fields will result in increased response times",
"enums": [
"title",
"artist",
"albumartist",
"genre",
"year",
"rating",
"album",
"track",
"duration",
"comment",
"lyrics",
"musicbrainztrackid",
"musicbrainzartistid",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"playcount",
"fanart",
"thumbnail",
"file",
"albumid",
"lastplayed",
"disc",
"genreid",
"artistid",
"displayartist",
"albumartistid",
"albumreleasetype",
"dateadded",
"votes",
"userrating",
"mood",
"contributors",
"displaycomposer",
"displayconductor",
"displayorchestra",
"displaylyricist",
"sortartist",
"art",
"sourceid",
"disctitle",
"releasedate",
"originaldate",
"bpm",
"samplerate",
"bitrate",
"channels",
"datemodified",
"datenew"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Audio.Property.Name ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "missingartistid",
"enums": [
"missingartistid",
"librarylastupdated",
"librarylastcleaned",
"artistlinksupdated",
"songslastadded",
"albumslastadded",
"artistslastadded",
"genreslastadded",
"songsmodified",
"albumsmodified",
"artistsmodified"
],
"id": "Audio.Property.Name",
"type": "string"
}
</syntaxhighlight>}}
==== Audio.Property.Value ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' albumslastadded]
* [''string'' albumsmodified]
* [''string'' artistlinksupdated]
* [''string'' artistslastadded]
* [''string'' artistsmodified]
* [''string'' genreslastadded]
* [''string'' librarylastcleaned]
* [''string'' librarylastupdated]
* [''[[#Library.Id|Library.Id]]'' missingartistid = -1]
* [''string'' songslastadded]
* [''string'' songsmodified]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Audio.Property.Value",
"properties": {
"albumslastadded": {
"default": "",
"type": "string"
},
"albumsmodified": {
"default": "",
"type": "string"
},
"artistlinksupdated": {
"default": "",
"type": "string"
},
"artistslastadded": {
"default": "",
"type": "string"
},
"artistsmodified": {
"default": "",
"type": "string"
},
"genreslastadded": {
"default": "",
"type": "string"
},
"librarylastcleaned": {
"default": "",
"type": "string"
},
"librarylastupdated": {
"default": "",
"type": "string"
},
"missingartistid": {
"$ref": "Library.Id",
"default": -1
},
"songslastadded": {
"default": "",
"type": "string"
},
"songsmodified": {
"default": "",
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
=== Configuration ===
==== Configuration ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Configuration.Notifications|Configuration.Notifications]]'' notifications
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Configuration",
"properties": {
"notifications": {
"$ref": "Configuration.Notifications",
"required": true
}
},
"required": true,
"type": "object"
}
</syntaxhighlight>}}
==== Configuration.Notifications ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' application
* ''boolean'' audiolibrary
* ''boolean'' gui
* ''boolean'' input
* ''boolean'' other
* ''boolean'' player
* ''boolean'' playlist
* ''boolean'' pvr
* ''boolean'' system
* ''boolean'' videolibrary
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"id": "Configuration.Notifications",
"properties": {
"application": {
"required": true,
"type": "boolean"
},
"audiolibrary": {
"required": true,
"type": "boolean"
},
"gui": {
"required": true,
"type": "boolean"
},
"input": {
"required": true,
"type": "boolean"
},
"other": {
"required": true,
"type": "boolean"
},
"player": {
"required": true,
"type": "boolean"
},
"playlist": {
"required": true,
"type": "boolean"
},
"pvr": {
"required": true,
"type": "boolean"
},
"system": {
"required": true,
"type": "boolean"
},
"videolibrary": {
"required": true,
"type": "boolean"
}
},
"type": "object"
}
</syntaxhighlight>}}
=== Favourite ===
==== Favourite.Details.Favourite ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' path]
* [''string'' thumbnail]
* ''string'' title
* ''[[#Favourite.Type|Favourite.Type]]'' type
* [''string'' window]
* [''string'' windowparameter]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"id": "Favourite.Details.Favourite",
"properties": {
"path": {
"default": "",
"type": "string"
},
"thumbnail": {
"default": "",
"type": "string"
},
"title": {
"required": true,
"type": "string"
},
"type": {
"$ref": "Favourite.Type",
"required": true
},
"window": {
"default": "",
"type": "string"
},
"windowparameter": {
"default": "",
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Favourite.Fields.Favourite ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Favourite.Fields.Favourite",
"items": {
"enums": [
"window",
"windowparameter",
"thumbnail",
"path"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Favourite.Type ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "media",
"enums": [
"media",
"window",
"script",
"androidapp",
"unknown"
],
"id": "Favourite.Type",
"type": "string"
}
</syntaxhighlight>}}
=== Files ===
==== Files.Media ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "video",
"enums": [
"video",
"music",
"pictures",
"files",
"programs"
],
"id": "Files.Media",
"type": "string"
}
</syntaxhighlight>}}
=== GUI ===
==== GUI.Property.Name ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "currentwindow",
"enums": [
"currentwindow",
"currentcontrol",
"skin",
"fullscreen",
"stereoscopicmode"
],
"id": "GUI.Property.Name",
"type": "string"
}
</syntaxhighlight>}}
==== GUI.Property.Value ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''object'' currentcontrol]
* [''object'' currentwindow]
* [''boolean'' fullscreen]
* [''object'' skin]
* [''[[#GUI.Stereoscopy.Mode|GUI.Stereoscopy.Mode]]'' stereoscopicmode]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "GUI.Property.Value",
"properties": {
"currentcontrol": {
"properties": {
"label": {
"required": true,
"type": "string"
}
},
"type": "object"
},
"currentwindow": {
"properties": {
"id": {
"required": true,
"type": "integer"
},
"label": {
"required": true,
"type": "string"
}
},
"type": "object"
},
"fullscreen": {
"default": false,
"type": "boolean"
},
"skin": {
"properties": {
"id": {
"minLength": 1,
"required": true,
"type": "string"
},
"name": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"stereoscopicmode": {
"$ref": "GUI.Stereoscopy.Mode"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== GUI.Stereoscopy.Mode ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' label
* ''string'' mode
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "GUI.Stereoscopy.Mode",
"properties": {
"label": {
"required": true,
"type": "string"
},
"mode": {
"enums": [
"off",
"split_vertical",
"split_horizontal",
"row_interleaved",
"hardware_based",
"anaglyph_cyan_red",
"anaglyph_green_magenta",
"anaglyph_yellow_blue",
"monoscopic"
],
"required": true,
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== GUI.Window ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "addon",
"enums": [
"addon",
"addonbrowser",
"addoninformation",
"addonsettings",
"appearancesettings",
"busydialog",
"busydialognocancel",
"contentsettings",
"contextmenu",
"eventlog",
"extendedprogressdialog",
"favourites",
"filebrowser",
"filemanager",
"fullscreengame",
"fullscreeninfo",
"fullscreenlivetv",
"fullscreenlivetvinput",
"fullscreenlivetvpreview",
"fullscreenradio",
"fullscreenradioinput",
"fullscreenradiopreview",
"fullscreenvideo",
"gameadvancedsettings",
"gamecontrollers",
"gameosd",
"gamepadinput",
"games",
"gamesettings",
"gamestretchmode",
"gamevideofilter",
"gamevideorotation",
"gamevolume",
"home",
"infoprovidersettings",
"interfacesettings",
"libexportsettings",
"locksettings",
"loginscreen",
"mediafilter",
"mediasettings",
"mediasource",
"movieinformation",
"music",
"musicinformation",
"musicosd",
"musicplaylist",
"musicplaylisteditor",
"networksetup",
"notification",
"numericinput",
"okdialog",
"osdaudiosettings",
"osdcmssettings",
"osdsubtitlesettings",
"osdvideosettings",
"peripheralsettings",
"pictureinfo",
"pictures",
"playercontrols",
"playerprocessinfo",
"playersettings",
"profiles",
"profilesettings",
"programs",
"progressdialog",
"pvrchannelguide",
"pvrchannelmanager",
"pvrchannelscan",
"pvrgroupmanager",
"pvrguidecontrols",
"pvrguideinfo",
"pvrguidesearch",
"pvrosdchannels",
"pvrosdguide",
"pvrosdteletext",
"pvrradiordsinfo",
"pvrrecordinginfo",
"pvrsettings",
"pvrtimersetting",
"pvrupdateprogress",
"radiochannels",
"radioguide",
"radiorecordings",
"radiosearch",
"radiotimerrules",
"radiotimers",
"screencalibration",
"screensaver",
"seekbar",
"selectdialog",
"servicesettings",
"settings",
"shutdownmenu",
"skinsettings",
"sliderdialog",
"slideshow",
"smartplaylisteditor",
"smartplaylistrule",
"songinformation",
"splash",
"startup",
"startwindow",
"submenu",
"subtitlesearch",
"systeminfo",
"systemsettings",
"teletext",
"textviewer",
"tvchannels",
"tvguide",
"tvrecordings",
"tvsearch",
"tvtimerrules",
"tvtimers",
"videobookmarks",
"videomenu",
"videoosd",
"videoplaylist",
"videos",
"videotimeseek",
"virtualkeyboard",
"visualisation",
"visualisationpresetlist",
"volumebar",
"weather",
"yesnodialog"
],
"id": "GUI.Window",
"type": "string"
}
</syntaxhighlight>}}
=== Global ===
==== Global.IncrementDecrement ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "increment",
"enums": [
"increment",
"decrement"
],
"id": "Global.IncrementDecrement",
"type": "string"
}
</syntaxhighlight>}}
==== Global.String.NotEmpty ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "",
"id": "Global.String.NotEmpty",
"minLength": 1,
"type": "string"
}
</syntaxhighlight>}}
==== Global.Time ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''integer'' hours
* ''integer'' milliseconds
* ''integer'' minutes
* ''integer'' seconds
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"description": "A duration.",
"id": "Global.Time",
"properties": {
"hours": {
"minimum": 0,
"required": true,
"type": "integer"
},
"milliseconds": {
"maximum": 999,
"minimum": 0,
"required": true,
"type": "integer"
},
"minutes": {
"maximum": 59,
"minimum": 0,
"required": true,
"type": "integer"
},
"seconds": {
"maximum": 59,
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Global.Toggle ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": null,
"id": "Global.Toggle",
"type": [
{
"type": "boolean"
},
{
"enums": [
"toggle"
],
"type": "string"
}
]
}
</syntaxhighlight>}}
==== Global.Weekday ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "monday",
"enums": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
],
"id": "Global.Weekday",
"type": "string"
}
</syntaxhighlight>}}
=== Input ===
==== Input.Action ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "analogfastforward",
"enums": [
"analogfastforward",
"analogmove",
"analogmovexleft",
"analogmovexright",
"analogmoveydown",
"analogmoveyup",
"analogrewind",
"analogseekback",
"analogseekforward",
"aspectratio",
"audiodelay",
"audiodelayminus",
"audiodelayplus",
"audionextlanguage",
"audiotoggledigital",
"back",
"backspace",
"bigstepback",
"bigstepforward",
"blue",
"browsesubtitle",
"channeldown",
"channelnumberseparator",
"channelup",
"chapterorbigstepback",
"chapterorbigstepforward",
"close",
"codecinfo",
"contextmenu",
"copy",
"createbookmark",
"createepisodebookmark",
"cursorleft",
"cursorright",
"cyclesubtitle",
"cycletonemapmethod",
"decreasepar",
"decreaserating",
"decreasevisrating",
"delete",
"doubleclick",
"down",
"enter",
"error",
"fastforward",
"filter",
"filterclear",
"filtersms2",
"filtersms3",
"filtersms4",
"filtersms5",
"filtersms6",
"filtersms7",
"filtersms8",
"filtersms9",
"firstpage",
"fullscreen",
"green",
"guiprofile",
"hdrtoggle",
"highlight",
"increasepar",
"increaserating",
"increasevisrating",
"info",
"jumpsms2",
"jumpsms3",
"jumpsms4",
"jumpsms5",
"jumpsms6",
"jumpsms7",
"jumpsms8",
"jumpsms9",
"lastpage",
"left",
"leftclick",
"lockpreset",
"longclick",
"longpress",
"menu",
"middleclick",
"mousedrag",
"mousedragend",
"mousemove",
"move",
"moveitemdown",
"moveitemup",
"mute",
"nextcalibration",
"nextchannelgroup",
"nextletter",
"nextpicture",
"nextpreset",
"nextresolution",
"nextscene",
"nextstereomode",
"nextsubtitle",
"noop",
"number0",
"number1",
"number2",
"number3",
"number4",
"number5",
"number6",
"number7",
"number8",
"number9",
"osd",
"pagedown",
"pageup",
"pangesture",
"parentdir",
"parentfolder",
"pause",
"play",
"playerdebug",
"playerdebugvideo",
"playerprocessinfo",
"playerprogramselect",
"playerresolutionselect",
"playlist",
"playnext",
"playpause",
"playpvr",
"playpvrradio",
"playpvrtv",
"previouschannelgroup",
"previousmenu",
"previouspicture",
"previouspreset",
"previousscene",
"previousstereomode",
"prevletter",
"queue",
"randompreset",
"record",
"red",
"reloadkeymaps",
"rename",
"resetcalibration",
"rewind",
"right",
"rightclick",
"rotate",
"rotateccw",
"rotategesture",
"scanitem",
"screenshot",
"scrolldown",
"scrollup",
"select",
"setrating",
"settingslevelchange",
"settingsreset",
"shift",
"showpreset",
"showsubtitles",
"showtime",
"showtimerrule",
"showvideomenu",
"skipnext",
"skipprevious",
"smallstepback",
"stepback",
"stepforward",
"stereomode",
"stereomodetomono",
"stop",
"subtitlealign",
"subtitledelay",
"subtitledelayminus",
"subtitledelayplus",
"subtitleshiftdown",
"subtitleshiftup",
"swipedown",
"swipeleft",
"swiperight",
"swipeup",
"switchplayer",
"symbols",
"tap",
"togglecommskip",
"togglefont",
"togglefullscreen",
"togglestereomode",
"togglewatched",
"up",
"verticalshiftdown",
"verticalshiftup",
"videonextstream",
"voicerecognizer",
"volampdown",
"volampup",
"volumeamplification",
"volumedown",
"volumeup",
"wheeldown",
"wheelup",
"yellow",
"zoomgesture",
"zoomin",
"zoomlevel1",
"zoomlevel2",
"zoomlevel3",
"zoomlevel4",
"zoomlevel5",
"zoomlevel6",
"zoomlevel7",
"zoomlevel8",
"zoomlevel9",
"zoomnormal",
"zoomout"
],
"id": "Input.Action",
"type": "string"
}
</syntaxhighlight>}}
=== Item ===
==== Item.CustomProperties ====
'''Type:''' ''object''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": {
"$ref": "Global.String.NotEmpty",
"default": ""
},
"id": "Item.CustomProperties",
"type": "object"
}
</syntaxhighlight>}}
==== Item.Details.Base ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' label
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Item.Details.Base",
"properties": {
"label": {
"required": true,
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Item.Fields.Base ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Item.Fields.Base",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
</syntaxhighlight>}}
=== Library ===
==== Library.Details.Genre ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' genreid
* [''[[#Array.Integer|Array.Integer]]'' sourceid]
* [''string'' thumbnail]
* [''string'' title]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "Library.Details.Genre",
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
},
"sourceid": {
"$ref": "Array.Integer",
"description": "The ids of sources with songs of the genre"
},
"thumbnail": {
"default": "",
"type": "string"
},
"title": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Library.Details.Source ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' file
* [''[[#Array.String|Array.String]]'' paths]
* ''[[#Library.Id|Library.Id]]'' sourceid
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "Library.Details.Source",
"properties": {
"file": {
"description": "The url encoded multipath string combining all paths of the source ",
"required": true,
"type": "string"
},
"paths": {
"$ref": "Array.String",
"description": "The individual paths of the media source"
},
"sourceid": {
"$ref": "Library.Id",
"required": true
}
}
}
</syntaxhighlight>}}
==== Library.Details.Tag ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' tagid
* [''string'' title]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "Library.Details.Tag",
"properties": {
"tagid": {
"$ref": "Library.Id",
"required": true
},
"title": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Library.Fields.Genre ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Library.Fields.Genre",
"items": {
"enums": [
"title",
"thumbnail",
"sourceid"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Library.Fields.Source ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Library.Fields.Source",
"items": {
"enums": [
"file",
"paths"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Library.Fields.Tag ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Library.Fields.Tag",
"items": {
"enums": [
"title"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Library.Id ====
'''Type:''' ''integer''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": -1,
"id": "Library.Id",
"minimum": 1,
"type": "integer"
}
</syntaxhighlight>}}
=== List ===
==== List.Amount ====
'''Type:''' ''integer''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": -1,
"id": "List.Amount",
"minimum": 0,
"type": "integer"
}
</syntaxhighlight>}}
==== List.Fields.All ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "List.Fields.All",
"items": {
"enums": [
"title",
"artist",
"albumartist",
"genre",
"year",
"rating",
"album",
"track",
"duration",
"comment",
"lyrics",
"musicbrainztrackid",
"musicbrainzartistid",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"playcount",
"fanart",
"director",
"trailer",
"tagline",
"plot",
"plotoutline",
"originaltitle",
"lastplayed",
"writer",
"studio",
"mpaa",
"cast",
"country",
"imdbnumber",
"premiered",
"productioncode",
"runtime",
"set",
"showlink",
"streamdetails",
"top250",
"votes",
"firstaired",
"season",
"episode",
"showtitle",
"thumbnail",
"file",
"resume",
"artistid",
"albumid",
"tvshowid",
"setid",
"watchedepisodes",
"disc",
"tag",
"art",
"genreid",
"displayartist",
"albumartistid",
"description",
"theme",
"mood",
"style",
"albumlabel",
"sorttitle",
"episodeguide",
"uniqueid",
"dateadded",
"channel",
"channeltype",
"hidden",
"locked",
"channelnumber",
"subchannelnumber",
"starttime",
"endtime",
"specialsortseason",
"specialsortepisode",
"compilation",
"releasetype",
"albumreleasetype",
"contributors",
"displaycomposer",
"displayconductor",
"displayorchestra",
"displaylyricist",
"userrating",
"sortartist",
"musicbrainzreleasegroupid",
"mediapath",
"dynpath",
"isboxset",
"totaldiscs",
"disctitle",
"releasedate",
"originaldate",
"bpm",
"bitrate",
"samplerate",
"channels",
"albumstatus",
"datemodified",
"datenew",
"customproperties",
"albumduration"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== List.Fields.Files ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "List.Fields.Files",
"items": {
"enums": [
"title",
"artist",
"albumartist",
"genre",
"year",
"rating",
"album",
"track",
"duration",
"comment",
"lyrics",
"musicbrainztrackid",
"musicbrainzartistid",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"playcount",
"fanart",
"director",
"trailer",
"tagline",
"plot",
"plotoutline",
"originaltitle",
"lastplayed",
"writer",
"studio",
"mpaa",
"cast",
"country",
"imdbnumber",
"premiered",
"productioncode",
"runtime",
"set",
"showlink",
"streamdetails",
"top250",
"votes",
"firstaired",
"season",
"episode",
"showtitle",
"thumbnail",
"file",
"resume",
"artistid",
"albumid",
"tvshowid",
"setid",
"watchedepisodes",
"disc",
"tag",
"art",
"genreid",
"displayartist",
"albumartistid",
"description",
"theme",
"mood",
"style",
"albumlabel",
"sorttitle",
"episodeguide",
"uniqueid",
"dateadded",
"size",
"lastmodified",
"mimetype",
"specialsortseason",
"specialsortepisode",
"sortartist",
"musicbrainzreleasegroupid",
"isboxset",
"totaldiscs",
"disctitle",
"releasedate",
"originaldate",
"bpm",
"bitrate",
"samplerate",
"channels",
"datemodified",
"datenew",
"customproperties",
"albumduration"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== List.Filter.Albums ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.Albums",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.Albums"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.Albums"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Albums"
}
]
}
</syntaxhighlight>}}
==== List.Filter.Artists ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.Artists",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.Artists"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.Artists"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Artists"
}
]
}
</syntaxhighlight>}}
==== List.Filter.Episodes ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.Episodes",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.Episodes"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.Episodes"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Episodes"
}
]
}
</syntaxhighlight>}}
==== List.Filter.Fields.Albums ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "genre",
"enums": [
"genre",
"source",
"album",
"disctitle",
"totaldiscs",
"isboxset",
"artist",
"albumartist",
"year",
"originalyear",
"albumduration",
"review",
"themes",
"moods",
"styles",
"compilation",
"type",
"label",
"rating",
"userrating",
"playcount",
"lastplayed",
"path",
"albumstatus",
"dateadded",
"datemodified",
"datenew",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Albums",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Fields.Artists ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "artist",
"enums": [
"artist",
"source",
"genre",
"moods",
"styles",
"instruments",
"biography",
"artisttype",
"gender",
"disambiguation",
"born",
"bandformed",
"disbanded",
"died",
"role",
"path",
"dateadded",
"datemodified",
"datenew",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Artists",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Fields.Episodes ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "title",
"enums": [
"title",
"tvshow",
"originaltitle",
"plot",
"votes",
"rating",
"userrating",
"time",
"writers",
"airdate",
"playcount",
"lastplayed",
"inprogress",
"genre",
"year",
"director",
"actor",
"episode",
"season",
"filename",
"path",
"studio",
"mpaarating",
"dateadded",
"tag",
"videoresolution",
"audiochannels",
"audiocount",
"subtitlecount",
"videocodec",
"audiocodec",
"audiolanguage",
"subtitlelanguage",
"videoaspect",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Episodes",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Fields.Movies ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "title",
"enums": [
"title",
"originaltitle",
"plot",
"plotoutline",
"tagline",
"votes",
"rating",
"userrating",
"time",
"writers",
"playcount",
"lastplayed",
"inprogress",
"genre",
"country",
"year",
"director",
"actor",
"mpaarating",
"top250",
"studio",
"hastrailer",
"filename",
"path",
"set",
"tag",
"dateadded",
"videoresolution",
"audiochannels",
"audiocount",
"subtitlecount",
"videocodec",
"audiocodec",
"audiolanguage",
"subtitlelanguage",
"videoaspect",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Movies",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Fields.MusicVideos ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "title",
"enums": [
"title",
"genre",
"album",
"year",
"artist",
"filename",
"path",
"playcount",
"lastplayed",
"rating",
"userrating",
"time",
"director",
"studio",
"plot",
"tag",
"dateadded",
"videoresolution",
"audiochannels",
"audiocount",
"subtitlecount",
"videocodec",
"audiocodec",
"audiolanguage",
"subtitlelanguage",
"videoaspect",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.MusicVideos",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Fields.Songs ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "genre",
"enums": [
"genre",
"source",
"album",
"disctitle",
"artist",
"albumartist",
"title",
"year",
"originalyear",
"time",
"tracknumber",
"filename",
"path",
"playcount",
"lastplayed",
"rating",
"userrating",
"comment",
"moods",
"bpm",
"samplerate",
"bitrate",
"channels",
"dateadded",
"datemodified",
"datenew",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Songs",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Fields.TVShows ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "title",
"enums": [
"title",
"originaltitle",
"plot",
"status",
"votes",
"rating",
"userrating",
"year",
"genre",
"director",
"actor",
"numepisodes",
"numwatched",
"playcount",
"path",
"studio",
"mpaarating",
"dateadded",
"lastplayed",
"inprogress",
"tag",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.TVShows",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Fields.Textures ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "textureid",
"enums": [
"textureid",
"url",
"cachedurl",
"lasthashcheck",
"imagehash",
"width",
"height",
"usecount",
"lastused"
],
"id": "List.Filter.Fields.Textures",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Movies ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.Movies",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.Movies"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.Movies"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Movies"
}
]
}
</syntaxhighlight>}}
==== List.Filter.MusicVideos ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.MusicVideos",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.MusicVideos"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.MusicVideos"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.MusicVideos"
}
]
}
</syntaxhighlight>}}
==== List.Filter.Operators ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "contains",
"enums": [
"contains",
"doesnotcontain",
"is",
"isnot",
"startswith",
"endswith",
"greaterthan",
"lessthan",
"after",
"before",
"inthelast",
"notinthelast",
"true",
"false",
"between"
],
"id": "List.Filter.Operators",
"type": "string"
}
</syntaxhighlight>}}
==== List.Filter.Rule ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Operators|List.Filter.Operators]]'' operator
* ''mixed: string|array'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.Rule",
"properties": {
"operator": {
"$ref": "List.Filter.Operators",
"required": true
},
"value": {
"required": true,
"type": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"type": "object"
}
</syntaxhighlight>}}
==== List.Filter.Rule.Albums ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Albums|List.Filter.Fields.Albums]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Filter.Rule",
"id": "List.Filter.Rule.Albums",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Albums",
"required": true
}
}
}
</syntaxhighlight>}}
==== List.Filter.Rule.Artists ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Artists|List.Filter.Fields.Artists]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Filter.Rule",
"id": "List.Filter.Rule.Artists",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Artists",
"required": true
}
}
}
</syntaxhighlight>}}
==== List.Filter.Rule.Episodes ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Episodes|List.Filter.Fields.Episodes]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Filter.Rule",
"id": "List.Filter.Rule.Episodes",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Episodes",
"required": true
}
}
}
</syntaxhighlight>}}
==== List.Filter.Rule.Movies ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Movies|List.Filter.Fields.Movies]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Filter.Rule",
"id": "List.Filter.Rule.Movies",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Movies",
"required": true
}
}
}
</syntaxhighlight>}}
==== List.Filter.Rule.MusicVideos ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.MusicVideos|List.Filter.Fields.MusicVideos]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Filter.Rule",
"id": "List.Filter.Rule.MusicVideos",
"properties": {
"field": {
"$ref": "List.Filter.Fields.MusicVideos",
"required": true
}
}
}
</syntaxhighlight>}}
==== List.Filter.Rule.Songs ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Songs|List.Filter.Fields.Songs]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Filter.Rule",
"id": "List.Filter.Rule.Songs",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Songs",
"required": true
}
}
}
</syntaxhighlight>}}
==== List.Filter.Rule.TVShows ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.TVShows|List.Filter.Fields.TVShows]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Filter.Rule",
"id": "List.Filter.Rule.TVShows",
"properties": {
"field": {
"$ref": "List.Filter.Fields.TVShows",
"required": true
}
}
}
</syntaxhighlight>}}
==== List.Filter.Rule.Textures ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Textures|List.Filter.Fields.Textures]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Filter.Rule",
"id": "List.Filter.Rule.Textures",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Textures",
"required": true
}
}
}
</syntaxhighlight>}}
==== List.Filter.Songs ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.Songs",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.Songs"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.Songs"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Songs"
}
]
}
</syntaxhighlight>}}
==== List.Filter.TVShows ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.TVShows",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.TVShows"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.TVShows"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.TVShows"
}
]
}
</syntaxhighlight>}}
==== List.Filter.Textures ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Filter.Textures",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.Textures"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.Textures"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Textures"
}
]
}
</syntaxhighlight>}}
==== List.Item.All ====
'''Extends:'''
* ''[[#List.Item.Base|List.Item.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' channel]
* [''integer'' channelnumber]
* [''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype = tv]
* [''string'' endtime]
* [''boolean'' hidden]
* [''boolean'' locked]
* [''string'' starttime]
* [''integer'' subchannelnumber]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Item.Base",
"id": "List.Item.All",
"properties": {
"channel": {
"default": "",
"type": "string"
},
"channelnumber": {
"default": 0,
"type": "integer"
},
"channeltype": {
"$ref": "PVR.Channel.Type",
"default": "tv"
},
"endtime": {
"default": "",
"type": "string"
},
"hidden": {
"default": false,
"type": "boolean"
},
"locked": {
"default": false,
"type": "boolean"
},
"starttime": {
"default": "",
"type": "string"
},
"subchannelnumber": {
"default": 0,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== List.Item.Base ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' album]
* [''[[#Array.String|Array.String]]'' albumartist]
* [''[[#Array.Integer|Array.Integer]]'' albumartistid]
* [''[[#Library.Id|Library.Id]]'' albumid = -1]
* [''string'' albumlabel]
* [''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' albumreleasetype = album]
* [''string'' albumstatus]
* [''integer'' bitrate]
* [''integer'' bpm]
* [''[[#Video.Cast|Video.Cast]]'' cast]
* [''integer'' channels]
* [''string'' comment]
* [''boolean'' compilation]
* [''[[#Audio.Contributors|Audio.Contributors]]'' contributors]
* [''[[#Array.String|Array.String]]'' country]
* [''[[#Item.CustomProperties|Item.CustomProperties]]'' customproperties]
* [''string'' description]
* [''integer'' disc]
* [''string'' disctitle]
* [''string'' displaycomposer]
* [''string'' displayconductor]
* [''string'' displaylyricist]
* [''string'' displayorchestra]
* [''integer'' duration]
* [''string'' dynpath]
* [''integer'' episode]
* [''string'' episodeguide]
* [''string'' firstaired]
* [''[[#Library.Id|Library.Id]]'' id = -1]
* [''string'' imdbnumber]
* [''boolean'' isboxset]
* [''string'' lyrics]
* [''string'' mediapath]
* [''[[#Array.String|Array.String]]'' mood]
* [''string'' mpaa]
* [''[[#Array.String|Array.String]]'' musicbrainzartistid]
* [''string'' musicbrainztrackid]
* [''string'' originaldate]
* [''string'' originaltitle]
* [''string'' plotoutline]
* [''string'' premiered]
* [''string'' productioncode]
* [''string'' releasedate]
* [''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' releasetype = album]
* [''integer'' samplerate]
* [''integer'' season]
* [''string'' set]
* [''[[#Library.Id|Library.Id]]'' setid = -1]
* [''[[#Array.String|Array.String]]'' showlink]
* [''string'' showtitle]
* [''string'' sorttitle]
* [''integer'' specialsortepisode]
* [''integer'' specialsortseason]
* [''[[#Array.String|Array.String]]'' studio]
* [''[[#Array.String|Array.String]]'' style]
* [''[[#Array.String|Array.String]]'' tag]
* [''string'' tagline]
* [''[[#Array.String|Array.String]]'' theme]
* [''integer'' top250]
* [''integer'' totaldiscs]
* [''integer'' track]
* [''string'' trailer]
* [''[[#Library.Id|Library.Id]]'' tvshowid = -1]
* [''string'' type = unknown]
* [''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid]
* [''string'' votes]
* [''integer'' watchedepisodes]
* [''[[#Array.String|Array.String]]'' writer]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": [
"Video.Details.File",
"Audio.Details.Media"
],
"id": "List.Item.Base",
"properties": {
"album": {
"default": "",
"type": "string"
},
"albumartist": {
"$ref": "Array.String"
},
"albumartistid": {
"$ref": "Array.Integer"
},
"albumid": {
"$ref": "Library.Id",
"default": -1
},
"albumlabel": {
"default": "",
"type": "string"
},
"albumreleasetype": {
"$ref": "Audio.Album.ReleaseType",
"default": "album"
},
"albumstatus": {
"default": "",
"type": "string"
},
"bitrate": {
"default": 0,
"type": "integer"
},
"bpm": {
"default": 0,
"type": "integer"
},
"cast": {
"$ref": "Video.Cast"
},
"channels": {
"default": 0,
"type": "integer"
},
"comment": {
"default": "",
"type": "string"
},
"compilation": {
"default": false,
"type": "boolean"
},
"contributors": {
"$ref": "Audio.Contributors"
},
"country": {
"$ref": "Array.String"
},
"customproperties": {
"$ref": "Item.CustomProperties"
},
"description": {
"default": "",
"type": "string"
},
"disc": {
"default": 0,
"type": "integer"
},
"disctitle": {
"default": "",
"type": "string"
},
"displaycomposer": {
"default": "",
"type": "string"
},
"displayconductor": {
"default": "",
"type": "string"
},
"displaylyricist": {
"default": "",
"type": "string"
},
"displayorchestra": {
"default": "",
"type": "string"
},
"duration": {
"default": 0,
"type": "integer"
},
"dynpath": {
"default": "",
"description": "An experimental property for debug purposes, often same as mediapath but when different gives the actual file playing that should also be in file property",
"type": "string"
},
"episode": {
"default": 0,
"type": "integer"
},
"episodeguide": {
"default": "",
"type": "string"
},
"firstaired": {
"default": "",
"type": "string"
},
"id": {
"$ref": "Library.Id",
"default": -1
},
"imdbnumber": {
"default": "",
"type": "string"
},
"isboxset": {
"default": false,
"type": "boolean"
},
"lyrics": {
"default": "",
"type": "string"
},
"mediapath": {
"default": "",
"description": "Media source path that identifies the item",
"type": "string"
},
"mood": {
"$ref": "Array.String"
},
"mpaa": {
"default": "",
"type": "string"
},
"musicbrainzartistid": {
"$ref": "Array.String"
},
"musicbrainztrackid": {
"default": "",
"type": "string"
},
"originaldate": {
"default": "",
"type": "string"
},
"originaltitle": {
"default": "",
"type": "string"
},
"plotoutline": {
"default": "",
"type": "string"
},
"premiered": {
"default": "",
"type": "string"
},
"productioncode": {
"default": "",
"type": "string"
},
"releasedate": {
"default": "",
"type": "string"
},
"releasetype": {
"$ref": "Audio.Album.ReleaseType",
"default": "album"
},
"samplerate": {
"default": 0,
"type": "integer"
},
"season": {
"default": 0,
"type": "integer"
},
"set": {
"default": "",
"type": "string"
},
"setid": {
"$ref": "Library.Id",
"default": -1
},
"showlink": {
"$ref": "Array.String"
},
"showtitle": {
"default": "",
"type": "string"
},
"sorttitle": {
"default": "",
"type": "string"
},
"specialsortepisode": {
"default": 0,
"type": "integer"
},
"specialsortseason": {
"default": 0,
"type": "integer"
},
"studio": {
"$ref": "Array.String"
},
"style": {
"$ref": "Array.String"
},
"tag": {
"$ref": "Array.String"
},
"tagline": {
"default": "",
"type": "string"
},
"theme": {
"$ref": "Array.String"
},
"top250": {
"default": 0,
"type": "integer"
},
"totaldiscs": {
"default": 0,
"type": "integer"
},
"track": {
"default": 0,
"type": "integer"
},
"trailer": {
"default": "",
"type": "string"
},
"tvshowid": {
"$ref": "Library.Id",
"default": -1
},
"type": {
"default": "unknown",
"enums": [
"unknown",
"movie",
"episode",
"musicvideo",
"song",
"picture",
"channel"
],
"type": "string"
},
"uniqueid": {
"$ref": "Media.UniqueID"
},
"votes": {
"default": "",
"type": "string"
},
"watchedepisodes": {
"default": 0,
"type": "integer"
},
"writer": {
"$ref": "Array.String"
}
}
}
</syntaxhighlight>}}
==== List.Item.File ====
'''Extends:'''
* ''[[#List.Item.Base|List.Item.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' file
* ''string'' filetype
* [''string'' lastmodified]
* [''string'' mimetype]
* [''integer'' size]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "List.Item.Base",
"id": "List.Item.File",
"properties": {
"file": {
"required": true,
"type": "string"
},
"filetype": {
"enums": [
"file",
"directory"
],
"required": true,
"type": "string"
},
"lastmodified": {
"default": "",
"type": "string"
},
"mimetype": {
"default": "",
"type": "string"
},
"size": {
"default": 0,
"description": "Size of the file in bytes",
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== List.Items.Sources ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Items.Sources",
"items": {
"extends": "Item.Details.Base",
"properties": {
"file": {
"required": true,
"type": "string"
}
}
},
"type": "array"
}
</syntaxhighlight>}}
==== List.Limits ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#List.Amount|List.Amount]]'' end = -1]
* [''integer'' start]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"id": "List.Limits",
"properties": {
"end": {
"$ref": "List.Amount",
"default": -1,
"description": "Index of the last item to return"
},
"start": {
"default": 0,
"description": "Index of the first item to return",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== List.LimitsReturned ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#List.Amount|List.Amount]]'' end = -1]
* [''integer'' start]
* ''integer'' total
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"id": "List.LimitsReturned",
"properties": {
"end": {
"$ref": "List.Amount",
"default": -1
},
"start": {
"default": 0,
"minimum": 0,
"type": "integer"
},
"total": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== List.Sort ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''boolean'' ignorearticle]
* [''string'' method = none]
* [''string'' order = ascending]
* [''boolean'' useartistsortname]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "List.Sort",
"properties": {
"ignorearticle": {
"default": false,
"type": "boolean"
},
"method": {
"default": "none",
"enums": [
"none",
"label",
"date",
"size",
"file",
"path",
"drivetype",
"title",
"track",
"time",
"artist",
"album",
"albumtype",
"genre",
"country",
"year",
"rating",
"userrating",
"votes",
"top250",
"programcount",
"playlist",
"episode",
"season",
"totalepisodes",
"watchedepisodes",
"tvshowstatus",
"tvshowtitle",
"sorttitle",
"productioncode",
"mpaa",
"studio",
"dateadded",
"lastplayed",
"playcount",
"listeners",
"bitrate",
"random",
"totaldiscs",
"originaldate",
"bpm"
],
"type": "string"
},
"order": {
"default": "ascending",
"enums": [
"ascending",
"descending"
],
"type": "string"
},
"useartistsortname": {
"default": false,
"type": "boolean"
}
},
"type": "object"
}
</syntaxhighlight>}}
=== Media ===
==== Media.Artwork ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' banner]
* [''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' fanart]
* [''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' poster]
* [''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' thumb]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": {
"$ref": "Global.String.NotEmpty",
"default": ""
},
"id": "Media.Artwork",
"properties": {
"banner": {
"$ref": "Global.String.NotEmpty",
"default": ""
},
"fanart": {
"$ref": "Global.String.NotEmpty",
"default": ""
},
"poster": {
"$ref": "Global.String.NotEmpty",
"default": ""
},
"thumb": {
"$ref": "Global.String.NotEmpty",
"default": ""
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Media.Artwork.Set ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''mixed: null|[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' banner]
* [''mixed: null|[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' fanart]
* [''mixed: null|[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' poster]
* [''mixed: null|[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' thumb]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": {
"default": null,
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
]
},
"id": "Media.Artwork.Set",
"properties": {
"banner": {
"default": "",
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
]
},
"fanart": {
"default": "",
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
]
},
"poster": {
"default": "",
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
]
},
"thumb": {
"default": "",
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
]
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Media.Details.Base ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' fanart]
* [''string'' thumbnail]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "Media.Details.Base",
"properties": {
"fanart": {
"default": "",
"type": "string"
},
"thumbnail": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Media.UniqueID ====
'''Type:''' ''object''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": {
"$ref": "Global.String.NotEmpty",
"default": ""
},
"id": "Media.UniqueID",
"type": "object"
}
</syntaxhighlight>}}
==== Media.UniqueID.Set ====
'''Type:''' ''object''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": {
"default": null,
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
]
},
"id": "Media.UniqueID.Set",
"type": "object"
}
</syntaxhighlight>}}
=== Notifications ===
==== Notifications.Item ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Notifications.Item",
"type": [
{
"description": "An unknown item does not have any additional information.",
"properties": {
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
},
{
"description": "An item known to the database has an identification.",
"properties": {
"id": {
"$ref": "Library.Id",
"required": true
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
},
{
"description": "A movie item has a title and may have a release year.",
"properties": {
"title": {
"required": true,
"type": "string"
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
},
"year": {
"default": 0,
"type": "integer"
}
},
"type": "object"
},
{
"description": "A tv episode has a title and may have an episode number, season number and the title of the show it belongs to.",
"properties": {
"episode": {
"default": 0,
"type": "integer"
},
"season": {
"default": 0,
"type": "integer"
},
"showtitle": {
"default": "",
"type": "string"
},
"title": {
"required": true,
"type": "string"
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
},
{
"description": "A music video has a title and may have an album and an artist.",
"properties": {
"album": {
"default": "",
"type": "string"
},
"artist": {
"default": "",
"type": "string"
},
"title": {
"required": true,
"type": "string"
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
},
{
"description": "A song has a title and may have an album, an artist and a track number.",
"properties": {
"album": {
"default": "",
"type": "string"
},
"artist": {
"default": "",
"type": "string"
},
"title": {
"required": true,
"type": "string"
},
"track": {
"default": 0,
"type": "integer"
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
},
{
"description": "A picture has a file path.",
"properties": {
"file": {
"required": true,
"type": "string"
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
},
{
"description": "A PVR channel is either a radio or tv channel and has a title.",
"properties": {
"channeltype": {
"$ref": "PVR.Channel.Type",
"required": true
},
"id": {
"$ref": "Library.Id",
"required": true
},
"title": {
"required": true,
"type": "string"
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
}
]
}
</syntaxhighlight>}}
==== Notifications.Item.Type ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "unknown",
"enums": [
"unknown",
"movie",
"episode",
"musicvideo",
"song",
"picture",
"channel"
],
"id": "Notifications.Item.Type",
"type": "string"
}
</syntaxhighlight>}}
=== Optional ===
==== Optional.Boolean ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": null,
"id": "Optional.Boolean",
"type": [
{
"type": "null"
},
{
"type": "boolean"
}
]
}
</syntaxhighlight>}}
==== Optional.Integer ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": null,
"id": "Optional.Integer",
"type": [
{
"type": "null"
},
{
"type": "integer"
}
]
}
</syntaxhighlight>}}
==== Optional.Number ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": null,
"id": "Optional.Number",
"type": [
{
"type": "null"
},
{
"type": "number"
}
]
}
</syntaxhighlight>}}
==== Optional.String ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": null,
"id": "Optional.String",
"type": [
{
"type": "null"
},
{
"type": "string"
}
]
}
</syntaxhighlight>}}
=== PVR ===
==== PVR.Channel.Type ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "tv",
"enums": [
"tv",
"radio"
],
"id": "PVR.Channel.Type",
"type": "string"
}
</syntaxhighlight>}}
==== PVR.ChannelGroup.Id ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": null,
"id": "PVR.ChannelGroup.Id",
"type": [
{
"$ref": "Library.Id"
},
{
"enums": [
"alltv",
"allradio"
],
"type": "string"
}
]
}
</syntaxhighlight>}}
==== PVR.Details.Broadcast ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' broadcastid
* [''string'' cast]
* [''[[#Library.Id|Library.Id]]'' clientid = -1]
* [''string'' director]
* [''string'' endtime]
* [''string'' episodename]
* [''integer'' episodenum]
* [''integer'' episodepart]
* [''string'' firstaired]
* [''string'' genre]
* [''boolean'' hasrecording]
* [''boolean'' hasreminder]
* [''boolean'' hastimer]
* [''boolean'' hastimerrule]
* [''integer'' imdbnumber]
* [''boolean'' isactive]
* [''boolean'' isplayable]
* [''boolean'' isseries]
* [''string'' originaltitle]
* [''integer'' parentalrating]
* [''string'' plot]
* [''string'' plotoutline]
* [''integer'' progress]
* [''number'' progresspercentage]
* [''integer'' rating]
* [''string'' recording]
* [''integer'' runtime]
* [''string'' starttime]
* [''string'' thumbnail]
* [''string'' title]
* [''boolean'' wasactive]
* [''string'' writer]
* [''integer'' year]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "PVR.Details.Broadcast",
"properties": {
"broadcastid": {
"$ref": "Library.Id",
"required": true
},
"cast": {
"default": "",
"type": "string"
},
"clientid": {
"$ref": "Library.Id",
"default": -1
},
"director": {
"default": "",
"type": "string"
},
"endtime": {
"default": "",
"type": "string"
},
"episodename": {
"default": "",
"type": "string"
},
"episodenum": {
"default": 0,
"type": "integer"
},
"episodepart": {
"default": 0,
"type": "integer"
},
"firstaired": {
"default": "",
"type": "string"
},
"genre": {
"default": "",
"type": "string"
},
"hasrecording": {
"default": false,
"type": "boolean"
},
"hasreminder": {
"default": false,
"type": "boolean"
},
"hastimer": {
"default": false,
"type": "boolean"
},
"hastimerrule": {
"default": false,
"type": "boolean"
},
"imdbnumber": {
"default": 0,
"type": "integer"
},
"isactive": {
"default": false,
"type": "boolean"
},
"isplayable": {
"default": false,
"description": "Deprecated - Use GetBroadcastIsPlayable instead",
"type": "boolean"
},
"isseries": {
"default": false,
"type": "boolean"
},
"originaltitle": {
"default": "",
"type": "string"
},
"parentalrating": {
"default": 0,
"type": "integer"
},
"plot": {
"default": "",
"type": "string"
},
"plotoutline": {
"default": "",
"type": "string"
},
"progress": {
"default": 0,
"type": "integer"
},
"progresspercentage": {
"default": 0.0,
"type": "number"
},
"rating": {
"default": 0,
"type": "integer"
},
"recording": {
"default": "",
"type": "string"
},
"runtime": {
"default": 0,
"type": "integer"
},
"starttime": {
"default": "",
"type": "string"
},
"thumbnail": {
"default": "",
"type": "string"
},
"title": {
"default": "",
"type": "string"
},
"wasactive": {
"default": false,
"type": "boolean"
},
"writer": {
"default": "",
"type": "string"
},
"year": {
"default": 0,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== PVR.Details.Channel ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#PVR.Details.Broadcast|PVR.Details.Broadcast]]'' broadcastnext]
* [''[[#PVR.Details.Broadcast|PVR.Details.Broadcast]]'' broadcastnow]
* [''string'' channel]
* ''[[#Library.Id|Library.Id]]'' channelid
* [''integer'' channelnumber]
* [''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype = tv]
* [''[[#Library.Id|Library.Id]]'' clientid = -1]
* [''boolean'' hasarchive]
* [''boolean'' hidden]
* [''string'' icon]
* [''boolean'' isrecording]
* [''string'' lastplayed]
* [''boolean'' locked]
* [''integer'' subchannelnumber]
* [''string'' thumbnail]
* ''integer'' uniqueid
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "PVR.Details.Channel",
"properties": {
"broadcastnext": {
"$ref": "PVR.Details.Broadcast"
},
"broadcastnow": {
"$ref": "PVR.Details.Broadcast"
},
"channel": {
"default": "",
"type": "string"
},
"channelid": {
"$ref": "Library.Id",
"required": true
},
"channelnumber": {
"default": 0,
"type": "integer"
},
"channeltype": {
"$ref": "PVR.Channel.Type",
"default": "tv"
},
"clientid": {
"$ref": "Library.Id",
"default": -1
},
"hasarchive": {
"default": false,
"type": "boolean"
},
"hidden": {
"default": false,
"type": "boolean"
},
"icon": {
"default": "",
"type": "string"
},
"isrecording": {
"default": false,
"type": "boolean"
},
"lastplayed": {
"default": "",
"type": "string"
},
"locked": {
"default": false,
"type": "boolean"
},
"subchannelnumber": {
"default": 0,
"type": "integer"
},
"thumbnail": {
"default": "",
"type": "string"
},
"uniqueid": {
"required": true,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== PVR.Details.ChannelGroup ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' channelgroupid
* ''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "PVR.Details.ChannelGroup",
"properties": {
"channelgroupid": {
"$ref": "Library.Id",
"required": true
},
"channeltype": {
"$ref": "PVR.Channel.Type",
"required": true
}
}
}
</syntaxhighlight>}}
==== PVR.Details.ChannelGroup.Extended ====
'''Extends:'''
* ''[[#PVR.Details.ChannelGroup|PVR.Details.ChannelGroup]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''array'' channels]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "PVR.Details.ChannelGroup",
"id": "PVR.Details.ChannelGroup.Extended",
"properties": {
"channels": {
"items": {
"$ref": "PVR.Details.Channel"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
</syntaxhighlight>}}
==== PVR.Details.Client ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' addonid]
* ''[[#Library.Id|Library.Id]]'' clientid
* [''boolean'' supportschannelgroups]
* [''boolean'' supportschannelscan]
* [''boolean'' supportsepg]
* [''boolean'' supportsradio]
* [''boolean'' supportsrecordings]
* [''boolean'' supportstimers]
* [''boolean'' supportstv]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "PVR.Details.Client",
"properties": {
"addonid": {
"default": "",
"type": "string"
},
"clientid": {
"$ref": "Library.Id",
"required": true
},
"supportschannelgroups": {
"default": false,
"type": "boolean"
},
"supportschannelscan": {
"default": false,
"type": "boolean"
},
"supportsepg": {
"default": false,
"type": "boolean"
},
"supportsradio": {
"default": false,
"type": "boolean"
},
"supportsrecordings": {
"default": false,
"type": "boolean"
},
"supportstimers": {
"default": false,
"type": "boolean"
},
"supportstv": {
"default": false,
"type": "boolean"
}
}
}
</syntaxhighlight>}}
==== PVR.Details.Recording ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Media.Artwork|Media.Artwork]]'' art]
* [''string'' channel]
* [''integer'' channeluid]
* [''[[#Library.Id|Library.Id]]'' clientid = -1]
* [''string'' directory]
* [''string'' endtime]
* [''integer'' epgeventid]
* [''integer'' episode]
* [''string'' file]
* [''string'' genre]
* [''string'' icon]
* [''boolean'' isdeleted]
* [''integer'' lifetime]
* [''integer'' playcount]
* [''string'' plot]
* [''string'' plotoutline]
* [''boolean'' radio]
* ''[[#Library.Id|Library.Id]]'' recordingid
* [''[[#Video.Resume|Video.Resume]]'' resume]
* [''integer'' runtime]
* [''integer'' season]
* [''string'' showtitle]
* [''string'' starttime]
* [''string'' streamurl]
* [''string'' title]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "PVR.Details.Recording",
"properties": {
"art": {
"$ref": "Media.Artwork"
},
"channel": {
"default": "",
"type": "string"
},
"channeluid": {
"default": 0,
"type": "integer"
},
"clientid": {
"$ref": "Library.Id",
"default": -1
},
"directory": {
"default": "",
"type": "string"
},
"endtime": {
"default": "",
"type": "string"
},
"epgeventid": {
"default": 0,
"type": "integer"
},
"episode": {
"default": 0,
"type": "integer"
},
"file": {
"default": "",
"type": "string"
},
"genre": {
"default": "",
"type": "string"
},
"icon": {
"default": "",
"type": "string"
},
"isdeleted": {
"default": false,
"type": "boolean"
},
"lifetime": {
"default": 0,
"type": "integer"
},
"playcount": {
"default": 0,
"type": "integer"
},
"plot": {
"default": "",
"type": "string"
},
"plotoutline": {
"default": "",
"type": "string"
},
"radio": {
"default": false,
"type": "boolean"
},
"recordingid": {
"$ref": "Library.Id",
"required": true
},
"resume": {
"$ref": "Video.Resume"
},
"runtime": {
"default": 0,
"type": "integer"
},
"season": {
"default": 0,
"type": "integer"
},
"showtitle": {
"default": "",
"type": "string"
},
"starttime": {
"default": "",
"type": "string"
},
"streamurl": {
"default": "",
"type": "string"
},
"title": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== PVR.Details.Timer ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Library.Id|Library.Id]]'' broadcastid = -1]
* [''[[#Library.Id|Library.Id]]'' channelid = -1]
* [''[[#Library.Id|Library.Id]]'' clientid = -1]
* [''string'' directory]
* [''boolean'' endanytime]
* [''integer'' endmargin]
* [''string'' endtime]
* [''string'' epgsearchstring]
* [''integer'' epguid]
* [''string'' file]
* [''string'' firstday]
* [''boolean'' fulltextepgsearch]
* [''boolean'' ismanual]
* [''boolean'' isradio]
* [''boolean'' isreadonly]
* [''boolean'' isreminder]
* [''boolean'' istimerrule]
* [''integer'' lifetime]
* [''integer'' maxrecordings]
* [''integer'' preventduplicateepisodes]
* [''integer'' priority]
* [''integer'' recordinggroup]
* [''integer'' runtime]
* [''boolean'' startanytime]
* [''integer'' startmargin]
* [''string'' starttime]
* [''[[#PVR.TimerState|PVR.TimerState]]'' state = unknown]
* [''string'' summary]
* ''[[#Library.Id|Library.Id]]'' timerid
* [''string'' title]
* [''array'' weekdays]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "PVR.Details.Timer",
"properties": {
"broadcastid": {
"$ref": "Library.Id",
"default": -1
},
"channelid": {
"$ref": "Library.Id",
"default": -1
},
"clientid": {
"$ref": "Library.Id",
"default": -1
},
"directory": {
"default": "",
"type": "string"
},
"endanytime": {
"default": false,
"type": "boolean"
},
"endmargin": {
"default": 0,
"type": "integer"
},
"endtime": {
"default": "",
"type": "string"
},
"epgsearchstring": {
"default": "",
"type": "string"
},
"epguid": {
"default": 0,
"type": "integer"
},
"file": {
"default": "",
"type": "string"
},
"firstday": {
"default": "",
"type": "string"
},
"fulltextepgsearch": {
"default": false,
"type": "boolean"
},
"ismanual": {
"default": false,
"type": "boolean"
},
"isradio": {
"default": false,
"type": "boolean"
},
"isreadonly": {
"default": false,
"type": "boolean"
},
"isreminder": {
"default": false,
"type": "boolean"
},
"istimerrule": {
"default": false,
"type": "boolean"
},
"lifetime": {
"default": 0,
"type": "integer"
},
"maxrecordings": {
"default": 0,
"type": "integer"
},
"preventduplicateepisodes": {
"default": 0,
"type": "integer"
},
"priority": {
"default": 0,
"type": "integer"
},
"recordinggroup": {
"default": 0,
"type": "integer"
},
"runtime": {
"default": 0,
"type": "integer"
},
"startanytime": {
"default": false,
"type": "boolean"
},
"startmargin": {
"default": 0,
"type": "integer"
},
"starttime": {
"default": "",
"type": "string"
},
"state": {
"$ref": "PVR.TimerState",
"default": "unknown"
},
"summary": {
"default": "",
"type": "string"
},
"timerid": {
"$ref": "Library.Id",
"required": true
},
"title": {
"default": "",
"type": "string"
},
"weekdays": {
"items": {
"$ref": "Global.Weekday"
},
"type": "array",
"uniqueItems": true
}
}
}
</syntaxhighlight>}}
==== PVR.Fields.Broadcast ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "PVR.Fields.Broadcast",
"items": {
"enums": [
"title",
"plot",
"plotoutline",
"starttime",
"endtime",
"runtime",
"progress",
"progresspercentage",
"genre",
"episodename",
"episodenum",
"episodepart",
"firstaired",
"hastimer",
"isactive",
"parentalrating",
"wasactive",
"thumbnail",
"rating",
"originaltitle",
"cast",
"director",
"writer",
"year",
"imdbnumber",
"hastimerrule",
"hasrecording",
"recording",
"isseries",
"isplayable",
"clientid",
"hasreminder"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== PVR.Fields.Channel ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "PVR.Fields.Channel",
"items": {
"enums": [
"thumbnail",
"channeltype",
"hidden",
"locked",
"channel",
"lastplayed",
"broadcastnow",
"broadcastnext",
"uniqueid",
"icon",
"channelnumber",
"subchannelnumber",
"isrecording",
"hasarchive",
"clientid"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== PVR.Fields.Client ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "PVR.Fields.Client",
"items": {
"enums": [
"addonid",
"supportstv",
"supportsradio",
"supportsepg",
"supportsrecordings",
"supportstimers",
"supportschannelgroups",
"supportschannelscan"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== PVR.Fields.Recording ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "PVR.Fields.Recording",
"items": {
"enums": [
"title",
"plot",
"plotoutline",
"genre",
"playcount",
"resume",
"channel",
"starttime",
"endtime",
"runtime",
"lifetime",
"icon",
"art",
"streamurl",
"file",
"directory",
"radio",
"isdeleted",
"epgeventid",
"channeluid",
"season",
"episode",
"showtitle",
"clientid"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== PVR.Fields.Timer ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "PVR.Fields.Timer",
"items": {
"enums": [
"title",
"summary",
"channelid",
"isradio",
"istimerrule",
"ismanual",
"starttime",
"endtime",
"runtime",
"lifetime",
"firstday",
"weekdays",
"priority",
"startmargin",
"endmargin",
"state",
"file",
"directory",
"preventduplicateepisodes",
"startanytime",
"endanytime",
"epgsearchstring",
"fulltextepgsearch",
"recordinggroup",
"maxrecordings",
"epguid",
"isreadonly",
"isreminder",
"clientid",
"broadcastid"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== PVR.Property.Name ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "available",
"enums": [
"available",
"recording",
"scanning"
],
"id": "PVR.Property.Name",
"type": "string"
}
</syntaxhighlight>}}
==== PVR.Property.Value ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''boolean'' available]
* [''boolean'' recording]
* [''boolean'' scanning]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "PVR.Property.Value",
"properties": {
"available": {
"default": false,
"type": "boolean"
},
"recording": {
"default": false,
"type": "boolean"
},
"scanning": {
"default": false,
"type": "boolean"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== PVR.TimerState ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "unknown",
"enums": [
"unknown",
"new",
"scheduled",
"recording",
"completed",
"aborted",
"cancelled",
"conflict_ok",
"conflict_notok",
"error",
"disabled"
],
"id": "PVR.TimerState",
"type": "string"
}
</syntaxhighlight>}}
=== Player ===
==== Player.Audio.Stream ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''integer'' bitrate
* ''integer'' channels
* ''string'' codec
* ''integer'' index
* ''boolean'' isdefault
* ''boolean'' isimpaired
* ''boolean'' isoriginal
* ''string'' language
* ''string'' name
* ''integer'' samplerate
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.Audio.Stream",
"properties": {
"bitrate": {
"required": true,
"type": "integer"
},
"channels": {
"required": true,
"type": "integer"
},
"codec": {
"required": true,
"type": "string"
},
"index": {
"minimum": 0,
"required": true,
"type": "integer"
},
"isdefault": {
"required": true,
"type": "boolean"
},
"isimpaired": {
"required": true,
"type": "boolean"
},
"isoriginal": {
"required": true,
"type": "boolean"
},
"language": {
"required": true,
"type": "string"
},
"name": {
"required": true,
"type": "string"
},
"samplerate": {
"required": true,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Player.CustomViewMode ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''mixed: string|[[#Optional.Boolean|Optional.Boolean]]'' nonlinearstretch]
* [''mixed: string|[[#Optional.Number|Optional.Number]]'' pixelratio]
* [''mixed: string|[[#Optional.Number|Optional.Number]]'' verticalshift]
* [''mixed: string|[[#Optional.Number|Optional.Number]]'' zoom]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.CustomViewMode",
"properties": {
"nonlinearstretch": {
"default": null,
"type": [
{
"enums": [
"increase",
"decrease"
],
"type": "string"
},
{
"$ref": "Optional.Boolean",
"description": "Flag to enable nonlinear stretch"
}
]
},
"pixelratio": {
"default": null,
"type": [
{
"enums": [
"increase",
"decrease"
],
"type": "string"
},
{
"$ref": "Optional.Number",
"description": "Pixel aspect ratio where 1.0 means square pixel"
}
]
},
"verticalshift": {
"default": null,
"type": [
{
"enums": [
"increase",
"decrease"
],
"type": "string"
},
{
"$ref": "Optional.Number",
"description": "Vertical shift 1.0 means shift to bottom"
}
]
},
"zoom": {
"default": null,
"type": [
{
"enums": [
"increase",
"decrease"
],
"type": "string"
},
{
"$ref": "Optional.Number",
"description": "Zoom where 1.0 means 100%"
}
]
}
},
"required": true,
"type": "object"
}
</syntaxhighlight>}}
==== Player.Id ====
'''Type:''' ''integer''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": -1,
"id": "Player.Id",
"maximum": 2,
"minimum": 0,
"type": "integer"
}
</syntaxhighlight>}}
==== Player.Notifications.Data ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Notifications.Item|Notifications.Item]]'' item
* ''[[#Player.Notifications.Player|Player.Notifications.Player]]'' player
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.Notifications.Data",
"properties": {
"item": {
"$ref": "Notifications.Item",
"required": true
},
"player": {
"$ref": "Player.Notifications.Player",
"required": true
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Player.Notifications.Player ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Player.Id|Player.Id]]'' playerid
* [''integer'' speed]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.Notifications.Player",
"properties": {
"playerid": {
"$ref": "Player.Id",
"required": true
},
"speed": {
"default": 0,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Player.Notifications.Player.Seek ====
'''Extends:'''
* ''[[#Player.Notifications.Player|Player.Notifications.Player]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Global.Time|Global.Time]]'' seekoffset]
* [''[[#Global.Time|Global.Time]]'' time]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Player.Notifications.Player",
"id": "Player.Notifications.Player.Seek",
"properties": {
"seekoffset": {
"$ref": "Global.Time",
"description": "A duration."
},
"time": {
"$ref": "Global.Time",
"description": "A duration."
}
}
}
</syntaxhighlight>}}
==== Player.Position.Percentage ====
'''Type:''' ''number''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": 0.0,
"id": "Player.Position.Percentage",
"maximum": 100.0,
"minimum": 0.0,
"type": "number"
}
</syntaxhighlight>}}
==== Player.Position.Time ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''integer'' hours]
* [''integer'' milliseconds]
* [''integer'' minutes]
* [''integer'' seconds]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"description": "A position in duration.",
"id": "Player.Position.Time",
"properties": {
"hours": {
"default": 0,
"minimum": 0,
"type": "integer"
},
"milliseconds": {
"default": 0,
"maximum": 999,
"minimum": 0,
"type": "integer"
},
"minutes": {
"default": 0,
"maximum": 59,
"minimum": 0,
"type": "integer"
},
"seconds": {
"default": 0,
"maximum": 59,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Player.Property.Name ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "type",
"enums": [
"type",
"partymode",
"speed",
"time",
"percentage",
"totaltime",
"playlistid",
"position",
"repeat",
"shuffled",
"canseek",
"canchangespeed",
"canmove",
"canzoom",
"canrotate",
"canshuffle",
"canrepeat",
"currentaudiostream",
"audiostreams",
"subtitleenabled",
"currentsubtitle",
"subtitles",
"live",
"currentvideostream",
"videostreams",
"cachepercentage"
],
"id": "Player.Property.Name",
"type": "string"
}
</syntaxhighlight>}}
==== Player.Property.Value ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''array'' audiostreams]
* [''[[#Player.Position.Percentage|Player.Position.Percentage]]'' cachepercentage]
* [''boolean'' canchangespeed]
* [''boolean'' canmove]
* [''boolean'' canrepeat]
* [''boolean'' canrotate]
* [''boolean'' canseek]
* [''boolean'' canshuffle]
* [''boolean'' canzoom]
* [''[[#Player.Audio.Stream|Player.Audio.Stream]]'' currentaudiostream]
* [''[[#Player.Subtitle|Player.Subtitle]]'' currentsubtitle]
* [''[[#Player.Video.Stream|Player.Video.Stream]]'' currentvideostream]
* [''boolean'' live]
* [''boolean'' partymode]
* [''[[#Player.Position.Percentage|Player.Position.Percentage]]'' percentage]
* [''[[#Playlist.Id|Playlist.Id]]'' playlistid = -1]
* [''[[#Playlist.Position|Playlist.Position]]'' position = -1]
* [''[[#Player.Repeat|Player.Repeat]]'' repeat = off]
* [''boolean'' shuffled]
* [''integer'' speed]
* [''boolean'' subtitleenabled]
* [''array'' subtitles]
* [''[[#Global.Time|Global.Time]]'' time]
* [''[[#Global.Time|Global.Time]]'' totaltime]
* [''[[#Player.Type|Player.Type]]'' type = video]
* [''array'' videostreams]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.Property.Value",
"properties": {
"audiostreams": {
"items": {
"$ref": "Player.Audio.Stream"
},
"type": "array"
},
"cachepercentage": {
"$ref": "Player.Position.Percentage",
"default": 0.0
},
"canchangespeed": {
"default": false,
"type": "boolean"
},
"canmove": {
"default": false,
"type": "boolean"
},
"canrepeat": {
"default": false,
"type": "boolean"
},
"canrotate": {
"default": false,
"type": "boolean"
},
"canseek": {
"default": false,
"type": "boolean"
},
"canshuffle": {
"default": false,
"type": "boolean"
},
"canzoom": {
"default": false,
"type": "boolean"
},
"currentaudiostream": {
"$ref": "Player.Audio.Stream"
},
"currentsubtitle": {
"$ref": "Player.Subtitle"
},
"currentvideostream": {
"$ref": "Player.Video.Stream"
},
"live": {
"default": false,
"type": "boolean"
},
"partymode": {
"default": false,
"type": "boolean"
},
"percentage": {
"$ref": "Player.Position.Percentage",
"default": 0.0
},
"playlistid": {
"$ref": "Playlist.Id",
"default": -1
},
"position": {
"$ref": "Playlist.Position",
"default": -1
},
"repeat": {
"$ref": "Player.Repeat",
"default": "off"
},
"shuffled": {
"default": false,
"type": "boolean"
},
"speed": {
"default": 0,
"type": "integer"
},
"subtitleenabled": {
"default": false,
"type": "boolean"
},
"subtitles": {
"items": {
"$ref": "Player.Subtitle"
},
"type": "array"
},
"time": {
"$ref": "Global.Time",
"description": "A duration."
},
"totaltime": {
"$ref": "Global.Time",
"description": "A duration."
},
"type": {
"$ref": "Player.Type",
"default": "video"
},
"videostreams": {
"items": {
"$ref": "Player.Video.Stream"
},
"type": "array"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Player.Repeat ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "off",
"enums": [
"off",
"one",
"all"
],
"id": "Player.Repeat",
"type": "string"
}
</syntaxhighlight>}}
==== Player.Speed ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''integer'' speed]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.Speed",
"properties": {
"speed": {
"default": 0,
"type": "integer"
}
},
"required": true,
"type": "object"
}
</syntaxhighlight>}}
==== Player.Subtitle ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''integer'' index
* ''boolean'' isdefault
* ''boolean'' isforced
* ''boolean'' isimpaired
* ''string'' language
* ''string'' name
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.Subtitle",
"properties": {
"index": {
"minimum": 0,
"required": true,
"type": "integer"
},
"isdefault": {
"required": true,
"type": "boolean"
},
"isforced": {
"required": true,
"type": "boolean"
},
"isimpaired": {
"required": true,
"type": "boolean"
},
"language": {
"required": true,
"type": "string"
},
"name": {
"required": true,
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Player.Type ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "video",
"enums": [
"video",
"audio",
"picture"
],
"id": "Player.Type",
"type": "string"
}
</syntaxhighlight>}}
==== Player.Video.Stream ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' codec
* ''integer'' height
* ''integer'' index
* ''string'' language
* ''string'' name
* ''integer'' width
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Player.Video.Stream",
"properties": {
"codec": {
"required": true,
"type": "string"
},
"height": {
"required": true,
"type": "integer"
},
"index": {
"minimum": 0,
"required": true,
"type": "integer"
},
"language": {
"required": true,
"type": "string"
},
"name": {
"required": true,
"type": "string"
},
"width": {
"required": true,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Player.ViewMode ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "normal",
"enums": [
"normal",
"zoom",
"stretch4x3",
"widezoom",
"stretch16x9",
"original",
"stretch16x9nonlin",
"zoom120width",
"zoom110width"
],
"id": "Player.ViewMode",
"type": "string"
}
</syntaxhighlight>}}
=== Playlist ===
==== Playlist.Id ====
'''Type:''' ''integer''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": -1,
"id": "Playlist.Id",
"maximum": 2,
"minimum": 0,
"type": "integer"
}
</syntaxhighlight>}}
==== Playlist.Item ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Playlist.Item",
"type": [
{
"additionalProperties": false,
"properties": {
"file": {
"description": "Path to a file (not a directory) to be added to the playlist",
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"directory": {
"required": true,
"type": "string"
},
"media": {
"$ref": "Files.Media",
"default": "files"
},
"recursive": {
"default": false,
"type": "boolean"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"movieid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"episodeid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"musicvideoid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"albumid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"songid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Identification of a genre from the AudioLibrary",
"required": true
}
},
"type": "object"
}
]
}
</syntaxhighlight>}}
==== Playlist.Position ====
'''Type:''' ''integer''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": -1,
"id": "Playlist.Position",
"minimum": 0,
"type": "integer"
}
</syntaxhighlight>}}
==== Playlist.Property.Name ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "type",
"enums": [
"type",
"size"
],
"id": "Playlist.Property.Name",
"type": "string"
}
</syntaxhighlight>}}
==== Playlist.Property.Value ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''integer'' size]
* [''[[#Playlist.Type|Playlist.Type]]'' type = unknown]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Playlist.Property.Value",
"properties": {
"size": {
"default": 0,
"minimum": 0,
"type": "integer"
},
"type": {
"$ref": "Playlist.Type",
"default": "unknown"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Playlist.Type ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "unknown",
"enums": [
"unknown",
"video",
"audio",
"picture",
"mixed"
],
"id": "Playlist.Type",
"type": "string"
}
</syntaxhighlight>}}
=== Profiles ===
==== Profiles.Details.Profile ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''integer'' lockmode]
* [''string'' thumbnail]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Details.Base",
"id": "Profiles.Details.Profile",
"properties": {
"lockmode": {
"default": 0,
"type": "integer"
},
"thumbnail": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Profiles.Fields.Profile ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Profiles.Fields.Profile",
"items": {
"enums": [
"thumbnail",
"lockmode"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Profiles.Password ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' encryption = md5]
* ''string'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Profiles.Password",
"properties": {
"encryption": {
"default": "md5",
"description": "Password Encryption",
"enums": [
"none",
"md5"
],
"type": "string"
},
"value": {
"description": "Password",
"required": true,
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
=== Setting ===
==== Setting.Details.Base ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' help]
* ''string'' id
* ''string'' label
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Setting.Details.Base",
"properties": {
"help": {
"default": "",
"type": "string"
},
"id": {
"minLength": 1,
"required": true,
"type": "string"
},
"label": {
"required": true,
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Setting.Details.Category ====
'''Extends:'''
* ''[[#Setting.Details.Base|Setting.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''array'' groups]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.Base",
"id": "Setting.Details.Category",
"properties": {
"groups": {
"items": {
"$ref": "Setting.Details.Group"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
}
}
</syntaxhighlight>}}
==== Setting.Details.Control ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Setting.Details.Control",
"type": [
{
"$ref": "Setting.Details.ControlCheckmark"
},
{
"$ref": "Setting.Details.ControlSpinner"
},
{
"$ref": "Setting.Details.ControlEdit"
},
{
"$ref": "Setting.Details.ControlButton"
},
{
"$ref": "Setting.Details.ControlList"
},
{
"$ref": "Setting.Details.ControlSlider"
},
{
"$ref": "Setting.Details.ControlRange"
},
{
"$ref": "Setting.Details.ControlLabel"
}
]
}
</syntaxhighlight>}}
==== Setting.Details.ControlBase ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' delayed
* ''string'' format
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Setting.Details.ControlBase",
"properties": {
"delayed": {
"required": true,
"type": "boolean"
},
"format": {
"required": true,
"type": "string"
},
"type": {
"required": true,
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Setting.Details.ControlButton ====
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlHeading",
"id": "Setting.Details.ControlButton",
"properties": {
"type": {
"enums": [
"button"
],
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.ControlCheckmark ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' format
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlBase",
"id": "Setting.Details.ControlCheckmark",
"properties": {
"format": {
"enums": [
"boolean"
],
"required": true,
"type": "string"
},
"type": {
"enums": [
"toggle"
],
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.ControlEdit ====
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' hidden
* ''string'' type
* ''boolean'' verifynewvalue
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlHeading",
"id": "Setting.Details.ControlEdit",
"properties": {
"hidden": {
"required": true,
"type": "boolean"
},
"type": {
"enums": [
"edit"
],
"required": true,
"type": "string"
},
"verifynewvalue": {
"required": true,
"type": "boolean"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.ControlHeading ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' heading]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlBase",
"id": "Setting.Details.ControlHeading",
"properties": {
"heading": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.ControlLabel ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' format
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlBase",
"id": "Setting.Details.ControlLabel",
"properties": {
"format": {
"enums": [
"string"
],
"required": true,
"type": "string"
},
"type": {
"enums": [
"label"
],
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.ControlList ====
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' multiselect
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlHeading",
"id": "Setting.Details.ControlList",
"properties": {
"multiselect": {
"required": true,
"type": "boolean"
},
"type": {
"enums": [
"list"
],
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.ControlRange ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' formatlabel
* ''string'' formatvalue
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlBase",
"id": "Setting.Details.ControlRange",
"properties": {
"formatlabel": {
"required": true,
"type": "string"
},
"formatvalue": {
"required": true,
"type": "string"
},
"type": {
"enums": [
"range"
],
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.ControlSlider ====
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' formatlabel
* ''boolean'' popup
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlHeading",
"id": "Setting.Details.ControlSlider",
"properties": {
"formatlabel": {
"required": true,
"type": "string"
},
"popup": {
"required": true,
"type": "boolean"
},
"type": {
"enums": [
"slider"
],
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.ControlSpinner ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' formatlabel]
* [''string'' minimumlabel]
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.ControlBase",
"id": "Setting.Details.ControlSpinner",
"properties": {
"formatlabel": {
"default": "",
"type": "string"
},
"minimumlabel": {
"default": "",
"type": "string"
},
"type": {
"enums": [
"spinner"
],
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.Group ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' id
* [''array'' settings]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"id": "Setting.Details.Group",
"properties": {
"id": {
"minLength": 1,
"required": true,
"type": "string"
},
"settings": {
"items": {
"$ref": "Setting.Details.Setting"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Setting.Details.Section ====
'''Extends:'''
* ''[[#Setting.Details.Base|Setting.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''array'' categories]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.Base",
"id": "Setting.Details.Section",
"properties": {
"categories": {
"items": {
"$ref": "Setting.Details.Category"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
}
}
</syntaxhighlight>}}
==== Setting.Details.Setting ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Setting.Details.Setting",
"type": [
{
"$ref": "Setting.Details.SettingBool"
},
{
"$ref": "Setting.Details.SettingInt"
},
{
"$ref": "Setting.Details.SettingNumber"
},
{
"$ref": "Setting.Details.SettingString"
},
{
"$ref": "Setting.Details.SettingAction"
},
{
"$ref": "Setting.Details.SettingList"
},
{
"$ref": "Setting.Details.SettingPath"
},
{
"$ref": "Setting.Details.SettingAddon"
},
{
"$ref": "Setting.Details.SettingDate"
},
{
"$ref": "Setting.Details.SettingTime"
}
]
}
</syntaxhighlight>}}
==== Setting.Details.SettingAction ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingBase",
"id": "Setting.Details.SettingAction",
"properties": {
"data": {
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingAddon ====
'''Extends:'''
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Addon.Types|Addon.Types]]'' addontype
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingString",
"id": "Setting.Details.SettingAddon",
"properties": {
"addontype": {
"$ref": "Addon.Types",
"required": true
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingBase ====
'''Extends:'''
* ''[[#Setting.Details.Base|Setting.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Setting.Details.Control|Setting.Details.Control]]'' control]
* ''boolean'' enabled
* ''[[#Setting.Level|Setting.Level]]'' level
* [''string'' parent]
* ''[[#Setting.Type|Setting.Type]]'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.Base",
"id": "Setting.Details.SettingBase",
"properties": {
"control": {
"$ref": "Setting.Details.Control"
},
"enabled": {
"required": true,
"type": "boolean"
},
"level": {
"$ref": "Setting.Level",
"required": true
},
"parent": {
"default": "",
"type": "string"
},
"type": {
"$ref": "Setting.Type",
"required": true
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingBool ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' default
* ''boolean'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingBase",
"id": "Setting.Details.SettingBool",
"properties": {
"default": {
"required": true,
"type": "boolean"
},
"value": {
"required": true,
"type": "boolean"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingDate ====
'''Extends:'''
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingString",
"id": "Setting.Details.SettingDate"
}
</syntaxhighlight>}}
==== Setting.Details.SettingInt ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''integer'' default
* [''integer'' maximum]
* [''integer'' minimum]
* [''array'' options]
* [''integer'' step]
* ''integer'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingBase",
"id": "Setting.Details.SettingInt",
"properties": {
"default": {
"required": true,
"type": "integer"
},
"maximum": {
"default": 0,
"type": "integer"
},
"minimum": {
"default": 0,
"type": "integer"
},
"options": {
"items": {
"properties": {
"label": {
"required": true,
"type": "string"
},
"value": {
"required": true,
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"step": {
"default": 0,
"type": "integer"
},
"value": {
"required": true,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingList ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Setting.Value.List|Setting.Value.List]]'' default
* ''[[#Setting.Details.Setting|Setting.Details.Setting]]'' definition
* ''string'' delimiter
* ''[[#Setting.Type|Setting.Type]]'' elementtype
* [''integer'' maximumitems]
* [''integer'' minimumitems]
* ''[[#Setting.Value.List|Setting.Value.List]]'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingBase",
"id": "Setting.Details.SettingList",
"properties": {
"default": {
"$ref": "Setting.Value.List",
"required": true
},
"definition": {
"$ref": "Setting.Details.Setting",
"required": true
},
"delimiter": {
"required": true,
"type": "string"
},
"elementtype": {
"$ref": "Setting.Type",
"required": true
},
"maximumitems": {
"default": 0,
"type": "integer"
},
"minimumitems": {
"default": 0,
"type": "integer"
},
"value": {
"$ref": "Setting.Value.List",
"required": true
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingNumber ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''number'' default
* ''number'' maximum
* ''number'' minimum
* ''number'' step
* ''number'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingBase",
"id": "Setting.Details.SettingNumber",
"properties": {
"default": {
"required": true,
"type": "number"
},
"maximum": {
"required": true,
"type": "number"
},
"minimum": {
"required": true,
"type": "number"
},
"step": {
"required": true,
"type": "number"
},
"value": {
"required": true,
"type": "number"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingPath ====
'''Extends:'''
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''array'' sources]
* ''boolean'' writable
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingString",
"id": "Setting.Details.SettingPath",
"properties": {
"sources": {
"items": {
"type": "string"
},
"type": "array"
},
"writable": {
"required": true,
"type": "boolean"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingString ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' allowempty
* ''string'' default
* [''array'' options]
* ''string'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Setting.Details.SettingBase",
"id": "Setting.Details.SettingString",
"properties": {
"allowempty": {
"required": true,
"type": "boolean"
},
"default": {
"required": true,
"type": "string"
},
"options": {
"items": {
"properties": {
"label": {
"required": true,
"type": "string"
},
"value": {
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"value": {
"required": true,
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Setting.Details.SettingTime ====
'''Extends:'''
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"extends": "Setting.Details.SettingString",
"id": "Setting.Details.SettingTime"
}
</syntaxhighlight>}}
==== Setting.Level ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "basic",
"enums": [
"basic",
"standard",
"advanced",
"expert"
],
"id": "Setting.Level",
"type": "string"
}
</syntaxhighlight>}}
==== Setting.Type ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "boolean",
"enums": [
"boolean",
"integer",
"number",
"string",
"action",
"list",
"path",
"addon",
"date",
"time"
],
"id": "Setting.Type",
"type": "string"
}
</syntaxhighlight>}}
==== Setting.Value ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": null,
"id": "Setting.Value",
"type": [
{
"type": "boolean"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
}
]
}
</syntaxhighlight>}}
==== Setting.Value.Extended ====
'''Type:''' ''mixed''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": null,
"id": "Setting.Value.Extended",
"type": [
{
"type": "boolean"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
},
{
"$ref": "Setting.Value.List"
}
]
}
</syntaxhighlight>}}
==== Setting.Value.List ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Setting.Value.List",
"items": {
"$ref": "Setting.Value"
},
"type": "array"
}
</syntaxhighlight>}}
=== System ===
==== System.Property.Name ====
'''Type:''' ''string''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"default": "canshutdown",
"enums": [
"canshutdown",
"cansuspend",
"canhibernate",
"canreboot"
],
"id": "System.Property.Name",
"type": "string"
}
</syntaxhighlight>}}
==== System.Property.Value ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''boolean'' canhibernate]
* [''boolean'' canreboot]
* [''boolean'' canshutdown]
* [''boolean'' cansuspend]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "System.Property.Value",
"properties": {
"canhibernate": {
"default": false,
"type": "boolean"
},
"canreboot": {
"default": false,
"type": "boolean"
},
"canshutdown": {
"default": false,
"type": "boolean"
},
"cansuspend": {
"default": false,
"type": "boolean"
}
},
"type": "object"
}
</syntaxhighlight>}}
=== Textures ===
==== Textures.Details.Size ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''integer'' height]
* [''string'' lastused]
* [''integer'' size]
* [''integer'' usecount]
* [''integer'' width]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Textures.Details.Size",
"properties": {
"height": {
"default": 0,
"description": "Height of texture",
"type": "integer"
},
"lastused": {
"default": "",
"description": "Date of last use",
"type": "string"
},
"size": {
"default": 0,
"description": "Size of the texture (1 == largest)",
"type": "integer"
},
"usecount": {
"default": 0,
"description": "Number of uses",
"type": "integer"
},
"width": {
"default": 0,
"description": "Width of texture",
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Textures.Details.Texture ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' cachedurl]
* [''string'' imagehash]
* [''string'' lasthashcheck]
* [''array'' sizes]
* [''[[#Library.Id|Library.Id]]'' textureid = -1]
* [''string'' url]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Textures.Details.Texture",
"properties": {
"cachedurl": {
"default": "",
"description": "Cached URL on disk",
"type": "string"
},
"imagehash": {
"default": "",
"description": "Hash of image",
"type": "string"
},
"lasthashcheck": {
"default": "",
"description": "Last time source was checked for changes",
"type": "string"
},
"sizes": {
"items": {
"$ref": "Textures.Details.Size"
},
"type": "array"
},
"textureid": {
"$ref": "Library.Id",
"default": -1
},
"url": {
"default": "",
"description": "Original source URL",
"type": "string"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Textures.Fields.Texture ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Textures.Fields.Texture",
"items": {
"enums": [
"url",
"cachedurl",
"lasthashcheck",
"imagehash",
"sizes"
],
"type": "string"
}
}
</syntaxhighlight>}}
=== Video ===
==== Video.Cast ====
'''Type:''' ''array''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Video.Cast",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"required": true,
"type": "string"
},
"order": {
"required": true,
"type": "integer"
},
"role": {
"required": true,
"type": "string"
},
"thumbnail": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
</syntaxhighlight>}}
==== Video.Details.Base ====
'''Extends:'''
* ''[[#Media.Details.Base|Media.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Media.Artwork|Media.Artwork]]'' art]
* [''integer'' playcount]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Media.Details.Base",
"id": "Video.Details.Base",
"properties": {
"art": {
"$ref": "Media.Artwork"
},
"playcount": {
"default": 0,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== Video.Details.Episode ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Video.Cast|Video.Cast]]'' cast]
* [''integer'' episode]
* ''[[#Library.Id|Library.Id]]'' episodeid
* [''string'' firstaired]
* [''string'' originaltitle]
* [''string'' productioncode]
* [''number'' rating]
* [''any'' ratings]
* [''integer'' season]
* [''[[#Library.Id|Library.Id]]'' seasonid = -1]
* [''string'' showtitle]
* [''integer'' specialsortepisode]
* [''integer'' specialsortseason]
* [''[[#Library.Id|Library.Id]]'' tvshowid = -1]
* [''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid]
* [''integer'' userrating]
* [''string'' votes]
* [''[[#Array.String|Array.String]]'' writer]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.File",
"id": "Video.Details.Episode",
"properties": {
"cast": {
"$ref": "Video.Cast"
},
"episode": {
"default": 0,
"type": "integer"
},
"episodeid": {
"$ref": "Library.Id",
"required": true
},
"firstaired": {
"default": "",
"type": "string"
},
"originaltitle": {
"default": "",
"type": "string"
},
"productioncode": {
"default": "",
"type": "string"
},
"rating": {
"default": 0.0,
"type": "number"
},
"ratings": {
"default": null,
"type": "any"
},
"season": {
"default": 0,
"type": "integer"
},
"seasonid": {
"$ref": "Library.Id",
"default": -1
},
"showtitle": {
"default": "",
"type": "string"
},
"specialsortepisode": {
"default": 0,
"type": "integer"
},
"specialsortseason": {
"default": 0,
"type": "integer"
},
"tvshowid": {
"$ref": "Library.Id",
"default": -1
},
"uniqueid": {
"$ref": "Media.UniqueID"
},
"userrating": {
"default": 0,
"type": "integer"
},
"votes": {
"default": "",
"type": "string"
},
"writer": {
"$ref": "Array.String"
}
}
}
</syntaxhighlight>}}
==== Video.Details.File ====
'''Extends:'''
* ''[[#Video.Details.Item|Video.Details.Item]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Array.String|Array.String]]'' director]
* [''[[#Video.Resume|Video.Resume]]'' resume]
* [''integer'' runtime]
* [''[[#Video.Streams|Video.Streams]]'' streamdetails]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.Item",
"id": "Video.Details.File",
"properties": {
"director": {
"$ref": "Array.String"
},
"resume": {
"$ref": "Video.Resume"
},
"runtime": {
"default": 0,
"description": "Runtime in seconds",
"type": "integer"
},
"streamdetails": {
"$ref": "Video.Streams"
}
}
}
</syntaxhighlight>}}
==== Video.Details.Item ====
'''Extends:'''
* ''[[#Video.Details.Media|Video.Details.Media]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' dateadded]
* [''string'' file]
* [''string'' lastplayed]
* [''string'' plot]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.Media",
"id": "Video.Details.Item",
"properties": {
"dateadded": {
"default": "",
"type": "string"
},
"file": {
"default": "",
"type": "string"
},
"lastplayed": {
"default": "",
"type": "string"
},
"plot": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Video.Details.Media ====
'''Extends:'''
* ''[[#Video.Details.Base|Video.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' title]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.Base",
"id": "Video.Details.Media",
"properties": {
"title": {
"default": "",
"type": "string"
}
}
}
</syntaxhighlight>}}
==== Video.Details.Movie ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Video.Cast|Video.Cast]]'' cast]
* [''[[#Array.String|Array.String]]'' country]
* [''[[#Array.String|Array.String]]'' genre]
* [''string'' imdbnumber]
* ''[[#Library.Id|Library.Id]]'' movieid
* [''string'' mpaa]
* [''string'' originaltitle]
* [''string'' plotoutline]
* [''string'' premiered]
* [''number'' rating]
* [''any'' ratings]
* [''string'' set]
* [''[[#Library.Id|Library.Id]]'' setid = -1]
* [''[[#Array.String|Array.String]]'' showlink]
* [''string'' sorttitle]
* [''[[#Array.String|Array.String]]'' studio]
* [''[[#Array.String|Array.String]]'' tag]
* [''string'' tagline]
* [''integer'' top250]
* [''string'' trailer]
* [''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid]
* [''integer'' userrating]
* [''string'' votes]
* [''[[#Array.String|Array.String]]'' writer]
* [''integer'' year]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.File",
"id": "Video.Details.Movie",
"properties": {
"cast": {
"$ref": "Video.Cast"
},
"country": {
"$ref": "Array.String"
},
"genre": {
"$ref": "Array.String"
},
"imdbnumber": {
"default": "",
"type": "string"
},
"movieid": {
"$ref": "Library.Id",
"required": true
},
"mpaa": {
"default": "",
"type": "string"
},
"originaltitle": {
"default": "",
"type": "string"
},
"plotoutline": {
"default": "",
"type": "string"
},
"premiered": {
"default": "",
"type": "string"
},
"rating": {
"default": 0.0,
"type": "number"
},
"ratings": {
"default": null,
"type": "any"
},
"set": {
"default": "",
"type": "string"
},
"setid": {
"$ref": "Library.Id",
"default": -1
},
"showlink": {
"$ref": "Array.String"
},
"sorttitle": {
"default": "",
"type": "string"
},
"studio": {
"$ref": "Array.String"
},
"tag": {
"$ref": "Array.String"
},
"tagline": {
"default": "",
"type": "string"
},
"top250": {
"default": 0,
"type": "integer"
},
"trailer": {
"default": "",
"type": "string"
},
"uniqueid": {
"$ref": "Media.UniqueID"
},
"userrating": {
"default": 0,
"type": "integer"
},
"votes": {
"default": "",
"type": "string"
},
"writer": {
"$ref": "Array.String"
},
"year": {
"default": 0,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== Video.Details.MovieSet ====
'''Extends:'''
* ''[[#Video.Details.Media|Video.Details.Media]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' plot]
* ''[[#Library.Id|Library.Id]]'' setid
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.Media",
"id": "Video.Details.MovieSet",
"properties": {
"plot": {
"default": "",
"type": "string"
},
"setid": {
"$ref": "Library.Id",
"required": true
}
}
}
</syntaxhighlight>}}
==== Video.Details.MovieSet.Extended ====
'''Extends:'''
* ''[[#Video.Details.MovieSet|Video.Details.MovieSet]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [''array'' movies]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.MovieSet",
"id": "Video.Details.MovieSet.Extended",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"movies": {
"items": {
"$ref": "Video.Details.Movie"
},
"type": "array"
}
}
}
</syntaxhighlight>}}
==== Video.Details.MusicVideo ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''string'' album]
* [''[[#Array.String|Array.String]]'' artist]
* [''[[#Array.String|Array.String]]'' genre]
* ''[[#Library.Id|Library.Id]]'' musicvideoid
* [''string'' premiered]
* [''number'' rating]
* [''[[#Array.String|Array.String]]'' studio]
* [''[[#Array.String|Array.String]]'' tag]
* [''integer'' track]
* [''integer'' userrating]
* [''integer'' year]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.File",
"id": "Video.Details.MusicVideo",
"properties": {
"album": {
"default": "",
"type": "string"
},
"artist": {
"$ref": "Array.String"
},
"genre": {
"$ref": "Array.String"
},
"musicvideoid": {
"$ref": "Library.Id",
"required": true
},
"premiered": {
"default": "",
"type": "string"
},
"rating": {
"default": 0.0,
"type": "number"
},
"studio": {
"$ref": "Array.String"
},
"tag": {
"$ref": "Array.String"
},
"track": {
"default": 0,
"type": "integer"
},
"userrating": {
"default": 0,
"type": "integer"
},
"year": {
"default": 0,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== Video.Details.Season ====
'''Extends:'''
* ''[[#Video.Details.Base|Video.Details.Base]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''integer'' episode]
* ''integer'' season
* ''[[#Library.Id|Library.Id]]'' seasonid
* [''string'' showtitle]
* [''string'' title]
* [''[[#Library.Id|Library.Id]]'' tvshowid = -1]
* [''integer'' userrating]
* [''integer'' watchedepisodes]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.Base",
"id": "Video.Details.Season",
"properties": {
"episode": {
"default": 0,
"type": "integer"
},
"season": {
"required": true,
"type": "integer"
},
"seasonid": {
"$ref": "Library.Id",
"required": true
},
"showtitle": {
"default": "",
"type": "string"
},
"title": {
"default": "",
"type": "string"
},
"tvshowid": {
"$ref": "Library.Id",
"default": -1
},
"userrating": {
"default": 0,
"type": "integer"
},
"watchedepisodes": {
"default": 0,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== Video.Details.TVShow ====
'''Extends:'''
* ''[[#Video.Details.Item|Video.Details.Item]]''
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''[[#Video.Cast|Video.Cast]]'' cast]
* [''integer'' episode]
* [''string'' episodeguide]
* [''[[#Array.String|Array.String]]'' genre]
* [''string'' imdbnumber]
* [''string'' mpaa]
* [''string'' originaltitle]
* [''string'' premiered]
* [''number'' rating]
* [''any'' ratings]
* [''integer'' runtime]
* [''integer'' season]
* [''string'' sorttitle]
* [''string'' status]
* [''[[#Array.String|Array.String]]'' studio]
* [''[[#Array.String|Array.String]]'' tag]
* ''[[#Library.Id|Library.Id]]'' tvshowid
* [''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid]
* [''integer'' userrating]
* [''string'' votes]
* [''integer'' watchedepisodes]
* [''integer'' year]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Video.Details.Item",
"id": "Video.Details.TVShow",
"properties": {
"cast": {
"$ref": "Video.Cast"
},
"episode": {
"default": 0,
"type": "integer"
},
"episodeguide": {
"default": "",
"type": "string"
},
"genre": {
"$ref": "Array.String"
},
"imdbnumber": {
"default": "",
"type": "string"
},
"mpaa": {
"default": "",
"type": "string"
},
"originaltitle": {
"default": "",
"type": "string"
},
"premiered": {
"default": "",
"type": "string"
},
"rating": {
"default": 0.0,
"type": "number"
},
"ratings": {
"default": null,
"type": "any"
},
"runtime": {
"default": 0,
"description": "Runtime in seconds",
"type": "integer"
},
"season": {
"default": 0,
"type": "integer"
},
"sorttitle": {
"default": "",
"type": "string"
},
"status": {
"default": "",
"description": "Returns 'returning series', 'in production', 'planned', 'cancelled' or 'ended'",
"type": "string"
},
"studio": {
"$ref": "Array.String"
},
"tag": {
"$ref": "Array.String"
},
"tvshowid": {
"$ref": "Library.Id",
"required": true
},
"uniqueid": {
"$ref": "Media.UniqueID"
},
"userrating": {
"default": 0,
"type": "integer"
},
"votes": {
"default": "",
"type": "string"
},
"watchedepisodes": {
"default": 0,
"type": "integer"
},
"year": {
"default": 0,
"type": "integer"
}
}
}
</syntaxhighlight>}}
==== Video.Fields.Episode ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Video.Fields.Episode",
"items": {
"description": "Requesting the cast, ratings, streamdetails, uniqueid and/or tag field will result in increased response times",
"enums": [
"title",
"plot",
"votes",
"rating",
"writer",
"firstaired",
"playcount",
"runtime",
"director",
"productioncode",
"season",
"episode",
"originaltitle",
"showtitle",
"cast",
"streamdetails",
"lastplayed",
"fanart",
"thumbnail",
"file",
"resume",
"tvshowid",
"dateadded",
"uniqueid",
"art",
"specialsortseason",
"specialsortepisode",
"userrating",
"seasonid",
"ratings"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Video.Fields.Movie ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Video.Fields.Movie",
"items": {
"description": "Requesting the cast, ratings, showlink, streamdetails, uniqueid and/or tag field will result in increased response times",
"enums": [
"title",
"genre",
"year",
"rating",
"director",
"trailer",
"tagline",
"plot",
"plotoutline",
"originaltitle",
"lastplayed",
"playcount",
"writer",
"studio",
"mpaa",
"cast",
"country",
"imdbnumber",
"runtime",
"set",
"showlink",
"streamdetails",
"top250",
"votes",
"fanart",
"thumbnail",
"file",
"sorttitle",
"resume",
"setid",
"dateadded",
"tag",
"art",
"userrating",
"ratings",
"premiered",
"uniqueid"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Video.Fields.MovieSet ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Video.Fields.MovieSet",
"items": {
"enums": [
"title",
"playcount",
"fanart",
"thumbnail",
"art",
"plot"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Video.Fields.MusicVideo ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Video.Fields.MusicVideo",
"items": {
"description": "Requesting the streamdetails and/or tag field will result in increased response times",
"enums": [
"title",
"playcount",
"runtime",
"director",
"studio",
"year",
"plot",
"album",
"artist",
"genre",
"track",
"streamdetails",
"lastplayed",
"fanart",
"thumbnail",
"file",
"resume",
"dateadded",
"tag",
"art",
"rating",
"userrating",
"premiered"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Video.Fields.Season ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Video.Fields.Season",
"items": {
"enums": [
"season",
"showtitle",
"playcount",
"episode",
"fanart",
"thumbnail",
"tvshowid",
"watchedepisodes",
"art",
"userrating",
"title"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Video.Fields.TVShow ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"extends": "Item.Fields.Base",
"id": "Video.Fields.TVShow",
"items": {
"description": "Requesting the cast, ratings, uniqueid and/or tag field will result in increased response times",
"enums": [
"title",
"genre",
"year",
"rating",
"plot",
"studio",
"mpaa",
"cast",
"playcount",
"episode",
"imdbnumber",
"premiered",
"votes",
"lastplayed",
"fanart",
"thumbnail",
"file",
"originaltitle",
"sorttitle",
"episodeguide",
"season",
"watchedepisodes",
"dateadded",
"tag",
"art",
"userrating",
"ratings",
"runtime",
"uniqueid"
],
"type": "string"
}
}
</syntaxhighlight>}}
==== Video.Rating ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''boolean'' default]
* ''number'' rating
* [''integer'' votes]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"id": "Video.Rating",
"properties": {
"default": {
"default": false,
"type": "boolean"
},
"rating": {
"required": true,
"type": "number"
},
"votes": {
"default": 0,
"type": "integer"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Video.Ratings ====
'''Type:''' ''object''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": {
"$ref": "Video.Rating"
},
"id": "Video.Ratings",
"type": "object"
}
</syntaxhighlight>}}
==== Video.Ratings.Set ====
'''Type:''' ''object''
<br />
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": {
"default": null,
"type": [
{
"type": "null"
},
{
"$ref": "Video.Rating"
}
]
},
"id": "Video.Ratings.Set",
"type": "object"
}
</syntaxhighlight>}}
==== Video.Resume ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''number'' position]
* [''number'' total]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"id": "Video.Resume",
"properties": {
"position": {
"default": 0.0,
"minimum": 0.0,
"type": "number"
},
"total": {
"default": 0.0,
"minimum": 0.0,
"type": "number"
}
},
"type": "object"
}
</syntaxhighlight>}}
==== Video.Streams ====
'''Type:''' ''object''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [''array'' audio]
* [''array'' subtitle]
* [''array'' video]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"additionalProperties": false,
"id": "Video.Streams",
"properties": {
"audio": {
"items": {
"additionalProperties": false,
"properties": {
"channels": {
"default": 0,
"type": "integer"
},
"codec": {
"default": "",
"type": "string"
},
"language": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"subtitle": {
"items": {
"additionalProperties": false,
"properties": {
"language": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"video": {
"items": {
"additionalProperties": false,
"properties": {
"aspect": {
"default": 0.0,
"type": "number"
},
"codec": {
"default": "",
"type": "string"
},
"duration": {
"default": 0,
"type": "integer"
},
"height": {
"default": 0,
"type": "integer"
},
"width": {
"default": 0,
"type": "integer"
}
},
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"type": "object"
}
</syntaxhighlight>}}
== Notifications ==
=== Application ===
==== Application.OnVolumeChanged ====
The volume of the application has changed.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data:
#* ''boolean'' muted
#* ''integer'' volume
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The volume of the application has changed.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"muted": {
"required": true,
"type": "boolean"
},
"volume": {
"maximum": 100,
"minimum": 0,
"required": true,
"type": "integer"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
=== AudioLibrary ===
==== AudioLibrary.OnCleanFinished ====
The audio library has been cleaned.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The audio library has been cleaned.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== AudioLibrary.OnCleanStarted ====
An audio library clean operation has started.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "An audio library clean operation has started.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== AudioLibrary.OnExport ====
An audio library export has finished.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# [''object'' data]:
#* [''integer'' failcount = 0]
#* [''string'' file = ""]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "An audio library export has finished.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"failcount": {
"default": 0,
"minimum": 0,
"required": false,
"type": "integer"
},
"file": {
"default": "",
"required": false,
"type": "string"
}
},
"required": false,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== AudioLibrary.OnRemove ====
An audio item has been removed.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data:
#* ''[[#Library.Id|Library.Id]]'' id
#* ''[[#Optional.Boolean|Optional.Boolean]]'' transaction
#* ''[[#Notifications.Library.Audio.Type|Notifications.Library.Audio.Type]]'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "An audio item has been removed.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"id": {
"$ref": "Library.Id",
"required": true
},
"transaction": {
"$ref": "Optional.Boolean",
"description": "True if the removal is being performed within a transaction."
},
"type": {
"$ref": "Notifications.Library.Audio.Type",
"required": true
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== AudioLibrary.OnScanFinished ====
Scanning the audio library has been finished.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Scanning the audio library has been finished.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== AudioLibrary.OnScanStarted ====
An audio library scan has started.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "An audio library scan has started.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== AudioLibrary.OnUpdate ====
An audio item has been updated.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data:
#* ''[[#Optional.Boolean|Optional.Boolean]]'' added
#* ''[[#Library.Id|Library.Id]]'' id
#* ''[[#Optional.Boolean|Optional.Boolean]]'' transaction
#* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "An audio item has been updated.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"added": {
"$ref": "Optional.Boolean",
"description": "True if the update is for a newly added item."
},
"id": {
"$ref": "Library.Id",
"required": true
},
"transaction": {
"$ref": "Optional.Boolean",
"description": "True if the update is being performed within a transaction."
},
"type": {
"enum": [
"song"
],
"id": "Notifications.Library.Audio.Type",
"required": true,
"type": "string"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
=== GUI ===
==== GUI.OnDPMSActivated ====
Energy saving/DPMS has been activated.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Energy saving/DPMS has been activated.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== GUI.OnDPMSDeactivated ====
Energy saving/DPMS has been deactivated.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Energy saving/DPMS has been deactivated.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== GUI.OnScreensaverActivated ====
The screensaver has been activated.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The screensaver has been activated.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== GUI.OnScreensaverDeactivated ====
The screensaver has been deactivated.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data:
#* ''boolean'' shuttingdown
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The screensaver has been deactivated.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"shuttingdown": {
"required": true,
"type": "boolean"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
=== Input ===
==== Input.OnInputFinished ====
The user has provided the requested input.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The user has provided the requested input.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== Input.OnInputRequested ====
The user is requested to provide some information.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data:
#* ''string'' title
#* ''string'' type
#* ''string'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The user is requested to provide some information.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"title": {
"type": "string"
},
"type": {
"enum": [
"keyboard",
"time",
"date",
"ip",
"password",
"numericpassword",
"number",
"seconds"
],
"required": true,
"type": "string"
},
"value": {
"required": true,
"type": "string"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
=== Player ===
==== Player.OnAVChange ====
Audio- or videostream has changed. If there is no ID available extra information will be provided.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''[[#Player.Notifications.Data|Player.Notifications.Data]]'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Audio- or videostream has changed. If there is no ID available extra information will be provided.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== Player.OnAVStart ====
Playback of a media item has been started and first frame is available. If there is no ID available extra information will be provided.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''[[#Player.Notifications.Data|Player.Notifications.Data]]'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Playback of a media item has been started and first frame is available. If there is no ID available extra information will be provided.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== Player.OnPause ====
Playback of a media item has been paused. If there is no ID available extra information will be provided.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''[[#Player.Notifications.Data|Player.Notifications.Data]]'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Playback of a media item has been paused. If there is no ID available extra information will be provided.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== Player.OnPlay ====
Playback of a media item has been started or the playback speed has changed. If there is no ID available extra information will be provided.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''[[#Player.Notifications.Data|Player.Notifications.Data]]'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Playback of a media item has been started or the playback speed has changed. If there is no ID available extra information will be provided.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== Player.OnPropertyChanged ====
A property of the playing items has changed.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data:
#* ''[[#Player.Notifications.Player|Player.Notifications.Player]]'' player
#* ''[[#Player.Property.Value|Player.Property.Value]]'' property
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A property of the playing items has changed.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"player": {
"$ref": "Player.Notifications.Player",
"required": true
},
"property": {
"$ref": "Player.Property.Value"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== Player.OnResume ====
Playback of a media item has been resumed. If there is no ID available extra information will be provided.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''[[#Player.Notifications.Data|Player.Notifications.Data]]'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Playback of a media item has been resumed. If there is no ID available extra information will be provided.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== Player.OnSeek ====
The playback position has been changed. If there is no ID available extra information will be provided.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data:
#* ''[[#Notifications.Item|Notifications.Item]]'' item
#* ''[[#Player.Notifications.Player.Seek|Player.Notifications.Player.Seek]]'' player
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The playback position has been changed. If there is no ID available extra information will be provided.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"item": {
"$ref": "Notifications.Item"
},
"player": {
"$ref": "Player.Notifications.Player.Seek",
"required": true
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== Player.OnSpeedChanged ====
Speed of the playback of a media item has been changed. If there is no ID available extra information will be provided.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''[[#Player.Notifications.Data|Player.Notifications.Data]]'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Speed of the playback of a media item has been changed. If there is no ID available extra information will be provided.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== Player.OnStop ====
Playback of a media item has been stopped. If there is no ID available extra information will be provided.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data:
#* ''boolean'' end
#* ''[[#Notifications.Item|Notifications.Item]]'' item
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Playback of a media item has been stopped. If there is no ID available extra information will be provided.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"end": {
"description": "Whether the player has reached the end of the playable item(s) or not",
"required": true,
"type": "boolean"
},
"item": {
"$ref": "Notifications.Item"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
=== Playlist ===
==== Playlist.OnAdd ====
A playlist item has been added.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data:
#* ''[[#Notifications.Item|Notifications.Item]]'' item
#* ''[[#Playlist.Id|Playlist.Id]]'' playlistid
#* ''[[#Playlist.Position|Playlist.Position]]'' position
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A playlist item has been added.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"item": {
"$ref": "Notifications.Item"
},
"playlistid": {
"$ref": "Playlist.Id",
"required": true
},
"position": {
"$ref": "Playlist.Position"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== Playlist.OnClear ====
A playlist item has been cleared.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data:
#* ''[[#Playlist.Id|Playlist.Id]]'' playlistid
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A playlist item has been cleared.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"playlistid": {
"$ref": "Playlist.Id",
"required": true
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== Playlist.OnRemove ====
A playlist item has been removed.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data:
#* ''[[#Playlist.Id|Playlist.Id]]'' playlistid
#* ''[[#Playlist.Position|Playlist.Position]]'' position
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A playlist item has been removed.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"playlistid": {
"$ref": "Playlist.Id",
"required": true
},
"position": {
"$ref": "Playlist.Position"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
=== System ===
==== System.OnLowBattery ====
The system is on low battery.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The system is on low battery.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== System.OnQuit ====
Kodi will be closed.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data:
#* ''integer'' exitcode
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Kodi will be closed.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"exitcode": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== System.OnRestart ====
The system will be restarted.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The system will be restarted.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== System.OnSleep ====
The system will be suspended.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The system will be suspended.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== System.OnWake ====
The system woke up from suspension.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The system woke up from suspension.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
=== VideoLibrary ===
==== VideoLibrary.OnCleanFinished ====
The video library has been cleaned.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The video library has been cleaned.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== VideoLibrary.OnCleanStarted ====
A video library clean operation has started.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A video library clean operation has started.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== VideoLibrary.OnExport ====
A video library export has finished.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# [''object'' data]:
#* [''integer'' failcount = 0]
#* [''string'' file = ""]
#* [''string'' root = ""]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A video library export has finished.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"failcount": {
"default": 0,
"minimum": 0,
"required": false,
"type": "integer"
},
"file": {
"default": "",
"required": false,
"type": "string"
},
"root": {
"default": "",
"required": false,
"type": "string"
}
},
"required": false,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== VideoLibrary.OnRefresh ====
The video library has been refreshed and a home screen reload might be necessary.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "The video library has been refreshed and a home screen reload might be necessary.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== VideoLibrary.OnRemove ====
A video item has been removed.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data:
#* ''[[#Library.Id|Library.Id]]'' id
#* ''[[#Optional.Boolean|Optional.Boolean]]'' transaction
#* ''[[#Notifications.Library.Video.Type|Notifications.Library.Video.Type]]'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A video item has been removed.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"id": {
"$ref": "Library.Id",
"required": true
},
"transaction": {
"$ref": "Optional.Boolean",
"description": "True if the removal is being performed within a transaction."
},
"type": {
"$ref": "Notifications.Library.Video.Type",
"required": true
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== VideoLibrary.OnScanFinished ====
Scanning the video library has been finished.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "Scanning the video library has been finished.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== VideoLibrary.OnScanStarted ====
A video library scan has started.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A video library scan has started.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"required": true,
"type": "null"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}
==== VideoLibrary.OnUpdate ====
A video item has been updated.<br />
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data:
#* ''[[#Optional.Boolean|Optional.Boolean]]'' added
#* ''[[#Library.Id|Library.Id]]'' id
#* ''integer'' playcount = -1
#* ''[[#Optional.Boolean|Optional.Boolean]]'' transaction
#* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="json">
{
"description": "A video item has been updated.",
"params": [
{
"name": "sender",
"required": true,
"type": "string"
},
{
"name": "data",
"properties": {
"added": {
"$ref": "Optional.Boolean",
"description": "True if the update is for a newly added item."
},
"id": {
"$ref": "Library.Id",
"required": true
},
"playcount": {
"default": -1,
"minimum": 0,
"type": "integer"
},
"transaction": {
"$ref": "Optional.Boolean",
"description": "True if the update is being performed within a transaction."
},
"type": {
"enum": [
"movie",
"tvshow",
"episode",
"musicvideo"
],
"id": "Notifications.Library.Video.Type",
"required": true,
"type": "string"
}
},
"required": true,
"type": "object"
}
],
"returns": null,
"type": "notification"
}
</syntaxhighlight>}}

== External links ==
* [http://jsonrpc.org/spec.html JSON-RPC 2.0 specification]
* [http://tools.ietf.org/html/draft-zyp-json-schema-03 A JSON Media Type for Describing the Structure and Meaning of JSON Documents (Draft 03)]

{{updated|21}}
[[Category:JSON-RPC]]