Virbe Documentation

On face-detected

The On face-detected handler fires when the kiosk camera detects a human face approaching. Use it to greet users before they speak.

The On face-detected handler fires when the kiosk camera detects a human face within range. It is only triggered if the camera has been enabled in the kiosk configuration – see Enabling Camera Detection below. This allows your virtual being to proactively greet approaching users before they say a word – creating a more natural, welcoming experience at the kiosk.

When It Runs

This handler is triggered by the predefined face-detected signal, which fires when:

  • The camera is enabled in the kiosk's on-device settings (see Enabling Camera Detection)
  • The camera detects a human face in the frame
  • A new conversation is not already in progress (to avoid re-greeting a user mid-conversation)

This handler is Kiosk only. It requires the camera to be enabled in the kiosk app's on-device settings – this is not a Dashboard profile setting. It does nothing on web widget deployments.

Common Uses

  • Proactive greeting – Activate a greeting flow the moment a user approaches, without waiting for them to speak
  • Wake from idle – Transition the kiosk from its idle animation/state to an active ready state
  • Start session – Combine with On conversation-start to create a seamless approach-to-conversation experience

Typical Node Pattern

Signal Handler (On face-detected) ──► Activate Flow (Greet)

Or with an idle state check:

Signal Handler (On face-detected) ──► Is Flow Active? (Greet) ──► [No] ──► Activate Flow (Greet)
                                                                  └► [Yes] ──► Abandon Processing

The second pattern prevents re-triggering the greeting if it's already playing.

Available Nodes

NodeCategoryPurpose
Continue ProcessingExitPass to Conversational Flows
Abandon ProcessingExitDrop the event
Activate FlowExitTrigger a specific Conversational Flow
Check VariableContextRead a variable
Store VariableContextWrite a variable
Route by ProfileLogicBranch by touchpoint
Route by SignalLogicBranch by signal
Is Flow ActiveLogicCheck if a flow is already running
Trigger AutomationIntegrationFire an Automation
CommentOtherCanvas annotation

Example: Proactive Greeting with Guard

Prevent the greeting from firing if the kiosk is already in an active conversation:

  1. Signal Handler (On face-detected)
  2. Is Flow Active (check Main or Agent flow)
    • Active → Abandon Processing (user is already in conversation, do nothing)
    • Not active → Activate Flow (Greet)

Enabling Camera Detection

Camera-based face detection must be enabled in the kiosk settings before this handler will fire:

  1. Open kiosk application
  2. Go to app settings (tap three times in the bottom right corner of the screen)
  3. *Enter PIN if profile is protected by PIN
  4. In wake mode select: camera
  5. Save and close settings

Without this setting, the face-detected signal will never fire and this handler will remain dormant.

Hardware Requirements

For reliable face detection, follow the camera recommendations in the MetaHuman Kiosk hardware setup guide. Camera placement, lighting conditions, and frame rate all affect detection reliability.

On this page