LiveKit C++ SDK
Real-time audio/video SDK for C++
Loading...
Searching...
No Matches
Public Member Functions | List of all members
livekit::RoomDelegate Class Reference

#include <room_delegate.h>

Public Member Functions

virtual void onParticipantConnected (Room &, const ParticipantConnectedEvent &)
 
virtual void onParticipantDisconnected (Room &, const ParticipantDisconnectedEvent &)
 
virtual void onLocalTrackPublished (Room &, const LocalTrackPublishedEvent &)
 
virtual void onLocalTrackUnpublished (Room &, const LocalTrackUnpublishedEvent &)
 
virtual void onLocalTrackSubscribed (Room &, const LocalTrackSubscribedEvent &)
 
virtual void onTrackPublished (Room &, const TrackPublishedEvent &)
 
virtual void onTrackUnpublished (Room &, const TrackUnpublishedEvent &)
 
virtual void onTrackSubscribed (Room &, const TrackSubscribedEvent &)
 
virtual void onTrackUnsubscribed (Room &, const TrackUnsubscribedEvent &)
 
virtual void onTrackSubscriptionFailed (Room &, const TrackSubscriptionFailedEvent &)
 
virtual void onTrackMuted (Room &, const TrackMutedEvent &)
 
virtual void onTrackUnmuted (Room &, const TrackUnmutedEvent &)
 
virtual void onActiveSpeakersChanged (Room &, const ActiveSpeakersChangedEvent &)
 
virtual void onRoomMetadataChanged (Room &, const RoomMetadataChangedEvent &)
 
virtual void onRoomSidChanged (Room &, const RoomSidChangedEvent &)
 
virtual void onRoomUpdated (Room &, const RoomUpdatedEvent &)
 
virtual void onRoomMoved (Room &, const RoomMovedEvent &)
 
virtual void onParticipantMetadataChanged (Room &, const ParticipantMetadataChangedEvent &)
 
virtual void onParticipantNameChanged (Room &, const ParticipantNameChangedEvent &)
 
virtual void onParticipantAttributesChanged (Room &, const ParticipantAttributesChangedEvent &)
 
virtual void onParticipantEncryptionStatusChanged (Room &, const ParticipantEncryptionStatusChangedEvent &)
 
virtual void onConnectionQualityChanged (Room &, const ConnectionQualityChangedEvent &)
 
virtual void onConnectionStateChanged (Room &, const ConnectionStateChangedEvent &)
 
virtual void onDisconnected (Room &, const DisconnectedEvent &)
 
virtual void onReconnecting (Room &, const ReconnectingEvent &)
 
virtual void onReconnected (Room &, const ReconnectedEvent &)
 
virtual void onE2eeStateChanged (Room &, const E2eeStateChangedEvent &)
 
virtual void onRoomEos (Room &, const RoomEosEvent &)
 
virtual void onUserPacketReceived (Room &, const UserDataPacketEvent &)
 
virtual void onSipDtmfReceived (Room &, const SipDtmfReceivedEvent &)
 
virtual void onDataStreamHeaderReceived (Room &, const DataStreamHeaderReceivedEvent &)
 
virtual void onDataStreamChunkReceived (Room &, const DataStreamChunkReceivedEvent &)
 
virtual void onDataStreamTrailerReceived (Room &, const DataStreamTrailerReceivedEvent &)
 
virtual void onDataChannelBufferedAmountLowThresholdChanged (Room &, const DataChannelBufferedAmountLowThresholdChangedEvent &)
 
virtual void onByteStreamOpened (Room &, const ByteStreamOpenedEvent &)
 
virtual void onTextStreamOpened (Room &, const TextStreamOpenedEvent &)
 
virtual void onParticipantsUpdated (Room &, const ParticipantsUpdatedEvent &)
 

Detailed Description

Interface for receiving room-level events.

Implement this class and pass an instance to Room::setDelegate() to be notified about participants, tracks, data, and connection changes.

All methods provide default no-op implementations so you can override only the callbacks you care about.

Member Function Documentation

◆ onActiveSpeakersChanged()

virtual void livekit::RoomDelegate::onActiveSpeakersChanged ( Room &  ,
const ActiveSpeakersChangedEvent &   
)
inlinevirtual

Called when the list of active speakers changes.

◆ onByteStreamOpened()

virtual void livekit::RoomDelegate::onByteStreamOpened ( Room &  ,
const ByteStreamOpenedEvent &   
)
inlinevirtual

Called when a high-level byte stream reader is opened.

◆ onConnectionQualityChanged()

virtual void livekit::RoomDelegate::onConnectionQualityChanged ( Room &  ,
const ConnectionQualityChangedEvent &   
)
inlinevirtual

Called when a participant's connection quality changes.

◆ onConnectionStateChanged()

virtual void livekit::RoomDelegate::onConnectionStateChanged ( Room &  ,
const ConnectionStateChangedEvent &   
)
inlinevirtual

Called when the room's connection state changes.

◆ onDataChannelBufferedAmountLowThresholdChanged()

virtual void livekit::RoomDelegate::onDataChannelBufferedAmountLowThresholdChanged ( Room &  ,
const DataChannelBufferedAmountLowThresholdChangedEvent &   
)
inlinevirtual

Called when a data channel's buffered amount falls below its low threshold.

◆ onDataStreamChunkReceived()

virtual void livekit::RoomDelegate::onDataStreamChunkReceived ( Room &  ,
const DataStreamChunkReceivedEvent &   
)
inlinevirtual

Called when a data stream chunk is received.

◆ onDataStreamHeaderReceived()

virtual void livekit::RoomDelegate::onDataStreamHeaderReceived ( Room &  ,
const DataStreamHeaderReceivedEvent &   
)
inlinevirtual

Called when a data stream header is received.

◆ onDataStreamTrailerReceived()

virtual void livekit::RoomDelegate::onDataStreamTrailerReceived ( Room &  ,
const DataStreamTrailerReceivedEvent &   
)
inlinevirtual

Called when a data stream trailer is received.

◆ onDisconnected()

virtual void livekit::RoomDelegate::onDisconnected ( Room &  ,
const DisconnectedEvent &   
)
inlinevirtual

Called when the room is disconnected.

◆ onE2eeStateChanged()

virtual void livekit::RoomDelegate::onE2eeStateChanged ( Room &  ,
const E2eeStateChangedEvent &   
)
inlinevirtual

Called when a participant's end-to-end encryption state changes.

◆ onLocalTrackPublished()

virtual void livekit::RoomDelegate::onLocalTrackPublished ( Room &  ,
const LocalTrackPublishedEvent &   
)
inlinevirtual

Called when a local track is successfully published.

◆ onLocalTrackSubscribed()

virtual void livekit::RoomDelegate::onLocalTrackSubscribed ( Room &  ,
const LocalTrackSubscribedEvent &   
)
inlinevirtual

Called when a local track gains its first subscriber.

◆ onLocalTrackUnpublished()

virtual void livekit::RoomDelegate::onLocalTrackUnpublished ( Room &  ,
const LocalTrackUnpublishedEvent &   
)
inlinevirtual

Called when a local track is unpublished.

◆ onParticipantAttributesChanged()

virtual void livekit::RoomDelegate::onParticipantAttributesChanged ( Room &  ,
const ParticipantAttributesChangedEvent &   
)
inlinevirtual

Called when a participant's attributes are updated.

◆ onParticipantConnected()

virtual void livekit::RoomDelegate::onParticipantConnected ( Room &  ,
const ParticipantConnectedEvent &   
)
inlinevirtual

Called when a new remote participant joins the room.

◆ onParticipantDisconnected()

virtual void livekit::RoomDelegate::onParticipantDisconnected ( Room &  ,
const ParticipantDisconnectedEvent &   
)
inlinevirtual

Called when a remote participant leaves the room.

◆ onParticipantEncryptionStatusChanged()

virtual void livekit::RoomDelegate::onParticipantEncryptionStatusChanged ( Room &  ,
const ParticipantEncryptionStatusChangedEvent &   
)
inlinevirtual

Called when a participant's encryption status changes.

◆ onParticipantMetadataChanged()

virtual void livekit::RoomDelegate::onParticipantMetadataChanged ( Room &  ,
const ParticipantMetadataChangedEvent &   
)
inlinevirtual

Called when a participant's metadata is updated.

◆ onParticipantNameChanged()

virtual void livekit::RoomDelegate::onParticipantNameChanged ( Room &  ,
const ParticipantNameChangedEvent &   
)
inlinevirtual

Called when a participant's name is changed.

◆ onParticipantsUpdated()

virtual void livekit::RoomDelegate::onParticipantsUpdated ( Room &  ,
const ParticipantsUpdatedEvent &   
)
inlinevirtual

Called when a snapshot of participants has been updated.

◆ onReconnected()

virtual void livekit::RoomDelegate::onReconnected ( Room &  ,
const ReconnectedEvent &   
)
inlinevirtual

Called after the SDK successfully reconnects.

◆ onReconnecting()

virtual void livekit::RoomDelegate::onReconnecting ( Room &  ,
const ReconnectingEvent &   
)
inlinevirtual

Called before the SDK attempts to reconnect.

◆ onRoomEos()

virtual void livekit::RoomDelegate::onRoomEos ( Room &  ,
const RoomEosEvent &   
)
inlinevirtual

Called when the room reaches end-of-stream and will not emit further events.

◆ onRoomMetadataChanged()

virtual void livekit::RoomDelegate::onRoomMetadataChanged ( Room &  ,
const RoomMetadataChangedEvent &   
)
inlinevirtual

Called when the room's metadata changes.

◆ onRoomMoved()

virtual void livekit::RoomDelegate::onRoomMoved ( Room &  ,
const RoomMovedEvent &   
)
inlinevirtual

Called when the participant is moved to another room.

◆ onRoomSidChanged()

virtual void livekit::RoomDelegate::onRoomSidChanged ( Room &  ,
const RoomSidChangedEvent &   
)
inlinevirtual

Called when the room SID changes (e.g., after migration).

◆ onRoomUpdated()

virtual void livekit::RoomDelegate::onRoomUpdated ( Room &  ,
const RoomUpdatedEvent &   
)
inlinevirtual

Called when any room info is updated.

◆ onSipDtmfReceived()

virtual void livekit::RoomDelegate::onSipDtmfReceived ( Room &  ,
const SipDtmfReceivedEvent &   
)
inlinevirtual

Called when a SIP DTMF packet is received.

◆ onTextStreamOpened()

virtual void livekit::RoomDelegate::onTextStreamOpened ( Room &  ,
const TextStreamOpenedEvent &   
)
inlinevirtual

Called when a high-level text stream reader is opened.

◆ onTrackMuted()

virtual void livekit::RoomDelegate::onTrackMuted ( Room &  ,
const TrackMutedEvent &   
)
inlinevirtual

Called when a track is muted.

◆ onTrackPublished()

virtual void livekit::RoomDelegate::onTrackPublished ( Room &  ,
const TrackPublishedEvent &   
)
inlinevirtual

Called when a remote participant publishes a track.

◆ onTrackSubscribed()

virtual void livekit::RoomDelegate::onTrackSubscribed ( Room &  ,
const TrackSubscribedEvent &   
)
inlinevirtual

Called when a remote track is successfully subscribed.

◆ onTrackSubscriptionFailed()

virtual void livekit::RoomDelegate::onTrackSubscriptionFailed ( Room &  ,
const TrackSubscriptionFailedEvent &   
)
inlinevirtual

Called when subscribing to a remote track fails.

◆ onTrackUnmuted()

virtual void livekit::RoomDelegate::onTrackUnmuted ( Room &  ,
const TrackUnmutedEvent &   
)
inlinevirtual

Called when a track is unmuted.

◆ onTrackUnpublished()

virtual void livekit::RoomDelegate::onTrackUnpublished ( Room &  ,
const TrackUnpublishedEvent &   
)
inlinevirtual

Called when a remote participant unpublishes a track.

◆ onTrackUnsubscribed()

virtual void livekit::RoomDelegate::onTrackUnsubscribed ( Room &  ,
const TrackUnsubscribedEvent &   
)
inlinevirtual

Called when a remote track is unsubscribed.

◆ onUserPacketReceived()

virtual void livekit::RoomDelegate::onUserPacketReceived ( Room &  ,
const UserDataPacketEvent &   
)
inlinevirtual

Called when a user data packet (non-SIP) is received.

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