More API docs updates

Original commit message from CVS:
More API docs updates
This commit is contained in:
Wim Taymans 2001-04-19 22:25:04 +00:00
parent d2f531fd06
commit 18a4283a4e
11 changed files with 368 additions and 195 deletions

View file

@ -9,6 +9,7 @@ GtkObject
GstFakeSrc GstFakeSrc
GstFakeSink GstFakeSink
GstDiskSrc GstDiskSrc
GstHttpSrc
GstFdSrc GstFdSrc
GstSineSrc GstSineSrc
GstFdSink GstFdSink

View file

@ -7,7 +7,67 @@ Capabilities of pads
<!-- ##### SECTION Long_Description ##### --> <!-- ##### SECTION Long_Description ##### -->
<para> <para>
GstCaps is used to attach capabilities to a pad. Capabilities are made of GstCaps is used to attach capabilities to a pad. Capabilities are made of
a mime-type and a set of properties. a mime-type and a set of properties. GstCaps can be named and chained into
a list, which is then a GstCaps on its own.
</para>
<para>
GstCaps are created with gst_caps_new(), which takes a name, a mime type and
a pointer to a #GstProps. A convenience macro with a cleaner syntax is
available to create a caps with GST_CAPS_NEW(). The following example shows how
to create a GstCaps.
<programlisting>
GstCaps *caps;
caps = gst_caps_new (
"my_caps", /* capability name */
"audio/raw", /* mime type */
gst_props_new ( /* properties */
"format", GST_PROPS_STRING ("float"),
"layout", GST_PROPS_INT (5),
NULL));
</programlisting>
The following code example is equivalent to the above example:
<programlisting>
GstCaps *caps;
caps = GST_CAPS_NEW (
"my_caps", /* capability name */
"audio/raw", /* mime type */
"format", GST_PROPS_STRING ("float"),
"channels", GST_PROPS_INT (5)
);
</programlisting>
</para>
<para>
GstCaps are refcounted with gst_caps_ref() and gst_caps_unref().
</para>
<para>
GstCaps can be chained with the gst_caps_append(), gst_caps_prepend() and
gst_caps_chain() functions. Use gst_caps_get_by_name() to get a named caps
structure from a chained list.
</para>
<para>
To get the properties of a caps structure the functions
gst_caps_get_boolean(), gst_caps_get_fourcc_int(), gst_caps_get_int(),
gst_caps_get_string(), which all take a property name as an argument.
</para>
<para>
The properties of the caps structure can be modified with gst_caps_set, which
takes a list of key value pairs in the #GstProps syntax as shown by this example:
<programlisting>
GstCaps *caps;
....
gst_caps_set (caps, "format", GST_PROPS_STRING ("int"), NULL);
gst_caps_set (caps, "channels", GST_PROPS_INT (20), NULL);
</programlisting>
</para>
<para>
before modifying a GstCaps, it is a good idea to make a copy if it first with
gst_caps_copy_on_write(). This will copy thr GstCaps if the refcount is &gt;1.
</para> </para>
<!-- ##### SECTION See_Also ##### --> <!-- ##### SECTION See_Also ##### -->

View file

@ -10,7 +10,9 @@ Request the features of the CPU.
This module can be used when developing plugins. It is This module can be used when developing plugins. It is
typically used to enable special optimisations based on the typically used to enable special optimisations based on the
features of the CPU. features of the CPU.
</para>
<para>
You'll get a bitmask of flags with gst_cpu_get_flags().
</para> </para>
<!-- ##### SECTION See_Also ##### --> <!-- ##### SECTION See_Also ##### -->

View file

@ -14,3 +14,14 @@ Reads data from a URL.
</para> </para>
<!-- ##### ARG GstHttpSrc:location ##### -->
<para>
Specify the location of the file. The location must be a fully qualified URL.
</para>
<!-- ##### ARG GstHttpSrc:bytesperread ##### -->
<para>
Specify how many bytes to read at a time.
</para>

View file

@ -6,14 +6,66 @@ The connection between Elements
<!-- ##### SECTION Long_Description ##### --> <!-- ##### SECTION Long_Description ##### -->
<para> <para>
Elements are connected to each other via "pads", which are extremely light-weight generic #GstElement are connected to each other via "pads", which are extremely light-weight generic
connections. connections. After two pad are retrieved from an element with gst_element_get_pad(), the pads
can be connected with gst_pad_connect().
</para>
<para>
PedTemplates are use to describe the runtime behaviour of an element and what pads it
will have during its lifetime. Pads are typically created from a padtemplate with
GST_PADTEMPLATE_NEW() or with the factory macro GST_PADTEMPLATE_FACTORY().
</para>
<para>
Pad and PadTemplates have #GstCaps attached to it to describe the media type they
are capable of dealing with. gst_pad_get_caps() and gst_pad_set_caps() are used to
manipulate the caps of the pads. gst_padtemplate_get_caps() is used to get the
caps of a padtemplate. It's not possible to modify the caps of a padtemplate after
creation. The following code example shows the code to create a pad from a padtemplate.
<programlisting>
GST_PADTEMPLATE_FACTORY (my_factory,
"sink", /* the name of the pad */
GST_PAD_SINK, /* the direction of the pad */
GST_PAD_ALWAYS, /* when this pad will be present */
GST_CAPS_NEW ( /* the capabilities of the padtemplate */
"my_caps",
"audio/raw",
"format", GST_PROPS_STRING ("int"),
"channels", GST_PROPS_INT_RANGE (1, 6)
)
)
void
my_method (void)
{
GstPad *pad;
pad = gst_pad_new_from_template (GST_PADTEMPLATE_GET (my_factory), "sink");
...
}
</programlisting>
Pads created from a padtemplate cannot set capabilities that are incompatible with
the padtemplates capabilities.
</para>
<para>
Pads without padtemplates can be created with gst_pad_new() which takes a direction and
a name as an argument.
</para>
<para>
gst_pad_get_parent() will retrieve the GstElement that owns the pad.
</para>
<para>
GstElements creating a pad will typicilally use the various gst_pad_set_*_function() calls
to register callbacks for various events on the pads.
</para>
<para>
GstElements will use gst_pad_push() and gst_pad_pull() to push out or pull a buffer in. The
gst_pad_pullregion() function can be used to request for a buffer with a specific offset (in
time or in bytes).
</para> </para>
<!-- ##### SECTION See_Also ##### --> <!-- ##### SECTION See_Also ##### -->
<para> <para>
#GstCaps, #GstElement
</para> </para>
<!-- ##### MACRO GST_PAD_NAME ##### --> <!-- ##### MACRO GST_PAD_NAME ##### -->
@ -638,26 +690,26 @@ Call the EOS function of the pad
<!-- ##### MACRO GST_RPAD_LEN ##### --> <!-- ##### MACRO GST_RPAD_LEN ##### -->
<para> <para>
Get the length of the region that is being pulled.
</para> </para>
@pad: @pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_OFFSET ##### --> <!-- ##### MACRO GST_RPAD_OFFSET ##### -->
<para> <para>
Get the offset of the region that is being pulled.
</para> </para>
@pad: @pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_REGIONTYPE ##### --> <!-- ##### MACRO GST_RPAD_REGIONTYPE ##### -->
<para> <para>
Get the type of the region that is being pulled.
</para> </para>
@pad: @pad: the real pad to query.
<!-- ##### STRUCT GstRealPad ##### --> <!-- ##### STRUCT GstRealPad ##### -->
@ -785,26 +837,26 @@ Get the EOS function of the real pad.
<!-- ##### MACRO GST_RPAD_NEGOTIATEFUNC ##### --> <!-- ##### MACRO GST_RPAD_NEGOTIATEFUNC ##### -->
<para> <para>
Get the negotiate function from the real pad.
</para> </para>
@pad: @pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_NEWCAPSFUNC ##### --> <!-- ##### MACRO GST_RPAD_NEWCAPSFUNC ##### -->
<para> <para>
Get the newcaps function from the real pad.
</para> </para>
@pad: @pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_BUFFERPOOLFUNC ##### --> <!-- ##### MACRO GST_RPAD_BUFFERPOOLFUNC ##### -->
<para> <para>
Get the bufferpoolfunction from the real pad.
</para> </para>
@pad: @pad: the real pad to query.
<!-- ##### MACRO GST_GPAD_REALPAD ##### --> <!-- ##### MACRO GST_GPAD_REALPAD ##### -->
@ -840,7 +892,8 @@ Indicates when this pad will become available.
@GST_PAD_ALWAYS: the pad is always available @GST_PAD_ALWAYS: the pad is always available
@GST_PAD_SOMETIMES: the pad will become available depending on the media stream @GST_PAD_SOMETIMES: the pad will become available depending on the media stream
@GST_PAD_REQUEST: @GST_PAD_REQUEST: th pad is only available on request with
gst_element_request_pad_by_name() or gst_element_request_compatible_pad().
<!-- ##### STRUCT GstPadTemplate ##### --> <!-- ##### STRUCT GstPadTemplate ##### -->
<para> <para>
@ -855,65 +908,66 @@ Indicates when this pad will become available.
<!-- ##### MACRO GST_PADTEMPLATE_CAPS ##### --> <!-- ##### MACRO GST_PADTEMPLATE_CAPS ##### -->
<para> <para>
Get a handle to the padtemplate #GstCaps
</para> </para>
@templ: @templ: the template to query
<!-- ##### MACRO GST_PADTEMPLATE_DIRECTION ##### --> <!-- ##### MACRO GST_PADTEMPLATE_DIRECTION ##### -->
<para> <para>
Get the direction of the padtemplate.
</para> </para>
@templ: @templ: the template to query
<!-- ##### MACRO GST_PADTEMPLATE_NAME_TEMPLATE ##### --> <!-- ##### MACRO GST_PADTEMPLATE_NAME_TEMPLATE ##### -->
<para> <para>
Get the nametemplate of the padtemplate.
</para> </para>
@templ: @templ: the template to query
<!-- ##### MACRO GST_PADTEMPLATE_PRESENCE ##### --> <!-- ##### MACRO GST_PADTEMPLATE_PRESENCE ##### -->
<para> <para>
Get the presence of the padtemplate.
</para> </para>
@templ: @templ: the template to query
<!-- ##### MACRO GST_PADTEMPLATE_NEW ##### --> <!-- ##### MACRO GST_PADTEMPLATE_NEW ##### -->
<para> <para>
Create a new padtemplate.
</para> </para>
@padname: @padname: the nametemplate for the pads that will be created with this template
@dir: @dir: the direction of the pads.
@pres: @pres: the presence of the pads.
@a...: @a...: the capabilities of this padtemplate usually created with GST_CAPS_NEW()
<!-- ##### MACRO GST_PADTEMPLATE_FACTORY ##### --> <!-- ##### MACRO GST_PADTEMPLATE_FACTORY ##### -->
<para> <para>
Create a factory for a padtemplate. This can be used if you only want one instance
of the padtemplate. Use GST_PADTEMPLATE_GET() to get the unique padtemplate.
</para> </para>
@name: @name: th name of the factory
@padname: @padname: the nametemplate of the pads
@dir: @dir: the direction of the pads.
@pres: @pres: the presence of the pads.
@a...: @a...: the capabilities of this padtemplate, usually created with GST_CAPS_NEW()
<!-- ##### MACRO GST_PADTEMPLATE_GET ##### --> <!-- ##### MACRO GST_PADTEMPLATE_GET ##### -->
<para> <para>
Get the padtemplate of the factory created with GST_PADTEMPLATE_FACTORY()
</para> </para>
@fact: @fact: the factory name to get the padtemplate from.
<!-- ##### FUNCTION gst_padtemplate_new ##### --> <!-- ##### FUNCTION gst_padtemplate_new ##### -->
@ -927,8 +981,6 @@ Indicates when this pad will become available.
@caps: @caps:
@Varargs: @Varargs:
@Returns: @Returns:
<!-- # Unused Parameters # -->
@factory:
<!-- ##### FUNCTION gst_padtemplate_load_thyself ##### --> <!-- ##### FUNCTION gst_padtemplate_load_thyself ##### -->
@ -948,8 +1000,6 @@ Indicates when this pad will become available.
@templ: @templ:
@parent: @parent:
@Returns: @Returns:
<!-- # Unused Parameters # -->
@pad:
<!-- ##### FUNCTION gst_padtemplate_get_caps ##### --> <!-- ##### FUNCTION gst_padtemplate_get_caps ##### -->

View file

@ -7,7 +7,36 @@ Parses commandline syntax into a pipeline.
<!-- ##### SECTION Long_Description ##### --> <!-- ##### SECTION Long_Description ##### -->
<para> <para>
This method allows you to create a pipeline from a command This method allows you to create a pipeline from a command
line syntax description. line syntax description. The following example creates a simple
mp3 player.
<programlisting>
GstElement *pipeline;
/* create a pipeline to hold our elements */
pipeline = gst_pipeline_new ("launch");
/* build a pipeline in the pipeline */
gst_parse_launch ("disksrc location=some.mp3 ! mad ! osssink", GST_BIN (pipeline));
/* play the thing */
gst_element_set_state (pipeline, GST_STATE_PLAYING);
while (gst_bin_iterate (GST_BIN (pipeline)));
gst_element_set_state (pipeline, GST_STATE_NULL);
</programlisting>
</para>
<para>
Elements are separated with a <option>!</option>, properties are set with
<replaceable>property</replaceable>=<replaceable>value</replaceable>, specific pads
of an element are selected by replacing the <option>!</option> with
<replaceable>padname</replaceable><option>!</option>.
</para>
<para>
Elements can be added to a bin by embracing them with <option>()</option>. Threads
can be made with <option>{}</option>.
</para> </para>
<!-- ##### SECTION See_Also ##### --> <!-- ##### SECTION See_Also ##### -->

View file

@ -12,12 +12,6 @@ including threading, as well as provide simple interfaces to common
functions, like 'Play'. functions, like 'Play'.
</para> </para>
<para>
The pipeline also has the capability to autoplug. This feature
allows you to only define the input/output plugins and let the
pipeline figure out what plugins to use.
</para>
<!-- ##### SECTION See_Also ##### --> <!-- ##### SECTION See_Also ##### -->
<para> <para>

View file

@ -6,13 +6,51 @@ Dynamically loadable Elements
<!-- ##### SECTION Long_Description ##### --> <!-- ##### SECTION Long_Description ##### -->
<para> <para>
GStreamer is extensible so <classname>GstElements</classname> can be loaded at runtime. GStreamer is extensible so <classname>GstElements</classname> can be loaded at runtime. A plugin
system can provide one or more of the following basic <application>GStreamer</application>
objects factories:
<itemizedlist>
<listitem>
<para>
A #GstElementFactory: the components to build a pipeline.
</para>
</listitem>
<listitem>
<para>
A #GstTypeFactory: A MIME type and an optional typefind function.
</para>
</listitem>
<listitem>
<para>
A #GstAutoplugFactory: An object used to automatically construct pipelines.
</para>
</listitem>
</itemizedlist>
</para>
<para>
A new plugin is created with gst_plugin_new(). this function will return a handle
to the GstPlugin or NULL if the plugin could not be created.
</para>
<para>
Once a GstPlugin element has been created, you can add the different types of factories
to it with gst_plugin_add_factory(), gst_plugin_add_type(), gst_plugin_add_autoplugger().
</para>
<para>
<application>Gstreamer</application> plugins should have a method plugin_init that is called
by the loader.
</para>
<para>
use gst_plugin_find(), gst_plugin_get_list(), gst_plugin_get_factory_list(), gst_plugin_get_type_list() and
gst_plugin_get_autoplug_list() to query the plugin repository.
</para>
<para>
Plugins are always automaticlly loaded so you don't need to call gst_plugin_load() explicitly
to bring it into memory.
</para> </para>
<!-- ##### SECTION See_Also ##### --> <!-- ##### SECTION See_Also ##### -->
<para> <para>
#GstElement, #GstType, #GstAutoplug
</para> </para>
<!-- ##### STRUCT GstPlugin ##### --> <!-- ##### STRUCT GstPlugin ##### -->

View file

@ -12,7 +12,7 @@ are usually used in conjunction with GstCaps.
<!-- ##### SECTION See_Also ##### --> <!-- ##### SECTION See_Also ##### -->
<para> <para>
GstCaps #GstCaps
</para> </para>
<!-- ##### STRUCT GstProps ##### --> <!-- ##### STRUCT GstProps ##### -->

View file

@ -67,14 +67,6 @@ Query the element for the current mime type
</para> </para>
<!-- ##### FUNCTION gst_fdsink_chain ##### -->
<para>
</para>
@pad:
@buf:
<!-- ##### FUNCTION gst_pad_remove_ghost_parent ##### --> <!-- ##### FUNCTION gst_pad_remove_ghost_parent ##### -->
<para> <para>
@ -83,13 +75,7 @@ Query the element for the current mime type
@pad: @pad:
@parent: @parent:
<!-- ##### ARG GstHttpSrc:location ##### --> <!-- ##### FUNCTION gst_fdsink_chain ##### -->
<para>
Specify the location of the file. The location must be a fully qualified URL.
</para>
<!-- ##### FUNCTION gst_identity_chain ##### -->
<para> <para>
</para> </para>
@ -97,7 +83,7 @@ Specify the location of the file. The location must be a fully qualified URL.
@pad: @pad:
@buf: @buf:
<!-- ##### FUNCTION gst_audiosink_chain ##### --> <!-- ##### FUNCTION gst_identity_chain ##### -->
<para> <para>
</para> </para>
@ -112,6 +98,14 @@ Specify the location of the file. The location must be a fully qualified URL.
@Returns: @Returns:
<!-- ##### FUNCTION gst_audiosink_chain ##### -->
<para>
</para>
@pad:
@buf:
<!-- ##### MACRO GST_PIPELINE_CLASS ##### --> <!-- ##### MACRO GST_PIPELINE_CLASS ##### -->
<para> <para>
@ -206,6 +200,12 @@ the stream.
@gstsrc: the object which received the signal. @gstsrc: the object which received the signal.
@arg1: the object which received the signal @arg1: the object which received the signal
<!-- ##### TYPEDEF GstCapsFactoryEntry ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_disksrc_get_type ##### --> <!-- ##### FUNCTION gst_disksrc_get_type ##### -->
<para> <para>
@ -213,12 +213,6 @@ the stream.
@Returns: @Returns:
<!-- ##### TYPEDEF GstCapsFactoryEntry ##### -->
<para>
</para>
<!-- ##### MACRO GST_IS_DISKSRC_CLASS ##### --> <!-- ##### MACRO GST_IS_DISKSRC_CLASS ##### -->
<para> <para>
@ -372,16 +366,16 @@ subclass use this to start their flag enumeration
@audiosink: @audiosink:
@channels: @channels:
<!-- ##### SECTION ./tmpl/gstconnection.sgml:Short_Description ##### -->
Generic connection between elements.
<!-- ##### STRUCT GstSinkClass ##### --> <!-- ##### STRUCT GstSinkClass ##### -->
<para> <para>
</para> </para>
<!-- ##### SECTION ./tmpl/gstconnection.sgml:Short_Description ##### -->
Generic connection between elements.
<!-- ##### STRUCT GstFilterClass ##### --> <!-- ##### STRUCT GstFilterClass ##### -->
<para> <para>
@ -661,13 +655,13 @@ Specify the current offset in the file.
@sheight: @sheight:
@bytes_per_line: @bytes_per_line:
<!-- ##### ARG GstAudioSink:format ##### --> <!-- ##### SECTION ./tmpl/GstElement.sgml:Long_Description ##### -->
<para> <para>
</para> </para>
<!-- ##### SECTION ./tmpl/GstElement.sgml:Long_Description ##### --> <!-- ##### ARG GstAudioSink:format ##### -->
<para> <para>
</para> </para>
@ -701,17 +695,24 @@ Specify the current offset in the file.
@name: @name:
@Returns: @Returns:
<!-- ##### STRUCT GstConnection ##### -->
<para>
</para>
<!-- ##### STRUCT GstQueueClass ##### --> <!-- ##### STRUCT GstQueueClass ##### -->
<para> <para>
</para> </para>
<!-- ##### STRUCT GstConnection ##### --> <!-- ##### FUNCTION gst_fakesrc_push ##### -->
<para> <para>
</para> </para>
@src:
<!-- ##### FUNCTION gst_type_add_sink ##### --> <!-- ##### FUNCTION gst_type_add_sink ##### -->
<para> <para>
@ -721,13 +722,6 @@ Specify the current offset in the file.
@id: @id:
@sink: @sink:
<!-- ##### FUNCTION gst_fakesrc_push ##### -->
<para>
</para>
@src:
<!-- ##### MACRO GST_IS_IDENTITY_CLASS ##### --> <!-- ##### MACRO GST_IS_IDENTITY_CLASS ##### -->
<para> <para>
@ -1141,13 +1135,6 @@ GstFilter
@obj: @obj:
<!-- ##### FUNCTION gst_fdsrc_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_IS_QUEUE_CLASS ##### --> <!-- ##### MACRO GST_IS_QUEUE_CLASS ##### -->
<para> <para>
@ -1155,6 +1142,13 @@ GstFilter
@obj: @obj:
<!-- ##### FUNCTION gst_fdsrc_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_pad_get_type_id ##### --> <!-- ##### FUNCTION gst_pad_get_type_id ##### -->
<para> <para>
@ -1163,6 +1157,13 @@ GstFilter
@pad: @pad:
@Returns: @Returns:
<!-- ##### FUNCTION gst_thread_iterate ##### -->
<para>
</para>
@thread:
<!-- ##### STRUCT OverlayClip ##### --> <!-- ##### STRUCT OverlayClip ##### -->
<para> <para>
@ -1173,13 +1174,6 @@ GstFilter
@y1: @y1:
@y2: @y2:
<!-- ##### FUNCTION gst_thread_iterate ##### -->
<para>
</para>
@thread:
<!-- ##### ENUM GstSrcFlags ##### --> <!-- ##### ENUM GstSrcFlags ##### -->
<para> <para>
Flags for the GstSrc element Flags for the GstSrc element
@ -1255,13 +1249,6 @@ Defines an entry for a padfactory.
@obj: @obj:
<!-- ##### MACRO GST_AUDIOSINK_CLASS ##### -->
<para>
</para>
@klass:
<!-- ##### FUNCTION gst_asyncdisksrc_get_type ##### --> <!-- ##### FUNCTION gst_asyncdisksrc_get_type ##### -->
<para> <para>
@ -1269,6 +1256,13 @@ Defines an entry for a padfactory.
@Returns: @Returns:
<!-- ##### MACRO GST_AUDIOSINK_CLASS ##### -->
<para>
</para>
@klass:
<!-- ##### MACRO GST_PAD_FACTORY_SINK ##### --> <!-- ##### MACRO GST_PAD_FACTORY_SINK ##### -->
<para> <para>
Indicates a sinkpad for the padfactory. Indicates a sinkpad for the padfactory.
@ -1304,6 +1298,12 @@ Indicates a sinkpad for the padfactory.
@pad: @pad:
@Returns: @Returns:
<!-- ##### MACRO GST_PROPS_FOURCC_ID ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_esdsink_new ##### --> <!-- ##### FUNCTION gst_esdsink_new ##### -->
<para> <para>
@ -1312,12 +1312,6 @@ Indicates a sinkpad for the padfactory.
@name: @name:
@Returns: @Returns:
<!-- ##### MACRO GST_PROPS_FOURCC_ID ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_element_request_pad ##### --> <!-- ##### FUNCTION gst_element_request_pad ##### -->
<para> <para>
@ -1427,12 +1421,6 @@ This macro sets the given flags.
@flag: Flag to set, can by any number of bits in guint32. @flag: Flag to set, can by any number of bits in guint32.
@obj: GstSrc to set flag in. @obj: GstSrc to set flag in.
<!-- ##### MACRO DEBUG_LEAVE_STRING ##### -->
<para>
</para>
<!-- ##### MACRO GST_PROPS_FLOAT_STRING ##### --> <!-- ##### MACRO GST_PROPS_FLOAT_STRING ##### -->
<para> <para>
@ -1440,6 +1428,12 @@ This macro sets the given flags.
@a: @a:
<!-- ##### MACRO DEBUG_LEAVE_STRING ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_filter_get_type ##### --> <!-- ##### FUNCTION gst_filter_get_type ##### -->
<para> <para>
@ -1461,16 +1455,16 @@ This macro sets the given flags.
</para> </para>
<!-- ##### SECTION ./tmpl/gstsink.sgml:Title ##### -->
GstSink
<!-- ##### MACRO GST_CPU_FLAG_MMX ##### --> <!-- ##### MACRO GST_CPU_FLAG_MMX ##### -->
<para> <para>
A flag indicating that MMX instructions are supported. A flag indicating that MMX instructions are supported.
</para> </para>
<!-- ##### SECTION ./tmpl/gstsink.sgml:Title ##### -->
GstSink
<!-- ##### FUNCTION gst_object_get_type ##### --> <!-- ##### FUNCTION gst_object_get_type ##### -->
<para> <para>
@ -1608,13 +1602,6 @@ Indicates a srcpad for the padfactory.
@obj: @obj:
<!-- ##### ARG GstHttpSrc:bytesperread ##### -->
<para>
Specify how many bytes to read at a time.
</para>
<!-- ##### MACRO GST_THREAD ##### --> <!-- ##### MACRO GST_THREAD ##### -->
<para> <para>
@ -1784,13 +1771,6 @@ or a video card.
</para> </para>
<!-- ##### FUNCTION gst_esdsink_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_IS_BIN_CLASS ##### --> <!-- ##### MACRO GST_IS_BIN_CLASS ##### -->
<para> <para>
@ -1798,6 +1778,13 @@ or a video card.
@obj: @obj:
<!-- ##### FUNCTION gst_esdsink_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### SECTION ./tmpl/GstElement.sgml:See_Also ##### --> <!-- ##### SECTION ./tmpl/GstElement.sgml:See_Also ##### -->
<para> <para>
@ -1818,6 +1805,12 @@ Query whether this object has multiple input pads.
@obj: Element to query for multiple input pads. @obj: Element to query for multiple input pads.
<!-- ##### SECTION ./tmpl/gstfilter.sgml:See_Also ##### -->
<para>
</para>
<!-- ##### MACRO DEBUG_NOPREFIX ##### --> <!-- ##### MACRO DEBUG_NOPREFIX ##### -->
<para> <para>
@ -1826,12 +1819,6 @@ Query whether this object has multiple input pads.
@format: @format:
@args...: @args...:
<!-- ##### SECTION ./tmpl/gstfilter.sgml:See_Also ##### -->
<para>
</para>
<!-- ##### ARG GstAudioSink:frequency ##### --> <!-- ##### ARG GstAudioSink:frequency ##### -->
<para> <para>
@ -2249,6 +2236,13 @@ this in the factory definition.
@audiosink: @audiosink:
<!-- ##### MACRO GST_IS_FAKESINK ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_STATE_UNSET ##### --> <!-- ##### MACRO GST_STATE_UNSET ##### -->
<para> <para>
This macro unsets the given state on the element. This macro unsets the given state on the element.
@ -2257,13 +2251,6 @@ This macro unsets the given state on the element.
@obj: Element to unset state of. @obj: Element to unset state of.
@flag: State to unset, can be any number of bits in guint32. @flag: State to unset, can be any number of bits in guint32.
<!-- ##### MACRO GST_IS_FAKESINK ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_QUEUE_CLASS ##### --> <!-- ##### MACRO GST_QUEUE_CLASS ##### -->
<para> <para>
@ -2336,13 +2323,6 @@ The number of bytes per read.
@obj: @obj:
<!-- ##### FUNCTION gst_sinesrc_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO ERROR_OBJECT ##### --> <!-- ##### MACRO ERROR_OBJECT ##### -->
<para> <para>
@ -2353,6 +2333,13 @@ The number of bytes per read.
@format: @format:
@args...: @args...:
<!-- ##### FUNCTION gst_sinesrc_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_IS_IDENTITY ##### --> <!-- ##### MACRO GST_IS_IDENTITY ##### -->
<para> <para>
@ -2457,14 +2444,9 @@ This macro sets the given state on the element.
@obj: @obj:
<!-- ##### FUNCTION gst_src_push_region ##### --> <!-- ##### SECTION ./tmpl/videoraw.sgml:Short_Description ##### -->
<para> Information about video buffers.
</para>
@src:
@offset:
@size:
<!-- ##### FUNCTION gst_fdsink_get_type ##### --> <!-- ##### FUNCTION gst_fdsink_get_type ##### -->
<para> <para>
@ -2473,9 +2455,14 @@ This macro sets the given state on the element.
@Returns: @Returns:
<!-- ##### SECTION ./tmpl/videoraw.sgml:Short_Description ##### --> <!-- ##### FUNCTION gst_src_push_region ##### -->
Information about video buffers. <para>
</para>
@src:
@offset:
@size:
<!-- ##### STRUCT GstPipelineClass ##### --> <!-- ##### STRUCT GstPipelineClass ##### -->
<para> <para>
@ -2579,13 +2566,13 @@ A flag indicating that SSE instructions are supported.
@obj: @obj:
<!-- ##### STRUCT GstDiskSrcClass ##### --> <!-- ##### ARG GstAsyncDiskSrc:size ##### -->
<para> <para>
</para> </para>
<!-- ##### ARG GstAsyncDiskSrc:size ##### --> <!-- ##### STRUCT GstDiskSrcClass ##### -->
<para> <para>
</para> </para>
@ -2666,6 +2653,12 @@ Information about audio buffers.
</para> </para>
<!-- ##### FUNCTION plugin_initialize ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_caps_register ##### --> <!-- ##### FUNCTION gst_caps_register ##### -->
<para> <para>
@ -2674,12 +2667,6 @@ Information about audio buffers.
@factory: @factory:
@Returns: @Returns:
<!-- ##### FUNCTION plugin_initialize ##### -->
<para>
</para>
<!-- ##### ARG GstAsyncDiskSrc:location ##### --> <!-- ##### ARG GstAsyncDiskSrc:location ##### -->
<para> <para>
Specify the location of the file to read. Specify the location of the file to read.
@ -2743,13 +2730,6 @@ the offset.
</para> </para>
<!-- ##### MACRO GST_IS_ASYNCDISKSRC_CLASS ##### -->
<para>
</para>
@obj:
<!-- ##### FUNCTION gst_sinesrc_new ##### --> <!-- ##### FUNCTION gst_sinesrc_new ##### -->
<para> <para>
@ -2758,6 +2738,13 @@ the offset.
@name: @name:
@Returns: @Returns:
<!-- ##### MACRO GST_IS_ASYNCDISKSRC_CLASS ##### -->
<para>
</para>
@obj:
<!-- ##### ARG GstAudioSrc:curoffset ##### --> <!-- ##### ARG GstAudioSrc:curoffset ##### -->
<para> <para>
Get the current number of bytes read. Get the current number of bytes read.
@ -2806,13 +2793,6 @@ plugin
@klass: @klass:
<!-- ##### MACRO GST_ASYNCDISKSRC ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_HTTPSRC_CLASS ##### --> <!-- ##### MACRO GST_HTTPSRC_CLASS ##### -->
<para> <para>
@ -2820,6 +2800,13 @@ plugin
@klass: @klass:
<!-- ##### MACRO GST_ASYNCDISKSRC ##### -->
<para>
</para>
@obj:
<!-- ##### ARG GstPad:active ##### --> <!-- ##### ARG GstPad:active ##### -->
<para> <para>
Indicates this pad is active Indicates this pad is active

View file

@ -917,10 +917,10 @@ gst_pad_get_peer (GstPad *pad)
} }
/** /**
* gst_pad_get_buffer_pool: * gst_pad_get_bufferpool:
* @pad: the pad to get the bufferpool from * @pad: the pad to get the bufferpool from
* *
* Gst the bufferpool of the peer pad of the given * Get the bufferpool of the peer pad of the given
* pad * pad
* *
* Returns: The GstBufferPool or NULL. * Returns: The GstBufferPool or NULL.
@ -1456,11 +1456,12 @@ gst_padtemplate_init (GstPadTemplate *templ)
} }
/** /**
* gst_padtemplate_create: * gst_padtemplate_new:
* @name_template: the name template * @name_template: the name template
* @direction: the direction for the template * @direction: the direction for the template
* @presence: the presence of the pad * @presence: the presence of the pad
* @caps: a list of capabilities for the template * @caps: a list of capabilities for the template
* @...: more capabilities
* *
* Creates a new padtemplate from the given arguments. * Creates a new padtemplate from the given arguments.
* *