Document channel drop behavior for fn frames

sportsball-ai · Aug 19, 2024 · 1384466 · 1384466
1 parent 6b4e656
commit 1384466
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/macos/video-toolbox/src/compression_session.rs b/macos/video-toolbox/src/compression_session.rs
@@ -129,6 +129,7 @@ impl<C: Send> CompressionSession<C> {
         unsafe { result(sys::VTCompressionSessionPrepareToEncodeFrames(self.inner.0).into()) }
     }
 
+    /// Note: The sending half of this channel will be dropped when the channel exceeds its buffer capacity. If that happens then you are not polling this channel frequently enough.
     pub fn frames(&self) -> &mpsc::Receiver<Result<CompressionSessionOutputFrame<C>, OSStatus>> {
         &self.frames
     }