XMBML Functions: Difference between revisions

From PS3 Developer wiki
Jump to navigation Jump to search
m (→‎xcb Functions: XCB acronym speculation)
(sections renamed)
Line 4: Line 4:
host functions enable you to see folders and files on the filesystem.
host functions enable you to see folders and files on the filesystem.


== no function: direct ==
== host://localhost/ ==


You can add direct paths to the filesystem.
No function, direct. Using direct paths to the filesystem. Usage example:
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/game"/></pre>
<pre><Query class="type:x-xmb/folder-pixmap" key="host_hdd0" src="host://localhost/dev_hdd0"/></pre>


Examples:
{| class="wikitable sortable"
{| class="wikitable sortable"
|+FileSystem Paths Examples
! Disk !! Example
|-
|-
! Disk !! Path !! Example
| All filesystem || host://localhost/
|-
|-
| All filesystem || / || host://localhost/
| PS3 HDD || host://localhost/dev_hdd0
|-
|-
| PS3 Disk || /dev_hdd0 || host://localhost/dev_hdd0
| USB Port 0 Disk || host://localhost/dev_usb000
|-
|-
| PS3 Disk (installed games directory) || /dev_hdd0/game || host://localhost/dev_hdd0/game
| USB Port 1 Disk || host://localhost/dev_usb001
|-
|-
| USB Port 0 Disk || /dev_usb000 || host://localhost/dev_usb000
| USB Port 2 Disk || host://localhost/dev_usb002
|-
| USB Port 3 Disk || host://localhost/dev_usb003
|-
| USB Port 4 Disk || host://localhost/dev_usb004
|-
| USB Port 5 Disk || host://localhost/dev_usb005
|-
| USB Port 6 Disk || host://localhost/dev_usb006
|-
| USB Port 7 Disk || host://localhost/dev_usb007
|-
|-
|}
|}


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


Querys the filesystem with parameters.
Querys the filesystem with parameters to filter or identify contents. Usage example:
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>
<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"
{| class="wikitable sortable"
|-
|+Parameters
! Description !! Parameter !! Examples
! Description !! Parameter !! Examples
|-
|-
Line 55: Line 60:
-->
-->


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


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


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>
<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"
{| class="wikitable sortable"
|-
|+Parameters
! Description !! Parameter !! Confirmed accepted values !! Example
! Description !! Parameter !! Confirmed accepted values !! Example
|-
|-
Line 80: Line 82:
|}
|}


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


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


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>
<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"
{| class="wikitable sortable"
|-
|+Parameters
! Description !! Parameter !! Confirmed accepted values !! Example
! Description !! Parameter !! Confirmed accepted values !! Example
|-
|-
Line 123: Line 122:
|}
|}


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


Unknown.
Unknown. Usage example:


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


{| class="wikitable sortable"
{| class="wikitable sortable"
|-
|+Parameters
! Description !! Parameter !! Confirmed accepted values !! Example
! Description !! Parameter !! Confirmed accepted values !! Example
|-
|-
Line 140: Line 136:
|}
|}


== Operators ==
= Operators =


{| class="wikitable sortable"
{| class="wikitable sortable"

Revision as of 06:51, 4 May 2013

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: 

<Query class="type:x-xmb/folder-pixmap" key="host_hdd0" src="host://localhost/dev_hdd0/game"/>
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
USB Port 4 Disk host://localhost/dev_usb004
USB Port 5 Disk host://localhost/dev_usb005
USB Port 6 Disk host://localhost/dev_usb006
USB Port 7 Disk host://localhost/dev_usb007

host://localhost/q?

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

<Query class="type:x-xmb/xmlpackagefolder" key="host_provider_usb0" src="host://localhost/q?path=/dev_usb000&suffix=.pkg&subclass=x-host/package" />
Parameters
Description Parameter Examples
path FileSystem Path (null)
path=/
path=/dev_hdd0/game
path=/dev_usb000
path=/dev_bdvd/PS3_CONTENT/THEMEDIR/D000
any other filesystem path
suffix Filter by extension? (null)
suffix=.*
suffix=.pkg
suffix=.P3T
any other extension?
subclass Subclass of the files (mimetype?) (null)
subclass=x-host/package
subclass=x-host/widget
subclass=x-host/directory
subclass=x-host/theme-content
subclass=x-host/mount-info (to confirm)
subclass=x-host/unknown (to confirm)
subclass=x-host/file (to confirm)

xcb Functions

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: 

<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"/>
Parameters
Description Parameter Confirmed accepted values Example
Positive or negative condition having on
off		 having=off
Main search table? table Table from XMB database tables table=MMS_MEDIA_TYPE_SYSTEM
Run function (from registory.xml variables) rquery (null)
Variables from registory.xml		 rquery=root.fixed_items.fah
Run function (from envirmont variables?) rqueryenv (null)
backup		 rqueryenv=backup
Search condition cond (null)
Combination of XMB database object fields using logical 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: 

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

xcb://localhost/raw?

Unknown. Usage example: 

<Query class="type:x-xmb/folder-pixmap" key="vmc_device_ms" src="xcb://localhost/raw?idlist=?????" />
Parameters
Description Parameter Confirmed accepted values Example
List of ids? idlist (null) idlist=?????

Operators

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
Retrieved from "http://www.psdevwiki.com/ps3/index.php?title=XMBML_Functions&oldid=20979"