viewsConfig
Views' options
The parameter viewsConfig is needed for a correct display of the views (home, news)
| Name | Required | Type | Default value | Description |
|---|---|---|---|---|
homeRoute | Yes | 'home' | 'news' | home | Defines which view will be the main one (visible at start) |
webcamRotation | No | 0 | 90 | -90 | 180 | 0 | Webcam rotation angle, when used as background screen |
views | Yes | Options of the individual views |
Options communes à toutes les vues
| Name | Required | Type | Default value | Description |
|---|---|---|---|---|
background | Yes | BackgroundOptions | Background options for the main page |
BackgroundOptions
| Name | Required | Type | Default value | Description |
|---|---|---|---|---|
style | Yes | 'image' | 'video' | 'webcam' | 'neutral' | 'image' | Background style |
image | No | string | URL of the background image | |
video | No | string | URL of the background video | |
webcam | No | string | Source of the webcam used as background screen (1) | |
neutral | No | string | Main color | Background color (not supported ATM) |
blur | No | number | 0 | Background blur effect, in pixel |
(1) For a mobile / tablet, there will generaly be a front webcam, and a back one. If not, you need to use the id of the webcam you want to use. To get the id, you can use the following method :
How to get the list of available webcams
navigator.mediaDevices.enumerateDevices().then((devices) => {
console.log(devices.filter((device) => device.kind === 'videoinput'));
});
Specific options for the news view
| Name | Required | Type | Default value | Description |
|---|---|---|---|---|
intervalInSeconds | No | number | 3 | Waiting time at the end of an information before switching to the newxt one, in seconds |
loop | No | boolean | true | Shall the informations loop and come back to the first one once the last one is finished ? |
openingVideo | No | string | URL of opening credits' video | |
endingVideo | No | string | Url of the closing credits' video | |
showMenu | No | boolean | false | Indicates whether or not the menu must be displayed in the news view (when using RetorikNews component only) |