Difference between revisions of "Music-ui.xml"

From MythTV Official Wiki
Jump to: navigation, search
(MythMusic Windows)
Line 25: Line 25:
 
|}
 
|}
  
 +
=== Generic Attributes Used in most windows ===
 +
 +
</center>
 +
{{Note box|
 +
The following widgets can be used in almost any of the MythMusic views.  In addition, all textual elements can be combined however the themer likes using the <template> element.  To combine the title, artist, and album into a single textarea, the theme author might use a template like:
 +
<pre><template>%TITLE% (%ARTIST%) - %ALBUM%</template></pre>
 +
}}
 +
<center>
 +
{| cellpadding="4" border="1"
 +
| align="center"  |<b>Widget Name</b>
 +
| align="center"  |<b>Widget Type</b>
 +
| align="center"  |<b>Description</b>
 +
| align="center"  |<b>Required?</b>
 +
|-
 +
| style="background:darkturquoise" | artist
 +
| style="background:darkturquoise" align="center" | textarea
 +
| style="background:darkturquoise" | The artist of the selected item.
 +
| style="background:darkturquoise" align="center" | N
 +
|-
 +
| formatartist
 +
| align="center"  | textarea
 +
| The compilation formatted artist of the selected item.
 +
| align="center"  | N
 +
|-
 +
| style="background:darkturquoise" | compilationartist
 +
| style="background:darkturquoise" align="center" | textarea
 +
| style="background:darkturquoise" | The compilation artist of the selected item.
 +
| style="background:darkturquoise" align="center" | N
 +
|-
 +
| album
 +
| align="center"  | textarea
 +
| The album name of the selected item.
 +
| align="center"  | N
 +
|-
 +
| style="background:darkturquoise" | title
 +
| style="background:darkturquoise" align="center" | textarea
 +
| style="background:darkturquoise" | The title of the selected item.
 +
| style="background:darkturquoise" align="center" | N
 +
|-
 +
| tracknum
 +
| align="center"  | textarea
 +
| The track number of the selected item.
 +
| align="center"  | N
 +
|-
 +
| style="background:darkturquoise" | genre
 +
| style="background:darkturquoise" align="center" | textarea
 +
| style="background:darkturquoise" | The genre of the selected item.
 +
| style="background:darkturquoise" align="center" | N
 +
|-
 +
| year
 +
| align="center"  | textarea
 +
| The year of the selected item.
 +
| align="center"  | N
 +
|-
 +
| style="background:darkturquoise" | artisttitle
 +
| style="background:darkturquoise" align="center" | textarea
 +
| style="background:darkturquoise" | The artist and title of the selected item in format "Title by Artist.".
 +
| style="background:darkturquoise" align="center" | N
 +
|-
 +
| length
 +
| align="center"  | textarea
 +
| The formatted length of the selected item (hh:mm:ss).
 +
| align="center"  | N
 +
|-
 +
| style="background:darkturquoise" | lastplayed
 +
| style="background:darkturquoise" align="center" | textarea
 +
| style="background:darkturquoise" | The last played date of the selected item.
 +
| style="background:darkturquoise" align="center" | N
 +
|-
 +
| playcount
 +
| align="center"  | textarea
 +
| The number of times the selected item has been played.
 +
| align="center"  | N
 +
|-
 +
| style="background:darkturquoise" | tartist
 +
| style="background:darkturquoise" align="center" | textarea
 +
| style="background:darkturquoise" | The filename of the selected item.
 +
| style="background:darkturquoise" align="center" | N
 +
|}
  
 
=== The "import_music" window ===
 
=== The "import_music" window ===

Revision as of 03:52, 15 May 2010

The music-ui.xml file governs the layout and behavior of the MythMusic Plugin. It consists of the following windows and named attributes:

MythMusic Windows

Window Name Type Description
import_music Window Import music from a given directory.
miniplayer Popup Window The MythMusic miniplayer.
cdripper Window The main CD Rip window.
ripstatus Window Status of an in-progress CD Rip.

Generic Attributes Used in most windows

Important.png Note: The following widgets can be used in almost any of the MythMusic views. In addition, all textual elements can be combined however the themer likes using the <template> element. To combine the title, artist, and album into a single textarea, the theme author might use a template like:

<template>%TITLE% (%ARTIST%) - %ALBUM%</template>
Widget Name Widget Type Description Required?
artist textarea The artist of the selected item. N
formatartist textarea The compilation formatted artist of the selected item. N
compilationartist textarea The compilation artist of the selected item. N
album textarea The album name of the selected item. N
title textarea The title of the selected item. N
tracknum textarea The track number of the selected item. N
genre textarea The genre of the selected item. N
year textarea The year of the selected item. N
artisttitle textarea The artist and title of the selected item in format "Title by Artist.". N
length textarea The formatted length of the selected item (hh:mm:ss). N
lastplayed textarea The last played date of the selected item. N
playcount textarea The number of times the selected item has been played. N
tartist textarea The filename of the selected item. N

The "import_music" window

Widget Name Widget Type Description Required?
location textedit Edit path from which to import music. Yes
directoryfinder button Button to launch file browser to specify import directory. Yes
scan button Scan specified path for music. Yes
coverart button Button to launch coverart browser. Yes
filename textarea The filename of the current item. Yes
compartist textarea Compilation Artist Name. Yes
artist textarea Artist's Name. Yes
album textarea Album Name. Yes
title textarea Title of Track. Yes
genre textarea Genre of Track. Yes
year textarea Year of track. Yes
track textarea Track's number on CD. Yes
position textarea Position within scanned files. (ie 12 of 1364) Yes
status textarea Notification if already in database. Yes
compilation checkbox Checkbox to mark track as part of compilation. Yes
play button Play selected track. Yes
nextnew checkbox Checkbox to mark track as part of compilation. Yes
add button Play selected track. Yes
addallnew checkbox Add all new tracks. Yes
next button Navigate to next scanned track. Yes
prev checkbox Navigate to previous scanned track. Yes


The "miniplayer" window

Widget Name Widget Type Description Required?
time textarea Text area for Played Time / Total Time. Yes
info textarea Information notification area. Yes
volume textarea Textual volume in percent. Yes
userratingstate statetype The User Rating statetype (commonly "stars"). Values are 1, 2, 3, 4, 5, 6, 7, 8, 9, and 10. Yes
coverart imagetype Album art for current track. Yes
progress progressbar Progress bar for currently playing track. Yes


The "cdripper" window

Widget Name Widget Type Description Required?
quality buttonlist Quality selector for current rip. Yes
artist textedit Artist name edit. Yes
searchartist button Search within current library for Artist Name. Yes
album textedit Album name edit. Yes
searchalbum button Search within current library for album name. Yes
genre textedit Album genre edit. Yes
year textedit Album year edit. Yes
searchgenre button Search within current library for album Genre. Yes
compilation checkbox Designate album as a compilation album. Yes
switch button Switch Title and Artist. Yes
scan button Scan drive to CD. Yes
rip button Begin CD Rip. Yes
tracks buttonlist Button list of tracks on current CD. Yes


The "ripstatus" window

Widget Name Widget Type Description Required?
overall textarea Text value of overall progress. Yes
track textarea Text value of track progress. Yes
status textarea Miscellaneous status text. Yes
trackpct textarea Track rip percentage in text. Yes
overallpct textarea Overall rip percentage in text. Yes
overall_progress progressbar Progress bar for overall progress. Yes
track_progress progressbar Progress bar for track progress. Yes