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 /docs | |
parent | d675816ed0b053077696818253774bd3c55218ec (diff) |
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 'docs')
-rw-r--r-- | docs/plugins/gstreamer-vaapi-plugins-docs.xml.in | 17 | ||||
-rw-r--r-- | docs/plugins/gstreamer-vaapi-plugins-sections.txt | 135 |
2 files changed, 149 insertions, 3 deletions
diff --git a/docs/plugins/gstreamer-vaapi-plugins-docs.xml.in b/docs/plugins/gstreamer-vaapi-plugins-docs.xml.in index 99332e67..5070eb6e 100644 --- a/docs/plugins/gstreamer-vaapi-plugins-docs.xml.in +++ b/docs/plugins/gstreamer-vaapi-plugins-docs.xml.in @@ -10,10 +10,21 @@ </bookinfo> <chapter> + <title>gstreamer-vaapi Elements</title> + <xi:include href="xml/element-vaapidecode.xml"/> + <xi:include href="xml/element-vaapidecodebin.xml"/> + <xi:include href="xml/element-vaapipostproc.xml"/> + <xi:include href="xml/element-vaapisink.xml"/> + <xi:include href="xml/element-vaapiencode_h264.xml"/> + <xi:include href="xml/element-vaapiencode_h265.xml"/> + <xi:include href="xml/element-vaapiencode_jpeg.xml"/> + <xi:include href="xml/element-vaapiencode_mpeg2.xml"/> + <xi:include href="xml/element-vaapiencode_vp8.xml"/> + </chapter> + + <chapter> <title>gstreamer-vaapi Plugins</title> - <xi:include href="xml/gstvaapidecode.xml"/> - <xi:include href="xml/gstvaapipostproc.xml"/> - <xi:include href="xml/gstvaapisink.xml"/> + <xi:include href="xml/plugin-vaapi.xml"/> </chapter> <chapter id="object-tree"> diff --git a/docs/plugins/gstreamer-vaapi-plugins-sections.txt b/docs/plugins/gstreamer-vaapi-plugins-sections.txt new file mode 100644 index 00000000..c18e4621 --- /dev/null +++ b/docs/plugins/gstreamer-vaapi-plugins-sections.txt @@ -0,0 +1,135 @@ +<SECTION> +<FILE>element-vaapidecode</FILE> +<TITLE>vaapidecode</TITLE> +<SUBSECTION Standard> +GST_IS_VAAPIDECODE +GST_IS_VAAPIDECODE_CLASS +GST_TYPE_VAAPIDECODE +GST_VAAPIDECODE +GST_VAAPIDECODE_CLASS +GST_VAAPIDECODE_GET_CLASS +GstVaapiDecode +GstVaapiDecodeClass +gst_vaapidecode_get_type +</SECTION> + +<SECTION> +<FILE>element-vaapidecodebin</FILE> +<TITLE>vaapidecodebin</TITLE> +<SUBSECTION Standard> +GST_IS_AUTO_DETECT +GST_IS_AUTO_DETECT_CLASS +GST_TYPE_VAAPI_DECODE_BIN +GST_VAAPI_DECODE_BIN +GST_VAAPI_DECODE_BIN_CLASS +GST_VAAPI_DECODE_BIN_GET_CLASS +GstVaapiDecodeBin +GstVaapiDecodeBinClass +gst_vaapi_decode_bin_get_type +</SECTION> + +<SECTION> +<FILE>element-vaapipostproc</FILE> +<TITLE>vaapipostproc</TITLE> +GstVaapiDeinterlaceMode +<SUBSECTION Standard> +GST_IS_VAAPIPOSTPROC +GST_IS_VAAPIPOSTPROC_CLASS +GST_TYPE_VAAPIPOSTPROC +GST_VAAPIPOSTPROC +GST_VAAPIPOSTPROC_CLASS +GST_VAAPIPOSTPROC_GET_CLASS +GstVaapiPostproc +GstVaapiPostprocClass +gst_vaapipostproc_get_type +</SECTION> + +<SECTION> +<FILE>element-vaapisink</FILE> +<TITLE>vaapisink</TITLE> +<SUBSECTION Standard> +GST_IS_VAAPISINK +GST_IS_VAAPISINK_CLASS +GST_TYPE_VAAPISINK +GST_VAAPISINK +GST_VAAPISINK_CLASS +GST_VAAPISINK_GET_CLASS +GstVaapiSink +GstVaapiSinkClass +gst_vaapisink_get_type +</SECTION> + +<SECTION> +<FILE>element-vaapiencode_h264</FILE> +<TITLE>vaapiencode_h264</TITLE> +<SUBSECTION Standard> +GST_IS_VAAPIENCODE_H264 +GST_IS_VAAPIENCODE_H264_CLASS +GST_TYPE_VAAPIENCODE_H264 +GST_VAAPIENCODE_H264 +GST_VAAPIENCODE_H264_CLASS +GST_VAAPIENCODE_H264_GET_CLASS +GstVaapiEncodeH264 +GstVaapiEncodeH264Class +gst_vaapiencode_h264_get_type +</SECTION> + +<SECTION> +<FILE>element-vaapiencode_h265</FILE> +<TITLE>vaapiencode_h265</TITLE> +<SUBSECTION Standard> +GST_IS_VAAPIENCODE_H265 +GST_IS_VAAPIENCODE_H265_CLASS +GST_TYPE_VAAPIENCODE_H265 +GST_VAAPIENCODE_H265 +GST_VAAPIENCODE_H265_CLASS +GST_VAAPIENCODE_H265_GET_CLASS +GstVaapiEncodeH265 +GstVaapiEncodeH265Class +gst_vaapiencode_h265_get_type +</SECTION> + +<SECTION> +<FILE>element-vaapiencode_jpeg</FILE> +<TITLE>vaapiencode_jpeg</TITLE> +<SUBSECTION Standard> +GST_IS_VAAPIENCODE_JPEG +GST_IS_VAAPIENCODE_JPEG_CLASS +GST_TYPE_VAAPIENCODE_JPEG +GST_VAAPIENCODE_JPEG +GST_VAAPIENCODE_JPEG_CLASS +GST_VAAPIENCODE_JPEG_GET_CLASS +GstVaapiEncodeJpeg +GstVaapiEncodeJpegClass +gst_vaapiencode_jpeg_get_type +</SECTION> + +<SECTION> +<FILE>element-vaapiencode_mpeg2</FILE> +<TITLE>vaapiencode_mpeg2</TITLE> +<SUBSECTION Standard> +GST_IS_VAAPIENCODE_MPEG2 +GST_IS_VAAPIENCODE_MPEG2_CLASS +GST_TYPE_VAAPIENCODE_MPEG2 +GST_VAAPIENCODE_MPEG2 +GST_VAAPIENCODE_MPEG2_CLASS +GST_VAAPIENCODE_MPEG2_GET_CLASS +GstVaapiEncodeMpeg2 +GstVaapiEncodeMpeg2Class +gst_vaapiencode_mpeg2_get_type +</SECTION> + +<SECTION> +<FILE>element-vaapiencode_vp8</FILE> +<TITLE>vaapiencode_vp8</TITLE> +<SUBSECTION Standard> +GST_IS_VAAPIENCODE_VP8 +GST_IS_VAAPIENCODE_VP8_CLASS +GST_TYPE_VAAPIENCODE_VP8 +GST_VAAPIENCODE_VP8 +GST_VAAPIENCODE_VP8_CLASS +GST_VAAPIENCODE_VP8_GET_CLASS +GstVaapiEncodeVP8 +GstVaapiEncodeVP8Class +gst_vaapiencode_vp8_get_type +</SECTION> |