Skip to content

Commit 97fd35d

Browse files
authored
chore: Update description of parameters
Work in progress.
1 parent fa2f4fe commit 97fd35d

File tree

1 file changed

+16
-13
lines changed

1 file changed

+16
-13
lines changed

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

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,22 @@ sidebar_position: 10
44
---
55

66
# URL Query Parameters
7-
Appending query parameters to the URL will allow you to modify the behaviour of the GUI, as well as control the access level.
7+
Appending query parameter(s) to the URL will allow you to modify the behaviour of the GUI, as well as control the [access levels](../user-guide/features/access-levels.md).
88

99
| Query Parameter | Description |
1010
| :---------------------------------- | :------------------------------------------------------------------------ |
11-
| `?admin=0,1` | Default value is `0`. |
12-
| `?studio=0,1` | Default value is `0`. |
13-
| `?display=layout,buckets,inspector` | A comma-separated list of features to be displayed in the shelf. Available values are: `layout` \(for displaying the Rundown Layout\), `buckets` \(for displaying the Buckets\) and `inspector` \(for displaying the Inspector\). |
14-
| `?buckets=0,1,...` | The buckets can be specified as base-0 indices of the buckets as seen by the user. This means that `?buckets=1` will display the second bucket as seen by the user when not filtering the buckets. This allows the user to decide which bucket is displayed on a secondary attached screen simply by reordering the buckets on their main view. |
15-
| `?shelffollowsonair=0,1` | |
16-
| `?speak=0,1` | Default value is `0`. |
17-
| `?vibrate=0,1` | Default value is `0`. |
18-
| `?help=0,1` | Default value is `0`. |
19-
| `?zoom=0,1` | Default value is `0`. |
20-
| `?show_hidden_source_layers=0,1` | Default value is `0`. |
21-
| `?ignore_piece_content_status=0,1` | Default value is `0`. |
22-
| `?reportNotificationsId=0,1` | Default value is `0`. |
11+
| `admin=1` | Gives the GUI the same access as the combination of [Configuration Mode](../user-guide/features/access-levels.md#Configuration-Mode) and [Studio Mode](../user-guide/features/access-levels.md#Studio-Mode) as well as having access to a set of [Testing Mode](../user-guide/features/access-levels.md#Testing-Mode) tools and a Manual Control section on the Rundown page. _Default value is `0`._ |
12+
| `studio=1` | [Studio Mode](../user-guide/features/access-levels.md#Studio-Mode) gives the GUI full control of the studio and all information associated to it. This includes allowing actions like activating and deactivating rundowns, taking parts, adlibbing, etcetera. _Default value is `0`._ |
13+
| `buckets=0,1,...` | The buckets can be specified as base-0 indices of the buckets as seen by the user. This means that `?buckets=1` will display the second bucket as seen by the user when not filtering the buckets. This allows the user to decide which bucket is displayed on a secondary attached screen simply by reordering the buckets on their main view. |
14+
| `display=layout,buckets,inspector` | A comma-separated list of features to be displayed in the shelf. Available values are: `layout` \(for displaying the Rundown Layout\), `buckets` \(for displaying the Buckets\) and `inspector` \(for displaying the Inspector\). |
15+
| `help=1` | Enables some tooltips that might be useful to new users. _Default value is `0`._ |
16+
| `ignore_piece_content_status=1` | Removes the "zebra" marking on VT pieces that have a "missing" status. _Default value is `0`._ |
17+
| `reportNotificationsId=0,1,...` | Allows you to set a specific `reportNotificationsId`. _Default value is `0`, meaning the that default ID (i.e. not `0`) will be used._ |
18+
| `shelffollowsonair=1` | _Default value is `0`._ |
19+
| `show_hidden_source_layers=1` | _Default value is `0`._ |
20+
| `speak=1` | _Default value is `0`._ |
21+
| `vibrate=1` | _Default value is `0`._ |
22+
| `zoom=1` | _Default value is `0`._ |
23+
24+
25+

0 commit comments

Comments
 (0)