Skip to content

Audio Capture (f8.audiocap)

No description.

  • Service class: f8.audiocap
  • Version: 0.0.1
  • Source directory: f8/audiocap
  • Tags: audio, capture, shm

When to Use

  • Use f8.audiocap as the audio capture entry point for microphone, loopback, or ASIO input.
  • Choose it when the graph needs a reusable low-latency audio SHM producer.
  • It is the usual starting point for audio-reactive graphs.

Common Wiring Patterns

  • A standard chain is f8.audiocap -> f8.audiofeat.core / f8.audiofeat.rhythm.
  • During setup, keep a f8.viz.audio branch connected so you can confirm that audio is really flowing.
  • If multiple services consume the same stream, keep audioShmName consistent across the branch.

Pitfalls / Gotchas

  • If nothing moves, first verify the selected capture device and whether another app has locked it.
  • Sample rate and buffer size directly affect latency and stability; smaller buffers are more responsive but easier to destabilize.
  • When downstream audio logic looks wrong, confirm the capture source is healthy before tuning the analysis layers.

Service Reference

How to Run

win/f8audiocap_service.exe
  • Workdir: ./
  • Environment overrides: none

Typical Inputs / Outputs

  • Data inputs: none
  • Data outputs: monitor
  • Commands: none

Service State Fields

Name Access Required On Node Schema Description
audioShmName ro true true string Name of the audio shared memory segment
audioDevice ro true false string Name of the audio capture device in use
audioSampleRate ro true false integer Sample rate of the audio capture device
audioChannels ro true false integer Number of audio channels
audioFormat ro true false string Format of the audio data
audioFramesPerChunk ro true false integer Number of audio frames per chunk
audioChunkCount ro true false integer Number of audio chunks
writeSeq ro true false integer Sequence number of the last written audio chunk
mode rw true false string Current mode of the audio capture service
toneHz rw true false number Frequency of the generated tone
gain rw true false number Gain applied to the audio signal
active rw true false boolean / default=True Service lifecycle state (activate/deactivate).
svcId ro true false string Readonly: current service instance id (svcId).

Key Fields That Matter

  • audioShmName (Audio SHM, ro): Name of the audio shared memory segment Schema: string.
  • audioDevice (Audio Device, ro): Name of the audio capture device in use Schema: string.
  • audioSampleRate (Audio Sample Rate, ro): Sample rate of the audio capture device Schema: integer.
  • audioChannels (Audio Channels, ro): Number of audio channels Schema: integer.
  • audioFormat (Audio Format, ro): Format of the audio data Schema: string.
  • audioFramesPerChunk (Audio Frames Per Chunk, ro): Number of audio frames per chunk Schema: integer.
  • audioChunkCount (Audio Chunk Count, ro): Number of audio chunks Schema: integer.
  • writeSeq (Write Sequence, ro): Sequence number of the last written audio chunk Schema: integer.

Service Commands

None

Service Data Input Ports

None

Service Data Output Ports

Name Required On Node Schema Description
monitor true false object{active, alive, cpu, error, ...} Unified runtime monitor snapshots (health/resource/perf/error).

Operators

None