gstreamer/docs/gst/tmpl/gstsrc.sgml
Wim Taymans 196c67d7ff Changed the GstPadFactory and added the GstPadTemplate.
Original commit message from CVS:
Changed the GstPadFactory and added the GstPadTemplate.

The GstPadFactory is an easy way to define a pad with capabilities.
The GstPadFactory is converted into a GstPadTemplate. The template is
used to create new pads and to expose the possible pads used in an
element to the plugin system.

updated mp3parse, mpg123, cdparanoia to the new API.
Rerun gstreamer-register because the XML definition has changed.
2000-12-13 19:29:35 +00:00

97 lines
1.8 KiB
Text

<!-- ##### SECTION Title ##### -->
GstSrc
<!-- ##### SECTION Short_Description ##### -->
The start point of a filter graph
<!-- ##### SECTION Long_Description ##### -->
<para>
A GstSrc is the start of a filter graph. It typically is a file or an
audio source. It provides data for the next element in the graph.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### ENUM GstSrcFlags ##### -->
<para>
<informaltable pgwide=1 frame="none" role="enum">
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
<tbody>
<row>
<entry>GST_SRC_ASYNC</entry>
<entry>this source is assynchronous </entry>
</row>
</tbody></tgroup></informaltable>
</para>
@GST_SRC_ASYNC:
<!-- ##### MACRO GST_SRC_FLAGS ##### -->
<para>
This macro returns the entire set of flags for the object.
</para>
@obj: GstSrc to return flags for.
<!-- ##### MACRO GST_SRC_ASYNC ##### -->
<para>
This macro checks to see if the GST_SRC_ASYNC flag is set.
</para>
@obj: GstSrc to check for flag in.
<!-- ##### MACRO GST_SRC_SET_FLAGS ##### -->
<para>
This macro sets the given flags.
</para>
@src:
@flag: Flag to set, can by any number of bits in guint32.
<!-- # Unused Parameters # -->
@obj: GstSrc to set flag in.
<!-- ##### MACRO GST_SRC_UNSET_FLAGS ##### -->
<para>
This macro usets the given flags.
</para>
@src:
@flag: Flag to set, must be a single bit in guint32.
<!-- # Unused Parameters # -->
@obj: GstSrc to unset flag in.
<!-- ##### STRUCT GstSrc ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_src_signal_eos ##### -->
<para>
</para>
@src:
<!-- ##### SIGNAL GstSrc::eos ##### -->
<para>
An eos signal is triggered whenever the GstSrc has reached the end of
the stream.
</para>
@gstsrc: the object which received the signal.
<!-- # Unused Parameters # -->
@arg1: the object which received the signal