mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-30 05:31:15 +00:00
bf8c785fb0
Original commit message from CVS: Documentation updates. All standard library objects and standard elements are documented. Modified some of the elements to more accuratly report about their arguments so the documentation builds more reasonable output. Added aviencoder and jpegencoder elements (not working yet)
113 lines
1.9 KiB
Text
113 lines
1.9 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>
|
|
|
|
|
|
<!-- ##### 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:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_src_push ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@src:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_src_push_region ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@src:
|
|
@offset:
|
|
@size:
|
|
|
|
|
|
<!-- ##### 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.
|
|
@arg1: the object which received the signal
|
|
|