add deprecation to remix_and_resample

livekit · Sep 26, 2024 · e7290dd · e7290dd
1 parent e0505ce
commit e7290dd
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/livekit-rtc/livekit/rtc/audio_frame.py b/livekit-rtc/livekit/rtc/audio_frame.py
@@ -60,8 +60,12 @@ def _from_owned_info(owned_info: proto_audio.OwnedAudioFrameBuffer) -> "AudioFra
         )
 
     def remix_and_resample(self, sample_rate: int, num_channels: int) -> "AudioFrame":
-        """Resample the audio frame to the given sample rate and number of channels."""
+        """Resample the audio frame to the given sample rate and number of channels.
 
+        .. warning::
+            This method is deprecated and will be removed in a future release.
+            Please use the `rtc.AudioResampler` class instead.
+        """
         req = proto_ffi.FfiRequest()
         req.new_audio_resampler.CopyFrom(proto_audio.NewAudioResamplerRequest())