You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Whether to automatically subscribe to incoming captions streams from session
155
+
participants. Requires `captions_in_enabled` to be `True`.
156
+
</ParamField>
157
+
146
158
<ParamField
147
159
path="video_in_preferred_resolution"
148
160
type="tuple[int, int]"
@@ -171,7 +183,7 @@ Inherits all parameters from [TransportParams](/api-reference/server/services/tr
171
183
172
184
### SubscribeSettings
173
185
174
-
Used with `subscribe_to_stream()` to control per-stream subscription quality when `audio_in_auto_subscribe`or `video_in_auto_subscribe` are disabled.
186
+
Used with `subscribe_to_stream()` to control per-stream subscription quality when `audio_in_auto_subscribe`, `video_in_auto_subscribe`, or `captions_in_auto_subscribe` are disabled.
Preferred `(width, height)` resolution for the subscribed video track. The
186
202
server provides the closest available quality if the exact resolution is
@@ -227,7 +243,7 @@ See the [complete example](https://github.com/pipecat-ai/pipecat/blob/main/examp
227
243
228
244
### Subscribing to streams manually
229
245
230
-
When `audio_in_auto_subscribe`or `video_in_auto_subscribe` is disabled, subscribe to a specific participant's stream with `subscribe_to_stream()`, passing [SubscribeSettings](#subscribesettings) to control which tracks are received and at what quality. The `streamId` is available from the `on_participant_joined` event data.
246
+
When `audio_in_auto_subscribe`, `video_in_auto_subscribe`, or `captions_in_auto_subscribe` is disabled, subscribe to a specific participant's stream with `subscribe_to_stream()`, passing [SubscribeSettings](#subscribesettings) to control which tracks are received and at what quality. The `streamId` is available from the `on_participant_joined` event data.
231
247
232
248
```python
233
249
from pipecat.transports.vonage.video_connector import SubscribeSettings
Enable captions to receive real-time `TranscriptionFrame` and `InterimTranscriptionFrame` from participants. Each frame includes the `user_id` (stream ID) of the speaker.
266
+
267
+
```python
268
+
transport = VonageVideoConnectorTransport(
269
+
application_id,
270
+
session_id,
271
+
token,
272
+
VonageVideoConnectorTransportParams(
273
+
audio_in_enabled=True,
274
+
audio_out_enabled=True,
275
+
captions_in_enabled=True,
276
+
captions_in_auto_subscribe=True,
277
+
),
278
+
)
279
+
```
280
+
281
+
### Individual audio streams
282
+
283
+
By default, audio input is received as a session-level mix of all participants. When you subscribe to a stream (either manually or via auto-subscribe), the transport also delivers per-subscriber `UserAudioRawFrame` frames with a `user_id` field identifying the source participant. This enables use cases like speaker diarization or per-participant processing.
284
+
246
285
## Event Handlers
247
286
248
287
`VonageVideoConnectorTransport` provides event handlers for session lifecycle, participant stream management, and subscriber connectivity. Register handlers using the `@event_handler` decorator on the transport instance.
0 commit comments