XMBML Functions: Difference between revisions
Jump to navigation
Jump to search
m (→Parameters) |
|||
| 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. | |||
You can unlink (delete) files with this. | |||
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. | |||
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 | |||
|- | |||
| suffix || Filter by extension? || null<br/>suffix=.*<br/>suffix=.pkg | |||
|- | |||
| subclass || Subclass of the files (mimetype?) || null<br/>subclass=x-host/package<br/>subclass=x-host/widget<br/>subclass=x-host/directory | |||
|- | |||
|} | |||
= xcb Functions = | = xcb Functions = | ||
Revision as of 20:57, 18 February 2012
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. You can unlink (delete) files with this.
Usage example:
<Query class="type:x-xmb/folder-pixmap" key="host_hdd0" src="host://localhost/dev_hdd0"/>
Examples:
| 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.
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 |
| suffix | Filter by extension? | null suffix=.* suffix=.pkg |
| subclass | Subclass of the files (mimetype?) | null subclass=x-host/package subclass=x-host/widget subclass=x-host/directory |
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:
<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 |
| Run function (from registory.xml variables) | rquery | (null) Variables from registory.xml |
rquery=root.fixed_items.fah |
| Search condition | cond | (null) Any combination of #Objects_and_fields Any combination of #Operators |
. |
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 | (null) MMS_MEDIA_TYPE_SYSTEM MMS_MEDIA_TYPE_HDD MMS_MEDIA_TYPE_PLUS MMS_MEDIA_TYPE_PS3_BD [OFW 1.10] MMS_MEDIA_TYPE_PS3_DVD [OFW 1.10] MMS_MEDIA_TYPE_PS2_DVD [OFW 1.10] MMS_MEDIA_TYPE_PS2_CD [OFW 1.10] MMS_MEDIA_TYPE_PS1_CD [OFW 1.10] |
table=MMS_MEDIA_TYPE_SYSTEM |
| Filter by subclass? | subclass | (null) x-xcb/storagemedia-sdps2 x-xcb/storagemedia-sdps3 x-xcb/storagemedia-sdpsp x-xcb/storagemedia-dspsp [OFW 1.10] x-xcb/storagemedia-psv x-xcb/storagemedia-psmc x-xcb/storagemedia-bdc x-xcb/friendachievgroup x-xcb/savedata-plus x-xcb/friendachievflag |
subclass=x-xcb/storagemedia-sdps2 |
| Filter by genre? | genre | (null) Photo Game Music Video |
genre=Photo |
| Sorting | sort | (null) Any combination of #Objects_and_fields 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) Any combination of #Objects_and_fields Operators: Any combination of #Operators |
cond=Ae+StorageMedia:StorageMedia.stat.mediaStatus %xCB_MEDIA_INSERTED+Ae+StorageMedia:StorageMedia.d eviceType %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 |
opt=option_hybrid |
| ???????? | perm | (null) 1 |
perm=1 |
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 (to confirm) | On+Game:Game.category GD |
| Aa | And exists (to confirm) | Aa+Game:Common.title |
| Oa | Or exists (to confirm) | Oa+Game:Common.title |
| Ap | And path? (to confirm) | Ap+Ps3SaveData:Common.dirPath %xUserHomeDir/savedata |
| Op | Or path? (to confirm) | Op+Ps3SaveData:Common.dirPath %xUserHomeDir/savedata |
| AL | And less than | AL+Game:Common.stat.rating 299 |
| OL | Or less than (to confirm) | OL+Game:Common.stat.rating 299 |
| AG | And greater than | AG+Game:Common.stat.rating 299 |
| OG | Or greater than (to confirm) | 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 |
Objects and fields
StorageMedia
| Object | Field | Confirmed accepted values |
|---|---|---|
| StorageMedia | StorageMedia:StorageMedia.sortOrder | (null) |
| StorageMedia | StorageMedia:StorageMedia.timeInserted | (null) |
| StorageMedia | StorageMedia:StorageMedia.reserved24 | (null) |
| StorageMedia | StorageMedia:StorageMedia.mediaFormat | (null) %xCB_MEDIA_FORMAT_DATA %xCB_MEDIA_FORMAT_PS3GAME_BD %xCB_MEDIA_FORMAT_PS3GAME_DVD %xCB_MEDIA_FORMAT_PS3CONTENT_BD %xCB_MEDIA_FORMAT_PS3CONTENT_DVD %xCB_MEDIA_FORMAT_PS1GAME_CD %xCB_MEDIA_FORMAT_BDMV %xCB_MEDIA_FORMAT_BDAV %xCB_MEDIA_FORMAT_AVCHD %xCB_MEDIA_FORMAT_DVD_VIDEO %xCB_MEDIA_FORMAT_DVDPVR |
| StorageMedia | StorageMedia:StorageMedia.type | (null) %xCB_MEDIA_TYPE_BDROM %xCB_MEDIA_TYPE_DVDROM %xCB_MEDIA_TYPE_DVDPRW %xCB_MEDIA_TYPE_DVDMR %xCB_MEDIA_TYPE_CDROM %xCB_MEDIA_TYPE_CDMRW %xCB_MEDIA_TYPE_MS_STD %xCB_MEDIA_TYPE_MS_R %xCB_MEDIA_TYPE_MS_IOX %xCB_MEDIA_TYPE_SD %xCB_MEDIA_TYPE_CF %xCB_MEDIA_TYPE_PS3_BD %xCB_MEDIA_TYPE_PS3_DVD %xCB_MEDIA_TYPE_PS2MC %xCB_MEDIA_TYPE_PS1MC %xCB_MEDIA_TYPE_PS1_CD %xCB_MEDIA_TYPE_PDA %xCB_MEDIA_TYPE_DLNA %xCB_MEDIA_TYPE_WM %xCB_MEDIA_TYPE_SACD %xCB_MEDIA_TYPE_CDDA %xCB_MEDIA_TYPE_DSD %xCB_MEDIA_TYPE_AAD [OFW 1.10] |
| StorageMedia | StorageMedia:StorageMedia.deviceType | (null) %xCB_DEVICE_TYPE_USBPSP %xCB_DEVICE_TYPE_USBAAD %xCB_DEVICE_TYPE_USBAADWM %xCB_DEVICE_TYPE_USBWM %xCB_DEVICE_TYPE_USBMASS %xCB_DEVICE_TYPE_USBCAMERA %xCB_DEVICE_TYPE_MS %xCB_DEVICE_TYPE_SD %xCB_DEVICE_TYPE_C %xCB_DEVICE_TYPE_ETHER |
| StorageMedia | StorageMedia:StorageMedia.hybrid | (null) HYBRID |
| StorageMedia | StorageMedia:StorageMedia.sortOrder | (null) |
| StorageMedia | StorageMedia:StorageMedia.audio.channelType | (null) |
| StorageMedia | StorageMedia:StorageMedia.stat.version | (null) |
| StorageMedia | StorageMedia:StorageMedia.stat.mediaStatus | (null) %xCB_MEDIA_INSERTED |
| StorageMedia | StorageMedia:Common.stat.timeImported | (null) |
| StorageMedia | StorageMedia:Common.titleForSort | (null) |
| StorageMedia | StorageMedia:Common.fileName | (null) EX_GAME THEMEDIR EX_VIDEO VIDEODIR (any file or dir name?) |
Game
| Object | Field | Confirmed accepted values |
|---|---|---|
| Game | Game:Game.gameCategory | (null) |
| Game | Game:Game.bootable [OFW 1.10] | (null) 0 1 |
| Game | Game:Game.titleId [OFW 1.10] | (null) NPUP00030 (any other game ID?) |
| Game | Game:Game.category | (null) 1P (Game - PS1 Game) 2P (Game - PS2 Game) 2D (Game - PS2 Emulator Data) AM (Music, ex: Qriocity Music Unlimited) AP (Photo, ex: Play Memories) AT (TV, ex: QOOK TV, Now TV) AV (Video, ex: Netflix, LoveFilm) BV (Video, ??????) CB (Network, ex: Life with Playstation, Folding@home) GD (Game - Game Data) HM (Music, ??????) HG (Game - HDD Game) MN? (Game - PSP Mini Game) PP (Game - PSP Game?) SD? (Game - Game Save Data) VF (??????) WT (??????) |
| Game | Game:Common.dirPath | (null) /dev_hdd0/game |
| Game | Game:Common.fileName | (null) SCEAPPS01 SCEAPPS02 SCEAPPS03 NPIA00002 (Folding@home) NPIA00005 (Playstation home) (any other game ID?) |
| Game | Game:Common.stat.timeLastUsed | (null) |
| Game | Game:Common.timeCreated | (null) |
| Game | Game:Common.title | (null) |
| Game | Game:Common.titleForSort | (null) |
| Game | Game:Common.stat.rating | (null) 299 300 (any other number?) |
GameList
| Object | Field | Confirmed accepted values |
|---|---|---|
| GameList | GameList:Common.titleForSort | (null) 2000 4000 |
| GameList | GameList:GameList.type | (null) %xCB_LIST_TYPE_PSPSAVEDATA_TITLE %xCB_LIST_TYPE_PS3SAVEDATA_TITLE %xCB_LIST_TYPE_GAME_TAGS %xCB_LIST_TYPE_GAME_FORMAT |
| GameList | GameList:Common.owner | (null) %xUserId |
Photo
| Object | Field | Confirmed accepted values |
|---|---|---|
| Photo | Photo:Common.titleForSort | (null) |
| Photo | Photo:Common.timeCreated | (null) |
| Photo | Photo:Common.size | (null) |
| Photo | Photo:Common.stat.contentsStatus [OFW 1.10] | (null) %xCB_CONTENT_STATUS_AVAILABLE |
| Photo | Photo:Common.stat.timeImported [OFW 1.10] | (null) |
| Photo | Photo:Common.stat.timeImportedTicks | (null) |
| Photo | Photo:Photo.codec | (null) |
PhotoList
| Object | Field | Confirmed accepted values |
|---|---|---|
| PhotoList | PhotoList:Common.titleForSort | (null) |
| PhotoList | PhotoList:PhotoList.type | (null) %xCB_LIST_TYPE_PHOTO_ALBUM_MONTH %xCB_LIST_TYPE_PHOTO_ALBUM_YEAR %xCB_LIST_TYPE_PHOTO_TAGS |
Music
| Object | Field | Confirmed accepted values |
|---|---|---|
| Music | Music:Common.titleForSort | (null) |
| Music | Music:Common.reserved1 | (null) |
| Music | Music:Common.stat.timeImported [OFW 1.10] | (null) |
| Music | Music:Common.stat.timeImportedTicks | (null) |
| Music | Music:Music.codec | (null) |
| Music | Music:MusicServed.trackNumber | (null) |
| Music | Music:MusicServed.discNumber | (null) |
| Music | Music:MusicServed.listTitleForSort | (null) |
| Music | Music:MusicServed.playerForSort | (null) |
| Music | Music:MusicServed.genreForSort | (null) |
MusicList
| Object | Field | Confirmed accepted values |
|---|---|---|
| MusicList | MusicList:Common.titleForSort | (null) |
| MusicList | MusicList:MusicList.type | (null) %xCB_LIST_TYPE_MUSIC_ALBUM %xCB_LIST_TYPE_MUSIC_PLAYLIST_ARTIST %xCB_LIST_TYPE_MUSIC_PLAYLIST_GENRE %xCB_LIST_TYPE_MUSIC_TRACKNAME_INITIAL %xCB_LIST_TYPE_MUSIC_RELEASEDYEAR |
| MusicList | MusicList:MusicListServed.genreForSort | (null) |
| MusicList | MusicList:MusicListServed.playerForSort | (null) |
Video
| Object | Field | Confirmed accepted values |
|---|---|---|
| Video | Video:Common.titleForSort | (null) |
| Video | Video:Common.size | (null) |
| Video | Video:Common.stat.timeImported [OFW 1.10] | (null) |
| Video | Video:Common.stat.timeImportedTicks | (null) |
| Video | Video:Video.videoCodec | (null) |
VideoList
| Object | Field | Confirmed accepted values |
|---|---|---|
| VideoList | VideoList:Common.titleForSort | (null) |
| VideoList | VideoList:VideoList.type | (null) %xCB_LIST_TYPE_VIDEO_TITLE_INITIAL %xCB_LIST_TYPE_VIDEO_IMPORTEDMONTH %xCB_LIST_TYPE_VIDEO_TAGS |
AchievTitle
| Object | Field | Confirmed accepted values |
|---|---|---|
| AchievTitle | AchievTitle:Common.dirPath | (null) %xUserHomeDir/trophy |
| AchievTitle | AchievTitle:Common.fileName | (null) |
| AchievTitle | AchievTitle:Common.titleForSort | (null) |
| AchievTitle | AchievTitle:Common.timeModified | (null) |
| AchievTitle | AchievTitle:AchievTitle.timeLastUnlocked | (null) |
| AchievTitle | AchievTitle:AchievTitle.ex.timeLastUpdate | (null) |
| AchievTitle | AchievTitle:AchievTitle.ex.timeLastUnlocked | (null) |
AchievFlag
| Object | Field | Confirmed accepted values |
|---|---|---|
| AchievFlag | AchievFlag:Common.fileName | (null) |
| AchievFlag | AchievFlag:Common.titleForSort | (null) |
| AchievFlag | AchievFlag:Common.fileName | (null) |
| AchievFlag | AchievFlag:AchievFlag.flagId | (null) |
| AchievFlag | AchievFlag:AchievFlag.flagType | (null) |
| AchievFlag | AchievFlag:AchievFlag.timeUnlocked | (null) |
| AchievFlag | AchievFlag:AchievFlag.reserved0 | (null) |
| AchievFlag | AchievFlag:AchievFlag.reserved3 | (null) |
| AchievFlag | AchievFlag:AchievFlag.reserved4 | (null) |
| AchievFlag | AchievFlag:AchievFlag.ex.timeUnlocked | (null) |
Ps3SaveData
| Object | Field | Confirmed accepted values |
|---|---|---|
| Ps3SaveData | Ps3SaveData:Common.title [OFW 1.10] | (null) |
| Ps3SaveData | Ps3SaveData:Common.titleForSort | (null) |
| Ps3SaveData | Ps3SaveData:Common.dirPath | (null) %xUserHomeDir/savedata |
| Ps3SaveData | Ps3SaveData:Common.owner | (null) %xUserId |
| Ps3SaveData | Ps3SaveData:Ps3SaveData.timeModified | (null) |
| Ps3SaveData | Ps3SaveData:Ps3SaveData.subTitle | (null) |
| Ps3SaveData | Ps3SaveData:Ps3SaveData.broken | (null) |
Ps2SaveData
| Object | Field | Confirmed accepted values |
|---|---|---|
| Ps2SaveData | Ps2SaveData:Common.titleForSort | (null) |
| Ps2SaveData | Ps2SaveData:Ps2.timeModified | (null) |
| Ps2SaveData | Ps2SaveData:Ps2.timeModified | (null) |
PspSaveData
| Object | Field | Confirmed accepted values |
|---|---|---|
| PspSaveData | PspSaveData:Common.titleForSort | (null) |
| PspSaveData | PspSaveData:Common.dirPath | (null) %xUserHomeDir/minis_savedata |
| PspSaveData | PspSaveData:Common.owner | (null) %xUserId |
| PspSaveData | PspSaveData:PspSaveData.timeModified | (null) |
| PspSaveData | PspSaveData:PspSaveData.sdTitle | (null) |
| PspSaveData | PspSaveData:PspSaveData.broken | (null) |
Person
| Object | Field | Confirmed accepted values |
|---|---|---|
| Person | Person:Common.titleForSort | (null) |
| Person | Person:Common.stat.status | (null) 2 3 4 5 6 2 5 |
| Person | Person:Common.stat.timeLastUsed | (null) |
| Person | Person:Person.reserved20 | (null) |
| Person | Person:Person.stat.presence | (null) 2 6 |
BlockedPlayer
| Object | Field | Confirmed accepted values |
|---|---|---|
| BlockedPlayer | BlockedPlayer:Common.titleForSort | (null) |
| BlockedPlayer | BlockedPlayer:Common.owner | (null) %xUserId |
PlayedPlayer
| Object | Field | Confirmed accepted values |
|---|---|---|
| PlayedPlayer | PlayedPlayer:Common.timeCreated | (null) |
| PlayedPlayer | PlayedPlayer:Common.titleForSort | (null) |
| PlayedPlayer | PlayedPlayer:Common.owner | (null) %xUserId |
Vmc
| Object | Field | Confirmed accepted values |
|---|---|---|
| Vmc | Vmc:Common.timeCreated [OFW 1.10] | (null) |
| Vmc | Vmc:Common.timeCreatedUTC | (null) |
| Vmc | Vmc:Common.titleForSort | (null) |
| Vmc | Vmc:Common.title | (null) |
| Vmc | Vmc:Vmc.type | (null) |