transport.h

Go to the documentation of this file.

//
// Copyright (c) 2024-2026, Daily
//
// SPDX-License-Identifier: BSD-2-Clause
//
 
 
#ifndef PIPECAT_TRANSPORT_H
#define PIPECAT_TRANSPORT_H
 
#include "pipecat/rtvi/messages.h"
 
#include <nlohmann/json.hpp>
 
#include <cstddef>
#include <cstdint>
#include <string>
 
namespace pipecat {
 
enum class TransportState {
    Disconnected,    
    Initializing,    
    Initialized,     
    Authenticating,  
    Authenticated,   
    Connecting,      
    Connected,       
    Ready,           
    Disconnecting,   
    Error,           
};
 
const char* to_string(TransportState state);
 
struct Participant {
    std::string id;
    std::string name;
    bool local = false;
};
 
class TransportObserver {
   public:
    virtual ~TransportObserver() = default;
 
    virtual void on_transport_message(const nlohmann::json& message) = 0;
 
    virtual void on_bot_connected(const Participant& bot) = 0;
 
    virtual void on_bot_disconnected(const Participant& bot) = 0;
 
    virtual void on_participant_joined(const Participant& participant) = 0;
 
    virtual void on_participant_left(const Participant& participant) = 0;
 
    virtual void on_transport_error(const std::string& error, bool fatal) = 0;
 
    virtual void on_transport_disconnected() = 0;
};
 
class Transport {
   public:
    virtual ~Transport() = default;
 
    virtual void initialize(TransportObserver* observer) = 0;
 
    virtual void connect(const nlohmann::json& params) = 0;
 
    virtual void disconnect() = 0;
 
    virtual void send_ready_message(const rtvi::Message& message) = 0;
 
    virtual void send_message(const rtvi::Message& message) = 0;
 
    virtual size_t max_message_size() const { return 64 * 1024; }
 
    virtual int32_t
    send_user_audio(const int16_t* frames, size_t num_frames) = 0;
 
    virtual int32_t read_bot_audio(int16_t* frames, size_t num_frames) = 0;
};
 
}  // namespace pipecat
 
#endif