Documentation Index
Fetch the complete documentation index at: https://docs.simular.ai/llms.txt
Use this file to discover all available pages before exploring further.
Class: LoopbackSource
Defined in: index.d.ts:647 A loopback capture source that records system audio output (what the user hears through their speakers or headphones). Loopback capture is inherently platform-specific: macOS usesScreenCaptureKit (requires screen-recording permission), Windows
uses WASAPI loopback mode, and Linux uses PulseAudio/PipeWire
monitor sources.
Constructors
Constructor
new LoopbackSource(Defined in: index.d.ts:658 Opens a loopback capture stream for the given format.channels,sampleRate):LoopbackSource
channels is the number of interleaved channels (1 = mono,
2 = stereo). sample_rate is samples per second per channel
(e.g. 44100, 48000).
The stream does not begin producing samples until start() is
called.
Parameters
channels
number
sampleRate
number
Returns
LoopbackSource
Accessors
channels
Get Signature
get channels(): number
Defined in: index.d.ts:670
Number of interleaved channels (1 = mono, 2 = stereo).
Returns
number
sampleRate
Get Signature
get sampleRate(): number
Defined in: index.d.ts:672
Samples per second per channel (e.g. 44100, 48000).
Returns
number
Methods
drain()
drain(): SamplesBuffer
Defined in: index.d.ts:686
Drains all buffered samples and returns them as a SamplesBuffer.
Typical usage: call start(), do work while audio accumulates in
the background, call stop(), then call drain() to collect
everything that was captured.
Returns
SamplesBuffer
record()
record(Defined in: index.d.ts:678 Blocks for exactlydurationMs):SamplesBuffer
duration_ms and returns the captured audio as
a SamplesBuffer. Useful for streaming fixed-size chunks while
the source is still running.
Parameters
durationMs
number
Returns
SamplesBuffer
start()
start(): void
Defined in: index.d.ts:663
Begin capturing system audio. Must be called before record()
or drain().
Returns
void
stop()
stop(): void
Defined in: index.d.ts:668
Stop capturing. May be started again with start(). After
stopping, call drain() to collect remaining buffered samples.
Returns
void