XMBML Functions: Difference between revisions

From PS3 Developer wiki
Jump to navigation Jump to search
(Blanked the page)
Line 1: Line 1:


= host Functions =
host functions enable you to see folders and files on the filesystem.
== no function: direct ==
You can add direct paths to the filesystem.
Depending on the Query class atribute, you can unlink (delete) files (type:x-xmb/folder-pixmap) or install package files (type:x-xmb/xmlpackagefolder).
Usage example:
<pre><Query class="type:x-xmb/folder-pixmap" key="host_hdd0" src="host://localhost/dev_hdd0"/></pre>
Examples:
{| class="wikitable sortable"
|-
! Disk !! Path !! Example
|-
| All filesystem || / || host://localhost/
|-
| PS3 Disk || /dev_hdd0 || host://localhost/dev_hdd0
|-
| PS3 Disk (installed games directory) || /dev_hdd0/game || host://localhost/dev_hdd0/game
|-
| USB Port 0 Disk || /dev_usb000 || host://localhost/dev_usb000
|-
|}
== q ==
Querys the filesystem with parameters.
Depending on the Query class atribute, you can unlink (delete) files (type:x-xmb/folder-pixmap) or install package files (type:x-xmb/xmlpackagefolder).
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>
=== Parameters ===
{| class="wikitable sortable"
|-
! 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 =
== 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>
=== Parameters ===
{| class="wikitable sortable"
|-
! 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
|-
|}
== 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>
=== Parameters ===
{| class="wikitable sortable"
|-
! 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-sdpsp<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
|-
| ???????? || 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
|-
|}
== raw ==
Unknown.
Usage example:
<pre><Query class="type:x-xmb/folder-pixmap" key="vmc_device_ms" src="xcb://localhost/raw?idlist=?????" /></pre>
=== Parameters ===
{| class="wikitable sortable"
|-
! Description !! Parameter !! Confirmed accepted values !! Example
|-
| List of ids? || idlist || (null) || idlist=?????
|-
|}
== Operators ==
{| class="wikitable sortable"
|-
! Operator !! Field !! Example
|-
| Ae || And equal || Ae+Game:Game.category GD
|-
| Oe || Or equal || Oe+Game:Game.category GD
|-
| An || And not equal || An+Game:Game.category GD
|-
| On || Or not equal || On+Game:Game.category GD
|-
| Aa || And exists || Aa+Game:Common.title
|-
| Oa || Or exists || Oa+Game:Common.title
|-
| Ai || ?????? || Ai+xCB:MusicList
|-
| Oi || ?????? || Oi+xCB:MusicList
|-
| Ap || And path? || Ap+Ps3SaveData:Common.dirPath %xUserHomeDir/savedata
|-
| Op || Or path? || Op+Ps3SaveData:Common.dirPath %xUserHomeDir/savedata
|-
| Al || And less than || Al+Game:Common.stat.rating 299
|-
| Ol || Or less than || Ol+Game:Common.stat.rating 299
|-
| AL || And less or equal than || AL+Game:Common.stat.rating 299
|-
| OL || Or less or equal than || OL+Game:Common.stat.rating 299
|-
| AG || And greater or equal than || AG+Game:Common.stat.rating 299
|-
| OG || Or greater or equal than || OG+Game:Common.stat.rating 299
|-
| Ag || And greater than || Ag+Game:Common.stat.rating 299
|-
| Og || Or greater than || Og+Game:Common.stat.rating 299
|-
| Agl || And greater than and less than || Agl+Person:Person.stat.presence 2 6
|-
| Ogl || Or greater than and less than || Ogl+Person:Person.stat.presence 2 6
|-
| AGl || And greater or equal than and less than || AGl+Person:Person.stat.presence 2 6
|-
| OGl || Or greater or equal than and less than || OGl+Person:Person.stat.presence 2 6
|-
| AgL || And greater than and less or equal than || AgL+Person:Person.stat.presence 2 6
|-
| OgL || Or greater than and less or equal than || OgL+Person:Person.stat.presence 2 6
|-
| AGL || And greater or equal than and less or equal than || AGL+Person:Person.stat.presence 2 6
|-
| OGL || Or greater or equal than and less or equal than || OGL+Person:Person.stat.presence 2 6
|-
|}

Revision as of 18:38, 23 February 2012

Retrieved from "http://www.psdevwiki.com/ps3/index.php?title=XMBML_Functions&oldid=10401"