Interface for receiving room-level events. More...

#include <room_delegate.h>

Public Member Functions
virtual void	onParticipantConnected (Room &, const ParticipantConnectedEvent &)
	Called when a new remote participant joins the room.

virtual void	onParticipantDisconnected (Room &, const ParticipantDisconnectedEvent &)
	Called when a remote participant leaves the room.

virtual void	onLocalTrackPublished (Room &, const LocalTrackPublishedEvent &)
	Called when a local track is successfully published.

virtual void	onLocalTrackUnpublished (Room &, const LocalTrackUnpublishedEvent &)
	Called when a local track is unpublished.

virtual void	onLocalTrackSubscribed (Room &, const LocalTrackSubscribedEvent &)
	Called when a local track gains its first subscriber.

virtual void	onTrackPublished (Room &, const TrackPublishedEvent &)
	Called when a remote participant publishes a track.

virtual void	onTrackUnpublished (Room &, const TrackUnpublishedEvent &)
	Called when a remote participant unpublishes a track.

virtual void	onTrackSubscribed (Room &, const TrackSubscribedEvent &)
	Called when a remote track is successfully subscribed.

virtual void	onTrackUnsubscribed (Room &, const TrackUnsubscribedEvent &)
	Called when a remote track is unsubscribed.

virtual void	onTrackSubscriptionFailed (Room &, const TrackSubscriptionFailedEvent &)
	Called when subscribing to a remote track fails.

virtual void	onTrackMuted (Room &, const TrackMutedEvent &)
	Called when a track is muted.

virtual void	onTrackUnmuted (Room &, const TrackUnmutedEvent &)
	Called when a track is unmuted.

virtual void	onActiveSpeakersChanged (Room &, const ActiveSpeakersChangedEvent &)
	Called when the list of active speakers changes.

virtual void	onRoomMetadataChanged (Room &, const RoomMetadataChangedEvent &)
	Called when the room's metadata changes.

virtual void	onRoomSidChanged (Room &, const RoomSidChangedEvent &)
	Called when the room SID changes (e.g., after migration).

virtual void	onRoomUpdated (Room &, const RoomUpdatedEvent &)
	Called when any room info is updated.

virtual void	onRoomMoved (Room &, const RoomMovedEvent &)
	Called when the participant is moved to another room.

virtual void	onParticipantMetadataChanged (Room &, const ParticipantMetadataChangedEvent &)
	Called when a participant's metadata is updated.

virtual void	onParticipantNameChanged (Room &, const ParticipantNameChangedEvent &)
	Called when a participant's name is changed.

virtual void	onParticipantAttributesChanged (Room &, const ParticipantAttributesChangedEvent &)
	Called when a participant's attributes are updated.

virtual void	onParticipantEncryptionStatusChanged (Room &, const ParticipantEncryptionStatusChangedEvent &)
	Called when a participant's encryption status changes.

virtual void	onConnectionQualityChanged (Room &, const ConnectionQualityChangedEvent &)
	Called when a participant's connection quality changes.

virtual void	onConnectionStateChanged (Room &, const ConnectionStateChangedEvent &)
	Called when the room's connection state changes.

virtual void	onDisconnected (Room &, const DisconnectedEvent &)
	Called when the room is disconnected.

virtual void	onReconnecting (Room &, const ReconnectingEvent &)
	Called before the SDK attempts to reconnect.

virtual void	onReconnected (Room &, const ReconnectedEvent &)
	Called after the SDK successfully reconnects.

virtual void	onE2eeStateChanged (Room &, const E2eeStateChangedEvent &)
	Called when a participant's end-to-end encryption state changes.

virtual void	onRoomEos (Room &, const RoomEosEvent &)
	Called when the room reaches end-of-stream and will not emit further events.

virtual void	onUserPacketReceived (Room &, const UserDataPacketEvent &)
	Called when a user data packet (non-SIP) is received.

virtual void	onSipDtmfReceived (Room &, const SipDtmfReceivedEvent &)
	Called when a SIP DTMF packet is received.

virtual void	onDataStreamHeaderReceived (Room &, const DataStreamHeaderReceivedEvent &)
	Called when a data stream header is received.

virtual void	onDataStreamChunkReceived (Room &, const DataStreamChunkReceivedEvent &)
	Called when a data stream chunk is received.

virtual void	onDataStreamTrailerReceived (Room &, const DataStreamTrailerReceivedEvent &)
	Called when a data stream trailer is received.

virtual void	onDataChannelBufferedAmountLowThresholdChanged (Room &, const DataChannelBufferedAmountLowThresholdChangedEvent &)
	Called when a data channel's buffered amount falls below its low threshold.

virtual void	onByteStreamOpened (Room &, const ByteStreamOpenedEvent &)
	Called when a high-level byte stream reader is opened.

virtual void	onTextStreamOpened (Room &, const TextStreamOpenedEvent &)
	Called when a high-level text stream reader is opened.

virtual void	onDataTrackPublished (Room &, const DataTrackPublishedEvent &)
	Called when a remote participant publishes a data track.

virtual void	onDataTrackUnpublished (Room &, const DataTrackUnpublishedEvent &)
	Called when a remote participant unpublishes a data track.

virtual void	onParticipantsUpdated (Room &, const ParticipantsUpdatedEvent &)
	Called when a snapshot of participants has been updated.

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

◆ onDataTrackPublished()

virtual void livekit::RoomDelegate::onDataTrackPublished	(	Room &	,
		const DataTrackPublishedEvent &
	)

inlinevirtual

Called when a remote participant publishes a data track.

Data tracks are independent of the audio/video track hierarchy and require an explicit subscribe() call to start receiving frames.

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

include/livekit/room_delegate.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ onDataTrackPublished()