feat: Rundown view, rundown header, and presenter view customization

[eol-account]

What kind of change does this PR introduce?

New feature.

What is the current behavior?

The rundown header, rundown view, and presenter screens have limited customizability.

What is the New Behavior?

Header Customizations

The header can now have a layout applied to it from settings. This setting allows elements of the header to be shown/hidden on a per-showstyle basis, but the header can also have a dashboard layout applied to it. This allows a completely custom header layout for a showstyle to be created without the need to change Sofie code.

Additionally, the option to create a custom Presenter Clock screen has been added. This is achieved using the same layout settings system, choosing a dashboard as the layout type.

Along with these two new dashboard-customizable areas, a number of dashboard panels have been implemented. See below in the section Dashboard Panels for details.

Additionally, customization options have been added to the rundown view. These include:

• Hiding the rundown divider bar

• Showing breaks as a "virtual segment" which cannot be set as next/taken, but which shows the user the point in their show at which a break occurs.

• Live line countdown requires Source Layer

  • This option can be used to prevent the countdown on the playhead from being shown unless there is an active piece on a certain source layer, e.g. VT. For details on the behaviour of this setting, see the description of the Part Timing Panel below.

• Segment countdown requires Source Layer

  • Allows the countdown to the next segment to be disabled unless the segment contains a piece on one of the specified source layers.

• Fixed duration Segment header

  • If set, the duration of the segment in the segment header will always show the planned duration, and will not count down.

Dashboard Panels

Segment Name Panel

Displays the name of either the current or the next segment. For the next segment option, if the current part is in the same segment as the next part then the next segment in playlist order will be used. If the next part is in a different segment, then the name of that segment will be shown.

Part Name Panel

Shows the name of either the current or next part (configurable through settings). If the option Show Piece Icon Color is selected, the background color of the panel will be set to the color of the "primary" piece in that part, which is determined using the same method as the presenter screen uses for displaying icons for the next part.

Text Label Panel

Allows any custom text to be written on a dashboard, this text is static and designed to be used as a layout element to help label sections of the dashboard. Text size will scale with the scale property of the panel.

Studio Name Panel

When in the shelf, this panel shows the name of the studio the playlist is attached to. When in views like the presenter screen, this panel shows the studio name of the studio the view is for.

Part Timing Panel

This panel has two modes, count_up and count_down, count_up will start counting from 0 when the part starts playback and acts as a simple time-elapsed display. The count_down mode will count down from the Part's planned duration to 0, then will start counting up after the planned duration has passed; the text will also turn read and bold, much like the playhead timer, to indicate that the user is over time. The title text will change based on the mode selected.

The panel also has the option to require that certain sourcelayers be present for the count up/down to start counting. If "Require Piece on Source Layer" (Required Layers) is set, any of the selected source layers must contain an active piece for the countdown to be active. If "Also Require Source Layers" (Additional Layers) is also set, then any of those selected sourcelayers must be active as well as the "Required" sourcelayers. If "Require All Additional Source Layers" is checked then everything under "Additional Layers" must have an active piece.

For example, by specifying:

• Required: VT, VO
• Also Require: Script, Mic
• Require All: Yes

The count up/down will only happen when there is a piece on either the VT or the VT layers, and there is a piece on both the Script and Mic layers. If "Require All" was not selected, then either Mic or Script would need to contain an active piece.

The "Hide Label" option with hide the text "Part Count (Up/Down)", leaving just the timer.

Segment Timing Panel

This panel behaves much the same as the Part Timing Panel, but for the current Segment.

Time of Day Panel

Shows the current time, same as the clock in the header of the rundown view.

System Status Panel

Shows the system status icons.

Playlist Name Panel

Shows the name of the current playlist and, optionally, the name of the current rundown.

End Words Panel

Shows the end words from a piece containing script content. The layers to search for script content can be specified using the "Script Source Layers" option. Whether the end words are shown can be controlled using the same method as controlling the time display for the Part and Segment timing panels.

The amount of text shown is dependent on the width of the panel. Text will be prefixed with ellipses in the case that the ends words text is too long to fit in the box, ensuring that the final words are always visible.

Playlist Start Timer Panel

Shows the start time of the playlist and associated timers, using the same component as the rundown header. The text label above the Planned Start is customizable, and the counters and labels can be hidden so that different parts of the timer can be displayed separately in dashboard views.

Playlist End Timer Panel

Same as above but for the Planned End timer.

Colored Box Panel

Allows drawing a solid-colour box in a dashboard, to help visually distinguish areas of the layout and to help group components together.

Other Information:

Status

[X] Code documentation for the relevant parts in the code have been added/updated by the PR author

[X] The functionality has been tested by the PR author

[ ] The functionality has been tested by NRK