Mark ReadFrames as being deprecated

This function's interface is mis-designed, since it relies on the AV1Packet retaining the whole list of OBUs.
pion · Apr 15, 2024 · 2c9f7bf · 2c9f7bf
1 parent 242f5de
commit 2c9f7bf
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/codecs/av1/frame/av1.go b/codecs/av1/frame/av1.go
@@ -30,6 +30,9 @@ func (f *AV1) pushOBUElement(isFirstOBUFragment *bool, obuElement []byte, obuLis
 }
 
 // ReadFrames processes the codecs.AV1Packet and returns fully constructed frames
+//
+// Deprecated: this depends on the depreacted OBUElements field being set
+// by the caller.
 func (f *AV1) ReadFrames(pkt *codecs.AV1Packet) ([][]byte, error) {
 	OBUs := [][]byte{}
 	isFirstOBUFragment := pkt.Z