Editing XMBML Functions

= Operators =
{{XMBML Operators}}

= host Functions =

host functions enable you to see folders and files on the filesystem.

== host://localhost/ ==

No function, direct. Using direct paths to the filesystem. Usage example:

<pre><Query class="type:x-xmb/folder-pixmap" key="host_hdd0" src="host://localhost/dev_hdd0/game"/></pre>

{| class="wikitable sortable"
|+FileSystem Paths Examples
! Disk !! Example
|-
| All filesystem || host://localhost/
|-
| PS3 HDD || host://localhost/dev_hdd0
|-
| USB Port 0 Disk || host://localhost/dev_usb000
|-
| USB Port 1 Disk || host://localhost/dev_usb001
|-
| USB Port 2 Disk || host://localhost/dev_usb002
|-
| USB Port 3 Disk || host://localhost/dev_usb003
|-
|}

*Only 4 usb storage devices can be mounted by the system at the same time, the usb device number is assigned dynamically (e.g: dev_usb089), there is no need to list all them

== host://localhost/q? ==

Querys the filesystem with parameters to filter or identify contents. Usage example:

<pre><Query class="type:x-xmb/xmlpackagefolder" key="host_provider_usb0" src="host://localhost/q?path=/dev_usb000&suffix=.pkg&subclass=x-host/package"/></pre>

{| class="wikitable sortable"
|+Parameters
! Description !! Parameter !! Examples
|-
| path || FileSystem Path || (null)<br/>path=/<br/>path=/dev_hdd0/game<br/>path=/dev_usb000<br/>path=/dev_bdvd/PS3_CONTENT/THEMEDIR/D000<br/>any other filesystem path
|-
| suffix || Filter by extension? || (null)<br/>suffix=.*<br/>suffix=.pkg<br/>suffix=.P3T<br/>any other extension?
|-
| subclass || Subclass of the files (mimetype?) || (null)<br/>subclass=x-host/package<br/>subclass=x-host/widget<br/>subclass=x-host/directory<br/>subclass=x-host/theme-content<br/>subclass=x-host/mount-info ''(to confirm)''<br/>subclass=x-host/unknown ''(to confirm)''<br/>subclass=x-host/file ''(to confirm)''
|-
|}

= xcb Functions =
XCB = XMB Content Browser ?

*Managed by dev_flash/vsh/module
**xcbcontentop.sprx
**xcbplugin1.sprx 

== xcb://localhost/exists? ==

Querys the database for Games, Music, Photos, Video, etc and if condition satisfaied (or not) go to selected xcb function. Usage example:

<pre><Query class="type:x-xmb/folder-pixmap" key="seg_folding_at_home" src="xcb://localhost/exists?having=off&rquery=root.fixed_items.fah&cond=Ae+Game:Common.dirPath /dev_hdd0/game+Ae+Game:Common.fileName NPIA00002"/></pre>

{| class="wikitable sortable"
|+Parameters
! Description !! Parameter !! Confirmed accepted values !! Example
|-
| Positive or negative condition || having || on<br />off || having=off
|-
| Main search table? || table || Table from [http://www.ps3devwiki.com/wiki/XMB_database#Tables XMB database tables] || table=MMS_MEDIA_TYPE_SYSTEM
|-
| Run function (from registory.xml variables) || rquery || (null)<br />Variables from registory.xml || rquery=root.fixed_items.fah
|-
| Run function (from envirmont variables?) || rqueryenv || (null)<br />backup || rqueryenv=backup
|-
| Search condition || cond || (null)<br />Combination of [http://www.ps3devwiki.com/wiki/XMB_database#Objects_and_fields XMB database object fields] using logical [[#Operators|operators]] || cond=Ae+StorageMedia:StorageMedia.stat.mediaStatus %xCB_MEDIA_INSERTED+Ae+StorageMedia:StorageMedia.deviceType %xCB_DEVICE_TYPE_CF
|-
|}

== xcb://localhost/query? ==

Querys the database for Games, Music, Photos, Video, etc and presents the returned items. Usage example:

<pre><Query class="type:x-xmb/folder-pixmap" key="vmc_device_ms" src="xcb://localhost/query?table=MMS_MEDIA_TYPE_SYSTEM&subclass=x-xcb/storagemedia-psv&sort=+StorageMedia:StorageMedia.sortOrder&genre=Game&cond=Ae+StorageMedia:StorageMedia.stat.mediaStatus %xCB_MEDIA_INSERTED+Ae+StorageMedia:StorageMedia.deviceType %xCB_DEVICE_TYPE_MS+AGL+StorageMedia:StorageMedia.type %xCB_MEDIA_TYPE_MS_STD %xCB_MEDIA_TYPE_MS_IOX+Ae+StorageMedia:StorageMedia.mediaFormat %xCB_MEDIA_FORMAT_DATA"/></pre>

{| class="wikitable sortable"
|+Parameters
! Description !! Parameter !! Confirmed accepted values !! Example
|-
| Returned items limit || limit || (null)<br />Numbers up to 2048? || limit=2048
|-
| Main search table? || table || Table from [http://www.ps3devwiki.com/wiki/XMB_database#Tables XMB database tables] || table=MMS_MEDIA_TYPE_SYSTEM
|-
| Filter by subclass? || subclass || (null)<br />x-xcb/unknown<br />x-xcb/game<br />x-xcb/game-disc<br />x-xcb/game-debug<br />x-xcb/game-list<br />x-xcb/content-disc<br />x-xcb/video<br />x-xcb/video-disctitle<br />x-xcb/video-file<br />x-xcb/video-list<br />x-xcb/video-content<br />x-xcb/editingvideo<br />x-xcb/photo<br />x-xcb/photo-list<br />x-xcb/music<br />x-xcb/music-list<br />x-xcb/segment<br />x-xcb/storage-media<br />x-xcb/storagemedia-generic<br />x-xcb/storagemedia-cdda<br />x-xcb/storagemedia-sacd<br />x-xcb/storagemedia-psmc<br />x-xcb/storagemedia-dlna<br />x-xcb/storagemedia-avchd<br />x-xcb/storagemedia-bdc<br />x-xcb/storagemedia-videodisc<br />x-xcb/storagemedia-sdps3<br />x-xcb/storagemedia-sdps2<br />x-xcb/storagemedia-sdpsp<br />x-xcb/storagemedia-psv<br />x-xcb/directory<br />x-xcb/directory-generic<br />x-xcb/directory-photo<br />x-xcb/directory-music<br />x-xcb/directory-video<br />x-xcb/directory-bddata<br />x-xcb/savedata-ps3<br />x-xcb/savedata-ps2<br />x-xcb/savedata-ps1<br />x-xcb/savedata-psp<br />x-xcb/savedata-plus<br />x-xcb/savedata-pspdir<br />x-xcb/achbase<br />x-xcb/achievtitle<br />x-xcb/achievgroup<br />x-xcb/achievflag<br />x-xcb/friendachievtitle<br />x-xcb/friendachievflag<br />x-xcb/friendachievgroup<br />x-xcb/person<br />x-xcb/playedplayer<br />x-xcb/blockedplayer<br />x-xcb/message<br />x-xcb/psv<br />x-xcb/vmc<br />x-xcb/query-condition || subclass=x-xcb/storagemedia-sdps2
|-
| Filter by genre? || genre || (null)<br />Photo<br />Game<br />Music<br />Video<br/>BdData || genre=Photo
|-
| Sorting || sort || (null)<br />Combination of [http://www.ps3devwiki.com/wiki/XMB_database#Objects_and_fields XMB database object fields] using sort operators:</br>+ ''[increasing]''<br/>- ''[decreasing]'' || sort=+StorageMedia:StorageMedia.sortOrder+StorageMedia :StorageMedia.timeInserted
|-
| Sorting (from registory.xml variables) || ssort || (null)<br />Variables from registory.xml || ssort=root.sort_selected.friend_named
|-
| Search condition || cond || (null)<br />Combination of [http://www.ps3devwiki.com/wiki/XMB_database#Objects_and_fields XMB database object fields] using logical [[#Operators|operators]] || cond=Ae+StorageMedia:StorageMedia.stat.mediaStatus %xCB_MEDIA_INSERTED+Ae+StorageMedia:StorageMedia.deviceType %xCB_DEVICE_TYPE_CF
|-
| Search condition (from registory.xml variables) || scond || (null)<br />Variables from registory.xml || scond=root.cond_selected.gamelist_format
|-
| ???????? || option || (null)<br />option_hybrid<br />option_plus || option=option_hybrid
|-
| ???????? || perm || (null)<br />1 || perm=1, perm=off
|-
| ???????? || attr ''(to confirm)'' || (null)<br />?????? || attr=PspSdDir:Common.title+PspSdDir:Common.fileName+PspSdDir:Common.titleForSort+PspSdDir:Common.size+PspSdDir:Common.timeCreatedUTC+PspSdDir:Common.dirPath
|-
| ???????? || trigger || (null)<br />off || trigger=off
|-
| ???????? || range || (null)<br />off<br/>only 0 1<br/>ahead 0 1024 || range=ahead 0 1024
|-
| ???????? || opt || (null)<br />parent<br/>logical<br/>shared || opt=parent
|-
|}

== xcb://localhost/raw? ==

Unknown. Usage example:

<pre><Query class="type:x-xmb/folder-pixmap" key="vmc_device_ms" src="xcb://localhost/raw?idlist=?????"/></pre>

{| class="wikitable sortable"
|+Parameters
! Description !! Parameter !! Confirmed accepted values !! Example
|-
| List of ids? || idlist || (null) || idlist=?????
|-
|}

= xmb Functions =

== xmb://localhost/ ==

Allows a direct link to a segment in other .xml file. Usage example with explicit complete path:

<pre><Query class="type:x-xmb/folder-pixmap" key="seg_photo_playlist" src="xmb://localhost/dev_flash/vsh/resource/explore/xmb/category_photo.xml#seg_playlist_mgmt"/></pre>

The same example but using the path shorcut '''%flash/''' (as a replacement of '''dev_flash/vsh/resource/explore/'''):

<pre><Query class="type:x-xmb/folder-pixmap" key="seg_photo_playlist" src="xmb://localhost/%flash/xmb/category_photo.xml#seg_playlist_mgmt"/></pre>

{| class="wikitable"
|+FileSystem Paths Examples
! Path !! Example !! notes
|-
| dev_flash/vsh/resource/explore/xmb/linked_file.xml || xmb://localhost/'''dev_flash/vsh/resource/explore/'''xmb/linked_file.xml#loaded_segment || 
|-
| dev_flash/vsh/resource/explore/xmb/linked_file.xml || xmb://localhost/'''%flash/'''xmb/linked_file.xml#loaded_segment || 
|-
| dev_hdd0/game/XMBMANPLS/USRDIR/xmbmp/game_settings.xml || xmb://localhost/dev_hdd0/game/XMBMANPLS/USRDIR/xmbmp/game_settings.xml#seg_settings || MXBM+ mod loads the main items from the installation folder of an app to allow an easy method to update the .xml files
|-
| dev_hdd0/xmlhost/game_plugin/fb.xml || xmb://localhost/dev_hdd0/xmlhost/game_plugin/fb.xml#seg_fb || Webman plugin XMB mod loads an .xml file to be able to update the list of games dinamically
|-
|}

= ese Functions =
ESE = acronym of ? ESE XML Schema ?

*Managed by dev_flash/vsh/module/
**esehttp.sprx
**eseibrd.sprx
**eseidle.sprx
**eselock.sprx

== ese://localhost/fixed? ==
Found inside explore_category_game.sprx

<pre>ese://localhost/fixed?type=dlctl</pre>

== ese://localhost/item? ==
Found inside explore_category_game.sprx

<pre>ese://localhost/item?id=</pre>

== ese://localhost/query? ==

<pre><Query class="type:x-xmb/folder-pixmap" key="seg_hdd_install" src="ese://localhost/query?type=install_game"/></pre>

{| class="wikitable"
|-
! Unknown !! Example
|-
| ? || ese://localhost/query?type=download_control
|-
| ? || ese://localhost/query?type=download_list
|-
| ? || ese://localhost/query?type=install_game
|-
| ? || ese://localhost/query?type=install_video
|-
| ? || ese://localhost/query?type=install_pkg
|-
|}

= sel Functions =
Selective functions, only available when satisfyed a condition, e.g: with screenshots the function '''sel://localhost/screenshot?category_photo.xml#seg_screenshot''' means: "when screenshot plugin is available... then load the segment #seg_screenshot" (screenshot plugin is enabled from the eboot of some games, and screenshot segment makes the icon visible in XMB photo column)

{| class="wikitable"
|-
! Parameter !! Valid values !! Example
|-
| type || game <br />minis <br />music <br />network <br />photo <br />psn <br />tv <br />video || sel://localhost/welcome?type=game
|-
| path || path to an .xml file#segment || sel://localhost/ingame?path=category_game.xml#seg_gameexit&type=game
|-
|}

== sel://localhost/avcroom? ==
Usage example:

<pre><Query class="type:x-xmb/folder-pixmap" key="seg_avcroom" src="sel://localhost/avcroom?category_friend.xml#seg_avcroom"/></pre>

== sel://localhost/currentuser?query? ==
Usage example:

<pre><Query class="type:x-xmb/folder-pixmap" key="Played" attr="Played" src="sel://localhost/currentuser?query?table=MMS_MEDIA_TYPE_HDD&sort=-PlayedPlayer:Common.timeCreated&cond=Aa+PlayedPlayer:Common.titleForSort+Ae+PlayedPlayer:Common.owner"/></pre>

== sel://localhost/dlnaconf? ==
Usage example:

<pre><Query class="type:x-xmb/folder-pixmap" key="seg_network_dlnaconf" src="sel://localhost/dlnaconf?category_sysconf.xml#seg_network_dlnaconf"/></pre>

== sel://localhost/env? ==
Found inside explore_category_game.sprx

== sel://localhost/ex? ==
Usage example:

<pre><Query class="type:x-xmb/folder-pixmap" key="gameDir2" attr="gameDir2" src="sel://localhost/ex?root.view_selected.game"/></pre>

== sel://localhost/fnregist? ==
Usage example:

<pre><Query class="type:x-xmb/folder-pixmap" key="seg_regist" src="sel://localhost/fnregist?"/></pre>

== sel://localhost/hakoniwa? ==
Hakoniwa is the "Photo Gallery" official app (NPIA00006) that comes partially preinstalled in the firmwares (there is a mandatory icon in XMB photo column and is dependant of hknw_plugin.sprx, but the program itself is not installed with the firmware). To use the program is needed to install the .PKG that installs the rest of the files in dev_hdd0/game/NPIA00006/USRDIR/EBOOT.PBP

Usage example:

<pre><Query class="type:x-xmb/folder-pixmap" key="seg_hakoniwa" src="sel://localhost/hakoniwa?category_photo.xml#seg_hakoniwa"/></pre>

== sel://localhost/hasbddata? ==
Usage example:

<pre><Query class="type:x-xmb/folder-pixmap" key="seg_bddata_mgmt" attr="seg_bddata_mgmt" src="sel://localhost/hasbddata?category_video.xml#seg_bddatamgmt"/></pre>

== sel://localhost/ingame? ==
Usage example:

<pre><Query class="type:x-xmb/folder-pixmap" key="seg_minis_manual" src="sel://localhost/ingame?path=category_game.xml#seg_minis_manual&type=minis"/></pre>

== sel://localhost/isdlna? ==
Usage example:

<pre><Query class="type:x-xmb/folder-pixmap" key="seg_dlna_scan" attr="seg_dlna_scan" src="sel://localhost/isdlna?category_photo.xml#seg_dlna_scan"/></pre>

== sel://localhost/ishantai? ==
Usage example:

<pre><Query class="type:x-xmb/folder-pixmap" key="seg_device_kbim_hantai" src="sel://localhost/ishantai?category_sysconf.xml#seg_device_kbim_hantai"/></pre>

== sel://localhost/iskana? ==
Usage example:

<pre><Query class="type:x-xmb/folder-pixmap" key="seg_device_kbim_kana" src="sel://localhost/iskana?category_sysconf.xml#seg_device_kbim_kana"/></pre>

== sel://localhost/ismegatv? ==
Found inside explore_category_game.sprx

== sel://localhost/ispremo? ==
Usage example:

<pre><Query class="type:x-xmb/folder-pixmap" key="seg_premo" src="sel://localhost/ispremo?file=category_network.xml&n=seg_premo"/></pre>

== sel://localhost/minis? ==
Usage example:

<pre><Query class="type:x-xmb/folder-pixmap" key="seg_sdpsp" src="sel://localhost/minis?category_game.xml#seg_sdpsp"/></pre>

== sel://localhost/newchat? ==
Usage example:

<pre><Query class="type:x-xmb/folder-pixmap" key="seg_new_chat" src="sel://localhost/newchat?category_friend.xml#seg_new_chat"/></pre>

== sel://localhost/nogold? ==
Usage example:

<pre><Query class="type:x-xmb/folder-pixmap" key="seg_plus" src="sel://localhost/nogold?category_psn.xml#seg_plus"/></pre>

== sel://localhost/nonpaccount? ==
Usage example:

<pre><Query class="type:x-xmb/folder-pixmap" key="seg_reg_quick" src="sel://localhost/nonpaccount?category_psn.xml#seg_reg_quick"/></pre>

== sel://localhost/nopremo? ==
Usage example:

<pre><Query class="type:x-xmb/folder-pixmap" key="seg_premo" src="sel://localhost/nopremo?category_network.xml#seg_premo"/></pre>

== sel://localhost/npaccount? ==
Usage example:

<pre><Query class="type:x-xmb/folder-pixmap" key="seg_message_box" src="sel://localhost/npaccount?category_friend.xml#seg_message_box"/></pre>

== sel://localhost/nplogin? ==
Usage example:

<pre><Query class="type:x-xmb/folder-pixmap" key="seg_fixed_items" src="sel://localhost/nplogin?category_friend.xml#seg_fixed_items"/></pre>

== sel://localhost/npnologin? ==
Found inside explore_category_game.sprx

== sel://localhost/ps2emusave? ==
Usage example:

<pre><Query class="type:x-xmb/folder-pixmap" key="seg_sdps2" src="sel://localhost/ps2emusave?category_game.xml#seg_sdps2"/></pre>

== sel://localhost/screenshot? ==
Usage example:

<pre><Query class="type:x-xmb/folder-pixmap" key="seg_screenshot" attr="seg_screenshot" src="sel://localhost/screenshot?category_photo.xml#seg_screenshot"/></pre>

== sel://localhost/videoedit? ==
Usage example:

<pre><Query class="type:x-xmb/folder-pixmap" key="seg_editingvideo_mgmt" attr="seg_editingvideo_mgmt" src="sel://localhost/videoedit?category_video.xml#seg_editingvideo_mgmt"/></pre>

== sel://localhost/welcome? ==
Usage example:

<pre><Query class="type:x-xmb/folder-pixmap" key="seg_welcome" attr="seg_welcome" src="sel://localhost/welcome?type=game"/></pre>

== sel://localhost/wenv? ==
Found inside explore_category_game.sprx

= xil Functions =
Acronym of... Xml? Index? List?

== xil://localhost/list? ==
Loads XIL information, in most cases this xil info is stored in a xil.xml configuration file (music, tv, and video uses xil files, but not game). Usage example:

<pre><Query class="type:x-xmb/folder-pixmap" key="seg_xil" attr="seg_xil" src="xil://localhost/list?t=music"/></pre>

{| class="wikitable"
|+FileSystem Paths Examples
! t= !! Linked to xil file in path: !! Example
|-
! music
| dev_hdd0/tmp/explore/xil/music/... xil.xml || xil://localhost/list?t=music
|-
! tv
| dev_hdd0/tmp/explore/xil/tv/... xil.xml || xil://localhost/list?t=tv
|-
! video
| dev_hdd0/tmp/explore/xil/video/... xil.xml || xil://localhost/list?t=video
|-
! game
| no xil.xml associated || xil://localhost/list?t=game
|-
|}

*Notes
**'''xil://localhost/list?t=game''' - Used for first time around firmware 4.40~4.46 in '''category_game.xml''', in the XMB item '''gameDir'''. In previous/older firmwares '''gameDir''' was using xcb://localhost/query? with a long list of operators to filter contents. In other words the old xcb query (usefull because was very open, but maybe not much efficient) has been replaced by a new xil function (maybe more efficient, but with the filtering operators hardcoded somewhere, and doesnt seems to be a xil.xml associated with it). As a note, the XMBM+ project (an unnofficial xml mod able to display games by groups by using custom filters) is based in the old method


== xil://localhost/item? ==
Found in explore_category_game.sprx

<pre>xil://localhost/item?x=%d&y=%u&t=%llx</pre>

{| class="wikitable"
|-
! ? !! ? !! ?
|-
! x
|  ||
|-
! y
|  ||
|-
! t
|  ||
|-
|}

= chat Functions =

== chat://localhost/player? ==
Found in explore_plugin.sprx

<pre>chat://localhost/player?id=</pre>

== chat://localhost/room? ==
Found in explore_plugin.sprx

<pre>chat://localhost/room?id=</pre>

== chat://localhost/roomlist? ==
Usage example:

<pre><Query class="type:x-xmb/folder-pixmap" key="seg_chat" src="chat://localhost/roomlist?"/></pre>

{| class="wikitable"
|-
! Unknown !! Example
|-
| ? || chat://localhost/roomlist?
|-
|}

= user Functions =

== user://localhost/create ==
Usage example:

<pre><Query class="type:x-xmb/folder-pixmap" key="user_provider_0" attr="user_provider_0" src="user://localhost/create"/></pre>

== user://localhost/others ==

== user://localhost/users ==
Usage example:

<pre><Query class="type:x-xmb/folder-pixmap" key="user_provider_1" attr="user_provider_1" src="user://localhost/users"/></pre>

= now Functions =

== now://localhost/q? ==
Usage example:

<pre><Query class="type:x-xmb/folder-pixmap" key="seg_now" src="now://localhost/q?id=XMB_MODULE_MUSIC&rquery=root.fixed_items.nowmusic"/></pre>

= rss Functions =

== rss:// ==
Usage example:

<pre><Query class="type:x-xmb/folder-pixmap" key="site_rss_2" attr="site_rss_2" src="rss://http://ps3.drikin.com/rss/sample.xml"/></pre>

= wboard Functions =

== wboard://localhost/item? ==
Usage example: (x and y axis ?)

<pre>wboard://localhost/item?x=%u&y=%u</pre>

== wboard://localhost/list? ==


{{System Firmware}}<noinclude>[[Category:Main]]</noinclude>