veilleConfig (depuis v4.0.0)

Utilisation

Ce paramètre permet de configurer la fonctionnalité de veille intégrée dans Retorik Framework. Sa définition est la suivante :

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
}

Il existe 4 écrans possibles pour la veille, un par défaut et 3 paramétrables qui passent de l'un à l'autre en séquence.

• défaut : écran noir avec un texte clignotant en Anglais, viible si aucun des 3 écrans paramétrables n'est activé
• paramétrables (dans l'ordre d'apparition si plusieurs sont présents) :
  • screenSaver : image en pleine page
  • news : chaîne info intégrée dans Retorik Framework
  • slideShow : défilement d'une ou plusieurs images

Paramètres

Nom	Requis	Type	Description
enabled	Non	boolean	La veille est activée si ce paramètre est true uniquement
killConversationOnLaunch	Non	boolean	Si ce paramètre est true, une nouvelle conversation sera créée à l'entrée en veille et à sa sortie
delayBeforeLaunchInSeconds	Non	number	La veille est activée si ce paramètre est true uniquement
autoExitFromWebcam	Non	boolean	Si ce paramètre est true et que l'accès à une webcam est accepté, la détection d'un visage devant la webcam fera automatiquement sortir l'application de veille
views	Non	Views	Configuration des vues disponibles

Views

Nom	Requis	Type	Description
news	Non	News	Configuration de la vue chaîne info
screenSaver	Non	ScreenSaver	Configuration de la vue économiseur d'écran
slideShow	Non	SlideShow	Configuration de la vue diaporama

News

Nom	Requis	Type	Description
enabled	Oui	boolean	La vue chaîne info est activée si ce paramètre est true
muted	Non	boolean	Si ce paramètre est true, le son de la chaîne info sera coupé

ScreenSaver

Nom	Requis	Type	Description
enabled	Oui	boolean	La vue économiseur d'écran est activée si ce paramètre est true
url	Oui	string	URL de l'image à afficher en pleine page
timerBeforeSwitchInSeconds	Non	number	Durée en secondes avant de passer à la vue suivante (si plusieurs vues sont activées)

SlideShow

Nom	Requis	Type	Description
enabled	Oui	boolean	La vue diaporama est activée si ce paramètre est true
urls	Oui	Array<string>	Liste des URLs des images à afficher en défilement
timerBeforeSwitchInSeconds	Non	number	Durée en secondes avant de passer à la vue suivante (si plusieurs vues sont activées)