diff options
author | Víctor Manuel Jáquez Leal <victorx.jaquez@intel.com> | 2016-01-29 20:41:27 +0100 |
---|---|---|
committer | Víctor Manuel Jáquez Leal <victorx.jaquez@intel.com> | 2016-02-03 20:03:47 +0100 |
commit | 9b8fb25b8c6ddfa7fd70a7ca79a468dae1376351 (patch) | |
tree | 8f6f60f1fb1a43bda3bff0fca681ad9558e9a1ee /gst/vaapi/gstvaapiencode_jpeg.c | |
parent | d675816ed0b053077696818253774bd3c55218ec (diff) | |
download | gst-vaapi-9b8fb25b8c6ddfa7fd70a7ca79a468dae1376351.tar.gz |
docs: update plugin documentation
Update all the documentation of elements of the vaapi plugin.
Signed-off-by: Víctor Manuel Jáquez Leal <victorx.jaquez@intel.com>
Diffstat (limited to 'gst/vaapi/gstvaapiencode_jpeg.c')
-rw-r--r-- | gst/vaapi/gstvaapiencode_jpeg.c | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/gst/vaapi/gstvaapiencode_jpeg.c b/gst/vaapi/gstvaapiencode_jpeg.c index d9dd3451..086d155c 100644 --- a/gst/vaapi/gstvaapiencode_jpeg.c +++ b/gst/vaapi/gstvaapiencode_jpeg.c @@ -20,6 +20,20 @@ * Boston, MA 02110-1301 USA */ +/** + * SECTION:element-vaapiencode_jpeg + * @short_description: A VA-API based JPEG image encoder + * + * Encodes raw images into JPEG images. + * + * <refsect2> + * <title>Example launch line</title> + * |[ + * gst-launch-1.0 -ev videotestsrc num-buffers=1 ! timeoverlay ! vaapiencode_jpeg ! filesink location=test.jpg + * ]| + * </refsect2> + */ + #include "gstcompat.h" #include <gst/vaapi/gstvaapidisplay.h> #include <gst/vaapi/gstvaapiencoder_jpeg.h> |