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

Classes

class  Actor
 
class  AudioStreamDetail
 
class  InfoTagGame
 
class  InfoTagMusic
 
class  InfoTagPicture
 
class  InfoTagRadioRDS
 
class  InfoTagVideo
 
class  Keyboard
 
class  Monitor
 
class  Player
 
class  PlayList
 
class  RenderCapture
 
class  SubtitleStreamDetail
 
class  VideoStreamDetail
 

Typedefs

typedef Alternative< String, const PlayList *> PlayParameter
 

Functions

 XBMCCOMMONS_STANDARD_EXCEPTION (KeyboardException)
 
void log (const char *msg, int level)
 
void shutdown ()
 { xbmc.shutdown() } Shutdown the htpc. More...
 
void restart ()
 { xbmc.restart() } Restart the htpc. More...
 
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 ()
 { xbmc.getSkinDir() } Get the active skin directory. More...
 
String getLanguage (int format, bool region)
 
String getIPAddress ()
 { xbmc.getIPAddress() } Get the current ip address. More...
 
long getDVDState ()
 { xbmc.getDVDState() } Returns the dvd state as an integer. More...
 
long getFreeMem ()
 { xbmc.getFreeMem() } Get amount of free memory in MB. More...
 
String getInfoLabel (const char *cLine)
 
String getInfoImage (const char *infotag)
 
void playSFX (const char *filename, bool useCached)
 
void stopSFX ()
 { xbmc.stopSFX() } Stops wav file More...
 
void enableNavSounds (bool yesNo)
 
bool getCondVisibility (const char *condition)
 
int getGlobalIdleTime ()
 { xbmc.getGlobalIdleTime() } Get the elapsed idle time in seconds. More...
 
String getCacheThumbName (const String &path)
 
Tuple< String, StringgetCleanMovieTitle (const String &path, bool usefoldername)
 
String getRegion (const char *id)
 
String getSupportedMedia (const char *mediaType)
 
bool skinHasImage (const char *image)
 
bool startServer (int iTyp, bool bStart)
 
void audioSuspend ()
 { xbmc.audioSuspend() } Suspend Audio engine. More...
 
void audioResume ()
 { xbmc.audioResume() } Resume Audio engine. More...
 
String convertLanguage (const char *language, int format)
 
String getUserAgent ()
 { xbmc.getUserAgent() } More...
 
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 getLOGWARNING ()
 
int getLOGERROR ()
 
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

◆ 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 ( )

◆ getENGLISH_NAME()

int XBMCAddon::xbmc::getENGLISH_NAME ( )

◆ getInfoImage()

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

◆ getInfoLabel()

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

◆ 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 ( )

◆ 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 ( )

◆ 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 ( )

◆ log()

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

◆ playSFX()

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

◆ skinHasImage()

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

◆ sleep()

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

◆ startServer()

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

◆ XBMCCOMMONS_STANDARD_EXCEPTION() [1/4]

XBMCAddon::xbmc::XBMCCOMMONS_STANDARD_EXCEPTION ( PlayListException  )

◆ XBMCCOMMONS_STANDARD_EXCEPTION() [2/4]

XBMCAddon::xbmc::XBMCCOMMONS_STANDARD_EXCEPTION ( RenderCaptureException  )

◆ XBMCCOMMONS_STANDARD_EXCEPTION() [3/4]

XBMCAddon::xbmc::XBMCCOMMONS_STANDARD_EXCEPTION ( KeyboardException  )

◆ XBMCCOMMONS_STANDARD_EXCEPTION() [4/4]

XBMCAddon::xbmc::XBMCCOMMONS_STANDARD_EXCEPTION ( PlayerException  )

Variable Documentation

◆ lLOGDEBUG

const int XBMCAddon::xbmc::lLOGDEBUG = LOGDEBUG