Bug 1297265: P2. Amend MediaDataDecoder documentation to emphasize the new expected behavior. r?kamidphish draft
authorJean-Yves Avenard <jyavenard@mozilla.com>
Tue, 30 Aug 2016 15:17:47 +1000
changeset 407290 ada851f013c3466bf0f6081dcd0c3f5328102a40
parent 407289 44ff17c387e385364d9ed6a2fe3275a6657ee8e9
child 407291 c922c40881d180b53f009f96b1d863e95a1fb046
push id27921
push userbmo:jyavenard@mozilla.com
push dateTue, 30 Aug 2016 07:23:20 +0000
reviewerskamidphish
bugs1297265
milestone51.0a1
Bug 1297265: P2. Amend MediaDataDecoder documentation to emphasize the new expected behavior. r?kamidphish MozReview-Commit-ID: EHFnCnc58qh
dom/media/platforms/PlatformDecoderModule.h
--- a/dom/media/platforms/PlatformDecoderModule.h
+++ b/dom/media/platforms/PlatformDecoderModule.h
@@ -170,16 +170,18 @@ public:
   virtual void Output(MediaData* aData) = 0;
 
   // Denotes an error in the decoding process. The reader will stop calling
   // the decoder.
   virtual void Error(MediaDataDecoderError aError) = 0;
 
   // Denotes that the last input sample has been inserted into the decoder,
   // and no more output can be produced unless more input is sent.
+  // InputExhausted should only be called if no decoded samples were returned
+  // from the last input.
   virtual void InputExhausted() = 0;
 
   virtual void DrainComplete() = 0;
 
   virtual void ReleaseMediaResources() {}
 
   virtual bool OnReaderTaskQueue() = 0;