LiveKit C++ SDK
Real-time audio/video SDK for C++
Loading...
Searching...
No Matches
livekit::DataStreamHeaderData Struct Reference

#include <room_event_types.h>

Public Types

enum class  ContentType { None , Text , Byte }
 
enum class  OperationType { Create = 0 , Update = 1 , Delete = 2 , Reaction = 3 }
 

Public Attributes

std::string stream_id
 
std::int64_t timestamp = 0
 
std::string mime_type
 
std::string topic
 
std::optional< std::uint64_t > total_length
 
std::map< std::string, std::string > attributes
 
enum livekit::DataStreamHeaderData::ContentType content_type = ContentType::None
 
std::optional< OperationTypeoperation_type
 
std::optional< int > version
 
std::optional< std::string > reply_to_stream_id
 
std::vector< std::string > attached_stream_ids
 
std::optional< bool > generated
 
std::optional< std::string > name
 

Detailed Description

Header information for an incoming data stream. Represents proto_room.DataStream.Header in a C++-friendly form.

Member Enumeration Documentation

◆ ContentType

Content type carried by this stream.

◆ OperationType

Operation type for text streams.

Member Data Documentation

◆ attached_stream_ids

std::vector<std::string> livekit::DataStreamHeaderData::attached_stream_ids

IDs of streams attached to this one.

◆ attributes

std::map<std::string, std::string> livekit::DataStreamHeaderData::attributes

Custom attributes associated with this stream.

◆ generated

std::optional<bool> livekit::DataStreamHeaderData::generated

True if this stream was generated (e.g. by AI).

◆ mime_type

std::string livekit::DataStreamHeaderData::mime_type

MIME type of the content (e.g. "application/json").

◆ name

std::optional<std::string> livekit::DataStreamHeaderData::name

Optional filename for byte streams.

◆ operation_type

std::optional<OperationType> livekit::DataStreamHeaderData::operation_type

Optional operation type, for text content.

◆ reply_to_stream_id

std::optional<std::string> livekit::DataStreamHeaderData::reply_to_stream_id

Optional ID of the stream this one replies to.

◆ stream_id

std::string livekit::DataStreamHeaderData::stream_id

Unique stream identifier.

◆ timestamp

std::int64_t livekit::DataStreamHeaderData::timestamp = 0

Timestamp (ms since Unix epoch).

◆ topic

std::string livekit::DataStreamHeaderData::topic

Application-defined topic name.

◆ total_length

std::optional<std::uint64_t> livekit::DataStreamHeaderData::total_length

Optional total length in bytes, if known.

◆ version

std::optional<int> livekit::DataStreamHeaderData::version

Optional version number for the text stream.


The documentation for this struct was generated from the following file: