GET
Get the personalization settings.
| Responses | |
| 200 | GET successful. |
| Response (application/json): object | ||
| Member | Type | Description |
language | string | The language that will be used for all on-screen messages and the ClickShare Instructions wallpaper. The possible values can be retrieved using the supportedLanguages parameter. Example: English |
location | string | The meeting room location that may be displayed. Example: South |
meetingRoomName | string | The meeting room name that may be displayed. Example: MR Antarctica |
screenIdOverlay | string | Choose how to display the status information: Standard (in the Floating Box) or Small (in the bottom Status Bar). Since version: 2.15 |
screensaver | object | The settings related to the screensaver. |
mode | string | Example: HDMI Since version: 2.10 |
state | boolean | Indicates if the screensaver is currently active or not. Since version: 2.10 read-only |
supportedModes | array | The supported screensaver modes. Example: ['Default', 'DisplayPort', 'HDMI'] Since version: 2.10 read-only |
supportedTimeouts | array | The supported values for the timeout. Example: ['Infinite', '10', '60'] read-only |
timeout | string | The period of inactivity in minutes after which the screen saver starts. If this parameter is set to 'Infinite', the screen saver is disabled. Otherwise, the value should be smaller than the value specified in 'standbyTimeout'. The supported values are in the supportedTimeouts field. Example: Infinite |
showNetworkInfo | boolean | Shows network information on display. Since version: 2.1 |
showWallpaper | boolean | Shows wallpaper information on display. Since version: 2.8 |
supportedLanguages | array | The list of possible values that can be used for the 'language' parameter. Example: ['English', 'Dutch'] read-only |
supportedScreenIdOverlays | array | Supported overlays for status information. Example: ['Standard', 'Small'] Since version: 2.15 read-only |
theaterMode | object | |
enabled | boolean | Enable the TheaterMode, hiding the statusbar when sharing. Since version: 2.4 |
welcomeMessage | string | The welcome message that may be displayed. Example: Welcome to Antarctica |