Skip to main content

JupyterLab extension that captures microphone audio in the browser and streams it to a server-side bridge, exposing it as a virtual audio source so terminal applications running in the container (such as Claude Code voice mode) can record from the user's microphone

Project description

jupyterlab_voice_capture_extension

GitHub Actions npm version PyPI version Total PyPI downloads JupyterLab 4 Brought To You By KOLOMOLO Donate PayPal

Capture microphone audio in the JupyterLab browser tab and stream it to a server-side FIFO, so terminal applications running inside the container - notably Claude Code voice mode - can record from a microphone the container itself has no access to.

The container has no capture device; the browser does. This extension bridges that gap: the browser captures the mic, ships the audio over an authenticated websocket to a Jupyter server handler, and the handler writes raw PCM to a named pipe. A separate, out-of-scope plumbing layer (PulseAudio module-pipe-source + SoX) turns that pipe into the system default audio source.

How it works

  • Capture - a microphone toggle in the status bar calls getUserMedia; an AudioWorklet resamples to 16 kHz mono and encodes signed 16-bit little-endian PCM off the UI thread
  • Transport - 20 ms PCM frames (640 bytes) are sent as binary websocket messages to …/jupyterlab-voice-capture-extension/stream, which lives under the Jupyter base URL and inherits Jupyter token auth - no new port is opened
  • Sink - the server handler writes each frame, in order, to a FIFO (default /run/voice/pulseaudio.fifo); the PulseAudio reader creates the pipe (module-pipe-source refuses a pre-existing one), so the handler attaches as writer, waits for the pipe to appear, and tolerates a not-yet-attached reader without blocking the server

Chain: browser mic → AudioWorklet (16 kHz mono s16le) → websocket → server handler → FIFO → (PulseAudio + SoX, out of scope) → terminal app.

[!IMPORTANT] Out of scope - the extension does not manage PulseAudio, invoke SoX or any recorder, or perform speech-to-text; its responsibility ends at delivering correct PCM to the FIFO.

Requirements

  • JupyterLab >= 4.0.0
  • A secure context (https or localhost) - browsers only expose the microphone over a secure origin

Install

pip install jupyterlab-voice-capture-extension

Dependencies

  • Python: jupyter_server and traitlets, installed automatically with the package
  • System (only for the full voice chain into a terminal app): PulseAudio + SoX. Provision and verify them with the bundled CLI:
jupyterlab_voice_capture install    # apt packages + /run/voice dir + client.conf + Jupyter config line (does NOT start the daemon)
jupyterlab_voice_capture start -d   # start the PulseAudio daemon + pipe-source (run after install and each restart)
jupyterlab_voice_capture validate   # check every component, print what to fix (--json for machine output)
jupyterlab_voice_capture stop       # kill the PulseAudio daemon

See docs/jupyterlab-enable-claude-voice.md for the full setup and troubleshooting.

Usage

  • Click the microphone icon in the status bar (or run Toggle Voice Capture from the command palette) to start capture
  • On the first start the browser asks for microphone permission; the status label moves Disconnected → Connecting → Connected, the icon glows green while streaming, and the browser shows its active-microphone indicator
  • Click again to stop - capture tracks are released and the browser indicator clears
  • Only one tab streams at a time: starting capture in a second tab takes over and stops the first

Configuration

The sink FIFO path defaults to /run/voice/pulseaudio.fifo and is overridable via Jupyter server config:

c.VoiceCapture.sink_path = "/run/voice/pulseaudio.fifo"

Settings → Voice Capture has one option, Auto-connect on startup (autoConnect, default off): when enabled, capture starts automatically as JupyterLab loads instead of waiting for a click.

Uninstall

pip uninstall jupyterlab-voice-capture-extension

Troubleshoot

If you see the frontend extension but it is not working, check that the server extension is enabled:

jupyter server extension list

If the server extension is installed and enabled but you do not see the frontend extension, check the frontend extension is installed:

jupyter labextension list

Contributing

If you would like to contribute to this extension, please refer to the Contributing Guide.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyterlab_voice_capture_extension-1.0.7.tar.gz (331.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file jupyterlab_voice_capture_extension-1.0.7.tar.gz.

File metadata

File hashes

Hashes for jupyterlab_voice_capture_extension-1.0.7.tar.gz
Algorithm Hash digest
SHA256 0add6b682a321f2e7784cf8ec79b0bb21dd3bc7a561d18926aae3770ae60f2e3
MD5 7e51b67d3d9bda643efb1ce4b88b135d
BLAKE2b-256 5a98aa558a6203f93379b6a7c0b24d8f614328b54c8af29f9992ec513a6486e6

See more details on using hashes here.

File details

Details for the file jupyterlab_voice_capture_extension-1.0.7-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_voice_capture_extension-1.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 ca7f38a07cd16ebe9d83098006aec8e6bc45affca7d1a77d60efbea66d670231
MD5 ff8987b986998e4508c2117f48e54066
BLAKE2b-256 dd9e306e1dedb852c22c310533da681652e6efa4e2c680e4169c64b7c011fcd0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page