diff options
| author | Anton Khirnov <anton@khirnov.net> | 2011-12-11 12:43:50 +0100 |
|---|---|---|
| committer | Anton Khirnov <anton@khirnov.net> | 2011-12-12 19:43:37 +0100 |
| commit | 1be323054e05d79f5e74896add75a04802d79846 (patch) | |
| tree | d2cb914afe8dfc737fe0bb36156e2b282f978b32 | |
| parent | 5b22d6e1323989b078ad097c5b50dddbbf0fe251 (diff) | |
| download | ffmpeg-1be323054e05d79f5e74896add75a04802d79846.tar.gz | |
Add basic libavdevice documentation.
| -rw-r--r-- | libavdevice/avdevice.h | 22 | ||||
| -rw-r--r-- | libavutil/avutil.h | 1 |
2 files changed, 23 insertions, 0 deletions
diff --git a/libavdevice/avdevice.h b/libavdevice/avdevice.h index fd82816713..e6c86cb3c3 100644 --- a/libavdevice/avdevice.h +++ b/libavdevice/avdevice.h @@ -19,6 +19,28 @@ #ifndef AVDEVICE_AVDEVICE_H #define AVDEVICE_AVDEVICE_H +/** + * @file + * @ingroup lavd + * Main libavdevice API header + */ + +/** + * @defgroup lavd Special devices muxing/demuxing library + * @{ + * Libavdevice is a complementary library to @ref libavf "libavformat". It + * provides various "special" platform-specific muxers and demuxers, e.g. for + * grabbing devices, audio capture and playback etc. As a consequence, the + * (de)muxers in libavdevice are of the AVFMT_NOFILE type (they use their own + * I/O functions). The filename passed to avformat_open_input() often does not + * refer to an actually existing file, but has some special device-specific + * meaning - e.g. for the x11grab device it is the display name. + * + * To use libavdevice, simply call avdevice_register_all() to register all + * compiled muxers and demuxers. They all use standard libavformat API. + * @} + */ + #include "libavutil/avutil.h" #define LIBAVDEVICE_VERSION_MAJOR 53 diff --git a/libavutil/avutil.h b/libavutil/avutil.h index 1ed9ffe87c..fa84eff9e7 100644 --- a/libavutil/avutil.h +++ b/libavutil/avutil.h @@ -37,6 +37,7 @@ * @li @ref libavc "libavcodec" encoding/decoding library * @li @subpage libavfilter graph based frame editing library * @li @ref libavf "libavformat" I/O and muxing/demuxing library + * @li @ref lavd "libavdevice" special devices muxing/demuxing library * @li @ref lavu "libavutil" common utility library * @li @subpage libpostproc post processing library * @li @subpage libswscale color conversion and scaling library |