Kodi Development 22.0
for Binary and Script based Add-Ons
 
Loading...
Searching...
No Matches
ModuleXbmc.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 "Tuple.h"
13
14#include "utils/LangCodeExpander.h"
15#include "swighelper.h"
16#include <vector>
17
18#ifndef DOXYGEN_SHOULD_SKIP_THIS
19namespace XBMCAddon
20{
21 namespace xbmc
22 {
23#ifndef SWIG
24 // This is a bit of a hack to get around a SWIG problem
25 extern const int lLOGDEBUG;
26#endif
27#endif /* DOXYGEN_SHOULD_SKIP_THIS */
28
29 //
38 //
39
40#ifdef DOXYGEN_SHOULD_USE_THIS
83 log(...);
84#else
85 void log(const char* msg, int level = lLOGDEBUG);
86#endif
87
88#ifdef DOXYGEN_SHOULD_USE_THIS
105#else
106 void shutdown();
107#endif
108
109#ifdef DOXYGEN_SHOULD_USE_THIS
126#else
127 void restart();
128#endif
129
130#ifdef DOXYGEN_SHOULD_USE_THIS
149#else
150 void executescript(const char* script);
151#endif
152
153#ifdef DOXYGEN_SHOULD_USE_THIS
178#else
179 void executebuiltin(const char* function, bool wait = false);
180#endif
181
182#ifdef DOXYGEN_SHOULD_USE_THIS
204#else
205 String executeJSONRPC(const char* jsonrpccommand);
206#endif
207
208#ifdef DOXYGEN_SHOULD_USE_THIS
239 sleep(...);
240#else
241 void sleep(long timemillis);
242#endif
243
244#ifdef DOXYGEN_SHOULD_USE_THIS
268#else
269 String getLocalizedString(int id);
270#endif
271
272#ifdef DOXYGEN_SHOULD_USE_THIS
295#else
296 String getSkinDir();
297#endif
298
299#ifdef DOXYGEN_SHOULD_USE_THIS
329#else
330 String getLanguage(int format = CLangCodeExpander::ENGLISH_NAME, bool region = false);
331#endif
332
333#ifdef DOXYGEN_SHOULD_USE_THIS
352#else
353 String getIPAddress();
354#endif
355
356#ifdef DOXYGEN_SHOULD_USE_THIS
382#else
383 long getDVDState();
384#endif
385
386#ifdef DOXYGEN_SHOULD_USE_THIS
405#else
406 long getFreeMem();
407#endif
408
409#ifdef DOXYGEN_SHOULD_USE_THIS
432#else
433 String getInfoLabel(const char* cLine);
434#endif
435
436#ifdef DOXYGEN_SHOULD_USE_THIS
461#else
462 String getInfoImage(const char * infotag);
463#endif
464
465#ifdef DOXYGEN_SHOULD_USE_THIS
487#else
488 String getDatabaseName(const char* dbType);
489#endif
490
491#ifdef DOXYGEN_SHOULD_USE_THIS
516#else
517 void playSFX(const char* filename, bool useCached = true);
518#endif
519
520#ifdef DOXYGEN_SHOULD_USE_THIS
538#else
539 void stopSFX();
540#endif
541
542#ifdef DOXYGEN_SHOULD_USE_THIS
562#else
563 void enableNavSounds(bool yesNo);
564#endif
565
566#ifdef DOXYGEN_SHOULD_USE_THIS
591#else
592 bool getCondVisibility(const char *condition);
593#endif
594
595#ifdef DOXYGEN_SHOULD_USE_THIS
614#else
615 int getGlobalIdleTime();
616#endif
617
618#ifdef DOXYGEN_SHOULD_USE_THIS
661#else
662 int getDevicePowerStatus(const String& adapterName = emptyString);
663#endif
664
665#ifdef DOXYGEN_SHOULD_USE_THIS
687#else
688 std::vector<String> getCecAdapterNames();
689#endif
690
691#ifdef DOXYGEN_SHOULD_USE_THIS
711#else
712 String getCacheThumbName(const String& path);
713#endif
714
715#ifdef DOXYGEN_SHOULD_USE_THIS
738#else
739 Tuple<String,String> getCleanMovieTitle(const String& path, bool usefoldername = false);
740#endif
741
742#ifdef DOXYGEN_SHOULD_USE_THIS
767#else
768 String getRegion(const char* id);
769#endif
770
771#ifdef DOXYGEN_SHOULD_USE_THIS
798#else
799 String getSupportedMedia(const char* mediaType);
800#endif
801
802#ifdef DOXYGEN_SHOULD_USE_THIS
826#else
827 bool skinHasImage(const char* image);
828#endif
829
830#ifdef DOXYGEN_SHOULD_USE_THIS
862#else
863 bool startServer(int iTyp, bool bStart);
864#endif
865
866#ifdef DOXYGEN_SHOULD_USE_THIS
883#else
884 void audioSuspend();
885#endif
886
887#ifdef DOXYGEN_SHOULD_USE_THIS
904#else
905 void audioResume();
906#endif
907
908#ifdef DOXYGEN_SHOULD_USE_THIS
930#else
931 String getUserAgent();
932#endif
933
934#ifdef DOXYGEN_SHOULD_USE_THIS
964#else
965 String convertLanguage(const char* language, int format);
966#endif
968#ifndef DOXYGEN_SHOULD_SKIP_THIS
969 SWIG_CONSTANT_FROM_GETTER(int, SERVER_WEBSERVER);
970 SWIG_CONSTANT_FROM_GETTER(int, SERVER_AIRPLAYSERVER);
971 SWIG_CONSTANT_FROM_GETTER(int, SERVER_UPNPSERVER);
972 SWIG_CONSTANT_FROM_GETTER(int, SERVER_UPNPRENDERER);
973 SWIG_CONSTANT_FROM_GETTER(int, SERVER_EVENTSERVER);
974 SWIG_CONSTANT_FROM_GETTER(int, SERVER_JSONRPCSERVER);
975 SWIG_CONSTANT_FROM_GETTER(int, SERVER_ZEROCONF);
976
977 SWIG_CONSTANT_FROM_GETTER(int, PLAYLIST_MUSIC);
978 SWIG_CONSTANT_FROM_GETTER(int, PLAYLIST_VIDEO);
979 SWIG_CONSTANT_FROM_GETTER(int, TRAY_OPEN);
980 SWIG_CONSTANT_FROM_GETTER(int, DRIVE_NOT_READY);
981 SWIG_CONSTANT_FROM_GETTER(int, TRAY_CLOSED_NO_MEDIA);
982 SWIG_CONSTANT_FROM_GETTER(int, TRAY_CLOSED_MEDIA_PRESENT);
983 SWIG_CONSTANT_FROM_GETTER(int, LOGDEBUG);
984 SWIG_CONSTANT_FROM_GETTER(int, LOGINFO);
985 SWIG_CONSTANT_FROM_GETTER(int, LOGWARNING);
986 SWIG_CONSTANT_FROM_GETTER(int, LOGERROR);
987 SWIG_CONSTANT_FROM_GETTER(int, LOGFATAL);
988 SWIG_CONSTANT_FROM_GETTER(int, LOGNONE);
989
990 SWIG_CONSTANT_FROM_GETTER(int, ISO_639_1);
991 SWIG_CONSTANT_FROM_GETTER(int, ISO_639_2);
992 SWIG_CONSTANT_FROM_GETTER(int, ENGLISH_NAME);
993
994 SWIG_CONSTANT_FROM_GETTER(int, DEVICE_POWER_NO_ADAPTER);
995 SWIG_CONSTANT_FROM_GETTER(int, DEVICE_POWER_ON);
996 SWIG_CONSTANT_FROM_GETTER(int, DEVICE_POWER_STANDBY);
997 SWIG_CONSTANT_FROM_GETTER(int, DEVICE_POWER_TRANSITION_TO_ON);
998 SWIG_CONSTANT_FROM_GETTER(int, DEVICE_POWER_TRANSITION_TO_STANDBY);
999 SWIG_CONSTANT_FROM_GETTER(int, DEVICE_POWER_UNKNOWN);
1000#if 0
1001 void registerMonitor(Monitor* monitor);
1002 void unregisterMonitor(Monitor* monitor);
1003#endif
1004 }
1005}
1006#endif /* DOXYGEN_SHOULD_SKIP_THIS */
getRegion(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
getSkinDir()
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
getCondVisibility(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
getIPAddress()
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
getSupportedMedia(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
getDVDState()
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
getInfoLabel(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
executebuiltin(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
getCacheThumbName(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
getDatabaseName(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
log(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
shutdown()
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
getUserAgent()
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
audioSuspend()
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
getCleanMovieTitle(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
enableNavSounds(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
getCecAdapterNames()
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
skinHasImage(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
getLocalizedString(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
startServer(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
getLanguage(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
getFreeMem()
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
convertLanguage(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
sleep(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
restart()
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
executeJSONRPC(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
getGlobalIdleTime()
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
getDevicePowerStatus(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
stopSFX()
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
audioResume()
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
executescript(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
getInfoImage(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
playSFX(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...