Skip to main content

viewsConfig

Views' options

The parameter viewsConfig is needed for a correct display of the views (home, news)

NameRequiredTypeDefault valueDescription
homeRouteYes'home' | 'news'homeDefines which view will be the main one (visible at start)
webcamRotationNo0 | 90 | -90 | 1800Webcam rotation angle, when used as background screen
viewsYesOptions of the individual views

Options communes à toutes les vues

NameRequiredTypeDefault valueDescription
backgroundYesBackgroundOptions Background options for the main page

BackgroundOptions

NameRequiredTypeDefault valueDescription
styleYes'image' | 'video' | 'webcam' | 'neutral''image'Background style
imageNostringURL of the background image
videoNostringURL of the background video
webcamNostringSource of the webcam used as background screen (1)
neutralNostringMain colorBackground color (not supported ATM)
blurNonumber0Background 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

NameRequiredTypeDefault valueDescription
intervalInSecondsNonumber3Waiting time at the end of an information before switching to the newxt one, in seconds
loopNobooleantrueShall the informations loop and come back to the first one once the last one is finished ?
openingVideoNostringURL of opening credits' video
endingVideoNostringUrl of the closing credits' video
showMenuNobooleanfalseIndicates whether or not the menu must be displayed in the news view (when using RetorikNews component only)