livekit::RemoteParticipant Class Reference

Represents a remote participant in a LiveKit room. More...

#include <remote_participant.h>

Inheritance diagram for livekit::RemoteParticipant:

Collaboration diagram for livekit::RemoteParticipant:

Public Types
using	PublicationMap = std::unordered_map< std::string, std::shared_ptr< RemoteTrackPublication > >

Public Member Functions
	RemoteParticipant (FfiHandle handle, std::string sid, std::string name, std::string identity, std::string metadata, std::unordered_map< std::string, std::string > attributes, ParticipantKind kind, DisconnectReason reason)
const PublicationMap &	trackPublications () const noexcept
	A dictionary of track publications associated with the participant.
PublicationMap &	mutableTrackPublications () noexcept
	Optional: non-const access if you want to mutate in-place.
std::string	toString () const
Public Member Functions inherited from livekit::Participant
	Participant (FfiHandle handle, std::string sid, std::string name, std::string identity, std::string metadata, std::unordered_map< std::string, std::string > attributes, ParticipantKind kind, DisconnectReason reason)
const std::string &	sid () const noexcept
const std::string &	name () const noexcept
const std::string &	identity () const noexcept
const std::string &	metadata () const noexcept
const std::unordered_map< std::string, std::string > &	attributes () const noexcept
ParticipantKind	kind () const noexcept
DisconnectReason	disconnectReason () const noexcept
uintptr_t	ffiHandleId () const noexcept

Protected Member Functions
std::shared_ptr< TrackPublication >	findTrackPublication (const std::string &sid) const override
	Called by Room events like kTrackMuted.

Friends
class	Room

Detailed Description

Represents a remote participant in a LiveKit room.

Member Function Documentation

findTrackPublication()

std::shared_ptr< TrackPublication > livekit::RemoteParticipant::findTrackPublication ( const std::string &  sid ) const

overrideprotectedvirtual

Called by Room events like kTrackMuted.

This is internal plumbing and not intended to be called directly by SDK users.

Implements livekit::Participant.

---

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

• include/livekit/remote_participant.h