 |
Kodi Documentation 18.0
Kodi is an open source media player and entertainment hub.
|
|
Kodi Documentation 18.0
Kodi is an open source media player and entertainment hub.
|
Selectable window list item. More...
Modules | |
| Overlay icon types | |
| Overlay icon types used on list item. | |
Classes | |
| class | XBMCAddon::xbmcgui::ListItem |
Selectable window list item.
The list item control is used for creating item lists in Kodi
Class: ListItem([label, label2, iconImage, thumbnailImage, path]) | label | [opt] string |
| label2 | [opt] string |
| iconImage | Deprecated. Use setArt |
| thumbnailImage | Deprecated. Use setArt |
| path | [opt] string |
Example:
| void XBMCAddon::xbmcgui::ListItem::addAvailableArtwork | ( | ... | ) |
Add an image to available artworks (needed for video scrapers)
| url | string (image path url) |
| art_type | string (image type) |
| referrer | [opt] string (referrer url) |
| cache | [opt] string (filename in cache) |
| post | [opt] bool (use post to retrieve the image, default false) |
| isgz | [opt] bool (use gzip to retrieve the image, default false) |
| season | [opt] integer (number of season in case of season thumb) |
Example:
| void XBMCAddon::xbmcgui::ListItem::addContextMenuItems | ( | ... | ) |
Adds item(s) to the context menu for media lists.
| items | list - [(label, action),*] A list of tuples consisting of label and action pairs.
|
Example:
| void XBMCAddon::xbmcgui::ListItem::addSeason | ( | ... | ) |
Add a season with name to a listitem. It needs at least the season number
| number | int - the number of the season. |
| name | string - the name of the season. Default "". |
Example:
| void XBMCAddon::xbmcgui::ListItem::addStreamInfo | ( | ... | ) |
Add a stream with details.
| type | string - type of stream(video/audio/subtitle). |
| values | dictionary - pairs of { label: value }. |
| Label | Description |
|---|---|
| codec | string (h264) |
| aspect | float (1.78) |
| width | integer (1280) |
| height | integer (720) |
| duration | integer (seconds) |
| Label | Description |
|---|---|
| codec | string (dts) |
| language | string (en) |
| channels | integer (2) |
| Label | Description |
|---|---|
| language | string (en) |
Example:
| String XBMCAddon::xbmcgui::ListItem::getArt | ( | key | ) |
Returns a listitem art path as a string, similar to an infolabel.
| key | string - art name.
|
Example:
| String XBMCAddon::xbmcgui::ListItem::getdescription | ( | ) |
| String XBMCAddon::xbmcgui::ListItem::getduration | ( | ) |
| String XBMCAddon::xbmcgui::ListItem::getfilename | ( | ) |
| String XBMCAddon::xbmcgui::ListItem::getLabel | ( | ) |
| String XBMCAddon::xbmcgui::ListItem::getLabel2 | ( | ) |
Returns the second listitem label.
Example:
| xbmc::InfoTagMusic * XBMCAddon::xbmcgui::ListItem::getMusicInfoTag | ( | ) |
Returns the MusicInfoTag for this item.
| String XBMCAddon::xbmcgui::ListItem::getPath | ( | ) |
Returns the path of this listitem.
| String XBMCAddon::xbmcgui::ListItem::getProperty | ( | ... | ) |
Returns a listitem property as a string, similar to an infolabel.
| key | string - property name. |
Example:
| float XBMCAddon::xbmcgui::ListItem::getRating | ( | key | ) |
Returns a listitem rating as a float.
| key | string - rating type.
|
Example:
| String XBMCAddon::xbmcgui::ListItem::getUniqueID | ( | key | ) |
Returns a listitem uniqueID as a string, similar to an infolabel.
| key | string - uniqueID name.
|
Example:
| xbmc::InfoTagVideo * XBMCAddon::xbmcgui::ListItem::getVideoInfoTag | ( | ) |
Returns the VideoInfoTag for this item.
| int XBMCAddon::xbmcgui::ListItem::getVotes | ( | key | ) |
Returns a listitem votes as a integer.
| key | string - rating type.
|
Example:
| bool XBMCAddon::xbmcgui::ListItem::isSelected | ( | ) |
Returns the listitem's selected status.
Example:
| XBMCAddon::xbmcgui::ListItem::ListItem | ( | const String & | label = emptyString, |
| const String & | label2 = emptyString, |
||
| const String & | iconImage = emptyString, |
||
| const String & | thumbnailImage = emptyString, |
||
| const String & | path = emptyString, |
||
| bool | offscreen = false |
||
| ) |
| void XBMCAddon::xbmcgui::ListItem::select | ( | ... | ) |
Sets the listitem's selected status.
| selected | bool - True=selected/False=not selected |
Example:
| void XBMCAddon::xbmcgui::ListItem::setArt | ( | ... | ) |
Sets the listitem's art
| values | dictionary - pairs of { label: value }.
|
Example:
| void XBMCAddon::xbmcgui::ListItem::setAvailableFanart | ( | ... | ) |
Set available images (needed for video scrapers)
| images | list of dictionaries (see below for relevant keys) |
| Label | Description |
|---|---|
| image | string (http://www.someurl.com/someimage.png) |
| preview | [opt] string (http://www.someurl.com/somepreviewimage.png) |
Example:
| void XBMCAddon::xbmcgui::ListItem::setCast | ( | ... | ) |
Set cast including thumbnails.
| actors | list of dictionaries (see below for relevant keys) |
| Label | Description |
|---|---|
| name | string (Michael C. Hall) |
| role | string (Dexter) |
| thumbnail | string (http://www.someurl.com/someimage.png) |
| order | integer (1) |
Example:
| void XBMCAddon::xbmcgui::ListItem::setContentLookup | ( | ... | ) |
Enable or disable content lookup for item.
If disabled, HEAD requests to e.g determine mime type will not be sent.
| enable | bool to enable content lookup |
| void XBMCAddon::xbmcgui::ListItem::setIconImage | ( | ... | ) |
| void XBMCAddon::xbmcgui::ListItem::setInfo | ( | ... | ) |
Sets the listitem's infoLabels.
| type | string - type of |
| infoLabels | dictionary - pairs of { label: value } |
Available types
| Command name | Description |
|---|---|
| video | Video information |
| music | Music information |
| pictures | Pictures informanion |
| game | Game information |
exif: to the label. Exif values must be passed as strings, separate value pairs with a comma. (eg. {'exif:resolution': '720,480'} See kodi_pictures_infotag for valid strings.General Values (that apply to all types):
| Info label | Description |
|---|---|
| count | integer (12) - can be used to store an id for later, or for sorting purposes |
| size | long (1024) - size in bytes |
| date | string (d.m.Y / 01.01.2009) - file date |
Video Values:
| Info label | Description |
|---|---|
| genre | string (Comedy) or list of strings (["Comedy", "Animation", "Drama"]) |
| country | string (Germany) or list of strings (["Germany", "Italy", "France"]) |
| year | integer (2009) |
| episode | integer (4) |
| season | integer (1) |
| sortepisode | integer (4) |
| sortseason | integer (1) |
| episodeguide | string (Episode guide) |
| showlink | string (Battlestar Galactica) or list of strings (["Battlestar Galactica", "Caprica"]) |
| top250 | integer (192) |
| setid | integer (14) |
| tracknumber | integer (3) |
| rating | float (6.4) - range is 0..10 |
| userrating | integer (9) - range is 1..10 (0 to reset) |
| watched | depreciated - use playcount instead |
| playcount | integer (2) - number of times this item has been played |
| overlay | integer (2) - range is 0..7. See Overlay icon types for values |
| cast | list (["Michal C. Hall","Jennifer Carpenter"]) - if provided a list of tuples cast will be interpreted as castandrole |
| castandrole | list of tuples ([("Michael C. Hall","Dexter"),("Jennifer Carpenter","Debra")]) |
| director | string (Dagur Kari) or list of strings (["Dagur Kari", "Quentin Tarantino", "Chrstopher Nolan"]) |
| mpaa | string (PG-13) |
| plot | string (Long Description) |
| plotoutline | string (Short Description) |
| title | string (Big Fan) |
| originaltitle | string (Big Fan) |
| sorttitle | string (Big Fan) |
| duration | integer (245) - duration in seconds |
| studio | string (Warner Bros.) or list of strings (["Warner Bros.", "Disney", "Paramount"]) |
| tagline | string (An awesome movie) - short description of movie |
| writer | string (Robert D. Siegel) or list of strings (["Robert D. Siegel", "Jonathan Nolan", "J.K. Rowling"]) |
| tvshowtitle | string (Heroes) |
| premiered | string (2005-03-04) |
| status | string (Continuing) - status of a TVshow |
| set | string (Batman Collection) - name of the collection |
| setoverview | string (All Batman movies) - overview of the collection |
| tag | string (cult) or list of strings (["cult", "documentary", "best movies"]) - movie tag |
| imdbnumber | string (tt0110293) - IMDb code |
| code | string (101) - Production code |
| aired | string (2008-12-07) |
| credits | string (Andy Kaufman) or list of strings (["Dagur Kari", "Quentin Tarantino", "Chrstopher Nolan"]) - writing credits |
| lastplayed | string (Y-m-d h:m:s = 2009-04-05 23:16:04) |
| album | string (The Joshua Tree) |
| artist | list (['U2']) |
| votes | string (12345 votes) |
| path | string (/home/user/movie.avi) |
| trailer | string (/home/user/trailer.avi) |
| dateadded | string (Y-m-d h:m:s = 2009-04-05 23:16:04) |
| mediatype | string - "video", "movie", "tvshow", "season", "episode" or "musicvideo" |
| dbid | integer (23) - Only add this for items which are part of the local db. You also need to set the correct 'mediatype'! |
Music Values:
| Info label | Description |
|---|---|
| tracknumber | integer (8) |
| discnumber | integer (2) |
| duration | integer (245) - duration in seconds |
| year | integer (1998) |
| genre | string (Rock) |
| album | string (Pulse) |
| artist | string (Muse) |
| title | string (American Pie) |
| rating | float - range is between 0 and 10 |
| userrating | integer - range is 1..10 |
| lyrics | string (On a dark desert highway...) |
| playcount | integer (2) - number of times this item has been played |
| lastplayed | string (Y-m-d h:m:s = 2009-04-05 23:16:04) |
| mediatype | string - "music", "song", "album", "artist" |
| dbid | integer (23) - Only add this for items which are part of the local db. You also need to set the correct 'mediatype'! |
| listeners | integer (25614) |
| musicbrainztrackid | string (cd1de9af-0b71-4503-9f96-9f5efe27923c) |
| musicbrainzartistid | string (d87e52c5-bb8d-4da8-b941-9f4928627dc8) |
| musicbrainzalbumid | string (24944755-2f68-3778-974e-f572a9e30108) |
| musicbrainzalbumartistid | string (d87e52c5-bb8d-4da8-b941-9f4928627dc8) |
| comment | string (This is a great song) |
Picture Values:
| Info label | Description |
|---|---|
| title | string (In the last summer-1) |
| picturepath | string (/home/username/pictures/img001.jpg) |
| exif* | string (See kodi_pictures_infotag for valid strings) |
Game Values:
| Info label | Description |
|---|---|
| title | string (Super Mario Bros.) |
| platform | string (Atari 2600) |
| genres | list (["Action","Strategy"]) |
| publisher | string (Nintendo) |
| developer | string (Square) |
| overview | string (Long Description) |
| year | integer (1980) |
| gameclient | string (game.libretro.fceumm) |
Example:
| void XBMCAddon::xbmcgui::ListItem::setIsFolder | ( | ... | ) |
Sets if this listitem is a folder.
| isFolder | bool - True=folder / False=not a folder (default). |
Example:
| void XBMCAddon::xbmcgui::ListItem::setLabel | ( | ... | ) |
Sets the listitem's label.
| label | string or unicode - text string. |
Example:
| void XBMCAddon::xbmcgui::ListItem::setLabel2 | ( | ... | ) |
Sets the listitem's label2.
| label | string or unicode - text string. |
Example:
| void XBMCAddon::xbmcgui::ListItem::setMimeType | ( | ... | ) |
Sets the listitem's mimetype if known.
| mimetype | string or unicode - mimetype |
If known prehand, this can (but does not have to) avoid HEAD requests being sent to HTTP servers to figure out file type.
| void XBMCAddon::xbmcgui::ListItem::setPath | ( | ... | ) |
Sets the listitem's path.
| path | string or unicode - path, activated when item is clicked. |
Example:
| void XBMCAddon::xbmcgui::ListItem::setProperties | ( | ... | ) |
Sets multiple properties for listitem's
| values | dictionary - pairs of { label: value }. |
Example:
| void XBMCAddon::xbmcgui::ListItem::setProperty | ( | ... | ) |
Sets a listitem property, similar to an infolabel.
| key | string - property name. |
| value | string or unicode - value of property. |
Example:
| void XBMCAddon::xbmcgui::ListItem::setRating | ( | ... | ) |
Sets a listitem's rating. It needs at least type and rating param
| type | string - the type of the rating. Any string. | ||||||||||
| rating | float - the value of the rating. | ||||||||||
| votes | int - the number of votes. Default 0. | ||||||||||
| defaultt | bool - is the default rating?. Default False.
|
Example:
| void XBMCAddon::xbmcgui::ListItem::setSubtitles | ( | ... | ) |
Sets subtitles for this listitem.
| subtitleFiles | list with path to subtitle files |
Example:
... listitem.setSubtitles(['special://temp/example.srt', 'http://example.com/example.srt']) ...
| void XBMCAddon::xbmcgui::ListItem::setThumbnailImage | ( | ... | ) |
| void XBMCAddon::xbmcgui::ListItem::setUniqueIDs | ( | ... | ) |
Sets the listitem's uniqueID
| values | dictionary - pairs of { label: value }. |
| defaultrating | [opt] string - the name of default rating. |
| Label | Type |
|---|---|
| imdb | string - uniqueid name |
| tvdb | string - uniqueid name |
| tmdb | string - uniqueid name |
| anidb | string - uniqueid name |
Example:
|
override |
1.9.2