Kodi Development 22.0
for Binary and Script based Add-Ons
 
Loading...
Searching...
No Matches
ModuleXbmcplugin.h
1/*
2 * Copyright (C) 2005-2018 Team Kodi
3 * This file is part of Kodi - https://kodi.tv
4 *
5 * SPDX-License-Identifier: GPL-2.0-or-later
6 * See LICENSES/README.md for more information.
7 */
8
9#pragma once
10
11#include "AddonString.h"
12#include "ListItem.h"
13#include "SortFileItem.h"
14#include "Tuple.h"
15#include "swighelper.h"
16
17#include <vector>
18
19#ifndef DOXYGEN_SHOULD_SKIP_THIS
20namespace XBMCAddon
21{
22 namespace xbmcplugin
23 {
24#endif /* DOXYGEN_SHOULD_SKIP_THIS */
25
26 //
35 //
36
37#ifdef DOXYGEN_SHOULD_USE_THIS
69#else
70 bool addDirectoryItem(int handle, const String& url, const XBMCAddon::xbmcgui::ListItem* listitem,
71 bool isFolder = false, int totalItems = 0);
72#endif
73
74#ifdef DOXYGEN_SHOULD_USE_THIS
102#else
103 bool addDirectoryItems(int handle,
104 const std::vector<Tuple<String,const XBMCAddon::xbmcgui::ListItem*,bool> >& items,
105 int totalItems = 0);
106#endif
107
108#ifdef DOXYGEN_SHOULD_USE_THIS
137#else
138 void endOfDirectory(int handle, bool succeeded = true, bool updateListing = false,
139 bool cacheToDisc = true);
140#endif
141
142#ifdef DOXYGEN_SHOULD_USE_THIS
167#else
168 void setResolvedUrl(int handle, bool succeeded, const XBMCAddon::xbmcgui::ListItem* listitem);
169#endif
170
171#ifdef DOXYGEN_SHOULD_USE_THIS
267#else
268 void addSortMethod(int handle, int sortMethod, const String& labelMask = emptyString, const String& label2Mask = emptyString);
269#endif
270
271#ifdef DOXYGEN_SHOULD_USE_THIS
296#else
297 String getSetting(int handle, const char* id);
298#endif
299
300#ifdef DOXYGEN_SHOULD_USE_THIS
321#else
322 void setSetting(int handle, const String& id, const String& value);
323#endif
324
325#ifdef DOXYGEN_SHOULD_USE_THIS
357#else
358 void setContent(int handle, const char* content);
359#endif
360
361#ifdef DOXYGEN_SHOULD_USE_THIS
381#else
382 void setPluginCategory(int handle, const String& category);
383#endif
384
385#ifdef DOXYGEN_SHOULD_USE_THIS
408#else
409 void setPluginFanart(int handle, const char* image = NULL,
410 const char* color1 = NULL,
411 const char* color2 = NULL,
412 const char* color3 = NULL);
413#endif
414
415#ifdef DOXYGEN_SHOULD_USE_THIS
439#else
440 void setProperty(int handle, const char* key, const String& value);
441#endif
442
443#ifndef DOXYGEN_SHOULD_SKIP_THIS
444 SWIG_CONSTANT2(int, SORT_METHOD_NONE, static_cast<int>(SortMethod::NONE));
445 SWIG_CONSTANT2(int, SORT_METHOD_LABEL, static_cast<int>(SortMethod::LABEL));
446 SWIG_CONSTANT2(int,
447 SORT_METHOD_LABEL_IGNORE_THE,
448 static_cast<int>(SortMethod::LABEL_IGNORE_THE));
449 SWIG_CONSTANT2(int, SORT_METHOD_DATE, static_cast<int>(SortMethod::DATE));
450 SWIG_CONSTANT2(int, SORT_METHOD_SIZE, static_cast<int>(SortMethod::SIZE));
451 SWIG_CONSTANT2(int, SORT_METHOD_FILE, static_cast<int>(SortMethod::FILE));
452 SWIG_CONSTANT2(int, SORT_METHOD_DRIVE_TYPE, static_cast<int>(SortMethod::DRIVE_TYPE));
453 SWIG_CONSTANT2(int, SORT_METHOD_TRACKNUM, static_cast<int>(SortMethod::TRACKNUM));
454 SWIG_CONSTANT2(int, SORT_METHOD_DURATION, static_cast<int>(SortMethod::DURATION));
455 SWIG_CONSTANT2(int, SORT_METHOD_TITLE, static_cast<int>(SortMethod::TITLE));
456 SWIG_CONSTANT2(int,
457 SORT_METHOD_TITLE_IGNORE_THE,
458 static_cast<int>(SortMethod::TITLE_IGNORE_THE));
459 SWIG_CONSTANT2(int, SORT_METHOD_ARTIST, static_cast<int>(SortMethod::ARTIST));
460 SWIG_CONSTANT2(int,
461 SORT_METHOD_ARTIST_IGNORE_THE,
462 static_cast<int>(SortMethod::ARTIST_IGNORE_THE));
463 SWIG_CONSTANT2(int, SORT_METHOD_ALBUM, static_cast<int>(SortMethod::ALBUM));
464 SWIG_CONSTANT2(int,
465 SORT_METHOD_ALBUM_IGNORE_THE,
466 static_cast<int>(SortMethod::ALBUM_IGNORE_THE));
467 SWIG_CONSTANT2(int, SORT_METHOD_GENRE, static_cast<int>(SortMethod::GENRE));
468 SWIG_CONSTANT2(int, SORT_METHOD_VIDEO_YEAR, static_cast<int>(SortMethod::YEAR));
469 SWIG_CONSTANT2(int, SORT_METHOD_VIDEO_RATING, static_cast<int>(SortMethod::VIDEO_RATING));
470 SWIG_CONSTANT2(int, SORT_METHOD_PROGRAM_COUNT, static_cast<int>(SortMethod::PROGRAM_COUNT));
471 SWIG_CONSTANT2(int, SORT_METHOD_PLAYLIST_ORDER, static_cast<int>(SortMethod::PLAYLIST_ORDER));
472 SWIG_CONSTANT2(int, SORT_METHOD_EPISODE, static_cast<int>(SortMethod::EPISODE));
473 SWIG_CONSTANT2(int, SORT_METHOD_VIDEO_TITLE, static_cast<int>(SortMethod::VIDEO_TITLE));
474 SWIG_CONSTANT2(int,
475 SORT_METHOD_VIDEO_SORT_TITLE,
476 static_cast<int>(SortMethod::VIDEO_SORT_TITLE));
477 SWIG_CONSTANT2(int,
478 SORT_METHOD_VIDEO_SORT_TITLE_IGNORE_THE,
479 static_cast<int>(SortMethod::VIDEO_SORT_TITLE_IGNORE_THE));
480 SWIG_CONSTANT2(int,
481 SORT_METHOD_VIDEO_ORIGINAL_TITLE,
482 static_cast<int>(SortMethod::VIDEO_ORIGINAL_TITLE));
483 SWIG_CONSTANT2(int,
484 SORT_METHOD_VIDEO_ORIGINAL_TITLE_IGNORE_THE,
485 static_cast<int>(SortMethod::VIDEO_ORIGINAL_TITLE_IGNORE_THE));
486 SWIG_CONSTANT2(int, SORT_METHOD_PRODUCTIONCODE, static_cast<int>(SortMethod::PRODUCTIONCODE));
487 SWIG_CONSTANT2(int, SORT_METHOD_SONG_RATING, static_cast<int>(SortMethod::SONG_RATING));
488 SWIG_CONSTANT2(int, SORT_METHOD_MPAA_RATING, static_cast<int>(SortMethod::MPAA_RATING));
489 SWIG_CONSTANT2(int, SORT_METHOD_VIDEO_RUNTIME, static_cast<int>(SortMethod::VIDEO_RUNTIME));
490 SWIG_CONSTANT2(int, SORT_METHOD_STUDIO, static_cast<int>(SortMethod::STUDIO));
491 SWIG_CONSTANT2(int,
492 SORT_METHOD_STUDIO_IGNORE_THE,
493 static_cast<int>(SortMethod::STUDIO_IGNORE_THE));
494 SWIG_CONSTANT2(int, SORT_METHOD_UNSORTED, static_cast<int>(SortMethod::UNSORTED));
495 SWIG_CONSTANT2(int, SORT_METHOD_BITRATE, static_cast<int>(SortMethod::BITRATE));
496 SWIG_CONSTANT2(int, SORT_METHOD_LISTENERS, static_cast<int>(SortMethod::LISTENERS));
497 SWIG_CONSTANT2(int, SORT_METHOD_COUNTRY, static_cast<int>(SortMethod::COUNTRY));
498 SWIG_CONSTANT2(int, SORT_METHOD_DATEADDED, static_cast<int>(SortMethod::DATEADDED));
499 SWIG_CONSTANT2(int, SORT_METHOD_FULLPATH, static_cast<int>(SortMethod::FULLPATH));
500 SWIG_CONSTANT2(int,
501 SORT_METHOD_LABEL_IGNORE_FOLDERS,
502 static_cast<int>(SortMethod::LABEL_IGNORE_FOLDERS));
503 SWIG_CONSTANT2(int, SORT_METHOD_LASTPLAYED, static_cast<int>(SortMethod::LASTPLAYED));
504 SWIG_CONSTANT2(int, SORT_METHOD_PLAYCOUNT, static_cast<int>(SortMethod::PLAYCOUNT));
505 SWIG_CONSTANT2(int, SORT_METHOD_CHANNEL, static_cast<int>(SortMethod::CHANNEL));
506 SWIG_CONSTANT2(int, SORT_METHOD_DATE_TAKEN, static_cast<int>(SortMethod::DATE_TAKEN));
507 SWIG_CONSTANT2(int,
508 SORT_METHOD_VIDEO_USER_RATING,
509 static_cast<int>(SortMethod::VIDEO_USER_RATING));
510 SWIG_CONSTANT2(int,
511 SORT_METHOD_SONG_USER_RATING,
512 static_cast<int>(SortMethod::SONG_USER_RATING));
513 }
514}
515#endif /* DOXYGEN_SHOULD_SKIP_THIS */
Definition ListItem.h:54
addDirectoryItems(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
addDirectoryItem(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
endOfDirectory(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
setSetting(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
addSortMethod(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
getSetting(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
setPluginCategory(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
setProperty(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
setResolvedUrl(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
setContent(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
setPluginFanart(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...