/
ListItem.h
1200 lines (1145 loc) · 44.3 KB
/
ListItem.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (C) 2005-2013 Team XBMC
* http://kodi.tv
*
* This Program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2, or (at your option)
* any later version.
*
* This Program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with XBMC; see the file COPYING. If not, see
* <http://www.gnu.org/licenses/>.
*
*/
#pragma once
#include <map>
#include <vector>
#include "AddonClass.h"
#include "Tuple.h"
#include "Dictionary.h"
#include "Alternative.h"
#include "ListItem.h"
#include "FileItem.h"
#include "AddonString.h"
#include "commons/Exception.h"
#include "InfoTagVideo.h"
#include "InfoTagMusic.h"
namespace XBMCAddon
{
namespace xbmcgui
{
XBMCCOMMONS_STANDARD_EXCEPTION(ListItemException);
// This is a type that represents either a String or a String Tuple
typedef Alternative<StringOrInt,Tuple<String, StringOrInt> > InfoLabelStringOrTuple;
// This type is either a String or a list of InfoLabelStringOrTuple types
typedef Alternative<StringOrInt, std::vector<InfoLabelStringOrTuple> > InfoLabelValue;
// The type contains the dictionary values for the ListItem::setInfo call.
// The values in the dictionary can be either a String, or a list of items.
// If it's a list of items then the items can be either a String or a Tuple.
typedef Dictionary<InfoLabelValue> InfoLabelDict;
//
/// \defgroup python_xbmcgui_listitem ListItem
/// \ingroup python_xbmcgui
/// @{
/// @brief **Selectable window list item.**
///
/// The list item control is used for creating item lists in Kodi
///
/// \python_class{ ListItem([label, label2, iconImage, thumbnailImage, path]) }
///
/// @param label [opt] string
/// @param label2 [opt] string
/// @param iconImage __Deprecated. Use setArt__
/// @param thumbnailImage __Deprecated. Use setArt__
/// @param path [opt] string
///
///
///-----------------------------------------------------------------------
/// @python_v16 **iconImage** and **thumbnailImage** are deprecated. Use **setArt()**.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// listitem = xbmcgui.ListItem('Casino Royale')
/// ...
/// ~~~~~~~~~~~~~
class ListItem : public AddonClass
{
public:
#if !defined SWIG && !defined DOXYGEN_SHOULD_SKIP_THIS
CFileItemPtr item;
bool m_offscreen;
#endif
ListItem(const String& label = emptyString,
const String& label2 = emptyString,
const String& iconImage = emptyString,
const String& thumbnailImage = emptyString,
const String& path = emptyString,
bool offscreen = false);
#ifndef SWIG
inline explicit ListItem(CFileItemPtr pitem) :
item(pitem), m_offscreen(false)
{}
static inline AddonClass::Ref<ListItem> fromString(const String& str)
{
AddonClass::Ref<ListItem> ret = AddonClass::Ref<ListItem>(new ListItem());
ret->item.reset(new CFileItem(str));
return ret;
}
#endif
~ListItem() override;
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ getLabel() }
///-----------------------------------------------------------------------
/// Returns the listitem label.
///
/// @return Label of item
///
///
///-----------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// # getLabel()
/// label = listitem.getLabel()
/// ...
/// ~~~~~~~~~~~~~
///
getLabel();
#else
String getLabel();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ getLabel2() }
///-----------------------------------------------------------------------
/// Returns the second listitem label.
///
/// @return Second label of item
///
///
///-----------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// # getLabel2()
/// label = listitem.getLabel2()
/// ...
/// ~~~~~~~~~~~~~
///
getLabel2();
#else
String getLabel2();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ setLabel(label) }
///-----------------------------------------------------------------------
/// Sets the listitem's label.
///
/// @param label string or unicode - text string.
///
///
///-----------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// # setLabel(label)
/// listitem.setLabel('Casino Royale')
/// ...
/// ~~~~~~~~~~~~~
///
setLabel(...);
#else
void setLabel(const String& label);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ setLabel2(label) }
///-----------------------------------------------------------------------
/// Sets the listitem's label2.
///
/// @param label string or unicode - text string.
///
///
///-----------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// # setLabel2(label)
/// listitem.setLabel2('Casino Royale')
/// ...
/// ~~~~~~~~~~~~~
///
setLabel2(...);
#else
void setLabel2(const String& label);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ setIconImage(iconImage) }
///-----------------------------------------------------------------------
/// @python_v16 Deprecated. Use **setArt()**.
///
setIconImage(...);
#else
void setIconImage(const String& iconImage);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ setThumbnailImage(thumbFilename) }
///-----------------------------------------------------------------------
/// @python_v16 Deprecated. Use **setArt()**.
///
setThumbnailImage(...);
#else
void setThumbnailImage(const String& thumbFilename);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ setArt(values) }
///-----------------------------------------------------------------------
/// Sets the listitem's art
///
/// @param values dictionary - pairs of `{ label: value }`.
/// - Some default art values (any string possible):
/// | Label | Type |
/// |:-------------:|:--------------------------------------------------|
/// | thumb | string - image filename
/// | poster | string - image filename
/// | banner | string - image filename
/// | fanart | string - image filename
/// | clearart | string - image filename
/// | clearlogo | string - image filename
/// | landscape | string - image filename
/// | icon | string - image filename
///
///
///
///-----------------------------------------------------------------------
/// @python_v13 New function added.
/// @python_v16 Added new label **icon**.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// # setArt(values)
/// listitem.setArt({ 'poster': 'poster.png', 'banner' : 'banner.png' })
/// ...
/// ~~~~~~~~~~~~~
///
setArt(...);
#else
void setArt(const Properties& dictionary);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ setIsFolder(isFolder) }
///-----------------------------------------------------------------------
/// Sets if this listitem is a folder.
///
/// @param isFolder bool - True=folder / False=not a folder (default).
///
///
///-----------------------------------------------------------------------
///
/// @python_v18 New function added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// # setIsFolder(isFolder)
/// listitem.setIsFolder(True)
/// ...
/// ~~~~~~~~~~~~~
///
setIsFolder(...);
#else
void setIsFolder(bool isFolder);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ setUniqueIDs(values, defaultrating) }
///-----------------------------------------------------------------------
/// Sets the listitem's uniqueID
///
/// @param values dictionary - pairs of `{ label: value }`.
/// @param defaultrating [opt] string - the name of default rating.
///
/// - Some example values (any string possible):
/// | Label | Type |
/// |:-------------:|:--------------------------------------------------|
/// | imdb | string - uniqueid name
/// | tvdb | string - uniqueid name
/// | tmdb | string - uniqueid name
/// | anidb | string - uniqueid name
///
///
///
///-----------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// # setUniqueIDs(values, defaultrating)
/// listitem.setUniqueIDs({ 'imdb': 'tt8938399', 'tmdb' : '9837493' }, "imdb")
/// ...
/// ~~~~~~~~~~~~~
///
setUniqueIDs(...);
#else
void setUniqueIDs(const Properties& dictionary, const String& defaultrating = "");
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ setRating(type, rating, votes = 0, defaultt = False) }
///-----------------------------------------------------------------------
/// Sets a listitem's rating. It needs at least type and rating param
///
/// @param type string - the type of the rating. Any string.
/// @param rating float - the value of the rating.
/// @param votes int - the number of votes. Default 0.
/// @param defaultt bool - is the default rating?. Default False.
/// - Some example type (any string possible):
/// | Label | Type |
/// |:-------------:|:--------------------------------------------------|
/// | imdb | string - rating type
/// | tvdb | string - rating type
/// | tmdb | string - rating type
/// | anidb | string - rating type
///
///
///
///-----------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// # setRating(type, rating, votes, defaultt))
/// listitem.setRating("imdb", 4.6, 8940, True)
/// ...
/// ~~~~~~~~~~~~~
///
setRating(...);
#else
void setRating(std::string type, float rating, int votes = 0, bool defaultt = false);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ addSeason(number, name = "") }
///-----------------------------------------------------------------------
/// Add a season with name to a listitem. It needs at least the season number
///
/// @param number int - the number of the season.
/// @param name string - the name of the season. Default "".
///
///-----------------------------------------------------------------------
///
/// @python_v18 New function added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// # addSeason(number, name))
/// listitem.addSeason(1, "Murder House")
/// ...
/// ~~~~~~~~~~~~~
///
addSeason(...);
#else
void addSeason(int number, std::string name = "");
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ getArt(key) }
///-----------------------------------------------------------------------
/// Returns a listitem art path as a string, similar to an infolabel.\n
///
/// @param key string - art name.
/// - Some default art values (any string possible):
/// | Label | Type |
/// |---------------|--------------------------------------------------|
/// | thumb | string - image path
/// | poster | string - image path
/// | banner | string - image path
/// | fanart | string - image path
/// | clearart | string - image path
/// | clearlogo | string - image path
/// | landscape | string - image path
/// | icon | string - image path
///
///
///-----------------------------------------------------------------------
/// @python_v17 New function added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// poster = listitem.getArt('poster')
/// ...
/// ~~~~~~~~~~~~~
///
getArt(key);
#else
String getArt(const char* key);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ getUniqueID(key) }
///-----------------------------------------------------------------------
/// Returns a listitem uniqueID as a string, similar to an infolabel.\n
///
/// @param key string - uniqueID name.
/// - Some default uniqueID values (any string possible):
/// | Label | Type |
/// |---------------|--------------------------------------------------|
/// | imdb | string - uniqueid name
/// | tvdb | string - uniqueid name
/// | tmdb | string - uniqueid name
/// | anidb | string - uniqueid name
///
///
///
///-----------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// uniqueID = listitem.getUniqueID('imdb')
/// ...
/// ~~~~~~~~~~~~~
///
getUniqueID(key);
#else
String getUniqueID(const char* key);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ getRating(key) }
///-----------------------------------------------------------------------
/// Returns a listitem rating as a float.\n
///
/// @param key string - rating type.
/// - Some default key values (any string possible):
/// | Label | Type |
/// |---------------|--------------------------------------------------|
/// | imdb | string - type name
/// | tvdb | string - type name
/// | tmdb | string - type name
/// | anidb | string - type name
///
///
///
///-----------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// rating = listitem.getRating('imdb')
/// ...
/// ~~~~~~~~~~~~~
///
getRating(key);
#else
float getRating(const char* key);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ getVotes(key) }
///-----------------------------------------------------------------------
/// Returns a listitem votes as a integer.\n
///
/// @param key string - rating type.
/// - Some default key values (any string possible):
/// | Label | Type |
/// |---------------|--------------------------------------------------|
/// | imdb | string - type name
/// | tvdb | string - type name
/// | tmdb | string - type name
/// | anidb | string - type name
///
///
///
///-----------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// votes = listitem.getVotes('imdb')
/// ...
/// ~~~~~~~~~~~~~
///
getVotes(key);
#else
int getVotes(const char* key);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ select(selected) }
///-----------------------------------------------------------------------
/// Sets the listitem's selected status.
///
/// @param selected bool - True=selected/False=not selected
///
///
///
///-----------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// # select(selected)
/// listitem.select(True)
/// ...
/// ~~~~~~~~~~~~~
///
select(...);
#else
void select(bool selected);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ isSelected() }
///-----------------------------------------------------------------------
/// Returns the listitem's selected status.
///
///
/// @return bool - true if selected, otherwise false
///
///
///-----------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// # isSelected()
/// selected = listitem.isSelected()
/// ...
/// ~~~~~~~~~~~~~
///
isSelected();
#else
bool isSelected();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ setInfo(type, infoLabels) }
///-----------------------------------------------------------------------
/// Sets the listitem's infoLabels.
///
/// @param type string - type of
/// @param infoLabels dictionary - pairs of `{ label: value }`
///
/// __Available types__
/// | Command name | Description |
/// |:------------:|:----------------------|
/// | video | Video information
/// | music | Music information
/// | pictures | Pictures informanion
/// | game | Game information
///
/// @note To set pictures exif info, prepend `exif:` to the label. Exif values must be passed
/// as strings, separate value pairs with a comma. <b>(eg. <c>{'exif:resolution': '720,480'}</c></b>
/// See \ref kodi_pictures_infotag for valid strings.\n
/// \n
/// You can use the above as keywords for arguments and skip certain optional arguments.
/// Once you use a keyword, all following arguments require the keyword.
///
/// __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 \ref kodi_guilib_listitem_iconoverlay "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 \ref 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)
///
///
///-----------------------------------------------------------------------
/// @python_v14 Added new label **discnumber**.
/// @python_v15 **duration** has to be set in seconds.
/// @python_v16 Added new label **mediatype**.
/// @python_v17
/// Added labels **setid**, **set**, **imdbnumber**, **code**, **dbid**, **path** and **userrating**.
/// Expanded the possible infoLabels for the option **mediatype**.
/// @python_v18 Added new **game** type and associated infolabels.
/// Added labels **setoverview**, **tag**, **sortepisode**, **sortseason**, **episodeguide**, **showlink**.
/// Extended labels **genre**, **country**, **director**, **studio**, **writer**, **tag**, **credits** to also use a list of strings.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// listitem.setInfo('video', { 'genre': 'Comedy' })
/// ...
/// ~~~~~~~~~~~~~
///
setInfo(...);
#else
void setInfo(const char* type, const InfoLabelDict& infoLabels);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ setCast(actors) }
///-----------------------------------------------------------------------
/// @brief Set cast including thumbnails
///
/// @param actors list of dictionaries (see below for relevant keys)
///
/// - Keys:
/// | Label | Description |
/// |--------------:|:------------------------------------------------|
/// | name | string (Michael C. Hall)
/// | role | string (Dexter)
/// | thumbnail | string (http://www.someurl.com/someimage.png)
/// | order | integer (1)
///
///
///-----------------------------------------------------------------------
/// @python_v17 New function added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// actors = [{"name": "Actor 1", "role": "role 1"}, {"name": "Actor 2", "role": "role 2"}]
/// listitem.setCast(actors)
/// ...
/// ~~~~~~~~~~~~~
///
setCast(...);
#else
void setCast(const std::vector<Properties>& actors);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ setAvailableFanart(images) }
///-----------------------------------------------------------------------
/// @brief Set available images (needed for scrapers)
///
/// @param images list of dictionaries (see below for relevant keys)
///
/// - Keys:
/// | Label | Description |
/// |--------------:|:------------------------------------------------|
/// | image | string (http://www.someurl.com/someimage.png)
/// | preview | [opt] string (http://www.someurl.com/somepreviewimage.png)
/// | colors | [opt] string (either comma separated Kodi hex values ("FFFFFFFF,DDDDDDDD") or TVDB RGB Int Triplets ("|68,69,59|69,70,58|78,78,68|"))
///
///
///-----------------------------------------------------------------------
/// @python_v18 New function added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// fanart = [{"image": path_to_image_1, "preview": path_to_preview_1}, {"image": path_to_image_2, "preview": path_to_preview_2}]
/// listitem.setAvailableFanart(fanart)
/// ...
/// ~~~~~~~~~~~~~
///
setAvailableFanart(...);
#else
void setAvailableFanart(const std::vector<Properties>& images);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ addAvailableArtwork(images) }
///-----------------------------------------------------------------------
/// @brief Add an image to available artworks (needed for scrapers)
///
/// @param url string (image path url)
/// @param art_type string (image type)
/// @param referrer [opt] string (referrer url)
/// @param cache [opt] string (filename in cache)
/// @param post [opt] bool (use post to retrieve the image, default false)
/// @param isgz [opt] bool (use gzip to retrieve the image, default false)
/// @param season [opt] integer (number of season in case of season thumb)
///
///-----------------------------------------------------------------------
/// @python_v18 New function added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// listitem.addAvailableArtwork(path_to_image_1, "thumb")
/// ...
/// ~~~~~~~~~~~~~
///
addAvailableArtwork(...);
#else
void addAvailableArtwork(std::string url, std::string art_type = "", std::string referrer = "", std::string cache = "", bool post = false, bool isgz = false, int season = -1);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ addStreamInfo(type, values) }
///-----------------------------------------------------------------------
/// @brief Add a stream with details.
///
/// @param type string - type of stream(video/audio/subtitle).
/// @param values dictionary - pairs of { label: value }.
///
/// - Video Values:
/// | Label | Description |
/// |--------------:|:------------------------------------------------|
/// | codec | string (h264)
/// | aspect | float (1.78)
/// | width | integer (1280)
/// | height | integer (720)
/// | duration | integer (seconds)
///
/// - Audio Values:
/// | Label | Description |
/// |--------------:|:------------------------------------------------|
/// | codec | string (dts)
/// | language | string (en)
/// | channels | integer (2)
///
/// - Subtitle Values:
/// | Label | Description |
/// |--------------:|:------------------------------------------------|
/// | language | string (en)
///
///
///
///-----------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// listitem.addStreamInfo('video', { 'codec': 'h264', 'width' : 1280 })
/// ...
/// ~~~~~~~~~~~~~
///
addStreamInfo(...);
#else
void addStreamInfo(const char* cType, const Properties& dictionary);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ addContextMenuItems([(label, action,)*], replaceItems) }
///-----------------------------------------------------------------------
/// Adds item(s) to the context menu for media lists.
///
/// @param items list - [(label, action,)*] A list of tuples consisting of label and action pairs.
/// - label string or unicode - item's label.
/// - action string or unicode - any built-in function to perform.
///
///
/// List of functions - http://kodi.wiki/view/List_of_Built_In_Functions
///
/// @note You can use the above as keywords for arguments and skip certain optional arguments.\n
/// Once you use a keyword, all following arguments require the keyword.
///
///
///-----------------------------------------------------------------------
/// @python_v17 Completely removed option **replaceItems**.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// listitem.addContextMenuItems([('Theater Showtimes', 'RunScript(special://home/scripts/showtimes/default.py,Iron Man)',)])
/// ...
/// ~~~~~~~~~~~~~
///
addContextMenuItems(...);
#else
void addContextMenuItems(const std::vector<Tuple<String,String> >& items, bool replaceItems = false);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ setProperty(key, value) }
///-----------------------------------------------------------------------
/// Sets a listitem property, similar to an infolabel.
///
/// @param key string - property name.
/// @param value string or unicode - value of property.
///
/// @note Key is NOT case sensitive.\n
/// You can use the above as keywords for arguments and skip certain optional arguments.\n
/// Once you use a keyword, all following arguments require the keyword.\n
/// \n
/// Some of these are treated internally by Kodi, such as the 'StartOffset' property, which is
/// the offset in seconds at which to start playback of an item. Others may be used in the skin
/// to add extra information, such as 'WatchedCount' for tvshow items
///
///
///-----------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// listitem.setProperty('AspectRatio', '1.85 : 1')
/// listitem.setProperty('StartOffset', '256.4')
/// ...
/// ~~~~~~~~~~~~~
///
setProperty(...);
#else
void setProperty(const char * key, const String& value);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ setProperties(values) }
///-----------------------------------------------------------------------
/// Sets multiple properties for listitem's
///
/// @param values dictionary - pairs of `{ label: value }`.
///
/// @python_v18 New function added.
///
///-----------------------------------------------------------------------
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// # setProperties(values)
/// listitem.setProperties({ 'AspectRatio': '1.85', 'StartOffset' : '256.4' })
/// ...
/// ~~~~~~~~~~~~~
///
setProperties(...);
#else
void setProperties(const Properties& dictionary);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ getProperty(key) }
///-----------------------------------------------------------------------
/// Returns a listitem property as a string, similar to an infolabel.
///
/// @param key string - property name.
///
/// @note Key is NOT case sensitive.\n
/// You can use the above as keywords for arguments and skip certain optional arguments.\n
/// Once you use a keyword, all following arguments require the keyword.
///
///
///-----------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// AspectRatio = listitem.getProperty('AspectRatio')
/// ...
/// ~~~~~~~~~~~~~
///
getProperty(...);
#else
String getProperty(const char* key);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS