trim

Author: stephen-derosa

README.md

@@ -260,6 +260,13 @@ The following features are deprecated and will be removed in the next major rele
 
 - `PacketTrailerFeatures` is deprecated. Use `FrameMetadataFeatures` via
   `TrackPublishOptions::frame_metadata_features` instead.
+- `Room::setOnAudioFrameCallback`, `Room::setOnVideoFrameCallback`, and
+  `Room::setOnVideoFrameEventCallback` are deprecated. Use the `[[nodiscard]]`
+  variants `trySetOnAudioFrameCallback`, `trySetOnVideoFrameCallback`, and
+  `trySetOnVideoFrameEventCallback` instead, which return `false` when a
+  callback is already registered rather than silently replacing it. To replace
+  an active callback, call `clearOn*FrameCallback` first. (The same rename
+  applies to the corresponding `SubscriptionThreadDispatcher` methods.)
 
 ### `v1.0.0`
 

include/livekit/room.h

@@ -374,46 +374,20 @@ class LIVEKIT_API Room {
   /// @deprecated Use trySetOnAudioFrameCallback() instead.
   ///
   /// Forwards to @ref trySetOnAudioFrameCallback and discards the result.
-  /// Replacing an active callback is not supported through this overload; call
-  /// @ref clearOnAudioFrameCallback first, then @ref trySetOnAudioFrameCallback.
-  ///
-  /// @param participant_identity Identity of the remote participant.
-  /// @param track_name           Track name to match.
-  /// @param callback             Function invoked for each decoded audio frame.
-  /// @param opts                 Options used when creating the backing
-  ///                             @ref AudioStream.
   [[deprecated("Room::setOnAudioFrameCallback is deprecated; use trySetOnAudioFrameCallback instead")]]
   void setOnAudioFrameCallback(const std::string& participant_identity, const std::string& track_name,
                                AudioFrameCallback callback, const AudioStream::Options& opts = {});
 
   /// @deprecated Use trySetOnVideoFrameCallback() instead.
   ///
   /// Forwards to @ref trySetOnVideoFrameCallback and discards the result.
-  /// Replacing an active callback is not supported through this overload; call
-  /// @ref clearOnVideoFrameCallback first, then @ref trySetOnVideoFrameCallback.
-  ///
-  /// @param participant_identity Identity of the remote participant.
-  /// @param track_name           Track name to match.
-  /// @param callback             Function invoked for each decoded video frame.
-  /// @param opts                 Options used when creating the backing
-  ///                             @ref VideoStream.
   [[deprecated("Room::setOnVideoFrameCallback is deprecated; use trySetOnVideoFrameCallback instead")]]
   void setOnVideoFrameCallback(const std::string& participant_identity, const std::string& track_name,
                                VideoFrameCallback callback, const VideoStream::Options& opts = {});
 
   /// @deprecated Use trySetOnVideoFrameEventCallback() instead.
   ///
   /// Forwards to @ref trySetOnVideoFrameEventCallback and discards the result.
-  /// Replacing an active callback is not supported through this overload; call
-  /// @ref clearOnVideoFrameCallback first, then
-  /// @ref trySetOnVideoFrameEventCallback.
-  ///
-  /// @param participant_identity Identity of the remote participant.
-  /// @param track_name           Track name to match.
-  /// @param callback             Function invoked for each decoded video frame
-  ///                             event, including optional metadata.
-  /// @param opts                 Options used when creating the backing
-  ///                             @ref VideoStream.
   [[deprecated("Room::setOnVideoFrameEventCallback is deprecated; use trySetOnVideoFrameEventCallback instead")]]
   void setOnVideoFrameEventCallback(const std::string& participant_identity, const std::string& track_name,
                                     VideoFrameEventCallback callback, const VideoStream::Options& opts = {});

include/livekit/subscription_thread_dispatcher.h

@@ -160,12 +160,6 @@ class LIVEKIT_API SubscriptionThreadDispatcher {
   /// Forwards to @ref trySetOnAudioFrameCallback and discards the result.
   /// Replacing an active callback is not supported through this overload; call
   /// @ref clearOnAudioFrameCallback first, then @ref trySetOnAudioFrameCallback.
-  ///
-  /// @param participant_identity Identity of the remote participant.
-  /// @param track_name           Track name to match.
-  /// @param callback             Function invoked for each decoded audio frame.
-  /// @param opts                 Options used when creating the backing
-  ///                             @ref AudioStream.
   [[deprecated(
       "SubscriptionThreadDispatcher::setOnAudioFrameCallback is deprecated; use trySetOnAudioFrameCallback instead")]]
   void setOnAudioFrameCallback(const std::string& participant_identity, const std::string& track_name,
@@ -176,12 +170,6 @@ class LIVEKIT_API SubscriptionThreadDispatcher {
   /// Forwards to @ref trySetOnVideoFrameCallback and discards the result.
   /// Replacing an active callback is not supported through this overload; call
   /// @ref clearOnVideoFrameCallback first, then @ref trySetOnVideoFrameCallback.
-  ///
-  /// @param participant_identity Identity of the remote participant.
-  /// @param track_name           Track name to match.
-  /// @param callback             Function invoked for each decoded video frame.
-  /// @param opts                 Options used when creating the backing
-  ///                             @ref VideoStream.
   [[deprecated(
       "SubscriptionThreadDispatcher::setOnVideoFrameCallback is deprecated; use trySetOnVideoFrameCallback instead")]]
   void setOnVideoFrameCallback(const std::string& participant_identity, const std::string& track_name,
@@ -193,13 +181,6 @@ class LIVEKIT_API SubscriptionThreadDispatcher {
   /// Replacing an active callback is not supported through this overload; call
   /// @ref clearOnVideoFrameCallback first, then
   /// @ref trySetOnVideoFrameEventCallback.
-  ///
-  /// @param participant_identity Identity of the remote participant.
-  /// @param track_name           Track name to match.
-  /// @param callback             Function invoked for each decoded video frame
-  ///                             event, including optional metadata.
-  /// @param opts                 Options used when creating the backing
-  ///                             @ref VideoStream.
   [[deprecated(
       "SubscriptionThreadDispatcher::setOnVideoFrameEventCallback is deprecated; use "
       "trySetOnVideoFrameEventCallback instead")]]