.. This is part of the Zrythm Manual.
   Copyright (C) 2020 Alexandros Theodotou <alex at zrythm dot org>
   See the file index.rst for copying conditions.

.. _timeline-ruler:

Ruler
=====

The ruler is mainly used to control looping and playback.

.. image:: /_static/img/ruler.png
   :align: center

The ruler will display more or less information depending on
the current zoom level. It will also display the
following markers/indicators discussed in
:ref:`loop-points-and-markers`.

Cue point
  Displayed as a blue, right-pointing arrow.
Playhead position
  Shown as a grey, down-facing arrow.
Loop points
  Shown as 2 green arrows, and the area between them is
  shown in bright green if loop is enabled, or grey if
  disabled. Can be dragged to reposition.

Clicking and dragging on empty space in the ruler (other
than the top part, which is used for selecting ranges) will
allow you to reposition the playhead.

.. tip:: Hold :zbutton:`Shift` to temporarily disable snapping

Setting the Cue Point
---------------------
Double click inside the ruler to set the cue point. This
will be used to return to when playback is stopped.
