Difference between revisions of "Osd.xml"
From MythTV Official Wiki
(→OSD Windows) |
(→OSD Windows) |
||
| Line 14: | Line 14: | ||
| MythPopupBox | | MythPopupBox | ||
| Window | | Window | ||
| − | | The OSD menu. See base.xml for details. | + | | The OSD menu. See [[base.xml]] for details. |
|- | |- | ||
| style="background:silver" | osd_message | | style="background:silver" | osd_message | ||
Revision as of 18:26, 10 October 2010
The osd.xml file governs the layout and behavior of an On Screen Display (OSD) during video playback. To make sure your OSD is detected (if you are including it with another type of theme), it's important to remember to add "OSD" to the <types> element in themeinfo.xml. For an OSD-only theme, osd.xml and themeinfo.xml (as well as any image assets) are required. osd.xml consists of the following windows and named attributes:
Contents
OSD Windows
Note: Special consideration when writing an OSD: Because the various video renderers all perform scaling differently, and because of the nature of scaling and image caching in MythUI, you must avoid the use of the <position> tag at all costs. You also must not inherit any widgets from outside of the OSD.xml file. The OSD.xml must stand alone with its own widget definitions, and with all elements using <area> tags.
| Window Name | Type | Description |
| MythPopupBox | Window | The OSD menu. See base.xml for details. |
| osd_message | Window | The OSD text message/notification popup. |
| osd_input | Window | This window displays the channel number being input during a channel change. |
| osd_status | Window | The "overall status" window, which usually displays playback progress. |
| program_info | Window | The Program Information window. |
| browse_info | Window | The OSD window displayed during channel browsing. |
| osd_program_editor | Window | The recording editor window |
| ChannelEditor | Window | The channel details editor |
Generic attributes used in most windows
- As with the recordings-ui.xml and schedule-ui.xml, the osd.xml file can use most mapped program attributes. This allows the themer to show whichever information he or she likes across the different screens. This is a list of attributes you can utilize in many (but not all) of the aforementioned windows, including use in their buttonlists or individually.
| 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 |
The "osd_message" window
| Widget Name | Widget Type | Description | Required? |
| message_text | textarea | The popup/notification text area. | Yes |
The "osd_input" window
| Widget Name | Widget Type | Description | Required? |
| osd_number_entry | textarea | The channel number/text input text area. | Yes |
The "osd_status" window
| Widget Name | Widget Type | Description | Required? |
| position | progressbar | The playback position of the current item. | Yes |
The "program_info" window
| Widget Name | Widget Type | Description | Required? |
| icon_path | imagetype | The channel icon for the currently playing item. | No |
The "browse_info" window
| Widget Name | Widget Type | Description | Required? |
| icon_path | imagetype | The channel icon for the currently playing item. | No |
