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
340#else
341 String getLanguage(int format = CLangCodeExpander::ENGLISH_NAME, bool region = false);
342#endif
343
344#ifdef DOXYGEN_SHOULD_USE_THIS
363#else
364 String getIPAddress();
365#endif
366
367#ifdef DOXYGEN_SHOULD_USE_THIS
393#else
394 long getDVDState();
395#endif
396
397#ifdef DOXYGEN_SHOULD_USE_THIS
416#else
417 long getFreeMem();
418#endif
419
420#ifdef DOXYGEN_SHOULD_USE_THIS
443#else
444 String getInfoLabel(const char* cLine);
445#endif
446
447#ifdef DOXYGEN_SHOULD_USE_THIS
472#else
473 String getInfoImage(const char * infotag);
474#endif
475
476#ifdef DOXYGEN_SHOULD_USE_THIS
498#else
499 String getDatabaseName(const char* dbType);
500#endif
501
502#ifdef DOXYGEN_SHOULD_USE_THIS
527#else
528 void playSFX(const char* filename, bool useCached = true);
529#endif
530
531#ifdef DOXYGEN_SHOULD_USE_THIS
549#else
550 void stopSFX();
551#endif
552
553#ifdef DOXYGEN_SHOULD_USE_THIS
573#else
574 void enableNavSounds(bool yesNo);
575#endif
576
577#ifdef DOXYGEN_SHOULD_USE_THIS
602#else
603 bool getCondVisibility(const char *condition);
604#endif
605
606#ifdef DOXYGEN_SHOULD_USE_THIS
625#else
626 int getGlobalIdleTime();
627#endif
628
629#ifdef DOXYGEN_SHOULD_USE_THIS
672#else
673 int getDevicePowerStatus(const String& adapterName = emptyString);
674#endif
675
676#ifdef DOXYGEN_SHOULD_USE_THIS
698#else
699 std::vector<String> getCecAdapterNames();
700#endif
701
702#ifdef DOXYGEN_SHOULD_USE_THIS
722#else
723 String getCacheThumbName(const String& path);
724#endif
725
726#ifdef DOXYGEN_SHOULD_USE_THIS
749#else
750 Tuple<String,String> getCleanMovieTitle(const String& path, bool usefoldername = false);
751#endif
752
753#ifdef DOXYGEN_SHOULD_USE_THIS
778#else
779 String getRegion(const char* id);
780#endif
781
782#ifdef DOXYGEN_SHOULD_USE_THIS
809#else
810 String getSupportedMedia(const char* mediaType);
811#endif
812
813#ifdef DOXYGEN_SHOULD_USE_THIS
837#else
838 bool skinHasImage(const char* image);
839#endif
840
841#ifdef DOXYGEN_SHOULD_USE_THIS
873#else
874 bool startServer(int iTyp, bool bStart);
875#endif
876
877#ifdef DOXYGEN_SHOULD_USE_THIS
894#else
895 void audioSuspend();
896#endif
897
898#ifdef DOXYGEN_SHOULD_USE_THIS
915#else
916 void audioResume();
917#endif
918
919#ifdef DOXYGEN_SHOULD_USE_THIS
941#else
942 String getUserAgent();
943#endif
944
945#ifdef DOXYGEN_SHOULD_USE_THIS
984#else
985 String convertLanguage(const char* language, int format);
986#endif
988#ifndef DOXYGEN_SHOULD_SKIP_THIS
989 SWIG_CONSTANT_FROM_GETTER(int, SERVER_WEBSERVER);
990 SWIG_CONSTANT_FROM_GETTER(int, SERVER_AIRPLAYSERVER);
991 SWIG_CONSTANT_FROM_GETTER(int, SERVER_UPNPSERVER);
992 SWIG_CONSTANT_FROM_GETTER(int, SERVER_UPNPRENDERER);
993 SWIG_CONSTANT_FROM_GETTER(int, SERVER_EVENTSERVER);
994 SWIG_CONSTANT_FROM_GETTER(int, SERVER_JSONRPCSERVER);
995 SWIG_CONSTANT_FROM_GETTER(int, SERVER_ZEROCONF);
996
997 SWIG_CONSTANT_FROM_GETTER(int, PLAYLIST_MUSIC);
998 SWIG_CONSTANT_FROM_GETTER(int, PLAYLIST_VIDEO);
999 SWIG_CONSTANT_FROM_GETTER(int, TRAY_OPEN);
1000 SWIG_CONSTANT_FROM_GETTER(int, DRIVE_NOT_READY);
1001 SWIG_CONSTANT_FROM_GETTER(int, TRAY_CLOSED_NO_MEDIA);
1002 SWIG_CONSTANT_FROM_GETTER(int, TRAY_CLOSED_MEDIA_PRESENT);
1003 SWIG_CONSTANT_FROM_GETTER(int, LOGDEBUG);
1004 SWIG_CONSTANT_FROM_GETTER(int, LOGINFO);
1005 SWIG_CONSTANT_FROM_GETTER(int, LOGWARNING);
1006 SWIG_CONSTANT_FROM_GETTER(int, LOGERROR);
1007 SWIG_CONSTANT_FROM_GETTER(int, LOGFATAL);
1008 SWIG_CONSTANT_FROM_GETTER(int, LOGNONE);
1009
1010 SWIG_CONSTANT_FROM_GETTER(int, ISO_639_1);
1011 SWIG_CONSTANT_FROM_GETTER(int, ISO_639_2);
1012 SWIG_CONSTANT_FROM_GETTER(int, ENGLISH_NAME);
1013 SWIG_CONSTANT_FROM_GETTER(int, ISO_NAME);
1014
1015 SWIG_CONSTANT_FROM_GETTER(int, DEVICE_POWER_NO_ADAPTER);
1016 SWIG_CONSTANT_FROM_GETTER(int, DEVICE_POWER_ON);
1017 SWIG_CONSTANT_FROM_GETTER(int, DEVICE_POWER_STANDBY);
1018 SWIG_CONSTANT_FROM_GETTER(int, DEVICE_POWER_TRANSITION_TO_ON);
1019 SWIG_CONSTANT_FROM_GETTER(int, DEVICE_POWER_TRANSITION_TO_STANDBY);
1020 SWIG_CONSTANT_FROM_GETTER(int, DEVICE_POWER_UNKNOWN);
1021#if 0
1022 void registerMonitor(Monitor* monitor);
1023 void unregisterMonitor(Monitor* monitor);
1024#endif
1025 }
1026}
1027#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...