Open
Conversation
Extends the user mute strategies reference with a "Building Custom Strategies" section covering the BaseUserMuteStrategy contract, which frames reach a strategy vs. which frames get suppressed when muted, runtime toggling via a companion FrameProcessor, and a worked "mute for first N words" example. Closes Kapa coverage gap for fine-grained and dynamic muting questions.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation for implementing and wiring custom user mute strategies, clarifying what frames strategies can observe and what inputs are actually suppressed when muted.
Changes:
- Adds a “Building Custom Strategies” section describing the
BaseUserMuteStrategycontract and frame visibility/suppression behavior. - Documents how to toggle muting at runtime via a companion
FrameProcessor, including a full pipeline wire-up example. - Adds a worked example for muting during the first N words of bot speech, plus a caveat about evaluation timing.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Label the base-class code block as a simplified interface and drop the misleading import that redefined the class in the same snippet. - Reword the toggleable-strategy intro to make clear that enable/disable belong to the example, not the BaseUserMuteStrategy contract. - Bound DisclaimerGuardProcessor._buffer to a sliding window and reset it on BotStartedSpeakingFrame so it can't grow unbounded when the trigger phrase never appears.
markbackman
reviewed
Apr 17, 2026
| ) | ||
| ``` | ||
|
|
||
| ## Building Custom Strategies |
Contributor
There was a problem hiding this comment.
Can we move this to a guide instead of nesting it the API reference?
Contributor
There was a problem hiding this comment.
This would be a good fit for pipecat/fundamentals/user-input-muting.mdx.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
BaseUserMuteStrategycontract, which frames reach a strategy, and which frames actually get suppressed when muted.FrameProcessor(for signals likeLLMTextFramethat don't reach the aggregator directly), with a full wire-up example.Closes a Kapa.ai documentation coverage gap where the assistant couldn't answer questions about fine-grained or dynamic muting (per-word muting, runtime enable/disable, which frames strategies can observe).
Test plan
mint broken-linkspasses in CI#toggling-a-strategy-at-runtimeresolve🤖 Generated with Claude Code