diff options
-rw-r--r-- | docs/CUSTOM_WPS_FORMAT | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/docs/CUSTOM_WPS_FORMAT b/docs/CUSTOM_WPS_FORMAT new file mode 100644 index 0000000000..16549f389c --- /dev/null +++ b/docs/CUSTOM_WPS_FORMAT | |||
@@ -0,0 +1,53 @@ | |||
1 | Custom WPS Display | ||
2 | wps.config File Format Specifications | ||
3 | |||
4 | Description | ||
5 | ----------- | ||
6 | The Custom WPS Display is used on the Rockbox Player ONLY as a means | ||
7 | to customize the WPS to the user's likings. | ||
8 | The first line of the 2 line display is the customized line (scrolling). | ||
9 | The second line is always the time display. (Elapsed & Total Time). | ||
10 | The second line is not able to be customized. | ||
11 | All characters not preceded by % are displayed as typed. | ||
12 | |||
13 | File Location | ||
14 | ------------- | ||
15 | The configuration file must be located in the root folder of the | ||
16 | device and must be named wps.config (lowercase) | ||
17 | |||
18 | Tags | ||
19 | ---- | ||
20 | %t : ID3 Title | ||
21 | %a : ID3 Artist | ||
22 | %n : ID3 Track Number | ||
23 | %u : ID3 Album | ||
24 | %c : Conditional Title/Filename | ||
25 | Displays "Artist - Title" *or* | ||
26 | Displays Filename if no ID3 Artist/Title | ||
27 | %b : File Bitrate | ||
28 | %f : File Frequency | ||
29 | %p : File Path | ||
30 | %m : File Name | ||
31 | %s : File Size (In Kilobytes) | ||
32 | %i : Playlist Position | ||
33 | %l : Playlist Total Entries | ||
34 | %e : Elapsed Track Time | ||
35 | %o : Total Track Time | ||
36 | |||
37 | Example wps.config File | ||
38 | ----------------------- | ||
39 | %i/%l: %c * %sKB | ||
40 | |||
41 | Example Output | ||
42 | -------------- | ||
43 | ID3 Title: None | ||
44 | ID3 Artist: None | ||
45 | Playlist Position: 5 | ||
46 | Playlist Total Entries: 10 | ||
47 | Filename: My Song.mp3 | ||
48 | File Size: 3500 | ||
49 | Elapsed Track Time: 2:23 | ||
50 | Total Track Time: 3:01 | ||
51 | The output of this on the player would be: | ||
52 | 5/10: My Song.mp3 * 3500KB | ||
53 | 2:23/3:01 | ||