Overview

STTMuteFilter is a general-purpose processor that combines STT muting and interruption control. When active, it prevents both transcription and interruptions during specified conditions (e.g., bot speech, function calls), providing a cleaner conversation flow.

The processor supports multiple simultaneous strategies for when to mute the STT service, making it flexible for different use cases.

Want to try it out? Check out the STTMuteFilter foundational demo

Constructor Parameters

stt_service
STTService
required

The STT service to control

config
STTMuteConfig
required

Configuration object that defines the muting strategies and optional custom logic

Configuration

The processor is configured using STTMuteConfig, which determines when and how the STT service should be muted:

strategies
set[STTMuteStrategy]

Set of muting strategies to apply

should_mute_callback
Callable[[STTMuteFilter], Awaitable[bool]]
default: "None"

Optional callback for custom muting logic (required when strategy is CUSTOM)

Muting Strategies

STTMuteConfig accepts a set of these STTMuteStrategy values:

FIRST_SPEECH
STTMuteStrategy

Mute only during the bot’s first speech (typically during introduction)

FUNCTION_CALL
STTMuteStrategy

Mute during LLM function calls (e.g., API requests, external service calls)

ALWAYS
STTMuteStrategy

Mute during all bot speech

CUSTOM
STTMuteStrategy

Use custom logic provided via callback to determine when to mute

Input Frames

BotStartedSpeakingFrame
Frame

Indicates bot has started speaking

BotStoppedSpeakingFrame
Frame

Indicates bot has stopped speaking

FunctionCallInProgressFrame
Frame

Indicates a function call has started

FunctionCallResultFrame
Frame

Indicates a function call has completed

StartInterruptionFrame
Frame

User interruption start event (suppressed when muted)

StopInterruptionFrame
Frame

User interruption stop event (suppressed when muted)

UserStartedSpeakingFrame
Frame

Indicates user has started speaking (suppressed when muted)

UserStoppedSpeakingFrame
Frame

Indicates user has stopped speaking (suppressed when muted)

Output Frames

STTMuteFrame
Frame

Control frame to mute/unmute the STT service

All input frames are passed through except VAD-related frames (interruptions and user speaking events) when muted.

Usage Examples

Basic Usage (Mute During First Speech)

stt = DeepgramSTTService(api_key=os.getenv("DEEPGRAM_API_KEY"))
stt_mute_filter = STTMuteFilter(
    stt_service=stt,
    config=STTMuteConfig(strategies={
        STTMuteStrategy.FIRST_SPEECH
    })
)

pipeline = Pipeline([
    transport.input(),
    stt_mute_filter,  # Add before STT service
    stt,
    # ... rest of pipeline
])

Always Mute During Bot Speech

stt_mute_filter = STTMuteFilter(
    stt_service=stt,
    config=STTMuteConfig(strategies={STTMuteStrategy.ALWAYS})
)

Custom Muting Logic with Function Calls

async def custom_mute_logic(processor: STTMuteFilter) -> bool:
    # Example: Mute during business hours only
    current_hour = datetime.now().hour
    return processor._bot_is_speaking and (9 <= current_hour < 17)

stt_mute_filter = STTMuteFilter(
    stt_service=stt,
    config=STTMuteConfig(
        strategies={
            STTMuteStrategy.CUSTOM,
            STTMuteStrategy.FUNCTION_CALL
        },
        should_mute_callback=custom_mute_logic
    )
)

Frame Flow

Notes

  • Combines STT muting and interruption control into a single concept
  • Muting prevents both transcription and interruptions
  • Multiple strategies can be active simultaneously
  • Custom strategy allows for complex muting logic
  • Placed before STT service in pipeline
  • Maintains conversation flow during bot speech and function calls
  • Efficient state tracking for minimal overhead