diff options
| -rw-r--r-- | docs/libs/gst-plugins-base-libs-docs.sgml | 201 |
1 files changed, 63 insertions, 138 deletions
diff --git a/docs/libs/gst-plugins-base-libs-docs.sgml b/docs/libs/gst-plugins-base-libs-docs.sgml index ea47a7caa..1b22b51e9 100644 --- a/docs/libs/gst-plugins-base-libs-docs.sgml +++ b/docs/libs/gst-plugins-base-libs-docs.sgml @@ -3,88 +3,12 @@ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ <!ENTITY % version-entities SYSTEM "version.entities"> %version-entities; -<!ENTITY GstCompiling SYSTEM "compiling.sgml"> -<!-- app--> -<!ENTITY GstAppSrc SYSTEM "xml/gstappsrc.xml"> -<!ENTITY GstAppSink SYSTEM "xml/gstappsink.xml"> -<!-- audio --> -<!ENTITY GstAudio SYSTEM "xml/gstaudio.xml"> -<!ENTITY GstAudioClock SYSTEM "xml/gstaudioclock.xml"> -<!ENTITY GstAudioFilter SYSTEM "xml/gstaudiofilter.xml"> -<!ENTITY GstAudioMixerUtils SYSTEM "xml/gstaudiomixerutils.xml"> -<!ENTITY GstAudioSink SYSTEM "xml/gstaudiosink.xml"> -<!ENTITY GstAudioSrc SYSTEM "xml/gstaudiosrc.xml"> -<!ENTITY GstBaseAudioSink SYSTEM "xml/gstbaseaudiosink.xml"> -<!ENTITY GstBaseAudioSrc SYSTEM "xml/gstbaseaudiosrc.xml"> -<!ENTITY GstMultiChannel SYSTEM "xml/gstmultichannel.xml"> -<!ENTITY GstRingBuffer SYSTEM "xml/gstringbuffer.xml"> -<!-- app --> -<!-- cdda --> -<!ENTITY GstCddaBaseSrc SYSTEM "xml/gstcddabasesrc.xml"> -<!-- fft --> -<!ENTITY GstFFT SYSTEM "xml/gstfft.xml"> -<!ENTITY GstFFTS16 SYSTEM "xml/gstffts16.xml"> -<!ENTITY GstFFTS32 SYSTEM "xml/gstffts32.xml"> -<!ENTITY GstFFTF32 SYSTEM "xml/gstfftf32.xml"> -<!ENTITY GstFFTF64 SYSTEM "xml/gstfftf64.xml"> -<!-- floatcast --> -<!ENTITY GstFloatCast SYSTEM "xml/gstfloatcast.xml"> -<!-- interfaces --> -<!ENTITY GstColorBalance SYSTEM "xml/gstcolorbalance.xml"> -<!ENTITY GstColorBalanceChannel SYSTEM "xml/gstcolorbalancechannel.xml"> -<!ENTITY GstMixer SYSTEM "xml/gstmixer.xml"> -<!ENTITY GstMixerOptions SYSTEM "xml/gstmixeroptions.xml"> -<!ENTITY GstMixerTrack SYSTEM "xml/gstmixertrack.xml"> -<!ENTITY GstNavigation SYSTEM "xml/gstnavigation.xml"> -<!ENTITY GstPropertyProbe SYSTEM "xml/gstpropertyprobe.xml"> -<!ENTITY GstStreamVolume SYSTEM "xml/gststreamvolume.xml"> -<!ENTITY GstTuner SYSTEM "xml/gsttuner.xml"> -<!ENTITY GstTunerChannel SYSTEM "xml/gsttunerchannel.xml"> -<!ENTITY GstTunerNorm SYSTEM "xml/gsttunernorm.xml"> -<!ENTITY GstVideoOrientation SYSTEM "xml/gstvideoorientation.xml"> -<!ENTITY GstXOverlay SYSTEM "xml/gstxoverlay.xml"> -<!-- netbuffer --> -<!ENTITY GstNetBuffer SYSTEM "xml/gstnetbuffer.xml"> -<!-- riff --> -<!ENTITY GstRiff SYSTEM "xml/gstriff.xml"> -<!-- rtp --> -<!ENTITY GstBaseRtpAudioPayload SYSTEM "xml/gstbasertpaudiopayload.xml"> -<!ENTITY GstBaseRtpDepayload SYSTEM "xml/gstbasertpdepayload.xml"> -<!ENTITY GstBaseRtpPayload SYSTEM "xml/gstbasertppayload.xml"> -<!ENTITY GstRtpBuffer SYSTEM "xml/gstrtpbuffer.xml"> -<!ENTITY GstRtcpBuffer SYSTEM "xml/gstrtcpbuffer.xml"> -<!ENTITY GstRtpPayloads SYSTEM "xml/gstrtppayloads.xml"> -<!-- rtsp --> -<!ENTITY GstRTSPBase64 SYSTEM "xml/gstrtspbase64.xml"> -<!ENTITY GstRTSPConnection SYSTEM "xml/gstrtspconnection.xml"> -<!ENTITY GstRTSPDefs SYSTEM "xml/gstrtspdefs.xml"> -<!ENTITY GstRTSPMessage SYSTEM "xml/gstrtspmessage.xml"> -<!ENTITY GstRTSPRange SYSTEM "xml/gstrtsprange.xml"> -<!ENTITY GstRTSPTransport SYSTEM "xml/gstrtsptransport.xml"> -<!ENTITY GstRTSPUrl SYSTEM "xml/gstrtspurl.xml"> -<!-- sdp --> -<!ENTITY GstSDP SYSTEM "xml/gstsdp.xml"> -<!ENTITY GstSDPMessage SYSTEM "xml/gstsdpmessage.xml"> -<!-- tag --> -<!ENTITY GstTag SYSTEM "xml/gsttag.xml"> -<!ENTITY GstTagVorbis SYSTEM "xml/gsttagvorbis.xml"> -<!ENTITY GstTagID3 SYSTEM "xml/gsttagid3.xml"> -<!ENTITY GstTagDemux SYSTEM "xml/gsttagdemux.xml"> -<!-- utils --> -<!ENTITY GstPBUtils SYSTEM "xml/gstpbutils.xml"> -<!ENTITY GstPBUtilsDescriptions SYSTEM "xml/gstpbutilsdescriptions.xml"> -<!ENTITY GstPBUtilsMissingPlugins SYSTEM "xml/gstpbutilsmissingplugins.xml"> -<!ENTITY GstPBUtilsInstallPlugins SYSTEM "xml/gstpbutilsinstallplugins.xml"> -<!-- video --> -<!ENTITY GstVideo SYSTEM "xml/gstvideo.xml"> -<!ENTITY GstVideoFilter SYSTEM "xml/gstvideofilter.xml"> -<!ENTITY GstVideoSink SYSTEM "xml/gstvideosink.xml"> <!-- generated by gtkdoc-mkdb --> <!ENTITY gst-plugin-libs-tree-index SYSTEM "xml/tree_index.sgml"> ]> -<book id="index"> +<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude"> <bookinfo> <title>GStreamer Base Plugins &GST_MAJORMINOR; Library Reference Manual</title> <releaseinfo> @@ -99,7 +23,7 @@ This manual describes the libraries provided by the GStreamer Base Plugins package. </para> - &GstCompiling; + <xi:include href="compiling.xml" /> <chapter id="gstreamer-app"> <title>App Library</title> @@ -111,8 +35,8 @@ <para> To use it the functionality, insert an appsrc or appsink element into a pipeline and call the appropriate functions on the element. </para> - &GstAppSrc; - &GstAppSink; + <xi:include href="xml/gstappsrc.xml" /> + <xi:include href="xml/gstappsink.xml" /> </chapter> <chapter id="gstreamer-audio"> @@ -122,16 +46,16 @@ <filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding <filename>-lgstaudio-&GST_MAJORMINOR;</filename> to the library flags. </para> - &GstAudio; - &GstAudioClock; - &GstAudioFilter; - &GstAudioMixerUtils; - &GstBaseAudioSink; - &GstBaseAudioSrc; - &GstAudioSink; - &GstAudioSrc; - &GstMultiChannel; - &GstRingBuffer; + <xi:include href="xml/gstaudio.xml" /> + <xi:include href="xml/gstaudioclock.xml" /> + <xi:include href="xml/gstaudiofilter.xml" /> + <xi:include href="xml/gstaudiomixerutils.xml" /> + <xi:include href="xml/gstaudiosink.xml" /> + <xi:include href="xml/gstaudiosrc.xml" /> + <xi:include href="xml/gstbaseaudiosink.xml" /> + <xi:include href="xml/gstbaseaudiosrc.xml" /> + <xi:include href="xml/gstmultichannel.xml" /> + <xi:include href="xml/gstringbuffer.xml" /> </chapter> <chapter id="gstreamer-cdda"> @@ -141,7 +65,7 @@ <filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding <filename>-lgstcdda-&GST_MAJORMINOR;</filename> to the library flags. </para> - &GstCddaBaseSrc; + <xi:include href="xml/gstcddabasesrc.xml" /> </chapter> <chapter id="gstreamer-ffft"> @@ -156,11 +80,11 @@ <filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding <filename>-lgstfft-&GST_MAJORMINOR;</filename> to the library flags. </para> - &GstFFT; - &GstFFTS16; - &GstFFTS32; - &GstFFTF32; - &GstFFTF64; + <xi:include href="xml/gstfft.xml" /> + <xi:include href="xml/gstffts16.xml" /> + <xi:include href="xml/gstffts32.xml" /> + <xi:include href="xml/gstfftf32.xml" /> + <xi:include href="xml/gstfftf64.xml" /> </chapter> <chapter id="gstreamer-floatcast"> @@ -170,7 +94,7 @@ <filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding <filename>-lgstfloatcase-&GST_MAJORMINOR;</filename> to the library flags. </para> - &GstFloatCast; + <xi:include href="xml/gstfloatcast.xml" /> </chapter> <chapter id="gstreamer-interfaces"> @@ -180,19 +104,19 @@ <filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding <filename>-lgstinterfaces-&GST_MAJORMINOR;</filename> to the library flags. </para> - &GstColorBalance; - &GstColorBalanceChannel; - &GstMixer; - &GstMixerOptions; - &GstMixerTrack; - &GstNavigation; - &GstPropertyProbe; - &GstStreamVolume; - &GstTuner; - &GstTunerChannel; - &GstTunerNorm; - &GstVideoOrientation; - &GstXOverlay; + <xi:include href="xml/gstcolorbalance.xml" /> + <xi:include href="xml/gstcolorbalancechannel.xml" /> + <xi:include href="xml/gstmixer.xml" /> + <xi:include href="xml/gstmixeroptions.xml" /> + <xi:include href="xml/gstmixertrack.xml" /> + <xi:include href="xml/gstnavigation.xml" /> + <xi:include href="xml/gstpropertyprobe.xml" /> + <xi:include href="xml/gststreamvolume.xml" /> + <xi:include href="xml/gsttuner.xml" /> + <xi:include href="xml/gsttunerchannel.xml" /> + <xi:include href="xml/gsttunernorm.xml" /> + <xi:include href="xml/gstvideoorientation.xml" /> + <xi:include href="xml/gstxoverlay.xml" /> </chapter> <chapter id="gstreamer-netbuffer"> @@ -202,7 +126,7 @@ <filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding <filename>-lgstnetbuffer-&GST_MAJORMINOR;</filename> to the library flags. </para> - &GstNetBuffer; + <xi:include href="xml/gstnetbuffer.xml" /> </chapter> <chapter id="gstreamer-riff"> @@ -212,7 +136,7 @@ <filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding <filename>-lgstriff-&GST_MAJORMINOR;</filename> to the library flags. </para> - &GstRiff; + <xi:include href="xml/gstriff.xml" /> </chapter> <chapter id="gstreamer-rtp"> @@ -222,12 +146,12 @@ <filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding <filename>-lgstrtp-&GST_MAJORMINOR;</filename> to the library flags. </para> - &GstBaseRtpAudioPayload; - &GstBaseRtpDepayload; - &GstBaseRtpPayload; - &GstRtpPayloads; - &GstRtpBuffer; - &GstRtcpBuffer; + <xi:include href="xml/gstbasertpaudiopayload.xml" /> + <xi:include href="xml/gstbasertpdepayload.xml" /> + <xi:include href="xml/gstbasertppayload.xml" /> + <xi:include href="xml/gstrtpbuffer.xml" /> + <xi:include href="xml/gstrtcpbuffer.xml" /> + <xi:include href="xml/gstrtppayloads.xml" /> </chapter> <chapter id="gstreamer-rtsp"> @@ -237,13 +161,13 @@ <filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding <filename>-lgstrtsp-&GST_MAJORMINOR;</filename> to the library flags. </para> - &GstRTSPBase64; - &GstRTSPConnection; - &GstRTSPDefs; - &GstRTSPMessage; - &GstRTSPRange; - &GstRTSPTransport; - &GstRTSPUrl; + <xi:include href="xml/gstrtspbase64.xml" /> + <xi:include href="xml/gstrtspconnection.xml" /> + <xi:include href="xml/gstrtspdefs.xml" /> + <xi:include href="xml/gstrtspmessage.xml" /> + <xi:include href="xml/gstrtsprange.xml" /> + <xi:include href="xml/gstrtsptransport.xml" /> + <xi:include href="xml/gstrtspurl.xml" /> </chapter> <chapter id="gstreamer-sdp"> @@ -253,7 +177,8 @@ <filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding <filename>-lgstsdp-&GST_MAJORMINOR;</filename> to the library flags. </para> - &GstSDPMessage; + <xi:include href="xml/gstsdp.xml" /> + <xi:include href="xml/gstsdpmessage.xml" /> </chapter> <chapter id="gstreamer-tag"> @@ -263,10 +188,10 @@ <filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding <filename>-lgsttag-&GST_MAJORMINOR;</filename> to the library flags. </para> - &GstTag; - &GstTagVorbis; - &GstTagID3; - &GstTagDemux; + <xi:include href="xml/gsttag.xml" /> + <xi:include href="xml/gsttagvorbis.xml" /> + <xi:include href="xml/gsttagid3.xml" /> + <xi:include href="xml/gsttagdemux.xml" /> </chapter> <chapter id="gstreamer-base-utils"> @@ -277,10 +202,10 @@ <filename>-lgstpbutils-&GST_MAJORMINOR;</filename> to the library flags. </para> - &GstPBUtils; - &GstPBUtilsDescriptions; - &GstPBUtilsMissingPlugins; - &GstPBUtilsInstallPlugins; + <xi:include href="xml/gstpbutils.xml" /> + <xi:include href="xml/gstpbutilsdescriptions.xml" /> + <xi:include href="xml/gstpbutilsmissingplugins.xml" /> + <xi:include href="xml/gstpbutilsinstallplugins.xml" /> </chapter> <chapter id="gstreamer-video"> @@ -290,15 +215,15 @@ <filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding <filename>-lgstvideo-&GST_MAJORMINOR;</filename> to the library flags. </para> - &GstVideo; - &GstVideoSink; - &GstVideoFilter; + <xi:include href="xml/gstvideo.xml" /> + <xi:include href="xml/gstvideofilter.xml" /> + <xi:include href="xml/gstvideosink.xml" /> </chapter> </part> <part id="gstreamer-libs-hierarchy"> <title>Object Hierarchy</title> - &gst-plugin-libs-tree-index; + <xi:include href="xml/tree_index.sgml" /> </part> <index id="api-index"> |