Clarify what av_read_frame() returns.

Originally committed as revision 25123 to svn://svn.ffmpeg.org/ffmpeg/trunk
This commit is contained in:
Michael Niedermayer 2010-09-14 22:20:46 +00:00
parent 180ec37dff
commit 4faf628f20
1 changed files with 5 additions and 0 deletions

View File

@ -1088,6 +1088,11 @@ int av_read_packet(AVFormatContext *s, AVPacket *pkt);
/**
* Return the next frame of a stream.
* This function returns what is stored in the file, and does not validate
* that what is there are valid frames for the decoder. It will split what is
* stored in the file into frames and return one for each call. It will not
* omit invalid data between valid frames so as to give the decoder the maximum
* information possible for decoding.
*
* The returned packet is valid
* until the next av_read_frame() or until av_close_input_file() and