Output transport
Attach a playback process to a session:
sink = %Membrane.PortAudio.Sink{latency: :low, ringbuffer_size: 2048, portaudio_buffer_size: 256}{:ok, playback} = AudioFlow.Playback.start_link(sink: sink){:ok, session} = AudioFlow.start_session( Keyword.put(session_options, :output, {AudioFlow.Playback, playback}))The application selects the sink. A sound device opens only when PCM arrives.
Each turn gets its own output pipeline. The queue is limited by :max_bytes
(96,000 by default). One further chunk can wait for capacity. Each chunk must fit
within that limit. A full queue blocks the turn worker, while cancellation stays
available in the session. Membrane input prefetch is limited to one buffer; the
device has its own ring buffer. PCM chunks must keep the same sample rate
throughout a turn.
Drain and flush
Section titled “Drain and flush”Normal completion drains queued output. The playback process sends :drained
after pipeline cleanup. Inference :done can arrive before playback finishes.
PortAudio output is padded to a whole device block and has a final ring-buffer
drain interval before close.
Cancellation drops the queue and closes the old pipeline before it
acknowledges. Old turn references are rejected. A completed inference turn can
still be cancelled while its audio is queued. Session exit also closes its output
pipeline.
Events
Section titled “Events”The observer receives {AudioFlow.Playback, pid, turn_key, event}. Events
include :drained, {:first_buffer, %{elapsed_us: us}},
{:flushed, %{control_us: us}}, back pressure, and failure. First-buffer time ends at the Membrane source, and flush time ends after pipeline
cleanup. Neither is a microphone-to-speaker measurement. A device close can drain
a short native buffer. Acoustic interruption latency needs a
loopback recording and a common clock.
Custom transports
Section titled “Custom transports”AudioFlow.Output defines the transport interface for other output engines.
push/3 runs in the turn worker, so it can apply back pressure. flush/2 must
release blocked producers and stop old output. Use a separate playback process
for each session.
Full media example
Section titled “Full media example”AUDIOFLOW_ML=1 AUDIOFLOW_MEDIA=1 AUDIOFLOW_PCM=recording.s16le \ AUDIOFLOW_LLM=Qwen/Qwen3-0.6B mix run examples/media.exsexamples/models.exs starts shared models, and examples/local.exs adds a single
utterance for inference benchmarks. examples/media.exs connects a PCM file,
resampling, Silero, the session, and PortAudio output. It plays sound when run.
Set AUDIOFLOW_INPUT_RATE and AUDIOFLOW_INPUT_CHANNELS for other input formats.
The file example reads at processing speed, so use one utterance for this check.
A live PortAudio source follows the device clock. The media tests use a controlled
sink. They verify back pressure, drain, cancellation, pipeline failure, and cleanup
without opening a sound device.