[FFmpeg-soc] [soc]: r4893 - concat/libavformat/playlist.h

[gkovacs]

Author: gkovacs
Date: Sat Aug  1 06:52:20 2009
New Revision: 4893

Log:
doxygen comment for ff_playlist_stream_index_from_time

Modified:
   concat/libavformat/playlist.h

Modified: concat/libavformat/playlist.h
==============================================================================
--- concat/libavformat/playlist.h	Sat Aug  1 05:59:20 2009	(r4892)
+++ concat/libavformat/playlist.h	Sat Aug  1 06:52:20 2009	(r4893)
@@ -123,6 +123,12 @@ void ff_playlist_add_path(PlaylistContex
  */
 int64_t ff_playlist_time_offset(int64_t *durations, const int pe_curidx);
 
+/** @fn int64_t ff_playlist_time_offset(int64_t *durations, int pe_curidx)
+ *  @brief Calculates the index of the playlist item which would contain the timestamp specified in AV_TIME_BASE units.
+ *  @param ctx PlaylistContext within which the list of playlist elements and durations are stored.
+ *  @param pts Timestamp in AV_TIME_BASE.
+ *  @return Returns the index of the stream which covers the specified time range.
+ */
 int ff_playlist_stream_index_from_time(PlaylistContext *ctx, int64_t pts);
 
 #endif /* AVFORMAT_PLAYLIST_H */