The Pipecat C++ client SDK. More...

Classes
struct	APIRequest

class	BotAlreadyStartedError

class	BotNotReadyError

struct	ClientResponse
	The bot's answer to a request. More...

class	ConnectionTimeoutError
	The bot didn't become ready in time. Thrown by PipecatClient::connect(). More...

class	DailyTransport

struct	DailyTransportOptions
	Options to create a DailyTransport. More...

class	InvalidTransportParamsError

class	MessageError

class	MessageTooLargeError
	A message is too large for the transport. More...

struct	Participant
	Someone in the session, like the bot or another user. More...

class	PipecatClient

class	PipecatClientCallbacks

struct	PipecatClientOptions
	Options to create a PipecatClient. More...

class	PipecatError
	Base class of all the errors thrown by the client. More...

class	RequestTimeoutError

class	StartBotError
	Starting the bot failed. Thrown by PipecatClient::start_bot(). More...

class	Transport

class	TransportObserver

class	TransportStartError
	The transport couldn't connect. Thrown by Transport::connect(). More...

class	UnsupportedFeatureError
	The transport or the bot doesn't support a feature. More...

class	WebSocketTransport

struct	WebSocketTransportOptions
	Options to create a WebSocketTransport. More...

Typedefs
using	FunctionCallResultCallback = std::function< void(nlohmann::json result)>

using	ClientResponseCallback = std::function< void(const ClientResponse &)>
	Receives the bot's answer to a request.

Enumerations
enum class	TransportState { Disconnected , Initializing , Initialized , Authenticating , Authenticated , Connecting , Connected , Ready , Disconnecting , Error }
	The state of the connection to the bot. More...

Functions
const char *	to_string (TransportState state)
	The name of a state, e.g. "ready".

Detailed Description

The Pipecat C++ client SDK.

Typedef Documentation

using pipecat::FunctionCallResultCallback = typedef std::function<void(nlohmann::json result)>

Sends the result of a function call to the bot.

Call it once, right away or later, from any thread. It does nothing after the client disconnects. A null result is sent as an empty object.

strong

The state of the connection to the bot.

Enumerator
Disconnected	Not connected.
Initializing	The transport is getting ready.
Initialized	The transport is ready to connect.
Authenticating	Starting the bot.
Authenticated	The bot was started.
Connecting	Connecting to the bot.
Connected	Connected, waiting for the bot to be ready.
Ready	The bot is ready.
Disconnecting	Disconnecting from the bot.
Error	Starting or connecting to the bot failed.