WebSocket Transport

​

Usage

#include <pipecat/pipecat.h>
#include <pipecat/websocket/transport.h>

int main() {
    App app;  // Your pipecat::PipecatClientCallbacks.

    pipecat::PipecatClientOptions options;
    options.transport = std::make_unique<pipecat::WebSocketTransport>();
    options.callbacks = &app;
    pipecat::PipecatClient client(std::move(options));

    // Start a bot with Pipecat's development runner, and connect to it.
    pipecat::APIRequest request;
    request.endpoint = "http://localhost:7860/start";
    request.request_data = {{"transport", "websocket"}};
    client.start_bot_and_connect(request);

    ...

    client.disconnect();
}

• The transport connects to the bot’s WebSocket. Start endpoints like Pipecat’s development runner (python bot.py -t websocket) return its URL, and a token if it needs one, when you ask for the websocket transport. If you already have them, connect directly with client.connect({{"wsUrl", ws_url}, {"token", token}}).
• The bot serializes its frames with ProtobufFrameSerializer, like the websocket example’s bot.
• Audio is 16-bit PCM, 16 kHz mono by default. Change it with pipecat::WebSocketTransportOptions. The bot’s audio is converted to it from whatever the bot sends. The user’s audio is sent without echo cancellation, so if you play the bot through speakers, use your platform’s echo cancellation or headphones.
• Each client needs its own WebSocketTransport, and several clients can run at the same time, e.g. to talk to several bots.

​

Installation

• libdatachannel 0.24 or newer, for its WebSocket client. CMake downloads and builds it if it’s not installed, which needs OpenSSL.
• speexdsp, to convert the bot’s audio. If it’s not installed, CMake downloads it and builds what the transport needs into it.

sudo apt-get install libssl-dev
cmake . -G Ninja -Bbuild -DCMAKE_BUILD_TYPE=Release -DPIPECAT_BUILD_WEBSOCKET=ON
ninja -C build
cmake --install build --prefix /path/to/pipecat

brew install openssl@3
export OPENSSL_ROOT_DIR=$(brew --prefix openssl@3)
cmake . -G Ninja -Bbuild -DCMAKE_BUILD_TYPE=Release -DPIPECAT_BUILD_WEBSOCKET=ON
ninja -C build
cmake --install build --prefix /path/to/pipecat

cmake --preset vcpkg -DPIPECAT_BUILD_WEBSOCKET=ON -DVCPKG_MANIFEST_FEATURES=websocket
cmake --build build --config Release
cmake --install build --config Release --prefix C:/path/to/pipecat

find_package(pipecat 1.0 REQUIRED COMPONENTS websocket)
target_link_libraries(my_app PRIVATE pipecat::websocket)

​

Examples

​

Documentation