Recordings-ui.xml
(Difference between revisions)
(→The "watchrecordings" window) |
(→The "watchrecordings" window) |
||
| Line 429: | Line 429: | ||
| align="center" | statetype | | align="center" | statetype | ||
| A statetype to display if the item is being commflagged/processed. Values are ''yes'' and ''no''. | | A statetype to display if the item is being commflagged/processed. Values are ''yes'' and ''no''. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| align="center" | No | | align="center" | No | ||
|- | |- | ||
| Line 465: | Line 455: | ||
| style="background:darkturquoise" | The number of items in the selected recording group | | style="background:darkturquoise" | The number of items in the selected recording group | ||
| style="background:darkturquoise" align="center" | No | | style="background:darkturquoise" align="center" | No | ||
| + | !- | ||
| + | | usedbar | ||
| + | | align="center" | progressbar | ||
| + | | An progress bar to display free space. | ||
| + | | align="center" | No | ||
| + | |- | ||
| + | | style="background:darkturquoise" | freereport | ||
| + | | style="background:darkturquoise" align="center" | textarea | ||
| + | | style="background:darkturquoise" | A report of the free space on all recording Storage Groups | ||
| + | | style="background:darkturquoise" align="center" | No | ||
| + | |- | ||
| + | | diskspacetotal | ||
| + | | align="center" | textarea | ||
| + | | Total disk space for recordings | ||
| + | | align="center" | No | ||
| + | |- | ||
| + | | style="background:darkturquoise" | diskspaceused | ||
| + | | style="background:darkturquoise" align="center" | textarea | ||
| + | | style="background:darkturquoise" | Disk space used by recordings | ||
| + | | style="background:darkturquoise" align="center" | No | ||
| + | |- | ||
| + | | diskspacefree | ||
| + | | align="center" | textarea | ||
| + | | Disk space free for recordings | ||
| + | | align="center" | No | ||
| + | |- | ||
| + | | style="background:darkturquoise" | diskspacepercentused | ||
| + | | style="background:darkturquoise" align="center" | textarea | ||
| + | | style="background:darkturquoise" | Disk space used by recordings as a percentage | ||
| + | | style="background:darkturquoise" align="center" | No | ||
| + | |- | ||
| + | | diskspacepercentfree | ||
| + | | align="center" | textarea | ||
| + | | Disk space free for recordings as a percentage | ||
| + | | align="center" | No | ||
|} | |} | ||
Revision as of 12:26, 21 February 2012
The recordings-ui.xml file governs the layout and behavior of the Watch Recordings screen and associated screens. It consists of the following windows and named attributes:
Contents |
Recording UI Windows
| Window Name | Type | Description |
| watchrecordings | Window | The Watch Recordings screen. |
| groupfilter | Window | The Group Filter popup. |
| changeview | Window | The Change View popup. |
| passwordchanger | Window | The Password Change popup. |
| groupselector | Window | The Group selector popup. |
| iconhelp | Window | The Help popup. |
| editmetadata | Window | The Edit Recording Title/Subtitle popup. |
Generic Attributes Used in most windows
Note: The following widgets can be used in almost any of the schedule-ui.xml and recordings-ui.xml views. In addition, all textual elements can be combined however the themer likes using the <template> element. To combine the title, year, and description into a single textarea, the theme author might use a template like:
<template>%TITLE% (%YEAR&) - %DESCRIPTION%</template>
| Widget Name | Widget Type | Description | Required? |
| title | textarea | The title of the item. | N |
| subtitle | textarea | The subtitle of the item. | N |
| titlesubtitle | textarea | The title and subtitle of the item. | N |
| description | textarea | The description/plot of the item. | N |
| category | textarea | The category of the item. | N |
| callsign | textarea | The callsign of the item's channel. | N |
| commfree | textarea | The commercial free status of the item's channel. | N |
| outputfilters | textarea | The playback output filters of the item's channel. | N |
| starttime | textarea | The start time of the item in the user-specified format. | N |
| startdate | textarea | The start date of the item in the user-specified format. | N |
| endtime | textarea | The end time of the item in the user-specified format. | N |
| enddate | textarea | The end date of the item in the user-specified format. | N |
| recstarttime | textarea | The recording start time of the item in the user-specified format. | N |
| recstartdate | textarea | The recording end date of the item in the user-specified format. | N |
| recendtime | textarea | The recording end time of the item in the user-specified format. | N |
| recenddate | textarea | The recording end date of the item in the user-specified format. | N |
| lastmodifiedtime | textarea | The last modified time of the item in the user-specified format. | N |
| lastmodifieddate | textarea | The last modified date of the item in the user-specified format. | N |
| lastmodified | textarea | The last modified time and date of the item in the user-specified format. | N |
| channum | textarea | The channel number on which the item was recorded. | N |
| chanid | textarea | The internal myth channel ID on which the item was recorded. | N |
| channel | textarea | The combined channel number/name string. | N |
| longchannel | textarea | The full plain english channel name/number string. | N |
| iconpath | textarea | The path to the icon file for the channel on which the item was recorded. | N |
| filesize | textarea | The file size of the item in bytes. | N |
| filesize_str | textarea | A "plain english" filesize of the item (in MB/GB/etc.) | N |
| lenmins | textarea | The length of the item in minutes. | N |
| lentime | textarea | The length of the item in hours. | N |
| rectypechar | textarea | The recording type of the item, single character. | N |
| rectype | textarea | The recording type of the item as a string. | N |
| rectypestatus | textarea | A string value for the status of an upcoming recording. | N |
| card | textarea | The card upon which an item will record. | N |
| recpriority | textarea | The recording priority of an item. | N |
| recgroup | textarea | The recording group of an item. | N |
| playgroup | textarea | The playback group of an item. | N |
| storagegroup | textarea | The storage group of an item. | N |
| timedate | textarea | The "date, starttime-endtime" of an item. | N |
| shorttimedate | textarea | The short version of the "date, starttime-endtime" of an item. | N |
| shortstarttimedate | textarea | The short "date starttime" of an item. | N |
| recstatus | textarea | The recording status of an item. | N |
| repeat | textarea | The short repeat status of an item. (Repeat) | N |
| longrepeat | textarea | The long string repeat status of an item. (Repeat Sun July 17, 2010) | N |
| seriesid | textarea | The grabber-assigned Series ID of an item. | N |
| programid | textarea | The grabber assigned Program ID of an item. | N |
| catType | textarea | The category Type of an item. | N |
| year | textarea | The year of release of an item. | N |
| stars | textarea | The stars value in text of an item. (4 Stars) | N |
| yearstars | textarea | The year and star values of an item. (1996, 5 stars) | N |
| originalairdate | textarea | The original air date of an item. | N |
| shortoriginalairdate | textarea | The short original air date of an item. | N |
| ratingstate | statetype | A statetype for the rating of the item. Types are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, and 10. | N |
| season | textarea | The Season number of an item. | N |
| episode | textarea | The episode number of an item. | N |
| s00e00 | textarea | The season and episode in s01e01 format. | N |
| 00x00 | textarea | The season and episode in 1x01 format. | N |
| inetref | textarea | The TMDB/TVDB-style Inetref for an item. | N |
The "watchrecordings" window
| Widget Name | Widget Type | Description | Required? | |||||
| groups | buttonlist | A buttonlist for the recording groups/genres/etc. Valid textareas are name and reccount | Yes | |||||
| recordings | buttonlist | A buttonlist for the recording items. | Yes | |||||
| recGroups | buttonlist | A buttonlist for Recording Groups. | No | |||||
| norecordings | textarea | A textarea to display if there are no recordings. | No | |||||
| subtitletypes | statetype | A statetype for the item's subtitle attributes. Types are cc, subtitles, and onscreensubs. | No | |||||
| audioprops | statetype | A statetype for the item's audio attributes. Types are stereo, surround, dolby, and mono. | No | |||||
| jobstate | statetype | Statetype for jobs running on a given item. States names are recording and transcoding. | No | |||||
| videoprops | statetype | A statetype for the item's video attributes. Types are hdtv, widescreen, avchd, hd720, and hd1080. | No | |||||
| transcoded | statetype | A statetype for an item that has been transcoded. Values are yes and no. | No | |||||
| inuse | statetype | A statetype for an item that is in use. Values are yes and no. | No | |||||
| watched | statetype | A statetype to display if the item has been watched. Values are yes and no. | No | |||||
| playlist | statetype | A statetype to display if the item is in a playlist. Values are yes and no. | No | |||||
| preserved | statetype | A statetype for an item that has "preserved" status. Values are yes and no. | No | |||||
| autoexpire | statetype | A statetype to display if the item is autoexpire eligible. Values are yes and no. | No | |||||
| commflagged | statetype | A statetype to display if the item has been commercial flagged. Values are yes and no. | No | |||||
| bookmark | statetype | A statetype to display if the item has a bookmark. Values are yes and no. | No | |||||
| cutlist | statetype | A statetype to display if the item has a cutlist. Values are yes and no. | No | |||||
| processing | statetype | A statetype to display if the item is being commflagged/processed. Values are yes and no. | No | |||||
| fanart | imagetype | The fanart for the item, if available. | No | |||||
| banner | imagetype | The banner for the item, if available. | No | |||||
| coverart | imagetype | The coverart for the item, if available. | No | |||||
| preview | imagetype | The screenshot for the item, if available. | No | |||||
| rec_count | textarea | The number of items in the selected recording group | No | - | usedbar | progressbar | An progress bar to display free space. | No |
|---|---|---|---|---|---|---|---|---|
| freereport | textarea | A report of the free space on all recording Storage Groups | No | |||||
| diskspacetotal | textarea | Total disk space for recordings | No | |||||
| diskspaceused | textarea | Disk space used by recordings | No | |||||
| diskspacefree | textarea | Disk space free for recordings | No | |||||
| diskspacepercentused | textarea | Disk space used by recordings as a percentage | No | |||||
| diskspacepercentfree | textarea | Disk space free for recordings as a percentage | No |
The "groupfilter" window
| Widget Name | Widget Type | Description | Required? |
| groups | buttonlist | A buttonlist for the recording groups/genres/etc.. | Yes |
The "changeview" window
| Widget Name | Widget Type | Description | Required? |
| titles | checkbox | A checkbox to show titles. | Yes |
| categories | checkbox | A checkbox to show categories. | Yes |
| recgroups | checkbox | A checkbox to show recording groups. | Yes |
| watchlist | checkbox | A checkbox to show the Watch List. | Yes |
| searches | checkbox | A checkbox to show searches. | Yes |
| livetv | checkbox | A checkbox to show LiveTV recordings | Yes |
| watched | checkbox | A checkbox to show watched items. | Yes |
| save | button | A button to save the settings. | Yes |
The "passwordchanger" window
| Widget Name | Widget Type | Description | Required? |
| oldpassword | textedit | An input for the old password. | Yes |
| newpassword | textedit | An input for the new password. | Yes |
| ok | button | A button to finish changing password. | Yes |
The "groupselector" window
| Widget Name | Widget Type | Description | Required? |
| groups | buttonlist | A list of the available groups. | Yes |
The "iconhelp" window
| Widget Name | Widget Type | Description | Required? |
| iconlist | buttonlist | A list of the icons and their meanings which *must contain* the statetype items (see below). | Yes |
| items | statetype | A statetype for each of the help icons. Values are commflagged, cutlist, autoexpire, processing, bookmark, mono, stereo, surround, dolby, cc, subtitles, onscreensub, hdtv, widescreen, avchd, hd1080, hd720, and watched. | Yes |
The "editmetadata" window
| Widget Name | Widget Type | Description | Required? |
| title | textedit | A textedit to change the title. | Yes |
| subtitle | textedit | A textedit to change the subtitle | Yes |
| description | textedit | A textedit to change the description (since Mar 3, 2011, will be in 0.25+) | No |
| ok | button | A button to confirm the title/subtitle changes. | Yes |
| inetref | textedit | A textedit to change the inetref. | Yes |
| season | spinbox | A spinbox to change the season number | Yes |
| episode | spinbox | A spinbox to change the episode number | Yes |
