Commit b214d35e authored by Andy Wingo Wingo's avatar Andy Wingo Wingo

commit to make gstreamer follow the gtk function/macro naming conventions:

Original commit message from CVS:
commit to make gstreamer follow the gtk function/macro naming conventions:

GstPadTemplate <-> gst_pad_template <-> GST_PAD_TEMPLATE

and the same for *factory and typefind.
parent 55d82364
......@@ -13,7 +13,7 @@ non renderer ones do.
</para>
<para>
You first need to create a suitable autoplugger with gst_autoplugfactory_make()
You first need to create a suitable autoplugger with gst_autoplug_factory_make()
(see #GstAutoplugFactory).
The name of the autoplugger must be one of the registered autopluggers
(see #GstStaticAutoplug and #GstStaticAutoplugRender).
......@@ -29,10 +29,10 @@ then add the bin to a pipeline and run it.
GstElement *sink;
/* create a static autoplugger */
autoplug = gst_autoplugfactory_make ("staticrender");
autoplug = gst_autoplug_factory_make ("staticrender");
/* create an osssink */
sink = gst_elementfactory_make ("osssink", "our_sink");
sink = gst_element_factory_make ("osssink", "our_sink");
/* create an element that can play audio/mp3 through osssink */
element = gst_autoplug_to_renderers (autoplug,
......@@ -58,7 +58,7 @@ compatible with the provided sink caps.
GstElement *element;
/* create a static autoplugger */
autoplug = gst_autoplugfactory_make ("static");
autoplug = gst_autoplug_factory_make ("static");
/* create an element that converts audio/mp3 to audio/raw */
element = gst_autoplug_to_caps (autoplug,
......
......@@ -10,20 +10,20 @@ An autoplugfactory is used to create instances of an autoplugger. It
can be added to a #GstPlugin as it extends #GstPluginFeature.
</para>
<para>
Use gst_autoplugfactory_new() to create a new autoplugger which can be registered
Use gst_autoplug_factory_new() to create a new autoplugger which can be registered
to a plugin with gst_plugin_add_feature().
</para>
<para>
Use gst_autoplugfactory_find() to find the named autoplugfactory.
or use gst_autoplugfactory_get_list() to get a list of all available autopluggers.
Use gst_autoplug_factory_find() to find the named autoplugfactory.
or use gst_autoplug_factory_get_list() to get a list of all available autopluggers.
</para>
<para>
Once an autoplugfactory has been obtained use gst_autoplugfactory_create() to
instantiate a real autoplugger. Optionally gst_autoplugfactory_make() to create
Once an autoplugfactory has been obtained use gst_autoplug_factory_create() to
instantiate a real autoplugger. Optionally gst_autoplug_factory_make() to create
a autoplugger from the named factory.
</para>
<para>
Use gst_autoplugfactory_destroy() to remove the factory from the global list.
Use gst_autoplug_factory_destroy() to remove the factory from the global list.
</para>
<!-- ##### SECTION See_Also ##### -->
......@@ -37,7 +37,7 @@ Use gst_autoplugfactory_destroy() to remove the factory from the global list.
</para>
<!-- ##### FUNCTION gst_autoplugfactory_new ##### -->
<!-- ##### FUNCTION gst_autoplug_factory_new ##### -->
<para>
</para>
......@@ -48,7 +48,7 @@ Use gst_autoplugfactory_destroy() to remove the factory from the global list.
@Returns:
<!-- ##### FUNCTION gst_autoplugfactory_destroy ##### -->
<!-- ##### FUNCTION gst_autoplug_factory_destroy ##### -->
<para>
</para>
......@@ -56,7 +56,7 @@ Use gst_autoplugfactory_destroy() to remove the factory from the global list.
@factory:
<!-- ##### FUNCTION gst_autoplugfactory_find ##### -->
<!-- ##### FUNCTION gst_autoplug_factory_find ##### -->
<para>
</para>
......@@ -65,7 +65,7 @@ Use gst_autoplugfactory_destroy() to remove the factory from the global list.
@Returns:
<!-- ##### FUNCTION gst_autoplugfactory_get_list ##### -->
<!-- ##### FUNCTION gst_autoplug_factory_get_list ##### -->
<para>
</para>
......@@ -73,7 +73,7 @@ Use gst_autoplugfactory_destroy() to remove the factory from the global list.
@Returns:
<!-- ##### FUNCTION gst_autoplugfactory_create ##### -->
<!-- ##### FUNCTION gst_autoplug_factory_create ##### -->
<para>
</para>
......@@ -82,7 +82,7 @@ Use gst_autoplugfactory_destroy() to remove the factory from the global list.
@Returns:
<!-- ##### FUNCTION gst_autoplugfactory_make ##### -->
<!-- ##### FUNCTION gst_autoplug_factory_make ##### -->
<para>
</para>
......
......@@ -256,7 +256,7 @@ The function to set the clock on a clock receiving element.
@clock: The clock to set on the element
<!-- ##### FUNCTION gst_element_class_add_padtemplate ##### -->
<!-- ##### FUNCTION gst_element_class_add_pad_template ##### -->
<para>
</para>
......@@ -405,7 +405,7 @@ instead.
@Returns:
<!-- ##### FUNCTION gst_element_get_padtemplate_list ##### -->
<!-- ##### FUNCTION gst_element_get_pad_template_list ##### -->
<para>
</para>
......@@ -414,7 +414,7 @@ instead.
@Returns:
<!-- ##### FUNCTION gst_element_get_padtemplate_by_name ##### -->
<!-- ##### FUNCTION gst_element_get_pad_template_by_name ##### -->
<para>
</para>
......
......@@ -10,21 +10,21 @@ GstElementFactory is used to create instances of elements. A GstElementfactory
can be added to a #GstPlugin as it is also a #GstPluginFeature.
</para>
<para>
Use gst_elementfactory_new() to create a new factory which can be added to a plugin
Use gst_element_factory_new() to create a new factory which can be added to a plugin
with gst_plugin_add_feature().
</para>
<para>
gst_elementfactory_get_list() is used to get a list of all available factories in
gst_element_factory_get_list() is used to get a list of all available factories in
the plugin repository.
</para>
<para>
gst_elementfactory_add_padtemplate() is used to add a padtemplate to the factory.
gst_element_factory_add_pad_template() is used to add a padtemplate to the factory.
This function will enable the application to query for elementfactories that handle
a specific media type.
</para>
<para>
Use the gst_elementfactory_find() and gst_elementfactory_create() functions
to create element instances or use gst_elementfactory_make() as a convenient
Use the gst_element_factory_find() and gst_element_factory_create() functions
to create element instances or use gst_element_factory_make() as a convenient
shortcut.
</para>
<para>
......@@ -40,10 +40,10 @@ The following code example shows you how to create a GstDiskSrc element.
gst_init(&amp;argc,&amp;argv);
srcfactory = gst_elementfactory_find("filesrc");
srcfactory = gst_element_factory_find("filesrc");
g_return_if_fail(srcfactory != NULL);
src = gst_elementfactory_create(srcfactory,"src");
src = gst_element_factory_create(srcfactory,"src");
g_return_if_fail(src != NULL);
...
</programlisting>
......@@ -67,7 +67,7 @@ describes the element, mostly for the benefit of editors.
@author:
@copyright:
<!-- ##### FUNCTION gst_elementfactory_new ##### -->
<!-- ##### FUNCTION gst_element_factory_new ##### -->
<para>
</para>
......@@ -78,7 +78,7 @@ describes the element, mostly for the benefit of editors.
@Returns:
<!-- ##### FUNCTION gst_elementfactory_find ##### -->
<!-- ##### FUNCTION gst_element_factory_find ##### -->
<para>
</para>
......@@ -87,7 +87,7 @@ describes the element, mostly for the benefit of editors.
@Returns:
<!-- ##### FUNCTION gst_elementfactory_get_list ##### -->
<!-- ##### FUNCTION gst_element_factory_get_list ##### -->
<para>
</para>
......@@ -95,7 +95,7 @@ describes the element, mostly for the benefit of editors.
@Returns:
<!-- ##### FUNCTION gst_elementfactory_add_padtemplate ##### -->
<!-- ##### FUNCTION gst_element_factory_add_pad_template ##### -->
<para>
</para>
......@@ -107,7 +107,7 @@ describes the element, mostly for the benefit of editors.
@pad:
<!-- ##### FUNCTION gst_elementfactory_can_src_caps ##### -->
<!-- ##### FUNCTION gst_element_factory_can_src_caps ##### -->
<para>
</para>
......@@ -117,7 +117,7 @@ describes the element, mostly for the benefit of editors.
@Returns:
<!-- ##### FUNCTION gst_elementfactory_can_sink_caps ##### -->
<!-- ##### FUNCTION gst_element_factory_can_sink_caps ##### -->
<para>
</para>
......@@ -127,7 +127,7 @@ describes the element, mostly for the benefit of editors.
@Returns:
<!-- ##### FUNCTION gst_elementfactory_create ##### -->
<!-- ##### FUNCTION gst_element_factory_create ##### -->
<para>
</para>
......@@ -137,7 +137,7 @@ describes the element, mostly for the benefit of editors.
@Returns:
<!-- ##### FUNCTION gst_elementfactory_make ##### -->
<!-- ##### FUNCTION gst_element_factory_make ##### -->
<para>
</para>
......
......@@ -70,7 +70,7 @@ Get the parent element of this pad.
@pad: the pad to query
<!-- ##### MACRO GST_PAD_PADTEMPLATE ##### -->
<!-- ##### MACRO GST_PAD_PAD_TEMPLATE ##### -->
<para>
Get the padtemplate that was used to create this pad. NULL if no padtemplate
was used.
......@@ -662,7 +662,7 @@ Destroy the pad.
@Returns:
<!-- ##### FUNCTION gst_pad_get_padtemplate ##### -->
<!-- ##### FUNCTION gst_pad_get_pad_template ##### -->
<para>
</para>
......@@ -671,7 +671,7 @@ Destroy the pad.
@Returns:
<!-- ##### FUNCTION gst_pad_get_padtemplate_caps ##### -->
<!-- ##### FUNCTION gst_pad_get_pad_template_caps ##### -->
<para>
</para>
......
......@@ -11,19 +11,19 @@ handle.
</para>
<para>
Pad and PadTemplates have #GstCaps attached to it to describe the media type they
are capable of dealing with. gst_padtemplate_get_caps() is used to get the
are capable of dealing with. gst_pad_template_get_caps() is used to get the
caps of a padtemplate. It's not possible to modify the caps of a padtemplate after
creation.
</para>
<para>
Padtemplates can be created with gst_padtemplate_new() or with the convenient
GST_PADTEMPLATE_FACTORY() macro. A padtemplate can be used to create a pad or
Padtemplates can be created with gst_pad_template_new() or with the convenient
GST_PAD_TEMPLATE_FACTORY() macro. A padtemplate can be used to create a pad or
to add to an elementfactory.
</para>
<para>
The following code example shows the code to create a pad from a padtemplate.
<programlisting>
GST_PADTEMPLATE_FACTORY (my_template_factory,
GST_PAD_TEMPLATE_FACTORY (my_template_factory,
"sink", /* the name of the pad */
GST_PAD_SINK, /* the direction of the pad */
GST_PAD_ALWAYS, /* when this pad will be present */
......@@ -40,7 +40,7 @@ The following code example shows the code to create a pad from a padtemplate.
{
GstPad *pad;
pad = gst_pad_new_from_template (GST_PADTEMPLATE_GET (my_template_factory), "sink");
pad = gst_pad_new_from_template (GST_PAD_TEMPLATE_GET (my_template_factory), "sink");
...
}
</programlisting>
......@@ -53,10 +53,10 @@ The following example shows you how to add the padtemplate to an elementfactory:
{
GstElementFactory *factory;
factory = gst_elementfactory_new ("my_factory", GST_TYPE_MYFACTORY, &amp;gst_myfactory_details);
factory = gst_element_factory_new ("my_factory", GST_TYPE_MYFACTORY, &amp;gst_myfactory_details);
g_return_val_if_fail (factory != NULL, FALSE);
gst_elementfactory_add_padtemplate (factory, GST_PADTEMPLATE_GET (my_template_factory));
gst_element_factory_add_pad_template (factory, GST_PAD_TEMPLATE_GET (my_template_factory));
gst_plugin_add_feature (plugin, GST_PLUGIN_FEATURE (factory));
......@@ -87,7 +87,7 @@ gst_element_request_pad_by_name() or gst_element_request_compatible_pad().
</para>
<!-- ##### MACRO GST_PADTEMPLATE_CAPS ##### -->
<!-- ##### MACRO GST_PAD_TEMPLATE_CAPS ##### -->
<para>
Get a handle to the padtemplate #GstCaps
</para>
......@@ -95,7 +95,7 @@ Get a handle to the padtemplate #GstCaps
@templ: the template to query
<!-- ##### MACRO GST_PADTEMPLATE_DIRECTION ##### -->
<!-- ##### MACRO GST_PAD_TEMPLATE_DIRECTION ##### -->
<para>
Get the direction of the padtemplate.
</para>
......@@ -103,7 +103,7 @@ Get the direction of the padtemplate.
@templ: the template to query
<!-- ##### MACRO GST_PADTEMPLATE_NAME_TEMPLATE ##### -->
<!-- ##### MACRO GST_PAD_TEMPLATE_NAME_TEMPLATE ##### -->
<para>
Get the nametemplate of the padtemplate.
</para>
......@@ -111,7 +111,7 @@ Get the nametemplate of the padtemplate.
@templ: the template to query
<!-- ##### MACRO GST_PADTEMPLATE_PRESENCE ##### -->
<!-- ##### MACRO GST_PAD_TEMPLATE_PRESENCE ##### -->
<para>
Get the presence of the padtemplate.
</para>
......@@ -119,7 +119,7 @@ Get the presence of the padtemplate.
@templ: the template to query
<!-- ##### MACRO GST_PADTEMPLATE_NEW ##### -->
<!-- ##### MACRO GST_PAD_TEMPLATE_NEW ##### -->
<para>
Create a new padtemplate.
</para>
......@@ -130,10 +130,10 @@ Create a new padtemplate.
@a...: the capabilities of this padtemplate usually created with GST_CAPS_NEW()
<!-- ##### MACRO GST_PADTEMPLATE_FACTORY ##### -->
<!-- ##### MACRO GST_PAD_TEMPLATE_FACTORY ##### -->
<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.
of the padtemplate. Use GST_PAD_TEMPLATE_GET() to get the unique padtemplate.
</para>
@name: th name of the factory
......@@ -143,15 +143,15 @@ of the padtemplate. Use GST_PADTEMPLATE_GET() to get the unique padtemplate.
@a...: the capabilities of this padtemplate, usually created with GST_CAPS_NEW()
<!-- ##### MACRO GST_PADTEMPLATE_GET ##### -->
<!-- ##### MACRO GST_PAD_TEMPLATE_GET ##### -->
<para>
Get the padtemplate of the factory created with GST_PADTEMPLATE_FACTORY()
Get the padtemplate of the factory created with GST_PAD_TEMPLATE_FACTORY()
</para>
@fact: the factory name to get the padtemplate from.
<!-- ##### MACRO GST_PADTEMPLATE_FIXED ##### -->
<!-- ##### MACRO GST_PAD_TEMPLATE_FIXED ##### -->
<para>
Get the flag indicating the properties are fixed from the template.
</para>
......@@ -159,7 +159,7 @@ Get the flag indicating the properties are fixed from the template.
@templ: the template to query
<!-- ##### MACRO GST_PADTEMPLATE_IS_FIXED ##### -->
<!-- ##### MACRO GST_PAD_TEMPLATE_IS_FIXED ##### -->
<para>
Check if the properties of the padtemplate are fixed
</para>
......@@ -167,7 +167,7 @@ Check if the properties of the padtemplate are fixed
@templ: the template to query
<!-- ##### FUNCTION gst_padtemplate_new ##### -->
<!-- ##### FUNCTION gst_pad_template_new ##### -->
<para>
</para>
......@@ -180,7 +180,7 @@ Check if the properties of the padtemplate are fixed
@Returns:
<!-- ##### FUNCTION gst_padtemplate_load_thyself ##### -->
<!-- ##### FUNCTION gst_pad_template_load_thyself ##### -->
<para>
</para>
......@@ -189,7 +189,7 @@ Check if the properties of the padtemplate are fixed
@Returns:
<!-- ##### FUNCTION gst_padtemplate_save_thyself ##### -->
<!-- ##### FUNCTION gst_pad_template_save_thyself ##### -->
<para>
</para>
......@@ -199,7 +199,7 @@ Check if the properties of the padtemplate are fixed
@Returns:
<!-- ##### FUNCTION gst_padtemplate_get_caps ##### -->
<!-- ##### FUNCTION gst_pad_template_get_caps ##### -->
<para>
</para>
......@@ -208,7 +208,7 @@ Check if the properties of the padtemplate are fixed
@Returns:
<!-- ##### FUNCTION gst_padtemplate_get_caps_by_name ##### -->
<!-- ##### FUNCTION gst_pad_template_get_caps_by_name ##### -->
<para>
</para>
......
......@@ -5001,7 +5001,7 @@ must be defined to activate the tracing functionality.
@srccaps:
@sinkcaps:
<!-- ##### FUNCTION gst_autoplugfactory_load_thyself ##### -->
<!-- ##### FUNCTION gst_autoplug_factory_load_thyself ##### -->
<para>
</para>
......@@ -5009,7 +5009,7 @@ must be defined to activate the tracing functionality.
@parent:
@Returns:
<!-- ##### FUNCTION gst_autoplugfactory_save_thyself ##### -->
<!-- ##### FUNCTION gst_autoplug_factory_save_thyself ##### -->
<para>
</para>
......@@ -5413,7 +5413,7 @@ must be defined to activate the tracing functionality.
@element:
<!-- ##### FUNCTION gst_elementfactory_add_sink ##### -->
<!-- ##### FUNCTION gst_element_factory_add_sink ##### -->
<para>
</para>
......@@ -5421,7 +5421,7 @@ must be defined to activate the tracing functionality.
@elementfactory:
@id:
<!-- ##### FUNCTION gst_elementfactory_add_src ##### -->
<!-- ##### FUNCTION gst_element_factory_add_src ##### -->
<para>
</para>
......@@ -5429,7 +5429,7 @@ must be defined to activate the tracing functionality.
@elementfactory:
@id:
<!-- ##### FUNCTION gst_elementfactory_can_sink_caps_list ##### -->
<!-- ##### FUNCTION gst_element_factory_can_sink_caps_list ##### -->
<para>
</para>
......@@ -5438,7 +5438,7 @@ must be defined to activate the tracing functionality.
@caps:
@Returns:
<!-- ##### FUNCTION gst_elementfactory_can_src_caps_list ##### -->
<!-- ##### FUNCTION gst_element_factory_can_src_caps_list ##### -->
<para>
</para>
......@@ -5447,14 +5447,14 @@ must be defined to activate the tracing functionality.
@caps:
@Returns:
<!-- ##### FUNCTION gst_elementfactory_destroy ##### -->
<!-- ##### FUNCTION gst_element_factory_destroy ##### -->
<para>
</para>
@elementfactory:
<!-- ##### FUNCTION gst_elementfactory_load_thyself ##### -->
<!-- ##### FUNCTION gst_element_factory_load_thyself ##### -->
<para>
</para>
......@@ -5462,14 +5462,14 @@ must be defined to activate the tracing functionality.
@parent:
@Returns:
<!-- ##### FUNCTION gst_elementfactory_register ##### -->
<!-- ##### FUNCTION gst_element_factory_register ##### -->
<para>
</para>
@elementfactory:
<!-- ##### FUNCTION gst_elementfactory_save_thyself ##### -->
<!-- ##### FUNCTION gst_element_factory_save_thyself ##### -->
<para>
</para>
......@@ -5986,7 +5986,7 @@ Call the EOS function of the pad
@sinkpad:
@Returns:
<!-- ##### FUNCTION gst_padtemplate_create ##### -->
<!-- ##### FUNCTION gst_pad_template_create ##### -->
<para>
</para>
......@@ -6072,7 +6072,7 @@ Call the EOS function of the pad
</para>
<!-- ##### FUNCTION gst_plugin_load_autoplugfactory ##### -->
<!-- ##### FUNCTION gst_plugin_load_autoplug_factory ##### -->
<para>
</para>
......@@ -6080,7 +6080,7 @@ Call the EOS function of the pad
@name:
@Returns:
<!-- ##### FUNCTION gst_plugin_load_elementfactory ##### -->
<!-- ##### FUNCTION gst_plugin_load_element_factory ##### -->
<para>
</para>
......@@ -6088,7 +6088,7 @@ Call the EOS function of the pad
@name:
@Returns:
<!-- ##### FUNCTION gst_plugin_load_typefactory ##### -->
<!-- ##### FUNCTION gst_plugin_load_type_factory ##### -->
<para>
</para>
......@@ -6295,7 +6295,7 @@ Call the EOS function of the pad
@sched:
@element:
<!-- ##### FUNCTION gst_schedulerfactory_get_type ##### -->
<!-- ##### FUNCTION gst_scheduler_factory_get_type ##### -->
<para>
</para>
......@@ -6573,7 +6573,7 @@ Call the EOS function of the pad
@parent:
@Returns:
<!-- ##### FUNCTION gst_typefactory_load_thyself ##### -->
<!-- ##### FUNCTION gst_type_factory_load_thyself ##### -->
<para>
</para>
......@@ -6581,7 +6581,7 @@ Call the EOS function of the pad
@parent:
@Returns:
<!-- ##### FUNCTION gst_typefactory_save_thyself ##### -->
<!-- ##### FUNCTION gst_type_factory_save_thyself ##### -->
<para>
</para>
......
......@@ -10,20 +10,20 @@ A schedulerfactory is used to create instances of a scheduler. It
can be added to a #GstPlugin as it extends #GstPluginFeature.
</para>
<para>
Use gst_schedulerfactory_new() to create a new scheduler which can be registered
Use gst_scheduler_factory_new() to create a new scheduler which can be registered
to a plugin with gst_plugin_add_feature().
</para>
<para>
Use gst_schedulerfactory_find() to find the named schedulerfactory.
or use gst_schedulerfactory_get_list() to get a list of all available schedulers.
Use gst_scheduler_factory_find() to find the named schedulerfactory.
or use gst_scheduler_factory_get_list() to get a list of all available schedulers.
</para>
<para>
Once an schedulerfactory has been obtained use gst_schedulerfactory_create() to
instantiate a real scheduler. Optionally gst_schedulerfactory_make() to create
Once an schedulerfactory has been obtained use gst_scheduler_factory_create() to
instantiate a real scheduler. Optionally gst_scheduler_factory_make() to create
a scheduler from the named factory.
</para>
<para>
Use gst_schedulerfactory_destroy() to remove the factory from the global list.
Use gst_scheduler_factory_destroy() to remove the factory from the global list.
</para>
<!-- ##### SECTION See_Also ##### -->
......@@ -31,7 +31,7 @@ Use gst_schedulerfactory_destroy() to remove the factory from the global list.
</para>
<!-- ##### FUNCTION gst_schedulerfactory_create ##### -->
<!-- ##### FUNCTION gst_scheduler_factory_create ##### -->
<para>
</para>
......@@ -41,7 +41,7 @@ Use gst_schedulerfactory_destroy() to remove the factory from the global list.
@Returns:
<!-- ##### FUNCTION gst_schedulerfactory_destroy ##### -->
<!-- ##### FUNCTION gst_scheduler_factory_destroy ##### -->
<para>
</para>
......@@ -49,7 +49,7 @@ Use gst_schedulerfactory_destroy() to remove the factory from the global list.