Skip to content

Commit 2188651

Browse files
committed
docs: Document new fullscren parameter for screens
1 parent 7ba4b71 commit 2188651

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,8 @@ Bookmark the "Available screens" view for your studio (e.g., `/countdowns/studio
271271

272272
## Sofie Screens
273273

274+
All Screens support a `?fullscreen=1` query parameter. When this parameter is present, the screen will display a semi-transparent overlay prompting the user to click anywhere to enter fullscreen mode. Once fullscreen is entered, the overlay disappears. If the user exits fullscreen, the overlay will reappear.
275+
274276
### Prompter Screen
275277

276278
`/prompter/:studioId`
@@ -335,7 +337,6 @@ This screen can be configured using query parameters:
335337
| :--------------- | :----- | :--------------------------------------------------------------------------------------------------------- | :----------- |
336338
| `sourceLayerIds` | string | A comma-separated list of Source Layer IDs to be considered for display | _(show all)_ |
337339
| `studioLabels` | string | A comma-separated list of Studio Labels (Piece `.content.studioLabel` values) to be considered for display | _(show all)_ |
338-
| `fullscreen` | 0 / 1 | Should the screen be shown fullscreen on the device on first user interaction | 0 |
339340

340341
Example: [http://127.0.0.1/countdowns/studio0/camera?sourceLayerIds=camera0,dve0&studioLabels=1,KAM%201,K1,KAM1&fullscreen=1](http://127.0.0.1/countdowns/studio0/camera?sourceLayerIds=camera0,dve0&studioLabels=1,KAM%201,K1,KAM1&fullscreen=1)
341342

0 commit comments

Comments
 (0)