Skip to content

docs(lk): state the simulate defaults the server applies - #1121

Open
u9g wants to merge 3 commits into
mainfrom
docs/simulation-implicit-behavior
Open

u9g wants to merge 3 commits into
mainfrom
docs/simulation-implicit-behavior

Conversation

@u9g

@u9g u9g commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

Help text for lk agent simulate now says what the server does:

  • --num-simulations defaults to 20 when unset (simulation.go#L110).
  • --background-noise picks a random ambient clip per simulation and mixes it in as loud as the voice.
  • --low-quality-microphone is a 300–3400 Hz band, G.711 µ-law phone line.
  • --packet-loss drops 25% of the audio in bursts of about 150 ms (50 ms blocks, mean burst of 3).
  • list --limit is API-key auth only. simulateListModeFlags already rejects it under --user-auth.

Sources for the audio flags: environment.py#L33-L80.

There's a demo video in the comments. Docs companion: livekit/web#7190.

--num-simulations didn't say it defaults to 20, and the three degraded-audio
flags didn't say what they do: noise as loud as the voice from a random clip,
a 300-3400 Hz G.711 phone band, and 25% loss in ~60 ms bursts.

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Devin Review

u9g added 2 commits November 12, 2026 10:57
Loss drops 50 ms blocks (sample_rate // 20) with a mean burst of three, so a
burst is about 150 ms. The 60 ms figure came from a simulator source comment
that assumed 20 ms blocks.
simulateListModeFlags marks --limit legacyOnly, so it's rejected under
--user-auth, but its help didn't say so the way --status and --cursor do.
@u9g

u9g commented Nov 12, 2026

Copy link
Copy Markdown
Contributor Author

lk agent simulate --help, audio --help and list --help built from this branch: -n now states its default of 20, each degraded-audio flag says what it does (noise as loud as the voice, a 300–3400 Hz G.711 phone band, 25% loss in ~150 ms bursts), and list --limit says it's API-key auth only.

lk-simulate-help.mp4

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant