Skip to content

docs: add full-duplex voice AI assistant guide - #1344

Merged
mdydek merged 3 commits into
software-mansion:mainfrom
maciejkucmierz-swm:docs/full-duplex-voice-ai-guide
Oct 26, 2026
Merged

mdydek merged 3 commits into
software-mansion:mainfrom
maciejkucmierz-swm:docs/full-duplex-voice-ai-guide

Conversation

@maciejkucmierz-swm

Copy link
Copy Markdown
Contributor

Based on the APIs introduced in:

⚠️ Breaking changes ⚠️

  • None. Documentation-only change.

Introduced changes

  • Add “Build a full-duplex voice AI assistant” guide for React Native Audio API 1.0.
  • Demonstrate communication-session configuration, voice-processing capture, Android voice output classification, and OpenAI Realtime audio streaming.
  • Cover queued playback, barge-in, late-decode invalidation, and conservative conversation truncation.
  • Distinguish essential audio functionality from optional UI features. Keep application-specific error handling and cleanup as comments/pseudocode.
  • Include a call-path diagram, native setup instructions, and a suggested local MVP token server.
  • Clarify that echo suppression depends on the device, OS, and audio route.

Only the new guide is included; existing documentation pages are unchanged.

Checklist

  • Updated relevant documentation
  • Added/Conducted relevant tests — docs build, formatting, link checks, and six mocked audio-path checks passed. Physical-device validation was not performed.
  • Performed self-review of the code

@closetcaiman closetcaiman added the documentation Additions, corrections, or updates to documentation and technical specs label Oct 14, 2026
@github-actions

github-actions Bot commented Oct 14, 2026 •

Copy link
Copy Markdown

WPT non-regression comparison

PASS — no regressions · 0 improved section(s) · overall 3427 → 3427 (0)

Unchanged sections (28)
Spec section Base pass Head pass Delta
Processing model 1 1 0
Other 56 56 0
AnalyserNode 138 138 0
AudioBuffer 140 140 0
AudioBufferSourceNode 220 220 0
AudioContext 58 58 0
AudioNode 261 261 0
AudioParam 680 680 0
BiquadFilterNode 275 275 0
ChannelMergerNode 30 30 0
ChannelSplitterNode 7 7 0
ConstantSourceNode 64 64 0
ConvolverNode 178 178 0
DelayNode 127 127 0
DestinationNode 0 0 0
DynamicsCompressorNode 4 4 0
GainNode 15 15 0
IIRFilterNode 87 87 0
MediaElementAudioSourceNode 0 0 0
MediaStreamAudioDestinationNode 1 1 0
MediaStreamAudioSourceNode 0 0 0
OfflineAudioContext 35 35 0
OscillatorNode 104 104 0
PannerNode 727 727 0
PeriodicWave 33 33 0
ScriptProcessorNode 0 0 0
StereoPannerNode 104 104 0
WaveShaperNode 82 82 0

Baseline: eb17d846e2e16cf3c82e0807a35f30565f10653e · Candidate: 8d8e531f3cf8e8b0c010e452a097a890f225a8d8

Workflow run · this comment is updated on every push.

@mdydek mdydek left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can it be written more begginer-friendly when it comes to using our library. I think we can assume the user's knowledge about tokens and other stuff, but focus more on the features used from our library

Comment thread packages/audiodocs/docs/guides/building-a-full-duplex-voice-ai-assistant.mdx Outdated
Comment thread packages/audiodocs/docs/guides/building-a-full-duplex-voice-ai-assistant.mdx Outdated
Comment thread packages/audiodocs/docs/guides/building-a-full-duplex-voice-ai-assistant.mdx Outdated
Comment thread packages/audiodocs/docs/guides/building-a-full-duplex-voice-ai-assistant.mdx Outdated

@mdydek mdydek left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the structure much better, but I feel like we could give some more code snippets rather than wall of text, prefer keeping it brief and giving some mini code snippets that can help the user to understand how to structure that

Comment thread packages/audiodocs/docs/guides/building-a-full-duplex-voice-ai-assistant.mdx Outdated
Comment thread packages/audiodocs/docs/guides/building-a-full-duplex-voice-ai-assistant.mdx Outdated
Comment thread packages/audiodocs/docs/guides/building-a-full-duplex-voice-ai-assistant.mdx Outdated
Comment thread packages/audiodocs/docs/guides/building-a-full-duplex-voice-ai-assistant.mdx Outdated
Comment thread packages/audiodocs/docs/guides/building-a-full-duplex-voice-ai-assistant.mdx Outdated
Comment thread packages/audiodocs/docs/guides/building-a-full-duplex-voice-ai-assistant.mdx Outdated
Comment thread packages/audiodocs/docs/guides/building-a-full-duplex-voice-ai-assistant.mdx Outdated
Comment thread packages/audiodocs/docs/guides/building-a-full-duplex-voice-ai-assistant.mdx Outdated
Comment thread packages/audiodocs/docs/guides/building-a-full-duplex-voice-ai-assistant.mdx Outdated
Comment thread packages/audiodocs/docs/guides/building-a-full-duplex-voice-ai-assistant.mdx Outdated
@mdydek
mdydek merged commit a07241c into software-mansion:main Oct 26, 2026
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Additions, corrections, or updates to documentation and technical specs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants