Skip to content

Commit 6c030a4

Browse files
authored
chore: Create url-query-parameters.md
Created a page that lists all available URL query parameters.
1 parent c99c2a6 commit 6c030a4

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
sidebar_label: URL Query Parameters
3+
sidebar_position: 10
4+
---
5+
6+
# 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.
8+
9+
| Query Parameter | Description |
10+
| :---------------------------------- | :------------------------------------------------------------------------ |
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`. |

0 commit comments

Comments
 (0)