Pipecat C++ Client SDK 1.0.0
Connect native apps to Pipecat bots
Loading...
Searching...
No Matches
messages.h File Reference
#include <nlohmann/json.hpp>
#include <cstdint>
#include <optional>
#include <string>
#include <vector>

Go to the source code of this file.

Classes

struct  pipecat::rtvi::AboutClientData
 Information about the client, sent to the bot when connecting. More...
 
struct  pipecat::rtvi::ClientMessageData
 An app-defined message between the client and the bot. More...
 
struct  pipecat::rtvi::SendTextOptions
 Options for sending text to the bot. More...
 
struct  pipecat::rtvi::LLMFunctionCallResultData
 The result of a function call, sent to the bot. More...
 
struct  pipecat::rtvi::BotReadyData
 Sent by the bot when it's ready. More...
 
struct  pipecat::rtvi::ErrorData
 An error. More...
 
struct  pipecat::rtvi::TranscriptData
 What the user said. More...
 
struct  pipecat::rtvi::TextData
 Some text. More...
 
struct  pipecat::rtvi::SpokenProgressData
 How much of a text the bot has spoken. More...
 
struct  pipecat::rtvi::BotOutputData
 
struct  pipecat::rtvi::MetricData
 A single measurement. More...
 
struct  pipecat::rtvi::MetricsData
 Performance metrics from the bot. More...
 
struct  pipecat::rtvi::LLMFunctionCallStartedData
 The bot's LLM started a function call. More...
 
struct  pipecat::rtvi::LLMFunctionCallInProgressData
 A function call is running. More...
 
struct  pipecat::rtvi::LLMFunctionCallStoppedData
 A function call finished or was cancelled. More...
 
struct  pipecat::rtvi::LLMSearchResult
 A search result. More...
 
struct  pipecat::rtvi::LLMSearchOrigin
 Where search results come from, e.g. a website. More...
 
struct  pipecat::rtvi::BotLLMSearchResponseData
 Search results used by the bot's LLM. More...
 
struct  pipecat::rtvi::Message
 

Namespaces

namespace  pipecat
 The Pipecat C++ client SDK.
 
namespace  pipecat::rtvi
 

Typedefs

using pipecat::rtvi::UserLLMTextData = TextData
 User text sent to the bot's LLM.
 
using pipecat::rtvi::BotLLMTextData = TextData
 Text from the bot's LLM, as it streams.
 
using pipecat::rtvi::BotTTSTextData = TextData
 Text the bot is speaking.
 

Enumerations

enum class  pipecat::rtvi::MessageType {
  pipecat::rtvi::ClientReady , pipecat::rtvi::DisconnectBot , pipecat::rtvi::ClientMessage , pipecat::rtvi::SendText ,
  pipecat::rtvi::DTMF , pipecat::rtvi::LLMFunctionCallResult , pipecat::rtvi::BotReady , pipecat::rtvi::Error ,
  pipecat::rtvi::ErrorResponse , pipecat::rtvi::ServerMessage , pipecat::rtvi::ServerResponse , pipecat::rtvi::Metrics ,
  pipecat::rtvi::UserStartedSpeaking , pipecat::rtvi::UserStoppedSpeaking , pipecat::rtvi::BotStartedSpeaking , pipecat::rtvi::BotStoppedSpeaking ,
  pipecat::rtvi::BotInterrupted , pipecat::rtvi::UserMuteStarted , pipecat::rtvi::UserMuteStopped , pipecat::rtvi::UserTranscription ,
  pipecat::rtvi::UserLLMText , pipecat::rtvi::BotOutput , pipecat::rtvi::BotLLMText , pipecat::rtvi::BotLLMStarted ,
  pipecat::rtvi::BotLLMStopped , pipecat::rtvi::BotLLMSearchResponse , pipecat::rtvi::BotTTSText , pipecat::rtvi::BotTTSStarted ,
  pipecat::rtvi::BotTTSStopped , pipecat::rtvi::LLMFunctionCallStarted , pipecat::rtvi::LLMFunctionCallInProgress , pipecat::rtvi::LLMFunctionCallStopped
}
 Types of RTVI messages. More...
 

Functions

const char * pipecat::rtvi::to_string (MessageType type)
 The RTVI name of a message type, e.g. "bot-ready".
 
std::optional< MessageType > pipecat::rtvi::parse_message_type (const std::string &type)
 The message type with an RTVI name, or std::nullopt if it's unknown.
 
AboutClientData pipecat::rtvi::default_about_client ()
 Information about this library and the platform it runs on.
 

Variables

constexpr const char * pipecat::rtvi::PROTOCOL_VERSION = "2.1.0"
 The RTVI protocol version this library speaks.
 
constexpr const char * pipecat::rtvi::MESSAGE_LABEL = "rtvi-ai"
 The label of every RTVI message.
 

Detailed Description

RTVI messages and their data.