The theme
=========
-**NOTE**: Nageru 1.9.0 made significant improvements to themes
-and how scenes work. If you use an older version, you may want
-to look at `the 1.8.6 documentation <https://nageru.sesse.net/doc-1.8.6/>`_;
-themes written for older versions still work without modification in
-1.9.0, but are not documented here, and you are advised to change
-to use the new interfaces, as they are equally powerful and much simpler
-to work with.
-
In Nageru, most of the business logic around how your stream
ends up looking is governed by the **theme**, much like how a
theme works on a blog or a CMS. Most importantly, the theme
If the first function is called with a true value (at the start of the theme),
the channel will get a “Set WB” button next to it, which will activate a color
picker, to select the gray point. To actually *apply* this white balance change,
-you have two options. If you're using Nageru 1.9.2 or newer, it's as simple
-as adding one element to the scene::
+add the white balance element to the scene::
scene:add_white_balance()
e.g. a mix of several inputs, such as a camera and an overlay, you will need to
give the input to fetch white balance from as as a parameter.)
-If, on the other hand, you are using Nageru 1.9.1 or older (or just wish
-for more manual control), there's an entry point you will need to implement::
-
- function set_wb(channel, red, green, blue)
-
-When the user picks a gray point, this function
-function will be called (with the RGB values in linear light—not sRGB!),
-and the theme can then use it to adjust the white balance for that channel.
-The typical way to to this is to have a *WhiteBalanceEffect* on each input
-and set its “neutral_color” parameter using the “set_vec3” function.
-
More complicated channels: Composites
-------------------------------------
resample_effect:always_disable_if_disabled(crop_effect)
-Also, since Nageru 1.9.1, you can disable an optional effect if a given other
+Also, you can disable an optional effect if a given other
effect is *enabled*::
overlay1_effect:promise_to_disable_if_enabled(overlay2_effect)
runtime.) It can still be useful for reducing the number of alternatives, though.
For more advanced exclusions, you may choose to split up the scenes into several
-distinct ones that you manage yourself; indeed, before Nageru 1.9.0, that was
-the only option. At some point, however, you may choose to simply accept the
-added startup time and a bit of extra RAM cost; ease of use and flexibility often
-trumps such concerns.
+distinct ones that you manage yourself. At some point, however, you may choose
+to simply accept the added startup time and a bit of extra RAM cost; ease of
+use and flexibility often trumps such concerns.
.. _menus:
Before you attempt to control audio from the theme, be sure to have read
the documentation about :doc:`audio`.
-Since Nageru 1.9.2, the theme has a certain amount of control over the audio
+The theme has a certain amount of control over the audio
mix, assuming that you are in multichannel mode. This is useful in particular
to be able to set defaults, if e.g. one channel should always be muted at
startup, or to switch in/out certain channels depending on whether they are
--------------------------
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**::
+If so, it is possible to declare a function **format_status_line**::
function format_status_line(disk_space_text, file_length_seconds)
if file_length_seconds > 86400.0 then
projects / nageru-docs / blobdiff