Kodi Documentation 18.0
Kodi is an open source media player and entertainment hub.
XBMCAddon::xbmc Namespace Reference

Classes

class  InfoTagMusic
 
class  InfoTagRadioRDS
 
class  InfoTagVideo
 
class  Keyboard
 
class  Monitor
 
class  Player
 
class  PlayList
 
class  RenderCapture
 

Typedefs

typedef Alternative< String, const PlayList * > PlayParameter
 

Functions

 XBMCCOMMONS_STANDARD_EXCEPTION (KeyboardException)
 
void log (const char *msg, int level)
 
void shutdown ()
 
void restart ()
 
void executescript (const char *script)
 
void executebuiltin (const char *function, bool wait)
 
String executeJSONRPC (const char *jsonrpccommand)
 
void sleep (long timemillis)
 
String getLocalizedString (int id)
 
String getSkinDir ()
 
String getLanguage (int format, bool region)
 
String getIPAddress ()
 
long getDVDState ()
 
long getFreeMem ()
 
String getInfoLabel (const char *cLine)
 
String getInfoImage (const char *infotag)
 
void playSFX (const char *filename, bool useCached)
 
void stopSFX ()
 
void enableNavSounds (bool yesNo)
 
bool getCondVisibility (const char *condition)
 
int getGlobalIdleTime ()
 
String getCacheThumbName (const String &path)
 
String makeLegalFilename (const String &filename, bool fatX)
 
String translatePath (const String &path)
 
Tuple< String, StringgetCleanMovieTitle (const String &path, bool usefoldername)
 
String validatePath (const String &path)
 
String getRegion (const char *id)
 
String getSupportedMedia (const char *mediaType)
 
bool skinHasImage (const char *image)
 
bool startServer (int iTyp, bool bStart, bool bWait)
 
void audioSuspend ()
 
void audioResume ()
 
String convertLanguage (const char *language, int format)
 
String getUserAgent ()
 
int getSERVER_WEBSERVER ()
 
int getSERVER_AIRPLAYSERVER ()
 
int getSERVER_UPNPSERVER ()
 
int getSERVER_UPNPRENDERER ()
 
int getSERVER_EVENTSERVER ()
 
int getSERVER_JSONRPCSERVER ()
 
int getSERVER_ZEROCONF ()
 
int getPLAYLIST_MUSIC ()
 
int getPLAYLIST_VIDEO ()
 
int getTRAY_OPEN ()
 
int getDRIVE_NOT_READY ()
 
int getTRAY_CLOSED_NO_MEDIA ()
 
int getTRAY_CLOSED_MEDIA_PRESENT ()
 
int getLOGDEBUG ()
 
int getLOGINFO ()
 
int getLOGNOTICE ()
 
int getLOGWARNING ()
 
int getLOGERROR ()
 
int getLOGSEVERE ()
 
int getLOGFATAL ()
 
int getLOGNONE ()
 
int getISO_639_1 ()
 
int getISO_639_2 ()
 
int getENGLISH_NAME ()
 
 XBMCCOMMONS_STANDARD_EXCEPTION (PlayerException)
 
 XBMCCOMMONS_STANDARD_EXCEPTION (PlayListException)
 
 XBMCCOMMONS_STANDARD_EXCEPTION (RenderCaptureException)
 

Variables

const int lLOGDEBUG = LOGDEBUG
 

Typedef Documentation

◆ PlayParameter

Function Documentation

◆ audioResume()

void XBMCAddon::xbmc::audioResume ( )

◆ audioSuspend()

void XBMCAddon::xbmc::audioSuspend ( )

◆ convertLanguage()

String XBMCAddon::xbmc::convertLanguage ( const char *  language,
int  format 
)

◆ enableNavSounds()

void XBMCAddon::xbmc::enableNavSounds ( bool  yesNo)

◆ executebuiltin()

void XBMCAddon::xbmc::executebuiltin ( const char *  function,
bool  wait 
)

◆ executeJSONRPC()

String XBMCAddon::xbmc::executeJSONRPC ( const char *  jsonrpccommand)

◆ executescript()

void XBMCAddon::xbmc::executescript ( const char *  script)

◆ getCacheThumbName()

String XBMCAddon::xbmc::getCacheThumbName ( const String path)

◆ getCleanMovieTitle()

Tuple< String, String > XBMCAddon::xbmc::getCleanMovieTitle ( const String path,
bool  usefoldername 
)

◆ getCondVisibility()

bool XBMCAddon::xbmc::getCondVisibility ( const char *  condition)

◆ getDRIVE_NOT_READY()

int XBMCAddon::xbmc::getDRIVE_NOT_READY ( )

◆ getDVDState()

long XBMCAddon::xbmc::getDVDState ( )

◆ getENGLISH_NAME()

int XBMCAddon::xbmc::getENGLISH_NAME ( )

◆ getFreeMem()

long XBMCAddon::xbmc::getFreeMem ( )

◆ getGlobalIdleTime()

int XBMCAddon::xbmc::getGlobalIdleTime ( )

◆ getInfoImage()

String XBMCAddon::xbmc::getInfoImage ( const char *  infotag)

◆ getInfoLabel()

String XBMCAddon::xbmc::getInfoLabel ( const char *  cLine)

◆ getIPAddress()

String XBMCAddon::xbmc::getIPAddress ( )

◆ getISO_639_1()

int XBMCAddon::xbmc::getISO_639_1 ( )

◆ getISO_639_2()

int XBMCAddon::xbmc::getISO_639_2 ( )

◆ getLanguage()

String XBMCAddon::xbmc::getLanguage ( int  format,
bool  region 
)

◆ getLocalizedString()

String XBMCAddon::xbmc::getLocalizedString ( int  id)

◆ getLOGDEBUG()

int XBMCAddon::xbmc::getLOGDEBUG ( )

◆ getLOGERROR()

int XBMCAddon::xbmc::getLOGERROR ( )

◆ getLOGFATAL()

int XBMCAddon::xbmc::getLOGFATAL ( )

◆ getLOGINFO()

int XBMCAddon::xbmc::getLOGINFO ( )

◆ getLOGNONE()

int XBMCAddon::xbmc::getLOGNONE ( )

◆ getLOGNOTICE()

int XBMCAddon::xbmc::getLOGNOTICE ( )

◆ getLOGSEVERE()

int XBMCAddon::xbmc::getLOGSEVERE ( )

◆ getLOGWARNING()

int XBMCAddon::xbmc::getLOGWARNING ( )

◆ getPLAYLIST_MUSIC()

int XBMCAddon::xbmc::getPLAYLIST_MUSIC ( )

◆ getPLAYLIST_VIDEO()

int XBMCAddon::xbmc::getPLAYLIST_VIDEO ( )

◆ getRegion()

String XBMCAddon::xbmc::getRegion ( const char *  id)

◆ getSERVER_AIRPLAYSERVER()

int XBMCAddon::xbmc::getSERVER_AIRPLAYSERVER ( )

◆ getSERVER_EVENTSERVER()

int XBMCAddon::xbmc::getSERVER_EVENTSERVER ( )

◆ getSERVER_JSONRPCSERVER()

int XBMCAddon::xbmc::getSERVER_JSONRPCSERVER ( )

◆ getSERVER_UPNPRENDERER()

int XBMCAddon::xbmc::getSERVER_UPNPRENDERER ( )

◆ getSERVER_UPNPSERVER()

int XBMCAddon::xbmc::getSERVER_UPNPSERVER ( )

◆ getSERVER_WEBSERVER()

int XBMCAddon::xbmc::getSERVER_WEBSERVER ( )

◆ getSERVER_ZEROCONF()

int XBMCAddon::xbmc::getSERVER_ZEROCONF ( )

◆ getSkinDir()

String XBMCAddon::xbmc::getSkinDir ( )

◆ getSupportedMedia()

String XBMCAddon::xbmc::getSupportedMedia ( const char *  mediaType)
Todo:
Add a mediaType enum
Todo:
implement

◆ getTRAY_CLOSED_MEDIA_PRESENT()

int XBMCAddon::xbmc::getTRAY_CLOSED_MEDIA_PRESENT ( )

◆ getTRAY_CLOSED_NO_MEDIA()

int XBMCAddon::xbmc::getTRAY_CLOSED_NO_MEDIA ( )

◆ getTRAY_OPEN()

int XBMCAddon::xbmc::getTRAY_OPEN ( )

◆ getUserAgent()

String XBMCAddon::xbmc::getUserAgent ( )

◆ log()

void XBMCAddon::xbmc::log ( const char *  msg,
int  level 
)

◆ makeLegalFilename()

String XBMCAddon::xbmc::makeLegalFilename ( const String filename,
bool  fatX 
)

◆ playSFX()

void XBMCAddon::xbmc::playSFX ( const char *  filename,
bool  useCached 
)

◆ restart()

void XBMCAddon::xbmc::restart ( )

◆ shutdown()

void XBMCAddon::xbmc::shutdown ( )

◆ skinHasImage()

bool XBMCAddon::xbmc::skinHasImage ( const char *  image)

◆ sleep()

void XBMCAddon::xbmc::sleep ( long  timemillis)

◆ startServer()

bool XBMCAddon::xbmc::startServer ( int  iTyp,
bool  bStart,
bool  bWait 
)

◆ stopSFX()

void XBMCAddon::xbmc::stopSFX ( )

◆ translatePath()

String XBMCAddon::xbmc::translatePath ( const String path)

◆ validatePath()

String XBMCAddon::xbmc::validatePath ( const String path)

◆ XBMCCOMMONS_STANDARD_EXCEPTION() [1/4]

XBMCAddon::xbmc::XBMCCOMMONS_STANDARD_EXCEPTION ( KeyboardException  )

◆ XBMCCOMMONS_STANDARD_EXCEPTION() [2/4]

XBMCAddon::xbmc::XBMCCOMMONS_STANDARD_EXCEPTION ( PlayerException  )

◆ XBMCCOMMONS_STANDARD_EXCEPTION() [3/4]

XBMCAddon::xbmc::XBMCCOMMONS_STANDARD_EXCEPTION ( PlayListException  )

◆ XBMCCOMMONS_STANDARD_EXCEPTION() [4/4]

XBMCAddon::xbmc::XBMCCOMMONS_STANDARD_EXCEPTION ( RenderCaptureException  )

Variable Documentation

◆ lLOGDEBUG

const int XBMCAddon::xbmc::lLOGDEBUG = LOGDEBUG