Add plugin keys to the manual for the Gigabeat S, plus a couple of missing ones for...
[kugel-rb/myfork.git] / manual / plugins / jpegviewer.tex
blobd4f9e23a1ec05c857b9a0e69b48159fd18e07a23
1 % $Id$ %
2 \subsection{JPEG viewer}
3 Open a JPEG file in the \setting{File Browser} to view it%
4 \nopt{lcd_color}{ using Rockbox's
5 greyscale library}.
6 \opt{swcodec}{
7 \note{When an audio file is playing the size of the image is limited as
8 the decoding process needs to share memory with audio tracks. To be able to
9 view a bigger file you may need to stop playback.}
11 \opt{MASCODEC}{
12 \note{This plugin will cause playback to stop.}
15 \begin{table}
16 \begin{btnmap}{}{}
17 \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD%
18 ,SANSA_E200_PAD,SANSA_C200_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD}
19 {\ButtonUp\ / \ButtonDown}%
20 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonMenu\ / \ButtonPlay}%
21 \opt{IRIVER_H10_PAD}{\ButtonScrollUp\ / \ButtonScrollDown} %
22 / \ButtonLeft\ / \ButtonRight
23 & Move around in zoomed in image\\
24 \opt{RECORDER_PAD}{\ButtonPlay}
25 \opt{ONDIO_PAD}{\ButtonMenu}
26 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD%
27 ,SANSA_C200_PAD,MROBE100_PAD}{\ButtonSelect}
28 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonScrollFwd}
29 \opt{IRIVER_H10_PAD}{\ButtonPlay}
30 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonVolUp}
31 & Zoom in\\
32 \opt{RECORDER_PAD}{\ButtonOn}
33 \opt{ONDIO_PAD}{\ButtonMenu+\ButtonDown}
34 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}
35 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonScrollBack}
36 \opt{IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_C200_PAD}{Long \ButtonSelect}
37 \opt{IRIVER_H10_PAD}{Long \ButtonPlay}
38 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonVolDown}
39 \opt{MROBE100_PAD}{\ButtonPlay}
40 & Zoom out\\
41 \opt{RECORDER_PAD}{\ButtonFThree}
42 \opt{ONDIO_PAD}{\ButtonMenu+\ButtonRight}
43 \opt{IRIVER_H100_PAD}{\ButtonOn}
44 \opt{IRIVER_H300_PAD}{\ButtonRec}
45 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonSelect+\ButtonRight}
46 \opt{IAUDIO_X5_PAD}{\ButtonPlay}
47 \opt{IRIVER_H10_PAD}{\ButtonFF}
48 \opt{SANSA_E200_PAD}{\ButtonScrollFwd}
49 \opt{SANSA_C200_PAD}{\ButtonVolUp}
50 \opt{GIGABEAT_PAD}{\ButtonA+\ButtonRight}
51 \opt{GIGABEAT_S_PAD}{\ButtonNext}
52 \opt{MROBE100_PAD}{\ButtonDisplay+\ButtonRight}
53 & Next jpeg in directory\\
54 \opt{RECORDER_PAD}{\ButtonFTwo}
55 \opt{ONDIO_PAD}{\ButtonMenu+\ButtonLeft}
56 \opt{IRIVER_H100_PAD,IAUDIO_X5_PAD}{\ButtonRec}
57 \opt{IRIVER_H300_PAD}{\ButtonOn}
58 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonSelect+\ButtonLeft}
59 \opt{IRIVER_H10_PAD}{\ButtonRew}
60 \opt{SANSA_E200_PAD}{\ButtonScrollBack}
61 \opt{SANSA_C200_PAD}{\ButtonVolDown}
62 \opt{GIGABEAT_PAD}{\ButtonA+\ButtonLeft}
63 \opt{GIGABEAT_S_PAD}{\ButtonPrev}
64 \opt{MROBE100_PAD}{\ButtonDisplay+\ButtonLeft}
65 & Previous jpeg in directory\\
66 \opt{SANSA_E200_PAD,SANSA_C200_PAD}{%currently only defined for the sansa pads
67 \ButtonRec
68 & Toggle slide show mode\\
70 \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff}
71 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonSelect+\ButtonMenu}
72 \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,SANSA_C200_PAD}{\ButtonPower}
73 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD}{\ButtonMenu}
74 & Show menu\\
75 \end{btnmap}
76 \end{table}
78 The menu has the following entries.
79 \begin{description}
80 \item[Quit.] Quits the viewer and returns to the \setting{File Browser}.
81 \item[Toggle Slideshow Mode.] Enables or disables the slideshow mode.
82 \item[Change Slideshow Timeout.] You can set the timeout for the slideshow
83 between 1 second and 20 seconds.
84 \nopt{MASCODEC}{
85 \item[Show Playback Menu.] From the playback menu you can control the
86 playback of the currently loaded playlist and change the volume of your \dap.
88 \opt{lcd_color}{
89 \item[Display Options.] From this menu you can force the viewer to render the
90 image in greyscale using the \setting{Greyscale} option or set the method of
91 dithering used in the \setting{Dithering} submenu.
93 \item[Return.] Returns you to the image
94 \end{description}
96 \note{
97 Progressive scan and other unusual JPEG files are not supported, and will
98 result in various ``unsupported xx'' messages. Processing could also fail if the
99 image is too big to decode which will be explained by a respective message.