Skip to content

Commit ce4e3ca

Browse files
github-actions[bot]markbackman
authored andcommitted
docs: update frame type names from VAD* to User*
Updates documentation to reflect the frame type rename in pipecat PR #4198: - VADUserStartedSpeakingFrame → UserStartedSpeakingFrame - VADUserStoppedSpeakingFrame → UserStoppedSpeakingFrame Updated pages: - guides/learn/speech-input.mdx - server/utilities/observers/user-bot-latency-observer.mdx - server/services/stt/soniox.mdx - server/services/stt/sarvam.mdx - server/frames/system-frames.mdx
1 parent e9b7189 commit ce4e3ca

5 files changed

Lines changed: 9 additions & 9 deletions

File tree

api-reference/server/frames/system-frames.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -153,9 +153,9 @@ Broadcast when all active [user mute strategies](/api-reference/server/utilities
153153

154154
## VAD Events
155155

156-
These frames are emitted directly by the Voice Activity Detection (VAD) processor and carry timing metadata. Higher-level speaking-state frames (`UserStartedSpeakingFrame`, `UserStoppedSpeakingFrame`) are derived from these.
156+
These frames are emitted directly by the Voice Activity Detection (VAD) processor and carry timing metadata. Higher-level speaking-state frames are derived from these.
157157

158-
### VADUserStartedSpeakingFrame
158+
### UserStartedSpeakingFrame
159159

160160
VAD confirmed that speech has started.
161161

@@ -167,7 +167,7 @@ VAD confirmed that speech has started.
167167
Wall-clock time when the frame was created.
168168
</ParamField>
169169

170-
### VADUserStoppedSpeakingFrame
170+
### UserStoppedSpeakingFrame
171171

172172
VAD confirmed that speech has ended.
173173

api-reference/server/services/stt/sarvam.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ stt = SarvamSTTService(
180180

181181
- **Supported languages**: Bengali (bn-IN), Gujarati (gu-IN), Hindi (hi-IN), Kannada (kn-IN), Malayalam (ml-IN), Marathi (mr-IN), Tamil (ta-IN), Telugu (te-IN), Punjabi (pa-IN), Odia (od-IN), English (en-IN), and Assamese (as-IN).
182182
- **Model-specific parameter validation**: The service validates that parameters are compatible with the selected model. For example, `prompt` is not supported with `saarika:v2.5`, and `language` is not supported with `saaras:v2.5` (which auto-detects language).
183-
- **VAD modes**: When `vad_signals=False` (default), the service relies on Pipecat's local VAD and flushes the server buffer on `VADUserStoppedSpeakingFrame`. When `vad_signals=True`, the service uses Sarvam's server-side VAD and broadcasts speaking frames from the server.
183+
- **VAD modes**: When `vad_signals=False` (default), the service relies on Pipecat's local VAD and flushes the server buffer on `UserStoppedSpeakingFrame`. When `vad_signals=True`, the service uses Sarvam's server-side VAD and broadcasts speaking frames from the server.
184184

185185
<Tip>
186186
The `InputParams` / `params=` pattern is deprecated as of v0.0.105. Use

api-reference/server/services/stt/soniox.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ Before using Soniox STT services, you need:
113113
</ParamField>
114114

115115
<ParamField path="vad_force_turn_endpoint" type="bool" default="True">
116-
Listen to `VADUserStoppedSpeakingFrame` to send a finalize message to Soniox.
116+
Listen to `UserStoppedSpeakingFrame` to send a finalize message to Soniox.
117117
When enabled, Pipecat's local VAD triggers transcript finalization. When
118118
disabled, Soniox detects the end of speech natively.
119119
</ParamField>

api-reference/server/utilities/observers/user-bot-latency-observer.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,8 @@ When tracing is enabled, latency measurements are automatically recorded as `tur
7272
The observer tracks conversation flow through these key events:
7373

7474
1. **Client connects** (`ClientConnectedFrame`) → Records timestamp for first-bot-speech measurement
75-
2. **User starts speaking** (`VADUserStartedSpeakingFrame`) → Resets latency tracking
76-
3. **User stops speaking** (`VADUserStoppedSpeakingFrame`) → Records timestamp, accounting for VAD `stop_secs` delay
75+
2. **User starts speaking** (`UserStartedSpeakingFrame`) → Resets latency tracking
76+
3. **User stops speaking** (`UserStoppedSpeakingFrame`) → Records timestamp, accounting for VAD `stop_secs` delay
7777
4. **Bot starts speaking** (`BotStartedSpeakingFrame`) → Calculates latency and emits `on_latency_measured` and `on_latency_breakdown` events
7878

7979
When `enable_metrics=True` in `PipelineParams`, the observer also collects per-service metrics (TTFB, text aggregation, function call latency) from `MetricsFrame` instances and includes them in the latency breakdown.

pipecat/learn/speech-input.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,8 +98,8 @@ While VAD detects speech vs. silence, it can't understand linguistic context. A
9898
2. **Turn End**: When the stop strategy determines the user is done, it emits `UserStoppedSpeakingFrame`
9999

100100
<Note>
101-
VAD also emits its own frames (`VADUserStartedSpeakingFrame`,
102-
`VADUserStoppedSpeakingFrame`) which indicate raw speech/silence detection.
101+
VAD also emits its own frames (`UserStartedSpeakingFrame`,
102+
`UserStoppedSpeakingFrame`) which indicate raw speech/silence detection.
103103
These are inputs to the turn strategies, not the final turn decisions.
104104
</Note>
105105

0 commit comments

Comments
 (0)