Difference between revisions of "List of built-in functions"

From Official Kodi Wiki
Jump to: navigation, search
(added XBMC.LastFM.Love and Ban)
Line 160: Line 160:
 
| class="usercell" | XBMC.LastFM.Ban
 
| class="usercell" | XBMC.LastFM.Ban
 
| class="usercell" | Only songs that are playing on last.fm radio can be banned, optional parameter (false) = direct banning without confirmationdialog.
 
| class="usercell" | Only songs that are playing on last.fm radio can be banned, optional parameter (false) = direct banning without confirmationdialog.
 
+
|-class="userrow"
 +
| class="usercell" | Container.SetViewMode(id)
 +
| class="usercell" | Set the current view mode (list, icons etc.) to the given container id.
 +
|-class="userrow"
 +
| class="usercell" | Container.NextViewMode
 +
| class="usercell" | Select the next view mode.
 +
|-class="userrow"
 +
| class="usercell" | Container.PreviousViewMode
 +
| class="usercell" | Select the previous view mode.
 
[[category:Skin Development]]
 
[[category:Skin Development]]
 
[[category:Inner Workings]]
 
[[category:Inner Workings]]
 
[[category:Python]]
 
[[category:Python]]
 
[[category:Skin Development]]
 
[[category:Skin Development]]

Revision as of 08:14, 9 December 2007

An up to date list of built-in functions can be found in the function CUtil::ExecBuiltIn() in the source code file xbmc/Util.cpp.

In addition to the following list, for most <onclick> and <onfocus> button actions in the skin you can also use the functions from Keymap.xml.
Example:
<onclick>VolumeUp</onclick>
<onclick>VolumeDown</onclick>

You can use parameters with all media windows, as can be seen here:


XBMC.Reboot Cold reboots the xbox (power cycle)
XBMC.Restart Cold reboots the xbox (power cycle)
XBMC.ShutDown Turns off the xbox
XBMC.Dashboard

Runs the dashboard, as specified in the GUI Settings

XBMC.RestartApp Restarts XBMC
XBMC.Credits Runs the Credits
XBMC.Reset Warm reboots the xbox
XBMC.ActivateWindow(window,dir)

Opens the given window. The parameter window can either be the window's id, or in the case of a standard window, the window's name. See here for a list of window names, and their respective ids. If, furthermore, the window is Music, Video, Pictures, or Program files, then the dir parameter specifies which folder XBMC should default to once the window is opened. This must be a <source> as specified in Sources.xml, or a subfolder of a valid source. Lastly, the special command XBMC.ActivateWindow(MyFiles,autodetection) opens the filemanager with the autodetected xbox in the left hand pane.

XBMC.ReplaceWindow(window,dir) Replaces the current window with the given window. This is the same as ActivateWindow() but it doesn't update the window history list, so when you go back from the new window it will not return to the previous window, rather will return to the previous window's previous window.
XBMC.RunScript(script[,args]*) Runs the python script. You must specify the full path to the script, or use Q:\Scripts\Scriptname.py. As of 2007/02/24, all extra parameters are passed to the script as arguments and can be accessed by python using sys.argv
XBMC.RunXBE(xbe) Runs the xbe. Full path must be specified.
XBMC.PlayMedia(media) Plays the media. This can be a playlist, music, or video file or an Url.
XBMC.SlideShow(dir) Starts a slideshow of pictures in the folder dir.
XBMC.RecursiveSlideShow(dir) Starts a recursive slideshow (including any images in subfolders) of the folder dir.
XBMC.ReloadSkin() Reloads the current skin – useful for skinners to use after they upload modified skin files (saves power cycling).
XBMC.PlayerControl(command) Allows control of music and videos. The command may be one of Play, Stop, Forward, Rewind, Next, Previous, BigSkipForward, BigSkipBackward, SmallSkipForward, SmallSkipBackward, Random, Repeat, RepeatOne, RepeatAll, RepeatOff, Partymode(music) or Partymode(video), and Record. Play will either pause, resume, or stop ffwding or rewinding. Random toggles random playback, Repeat cycles through the repeat modes, Partymode(music/video) toggles the appropriate partymode, defaults to music if no parameter is given. Record will work to record shoutcast streams (only?).
XBMC.EjectTray() Either opens or closes the DVD tray, depending on it's current state.
XBMC.AlarmClock(name,command,time) Pops up a dialog asking for the length of time for the alarm (unless the parameter time is specified), and starts a timer. When the timer runs out, it'll execute the built-in command (the parameter command) if it is specified, otherwise it'll pop up an alarm notice.
XBMC.CancelAlarm(name) Cancel a running alarm.
XBMC.Notification(header,message[,time,image]) Will display a notification dialog with the specified header and messag, in addition you can set the length of time it displays and a icon image.
XBMC.PlayDVD Will play the inserted CD or DVD media from the DVD-ROM drive.
Skin.SetBool(setting)

Sets the skin setting “setting” to true, for use with the conditional visibility tags containing Skin.HasSetting(setting). The settings are saved per-skin in settings.xml just like all the other XBMC settings.

Skin.ToggleSetting(setting)

Toggles the skin setting “setting” for use with conditional visibility tags containing Skin.HasSetting(setting).

Skin.SetString(string[,value])

Pops up a keyboard dialog and allows the user to input a string which can be used in a label control else where in the skin via the info tag Skin.String(string). If the value parameter is specified, then the keyboard dialog does not pop up, and the string is set directly.

Skin.SetImage(string[,value])

Pops up a file browser and allows the user to select an image file off the xbox harddisk to be used in an image control else where in the skin via the info tag Skin.String(string). If the value parameter is specified, then the file browser dialog does not pop up, and the image path is set directly.

Skin.SetPath(string[,value])

Pops up a folder browser and allows the user to select a folder of images off the xbox harddisk to be used in a multi image control else where in the skin via the info tag Skin.String(string). If the value parameter is specified, then the file browser dialog does not pop up, and the path is set directly.

Skin.SetFile(string,mask,folderpath)

Pops up a folder browser and allows the user to select a file off the xbox harddisk to be used else where in the skin via the info tag Skin.String(string). If the mask parameter is specified, then the file browser will only search for the extension specified (.avi,.mp3,.m3u,.png,.bmp,etc.,etc.). If the folderpath parameter is set the file browser will start in that folder.

Skin.theme

Cycles the skin theme. Skin.theme(-1) will go backwards.

SetFocus(id)

Will make the control with the id specified in the command gain focus.

Skin.Reset(setting) Resets the skin setting “setting”. If “setting” is a bool setting (ie set via SetBool or ToggleSetting) then the setting is reset to false. If “setting” is a string (Set via SetString, SetImage, or SetPath) then it is set to empty.
Skin.ResetSettings Resets all the above skin settings to their defaults (toggles all set to false, strings all set to empty.)
XBMC.Takescreenshot Takes a Screenshot.
XBMC.SetVolume(percent) Sets the volume to the percentage specified.
XBMC.Mute Mutes (or unmutes) the volume.
XBMC.Extract Extracts a specified archive to an optionally specified path. ! REQUIRES ABSOLUTE PATHS !
Dialog.Close(dialog[,force]) Close a dialog. Set force to true to bypass animations.
System.LogOff Log off current user.
XBMC.BackupSystemInfo Creates bios, eeprom, systeminformation backup to /system/systeminfo/
XBMC.System.PWMControl() RGB PWM Control for SmartXX v3 and OPX.

XBMC.system.pwmcontrol(#ColorA,#ColorB,action,xTime)

  1. ColorA & ColorB: #rrggbb-> from #000000 up to #FFFFFF [e.g. #FF0000 is Red, ##FFC0CB is Pink..]
  2. xTime: in msec, 0=off min.=1 max.=no max limit
  3. action:
  1. "fade": will fade only once in xTime, from ColorA to ColorB! A->B
  2. "fadeloop": will fade in loop in xTime, from ColorA to ColorB! A->B, A->B, A->B
  3. "faderepeat": will repeat fade (ping-pong) in xTime steps, from ColorA to ColorB. A<->B
  4. "blink": will blink from ColorA to ColorB in xTime. A-B-A-B-A-B
  5. "switch": will switch only once from ColorA to ColorB in xTime
  6. "none" or EMPTY: Switch to a Color! Alternate use: XBMC.system.pwmcontrol(#Color)
XBMC.updatelibrary(database) Takes either "video" or "music" as a parameter to begin updating the corresponding database.
XBMC.LastFM.Love All songs that can be submitted to Last.fm can be loved, optional parameter (false) = direct loving without confirmationdialog.
XBMC.LastFM.Ban Only songs that are playing on last.fm radio can be banned, optional parameter (false) = direct banning without confirmationdialog.
Container.SetViewMode(id) Set the current view mode (list, icons etc.) to the given container id.
Container.NextViewMode Select the next view mode.
Container.PreviousViewMode Select the previous view mode.