wx44wx/pipecat
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

deprecate STTMuteFilter in favor of LLMUSerAggregator user mute strategies

Browse Source
This commit is contained in:
Aleix Conchillo Flaqué
2025-12-27 13:47:29 -08:00
parent a962c4eeba
commit c7589663b5
2 changed files with 23 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
changelog/3292.deprecated.md Normal file
View File

@@ -0,0 +1 @@
- `STTMuteFilter` is deprecated and will be removed in a future version. Use `LLMUserAggregator`'s new `user_mute_strategies` instead.

22
src/pipecat/processors/filters/stt_mute_filter.py
View File

@@ -51,6 +51,10 @@ class STTMuteStrategy(Enum):
FUNCTION_CALL: Mute STT during function calls to prevent interruptions. FUNCTION_CALL: Mute STT during function calls to prevent interruptions.
ALWAYS: Always mute STT when the bot is speaking. ALWAYS: Always mute STT when the bot is speaking.
CUSTOM: Use a custom callback to determine muting logic dynamically. CUSTOM: Use a custom callback to determine muting logic dynamically.
.. deprecated:: 0.0.99
`STTMuteStrategy` is deprecated and will be removed in a future version.
Use `LLMUserAggregator`'s new `user_mute_strategies` instead.
""" """
FIRST_SPEECH = "first_speech" FIRST_SPEECH = "first_speech"
@@ -77,6 +81,10 @@ class STTMuteConfig:
Note: Note:
MUTE_UNTIL_FIRST_BOT_COMPLETE and FIRST_SPEECH strategies should not be used together MUTE_UNTIL_FIRST_BOT_COMPLETE and FIRST_SPEECH strategies should not be used together
as they handle the first bot speech differently. as they handle the first bot speech differently.
.. deprecated:: 0.0.99
`STTMuteConfig` is deprecated and will be removed in a future version.
Use `LLMUserAggregator`'s new `user_mute_strategies` instead.
""" """
strategies: set[STTMuteStrategy] strategies: set[STTMuteStrategy]
@@ -104,6 +112,10 @@ class STTMuteFilter(FrameProcessor):
feature. When STT is muted, interruptions are automatically disabled by feature. When STT is muted, interruptions are automatically disabled by
suppressing VAD-related frames. This prevents unwanted speech detection suppressing VAD-related frames. This prevents unwanted speech detection
during bot speech, function calls, or other specified conditions. during bot speech, function calls, or other specified conditions.
.. deprecated:: 0.0.99
`STTMuteFilter` is deprecated and will be removed in a future version.
Use `LLMUserAggregator`'s new `user_mute_strategies` instead.
""" """
def __init__(self, *, config: STTMuteConfig, **kwargs): def __init__(self, *, config: STTMuteConfig, **kwargs):
@@ -120,6 +132,16 @@ class STTMuteFilter(FrameProcessor):
self._function_call_in_progress = set() self._function_call_in_progress = set()
self._is_muted = False self._is_muted = False
import warnings
with warnings.catch_warnings():
warnings.simplefilter("always")
warnings.warn(
"`STTMuteFilter` is deprecated and will be removed in a future version. "
"Use `LLMUserAggregator`'s new `user_mute_strategies` instead.",
DeprecationWarning,
)
async def _handle_mute_state(self, should_mute: bool): async def _handle_mute_state(self, should_mute: bool):
"""Handle STT muting and interruption control state changes.""" """Handle STT muting and interruption control state changes."""
if should_mute != self._is_muted: if should_mute != self._is_muted: