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

#include <room_event_types.h>

Public Attributes

std::optional< std::string > sid
 
std::string name
 
std::string metadata
 
std::uint64_t lossy_dc_buffered_amount_low_threshold = 0
 
std::uint64_t reliable_dc_buffered_amount_low_threshold = 0
 
std::uint32_t empty_timeout = 0
 
std::uint32_t departure_timeout = 0
 
std::uint32_t max_participants = 0
 
std::int64_t creation_time = 0
 
std::uint32_t num_participants = 0
 
std::uint32_t num_publishers = 0
 
bool active_recording = false
 

Detailed Description

Snapshot of core room information.

Member Data Documentation

◆ active_recording

bool livekit::RoomInfoData::active_recording = false

True if the room is currently being recorded.

◆ creation_time

std::int64_t livekit::RoomInfoData::creation_time = 0

Creation time of the room (ms since Unix epoch).

◆ departure_timeout

std::uint32_t livekit::RoomInfoData::departure_timeout = 0

Time (seconds) to keep room open after last standard participant leaves.

◆ empty_timeout

std::uint32_t livekit::RoomInfoData::empty_timeout = 0

Time (seconds) to keep room open if no participants join.

◆ lossy_dc_buffered_amount_low_threshold

std::uint64_t livekit::RoomInfoData::lossy_dc_buffered_amount_low_threshold = 0

Low-watermark threshold for lossy data channel buffer.

◆ max_participants

std::uint32_t livekit::RoomInfoData::max_participants = 0

Maximum number of participants allowed in the room.

◆ metadata

std::string livekit::RoomInfoData::metadata

Arbitrary application metadata associated with the room.

◆ name

std::string livekit::RoomInfoData::name

Room name.

◆ num_participants

std::uint32_t livekit::RoomInfoData::num_participants = 0

Approximate number of participants (eventually consistent).

◆ num_publishers

std::uint32_t livekit::RoomInfoData::num_publishers = 0

Approximate number of publishers (eventually consistent).

◆ reliable_dc_buffered_amount_low_threshold

std::uint64_t livekit::RoomInfoData::reliable_dc_buffered_amount_low_threshold = 0

Low-watermark threshold for reliable data channel buffer.

◆ sid

std::optional<std::string> livekit::RoomInfoData::sid

Room SID, if known.


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