veilleConfig (since v4.0.0)

Usage

This parameter allows you to configure the standby feature built into Retorik Framework. Its definition is as follows:

interface VeilleConfiguration {
  enabled?: boolean
  killConversationOnLaunch?: boolean
  delayBeforeLaunchInSeconds?: number
  views?: {
    news?: {
      enabled: boolean
      muted?: boolean
    }
    screenSaver?: {
      enabled: boolean
      url: string
      timerBeforeSwitchInSeconds?: number
    }
    slideShow?: {
      enabled: boolean
      urls: Array<string>
      timerBeforeSwitchInSeconds?: number
    }
  }
  autoExitFromWebcam?: boolean
}

There are 4 possible screens for standby mode, one default and 3 configurable ones that cycle through in sequence.

• default: black screen with blinking text in English, visible if none of the 3 configurable screens are enabled
• configurable (in order of appearance if multiple are present):
  • screenSaver: full-page image
  • news: news channel built into Retorik Framework
  • slideShow: slideshow of one or more images

Parameters

Name	Required	Type	Description
enabled	No	boolean	Standby mode is enabled only if this parameter is true
killConversationOnLaunch	No	boolean	If this parameter is true, a new conversation will be created when entering and exiting standby mode
delayBeforeLaunchInSeconds	No	number	Delay in seconds of inactivity before standby mode is triggered
autoExitFromWebcam	No	boolean	If this parameter is true and webcam access is granted, detecting a face in front of the webcam will automatically exit standby mode
views	No	Views	Configuration of the available views

Views

Name	Required	Type	Description
news	No	News	Configuration of the news channel view
screenSaver	No	ScreenSaver	Configuration of the screen saver view
slideShow	No	SlideShow	Configuration of the slideshow view

News

Name	Required	Type	Description
enabled	Yes	boolean	The news channel view is enabled if this parameter is true
muted	No	boolean	If this parameter is true, the news channel audio will be muted

ScreenSaver

Name	Required	Type	Description
enabled	Yes	boolean	The screen saver view is enabled if this parameter is true
url	Yes	string	URL of the image to display in full page
timerBeforeSwitchInSeconds	No	number	Duration in seconds before switching to the next view (if multiple views are enabled)

SlideShow

Name	Required	Type	Description
enabled	Yes	boolean	The slideshow view is enabled if this parameter is true
urls	Yes	Array<string>	List of image URLs to display in the slideshow
timerBeforeSwitchInSeconds	No	number	Duration in seconds before switching to the next view (if multiple views are enabled)