From: Steinar H. Gunderson <sgunderson@bigfoot.com>
Date: Sun, 12 Apr 2020 11:37:17 +0000 (+0200)
Subject: Document overriding the status line, from Nageru 1.9.1.
X-Git-Url: https://git.sesse.net/?a=commitdiff_plain;h=c968d8319a8f77ed3777094d824690904cd0f43b;p=nageru-docs

Document overriding the status line, from Nageru 1.9.1.
---

diff --git a/theme.rst b/theme.rst
index 7fbe735..2e8b666 100644
--- a/theme.rst
+++ b/theme.rst
@@ -496,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.