Document overriding the status line, from Nageru 1.9.1.

[nageru-docs] / theme.rst

diff --git a/theme.rst b/theme.rst
index 2e70ca9db8004b9fe44d579d05e78818fea3c66e..2e8b6663b0ccddd05fe1314502ff9c5d2cf040f5 100644 (file)
--- a/theme.rst
+++ b/theme.rst
@@ -203,6 +203,9 @@ you must set it directly on the effect::
   input0_scaled:set_int("width", 1280)  -- Set on both alternatives.
   input0_scaled:set_int("height", 720)
 
+  -- This is also possible, as choose() returns the chosen effect:
+  input0_scaled:choose(ResampleEffect):set_float("zoom_y", 1.0001)
+
 Actually, more versions are created than you'd immediately expect.
 In particular, the output format for the live output and all previews are
 different (Y'CbCr versus RGBA), which is also handled transparently for you.
@@ -493,3 +496,22 @@ or frame rate:
 You can use this either for display purposes, or for choosing the right
 effect alternatives. In particular, you may want to disable scaling if
 the frame is already of the correct resolution.
+
+
+Overriding the status line
+--------------------------
+
+Some users may wish to override the status line, e.g. with recording time.
+If so, it is possible (since Nageru 1.9.1) to declare a function **format_status_line**::
+
+  function format_status_line(disk_space_text, file_length_seconds)
+    if file_length_seconds > 86400.0 then
+      return "Time to make a new segment"
+    else
+      return "Disk space left: " .. disk_space_text
+    end
+  end
+
+As demonstrated, it is given the disk space text (that would normally
+be there), and the length of the current recording file in seconds.
+HTML is supported.