LiveKit Transport

The LiveKitTransport class provides a WebRTC transport layer using LiveKit’s infrastructure. It wraps a LiveKit client to handle audio/video device management, WebRTC connections, and real-time communication between clients and bots. For complete documentation on LiveKit’s API, see the LiveKit Client SDK Reference. This transport is designed for production use cases, leveraging LiveKit’s infrastructure for low-latency, high-quality audio and video streaming. It expects your Pipecat server to include the corresponding LiveKitTransport server-side implementation.

Installation

npm install @pipecat-ai/client-js @pipecat-ai/livekit-transport

Usage

Basic Setup

import { PipecatClient } from "@pipecat-ai/client-js";
import { LiveKitTransport } from "@pipecat-ai/livekit-transport";

const pcClient = new PipecatClient({
  transport: new LiveKitTransport({
    // LiveKitTransport constructor options (RoomOptions)
  }),
  enableCam: false, // Default camera off
  enableMic: true, // Default microphone on
  callbacks: {
    // Event handlers
  },
  // ...
});

await pcClient.connect({
  url: "wss://your-livekit-server.com",
  token: "your-livekit-token",
});

API Reference

Constructor Options

type LiveKitTransportConstructorOptions = RoomOptions;

LiveKitTransportConstructorOptions is the RoomOptions type from the livekit-client library. These options are passed directly through to the LiveKit Room constructor. See the LiveKit RoomOptions documentation for a complete list of options.

TransportConnectionParams

On connect(), the LiveKitTransport requires a url and token to connect to a LiveKit room. This can be provided directly to the PipecatClient’s connect() method or via a starting endpoint passed to the PipecatClient’s startBotAndConnect() method. If using an endpoint, your endpoint should return a JSON object with url, token, and optional roomConnectionOptions. See the client connect() documentation for more information.

string

required

The WebSocket URL of your LiveKit server (e.g., wss://your-server.livekit.cloud).

string

required

Authentication token for the LiveKit room. Generate this on your server using LiveKit’s access token API.

RoomConnectOptions

Optional LiveKit room connection options. See the LiveKit RoomConnectOptions documentation for available options.

pcClient.connect({
  url: 'wss://your-server.livekit.cloud',
  token: 'your-livekit-token'
});
// OR...
pcClient.startBotAndConnect({
  endpoint: '/api/start', // Your server endpoint to start the bot
});

import os
import subprocess

@app.post("/api/start")
async def start(request: Request) -> Dict[Any, Any]:
    print("Creating room and token for RTVI connection")
    room_url, token = await create_livekit_room_and_token()

    # Start the bot process
    print("Starting bot subprocess")
    try:
        subprocess.Popen(
            [f"python3 -m bot.py -u {room_url} -t {token}"],
            shell=True,
            bufsize=1,
            cwd=os.path.dirname(os.path.abspath(__file__)),
        )
    except Exception as e:
        raise HTTPException(status_code=500, detail=f"Failed to start subprocess: {e}")

    # Return the LiveKit connection params
    return {"url": room_url, "token": token}

Media Support

LiveKitTransport carries the microphone, camera, screen share, bot audio, and bot video. screenShare is true only where the browser provides getDisplayMedia, which most mobile browsers, including iOS Safari, don’t. See mediaSupport.

Events

The transport implements the various PipecatClient event handlers. It does not expose the underlying LiveKit Room, so LiveKit-specific room events are not available through it.

More Information

LiveKit Docs

Official LiveKit Documentation

Source

LiveKitTransport

Package

@pipecat-ai/livekit-transport

Choosing a Transport

Transport Selection Guide

Get Started

Pipecat Server

Client SDKs

Pipecat Flows

Pipecat Cloud

CLI

Pipecat Context Hub

Installation

Usage

Basic Setup

API Reference

Constructor Options

TransportConnectionParams

Media Support

Events

More Information

LiveKit Docs

Source

Package

Choosing a Transport

​Installation

​Usage

​Basic Setup

​API Reference

​Constructor Options

​TransportConnectionParams

​Media Support

​Events

​More Information

LiveKit Docs

Source

Package

Choosing a Transport

Installation

Usage

Basic Setup

API Reference

Constructor Options

TransportConnectionParams

Media Support

Events

More Information