FAQ.md: Outlook for upcoming Liquidsoap 2.3.0

FAQ.md

@@ -1,5 +1,5 @@
 ---
-date: 2024-06-20
+date: 2024-06-23
 author: Matthias C. Hormann (Moonbase59)
 ---
 # FAQ – Frequently Asked Questions
@@ -24,6 +24,7 @@ author: Matthias C. Hormann (Moonbase59)
 - [How to ensure Autocue doesn’t try to process video files?](#how-to-ensure-autocue-doesnt-try-to-process-video-files)
 - [Why should I use `check_autocue_setup`, and what does it do?](#why-should-i-use-check_autocue_setup-and-what-does-it-do)
 - [What are good first steps to use Autocue in my own Liquidsoap script?](#what-are-good-first-steps-to-use-autocue-in-my-own-liquidsoap-script)
+- [What will happen when I switch to the upcoming Liquidsoap 2.3.0?](#what-will-happen-when-i-switch-to-the-upcoming-liquidsoap-230)
 <!-- Generated by gh-toc, https://moonbase59.github.io/gh-toc/ -->
 <!-- ToC end -->
 
@@ -298,3 +299,26 @@ Plan for _diagnostics logging_. The Liquidsoap integration layer might change th
 Good examples for all this are in [`test_autocue.cue_file.liq`](test_autocue.cue_file.liq). Study the `def live_aware_crossfade(old, new)` and `def show_meta(m)` function definitions and their usage.
 
 Have fun!
+
+
+## <a name="what-will-happen-when-i-switch-to-the-upcoming-liquidsoap-230"></a>What will happen when I switch to the upcoming Liquidsoap 2.3.0? <a href="#toc" class="goToc">⇧</a>
+
+Nothing is definite yet, Liquidsoap 2.3.0 is still under heavy development.
+
+Most certainly, as of 2024-06-23…
+
+- you will need a _new version_ 5.x.x of both `autocue.cue_file` and `cue_file`, because Liquidsoap will change the tags and API.
+- you’ll need to _pre-process your files again_, if you have used that feature.
+- I will see that `cue_file` will be able to _remove obsolete tags_.
+- if possible, I’ll do some _checking_ so that you don’t run `autocue.cue_file` (and thus `cue_file`) under an incompatible Liquidsoap version. The `check_autocue_setup()` function will take care of that.
+- `liq_fade_in` might change to `liq_fade_in_duration`.
+- `liq_fade_out` might change to `liq_fade_out_duration`.
+- `liq_cross_duration` will be split into
+  - `liq_cross_start_duration` and
+  - `liq_cross_end_duration`,
+
+  which makes some internal handling much more straightforward.
+
+See also:
+
+- https://github.com/savonet/liquidsoap/pull/3931#issuecomment-2184937173