Merge branch 'gsoc-android-2' of git+ssh://repo.or.cz/srv/git/kugel-rb into gsoc...
[kugel-rb.git] / manual / plugins / pictureflow.tex
blobe141baeb3b502b086aa3324bc2deb4768c516d75
1 \subsection{PictureFlow}
2 \screenshot{plugins/images/ss-pictureflow}{PictureFlow}{img:pictureflow}
3 PictureFlow provides a visualisation of your albums with their associated cover
4 art. \opt{swcodec}{It is possible to start playback of the selected
5 album from PictureFlow. Playback will start from the selected track. The
6 PictureFlow plugin will continue to run while your tracks are played.}
8 \opt{hwcodec}{
9 \note{PictureFlow is a visualisation only. It cannot be used to select and
10 play music. Also, using this plugin will cause playback to stop.}
13 \subsubsection{Requirements}
14 PictureFlow uses both the album art (see \reference{ref:album_art}) and
15 database (see \reference{ref:database}) features of Rockbox.
16 It is therefore important that these are working correctly before attempting
17 to use PictureFlow. In addition, there are some other points of which to be
18 aware:
20 \begin{itemize}
21 \item PictureFlow will accept album art larger than the dimensions of the
22 screen, but the larger the dimensions, the longer they will take to scale.
23 \end{itemize}
25 \subsubsection{Keys}
26 \begin{btnmap}
27 \opt{scrollwheel,IRIVER_H10_PAD,PBELL_VIBE500_PAD}{
28 \ActionStdPrev{} / \ActionStdNext
30 \opt{HAVEREMOTEKEYMAP}{
32 Scroll through albums / track list
36 % only scroll wheel and `strip' targets use the same action in album and track list
37 \nopt{scrollwheel,IRIVER_H10_PAD,PBELL_VIBE500_PAD}{%
38 % currently the M3 does not use buttons of the main unit which has no display
39 \nopt{IAUDIO_M3_PAD,touchscreen}{\ButtonLeft{} / \ButtonRight}
40 \opt{touchscreen}{\TouchMidLeft{} / \TouchMidRight}
42 \opt{HAVEREMOTEKEYMAP}{
43 \opt{IAUDIO_M3_PAD,GIGABEAT_RC_PAD}{\ActionRCStdPrev{} / \ActionRCStdNext}
45 Scroll through albums
48 \nopt{IAUDIO_M3_PAD}{\ActionStdPrev{} / \ActionStdNext}
50 \opt{HAVEREMOTEKEYMAP}{
51 % even though the M3 uses an Iaudio remote, mapping differs when used with M/X5
52 \opt{IAUDIO_M3_PAD}{\ButtonRCLeft{} / \ButtonRCRight}
53 \opt{GIGABEAT_RC_PAD}{\ButtonRCVolUp{} / \ButtonRCVolDown}
55 Scroll through track list
59 \nopt{IAUDIO_M3_PAD}{%
60 \nopt{ONDIO_PAD,IRIVER_H10_PAD,RECORDER_PAD,touchscreen,PBELL_VIBE500_PAD}
61 {\ButtonSelect}
62 \opt{ONDIO_PAD}{\ButtonUp}
63 \opt{IRIVER_H10_PAD,PBELL_VIBE500_PAD}{\ButtonRight}
64 \opt{RECORDER_PAD}{\ButtonOn}
65 \opt{touchscreen}{\TouchCenter}
68 \opt{HAVEREMOTEKEYMAP}{
69 \opt{IAUDIO_M3_PAD}{\ButtonRCPlay}
70 \opt{GIGABEAT_RC_PAD}{\ButtonRCFF}
72 Enter track list
73 \nopt{ONDIO_PAD}{/ Play album from selected track}
76 % Ondio uses a different button in album list and track list
77 \opt{ONDIO_PAD}{
78 \ButtonMenu
80 Play album from selected track in track list
84 \nopt{IAUDIO_M3_PAD,touchscreen}{\ButtonLeft}
85 \opt{touchscreen}{
86 \opt{COWON_D2_PAD}{\ButtonPower{} or}
87 \TouchBottomRight}
89 \opt{HAVEREMOTEKEYMAP}{
90 \opt{IAUDIO_M3_PAD,GIGABEAT_RC_PAD}{\ActionRCStdCancel}
92 Exit track list
95 \nopt{IAUDIO_M3_PAD}{\ActionStdMenu}
97 \opt{HAVEREMOTEKEYMAP}{
98 \opt{IAUDIO_M3_PAD,GIGABEAT_RC_PAD}{\ActionRCStdMenu}
100 Enter menu
103 \nopt{IAUDIO_M3_PAD}{%
104 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,RECORDER_PAD,ONDIO_PAD}{\ButtonOff}
105 \opt{IAUDIO_X5_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,SANSA_E200_PAD%
106 ,MROBE100_PAD}{\ButtonPower}
107 \opt{SANSA_C200_PAD,IRIVER_H10_PAD}{Long \ButtonPower}
108 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{Long \ButtonMenu}
109 \opt{SANSA_FUZE_PAD}{Long \ButtonHome}
110 \opt{PBELL_VIBE500_PAD}{\ButtonRec}
111 \opt{touchscreen}{
112 \opt{COWON_D2_PAD}{Long \ButtonPower{} or}
113 \TouchBottomRight{} (in album view)}
116 \opt{HAVEREMOTEKEYMAP}{
117 \opt{IAUDIO_M3_PAD}{\ButtonRCRec}
118 \opt{GIGABEAT_RC_PAD}{\ButtonRCRew}
120 Exit PictureFlow
123 \end{btnmap}
125 \subsubsection{Main Menu}
126 \begin{description}
127 \item[Go to WPS.] Leave PictureFlow and enter the while playing screen.
128 \opt{swcodec}{\item[Playback Control.] Control music playback from within the plugin.}
129 \item[Settings.] Enter the settings menu.
130 \item[Return.] Exit menu.
131 \item[Quit.] Exit PictureFlow plugin.
132 \end{description}
134 \subsubsection{Settings Menu}
136 \begin{description}
137 \item[Show FPS.] Displays frames per second on screen.
138 \item[Spacing.] The distance between the front edges of the side slides, i.e. changes
139 the degree of overlap of the side slides. A larger number means less overlap. Scales with zoom.
140 \item[Centre margin.] The distance, in screen pixels, with zoom at 100, between
141 the centre and side slides. Scales with zoom.
142 \item[Number of slides.] Sets the number of slides at each side, including the
143 centre slide. Therefore if set to 4, there will be 3 slides on the left,
144 the centre slide, and then 3 slides on the right.
145 \item[Zoom.] Changes the distance at which slides are rendered from the ``camera''.
146 \item[Show album title.] Allows setting the album title to be shown above or
147 below the cover art, or not at all.
148 \item[Resize Covers.] Set whether to automatically resize the covers or to leave
149 them at their original size.
150 \item[Rebuild cache.] Rebuild the PictureFlow cache. This is needed in order
151 for PictureFlow to pick up new albums, and may occasionally be needed if albums
152 are removed.
153 \end{description}