Commit the first part of FS#10263: Starting playback from within pictureflow, by...
[kugel-rb.git] / manual / plugins / pictureflow.tex
blob085d484658e8f69dee9cc54cbd8dc41df2f5d556
1 \subsection{PictureFlow}
2 \screenshot{plugins/images/ss-pictureflow}{PictureFlow}{img:pictureflow}
3 PictureFlow is a plugin that provides a visualisation of your albums with
4 their associated cover art.
6 \opt{hwcodec}{
7 \note{This plugin will cause playback to stop.}
10 \subsubsection{Requirements}
11 PictureFlow uses both the album art (see \reference{ref:album_art}) and
12 database (see \reference{ref:database}) features of Rockbox.
13 It is therefore important that these are working correctly before attempting
14 to use PictureFlow. In addition, there are some other points of which to be
15 aware:
17 \begin{itemize}
18 \item PictureFlow will accept album art larger than the dimensions of the
19 screen, but the larger the dimensions, the longer they will take to scale.
20 \end{itemize}
22 \note{PictureFlow is a visualisation only. It cannot be used to select and
23 play music.}
25 \subsubsection{Keys}
26 \begin{table}
27 \begin{btnmap}{}{}
28 \opt{scrollwheel,IRIVER_H10_PAD}{
29 \opt{scrollwheel}{\ButtonScrollFwd{} / \ButtonScrollBack}
30 \opt{IRIVER_H10_PAD}{\ButtonScrollUp{} / \ButtonScrollDown}
31 & Scroll through albums / track list\\}
33 \nopt{scrollwheel,IRIVER_H10_PAD}{\ButtonLeft{} / \ButtonRight
34 & Scroll through albums\\}
36 \nopt{scrollwheel,IRIVER_H10_PAD}{\ButtonUp{} / \ButtonDown
37 & Scroll through track list\\}
39 \opt{IRIVER_H10_PAD}{\ButtonRight}
40 \opt{ONDIO_PAD}{\ButtonUp}
41 \opt{RECORDER_PAD}{\ButtonOn}
42 \nopt{ONDIO_PAD,IRIVER_H10_PAD,RECORDER_PAD}{\ButtonSelect}
43 & Enter track list\\
45 \ButtonLeft & Exit track list\\
47 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}
48 \opt{IPOD_1G2G_PAD,IPOD_3G_PAD,IPOD_4G_PAD,GIGABEAT_PAD,%
49 GIGABEAT_S_PAD,MROBE100_PAD}{\ButtonMenu}
50 \opt{IAUDIO_X5_PAD}{\ButtonRec}
51 \opt{SANSA_E200_PAD}{\ButtonDown}
52 \opt{IRIVER_H10_PAD,SANSA_C200_PAD}{\ButtonPower}
53 \opt{RECORDER_PAD}{\ButtonFOne}
54 \opt{ONDIO_PAD}{Long \ButtonMenu}
55 & Enter menu\\
57 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,RECORDER_PAD,ONDIO_PAD}{\ButtonOff}
58 \opt{IAUDIO_X5_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,SANSA_E200_PAD,%
59 MROBE100_PAD}{\ButtonPower}
60 \opt{SANSA_C200_PAD,IRIVER_H10_PAD}{Long \ButtonPower}
61 \opt{IPOD_1G2G_PAD,IPOD_3G_PAD,IPOD_4G_PAD}{Long \ButtonMenu}
62 & Exit PictureFlow\\
63 \end{btnmap}
64 \end{table}
66 \subsubsection{Main Menu}
67 \begin{description}
68 \item[Settings.] Enter the settings menu.
69 \item[Return.] Exit menu.
70 \item[Quit.] Exit PictureFlow plugin.
71 \end{description}
73 \subsubsection{Settings Menu}
75 \begin{description}
76 \item[Show FPS.] Displays frames per second on screen.
77 \item[Spacing.] The distance between the front edges of the side slides, i.e. changes
78 the degree of overlap of the side slides. A larger number means less overlap. Scales with zoom.
79 \item[Centre margin.] The distance, in screen pixels, with zoom at 100, between
80 the centre and side slides. Scales with zoom.
81 \item[Number of slides.] Sets the number of slides at each side, including the
82 centre slide. Therefore if set to 4, there will be 3 slides on the left,
83 the centre slide, and then 3 slides on the right.
84 \item[Zoom.] Changes the distance at which slides are rendered from the "camera".
85 \item[Show album title.] Allows setting the album title to be shown above or
86 below the cover art, or not at all.
87 \item[Resize Covers.] Set whether to automatically resize the covers or to leave
88 them at their original size.
89 \item[Rebuild cache.] Rebuild the PictureFlow cache. This is needed in order
90 for PictureFlow to pick up new albums, and may occasionally be needed if albums
91 are removed.
92 \end{description}