Skip to content

Commit 44b581f

Browse files
committed
chore: update documentation
1 parent b7e8af4 commit 44b581f

2 files changed

Lines changed: 20 additions & 1 deletion

File tree

packages/documentation/docs/for-developers/url-query-parameters.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,4 @@ Appending query parameter(s) to the URL will allow you to modify the behaviour o
2323
| `vibrate=1` | Experimental feature that triggers the vibration API in the web browser 3 seconds before each planned _Take_. _Default value is `0`._ |
2424
| `zoom=100,...` | Sets the scaling of the entire GUI. _The unit is a percentage where `100` is the default scaling._ **Passing any `zoom` parameter will cause it to be stored in the browser's local storage as `uiZoomLevel` and will then be used for future sessions without notifying the user that they are using the Sofie GUI at a non-standard size!** |
2525
| `hideRundownHeader=1` | Hides header on [Rundown view](../user-guide/features/sofie-views-and-screens#rundown-view) and [Active Rundown screen](../user-guide/features/sofie-views-and-screens#active-rundown-screen). _Default value is `0`._ |
26+
| `lockView=1` | Locks the [Active Rundown screen](../user-guide/features/sofie-views-and-screens#active-rundown-screen) for unattended or kiosk use: hides exit controls (header close button and context menu “Close Rundown”), disables the in-app navigation confirmation when a rundown is active, and shows the [Screensaver](../user-guide/features/sofie-views-and-screens#screensaver) when no rundown is active instead of a message with a link back to the lobby. Only applies on `/activeRundown/:studioId` routes (ignored on `/rundown/:playlistId`). _Default value is `0`._ |

packages/documentation/docs/user-guide/features/sofie-views-and-screens.mdx

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -347,6 +347,20 @@ Example: [http://127.0.0.1/countdowns/studio0/camera?sourceLayerIds=camera0,dve0
347347

348348
A page which automatically displays the currently active rundown. Can be useful for the producer to have on a secondary screen.
349349

350+
When no rundown is active, a message is shown with a link back to the rundown list.
351+
352+
This screen can be configured using query parameters:
353+
354+
| Query parameter | Type | Description | Default |
355+
| :-------------- | :---- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------ |
356+
| `lockView` | 0 / 1 | Locks the view for unattended or kiosk displays. Hides the header close button and the context menu “Close Rundown” action, and disables the in-app navigation confirmation when a rundown is active. When no rundown is active, shows the [Screensaver](#screensaver) instead of the default idle message. Does not block browser back, manual URL changes, or closing the tab. Only applies on Active Rundown routes (not on a specific `/rundown/:playlistId` URL). | `0` |
357+
358+
Example (locked Active Rundown for a secondary monitor):
359+
360+
`http://localhost:3000/activeRundown/studio0?lockView=1`
361+
362+
Other query parameters for the rundown view itself (such as `hideRundownHeader` and layout selection) can be combined with `lockView`. See [URL Query Parameters](../../for-developers/url-query-parameters.md).
363+
350364
### Active Rundown Shelf Screen
351365

352366
`/activeRundown/:studioId/shelf`
@@ -357,6 +371,10 @@ A screen which automatically displays the currently active rundown, and shows th
357371

358372
A shelf layout can be selected by modifying the query string, see [Shelf Layouts](#shelf-layouts).
359373

374+
The `lockView` parameter described above also applies to this route. Example:
375+
376+
`http://localhost:3000/activeRundown/studio0/shelf?lockView=1&layout=Stream`
377+
360378
### Specific Rundown Shelf Screen
361379

362380
`/rundown/:rundownId/shelf`
@@ -379,7 +397,7 @@ Each embedded screen shows a label to identify it. This screen is mostly intende
379397

380398
### Screensaver
381399

382-
When big screen displays \(like Prompter Screen and the Presenter Screen\) do not have any meaningful content to show, an animated screensaver showing the current time and the next planned show will be displayed. If no Rundown is upcoming, the Studio name will be displayed.
400+
When big screen displays \(like Prompter Screen, the Presenter Screen, and the Active Rundown Screen with `lockView=1`\) do not have any meaningful content to show, an animated screensaver showing the current time and the next planned show will be displayed. If no Rundown is upcoming, the Studio name will be displayed.
383401

384402
![A screensaver showing the next scheduled show](/img/docs/main/features/next-scheduled-show-example.png)
385403

0 commit comments

Comments
 (0)