Update the video menu for time code.

[nageru-docs] / gettingstarted.rst

diff --git a/gettingstarted.rst b/gettingstarted.rst
index 463a4b3fee9b0e3a8efe68c8b35f0406bea36f6b..e2e37005d7bbbc607110019e807cbd0bec03c085 100644 (file)
--- a/gettingstarted.rst
+++ b/gettingstarted.rst
@@ -3,7 +3,8 @@ Getting started
 
 Welcome to Nageru! For simple use, you can jump right in and make yourself
 comfortable (at least if you have the :doc:`hardware requirements <hardware>`
 
 Welcome to Nageru! For simple use, you can jump right in and make yourself
 comfortable (at least if you have the :doc:`hardware requirements <hardware>`

-in place), but if you prefer a gentler introduction, this is the place.
+in place and have `compiled it <compile>`_), but if you prefer a gentler introduction,
+this is the place.

 
 
 Introduction to the M/E workflow
 
 
 Introduction to the M/E workflow


@@ -43,11 +44,14 @@ preview (using the 1–9 keys) and the right hand to choose a transition
 (using J, K or L). In addition, audio can be controlled using a MIDI controller
 if you want to; see the :doc:`audio <audio>` page for more information.
 
 (using J, K or L). In addition, audio can be controlled using a MIDI controller
 if you want to; see the :doc:`audio <audio>` page for more information.
 

+

 Channels
 ''''''''
 
 The preview and live displays are the most important part of the UI,
 Channels
 ''''''''
 
 The preview and live displays are the most important part of the UI,

-and thus take up the bulk of the space. As you can see, we have only
+and thus take up the bulk of the space. In addition, we have the list
+of channels and scenes (the side-by-side view and the static image)
+along the bottom. As you can see, we have only

 one (rather boring) input connected, and it is live. The other input is
 disconnected and thus shows only a test color. These correspond to pressing
 the 1 and 2 keys on the keyboard to activate preview, respectively—or you can
 one (rather boring) input connected, and it is live. The other input is
 disconnected and thus shows only a test color. These correspond to pressing
 the 1 and 2 keys on the keyboard to activate preview, respectively—or you can


@@ -62,6 +66,15 @@ Finally, we have a static image. The one included with Nageru is rather
 bland and generic, but it works as a generic pause image when you don't
 really want anything on the screen.
 
 bland and generic, but it works as a generic pause image when you don't
 really want anything on the screen.
 

+For any given channel, you can see that it is active in the live or preview
+by looking at its border. If it's got a red border, as in the leftmost
+input, it's live (either on its own, or as part of the side-by-side view).
+Similarly, if it's got a green border, as in the second input (you can
+see it if you look closely; it's a somewhat lighter shade of green),
+it will be marked with green. On conflict, red (live) wins, since it is
+the most important piece of information.
+
+

 Transitions
 '''''''''''
 
 Transitions
 '''''''''''
 


@@ -110,8 +123,13 @@ The video menu contains the following elements:
     You can achieve the same effect as this option by sending
     SIGHUP to the Nageru process.
 
     You can achieve the same effect as this option by sending
     SIGHUP to the Nageru process.
 

+  * **Open frame analyzer:** See :doc:`analyzer` for more information.
+

   * **Change x264 bitrate:** See :doc:`streaming` for more information.
 
   * **Change x264 bitrate:** See :doc:`streaming` for more information.
 

+  * **HDMI/SDI output device, HDMI/SDI output resolution, Display time code:**
+    See :doc:`hdmisdi` for more information.
+

   * **Exit:** Exits Nageru, obviously.
 
 The audio menu is explained in the section on :doc:`audio <audio>`.
   * **Exit:** Exits Nageru, obviously.
 
 The audio menu is explained in the section on :doc:`audio <audio>`.


@@ -156,6 +174,16 @@ The options presented are as follows:
    cards that can handle it in hardware), but a simple option (“Scan”)
    is available to try all modes in turn until a signal is received.
 
    cards that can handle it in hardware), but a simple option (“Scan”)
    is available to try all modes in turn until a signal is received.
 

+ * **Input interpretation:** Choose how the Y'CbCr values in the input signal
+   are to be interpreted. *Auto* will choose whatever is correct (as per the
+   appropriate standards) for the current video mode, but occasionally,
+   devices will get this wrong, and you will need to change this setting
+   to get correct colors. You can use the *--input-ycbcr-interpretation=*
+   command-line option to achieve the same effect.
+
+   See :doc:`analyzer` for figuring out if you need to change this.
+   If unsure, leave it unchanged.
+

  * **Use as audio source:** See the :doc:`audio <audio>` page for more
    information. For simple audio only; unavailable in multichannel mode.
 
  * **Use as audio source:** See the :doc:`audio <audio>` page for more
    information. For simple audio only; unavailable in multichannel mode.