manual/plugins/pictureflow.tex

   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.}
   6
   7 \opt{hwcodec}{
   8 \note{PictureFlow is a visualisation only. It cannot be used to select and
   9 -play music.  Also, using this plugin will cause playback to stop.}
  10 }
  11
  12 \subsubsection{Requirements}
  13 PictureFlow uses both the album art (see \reference{ref:album_art}) and
  14 database (see \reference{ref:database}) features of Rockbox.
  15 It is therefore important that these are working correctly before attempting
  16 to use PictureFlow. In addition, there are some other points of which to be
  17 aware:
  18
  19   \begin{itemize}
  20     \item PictureFlow will accept album art larger than the dimensions of the
  21     screen, but the larger the dimensions, the longer they will take to scale.
  22   \end{itemize}
  23
  24 \subsubsection{Keys}
  25 \begin{table}
  26     \begin{btnmap}{}{}
  27         \opt{scrollwheel,IRIVER_H10_PAD}{
  28           \opt{scrollwheel}{\ButtonScrollFwd{} / \ButtonScrollBack}
  29           \opt{IRIVER_H10_PAD}{\ButtonScrollUp{} / \ButtonScrollDown}
  30              \opt{HAVEREMOTEKEYMAP}{& }
  31           & Scroll through albums / track list\\}
  32
  33         \nopt{scrollwheel,IRIVER_H10_PAD}{\ButtonLeft{} / \ButtonRight
  34            \opt{HAVEREMOTEKEYMAP}{&
  35               \opt{GIGABEAT_RC_PAD}{\ButtonRCVolDown{} / \ButtonRCVolUp}
  36            }
  37         & Scroll through albums\\}
  38
  39         \nopt{scrollwheel,IRIVER_H10_PAD}{\ButtonUp{} / \ButtonDown
  40            \opt{HAVEREMOTEKEYMAP}{&
  41              \opt{GIGABEAT_RC_PAD}{\ButtonRCVolDown{} / \ButtonRCVolUp}
  42            }
  43         & Scroll through track list\\}
  44
  45         \opt{IRIVER_H10_PAD}{\ButtonRight}
  46         \opt{ONDIO_PAD}{\ButtonUp}
  47         \opt{RECORDER_PAD}{\ButtonOn}
  48         \nopt{ONDIO_PAD,IRIVER_H10_PAD,RECORDER_PAD}{\ButtonSelect}
  49            \opt{HAVEREMOTEKEYMAP}{&
  50              \opt{GIGABEAT_RC_PAD}{\ButtonRCFF}
  51            }
  52         & Enter track list
  53              \opt{swcodec}{/ Play album from selected track}
  54         \\
  55
  56         \ButtonLeft
  57            \opt{HAVEREMOTEKEYMAP}{&
  58              \opt{GIGABEAT_RC_PAD}{\ButtonRCRew}
  59             }
  60         & Exit track list\\
  61
  62         \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}
  63         \opt{IPOD_1G2G_PAD,IPOD_3G_PAD,IPOD_4G_PAD,GIGABEAT_PAD,%
  64              GIGABEAT_S_PAD,MROBE100_PAD}{\ButtonMenu}
  65         \opt{IAUDIO_X5_PAD}{\ButtonRec}
  66         \opt{SANSA_E200_PAD}{\ButtonDown}
  67         \opt{IRIVER_H10_PAD,SANSA_C200_PAD}{\ButtonPower}
  68         \opt{RECORDER_PAD}{\ButtonFOne}
  69         \opt{ONDIO_PAD}{Long \ButtonMenu}
  70             \opt{HAVEREMOTEKEYMAP}{&
  71               \opt{GIGABEAT_RC_PAD}{\ButtonRCDsp}
  72             }
  73         & Enter menu\\
  74
  75         \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,RECORDER_PAD,ONDIO_PAD}{\ButtonOff}
  76         \opt{IAUDIO_X5_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,SANSA_E200_PAD,%
  77              MROBE100_PAD}{\ButtonPower}
  78         \opt{SANSA_C200_PAD,IRIVER_H10_PAD}{Long \ButtonPower}
  79         \opt{IPOD_1G2G_PAD,IPOD_3G_PAD,IPOD_4G_PAD}{Long \ButtonMenu}
  80            \opt{HAVEREMOTEKEYMAP}{&
  81              \opt{GIGABEAT_RC_PAD}{\ButtonRCRew}
  82            }
  83         & Exit PictureFlow\\
  84     \end{btnmap}
  85 \end{table}
  86
  87 \subsubsection{Main Menu}
  88 \begin{description}
  89   \item[Settings.] Enter the settings menu.
  90   \item[Return.] Exit menu.
  91   \item[Quit.] Exit PictureFlow plugin.
  92 \end{description}
  93
  94 \subsubsection{Settings Menu}
  95
  96 \begin{description}
  97   \item[Show FPS.] Displays frames per second on screen.
  98   \item[Spacing.] The distance between the front edges of the side slides, i.e. changes
  99   the degree of overlap of the side slides. A larger number means less overlap. Scales with zoom.
 100   \item[Centre margin.] The distance, in screen pixels, with zoom at 100, between
 101   the centre and side slides. Scales with zoom.
 102   \item[Number of slides.] Sets the number of slides at each side, including the
 103   centre slide. Therefore if set to 4, there will be 3 slides on the left,
 104   the centre slide, and then 3 slides on the right.
 105   \item[Zoom.] Changes the distance at which slides are rendered from the "camera".
 106   \item[Show album title.] Allows setting the album title to be shown above or
 107   below the cover art, or not at all.
 108   \item[Resize Covers.] Set whether to automatically resize the covers or to leave
 109   them at their original size.
 110   \item[Rebuild cache.] Rebuild the PictureFlow cache. This is needed in order
 111   for PictureFlow to pick up new albums, and may occasionally be needed if albums
 112   are removed.
 113 \end{description}