Bug 1297265: P2. Amend MediaDataDecoder documentation to emphasize the new expected behavior. r?kamidphish draft
authorJean-Yves Avenard <jyavenard@mozilla.com>
Thu, 01 Sep 2016 19:28:24 +1000
changeset 408562 8c62f4223cf900d09d257dfcb7d6d0cefb1c89bb
parent 408561 fd1b2684fc9944b91422baf0de968c642587ad87
child 408563 16f873a0cbe00a973395cfaa3991dacd80084632
push id28252
push userbmo:jyavenard@mozilla.com
push dateThu, 01 Sep 2016 10:05:27 +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,19 @@ 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.
+  // A frame decoding session is completed once InputExhausted has been called.
+  // MediaDataDecoder::Input will not be called again until InputExhausted has
+  // been called.
   virtual void InputExhausted() = 0;
 
   virtual void DrainComplete() = 0;
 
   virtual void ReleaseMediaResources() {}
 
   virtual bool OnReaderTaskQueue() = 0;