Talk:List of built-in functions: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
m (a little more tweaking and it looks fine now. easy to read/understand and immediately recognisable)
m (not needed anymore)
 
Line 1: Line 1:
== List of functions ==


{| class="wikitable" border="1"
! style="color:#000000; background-color:#DBDBDB" |'''Functions'''
! style="color:#000000; background-color:#DBDBDB" | '''Description'''
! style="color:#000000; background-color:#DBDBDB; width: 135px"| '''XBMC Version'''
|-
| Help
| This help message
|
|-
| Reboot
| Cold reboots the system (power cycle)
|
|-
| ShutDown
| Trigger default Shutdown action defined in System Settings
|
|-
| Powerdown
| Powerdown system
|
|-
| Quit
| Quits XBMC
|
|-
| Hibernate
| Hibernate (S4) the System
|
|-
| Suspend
| Suspends (S3 / S1 depending on bios setting) the System
|
|-{{frodo row}}
| InhibitIdleShutdown(true/false)
| Prevent the system to shutdown on idle.
| '''[[:Category:Frodo feature|Frodo v12 Feature]]'''
|-{{frodo row}}
| AllowIdleShutdown
| Allow the system to shutdown on idle.
| '''[[:Category:Frodo feature|Frodo v12 Feature]]'''
|-{{gotham row}}
| ActivateScreensaver
| Starts the screensaver
| '''[[:Category:Gotham feature|Gotham v13 Feature]]'''
|-
| RestartApp
| Restarts XBMC (not implemented under Win32)
|
|-
| Minimize
| Minimizes XBMC
|
|-
| Reset
| Reset the system (same as reboot)
|
|-
| Mastermode
| Runs XBMC in master mode
|
|- {{gotham row}}
| SetGUILanguage
| Set GUI Language
| '''[[:Category:Gotham feature|Gotham v13 Feature]]'''
|-
| ActivateWindow(window[,dir,return])
| 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. [[Window IDs|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 optional 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. For some windows (MusicLibrary and VideoLibrary), the return parameter may be specified, which indicates that XBMC should use this folder as the "root" of the level, and thus the "parent directory" action from within this folder will return the user to where they were prior to the window activating.
|
|-{{frodo row}}
| ActivateWindowAndFocus(id1, id2,item1, id3,item2)
| Activate window with id1, first focus control id2 and then focus control id3. if either of the controls is a container, you can specify which item to focus (else, set it to 0).
| '''[[:Category:Frodo feature|Frodo v12 Feature]]'''
|-
| 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.
|
|-{{gotham row}}
| ReplaceWindowAndFocus(id1, id2,item1, id3,item2)
| Replace window with id1, first focus control id2 and then focus control id3.  if either of the controls is a container, you can specify which item to focus (else, set it to 0).
| '''[[:Category:Gotham feature|Gotham v13 Feature]]'''
|-
| TakeScreenshot
| Takes a Screenshot
|
|-
| RunScript(script[,args]*)
| Runs the python script. You must specify the full path to the script. If the script is an add-on, you can also execute it using its add-on id. As of 2007/02/24, all extra parameters are passed to the script as arguments and can be accessed by python using sys.argv
|
|-{{frodo row}}
| StopScript(id)
| Stop the script by ID or path, if running
| '''[[:Category:Frodo feature|Frodo v12 Feature]]'''
|-
| RunAppleScript(script[,args]*)
| Run the specified AppleScript command
|
|-
| RunPlugin(plugin)
| Runs the plugin. Full path must be specified. Does not work for folder plugins
|
|-
| RunAddon(id)
| Runs the specified plugin/script
|
|-{{gotham row}}
| NotifyAll
| Notify all connected clients
| '''[[:Category:Gotham feature|Gotham v13 Feature]]'''
|-
| Extract
| Extracts a specified archive to an optionally specified path. <font color="red">! REQUIRES ABSOLUTE PATHS !</font>
|
|-
| PlayMedia(media[,isdir][,1],[playoffset=xx])
| Plays the media. This can be a playlist, music, or video file, directory, plugin or an Url. The optional parameter ",isdir" can be used for playing a directory. ",1" will start a video in a preview window, instead of fullscreen. If media is a playlist, you can use playoffset=xx where xx is the position to start playback from.
|
|-
| SlideShow(dir [,recursive, [not]random])
| Starts a slideshow of pictures in the folder dir.  Optional parameters are "recursive", and "random" or "notrandom" parameters.  The "recursive" parameter starts a recursive slideshow, adding images from sub-folders.  The "random" and "notrandom" parameters override the Randomize setting found in the pictures media window.
|
|-
| RecursiveSlideShow(dir)
| Run a slideshow from the specified directory, including all subdirs
|
|-
| ReloadSkin()
| Reloads the current skin – useful for Skinners to use after they upload modified skin files (saves power cycling)
|
|-
| UnloadSkin()
| Unloads the current skin
|
|-
| RefreshRSS
| Reload RSS feeds from RSSFeeds.xml
|
|-
| 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, RandomOn, RandomOff, Repeat, RepeatOne, RepeatAll, RepeatOff, Partymode(music) or Partymode(video) or Partymode(path to .xsp file), and Record. Play will either pause, resume, or stop ffwding or rewinding.  Random toggles random playback and Repeat cycles through the repeat modes (these both take an optional second parameter, Notify, that notifies the user of the new state). Partymode(music/video) toggles the appropriate partymode, defaults to music if no parameter is given, besides the default music or video partymode you can also pass a path to a custom smartplaylist (.xsp) as parameter.
|
|-
| Playlist.PlayOffset
| Start playing from a particular offset in the playlist
|
|-
| Playlist.Clear
| Clear the current playlist
|
|-
| EjectTray()
| Either opens or closes the DVD tray, depending on its current state
|
|-
| AlarmClock(name,command,time[,silent,loop])
| 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 <span class="nobr">built-in</span> command (the parameter command) if it is specified, otherwise it'll pop up an alarm notice. Add silent to hide the alarm notification. Add loop for the alarm to execute the command each time the specified time interval expires.
|
|-
| CancelAlarm(name[,silent])
| Cancel a running alarm. Set silent to true to hide the alarm notification.
|
|-
| Action
| Executes an action for the active window (same as in keymap)
|
|-
| Notification(header,message[,time,image])
| Will display a notification dialog with the specified header and message, in addition you can set the length of time it displays in milliseconds and a icon image.
|
|-
| PlayDVD
| Will play the inserted CD or DVD media from the <span class="nobr">DVD-ROM</span> drive.
|
|-
| RipCD
| Will rip the inserted CD from the <span class="nobr">DVD-ROM</span> drive.
|
|-
| Skin.ToggleSetting(setting)
| Toggles the skin setting ?setting? for use with [[Conditional Visibility|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 elsewhere in the skin via the [[InfoLabels|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.SetNumeric(numeric[,value])
| Pops up a keyboard dialog and allows the user to input a numerical.
|
|-
| Skin.SetPath(string[,value])
| Pops up a folder browser and allows the user to select a folder of images  to be used in a multi image control else where in the skin via the [[InfoLabels|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.Theme
| Cycles the skin theme. Skin.theme(-1) will go backwards.
|
|-
| Skin.SetImage(string[,value])
| Pops up a file browser and allows the user to select an image file to be used in an image control elsewhere in the skin via the [[InfoLabels|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.SetLargeImage(string[,value])
| Pops up a file browser and allows the user to select an large image file to be used in an image control else where in the skin via the [[InfoLabels|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.SetFile(string,mask,folderpath)
| Pops up a folder browser and allows the user to select a file off the hard-disk to be used else where in the skin via the [[InfoLabels|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.). To use multiple extensions separate them using "|" minus quotes. If the folderpath parameter is set the file browser will start in that folder.
|
|-
| Skin.SetAddon(string,type)
| Pops up a select dialog and allows the user to select an add-on of the given type to be used elsewhere in the skin via the info tag Skin.String(string). The most common types are ''xbmc.addon.video'', ''xbmc.addon.audio'', ''xbmc.addon.image'' and ''xbmc.addon.executable''.
|
|-
| Skin.SetBool(setting)
| Sets the skin setting ?setting? to true, for use with the [[Conditional Visibility|conditional visibility tags]] containing Skin.HasSetting(setting). The settings are saved <span class="nobr">per-skin</span> in settings.xml just like all the other XBMC settings.
|
|-
| Skin.Reset(setting)
| Resets the skin setting ?setting?. If ?setting? is a bool setting (i.e. 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.)
|
|-
| Mute
| Mutes (or unmutes) the volume.
|
|-
| SetVolume(percent[,showvolumebar])
| Sets the volume to the percentage specified. Optionally, show the Volume Dialog in XBMC when setting the volume.
|
|-
| Dialog.Close(dialog[,force])
| Close a dialog. Set force to true to bypass animations. Use (all,true) to close all opened dialogs at once.
|
|-
| System.LogOff
| Log off current user.
|
|-
| System.Exec
| Execute shell commands.
|
|-
| System.ExecWait
| Execute shell commands and freezes XBMC until shell is closed.
|
|-
| Resolution
| Change XBMC's Resolution.
|
|-
| SetFocus(id,position)
| Will make a list with the "id" specified in the command gain focus at "position" number in its list. Alias SetFocus(id,position)
|
|-
| UpdateLibrary(database,[path])
| Takes either "video" or "music" as a parameter to begin updating the corresponding database. For "video" you can additionally specify a specific path to be scanned.
|
|-
| CleanLibrary(database)
| This funtion will perform a number of 'cleanup' tasks on your video database and can be run if you have moved, deleted or renamed files. Takes either "video" or "music" as a parameter to begin cleaning the corresponding database.
|
|-
| exportlibrary(music,false,filepath)
| The music library will be exported to a single file stored at filepath location.
|
|-
| exportlibrary(video,true,thumbs,overwrite,actorthumbs)
| The video library is exported to multiple files with the given options. Here thumbs, overwrite and actorthumbs are boolean values (true or false).
|
|-
| PageDown
| Send a page down event to the pagecontrol with given id.
|
|-
| PageUp
| Send a page up event to the pagecontrol with given id.
|
|-{{rem row}}
| <s>LastFM.Love</s>
| <s>All songs that can be submitted to Last.fm can be loved, optional parameter (false) = direct loving without confirmationdialog.</s> (removed in Gotham)
| '''[[:Category:Gotham feature|Gotham v13 Removal]]'''
|-{{rem row}}
| <s>LastFM.Ban</s>
| <s>Only songs that are playing on last.fm radio can be banned, optional parameter (false) = direct banning without confirmationdialog.</s> (removed in Gotham)
| '''[[:Category:Gotham feature|Gotham v13 Removal]]'''
|-
| Container.Refresh
| Refresh current listing.
|
|-
| Container.Update
| Update current listing. Send Container.Update(path,replace) to reset the path history.
|
|-
| Container.NextViewMode
| Select the next view mode.
|
|-
| Container.PreviousViewMode
| Select the previous view mode.
|
|-
| Container.SetViewMode(id)
| Set the current view mode (list, icons etc.) to the given container id.
|
|-
| Container.NextSortMethod
| Change to the next sort method.
|
|-
| Container.PreviousSortMethod
| Change to the previous sort method.
|
|-
| Container.SetSortMethod
| Change to the specified sort method.
|
|-
| Container.SortDirection
| Toggle the sort direction.
|
|-
| Control.Move(id,offset)
| Will make a Container with the "id" specified in the command move focus by "offset".
|
|-
| Control.SetFocus(id,position)
| Will make a list with the "id" specified in the command gain focus at "position" number in its list. Alias SetFocus(id,position)
|
|-
| Control.Message(id,message,[windowid])
| Sends a given message to a control in a given window (or active window if omitted). Messages can be movedown, moveup, pagedown, pageup, click.
|
|-
| SendClick(windowid,id)
| Sends a click to a control in a given window (or active window if omitted).
|
|-
| LoadProfile(profilename,[prompt])
| Load the specified profile. If prompt is not specified, and a password would be required for the requested profile, this command will silently fail. If promp' is specified and a password is required, a password dialog will be shown.
|
|-
| SetProperty(key,value[,id])
| Sets a window property for the current window (key,value), or the specified window (key,value,id).
|
|-
| ClearProperty(key[,id])
| Clears a window property for the current focused window/dialog(key), or the specified window (key,id).
|
|-
| PlayWith()
| Play the selected item with the specified player core.
|
|-
| WakeOnLan(mac)
| Sends the wake-up packet to the broadcast address for the specified MAC address (Format: FF:FF:FF:FF:FF:FF or FF-FF-FF-FF-FF-FF).
|
|-{{rem row}}
| <s>LCD.Suspend</s>
| <s>Suspends LCDproc.</s> (removed in Gotham)
| '''[[:Category:Gotham feature|Gotham v13 Removal]]'''
|-{{rem row}}
| <s>LCD.Resume</s>
|<s>Resumes LCDproc.</s> (removed in Gotham)
| '''[[:Category:Gotham feature|Gotham v13 Removal]]'''
|-
| Addon.Default.OpenSettings
| Open a settings dialog for the default addon of the given type
|
|-
| Addon.Default.Set
| Open a select dialog to allow choosing the default addon of the given type
|
|-
| Addon.OpenSettings(id)
| Open a settings dialog for the addon of the given id
|
|-
| UpdateAddonRepos
| Triggers a forced update of enabled add-on repositories.
|
|-
| UpdateLocalAddons
| Triggers a scan of local add-on directories.
|
|-
| ToggleDPMS
| Toggle DPMS mode manually
|
|-{{gotham row}}
| CECToggleState
| Toggle state of playing device via a CEC peripheral
| '''[[:Category:Gotham feature|Gotham v13 Feature]]'''
|-{{gotham row}}
| CECActivateSource
| Wake up playing device via a CEC peripheral
| '''[[:Category:Gotham feature|Gotham v13 Feature]]'''
|-{{gotham row}}
| CECStandby
| Put playing device on standby via a CEC peripheral
| '''[[:Category:Gotham feature|Gotham v13 Feature]]'''
|-
| Weather.Refresh
| Force weather data refresh
|
|-
| Weather.LocationNext
| Switch to next weather location
|
|-
| Weather.LocationPrevious
| Switch to previous weather location
|
|-
| Weather.LocationSet
| Switch to given weather location (parameter can be 1-3)
|
|-
| LIRC.Stop
| Removes XBMC as a LIRC client.
|
|-
| LIRC.Start
| Adds XBMC as a LIRC client.
|
|-
| LIRC.Send(command)
| Sends a command to LIRC, syntax is the lirc protocol without the newline.<br />Example: LIRC.Send(SEND_ONCE Onkyo_RC-453S2 volup)
|
|-
| VideoLibrary.Search
| Brings up a search dialog which will search the library
|
|-{{frodo row}}
| ToggleDebug
| Enables/disables debug mode
| '''[[:Category:Frodo feature|Frodo v12 Feature]]'''
|-{{frodo row}}
| StartPVRManager
| (Re)Starts the PVR manager
| '''[[:Category:Frodo feature|Frodo v12 Feature]]'''
|-{{frodo row}}
| StopPVRManager
| Stops the PVR manager
| '''[[:Category:Frodo feature|Frodo v12 Feature]]'''
|-{{gotham row}}
| StartAndroidActivity
(package,[intent,dataType,dataURI])
| Launch an Android native app with the given package name.  Optional parms (in order): intent, dataType, dataURI.
| '''[[:Category:Gotham feature|Gotham v13 Feature]]'''
|-{{gotham row}}
| SetStereoMode
| Changes the stereo mode of the GUI. Params can be: toggle, next, previous, select, tomono or any of the supported stereomodes (off, split_vertical, split_horizontal, row_interleaved, hardware_based, anaglyph_cyan_red, anaglyph_green_magenta, monoscopic)
| '''[[:Category:Gotham feature|Gotham v13 Feature]]'''
|}
<section end="main content" />
[[Category:Python]]
[[Category:Addon Development]]
[[Category:Skin Development]]

Latest revision as of 14:54, 19 February 2014

Retrieved from "https://kodi.wiki/index.php?title=Talk:List_of_built-in_functions&oldid=69287"