diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/CUSTOM_CFG_FORMAT | 114 |
1 files changed, 82 insertions, 32 deletions
diff --git a/docs/CUSTOM_CFG_FORMAT b/docs/CUSTOM_CFG_FORMAT index 87bc18162a..06b11b8241 100644 --- a/docs/CUSTOM_CFG_FORMAT +++ b/docs/CUSTOM_CFG_FORMAT | |||
@@ -1,24 +1,85 @@ | |||
1 | Custom CFG | 1 | Custom CFG File Format Specification |
2 | File Format Specifications | ||
3 | 2 | ||
4 | Description / General Info | 3 | General Info |
5 | -------------------------- | 4 | ------------ |
6 | * The .cfg file is used on both the Rockbox Player and Recorder, in order to | 5 | The .cfg file is used to load settings from a plain text file. A .cfg file may |
7 | load custom settings. | 6 | reside anywhere on the hard disk. The only restriction is that the filename |
8 | * Currently, only sound settings are supported but this will change in the | 7 | must end in .cfg |
9 | future. | ||
10 | |||
11 | File Location | ||
12 | ------------- | ||
13 | The files may reside anywhere on the hard disk. The only restriction is that | ||
14 | the filename must end in .cfg | ||
15 | 8 | ||
16 | Format Rules | 9 | Format Rules |
17 | ------------ | 10 | ------------ |
18 | * Each setting must have it's own line. | 11 | * Format: setting: value |
12 | * Each setting must be on a separate line. | ||
19 | * Lines starting with # are ignored. | 13 | * Lines starting with # are ignored. |
20 | * If a value is out of the acceptable range for the device, which can vary | 14 | |
21 | depending on the model, the value will be set to its default value. | 15 | Settings (allowed values) [unit] |
16 | -------------------------------- | ||
17 | volume (0 - 100) | ||
18 | bass (-15 - 15) | ||
19 | treble (-15 - 15) | ||
20 | balance (-100 - 100) | ||
21 | |||
22 | shuffle (on, off) | ||
23 | repeat (off, all, one) | ||
24 | play selected (on, off) | ||
25 | resume (off, ask, on) | ||
26 | scan min step (1, 2, 3, 4, 5, 6, 8, 10, 15, 20, 25) [seconds] | ||
27 | scan accel (0 - 15) [double scan speed every X seconds] | ||
28 | antiskip (0 - 7) [seconds] | ||
29 | |||
30 | sort case (on, off) | ||
31 | show files (all, supported, music) | ||
32 | follow playlist (on, off) | ||
33 | |||
34 | scroll speed (1 - 10) [Hz] | ||
35 | start delay (0 - 250) [1/10s] | ||
36 | scroll step (1 - 112) [pixel] | ||
37 | bidir limit (0 - 200) [% of screen width] | ||
38 | contrast (0 - 63) | ||
39 | backlight timeout (off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, | ||
40 | 15, 20, 30, 45, 60, 90) [seconds] | ||
41 | backlight when plugged (on, off) | ||
42 | |||
43 | disk spindown (3 - 254) [seconds] | ||
44 | disk poweroff (on, off) | ||
45 | battery capacity (1500 - 2400) [mAh] | ||
46 | idle poweroff (off, 1, 2, 3, 4, 5, 6, 7, 8, 9, | ||
47 | 10, 15, 30, 45, 60) [minutes] | ||
48 | |||
49 | Recorder-specific settings (allowed values) [unit] | ||
50 | --------------------------------------------------- | ||
51 | loudness (0 - 17) | ||
52 | bass boost (0 - 100) | ||
53 | auto volume (0=off, 1=2s, 2=4s, 3=8s) | ||
54 | |||
55 | peak meter release (1 - 126) | ||
56 | peak meter hold (off, 200ms, 300ms, 500ms, | ||
57 | 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, | ||
58 | 15, 20, 25, 30, 45, 90, | ||
59 | 2min, 3min, 5min, 10min, 20min, 45min, 90min) | ||
60 | peak meter clip hold (on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, | ||
61 | 15, 20, 25, 30, 45, 60, 90, | ||
62 | 2min, 3min, 5min, 10min, 20min, 45min, 90min) | ||
63 | peak meter busy (on, off) | ||
64 | peak meter dbfs (on, off) (on = dbfs, off = linear) | ||
65 | peak meter min (0 - 89) [dB] or (0 - 100) [%] | ||
66 | peak meter max (0 - 89) [dB] or (0 - 100) [%] | ||
67 | |||
68 | volume display (graphic, numeric) | ||
69 | battery display (graphic, numeric) | ||
70 | time format (12hour, 24hour) | ||
71 | |||
72 | deep discharge (on, off) | ||
73 | trickle charge (on, off) | ||
74 | |||
75 | rec quality (0 - 7) (0=smallest size, 7=highest quality) | ||
76 | rec frequency (48, 44, 32, 24, 22, 16) [kHz] | ||
77 | rec source (mic, line, spdif) | ||
78 | rec channels (mono, stereo) | ||
79 | rec mic gain (0 to 15) | ||
80 | rec left gain (0 to 15) | ||
81 | rec right gain (0 to 15) | ||
82 | |||
22 | 83 | ||
23 | Example File | 84 | Example File |
24 | ------------ | 85 | ------------ |
@@ -26,20 +87,9 @@ volume: 70 | |||
26 | bass: 11 | 87 | bass: 11 |
27 | treble: 12 | 88 | treble: 12 |
28 | balance: 0 | 89 | balance: 0 |
29 | channels: 0 | 90 | time format: 12hour |
30 | loudness: 5 | 91 | volume display: numeric |
31 | bass boost: 30 | 92 | show files: supported |
32 | auto volume: 0 | 93 | wps: car |
33 | 94 | lang: afrikaans | |
34 | This sets each line to the respective values after it. | ||
35 | 95 | ||
36 | Value ranges | ||
37 | ------------ | ||
38 | volume: 0 to 100 | ||
39 | bass: player: -15 to 15, recorder: -12 to 12 | ||
40 | treble: player: -15 to 15, recorder: -12 to 12 | ||
41 | balance: -100 to 100 | ||
42 | channels: 0=Stereo, 1=Mono, 2=Mono Left, 3=Mono Right | ||
43 | loudness: 0 to 17 (recorder only) | ||
44 | bass boost: 0 to 100 (recorder only) | ||
45 | auto volume: 0=off, 1=2s, 2=4s, 3=8s (recorder only) | ||