livekit::Room Class Reference

#include <room.h>

Public Member Functions
void	setDelegate (RoomDelegate *delegate)
bool	Connect (const std::string &url, const std::string &token, const RoomOptions &options)
RoomInfoData	room_info () const
LocalParticipant *	localParticipant () const
RemoteParticipant *	remoteParticipant (const std::string &identity) const
std::vector< std::shared_ptr< RemoteParticipant > >	remoteParticipants () const
	Returns a snapshot of all current remote participants.
void	registerTextStreamHandler (const std::string &topic, TextStreamHandler handler)
void	unregisterTextStreamHandler (const std::string &topic)
void	registerByteStreamHandler (const std::string &topic, ByteStreamHandler handler)
void	unregisterByteStreamHandler (const std::string &topic)
E2EEManager *	e2eeManager () const
void	setOnAudioFrameCallback (const std::string &participant_identity, TrackSource source, AudioFrameCallback callback, AudioStream::Options opts={})
	Sets the audio frame callback via SubscriptionThreadDispatcher.
void	setOnAudioFrameCallback (const std::string &participant_identity, const std::string &track_name, AudioFrameCallback callback, AudioStream::Options opts={})
	Sets the audio frame callback via SubscriptionThreadDispatcher.
void	setOnVideoFrameCallback (const std::string &participant_identity, TrackSource source, VideoFrameCallback callback, VideoStream::Options opts={})
	Sets the video frame callback via SubscriptionThreadDispatcher.
void	setOnVideoFrameCallback (const std::string &participant_identity, const std::string &track_name, VideoFrameCallback callback, VideoStream::Options opts={})
	Sets the video frame callback via SubscriptionThreadDispatcher.
void	clearOnAudioFrameCallback (const std::string &participant_identity, TrackSource source)
	Clears the audio frame callback via SubscriptionThreadDispatcher.
void	clearOnAudioFrameCallback (const std::string &participant_identity, const std::string &track_name)
	Clears the audio frame callback via SubscriptionThreadDispatcher.
void	clearOnVideoFrameCallback (const std::string &participant_identity, TrackSource source)
	Clears the video frame callback via SubscriptionThreadDispatcher.
void	clearOnVideoFrameCallback (const std::string &participant_identity, const std::string &track_name)
	Clears the video frame callback via SubscriptionThreadDispatcher.
DataFrameCallbackId	addOnDataFrameCallback (const std::string &participant_identity, const std::string &track_name, DataFrameCallback callback)
	Adds a data frame callback via SubscriptionThreadDispatcher.
void	removeOnDataFrameCallback (DataFrameCallbackId id)
	Removes the data frame callback via SubscriptionThreadDispatcher.

Friends
class	RoomCallbackTest

Detailed Description

Represents a LiveKit room session. A Room manages:

• the connection to the LiveKit server
• participant list (local + remote)
• track publications
• server events forwarded to a RoomDelegate

Member Function Documentation

e2eeManager()

E2EEManager * livekit::Room::e2eeManager

(

)

const

Returns the room's E2EE manager, or nullptr if E2EE was not enabled at connect time.

Notes:

• The manager is created after a successful Connect().
• If E2EE was not configured in RoomOptions, this will return nullptr.

---

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

• include/livekit/room.h