docs/gst/gstreamer-docs.sgml: More fine tuning.

Original commit message from CVS:
* docs/gst/gstreamer-docs.sgml: More fine tuning.
* docs/gst/gstreamer-sections.txt:
* docs/gst/tmpl/gstautoplug.sgml:
* docs/gst/tmpl/gststaticautoplug.sgml:
* docs/gst/tmpl/gststaticautoplugrender.sgml:
* docs/gst/tmpl/gstutils.sgml:
* docs/gst/tmpl/gstxml.sgml:
This commit is contained in:
David Schleef 2004-03-25 19:26:26 +00:00
parent 1e4ad29e52
commit e2e72a8993
8 changed files with 186 additions and 366 deletions

View file

@ -1,3 +1,13 @@
2004-03-25 David Schleef <ds@schleef.org>
* docs/gst/gstreamer-docs.sgml: More fine tuning.
* docs/gst/gstreamer-sections.txt:
* docs/gst/tmpl/gstautoplug.sgml:
* docs/gst/tmpl/gststaticautoplug.sgml:
* docs/gst/tmpl/gststaticautoplugrender.sgml:
* docs/gst/tmpl/gstutils.sgml:
* docs/gst/tmpl/gstxml.sgml:
2004-03-24 David Schleef <ds@schleef.org>
* docs/gst/gstreamer-docs.sgml: I got tired of the reference

View file

@ -14,7 +14,6 @@
<!ENTITY GstCpu SYSTEM "xml/gstcpu.xml">
<!ENTITY GstData SYSTEM "xml/gstdata.xml">
<!ENTITY GstElement SYSTEM "xml/gstelement.xml">
<!ENTITY GstElementFactory SYSTEM "xml/gstelementfactory.xml">
<!ENTITY GstError SYSTEM "xml/gsterror.xml">
<!ENTITY GstEvent SYSTEM "xml/gstevent.xml">
<!ENTITY GstFormat SYSTEM "xml/gstformat.xml">
@ -41,12 +40,9 @@
<!ENTITY GstThread SYSTEM "xml/gstthread.xml">
<!ENTITY GstTrace SYSTEM "xml/gsttrace.xml">
<!ENTITY GstTypeFind SYSTEM "xml/gsttypefind.xml">
<!ENTITY GstTypeFindFactory SYSTEM "xml/gsttypefindfactory.xml">
<!ENTITY GstUtils SYSTEM "xml/gstutils.xml">
<!ENTITY GstUri SYSTEM "xml/gsturi.xml">
<!-- not commented properly yet
<!ENTITY GstValue SYSTEM "xml/gstvalue.xml">
-->
<!ENTITY GstXML SYSTEM "xml/gstxml.xml">
<!-- these are elements without API docs
<!ENTITY GstQueue SYSTEM "xml/gstqueue.xml">
@ -92,7 +88,6 @@ with some more specialized elements.</para>
&GstCpu;
&GstData;
&GstElement;
<!-- &GstElementFactory; -->
&GstError;
&GstEvent;
&GstFormat;
@ -118,12 +113,9 @@ with some more specialized elements.</para>
&GstTagInterface;
&GstThread;
&GstTypeFind;
<!-- &GstTypeFindFactory; -->
&GstUri;
&GstUtils;
<!-- not commented properly yet
&GstValue;
-->
&GstXML;
</chapter>

View file

@ -1,4 +1,3 @@
<INCLUDE>gst/gst.h</INCLUDE>
<SECTION>
<FILE>gstbin</FILE>
GST_BIN_CLASS
@ -1502,6 +1501,32 @@ cothread_current_main
cothread_current
</SECTION>
<SECTION>
<FILE>gettext</FILE>
gettext
dgettext
dcgettext
ngettext
dngettext
dcngettext
textdomain
bindtextdomain
bind_textdomain_codeset
gettext_noop
</SECTION>
<SECTION>
<FILE>gst-i18n-app</FILE>
_
N_
</SECTION>
<SECTION>
<FILE>gst-i18n-lib</FILE>
_
N_
</SECTION>
<SECTION>
<FILE>gst</FILE>
gst_init
@ -1576,131 +1601,6 @@ SMP_ISYNC
PPC405_ERR77
</SECTION>
<SECTION>
<FILE>gstenumtypes</FILE>
gst_object_flags_get_type
GST_TYPE_OBJECT_FLAGS
gst_bin_flags_get_type
GST_TYPE_BIN_FLAGS
gst_buffer_flag_get_type
GST_TYPE_BUFFER_FLAG
gst_clock_entry_status_get_type
GST_TYPE_CLOCK_ENTRY_STATUS
gst_clock_entry_type_get_type
GST_TYPE_CLOCK_ENTRY_TYPE
gst_clock_return_get_type
GST_TYPE_CLOCK_RETURN
gst_clock_flags_get_type
GST_TYPE_CLOCK_FLAGS
gst_cpu_flags_get_type
GST_TYPE_CPU_FLAGS
gst_data_flags_get_type
GST_TYPE_DATA_FLAGS
gst_element_flags_get_type
GST_TYPE_ELEMENT_FLAGS
gst_core_error_get_type
GST_TYPE_CORE_ERROR
gst_library_error_get_type
GST_TYPE_LIBRARY_ERROR
gst_resource_error_get_type
GST_TYPE_RESOURCE_ERROR
gst_stream_error_get_type
GST_TYPE_STREAM_ERROR
gst_event_type_get_type
GST_TYPE_EVENT_TYPE
gst_event_flag_get_type
GST_TYPE_EVENT_FLAG
gst_seek_type_get_type
GST_TYPE_SEEK_TYPE
gst_seek_accuracy_get_type
GST_TYPE_SEEK_ACCURACY
gst_format_get_type
GST_TYPE_FORMAT
gst_index_certainty_get_type
GST_TYPE_INDEX_CERTAINTY
gst_index_entry_type_get_type
GST_TYPE_INDEX_ENTRY_TYPE
gst_index_lookup_method_get_type
GST_TYPE_INDEX_LOOKUP_METHOD
gst_assoc_flags_get_type
GST_TYPE_ASSOC_FLAGS
gst_index_resolver_method_get_type
GST_TYPE_INDEX_RESOLVER_METHOD
gst_index_flags_get_type
GST_TYPE_INDEX_FLAGS
gst_debug_level_get_type
GST_TYPE_DEBUG_LEVEL
gst_debug_color_flags_get_type
GST_TYPE_DEBUG_COLOR_FLAGS
gst_pad_link_return_get_type
GST_TYPE_PAD_LINK_RETURN
gst_pad_direction_get_type
GST_TYPE_PAD_DIRECTION
gst_pad_flags_get_type
GST_TYPE_PAD_FLAGS
gst_pad_presence_get_type
GST_TYPE_PAD_PRESENCE
gst_pad_template_flags_get_type
GST_TYPE_PAD_TEMPLATE_FLAGS
gst_plugin_error_get_type
GST_TYPE_PLUGIN_ERROR
gst_query_type_get_type
GST_TYPE_QUERY_TYPE
gst_scheduler_flags_get_type
GST_TYPE_SCHEDULER_FLAGS
gst_scheduler_state_get_type
GST_TYPE_SCHEDULER_STATE
gst_tag_merge_mode_get_type
GST_TYPE_TAG_MERGE_MODE
gst_tag_flag_get_type
GST_TYPE_TAG_FLAG
gst_thread_state_get_type
GST_TYPE_THREAD_STATE
gst_alloc_trace_flags_get_type
GST_TYPE_ALLOC_TRACE_FLAGS
gst_type_find_probability_get_type
GST_TYPE_TYPE_FIND_PROBABILITY
gst_element_state_get_type
GST_TYPE_ELEMENT_STATE
gst_element_state_return_get_type
GST_TYPE_ELEMENT_STATE_RETURN
gst_result_get_type
GST_TYPE_RESULT
gst_uri_type_get_type
GST_TYPE_URI_TYPE
gst_registry_return_get_type
GST_TYPE_REGISTRY_RETURN
gst_registry_flags_get_type
GST_TYPE_REGISTRY_FLAGS
gst_parse_error_get_type
GST_TYPE_PARSE_ERROR
</SECTION>
<SECTION>
<FILE>gstmarshal</FILE>
gst_marshal_VOID__VOID
gst_marshal_VOID__BOOLEAN
gst_marshal_VOID__INT
gst_marshal_VOID__STRING
gst_marshal_VOID__BOXED
gst_marshal_VOID__POINTER
gst_marshal_VOID__POINTER_OBJECT
gst_marshal_VOID__OBJECT
gst_marshal_VOID__OBJECT_PARAM
gst_marshal_VOID__OBJECT_POINTER
gst_marshal_VOID__OBJECT_BOXED
gst_marshal_VOID__OBJECT_OBJECT_STRING
gst_marshal_VOID__OBJECT_STRING
gst_marshal_VOID__INT_INT
gst_marshal_VOID__INT64
gst_marshal_VOID__UINT_BOXED
gst_marshal_VOID__UINT_POINTER
gst_marshal_BOOLEAN__VOID
gst_marshal_BOOLEAN__POINTER
gst_marshal_POINTER__POINTER
gst_marshal_BOXED__BOXED
</SECTION>
<SECTION>
<FILE>gstcpu</FILE>
GstCPUFlags
@ -1711,6 +1611,26 @@ gst_cpu_get_flags
<FILE>gstdata_private</FILE>
</SECTION>
<SECTION>
<FILE>gsterror</FILE>
GstCoreError
GstLibraryError
GstResourceError
GstStreamError
GST_TYPE_G_ERROR
GST_LIBRARY_ERROR
GST_RESOURCE_ERROR
GST_CORE_ERROR
GST_STREAM_ERROR
GST_ERROR_SYSTEM
gst_g_error_get_type
gst_error_get_message
gst_stream_error_quark
gst_core_error_quark
gst_resource_error_quark
gst_library_error_quark
</SECTION>
<SECTION>
<FILE>gstfilter</FILE>
GstFilterFunc
@ -2092,49 +2012,128 @@ gst_version
</SECTION>
<SECTION>
<FILE>gettext</FILE>
gettext
dgettext
dcgettext
ngettext
dngettext
dcngettext
textdomain
bindtextdomain
bind_textdomain_codeset
gettext_noop
<FILE>gstenumtypes</FILE>
gst_object_flags_get_type
GST_TYPE_OBJECT_FLAGS
gst_bin_flags_get_type
GST_TYPE_BIN_FLAGS
gst_buffer_flag_get_type
GST_TYPE_BUFFER_FLAG
gst_clock_entry_status_get_type
GST_TYPE_CLOCK_ENTRY_STATUS
gst_clock_entry_type_get_type
GST_TYPE_CLOCK_ENTRY_TYPE
gst_clock_return_get_type
GST_TYPE_CLOCK_RETURN
gst_clock_flags_get_type
GST_TYPE_CLOCK_FLAGS
gst_cpu_flags_get_type
GST_TYPE_CPU_FLAGS
gst_data_flags_get_type
GST_TYPE_DATA_FLAGS
gst_element_flags_get_type
GST_TYPE_ELEMENT_FLAGS
gst_core_error_get_type
GST_TYPE_CORE_ERROR
gst_library_error_get_type
GST_TYPE_LIBRARY_ERROR
gst_resource_error_get_type
GST_TYPE_RESOURCE_ERROR
gst_stream_error_get_type
GST_TYPE_STREAM_ERROR
gst_event_type_get_type
GST_TYPE_EVENT_TYPE
gst_event_flag_get_type
GST_TYPE_EVENT_FLAG
gst_seek_type_get_type
GST_TYPE_SEEK_TYPE
gst_seek_accuracy_get_type
GST_TYPE_SEEK_ACCURACY
gst_format_get_type
GST_TYPE_FORMAT
gst_index_certainty_get_type
GST_TYPE_INDEX_CERTAINTY
gst_index_entry_type_get_type
GST_TYPE_INDEX_ENTRY_TYPE
gst_index_lookup_method_get_type
GST_TYPE_INDEX_LOOKUP_METHOD
gst_assoc_flags_get_type
GST_TYPE_ASSOC_FLAGS
gst_index_resolver_method_get_type
GST_TYPE_INDEX_RESOLVER_METHOD
gst_index_flags_get_type
GST_TYPE_INDEX_FLAGS
gst_debug_level_get_type
GST_TYPE_DEBUG_LEVEL
gst_debug_color_flags_get_type
GST_TYPE_DEBUG_COLOR_FLAGS
gst_pad_link_return_get_type
GST_TYPE_PAD_LINK_RETURN
gst_pad_direction_get_type
GST_TYPE_PAD_DIRECTION
gst_pad_flags_get_type
GST_TYPE_PAD_FLAGS
gst_pad_presence_get_type
GST_TYPE_PAD_PRESENCE
gst_pad_template_flags_get_type
GST_TYPE_PAD_TEMPLATE_FLAGS
gst_plugin_error_get_type
GST_TYPE_PLUGIN_ERROR
gst_query_type_get_type
GST_TYPE_QUERY_TYPE
gst_scheduler_flags_get_type
GST_TYPE_SCHEDULER_FLAGS
gst_scheduler_state_get_type
GST_TYPE_SCHEDULER_STATE
gst_tag_merge_mode_get_type
GST_TYPE_TAG_MERGE_MODE
gst_tag_flag_get_type
GST_TYPE_TAG_FLAG
gst_thread_state_get_type
GST_TYPE_THREAD_STATE
gst_alloc_trace_flags_get_type
GST_TYPE_ALLOC_TRACE_FLAGS
gst_type_find_probability_get_type
GST_TYPE_TYPE_FIND_PROBABILITY
gst_element_state_get_type
GST_TYPE_ELEMENT_STATE
gst_element_state_return_get_type
GST_TYPE_ELEMENT_STATE_RETURN
gst_result_get_type
GST_TYPE_RESULT
gst_uri_type_get_type
GST_TYPE_URI_TYPE
gst_registry_return_get_type
GST_TYPE_REGISTRY_RETURN
gst_registry_flags_get_type
GST_TYPE_REGISTRY_FLAGS
gst_parse_error_get_type
GST_TYPE_PARSE_ERROR
</SECTION>
<SECTION>
<FILE>gsterror</FILE>
GstCoreError
GstLibraryError
GstResourceError
GstStreamError
GST_TYPE_G_ERROR
GST_LIBRARY_ERROR
GST_RESOURCE_ERROR
GST_CORE_ERROR
GST_STREAM_ERROR
GST_ERROR_SYSTEM
gst_g_error_get_type
gst_error_get_message
gst_stream_error_quark
gst_core_error_quark
gst_resource_error_quark
gst_library_error_quark
</SECTION>
<SECTION>
<FILE>gst-i18n-app</FILE>
_
N_
</SECTION>
<SECTION>
<FILE>gst-i18n-lib</FILE>
_
N_
<FILE>gstmarshal</FILE>
gst_marshal_VOID__VOID
gst_marshal_VOID__BOOLEAN
gst_marshal_VOID__INT
gst_marshal_VOID__STRING
gst_marshal_VOID__BOXED
gst_marshal_VOID__POINTER
gst_marshal_VOID__POINTER_OBJECT
gst_marshal_VOID__OBJECT
gst_marshal_VOID__OBJECT_PARAM
gst_marshal_VOID__OBJECT_POINTER
gst_marshal_VOID__OBJECT_BOXED
gst_marshal_VOID__OBJECT_OBJECT_STRING
gst_marshal_VOID__OBJECT_STRING
gst_marshal_VOID__INT_INT
gst_marshal_VOID__INT64
gst_marshal_VOID__UINT_BOXED
gst_marshal_VOID__UINT_POINTER
gst_marshal_BOOLEAN__VOID
gst_marshal_BOOLEAN__POINTER
gst_marshal_POINTER__POINTER
gst_marshal_BOXED__BOXED
</SECTION>
<SECTION>

View file

@ -1,151 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstAutoplug
<!-- ##### SECTION Short_Description ##### -->
Automatically create and link elements
<!-- ##### SECTION Long_Description ##### -->
<para>
GstAutoplug is an abstract class that is used for constructing and
linking elements. Two types of autopluggers exist: renderer ones and non
renderer ones. The renderer autopluggers will not have any src pads while the
non renderer ones do.
</para>
<para>
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).
</para>
<para>
If the autoplugger supports the RENDERER API, use gst_autoplug_to_renderers() to
create a bin that links the src caps to the specified renderer elements. You can
then add the bin to a pipeline and run it.
<programlisting>
GstAutoplug *autoplug;
GstElement *element;
GstElement *sink;
/* create a static autoplugger */
autoplug = gst_autoplug_factory_make ("staticrender");
/* create an osssink */
sink = gst_element_factory_make ("osssink", "our_sink");
/* create an element that can play audio/mp3 through osssink */
element = gst_autoplug_to_renderers (autoplug,
gst_caps_new (
"sink_audio_caps",
"audio/mp3",
NULL
),
sink,
NULL);
/* add the element to a bin and link the sink pad */
...
</programlisting>
</para>
<para>
If the autoplugger supports the CAPS API, use gst_autoplug_to_caps() to
link the src caps to the destination caps. The created bin will have src caps
compatible with the provided sink caps.
<programlisting>
GstAutoplug *autoplug;
GstElement *element;
/* create a static autoplugger */
autoplug = gst_autoplug_factory_make ("static");
/* create an element that converts audio/mp3 to audio/raw */
element = gst_autoplug_to_caps (autoplug,
gst_caps_new (
"sink_audio_caps",
"audio/mp3",
NULL
),
gst_caps_new (
"src_audio_caps",
"audio/raw",
NULL
),
NULL);
/* add the element to a bin and link the src/sink pads */
...
</programlisting>
</para>
<para>
Optionally you can get a notification when a new object is added to the created
pipeline with a g_signal_connect to the "new_object" signal.
</para>
<para>
Use the regular gst_object_destroy() call to destroy the autoplugger.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GstStaticAutoplug, #GstStaticAutoplugRender
</para>
<!-- ##### STRUCT GstAutoplug ##### -->
<para>
The autoplug object
</para>
<!-- ##### SIGNAL GstAutoplug::new-object ##### -->
<para>
</para>
@gstautoplug: the object which received the signal.
@arg1:
<!-- ##### ENUM GstAutoplugFlags ##### -->
<para>
The type of the autoplugger.
</para>
@GST_AUTOPLUG_TO_CAPS:
@GST_AUTOPLUG_TO_RENDERER:
@GST_AUTOPLUG_FLAG_LAST:
<!-- ##### FUNCTION gst_autoplug_signal_new_object ##### -->
<para>
</para>
@autoplug:
@object:
<!-- ##### FUNCTION gst_autoplug_to_caps ##### -->
<para>
</para>
@autoplug:
@srccaps:
@sinkcaps:
@Varargs:
@Returns:
<!-- ##### FUNCTION gst_autoplug_to_renderers ##### -->
<para>
</para>
@autoplug:
@srccaps:
@target:
@Varargs:
@Returns:

View file

@ -1,17 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstStaticAutoplug
<!-- ##### SECTION Short_Description ##### -->
A static autoplugger.
<!-- ##### SECTION Long_Description ##### -->
<para>
This autoplugger will create a non threaded element before running the
pipeline.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>

View file

@ -1,17 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstStaticAutoplugRender
<!-- ##### SECTION Short_Description ##### -->
An autoplugger made for media playback
<!-- ##### SECTION Long_Description ##### -->
<para>
this autoplugger will create a threaded element that can be used
in media players.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>

View file

@ -80,6 +80,14 @@ Some convenience functions
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@additional_initializations:

View file

@ -115,10 +115,6 @@ GstXML
</para>
@:
@:
@:
@gstxml: the object which received the signal.
@arg1:
@arg2:
@ -128,7 +124,7 @@ GstXML
</para>
@gstxml: the object which received the signal.
@arg1:
@arg2:
@:
@:
@: