mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-23 16:50:47 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: update introspected plugin docs for gstdoc-scangobj and other changes

Browse source 
Update common for latest gstdoc-scangobj and inspect xml files for
escaping and pad template order changes. Update other gtk-doc files
for API additions and object hierarchy changes.
This commit is contained in:
Tim-Philipp Müller 2010-06-17 16:06:53 +01:00
parent 6d2621d02c
commit 1d4d29f134
17 changed files with 170 additions and 115 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
common

@ -1 +1 @@
Subproject commit 35617c2306d19c6d2460ea3dc9fcdabfc5dd1677 Subproject commit 73ff93a46a122e76ae400eed155f0b1ce13d9ed6

52
docs/plugins/gst-plugins-base-plugins.args
View file

@ -2228,6 +2228,16 @@
<DEFAULT>FALSE</DEFAULT> <DEFAULT>FALSE</DEFAULT>
</ARG> </ARG>
<ARG>
<NAME>GstDecodeBin2::expose-all-streams</NAME>
<TYPE>gboolean</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Expose All Streams</NICK>
<BLURB>Expose all streams, including those of unknown type or that don't match the 'caps' property.</BLURB>
<DEFAULT>TRUE</DEFAULT>
</ARG>
<ARG> <ARG>
<NAME>GstURIDecodeBin::uri</NAME> <NAME>GstURIDecodeBin::uri</NAME>
<TYPE>gchar*</TYPE> <TYPE>gchar*</TYPE>
@ -2318,6 +2328,16 @@
<DEFAULT>FALSE</DEFAULT> <DEFAULT>FALSE</DEFAULT>
</ARG> </ARG>
<ARG>
<NAME>GstURIDecodeBin::expose-all-streams</NAME>
<TYPE>gboolean</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Expose All Streams</NICK>
<BLURB>Expose all streams, including those of unknown type or that don't match the 'caps' property.</BLURB>
<DEFAULT>TRUE</DEFAULT>
</ARG>
<ARG> <ARG>
<NAME>GstQueue2::current-level-buffers</NAME> <NAME>GstQueue2::current-level-buffers</NAME>
<TYPE>guint</TYPE> <TYPE>guint</TYPE>
@ -2688,6 +2708,16 @@
<DEFAULT></DEFAULT> <DEFAULT></DEFAULT>
</ARG> </ARG>
<ARG>
<NAME>GstPlayBin2::av-offset</NAME>
<TYPE>gint64</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>AV Offset</NICK>
<BLURB>The synchronisation offset between audio and video in nanoseconds.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG> <ARG>
<NAME>GstGioSink::location</NAME> <NAME>GstGioSink::location</NAME>
<TYPE>gchar*</TYPE> <TYPE>gchar*</TYPE>
@ -3064,7 +3094,7 @@
<RANGE></RANGE> <RANGE></RANGE>
<FLAGS>rw</FLAGS> <FLAGS>rw</FLAGS>
<NICK>Emit signals</NICK> <NICK>Emit signals</NICK>
<BLURB>Emit new-preroll and new-buffer signals.</BLURB> <BLURB>Emit need-data, enough-data and seek-data signals.</BLURB>
<DEFAULT>TRUE</DEFAULT> <DEFAULT>TRUE</DEFAULT>
</ARG> </ARG>
@ -3168,6 +3198,26 @@
<DEFAULT>NULL</DEFAULT> <DEFAULT>NULL</DEFAULT>
</ARG> </ARG>
<ARG>
<NAME>GstPlaySink::av-offset</NAME>
<TYPE>gint64</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>AV Offset</NICK>
<BLURB>The synchronisation offset between audio and video in nanoseconds.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstPlaySink::frame</NAME>
<TYPE>GstBuffer*</TYPE>
<RANGE></RANGE>
<FLAGS>r</FLAGS>
<NICK>Frame</NICK>
<BLURB>The last frame (NULL = no video available).</BLURB>
<DEFAULT></DEFAULT>
</ARG>
<ARG> <ARG>
<NAME>GstSubtitleOverlay::font-desc</NAME> <NAME>GstSubtitleOverlay::font-desc</NAME>
<TYPE>gchar*</TYPE> <TYPE>gchar*</TYPE>

5
docs/plugins/gst-plugins-base-plugins.hierarchy
View file

@ -82,12 +82,13 @@ GObject
GstOggAviParse GstOggAviParse
GstAdder GstAdder
GstBaseTransform GstBaseTransform
GstVideoFilter
GstVideoScale GstVideoScale
GstFFMpegCsp
GstAudioFilter GstAudioFilter
GstVolume GstVolume
GstAudioConvert GstAudioConvert
GstAudioResample GstAudioResample
GstFFMpegCsp
GstVideoRate GstVideoRate
GstStreamSelector GstStreamSelector
GstPlaybin2InputSelector GstPlaybin2InputSelector
@ -105,8 +106,8 @@ GObject
GstPlugin GstPlugin
GstRegistry GstRegistry
GstRingBuffer GstRingBuffer
GstAudioSinkRingBuffer
GstAudioSrcRingBuffer GstAudioSrcRingBuffer
GstAudioSinkRingBuffer
GstSignalObject GstSignalObject
GstMixerTrack GstMixerTrack
GstStreamInfo GstStreamInfo

8
docs/plugins/gst-plugins-base-plugins.signals
View file

@ -463,3 +463,11 @@ guint64 arg1
GstPlaySink *gstplaysink GstPlaySink *gstplaysink
</SIGNAL> </SIGNAL>
<SIGNAL>
<NAME>GstPlaySink::convert-frame</NAME>
<RETURNS>GstBuffer*</RETURNS>
<FLAGS>la</FLAGS>
GstPlaySink *gstplaysink
GstCaps *arg1
</SIGNAL>

1
docs/plugins/inspect/plugin-alsa.xml
View file

@ -16,7 +16,6 @@
<description>Control sound input and output levels with ALSA</description> <description>Control sound input and output levels with ALSA</description>
<author>Leif Johnson &lt;leif@ambient.2y.net&gt;</author> <author>Leif Johnson &lt;leif@ambient.2y.net&gt;</author>
<pads> <pads>
</pads> </pads>
</element> </element>
<element> <element>

8
docs/plugins/inspect/plugin-audiorate.xml
View file

@ -17,14 +17,14 @@
<author>Wim Taymans &lt;wim@fluendo.com&gt;</author> <author>Wim Taymans &lt;wim@fluendo.com&gt;</author>
<pads> <pads>
<caps> <caps>
<name>src</name> <name>sink</name>
<direction>source</direction> <direction>sink</direction>
<presence>always</presence> <presence>always</presence>
<details>audio/x-raw-int, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int){ 1234, 4321 }, width=(int){ 8, 16, 24, 32 }, depth=(int)[ 1, 32 ], signed=(boolean){ true, false }; audio/x-raw-float, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int){ 1234, 4321 }, width=(int){ 32, 64 }</details> <details>audio/x-raw-int, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int){ 1234, 4321 }, width=(int){ 8, 16, 24, 32 }, depth=(int)[ 1, 32 ], signed=(boolean){ true, false }; audio/x-raw-float, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int){ 1234, 4321 }, width=(int){ 32, 64 }</details>
</caps> </caps>
<caps> <caps>
<name>sink</name> <name>src</name>
<direction>sink</direction> <direction>source</direction>
<presence>always</presence> <presence>always</presence>
<details>audio/x-raw-int, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int){ 1234, 4321 }, width=(int){ 8, 16, 24, 32 }, depth=(int)[ 1, 32 ], signed=(boolean){ true, false }; audio/x-raw-float, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int){ 1234, 4321 }, width=(int){ 32, 64 }</details> <details>audio/x-raw-int, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int){ 1234, 4321 }, width=(int){ 8, 16, 24, 32 }, depth=(int)[ 1, 32 ], signed=(boolean){ true, false }; audio/x-raw-float, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int){ 1234, 4321 }, width=(int){ 32, 64 }</details>
</caps> </caps>

12
docs/plugins/inspect/plugin-decodebin.xml
View file

@ -16,18 +16,18 @@
<description>Autoplug and decode to raw media</description> <description>Autoplug and decode to raw media</description>
<author>Wim Taymans &lt;wim.taymans@gmail.com&gt;</author> <author>Wim Taymans &lt;wim.taymans@gmail.com&gt;</author>
<pads> <pads>
<caps>
<name>src%d</name>
<direction>source</direction>
<presence>sometimes</presence>
<details>ANY</details>
</caps>
<caps> <caps>
<name>sink</name> <name>sink</name>
<direction>sink</direction> <direction>sink</direction>
<presence>always</presence> <presence>always</presence>
<details>ANY</details> <details>ANY</details>
</caps> </caps>
<caps>
<name>src%d</name>
<direction>source</direction>
<presence>sometimes</presence>
<details>ANY</details>
</caps>
</pads> </pads>
</element> </element>
</elements> </elements>

4
docs/plugins/inspect/plugin-ffmpegcolorspace.xml
View file

File diff suppressed because one or more lines are too long

24
docs/plugins/inspect/plugin-gdp.xml
View file

@ -16,18 +16,18 @@
<description>Depayloads GStreamer Data Protocol buffers</description> <description>Depayloads GStreamer Data Protocol buffers</description>
<author>Thomas Vander Stichele &lt;thomas at apestaart dot org&gt;</author> <author>Thomas Vander Stichele &lt;thomas at apestaart dot org&gt;</author>
<pads> <pads>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>ANY</details>
</caps>
<caps> <caps>
<name>sink</name> <name>sink</name>
<direction>sink</direction> <direction>sink</direction>
<presence>always</presence> <presence>always</presence>
<details>application/x-gdp</details> <details>application/x-gdp</details>
</caps> </caps>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>ANY</details>
</caps>
</pads> </pads>
</element> </element>
<element> <element>
@ -37,18 +37,18 @@
<description>Payloads GStreamer Data Protocol buffers</description> <description>Payloads GStreamer Data Protocol buffers</description>
<author>Thomas Vander Stichele &lt;thomas at apestaart dot org&gt;</author> <author>Thomas Vander Stichele &lt;thomas at apestaart dot org&gt;</author>
<pads> <pads>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>application/x-gdp</details>
</caps>
<caps> <caps>
<name>sink</name> <name>sink</name>
<direction>sink</direction> <direction>sink</direction>
<presence>always</presence> <presence>always</presence>
<details>ANY</details> <details>ANY</details>
</caps> </caps>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>application/x-gdp</details>
</caps>
</pads> </pads>
</element> </element>
</elements> </elements>

2
docs/plugins/inspect/plugin-gnomevfs.xml
View file

@ -1,6 +1,6 @@
<plugin> <plugin>
<name>gnomevfs</name> <name>gnomevfs</name>
<description>elements to read from and write to Gnome-VFS uri's</description> <description>elements to read from and write to Gnome-VFS uri&apos;s</description>
<filename>../../ext/gnomevfs/.libs/libgstgnomevfs.so</filename> <filename>../../ext/gnomevfs/.libs/libgstgnomevfs.so</filename>
<basename>libgstgnomevfs.so</basename> <basename>libgstgnomevfs.so</basename>
<version>0.10.29.1</version> <version>0.10.29.1</version>

70
docs/plugins/inspect/plugin-ogg.xml
View file

File diff suppressed because one or more lines are too long

30
docs/plugins/inspect/plugin-playback.xml
View file

@ -16,7 +16,6 @@
<description>Autoplug and play media from an uri</description> <description>Autoplug and play media from an uri</description>
<author>Wim Taymans &lt;wim.taymans@gmail.com&gt;</author> <author>Wim Taymans &lt;wim.taymans@gmail.com&gt;</author>
<pads> <pads>
</pads> </pads>
</element> </element>
<element> <element>
@ -26,7 +25,6 @@
<description>Autoplug and play media from an uri</description> <description>Autoplug and play media from an uri</description>
<author>Wim Taymans &lt;wim.taymans@gmail.com&gt;</author> <author>Wim Taymans &lt;wim.taymans@gmail.com&gt;</author>
<pads> <pads>
</pads> </pads>
</element> </element>
<element> <element>
@ -37,19 +35,7 @@
<author>Wim Taymans &lt;wim.taymans@gmail.com&gt;</author> <author>Wim Taymans &lt;wim.taymans@gmail.com&gt;</author>
<pads> <pads>
<caps> <caps>
<name>text_sink</name> <name>audio_raw_sink</name>
<direction>sink</direction>
<presence>request</presence>
<details>ANY</details>
</caps>
<caps>
<name>video_sink</name>
<direction>sink</direction>
<presence>request</presence>
<details>ANY</details>
</caps>
<caps>
<name>video_raw_sink</name>
<direction>sink</direction> <direction>sink</direction>
<presence>request</presence> <presence>request</presence>
<details>ANY</details> <details>ANY</details>
@ -61,7 +47,19 @@
<details>ANY</details> <details>ANY</details>
</caps> </caps>
<caps> <caps>
<name>audio_raw_sink</name> <name>text_sink</name>
<direction>sink</direction>
<presence>request</presence>
<details>ANY</details>
</caps>
<caps>
<name>video_raw_sink</name>
<direction>sink</direction>
<presence>request</presence>
<details>ANY</details>
</caps>
<caps>
<name>video_sink</name>
<direction>sink</direction> <direction>sink</direction>
<presence>request</presence> <presence>request</presence>
<details>ANY</details> <details>ANY</details>

24
docs/plugins/inspect/plugin-subparse.xml
View file

@ -16,18 +16,18 @@
<description>Parses SSA subtitle streams</description> <description>Parses SSA subtitle streams</description>
<author>Tim-Philipp Müller &lt;tim centricular net&gt;</author> <author>Tim-Philipp Müller &lt;tim centricular net&gt;</author>
<pads> <pads>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>text/x-pango-markup</details>
</caps>
<caps> <caps>
<name>sink</name> <name>sink</name>
<direction>sink</direction> <direction>sink</direction>
<presence>always</presence> <presence>always</presence>
<details>application/x-ssa; application/x-ass</details> <details>application/x-ssa; application/x-ass</details>
</caps> </caps>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>text/x-pango-markup</details>
</caps>
</pads> </pads>
</element> </element>
<element> <element>
@ -37,18 +37,18 @@
<description>Parses subtitle (.sub) files into text streams</description> <description>Parses subtitle (.sub) files into text streams</description>
<author>Gustavo J. A. M. Carneiro &lt;gjc@inescporto.pt&gt;, GStreamer maintainers &lt;gstreamer-devel@lists.sourceforge.net&gt;</author> <author>Gustavo J. A. M. Carneiro &lt;gjc@inescporto.pt&gt;, GStreamer maintainers &lt;gstreamer-devel@lists.sourceforge.net&gt;</author>
<pads> <pads>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>text/plain; text/x-pango-markup</details>
</caps>
<caps> <caps>
<name>sink</name> <name>sink</name>
<direction>sink</direction> <direction>sink</direction>
<presence>always</presence> <presence>always</presence>
<details>application/x-subtitle; application/x-subtitle-sami; application/x-subtitle-tmplayer; application/x-subtitle-mpl2; application/x-subtitle-dks; application/x-subtitle-qttext</details> <details>application/x-subtitle; application/x-subtitle-sami; application/x-subtitle-tmplayer; application/x-subtitle-mpl2; application/x-subtitle-dks; application/x-subtitle-qttext</details>
</caps> </caps>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>text/plain; text/x-pango-markup</details>
</caps>
</pads> </pads>
</element> </element>
</elements> </elements>

1
docs/plugins/inspect/plugin-typefindfunctions.xml
View file

@ -9,6 +9,5 @@
<package>GStreamer Base Plug-ins git</package> <package>GStreamer Base Plug-ins git</package>
<origin>Unknown package origin</origin> <origin>Unknown package origin</origin>
<elements> <elements>
</elements> </elements>
</plugin> </plugin>

12
docs/plugins/inspect/plugin-uridecodebin.xml
View file

@ -16,18 +16,18 @@
<description>Autoplug and decode to raw media</description> <description>Autoplug and decode to raw media</description>
<author>Edward Hervey &lt;edward.hervey@collabora.co.uk&gt;, Sebastian Dröge &lt;sebastian.droege@collabora.co.uk&gt;</author> <author>Edward Hervey &lt;edward.hervey@collabora.co.uk&gt;, Sebastian Dröge &lt;sebastian.droege@collabora.co.uk&gt;</author>
<pads> <pads>
<caps>
<name>src%d</name>
<direction>source</direction>
<presence>sometimes</presence>
<details>ANY</details>
</caps>
<caps> <caps>
<name>sink</name> <name>sink</name>
<direction>sink</direction> <direction>sink</direction>
<presence>always</presence> <presence>always</presence>
<details>ANY</details> <details>ANY</details>
</caps> </caps>
<caps>
<name>src%d</name>
<direction>source</direction>
<presence>sometimes</presence>
<details>ANY</details>
</caps>
</pads> </pads>
</element> </element>
<element> <element>

14
docs/plugins/inspect/plugin-videorate.xml
View file

@ -16,17 +16,17 @@
<description>Drops/duplicates/adjusts timestamps on video frames to make a perfect stream</description> <description>Drops/duplicates/adjusts timestamps on video frames to make a perfect stream</description>
<author>Wim Taymans &lt;wim@fluendo.com&gt;</author> <author>Wim Taymans &lt;wim@fluendo.com&gt;</author>
<pads> <pads>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>video/x-raw-yuv; video/x-raw-rgb; image/jpeg; image/png</details>
</caps>
<caps> <caps>
<name>sink</name> <name>sink</name>
<direction>sink</direction> <direction>sink</direction>
<presence>always</presence> <presence>always</presence>
<details>video/x-raw-yuv; video/x-raw-rgb; image/jpeg; image/png</details> <details>video/x-raw-yuv; video/x-raw-rgb; video/x-raw-gray; image/jpeg; image/png</details>
</caps>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>video/x-raw-yuv; video/x-raw-rgb; video/x-raw-gray; image/jpeg; image/png</details>
</caps> </caps>
</pads> </pads>
</element> </element>

14
docs/plugins/inspect/plugin-videoscale.xml
View file

File diff suppressed because one or more lines are too long