Skip to content

Commit c30340e

Browse files
committed
docs: Add comprehensive timing and preparation guide
- Add timing-and-preparation.md covering lookahead, preroll, preliminary, and transitions - Add glossary.md with definitions of all key Sofie concepts - Document how timing mechanisms work together with adlibs - Explain device latency compensation strategies - Add cross-references between related documentation pages This addresses common questions about when to use each timing mechanism and how they interact, especially for adlib scenarios where lookahead cannot predict operator actions.
1 parent 6cff2ff commit c30340e

File tree

5 files changed

+713
-0
lines changed

5 files changed

+713
-0
lines changed

packages/documentation/docs/for-developers/for-blueprint-developers/ab-playback.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44
Prior to 1.50 of Sofie, this was implemented in Blueprints and not natively in Sofie-core
55
:::
66

7+
:::tip See Also
8+
For how AB Playback works with lookahead, preroll, and adlibs, see the [Timing and Preparation Guide](./timing-and-preparation.md).
9+
:::
10+
711
_AB Playback_ is a common technique for clip playback. The aim is to be able to play multiple clips back to back, alternating which player is used for each clip.
812
At first glance it sounds simple to handle, but it quickly becomes complicated when we consider the need to allow users to run adlibs and that the system needs to seamlessly update pre-programmed clips when this happens.
913

packages/documentation/docs/for-developers/for-blueprint-developers/lookahead.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Lookahead
22

3+
:::tip See Also
4+
For a comprehensive guide on how lookahead works together with preroll, preliminary, transitions, and adlibs, see the [Timing and Preparation Guide](./timing-and-preparation.md).
5+
:::
6+
37
Lookahead allows Sofie to look into future Parts and Pieces, in order to preload or preview what is coming up. The aim is to fill in the gaps between your TimelineObjects with lookahead versions of these objects.
48
In this way, it can be used to provide functionality such as an AUX on your vision mixer showing the next cut, or to load the next clip into the media player.
59

packages/documentation/docs/for-developers/for-blueprint-developers/part-and-piece-timings.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@ import { PartTimingsDemo } from './_part-timings-demo'
22

33
# Part and Piece Timings
44

5+
:::tip See Also
6+
For practical guidance on using preroll, transitions, lookahead together with adlibs, see the [Timing and Preparation Guide](./timing-and-preparation.md).
7+
:::
8+
59
Parts and pieces are the core groups that form the timeline, and define start and end caps for the other timeline objects.
610

711
When referring to the timeline in this page, we mean the built timeline objects that is sent to playout-gateway.

0 commit comments

Comments
 (0)