room_delegate.h

/*
 * Copyright 2025 LiveKit
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an “AS IS” BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#pragma once
 
#include "livekit/room_event_types.h"
#include "livekit/visibility.h"
 
namespace livekit {
 
class Room;
 
class LIVEKIT_API RoomDelegate {
public:
  virtual ~RoomDelegate() = default;
 
  // ------------------------------------------------------------------
  // Participant lifecycle
  // ------------------------------------------------------------------
 
  virtual void onParticipantConnected(Room&, const ParticipantConnectedEvent&) {}
 
  virtual void onParticipantDisconnected(Room&, const ParticipantDisconnectedEvent&) {}
 
  // ------------------------------------------------------------------
  // Local track publication events
  // ------------------------------------------------------------------
 
  virtual void onLocalTrackPublished(Room&, const LocalTrackPublishedEvent&) {}
 
  virtual void onLocalTrackUnpublished(Room&, const LocalTrackUnpublishedEvent&) {}
 
  virtual void onLocalTrackSubscribed(Room&, const LocalTrackSubscribedEvent&) {}
 
  // ------------------------------------------------------------------
  // Remote track publication/subscription
  // ------------------------------------------------------------------
 
  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&) {}
 
  // ------------------------------------------------------------------
  // Active speakers
  // ------------------------------------------------------------------
 
  virtual void onActiveSpeakersChanged(Room&, const ActiveSpeakersChangedEvent&) {}
 
  // ------------------------------------------------------------------
  // Room info / metadata
  // ------------------------------------------------------------------
 
  virtual void onRoomMetadataChanged(Room&, const RoomMetadataChangedEvent&) {}
 
  virtual void onRoomSidChanged(Room&, const RoomSidChangedEvent&) {}
 
  virtual void onRoomUpdated(Room&, const RoomUpdatedEvent&) {}
 
  virtual void onRoomMoved(Room&, const RoomMovedEvent&) {}
 
  // ------------------------------------------------------------------
  // Participant info changes
  // ------------------------------------------------------------------
 
  virtual void onParticipantMetadataChanged(Room&, const ParticipantMetadataChangedEvent&) {}
 
  virtual void onParticipantNameChanged(Room&, const ParticipantNameChangedEvent&) {}
 
  virtual void onParticipantAttributesChanged(Room&, const ParticipantAttributesChangedEvent&) {}
 
  virtual void onParticipantEncryptionStatusChanged(Room&, const ParticipantEncryptionStatusChangedEvent&) {}
 
  // ------------------------------------------------------------------
  // Connection quality / state
  // ------------------------------------------------------------------
 
  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 onTokenRefreshed(Room&, const TokenRefreshedEvent&) {}
 
  // ------------------------------------------------------------------
  // E2EE
  // ------------------------------------------------------------------
 
  virtual void onE2eeStateChanged(Room&, const E2eeStateChangedEvent&) {}
 
  // ------------------------------------------------------------------
  // EOS
  // ------------------------------------------------------------------
 
  virtual void onRoomEos(Room&, const RoomEosEvent&) {}
 
  // ------------------------------------------------------------------
  // Data / transcription / chat
  // ------------------------------------------------------------------
 
  virtual void onUserPacketReceived(Room&, const UserDataPacketEvent&) {}
 
  virtual void onSipDtmfReceived(Room&, const SipDtmfReceivedEvent&) {}
 
  // ------------------------------------------------------------------
  // Data streams
  // ------------------------------------------------------------------
 
  virtual void onDataStreamHeaderReceived(Room&, const DataStreamHeaderReceivedEvent&) {}
 
  virtual void onDataStreamChunkReceived(Room&, const DataStreamChunkReceivedEvent&) {}
 
  virtual void onDataStreamTrailerReceived(Room&, const DataStreamTrailerReceivedEvent&) {}
 
  virtual void onDataChannelBufferedAmountLowThresholdChanged(
      Room&, const DataChannelBufferedAmountLowThresholdChangedEvent&) {}
 
  // ------------------------------------------------------------------
  // High-level byte/text streams
  // ------------------------------------------------------------------
 
  virtual void onByteStreamOpened(Room&, const ByteStreamOpenedEvent&) {}
 
  virtual void onTextStreamOpened(Room&, const TextStreamOpenedEvent&) {}
 
  // ------------------------------------------------------------------
  // Data tracks
  // ------------------------------------------------------------------
 
  virtual void onDataTrackPublished(Room&, const DataTrackPublishedEvent&) {}
 
  virtual void onDataTrackUnpublished(Room&, const DataTrackUnpublishedEvent&) {}
 
  // ------------------------------------------------------------------
  // Participants snapshot
  // ------------------------------------------------------------------
 
  virtual void onParticipantsUpdated(Room&, const ParticipantsUpdatedEvent&) {}
};
 
} // namespace livekit