src/io/source_avcodec.h: add documentation
authorPaul Brossier <piem@piem.org>
Mon, 25 Apr 2016 14:41:24 +0000 (16:41 +0200)
committerPaul Brossier <piem@piem.org>
Mon, 25 Apr 2016 14:41:24 +0000 (16:41 +0200)
src/io/source_avcodec.h

index 9ca96db..81f657d 100644 (file)
@@ -118,6 +118,14 @@ uint_t aubio_source_avcodec_get_channels (const aubio_source_avcodec_t * s);
 */
 uint_t aubio_source_avcodec_seek (aubio_source_avcodec_t *s, uint_t pos);
 
+/**
+
+  get the duration of source object, in frames
+
+  \param s source object, created with ::new_aubio_source_avcodec
+  \return number of frames in file
+
+*/
 uint_t aubio_source_avcodec_get_duration (aubio_source_avcodec_t * s);
 
 /**