pipecat-client-android/ai.pipecat.client/PipecatClient

PipecatClient

open class PipecatClient<TransportType : Transport<ConnectParams>, ConnectParams>(transport: TransportType, options: PipecatClientOptions)

A Pipecat client. Connects to an RTVI backend and handles bidirectional audio and video streaming.

The client must be cleaned up using the release method when it is no longer required.

Parameters

transport

Transport for media streaming.

callbacks

Callbacks invoked when changes occur in the voice session.

options

Additional options for configuring the client and backend.

Constructors

Link copied to clipboard
constructor(transport: TransportType, options: PipecatClientOptions)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val isCamEnabled: Boolean

Returns true if the camera is enabled, false otherwise.

Link copied to clipboard
val isMicEnabled: Boolean

Returns true if the microphone is enabled, false otherwise.

Link copied to clipboard
val selectedCam: MediaDeviceInfo?

Returns the selected video input device.

Link copied to clipboard
val selectedMic: MediaDeviceInfo?

Returns the selected audio input device.

Link copied to clipboard
val state: TransportState

The current state of the session.

Link copied to clipboard
val thread: ThreadRef

The thread used by the PipecatClient for callbacks and other operations.

Link copied to clipboard
val tracks: Tracks

Returns a list of participant media tracks.

Functions

Link copied to clipboard
fun appendToContext(message: LLMContextMessage): Future<AppendToContextResultData, RTVIError>

Appends a message to the bot's LLM conversation context.

Link copied to clipboard
fun connect(transportParams: ConnectParams): Future<Unit, RTVIError>

Initiate an RTVI session, connecting to the backend.

Link copied to clipboard
fun disconnect(): Future<Unit, RTVIError>

Disconnect an active RTVI session.

Link copied to clipboard
fun disconnectBot()

Sends a disconnect signal to the bot while maintaining the transport connection.

Link copied to clipboard
fun enableCam(enable: Boolean): Future<Unit, RTVIError>

Enables or disables the video input device.

Link copied to clipboard
fun enableMic(enable: Boolean): Future<Unit, RTVIError>

Enables or disables the audio input device.

Link copied to clipboard
fun getAllCams(): Future<List<MediaDeviceInfo>, RTVIError>

Returns a list of available video input devices.

Link copied to clipboard
fun getAllMics(): Future<List<MediaDeviceInfo>, RTVIError>

Returns a list of available audio input devices.

Link copied to clipboard
fun initDevices(): Future<Unit, RTVIError>

Initialize local media devices such as camera and microphone.

Link copied to clipboard
fun registerFunctionCallHandler(functionName: String, callback: LLMFunctionCallHandler)

Registers a function call handler for a specific function name.

Link copied to clipboard
fun release()

Destroys this PipecatClient and cleans up any allocated resources.

Link copied to clipboard
fun sendClientMessage(msgType: String, data: Value = Value.Null): Future<Unit, RTVIError>

Sends a one-way message to the bot without expecting a response.

Link copied to clipboard
fun sendClientRequest(msgType: String, data: Value = Value.Null): Future<DataMessage, RTVIError>

Sends a request message to the bot and waits for a response.

Link copied to clipboard
Link copied to clipboard
fun startBotAndConnect(startBotParams: APIRequest): Future<Unit, RTVIError>

Performs bot start request and connection in a single operation.

Link copied to clipboard
fun unregisterFunctionCallHandler()

Unregisters all function call handlers.

fun unregisterFunctionCallHandler(functionName: String)

Unregisters a function call handler for a specific function name.

Link copied to clipboard
fun updateCam(camId: MediaDeviceId): Future<Unit, RTVIError>

Use the specified video input device.

Link copied to clipboard
fun updateMic(micId: MediaDeviceId): Future<Unit, RTVIError>

Use the specified audio input device.