Skip to content

Connecting From Frontend

Bennett Wu edited this page Sep 24, 2025 · 3 revisions

You can either connect to node server or whipser service from the ScribeAR frontend. Node server uses whisper service for transcriptions, so the transcription features between the two options is the same. However, node server enables kiosk mode, where users can scan a QR on the frontend to receive transcriptions on their own devices.

Connecting to Node Server

  • Assuming node-server and whisper-service is running (See Deployment)
  • On the frontend
    • Select "ScribeAR Server" as the transcription source
    • Enter the websocket address for node server
      • This should be in the form: ws://${ADDRESS}:${PORT}/api/sourcesink?sourceKey=${SOURCE_KEY}
      • For example, if node server is running on a device with IP address 192.168.0.10 on port 8080 and is configured with SOURCE_KEY HHZeVZHC2CeEBoUEhB8MPA==
        • The address would be ws://192.168.0.10:8080/api/sourcesink?sourceKey=HHZeVZHC2CeEBoUEhB8MPA==

Connecting to Whisper Service

  • Assuming whisper-service is running (See Deployment)
  • On the frontend
    • Select "ScribeAR Server" as the transcription source
    • Enter the websocket address for whisper service
      • This should be in the form: ws://${ADDRESS}:${PORT}/sourcesink?sourceKey=${SOURCE_KEY}
      • For example, if whisper service is running on a device with IP address 192.168.0.10 on port 8000 and is configured with API_KEY HHZeVZHC2CeEBoUEhB8MPA
        • The address would be ws://192.168.0.10:8000/sourcesink?api_key=HHZeVZHC2CeEBoUEhB8MPA

Clone this wiki locally