Skip to content

docs: update for pipecat PR #4716 #896

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
markbackman wants to merge 1 commit into
base: main
Choose a base branch
from
+20 −6
Open

docs: update for pipecat PR #4716 #896

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion api-reference/server/services/transport/transport-params.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,5 +168,9 @@ Each transport extends `TransportParams` with provider-specific fields:
| [DailyTransport](/api-reference/server/services/transport/daily) | `DailyParams` | `api_key`, `api_url`, `dialin_settings`, `transcription_enabled`, `transcription_settings` |
| [LiveKitTransport](/api-reference/server/services/transport/livekit) | `LiveKitParams` | (no additional fields) |
| [SmallWebRTCTransport](/api-reference/server/services/transport/small-webrtc) | `TransportParams` | Uses base class directly |
| [WebsocketServerTransport](/api-reference/server/services/transport/websocket-server) | `WebsocketServerParams` | `add_wav_header`, `serializer`, `session_timeout` |
| [WebsocketServerTransport](/api-reference/server/services/transport/websocket-server) | `WebsocketServerParams` | `add_wav_header`, `serializer`, `session_timeout` **(deprecated)** |
| [FastAPIWebsocketTransport](/api-reference/server/services/transport/fastapi-websocket) | `FastAPIWebsocketParams` | `serializer`, `session_timeout` |

<Note>
**WebsocketServerTransport** is deprecated as of version 1.4.0. Use [FastAPIWebsocketTransport](/api-reference/server/services/transport/fastapi-websocket) instead.
</Note>
20 changes: 15 additions & 5 deletions api-reference/server/services/transport/websocket-server.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,14 @@ Before using WebSocket transports, you need:

### WebsocketServerTransport

<Warning>
**Deprecated in version 1.4.0**

`WebsocketServerTransport` is deprecated and will be removed in a future version. It was intended for development and testing only and has a critical limitation: it only supports a single client at a time.

Use [FastAPIWebsocketTransport](/api-reference/server/services/transport/fastapi-websocket) instead for production use.
</Warning>

<ParamField path="params" type="WebsocketServerParams" required>
Transport configuration parameters.
</ParamField>
Expand Down Expand Up @@ -277,11 +285,13 @@ async def on_disconnected(transport, websocket):
| `transport` | `WebsocketClientTransport` | The transport instance |
| `websocket` | `WebSocketClientProtocol` | The WebSocket connection object |

<Note>
The WebSocket server only supports one client connection at a time. If a new
client connects while one is already connected, the existing connection will
be closed.
</Note>
<Warning>
**Single Client Limitation**

The WebSocket server only supports one client connection at a time. If a new client connects while one is already connected, the existing connection will be closed.

This limitation is why `WebsocketServerTransport` is deprecated in favor of [FastAPIWebsocketTransport](/api-reference/server/services/transport/fastapi-websocket), which supports multiple concurrent clients.
</Warning>

## Additional Resources

Expand Down
Loading