mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-09-27 14:31:01 +00:00
Code Issues 1 Projects Releases Wiki Activity

put symbols in the sections.txt into the right sections (so that we dont get wrong undocumented symbols) added TITLE ...

Browse source 
Original commit message from CVS:
put symbols in the sections.txt into the right sections (so that we dont get wrong undocumented symbols)
added TITLE tags where they were missing
fixed section names so that gtk-doc introspection works
fixed typos in api docs and docbook docs
added some thoughts about new interfaces (to personal notes)
This commit is contained in:
Stefan Kost 2004-07-21 11:32:09 +00:00
parent e5a3b3f338
commit 21e56edfbc
35 changed files with 715 additions and 1638 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
docs/README
View file

@ -87,6 +87,14 @@ HOW THE BUILD SYSTEM IS SET UP
* ps and pdf are built in the current dir, in one file * ps and pdf are built in the current dir, in one file
DOCBOOK NOTES
=============
* spell checking with aspell
* aspell -b -c --mode=sgml --lang=en <file>.xml
unfortunately the curses-ui of aspell (0.50.5) has problems with the xml tags
GTK-DOC NOTES GTK-DOC NOTES
============= =============
@ -108,10 +116,21 @@ GTK-DOC NOTES
- add both an entity and use the entity in gstreamer-docs.sgml - add both an entity and use the entity in gstreamer-docs.sgml
- add a new section to gstreamer-sections.txt - add a new section to gstreamer-sections.txt
- add all documented symbols to gstreamer-sections.txt in the proper section - add all documented symbols to gstreamer-sections.txt in the proper section
(default),<SUBSECTION Standard>,<SUBSECTION Private>
- document at least the Short_Description in tmpl/.sgml
- signals: document them properly in tmpl/.sgml (or better in the c-source)
- signals: document them properly in tmpl/.sgml
* checklist: * checklist:
- make sure -sections.txt has a <TITLE> set for each <FILE> - make sure -sections.txt has a <TITLE> set for each <FILE>
- the title should be named like the type, when it gets registered
(otherwise gtkdoc introspection fails)
- for clarity name the file like the title, but all lowercase
* what to do when trying to improve the docs
- compare the output of
grep "_get_type" gstreamer-sections.txt | sort
with the types in XXX.types to detect entries that
are maybe missing
* what happens during a gtk-doc build ? * what happens during a gtk-doc build ?
- headers are scanned based on $(MODULE).types - headers are scanned based on $(MODULE).types
@ -120,12 +139,9 @@ GTK-DOC NOTES
where the module name is $(MODULE) where the module name is $(MODULE)
$(MODULE)-sections.txt is created if it doesn't exist yet (it should), $(MODULE)-sections.txt is created if it doesn't exist yet (it should),
as well as $(MODULE)-decl.txt and $(MODULE)-decl-list.txt as well as $(MODULE)-decl.txt and $(MODULE)-decl-list.txt
and .args, .hierarchy and .signals files are created and .args, .hierarchy and .signals files are created
gtkdoc-scan is called gtkdoc-scan is called
(FIXME: why is there gstreamer.types.in and gst-plugins.types.in ?)
* Possible errors and how to fix them * Possible errors and how to fix them
- Warning: multiple "IDs" for constraint linkend: gst-tag-register. - Warning: multiple "IDs" for constraint linkend: gst-tag-register.
- check if gst_tag_register is listed more than once in -sections.txt - check if gst_tag_register is listed more than once in -sections.txt
@ -156,3 +172,4 @@ RANDOM THINGS I'VE LEARNED
xsltproc has a --path option (that xmlto doesn't use yet), but it xsltproc has a --path option (that xmlto doesn't use yet), but it
resolves single files to $(specified_path)/$(srcdir)/$(file) resolves single files to $(specified_path)/$(srcdir)/$(file)
For now, we need to hack around it by copying xml to the build dir. For now, we need to hack around it by copying xml to the build dir.

20
docs/gst/gstreamer-docs.sgml
View file

@ -17,8 +17,8 @@
<!ENTITY GstEvent SYSTEM "xml/gstevent.xml"> <!ENTITY GstEvent SYSTEM "xml/gstevent.xml">
<!ENTITY GstFormat SYSTEM "xml/gstformat.xml"> <!ENTITY GstFormat SYSTEM "xml/gstformat.xml">
<!ENTITY GstIndex SYSTEM "xml/gstindex.xml"> <!ENTITY GstIndex SYSTEM "xml/gstindex.xml">
<!ENTITY GstImplementsInterface SYSTEM "xml/gstimplementsinterface.xml">
<!ENTITY GstInfo SYSTEM "xml/gstinfo.xml"> <!ENTITY GstInfo SYSTEM "xml/gstinfo.xml">
<!ENTITY GstInterface SYSTEM "xml/gstinterface.xml">
<!ENTITY GstLog SYSTEM "xml/gstlog.xml"> <!ENTITY GstLog SYSTEM "xml/gstlog.xml">
<!ENTITY GstMemChunk SYSTEM "xml/gstmemchunk.xml"> <!ENTITY GstMemChunk SYSTEM "xml/gstmemchunk.xml">
<!ENTITY GstObject SYSTEM "xml/gstobject.xml"> <!ENTITY GstObject SYSTEM "xml/gstobject.xml">
@ -35,7 +35,7 @@
<!ENTITY GstStructure SYSTEM "xml/gststructure.xml"> <!ENTITY GstStructure SYSTEM "xml/gststructure.xml">
<!ENTITY GstSystemClock SYSTEM "xml/gstsystemclock.xml"> <!ENTITY GstSystemClock SYSTEM "xml/gstsystemclock.xml">
<!ENTITY GstTag SYSTEM "xml/gsttag.xml"> <!ENTITY GstTag SYSTEM "xml/gsttag.xml">
<!ENTITY GstTagInterface SYSTEM "xml/gsttaginterface.xml"> <!ENTITY GstTagSetter SYSTEM "xml/gsttagsetter.xml">
<!ENTITY GstThread SYSTEM "xml/gstthread.xml"> <!ENTITY GstThread SYSTEM "xml/gstthread.xml">
<!ENTITY GstTrace SYSTEM "xml/gsttrace.xml"> <!ENTITY GstTrace SYSTEM "xml/gsttrace.xml">
<!ENTITY GstTypeFind SYSTEM "xml/gsttypefind.xml"> <!ENTITY GstTypeFind SYSTEM "xml/gsttypefind.xml">
@ -70,10 +70,12 @@
<chapter id="gstreamer"> <chapter id="gstreamer">
<title>GStreamer Core Library</title> <title>GStreamer Core Library</title>
<para>libgstreamer-0.8.so provides all the core GStreamer services, <para>
including initialization, plugin management and types, as libgstreamer-&GST_MAJORMINOR;.so provides all the core GStreamer services,
well as the object hierarchy that defines elements and bins, along including initialization, plugin management and types,
with some more specialized elements.</para> as well as the object hierarchy that defines elements and bins,
along with some more specialized elements.
</para>
&Gst; &Gst;
&GstBin; &GstBin;
@ -89,7 +91,7 @@ with some more specialized elements.</para>
&GstFormat; &GstFormat;
&GstIndex; &GstIndex;
&GstInfo; &GstInfo;
&GstInterface; &GstImplementsInterface;
&GstObject; &GstObject;
&GstPad; &GstPad;
&GstParse; &GstParse;
@ -105,7 +107,7 @@ with some more specialized elements.</para>
&GstStructure; &GstStructure;
&GstSystemClock; &GstSystemClock;
&GstTag; &GstTag;
&GstTagInterface; &GstTagSetter;
&GstThread; &GstThread;
&GstTypeFind; &GstTypeFind;
&GstUri; &GstUri;
@ -118,6 +120,7 @@ with some more specialized elements.</para>
<chapter id="gstreamer-support"> <chapter id="gstreamer-support">
<title>GStreamer Core Support</title> <title>GStreamer Core Support</title>
<para> <para>
Theses elements support the gstreamer core and applications using it.
</para> </para>
&GstAtomic; &GstAtomic;
@ -126,6 +129,7 @@ with some more specialized elements.</para>
</chapter> </chapter>
<!-- <!--
FIXME: why is this commented out
<chapter id="element-types"> <chapter id="element-types">
<title>GStreamer Standard Elements</title> <title>GStreamer Standard Elements</title>

435
docs/gst/gstreamer-sections.txt
View file

@ -1,7 +1,8 @@
<SECTION> <SECTION>
<FILE>gstbin</FILE> <FILE>gstbin</FILE>
GstBinFlags
<TITLE>GstBin</TITLE> <TITLE>GstBin</TITLE>
GstBin
GstBinFlags
gst_bin_new gst_bin_new
gst_bin_add gst_bin_add
gst_bin_add_many gst_bin_add_many
@ -19,17 +20,20 @@ gst_bin_auto_clock
gst_bin_sync_children_state gst_bin_sync_children_state
gst_bin_child_state_change gst_bin_child_state_change
<SUBSECTION Standard> <SUBSECTION Standard>
GstBinClass
GST_BIN GST_BIN
GST_IS_BIN GST_IS_BIN
GST_TYPE_BIN GST_TYPE_BIN
gst_bin_get_type
GST_BIN_CLASS GST_BIN_CLASS
GST_IS_BIN_CLASS GST_IS_BIN_CLASS
GST_BIN_GET_CLASS GST_BIN_GET_CLASS
<SUBSECTION Private>
gst_bin_get_type
</SECTION> </SECTION>
<SECTION> <SECTION>
<FILE>gstbuffer</FILE> <FILE>gstbuffer</FILE>
<TITLE>GstBuffer</TITLE>
GstBuffer GstBuffer
GstBufferFreeDataFunc GstBufferFreeDataFunc
GST_BUFFER_TRACE_NAME GST_BUFFER_TRACE_NAME
@ -79,11 +83,13 @@ gst_buffer_default_copy
GST_BUFFER GST_BUFFER
GST_IS_BUFFER GST_IS_BUFFER
GST_TYPE_BUFFER GST_TYPE_BUFFER
<SUBSECTION Private>
gst_buffer_get_type gst_buffer_get_type
</SECTION> </SECTION>
<SECTION> <SECTION>
<FILE>gstcaps</FILE> <FILE>gstcaps</FILE>
<TITLE>GstCaps</TITLE>
GST_CAPS_FLAGS_ANY GST_CAPS_FLAGS_ANY
GST_CAPS_ANY GST_CAPS_ANY
GST_CAPS_NONE GST_CAPS_NONE
@ -136,11 +142,13 @@ gst_caps_subtract
GST_CAPS GST_CAPS
GST_IS_CAPS GST_IS_CAPS
GST_TYPE_CAPS GST_TYPE_CAPS
<SUBSECTION Private>
gst_caps_get_type gst_caps_get_type
</SECTION> </SECTION>
<SECTION> <SECTION>
<FILE>gstclock</FILE> <FILE>gstclock</FILE>
<TITLE>GstClock</TITLE>
GstClock GstClock
GstClockTime GstClockTime
GstClockTimeDiff GstClockTimeDiff
@ -168,7 +176,6 @@ GST_CLOCK_ENTRY_STATUS
GstClockReturn GstClockReturn
GstClockFlags GstClockFlags
GST_CLOCK_FLAGS GST_CLOCK_FLAGS
<TITLE>GstClock</TITLE>
gst_clock_set_speed gst_clock_set_speed
gst_clock_get_speed gst_clock_get_speed
gst_clock_set_resolution gst_clock_set_resolution
@ -194,10 +201,11 @@ GstClockClass
GST_CLOCK GST_CLOCK
GST_IS_CLOCK GST_IS_CLOCK
GST_TYPE_CLOCK GST_TYPE_CLOCK
gst_clock_get_type
GST_CLOCK_CLASS GST_CLOCK_CLASS
GST_IS_CLOCK_CLASS GST_IS_CLOCK_CLASS
GST_CLOCK_GET_CLASS GST_CLOCK_GET_CLASS
<SUBSECTION Private>
gst_clock_get_type
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -227,6 +235,7 @@ GST_PAD_IS_CONNECTED
<SECTION> <SECTION>
<FILE>gstdata</FILE> <FILE>gstdata</FILE>
<TITLE>GstData</TITLE>
GST_DATA GST_DATA
GST_DATA_TYPE GST_DATA_TYPE
GST_DATA_FLAGS GST_DATA_FLAGS
@ -253,13 +262,14 @@ gst_data_unref
<SUBSECTION Standard> <SUBSECTION Standard>
GST_DATA_FLAG_SET GST_DATA_FLAG_SET
GST_DATA_FLAG_IS_SET GST_DATA_FLAG_IS_SET
<SUBSECTION Private>
gst_data_get_type gst_data_get_type
</SECTION> </SECTION>
<SECTION> <SECTION>
<FILE>gstelement</FILE> <FILE>gstelement</FILE>
GstElement GstElement
GstElementClass GST_TYPE_ELEMENT
GstElementDetails GstElementDetails
GST_ELEMENT_DETAILS GST_ELEMENT_DETAILS
GST_IS_ELEMENT_DETAILS GST_IS_ELEMENT_DETAILS
@ -273,7 +283,6 @@ GST_STATE_PAUSED_TO_PLAYING
GST_STATE_PLAYING_TO_PAUSED GST_STATE_PLAYING_TO_PAUSED
GST_STATE_PAUSED_TO_READY GST_STATE_PAUSED_TO_READY
GST_STATE_READY_TO_NULL GST_STATE_READY_TO_NULL
GST_ELEMENT_CLASS
GST_ELEMENT_QUERY_TYPE_FUNCTION GST_ELEMENT_QUERY_TYPE_FUNCTION
GST_ELEMENT_FORMATS_FUNCTION GST_ELEMENT_FORMATS_FUNCTION
GST_ELEMENT_EVENT_MASK_FUNCTION GST_ELEMENT_EVENT_MASK_FUNCTION
@ -374,7 +383,6 @@ gst_element_get_factory
gst_element_get_managing_bin gst_element_get_managing_bin
gst_element_no_more_pads gst_element_no_more_pads
<TITLE>GstElementFactory</TITLE> <TITLE>GstElementFactory</TITLE>
gst_element_factory_get_type
gst_element_register gst_element_register
gst_element_factory_find gst_element_factory_find
gst_element_factory_get_element_type gst_element_factory_get_element_type
@ -391,23 +399,29 @@ gst_element_factory_make
gst_element_factory_can_src_caps gst_element_factory_can_src_caps
gst_element_factory_can_sink_caps gst_element_factory_can_sink_caps
GstElementFactory GstElementFactory
GstElementFactoryClass
GST_TYPE_ELEMENT_FACTORY GST_TYPE_ELEMENT_FACTORY
GST_ELEMENT_FACTORY
GST_ELEMENT_FACTORY_CLASS
GST_IS_ELEMENT_FACTORY
GST_IS_ELEMENT_FACTORY_CLASS
<SUBSECTION Standard> <SUBSECTION Standard>
GstElementClass
GST_ELEMENT GST_ELEMENT
GST_IS_ELEMENT GST_IS_ELEMENT
GST_TYPE_ELEMENT GST_ELEMENT_CLASS
gst_element_get_type
GST_IS_ELEMENT_CLASS GST_IS_ELEMENT_CLASS
GST_ELEMENT_GET_CLASS GST_ELEMENT_GET_CLASS
GstElementFactoryClass
GST_ELEMENT_FACTORY
GST_IS_ELEMENT_FACTORY
GST_ELEMENT_FACTORY_CLASS
GST_IS_ELEMENT_FACTORY_CLASS
<SUBSECTION Private>
gst_element_get_type
gst_element_factory_get_type
</SECTION> </SECTION>
<SECTION> <SECTION>
<FILE>gstevent</FILE> <FILE>gstevent</FILE>
<TITLE>GstEvent</TITLE>
GST_TYPE_EVENT
GstEvent
GstEventType GstEventType
GST_EVENT_ANY GST_EVENT_ANY
GST_EVENT_TRACE_NAME GST_EVENT_TRACE_NAME
@ -438,7 +452,6 @@ GST_EVENT_DISCONT_OFFSET_LEN
GST_EVENT_SIZE_FORMAT GST_EVENT_SIZE_FORMAT
GST_EVENT_SIZE_VALUE GST_EVENT_SIZE_VALUE
GST_EVENT_RATE_VALUE GST_EVENT_RATE_VALUE
GstEvent
gst_event_new gst_event_new
gst_event_ref gst_event_ref
gst_event_ref_by_count gst_event_ref_by_count
@ -456,7 +469,7 @@ gst_event_new_flush
<SUBSECTION Standard> <SUBSECTION Standard>
GST_EVENT GST_EVENT
GST_IS_EVENT GST_IS_EVENT
GST_TYPE_EVENT <SUBSECTION Private>
gst_event_get_type gst_event_get_type
</SECTION> </SECTION>
@ -507,15 +520,8 @@ gst_index_entry_copy
gst_index_entry_free gst_index_entry_free
gst_index_entry_assoc_map gst_index_entry_assoc_map
GST_TYPE_INDEX_FACTORY GST_TYPE_INDEX_FACTORY
GST_INDEX_FACTORY
GST_IS_INDEX_FACTORY
GST_INDEX_FACTORY_CLASS
GST_IS_INDEX_FACTORY_CLASS
GST_INDEX_FACTORY_GET_CLASS
<TITLE>GstIndexFactory</TITLE> <TITLE>GstIndexFactory</TITLE>
GstIndexFactory GstIndexFactory
GstIndexFactoryClass
gst_index_factory_get_type
gst_index_factory_new gst_index_factory_new
gst_index_factory_destroy gst_index_factory_destroy
gst_index_factory_find gst_index_factory_find
@ -526,14 +532,24 @@ GstIndexClass
GST_INDEX GST_INDEX
GST_IS_INDEX GST_IS_INDEX
GST_TYPE_INDEX GST_TYPE_INDEX
gst_index_get_type
GST_INDEX_CLASS GST_INDEX_CLASS
GST_IS_INDEX_CLASS GST_IS_INDEX_CLASS
GST_INDEX_GET_CLASS GST_INDEX_GET_CLASS
GstIndexFactoryClass
GST_INDEX_FACTORY
GST_IS_INDEX_FACTORY
GST_INDEX_FACTORY_CLASS
GST_IS_INDEX_FACTORY_CLASS
GST_INDEX_FACTORY_GET_CLASS
<SUBSECTION Private>
gst_index_get_type
gst_index_factory_get_type
</SECTION> </SECTION>
<SECTION> <SECTION>
<FILE>gstinterface</FILE> <FILE>gstimplementsinterface</FILE>
<TITLE>GstImplementsInterface</TITLE>
GST_TYPE_IMPLEMENTS_INTERFACE
GstImplementsInterface GstImplementsInterface
GST_IMPLEMENTS_INTERFACE_CHECK_INSTANCE_CAST GST_IMPLEMENTS_INTERFACE_CHECK_INSTANCE_CAST
GST_IMPLEMENTS_INTERFACE_CHECK_INSTANCE_TYPE GST_IMPLEMENTS_INTERFACE_CHECK_INSTANCE_TYPE
@ -541,21 +557,22 @@ gst_element_implements_interface
gst_implements_interface_cast gst_implements_interface_cast
gst_implements_interface_check gst_implements_interface_check
<SUBSECTION Standard> <SUBSECTION Standard>
GstImplementsInterfaceClass
GST_IMPLEMENTS_INTERFACE GST_IMPLEMENTS_INTERFACE
GST_IS_IMPLEMENTS_INTERFACE
GST_TYPE_IMPLEMENTS_INTERFACE
gst_implements_interface_get_type
GST_IMPLEMENTS_INTERFACE_CLASS GST_IMPLEMENTS_INTERFACE_CLASS
GST_IS_IMPLEMENTS_INTERFACE
GST_IS_IMPLEMENTS_INTERFACE_CLASS GST_IS_IMPLEMENTS_INTERFACE_CLASS
GST_IMPLEMENTS_INTERFACE_GET_CLASS GST_IMPLEMENTS_INTERFACE_GET_CLASS
<SUBSECTION Private>
gst_implements_interface_get_type
</SECTION> </SECTION>
<SECTION> <SECTION>
<FILE>gstobject</FILE> <FILE>gstobject</FILE>
GST_OBJECT_CLASS
xmlNodePtr
GstObjectFlags
<TITLE>GstObject</TITLE> <TITLE>GstObject</TITLE>
GstObject
GST_TYPE_OBJECT
GstObjectFlags
GST_FLAGS GST_FLAGS
GST_FLAG_IS_SET GST_FLAG_IS_SET
GST_FLAG_SET GST_FLAG_SET
@ -585,36 +602,28 @@ gst_object_get_path_string
gst_class_signal_connect gst_class_signal_connect
gst_class_signal_emit_by_name gst_class_signal_emit_by_name
<SUBSECTION Standard> <SUBSECTION Standard>
GstObjectClass
GST_OBJECT GST_OBJECT
GST_IS_OBJECT GST_IS_OBJECT
GST_TYPE_OBJECT GST_OBJECT_CLASS
gst_object_get_type
GST_IS_OBJECT_CLASS GST_IS_OBJECT_CLASS
GST_OBJECT_GET_CLASS GST_OBJECT_GET_CLASS
<SUBSECTION Private>
gst_object_get_type
</SECTION> </SECTION>
<SECTION> <SECTION>
<FILE>gstpad</FILE> <FILE>gstpad</FILE>
GstPad GstPad
GstPadClass
GstRealPad GstRealPad
GstGhostPad GstGhostPad
GstRealPadClass GstPadTemplate
GstGhostPadClass GST_TYPE_PAD
GST_IS_PAD_FAST
GST_PAD_CLASS
GST_TYPE_REAL_PAD GST_TYPE_REAL_PAD
GST_IS_REAL_PAD
GST_IS_REAL_PAD_FAST GST_IS_REAL_PAD_FAST
GST_IS_REAL_PAD_CLASS
GST_REAL_PAD
GST_REAL_PAD_CLASS
GST_TYPE_GHOST_PAD GST_TYPE_GHOST_PAD
GST_IS_GHOST_PAD
GST_IS_GHOST_PAD_FAST GST_IS_GHOST_PAD_FAST
GST_IS_GHOST_PAD_CLASS GST_IS_PAD_FAST
GST_GHOST_PAD
GST_GHOST_PAD_CLASS
GstStaticPadTemplate GstStaticPadTemplate
GstPadLink GstPadLink
GstPadLinkReturn GstPadLinkReturn
@ -684,10 +693,6 @@ GST_PAD_CAN_PULL
GST_PAD_IS_SRC GST_PAD_IS_SRC
GST_PAD_IS_SINK GST_PAD_IS_SINK
GST_TYPE_PAD_TEMPLATE GST_TYPE_PAD_TEMPLATE
GST_PAD_TEMPLATE
GST_PAD_TEMPLATE_CLASS
GST_IS_PAD_TEMPLATE
GST_IS_PAD_TEMPLATE_CLASS
GstPadPresence GstPadPresence
GST_PAD_TEMPLATE_NAME_TEMPLATE GST_PAD_TEMPLATE_NAME_TEMPLATE
GST_PAD_TEMPLATE_DIRECTION GST_PAD_TEMPLATE_DIRECTION
@ -697,8 +702,6 @@ GstPadTemplateFlags
GST_PAD_TEMPLATE_IS_FIXED GST_PAD_TEMPLATE_IS_FIXED
<TITLE>GstPadTemplate</TITLE> <TITLE>GstPadTemplate</TITLE>
GST_STATIC_PAD_TEMPLATE GST_STATIC_PAD_TEMPLATE
gst_real_pad_get_type
gst_ghost_pad_get_type
gst_pad_new gst_pad_new
gst_pad_new_from_template gst_pad_new_from_template
gst_pad_custom_new gst_pad_custom_new
@ -788,18 +791,37 @@ gst_pad_add_probe
gst_pad_remove_probe gst_pad_remove_probe
gst_pad_load_and_link gst_pad_load_and_link
gst_ghost_pad_new gst_ghost_pad_new
gst_pad_template_get_type
gst_pad_template_new gst_pad_template_new
gst_static_pad_template_get gst_static_pad_template_get
gst_pad_template_get_caps gst_pad_template_get_caps
gst_pad_template_get_caps_by_name gst_pad_template_get_caps_by_name
gst_ghost_pad_save_thyself gst_ghost_pad_save_thyself
<SUBSECTION Standard> <SUBSECTION Standard>
GstPadClass
GST_PAD GST_PAD
GST_IS_PAD GST_IS_PAD
GST_TYPE_PAD GST_PAD_CLASS
gst_pad_get_type
GST_IS_PAD_CLASS GST_IS_PAD_CLASS
GstGhostPadClass
GST_GHOST_PAD
GST_IS_GHOST_PAD
GST_GHOST_PAD_CLASS
GST_IS_GHOST_PAD_CLASS
GstRealPadClass
GST_REAL_PAD
GST_IS_REAL_PAD
GST_REAL_PAD_CLASS
GST_IS_REAL_PAD_CLASS
GstPadTemplateClass
GST_PAD_TEMPLATE
GST_IS_PAD_TEMPLATE
GST_PAD_TEMPLATE_CLASS
GST_IS_PAD_TEMPLATE_CLASS
<SUBSECTION Private>
gst_pad_get_type
gst_real_pad_get_type
gst_ghost_pad_get_type
gst_pad_template_get_type
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -812,10 +834,11 @@ GstPipelineClass
GST_PIPELINE GST_PIPELINE
GST_IS_PIPELINE GST_IS_PIPELINE
GST_TYPE_PIPELINE GST_TYPE_PIPELINE
gst_pipeline_get_type
GST_PIPELINE_CLASS GST_PIPELINE_CLASS
GST_IS_PIPELINE_CLASS GST_IS_PIPELINE_CLASS
GST_PIPELINE_GET_CLASS GST_PIPELINE_GET_CLASS
<SUBSECTION Private>
gst_pipeline_get_type
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -837,25 +860,27 @@ GstPluginFeatureClass
GST_PLUGIN_FEATURE GST_PLUGIN_FEATURE
GST_IS_PLUGIN_FEATURE GST_IS_PLUGIN_FEATURE
GST_TYPE_PLUGIN_FEATURE GST_TYPE_PLUGIN_FEATURE
gst_plugin_feature_get_type
GST_PLUGIN_FEATURE_CLASS GST_PLUGIN_FEATURE_CLASS
GST_IS_PLUGIN_FEATURE_CLASS GST_IS_PLUGIN_FEATURE_CLASS
GST_PLUGIN_FEATURE_GET_CLASS GST_PLUGIN_FEATURE_GET_CLASS
<SUBSECTION Private>
gst_plugin_feature_get_type
</SECTION> </SECTION>
<SECTION> <SECTION>
<FILE>gstqueue</FILE> <FILE>gstqueue</FILE>
<TITLE>GstQueue</TITLE> <TITLE>GstQueue</TITLE>
GstQueue GstQueue
GstQueueClass
GstQueueSize GstQueueSize
<SUBSECTION Standard> <SUBSECTION Standard>
GstQueueClass
GST_QUEUE GST_QUEUE
GST_IS_QUEUE GST_IS_QUEUE
GST_TYPE_QUEUE GST_TYPE_QUEUE
gst_queue_get_type
GST_QUEUE_CLASS GST_QUEUE_CLASS
GST_IS_QUEUE_CLASS GST_IS_QUEUE_CLASS
<SUBSECTION Private>
gst_queue_get_type
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -895,16 +920,16 @@ GstRegistryClass
GST_REGISTRY GST_REGISTRY
GST_IS_REGISTRY GST_IS_REGISTRY
GST_TYPE_REGISTRY GST_TYPE_REGISTRY
gst_registry_get_type
GST_REGISTRY_CLASS GST_REGISTRY_CLASS
GST_IS_REGISTRY_CLASS GST_IS_REGISTRY_CLASS
GST_REGISTRY_GET_CLASS GST_REGISTRY_GET_CLASS
<SUBSECTION Private>
gst_registry_get_type
</SECTION> </SECTION>
<SECTION> <SECTION>
<FILE>gstscheduler</FILE> <FILE>gstscheduler</FILE>
GstScheduler GstScheduler
GstSchedulerClass
GstSchedulerFlags GstSchedulerFlags
GST_SCHEDULER_PARENT GST_SCHEDULER_PARENT
GST_SCHEDULER_STATE GST_SCHEDULER_STATE
@ -934,16 +959,9 @@ gst_scheduler_get_clock
gst_scheduler_auto_clock gst_scheduler_auto_clock
gst_scheduler_show gst_scheduler_show
GST_TYPE_SCHEDULER_FACTORY GST_TYPE_SCHEDULER_FACTORY
GST_SCHEDULER_FACTORY
GST_IS_SCHEDULER_FACTORY
GST_SCHEDULER_FACTORY_CLASS
GST_IS_SCHEDULER_FACTORY_CLASS
GST_SCHEDULER_FACTORY_GET_CLASS
GST_SCHEDULER_DEFAULT_NAME GST_SCHEDULER_DEFAULT_NAME
<TITLE>GstSchedulerFactory</TITLE> <TITLE>GstSchedulerFactory</TITLE>
GstSchedulerFactory GstSchedulerFactory
GstSchedulerFactoryClass
gst_scheduler_factory_get_type
gst_scheduler_factory_new gst_scheduler_factory_new
gst_scheduler_factory_destroy gst_scheduler_factory_destroy
gst_scheduler_factory_find gst_scheduler_factory_find
@ -952,13 +970,22 @@ gst_scheduler_factory_make
gst_scheduler_factory_set_default_name gst_scheduler_factory_set_default_name
gst_scheduler_factory_get_default_name gst_scheduler_factory_get_default_name
<SUBSECTION Standard> <SUBSECTION Standard>
GstSchedulerClass
GST_SCHEDULER GST_SCHEDULER
GST_IS_SCHEDULER GST_IS_SCHEDULER
GST_TYPE_SCHEDULER GST_TYPE_SCHEDULER
gst_scheduler_get_type
GST_SCHEDULER_CLASS GST_SCHEDULER_CLASS
GST_IS_SCHEDULER_CLASS GST_IS_SCHEDULER_CLASS
GST_SCHEDULER_GET_CLASS GST_SCHEDULER_GET_CLASS
GstSchedulerFactoryClass
GST_SCHEDULER_FACTORY
GST_IS_SCHEDULER_FACTORY
GST_SCHEDULER_FACTORY_CLASS
GST_IS_SCHEDULER_FACTORY_CLASS
GST_SCHEDULER_FACTORY_GET_CLASS
<SUBSECTION Private>
gst_scheduler_get_type
gst_scheduler_factory_get_type
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -1000,6 +1027,7 @@ gst_structure_from_string
GST_STRUCTURE GST_STRUCTURE
GST_IS_STRUCTURE GST_IS_STRUCTURE
GST_TYPE_STRUCTURE GST_TYPE_STRUCTURE
<SUBSECTION Private>
gst_structure_get_type gst_structure_get_type
</SECTION> </SECTION>
@ -1118,11 +1146,13 @@ GST_TAG_ALBUM_PEAK
<SUBSECTION Standard> <SUBSECTION Standard>
GST_TAG_FLAG_IS_VALID GST_TAG_FLAG_IS_VALID
GST_TAG_MODE_IS_VALID GST_TAG_MODE_IS_VALID
<SUBSECTION Private>
gst_tag_list_get_type gst_tag_list_get_type
</SECTION> </SECTION>
<SECTION> <SECTION>
<FILE>gsttaginterface</FILE> <FILE>gsttagsetter</FILE>
<TITLE>GstTagSetter</TITLE>
GstTagSetter GstTagSetter
GstTagSetterIFace GstTagSetterIFace
gst_tag_setter_merge gst_tag_setter_merge
@ -1137,9 +1167,10 @@ gst_tag_setter_get_merge_mode
GST_TAG_SETTER GST_TAG_SETTER
GST_IS_TAG_SETTER GST_IS_TAG_SETTER
GST_TYPE_TAG_SETTER GST_TYPE_TAG_SETTER
gst_tag_setter_get_type
GST_TAG_SETTER_CLASS GST_TAG_SETTER_CLASS
GST_TAG_SETTER_GET_IFACE GST_TAG_SETTER_GET_IFACE
<SUBSECTION Private>
gst_tag_setter_get_type
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -1156,14 +1187,16 @@ GstThreadClass
GST_THREAD GST_THREAD
GST_IS_THREAD GST_IS_THREAD
GST_TYPE_THREAD GST_TYPE_THREAD
gst_thread_get_type
GST_THREAD_CLASS GST_THREAD_CLASS
GST_IS_THREAD_CLASS GST_IS_THREAD_CLASS
GST_THREAD_GET_CLASS GST_THREAD_GET_CLASS
<SUBSECTION Private>
gst_thread_get_type
</SECTION> </SECTION>
<SECTION> <SECTION>
<FILE>gsttypefind</FILE> <FILE>gsttypefind</FILE>
<TITLE>GstTypeFind</TITLE>
GstTypeFind GstTypeFind
GstTypeFindFunction GstTypeFindFunction
GstTypeFindProbability GstTypeFindProbability
@ -1182,22 +1215,19 @@ GstTypeFindFactoryClass
GST_TYPE_FIND_FACTORY GST_TYPE_FIND_FACTORY
GST_IS_TYPE_FIND_FACTORY GST_IS_TYPE_FIND_FACTORY
GST_TYPE_TYPE_FIND_FACTORY GST_TYPE_TYPE_FIND_FACTORY
gst_type_find_factory_get_type
GST_TYPE_FIND_FACTORY_CLASS GST_TYPE_FIND_FACTORY_CLASS
GST_IS_TYPE_FIND_FACTORY_CLASS GST_IS_TYPE_FIND_FACTORY_CLASS
GST_TYPE_FIND_FACTORY_GET_CLASS GST_TYPE_FIND_FACTORY_GET_CLASS
<SUBSECTION Private>
gst_type_find_factory_get_type
</SECTION> </SECTION>
<SECTION> <SECTION>
<FILE>gsturi</FILE> <FILE>gsturi</FILE>
GstURIType GstURIType
GST_TYPE_URI_HANDLER GST_TYPE_URI_HANDLER
GST_URI_HANDLER
GST_IS_URI_HANDLER
GST_URI_HANDLER_GET_INTERFACE
GST_URI_HANDLER_CLASS
GstURIHandler GstURIHandler
GstURIHandlerInterface GST_URI_TYPE_IS_VALID
gst_uri_protocol_is_valid gst_uri_protocol_is_valid
gst_uri_is_valid gst_uri_is_valid
gst_uri_get_protocol gst_uri_get_protocol
@ -1210,7 +1240,12 @@ gst_uri_handler_get_uri
gst_uri_handler_set_uri gst_uri_handler_set_uri
gst_uri_handler_new_uri gst_uri_handler_new_uri
<SUBSECTION Standard> <SUBSECTION Standard>
GST_URI_TYPE_IS_VALID GstURIHandlerInterface
GST_URI_HANDLER
GST_IS_URI_HANDLER
GST_URI_HANDLER_CLASS
GST_URI_HANDLER_GET_INTERFACE
<SUBSECTION Private>
gst_uri_handler_get_type gst_uri_handler_get_type
</SECTION> </SECTION>
@ -1233,10 +1268,11 @@ GstXMLClass
GST_XML GST_XML
GST_IS_XML GST_IS_XML
GST_TYPE_XML GST_TYPE_XML
gst_xml_get_type
GST_XML_CLASS GST_XML_CLASS
GST_IS_XML_CLASS GST_IS_XML_CLASS
GST_XML_GET_CLASS GST_XML_GET_CLASS
<SUBSECTION Private>
gst_xml_get_type
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -1267,102 +1303,103 @@ gst_atomic_int_dec_and_test
<SECTION> <SECTION>
<FILE>gstenumtypes</FILE> <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_ALLOC_TRACE_FLAGS
gst_type_find_probability_get_type GST_TYPE_ASSOC_FLAGS
GST_TYPE_TYPE_FIND_PROBABILITY GST_TYPE_BIN_FLAGS
gst_element_state_get_type GST_TYPE_BUFFER_FLAG
GST_TYPE_CLOCK_ENTRY_STATUS
GST_TYPE_CLOCK_ENTRY_TYPE
GST_TYPE_CLOCK_FLAGS
GST_TYPE_CLOCK_RETURN
GST_TYPE_CORE_ERROR
GST_TYPE_CPU_FLAGS
GST_TYPE_DATA_FLAGS
GST_TYPE_DEBUG_COLOR_FLAGS
GST_TYPE_DEBUG_LEVEL
GST_TYPE_ELEMENT_FLAGS
GST_TYPE_ELEMENT_STATE GST_TYPE_ELEMENT_STATE
gst_element_state_return_get_type
GST_TYPE_ELEMENT_STATE_RETURN GST_TYPE_ELEMENT_STATE_RETURN
gst_result_get_type GST_TYPE_EVENT_FLAG
GST_TYPE_RESULT GST_TYPE_EVENT_TYPE
gst_uri_type_get_type GST_TYPE_FORMAT
GST_TYPE_URI_TYPE GST_TYPE_INDEX_CERTAINTY
gst_registry_return_get_type GST_TYPE_INDEX_ENTRY_TYPE
GST_TYPE_REGISTRY_RETURN GST_TYPE_INDEX_FLAGS
gst_registry_flags_get_type GST_TYPE_INDEX_LOOKUP_METHOD
GST_TYPE_REGISTRY_FLAGS GST_TYPE_INDEX_RESOLVER_METHOD
gst_parse_error_get_type GST_TYPE_LIBRARY_ERROR
GST_TYPE_OBJECT_FLAGS
GST_TYPE_PAD_DIRECTION
GST_TYPE_PAD_FLAGS
GST_TYPE_PAD_LINK_RETURN
GST_TYPE_PAD_PRESENCE
GST_TYPE_PAD_TEMPLATE_FLAGS
GST_TYPE_PARSE_ERROR GST_TYPE_PARSE_ERROR
GST_TYPE_PLUGIN_ERROR
GST_TYPE_QUERY_TYPE
GST_TYPE_REGISTRY_FLAGS
GST_TYPE_REGISTRY_RETURN
GST_TYPE_RESOURCE_ERROR
GST_TYPE_RESULT
GST_TYPE_SCHEDULER_FLAGS
GST_TYPE_SCHEDULER_STATE
GST_TYPE_SEEK_ACCURACY
GST_TYPE_SEEK_TYPE
GST_TYPE_STREAM_ERROR
GST_TYPE_TAG_FLAG
GST_TYPE_TAG_MERGE_MODE
GST_TYPE_THREAD_STATE
GST_TYPE_TYPE_FIND_PROBABILITY
GST_TYPE_URI_TYPE
<SUBSECTION Private>
gst_alloc_trace_flags_get_type
gst_assoc_flags_get_type
gst_bin_flags_get_type
gst_buffer_flag_get_type
gst_clock_entry_status_get_type
gst_clock_entry_type_get_type
gst_clock_flags_get_type
gst_clock_return_get_type
gst_core_error_get_type
gst_cpu_flags_get_type
gst_data_flags_get_type
gst_debug_color_flags_get_type
gst_debug_level_get_type
gst_element_flags_get_type
gst_element_state_get_type
gst_element_state_return_get_type
gst_event_flag_get_type
gst_event_type_get_type
gst_format_get_type
gst_index_certainty_get_type
gst_index_entry_type_get_type
gst_index_flags_get_type
gst_index_lookup_method_get_type
gst_index_resolver_method_get_type
gst_library_error_get_type
gst_object_flags_get_type
gst_pad_direction_get_type
gst_pad_flags_get_type
gst_pad_link_return_get_type
gst_pad_presence_get_type
gst_pad_template_flags_get_type
gst_parse_error_get_type
gst_plugin_error_get_type
gst_query_type_get_type
gst_registry_flags_get_type
gst_registry_return_get_type
gst_resource_error_get_type
gst_result_get_type
gst_scheduler_flags_get_type
gst_scheduler_state_get_type
gst_seek_accuracy_get_type
gst_seek_type_get_type
gst_stream_error_get_type
gst_tag_flag_get_type
gst_tag_merge_mode_get_type
gst_thread_state_get_type
gst_type_find_probability_get_type
gst_uri_type_get_type
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -1486,6 +1523,7 @@ gst_mem_chunk_free
<SECTION> <SECTION>
<FILE>gstparse</FILE> <FILE>gstparse</FILE>
<TITLE>GstParse</TITLE>
gst_parse_error_quark gst_parse_error_quark
GST_PARSE_ERROR GST_PARSE_ERROR
GstParseError GstParseError
@ -1498,7 +1536,6 @@ gst_parse_launchv
gst_plugin_error_quark gst_plugin_error_quark
GST_PLUGIN_ERROR GST_PLUGIN_ERROR
GstPluginError GstPluginError
GST_PLUGIN
GstPlugin GstPlugin
GstPluginDesc GstPluginDesc
GstPluginInitFunc GstPluginInitFunc
@ -1508,7 +1545,6 @@ GST_PLUGIN_DEFINE_STATIC
GST_LICENSE_UNKNOWN GST_LICENSE_UNKNOWN
GstPluginFilter GstPluginFilter
GST_TYPE_PLUGIN GST_TYPE_PLUGIN
gst_plugin_get_type
gst_plugin_get_name gst_plugin_get_name
gst_plugin_get_description gst_plugin_get_description
gst_plugin_get_filename gst_plugin_get_filename
@ -1528,6 +1564,10 @@ gst_plugin_unload_plugin
gst_plugin_add_feature gst_plugin_add_feature
gst_plugin_load gst_plugin_load
gst_library_load gst_library_load
<SUBSECTION Standard>
GST_PLUGIN
<SUBSECTION Private>
gst_plugin_get_type
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -1614,40 +1654,17 @@ gst_vgulong
SMP_LOCK SMP_LOCK
</SECTION> </SECTION>
<SECTION>
<FILE>gsttypes</FILE>
GstObject
GstObjectClass
GstPad
GstPadClass
GstPadTemplate
GstPadTemplateClass
GstElement
GstElementClass
GstBin
GstBinClass
GstScheduler
GstSchedulerClass
GstEvent
GstElementState
GstElementStateReturn
GstResult
GST_RANK_PRIMARY
GST_RANK_SECONDARY
GST_RANK_MARGINAL
GST_RANK_NONE
GST_PADDING
GST_PADDING_INIT
</SECTION>
<SECTION> <SECTION>
<FILE>gsturitype</FILE> <FILE>gsturitype</FILE>
<TITLE>GstUri</TITLE>
GST_TYPE_URI GST_TYPE_URI
<SUBSECTION Private>
gst_uri_get_uri_type gst_uri_get_uri_type
</SECTION> </SECTION>
<SECTION> <SECTION>
<FILE>gstutils</FILE> <FILE>gstutils</FILE>
<TITLE>GstUtils</TITLE>
gst_util_set_value_from_string gst_util_set_value_from_string
gst_util_set_object_arg gst_util_set_object_arg
gst_util_dump_mem gst_util_dump_mem
@ -1774,6 +1791,7 @@ gst_version
<SECTION> <SECTION>
<FILE>gsterror</FILE> <FILE>gsterror</FILE>
<TITLE>GstGError</TITLE>
GstCoreError GstCoreError
GstLibraryError GstLibraryError
GstResourceError GstResourceError
@ -1784,11 +1802,26 @@ GST_RESOURCE_ERROR
GST_CORE_ERROR GST_CORE_ERROR
GST_STREAM_ERROR GST_STREAM_ERROR
GST_ERROR_SYSTEM GST_ERROR_SYSTEM
gst_g_error_get_type
gst_error_get_message gst_error_get_message
gst_stream_error_quark gst_stream_error_quark
gst_core_error_quark gst_core_error_quark
gst_resource_error_quark gst_resource_error_quark
gst_library_error_quark gst_library_error_quark
<SUBSECTION Private>
gst_g_error_get_type
</SECTION>
<SECTION>
<FILE>gsttypes</FILE>
GstElementState
GstElementStateReturn
GstResult
GST_RANK_PRIMARY
GST_RANK_SECONDARY
GST_RANK_MARGINAL
GST_RANK_NONE
GST_PADDING
GST_PADDING_INIT
<SUBSECTION Standard>
</SECTION> </SECTION>

23
docs/gst/gstreamer.types
View file

@ -1,21 +1,24 @@
#include <gst/gst.h> #include <gst/gst.h>
#include <gst/gstqueue.h> #include <gst/gstqueue.h>
gst_object_get_type
gst_element_get_type
gst_bin_get_type gst_bin_get_type
gst_clock_get_type gst_clock_get_type
gst_pipeline_get_type gst_element_factory_get_type
gst_element_get_type
gst_ghost_pad_get_type
gst_implements_interface_get_type
gst_index_factory_get_type
gst_index_get_type
gst_object_get_type
gst_pad_get_type gst_pad_get_type
gst_pad_template_get_type gst_pad_template_get_type
gst_ghost_pad_get_type gst_pipeline_get_type
gst_thread_get_type
gst_plugin_feature_get_type gst_plugin_feature_get_type
gst_type_find_factory_get_type gst_queue_get_type
gst_element_factory_get_type
gst_scheduler_factory_get_type gst_scheduler_factory_get_type
gst_scheduler_get_type gst_scheduler_get_type
gst_index_get_type gst_tag_setter_get_type
gst_index_factory_get_type gst_thread_get_type
gst_type_find_factory_get_type
gst_xml_get_type gst_xml_get_type
gst_queue_get_type

34
docs/gst/tmpl/gstbin.sgml
View file

@ -55,6 +55,40 @@ clock providers in the bin.
</para> </para>
<!-- ##### STRUCT GstBin ##### -->
<para>
</para>
<!-- ##### SIGNAL GstBin::element-added ##### -->
<para>
</para>
@gstbin: the object which received the signal.
@arg1: the element that was added to the bin
<!-- ##### SIGNAL GstBin::element-removed ##### -->
<para>
</para>
@gstbin: the object which received the signal.
@arg1: the element that was removed from the bin
<!-- ##### SIGNAL GstBin::iterate ##### -->
<para>
This signal is emitted when a bin iterates, either automatically or
due to a #gst_bin_iterate() call. The return value is used to
determine if the object method handler processed any data.
In most normal cases, a user-provided signal handler should return
FALSE.
</para>
@gstbin: the object which received the signal.
@Returns: TRUE if the state of the bin was advanced.
<!-- ##### ENUM GstBinFlags ##### --> <!-- ##### ENUM GstBinFlags ##### -->
<para> <para>
Flags for a bin. Flags for a bin.

2
docs/gst/tmpl/gstconfig.sgml
View file

@ -6,7 +6,7 @@ Configuration options
<!-- ##### SECTION Long_Description ##### --> <!-- ##### SECTION Long_Description ##### -->
<para> <para>
This describes the configureation options for GStreamer. When building This describes the configuration options for GStreamer. When building
GStreamer there are a lot of parts (known internally as "subsystems" ) that can GStreamer there are a lot of parts (known internally as "subsystems" ) that can
be disabled for various reasons. The most common reasons are speed and size, be disabled for various reasons. The most common reasons are speed and size,
which is important because GStreamer is designed to run on embedded systems. which is important because GStreamer is designed to run on embedded systems.

89
docs/gst/tmpl/gstelement.sgml
View file

@ -152,41 +152,12 @@ and gst_element_set_clock(). You can wait for the clock to reach a given
@arg1: @arg1:
@arg2: @arg2:
<!-- ##### STRUCT GstElementClass ##### --> <!-- ##### MACRO GST_TYPE_ELEMENT ##### -->
<para> <para>
</para> </para>
@parent_class:
@details:
@elementfactory:
@padtemplates:
@numpadtemplates:
@state_change:
@new_pad:
@pad_removed:
@error:
@eos:
@found_tag:
@set_property:
@get_property:
@release_locks:
@get_event_masks:
@send_event:
@get_formats:
@convert:
@get_query_types:
@query:
@change_state:
@request_new_pad:
@release_pad:
@get_clock:
@set_clock:
@get_index:
@set_index:
@set_state:
@no_more_pads:
@_gst_reserved:
<!-- ##### STRUCT GstElementDetails ##### --> <!-- ##### STRUCT GstElementDetails ##### -->
<para> <para>
@ -292,14 +263,6 @@ The Element is going from the READY state to the NULL state.
<!-- ##### MACRO GST_ELEMENT_CLASS ##### -->
<para>
</para>
@klass:
<!-- ##### MACRO GST_ELEMENT_QUERY_TYPE_FUNCTION ##### --> <!-- ##### MACRO GST_ELEMENT_QUERY_TYPE_FUNCTION ##### -->
<para> <para>
Helper macro to create query type functions Helper macro to create query type functions
@ -1255,14 +1218,6 @@ Sets the parent of an element.
@element: @element:
<!-- ##### FUNCTION gst_element_factory_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_element_register ##### --> <!-- ##### FUNCTION gst_element_register ##### -->
<para> <para>
@ -1413,14 +1368,6 @@ Sets the parent of an element.
</para> </para>
<!-- ##### STRUCT GstElementFactoryClass ##### -->
<para>
</para>
@parent_class:
@_gst_reserved:
<!-- ##### MACRO GST_TYPE_ELEMENT_FACTORY ##### --> <!-- ##### MACRO GST_TYPE_ELEMENT_FACTORY ##### -->
<para> <para>
@ -1428,35 +1375,3 @@ Sets the parent of an element.
<!-- ##### MACRO GST_ELEMENT_FACTORY ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_ELEMENT_FACTORY_CLASS ##### -->
<para>
</para>
@klass:
<!-- ##### MACRO GST_IS_ELEMENT_FACTORY ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_IS_ELEMENT_FACTORY_CLASS ##### -->
<para>
</para>
@klass:

842
docs/gst/tmpl/gstenumtypes.sgml
View file

@ -14,342 +14,11 @@ gstenumtypes
</para> </para>
<!-- ##### FUNCTION gst_object_flags_get_type ##### --> <!-- ##### MACRO GST_TYPE_ALLOC_TRACE_FLAGS ##### -->
<para> <para>
</para> </para>
@Returns:
<!-- ##### MACRO GST_TYPE_OBJECT_FLAGS ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_bin_flags_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_BIN_FLAGS ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_buffer_flag_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_BUFFER_FLAG ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_clock_entry_status_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_CLOCK_ENTRY_STATUS ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_clock_entry_type_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_CLOCK_ENTRY_TYPE ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_clock_return_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_CLOCK_RETURN ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_clock_flags_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_CLOCK_FLAGS ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_cpu_flags_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_CPU_FLAGS ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_data_flags_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_DATA_FLAGS ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_element_flags_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_ELEMENT_FLAGS ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_core_error_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_CORE_ERROR ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_library_error_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_LIBRARY_ERROR ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_resource_error_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_RESOURCE_ERROR ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_stream_error_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_STREAM_ERROR ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_event_type_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_EVENT_TYPE ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_event_flag_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_EVENT_FLAG ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_seek_type_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_SEEK_TYPE ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_seek_accuracy_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_SEEK_ACCURACY ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_format_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_FORMAT ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_index_certainty_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_INDEX_CERTAINTY ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_index_entry_type_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_INDEX_ENTRY_TYPE ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_index_lookup_method_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_INDEX_LOOKUP_METHOD ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_assoc_flags_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_ASSOC_FLAGS ##### --> <!-- ##### MACRO GST_TYPE_ASSOC_FLAGS ##### -->
@ -359,57 +28,67 @@ gstenumtypes
<!-- ##### FUNCTION gst_index_resolver_method_get_type ##### --> <!-- ##### MACRO GST_TYPE_BIN_FLAGS ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_INDEX_RESOLVER_METHOD ##### -->
<para> <para>
</para> </para>
<!-- ##### FUNCTION gst_index_flags_get_type ##### --> <!-- ##### MACRO GST_TYPE_BUFFER_FLAG ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_INDEX_FLAGS ##### -->
<para> <para>
</para> </para>
<!-- ##### FUNCTION gst_debug_level_get_type ##### --> <!-- ##### MACRO GST_TYPE_CLOCK_ENTRY_STATUS ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_DEBUG_LEVEL ##### -->
<para> <para>
</para> </para>
<!-- ##### FUNCTION gst_debug_color_flags_get_type ##### --> <!-- ##### MACRO GST_TYPE_CLOCK_ENTRY_TYPE ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_CLOCK_FLAGS ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_CLOCK_RETURN ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_CORE_ERROR ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_CPU_FLAGS ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_DATA_FLAGS ##### -->
<para> <para>
</para> </para>
@Returns:
<!-- ##### MACRO GST_TYPE_DEBUG_COLOR_FLAGS ##### --> <!-- ##### MACRO GST_TYPE_DEBUG_COLOR_FLAGS ##### -->
@ -419,222 +98,18 @@ gstenumtypes
<!-- ##### FUNCTION gst_pad_link_return_get_type ##### --> <!-- ##### MACRO GST_TYPE_DEBUG_LEVEL ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_PAD_LINK_RETURN ##### -->
<para> <para>
</para> </para>
<!-- ##### FUNCTION gst_pad_direction_get_type ##### --> <!-- ##### MACRO GST_TYPE_ELEMENT_FLAGS ##### -->
<para> <para>
</para> </para>
@Returns:
<!-- ##### MACRO GST_TYPE_PAD_DIRECTION ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_pad_flags_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_PAD_FLAGS ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_pad_presence_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_PAD_PRESENCE ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_pad_template_flags_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_PAD_TEMPLATE_FLAGS ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_plugin_error_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_PLUGIN_ERROR ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_query_type_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_QUERY_TYPE ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_scheduler_flags_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_SCHEDULER_FLAGS ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_scheduler_state_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_SCHEDULER_STATE ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_tag_merge_mode_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_TAG_MERGE_MODE ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_tag_flag_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_TAG_FLAG ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_thread_state_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_THREAD_STATE ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_alloc_trace_flags_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_ALLOC_TRACE_FLAGS ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_type_find_probability_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_TYPE_FIND_PROBABILITY ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_element_state_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_ELEMENT_STATE ##### --> <!-- ##### MACRO GST_TYPE_ELEMENT_STATE ##### -->
@ -644,14 +119,6 @@ gstenumtypes
<!-- ##### FUNCTION gst_element_state_return_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_ELEMENT_STATE_RETURN ##### --> <!-- ##### MACRO GST_TYPE_ELEMENT_STATE_RETURN ##### -->
<para> <para>
@ -659,72 +126,109 @@ gstenumtypes
<!-- ##### FUNCTION gst_result_get_type ##### --> <!-- ##### MACRO GST_TYPE_EVENT_FLAG ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_RESULT ##### -->
<para> <para>
</para> </para>
<!-- ##### FUNCTION gst_uri_type_get_type ##### --> <!-- ##### MACRO GST_TYPE_EVENT_TYPE ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_URI_TYPE ##### -->
<para> <para>
</para> </para>
<!-- ##### FUNCTION gst_registry_return_get_type ##### --> <!-- ##### MACRO GST_TYPE_FORMAT ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_REGISTRY_RETURN ##### -->
<para> <para>
</para> </para>
<!-- ##### FUNCTION gst_registry_flags_get_type ##### --> <!-- ##### MACRO GST_TYPE_INDEX_CERTAINTY ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_TYPE_REGISTRY_FLAGS ##### -->
<para> <para>
</para> </para>
<!-- ##### FUNCTION gst_parse_error_get_type ##### --> <!-- ##### MACRO GST_TYPE_INDEX_ENTRY_TYPE ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_INDEX_FLAGS ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_INDEX_LOOKUP_METHOD ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_INDEX_RESOLVER_METHOD ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_LIBRARY_ERROR ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_OBJECT_FLAGS ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_PAD_DIRECTION ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_PAD_FLAGS ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_PAD_LINK_RETURN ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_PAD_PRESENCE ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_PAD_TEMPLATE_FLAGS ##### -->
<para> <para>
</para> </para>
@Returns:
<!-- ##### MACRO GST_TYPE_PARSE_ERROR ##### --> <!-- ##### MACRO GST_TYPE_PARSE_ERROR ##### -->
@ -734,3 +238,115 @@ gstenumtypes
<!-- ##### MACRO GST_TYPE_PLUGIN_ERROR ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_QUERY_TYPE ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_REGISTRY_FLAGS ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_REGISTRY_RETURN ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_RESOURCE_ERROR ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_RESULT ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_SCHEDULER_FLAGS ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_SCHEDULER_STATE ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_SEEK_ACCURACY ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_SEEK_TYPE ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_STREAM_ERROR ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_TAG_FLAG ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_TAG_MERGE_MODE ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_THREAD_STATE ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_TYPE_FIND_PROBABILITY ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_URI_TYPE ##### -->
<para>
</para>

8
docs/gst/tmpl/gsterror.sgml
View file

@ -126,14 +126,6 @@ Categorized error messages
<!-- ##### FUNCTION gst_g_error_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_error_get_message ##### --> <!-- ##### FUNCTION gst_error_get_message ##### -->
<para> <para>

27
docs/gst/tmpl/gstevent.sgml
View file

@ -27,6 +27,23 @@ gst_event_new_flush() creates a new flush event.
#GstPad, #GstElement #GstPad, #GstElement
</para> </para>
<!-- ##### MACRO GST_TYPE_EVENT ##### -->
<para>
</para>
<!-- ##### STRUCT GstEvent ##### -->
<para>
</para>
@data:
@type:
@timestamp:
@src:
<!-- ##### ENUM GstEventType ##### --> <!-- ##### ENUM GstEventType ##### -->
<para> <para>
The different major types of events. The different major types of events.
@ -308,16 +325,6 @@ Get access to the rate vale field
@event: The event to query @event: The event to query
<!-- ##### STRUCT GstEvent ##### -->
<para>
</para>
@data:
@type:
@timestamp:
@src:
<!-- ##### FUNCTION gst_event_new ##### --> <!-- ##### FUNCTION gst_event_new ##### -->
<para> <para>

11
docs/gst/tmpl/gstinterface.sgml → docs/gst/tmpl/gstimplementsinterface.sgml
View file

@ -1,8 +1,8 @@
<!-- ##### SECTION Title ##### --> <!-- ##### SECTION Title ##### -->
GstInterface GstImplementsInterface
<!-- ##### SECTION Short_Description ##### --> <!-- ##### SECTION Short_Description ##### -->
Core interfaces implemented by #GstElements Core interface implemented by #GstElements that allows runtime querying of interface availabillity
<!-- ##### SECTION Long_Description ##### --> <!-- ##### SECTION Long_Description ##### -->
<para> <para>
@ -14,6 +14,13 @@ Core interfaces implemented by #GstElements
</para> </para>
<!-- ##### MACRO GST_TYPE_IMPLEMENTS_INTERFACE ##### -->
<para>
</para>
<!-- ##### STRUCT GstImplementsInterface ##### --> <!-- ##### STRUCT GstImplementsInterface ##### -->
<para> <para>

56
docs/gst/tmpl/gstindex.sgml
View file

@ -445,68 +445,12 @@ Check if the index can be written to
<!-- ##### MACRO GST_INDEX_FACTORY ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_IS_INDEX_FACTORY ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_INDEX_FACTORY_CLASS ##### -->
<para>
</para>
@klass:
<!-- ##### MACRO GST_IS_INDEX_FACTORY_CLASS ##### -->
<para>
</para>
@klass:
<!-- ##### MACRO GST_INDEX_FACTORY_GET_CLASS ##### -->
<para>
</para>
@obj:
<!-- ##### STRUCT GstIndexFactory ##### --> <!-- ##### STRUCT GstIndexFactory ##### -->
<para> <para>
The GstIndexFactory object The GstIndexFactory object
</para> </para>
<!-- ##### STRUCT GstIndexFactoryClass ##### -->
<para>
</para>
@parent:
@_gst_reserved:
<!-- ##### FUNCTION gst_index_factory_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_index_factory_new ##### --> <!-- ##### FUNCTION gst_index_factory_new ##### -->
<para> <para>

50
docs/gst/tmpl/gstobject.sgml
View file

@ -25,12 +25,58 @@ object.
</para> </para>
<!-- ##### MACRO GST_OBJECT_CLASS ##### --> <!-- ##### STRUCT GstObject ##### -->
<para>
</para>
<!-- ##### SIGNAL GstObject::deep-notify ##### -->
<para>
The deep notify signal is used to be notified of property changes.
it is typically attached to the toplevel bin to receive notifications
from all the elements contained in that bin.
</para>
@gstobject: the object which received the signal.
@arg1: the object that originated the signal
@arg2: the property that changed
<!-- ##### SIGNAL GstObject::object-saved ##### -->
<para>
Is trigered whenever a new object is saved to XML. You can connect to
this signal to insert custom XML tags into the core XML.
</para>
@gstobject: the object which received the signal.
@arg1: the xmlNodePtr of the parent node
<!-- ##### SIGNAL GstObject::parent-set ##### -->
<para>
Is emitted when the parent of an object is set.
</para>
@gstobject: the object which received the signal.
@arg1: the new parent
<!-- ##### SIGNAL GstObject::parent-unset ##### -->
<para>
Is emitted when the parent of an object is unset.
</para>
@gstobject: the object which received the signal.
@arg1: the old parent
<!-- ##### ARG GstObject:name ##### -->
<para>
The name of the object
</para>
<!-- ##### MACRO GST_TYPE_OBJECT ##### -->
<para> <para>
</para> </para>
@klass:
<!-- ##### MACRO xmlNodePtr ##### --> <!-- ##### MACRO xmlNodePtr ##### -->

174
docs/gst/tmpl/gstpad.sgml
View file

@ -63,14 +63,6 @@ Last reviewed on December 13th, 2002 (0.5.0.1)
</para> </para>
<!-- ##### STRUCT GstPadClass ##### -->
<para>
</para>
@parent_class:
@_gst_reserved:
<!-- ##### STRUCT GstRealPad ##### --> <!-- ##### STRUCT GstRealPad ##### -->
<para> <para>
@ -88,40 +80,26 @@ Last reviewed on December 13th, 2002 (0.5.0.1)
</para> </para>
<!-- ##### STRUCT GstRealPadClass ##### --> <!-- ##### STRUCT GstPadTemplate ##### -->
<para>
The padtemplate object.
</para>
<!-- ##### SIGNAL GstPadTemplate::pad-created ##### -->
<para>
This signal is fired when an element creates a pad from this
template.
</para>
@gstpadtemplate: the object which received the signal.
@arg1: The pad that was created.
<!-- ##### MACRO GST_TYPE_PAD ##### -->
<para> <para>
</para> </para>
@parent_class:
@caps_nego_failed:
@linked:
@unlinked:
@appfixatefunc:
@_gst_reserved:
<!-- ##### STRUCT GstGhostPadClass ##### -->
<para>
</para>
@parent_class:
@_gst_reserved:
<!-- ##### MACRO GST_IS_PAD_FAST ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_PAD_CLASS ##### -->
<para>
</para>
@klass:
<!-- ##### MACRO GST_TYPE_REAL_PAD ##### --> <!-- ##### MACRO GST_TYPE_REAL_PAD ##### -->
@ -131,14 +109,6 @@ Last reviewed on December 13th, 2002 (0.5.0.1)
<!-- ##### MACRO GST_IS_REAL_PAD ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_IS_REAL_PAD_FAST ##### --> <!-- ##### MACRO GST_IS_REAL_PAD_FAST ##### -->
<para> <para>
@ -147,32 +117,6 @@ Last reviewed on December 13th, 2002 (0.5.0.1)
@obj: @obj:
<!-- ##### MACRO GST_IS_REAL_PAD_CLASS ##### -->
<para>
</para>
@klass:
<!-- # Unused Parameters # -->
@obj:
<!-- ##### MACRO GST_REAL_PAD ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_REAL_PAD_CLASS ##### -->
<para>
</para>
@klass:
<!-- ##### MACRO GST_TYPE_GHOST_PAD ##### --> <!-- ##### MACRO GST_TYPE_GHOST_PAD ##### -->
<para> <para>
@ -180,14 +124,6 @@ Last reviewed on December 13th, 2002 (0.5.0.1)
<!-- ##### MACRO GST_IS_GHOST_PAD ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_IS_GHOST_PAD_FAST ##### --> <!-- ##### MACRO GST_IS_GHOST_PAD_FAST ##### -->
<para> <para>
@ -196,17 +132,7 @@ Last reviewed on December 13th, 2002 (0.5.0.1)
@obj: @obj:
<!-- ##### MACRO GST_IS_GHOST_PAD_CLASS ##### --> <!-- ##### MACRO GST_IS_PAD_FAST ##### -->
<para>
</para>
@klass:
<!-- # Unused Parameters # -->
@obj:
<!-- ##### MACRO GST_GHOST_PAD ##### -->
<para> <para>
</para> </para>
@ -214,14 +140,6 @@ Last reviewed on December 13th, 2002 (0.5.0.1)
@obj: @obj:
<!-- ##### MACRO GST_GHOST_PAD_CLASS ##### -->
<para>
</para>
@klass:
<!-- ##### STRUCT GstStaticPadTemplate ##### --> <!-- ##### STRUCT GstStaticPadTemplate ##### -->
<para> <para>
@ -807,40 +725,6 @@ Checks if the pad is a sink pad.
<!-- ##### MACRO GST_PAD_TEMPLATE ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_PAD_TEMPLATE_CLASS ##### -->
<para>
</para>
@klass:
<!-- ##### MACRO GST_IS_PAD_TEMPLATE ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_IS_PAD_TEMPLATE_CLASS ##### -->
<para>
</para>
@klass:
<!-- # Unused Parameters # -->
@obj:
<!-- ##### ENUM GstPadPresence ##### --> <!-- ##### ENUM GstPadPresence ##### -->
<para> <para>
Indicates when this pad will become available. Indicates when this pad will become available.
@ -910,22 +794,6 @@ Check if the properties of the padtemplate are fixed
@caps: @caps:
<!-- ##### FUNCTION gst_real_pad_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_ghost_pad_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_pad_new ##### --> <!-- ##### FUNCTION gst_pad_new ##### -->
<para> <para>
@ -1786,14 +1654,6 @@ Remove the probe from the pad
@Returns: @Returns:
<!-- ##### FUNCTION gst_pad_template_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_pad_template_new ##### --> <!-- ##### FUNCTION gst_pad_template_new ##### -->
<para> <para>

2
docs/gst/tmpl/gstparse.sgml
View file

@ -2,7 +2,7 @@
gstparse gstparse
<!-- ##### SECTION Short_Description ##### --> <!-- ##### SECTION Short_Description ##### -->
get a pipeline from a text pipeline description
<!-- ##### SECTION Long_Description ##### --> <!-- ##### SECTION Long_Description ##### -->
<para> <para>

16
docs/gst/tmpl/gstplugin.sgml
View file

@ -58,14 +58,6 @@ The plugin loading errors
@GST_PLUGIN_ERROR_DEPENDENCIES: The plugin has unresolved dependencies @GST_PLUGIN_ERROR_DEPENDENCIES: The plugin has unresolved dependencies
@GST_PLUGIN_ERROR_NAME_MISMATCH: @GST_PLUGIN_ERROR_NAME_MISMATCH:
<!-- ##### MACRO GST_PLUGIN ##### -->
<para>
</para>
@plugin:
<!-- ##### STRUCT GstPlugin ##### --> <!-- ##### STRUCT GstPlugin ##### -->
<para> <para>
The plugin object The plugin object
@ -173,14 +165,6 @@ It will be called by the loader at statup.
<!-- ##### FUNCTION gst_plugin_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_plugin_get_name ##### --> <!-- ##### FUNCTION gst_plugin_get_name ##### -->
<para> <para>

11
docs/gst/tmpl/gstqueue.sgml
View file

@ -112,17 +112,6 @@ The queue blocks by default.
</para> </para>
<!-- ##### STRUCT GstQueueClass ##### -->
<para>
</para>
@parent_class:
@underrun:
@running:
@overrun:
@_gst_reserved:
<!-- ##### STRUCT GstQueueSize ##### --> <!-- ##### STRUCT GstQueueSize ##### -->
<para> <para>

86
docs/gst/tmpl/gstscheduler.sgml
View file

@ -20,34 +20,6 @@ This is a base class for custom schedulers.
</para> </para>
<!-- ##### STRUCT GstSchedulerClass ##### -->
<para>
</para>
@parent_class:
@setup:
@reset:
@add_element:
@remove_element:
@add_scheduler:
@remove_scheduler:
@state_transition:
@scheduling_change:
@lock_element:
@unlock_element:
@yield:
@interrupt:
@error:
@pad_link:
@pad_unlink:
@pad_select:
@clock_wait:
@iterate:
@show:
@object_sync:
@_gst_reserved:
<!-- ##### ENUM GstSchedulerFlags ##### --> <!-- ##### ENUM GstSchedulerFlags ##### -->
<para> <para>
Flags for the scheduler Flags for the scheduler
@ -307,48 +279,6 @@ The state of the scheduler
<!-- ##### MACRO GST_SCHEDULER_FACTORY ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_IS_SCHEDULER_FACTORY ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_SCHEDULER_FACTORY_CLASS ##### -->
<para>
</para>
@klass:
<!-- ##### MACRO GST_IS_SCHEDULER_FACTORY_CLASS ##### -->
<para>
</para>
@klass:
<!-- # Unused Parameters # -->
@obj:
<!-- ##### MACRO GST_SCHEDULER_FACTORY_GET_CLASS ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_SCHEDULER_DEFAULT_NAME ##### --> <!-- ##### MACRO GST_SCHEDULER_DEFAULT_NAME ##### -->
<para> <para>
@ -362,22 +292,6 @@ The state of the scheduler
</para> </para>
<!-- ##### STRUCT GstSchedulerFactoryClass ##### -->
<para>
</para>
@parent:
@_gst_reserved:
<!-- ##### FUNCTION gst_scheduler_factory_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_scheduler_factory_new ##### --> <!-- ##### FUNCTION gst_scheduler_factory_new ##### -->
<para> <para>

2
docs/gst/tmpl/gsttaginterface.sgml → docs/gst/tmpl/gsttagsetter.sgml
View file

@ -1,5 +1,5 @@
<!-- ##### SECTION Title ##### --> <!-- ##### SECTION Title ##### -->
GstTagInterface GstTagSetter
<!-- ##### SECTION Short_Description ##### --> <!-- ##### SECTION Short_Description ##### -->
Element interface that allows setting and retrieval of media metadata Element interface that allows setting and retrieval of media metadata

2
docs/gst/tmpl/gsttypefind.sgml
View file

@ -2,7 +2,7 @@
GstTypeFindElement GstTypeFindElement
<!-- ##### SECTION Short_Description ##### --> <!-- ##### SECTION Short_Description ##### -->
typefinding subsystem
<!-- ##### SECTION Long_Description ##### --> <!-- ##### SECTION Long_Description ##### -->
<para> <para>

294
docs/gst/tmpl/gsttypes.sgml
View file

@ -14,300 +14,6 @@ gsttypes
</para> </para>
<!-- ##### STRUCT GstObject ##### -->
<para>
</para>
<!-- ##### SIGNAL GstObject::deep-notify ##### -->
<para>
The deep notify signal is used to be notified of property changes.
it is typically attached to the toplevel bin to receive notifications
from all the elements contained in that bin.
</para>
@gstobject: the object which received the signal.
@arg1: the object that originated the signal
@arg2: the property that changed
<!-- ##### SIGNAL GstObject::object-saved ##### -->
<para>
Is trigered whenever a new object is saved to XML. You can connect to
this signal to insert custom XML tags into the core XML.
</para>
@gstobject: the object which received the signal.
@arg1: the xmlNodePtr of the parent node
<!-- ##### SIGNAL GstObject::parent-set ##### -->
<para>
Is emitted when the parent of an object is set.
</para>
@gstobject: the object which received the signal.
@arg1: the new parent
<!-- ##### SIGNAL GstObject::parent-unset ##### -->
<para>
Is emitted when the parent of an object is unset.
</para>
@gstobject: the object which received the signal.
@arg1: the old parent
<!-- ##### ARG GstObject:name ##### -->
<para>
The name of the object
</para>
<!-- ##### STRUCT GstObjectClass ##### -->
<para>
</para>
@parent_class:
@path_string_separator:
@signal_object:
@parent_set:
@parent_unset:
@object_saved:
@deep_notify:
@destroy:
@save_thyself:
@restore_thyself:
@_gst_reserved:
<!-- ##### STRUCT GstPad ##### -->
<para>
</para>
<!-- ##### STRUCT GstPadClass ##### -->
<para>
</para>
@parent_class:
@_gst_reserved:
<!-- ##### STRUCT GstPadTemplate ##### -->
<para>
The padtemplate object.
</para>
<!-- ##### SIGNAL GstPadTemplate::pad-created ##### -->
<para>
This signal is fired when an element creates a pad from this
template.
</para>
@gstpadtemplate: the object which received the signal.
@arg1: The pad that was created.
<!-- ##### STRUCT GstPadTemplateClass ##### -->
<para>
</para>
@parent_class:
@pad_created:
@_gst_reserved:
<!-- ##### STRUCT GstElement ##### -->
<para>
</para>
<!-- ##### SIGNAL GstElement::eos ##### -->
<para>
</para>
@gstelement: the object which received the signal.
<!-- ##### SIGNAL GstElement::error ##### -->
<para>
</para>
@gstelement: the object which received the signal.
@arg1:
@arg2:
@arg3:
<!-- ##### SIGNAL GstElement::found-tag ##### -->
<para>
</para>
@gstelement: the object which received the signal.
@arg1:
@arg2:
<!-- ##### SIGNAL GstElement::new-pad ##### -->
<para>
</para>
@gstelement: the object which received the signal.
@arg1:
<!-- ##### SIGNAL GstElement::no-more-pads ##### -->
<para>
</para>
@gstelement: the object which received the signal.
<!-- ##### SIGNAL GstElement::pad-removed ##### -->
<para>
</para>
@gstelement: the object which received the signal.
@arg1:
<!-- ##### SIGNAL GstElement::state-change ##### -->
<para>
</para>
@gstelement: the object which received the signal.
@arg1:
@arg2:
<!-- ##### STRUCT GstElementClass ##### -->
<para>
</para>
@parent_class:
@details:
@elementfactory:
@padtemplates:
@numpadtemplates:
@state_change:
@new_pad:
@pad_removed:
@error:
@eos:
@found_tag:
@set_property:
@get_property:
@release_locks:
@get_event_masks:
@send_event:
@get_formats:
@convert:
@get_query_types:
@query:
@change_state:
@request_new_pad:
@release_pad:
@get_clock:
@set_clock:
@get_index:
@set_index:
@set_state:
@no_more_pads:
@_gst_reserved:
<!-- ##### STRUCT GstBin ##### -->
<para>
</para>
<!-- ##### SIGNAL GstBin::element-added ##### -->
<para>
</para>
@gstbin: the object which received the signal.
@arg1: the element that was added to the bin
<!-- ##### SIGNAL GstBin::element-removed ##### -->
<para>
</para>
@gstbin: the object which received the signal.
@arg1: the element that was removed from the bin
<!-- ##### SIGNAL GstBin::iterate ##### -->
<para>
This signal is emitted when a bin iterates, either automatically or
due to a #gst_bin_iterate() call. The return value is used to
determine if the object method handler processed any data.
In most normal cases, a user-provided signal handler should return
FALSE.
</para>
@gstbin: the object which received the signal.
@Returns: TRUE if the state of the bin was advanced.
<!-- ##### STRUCT GstBinClass ##### -->
<para>
</para>
@parent_class:
@add_element:
@remove_element:
@child_state_change:
@iterate:
@element_added:
@element_removed:
@_gst_reserved:
<!-- ##### STRUCT GstScheduler ##### -->
<para>
</para>
<!-- ##### STRUCT GstSchedulerClass ##### -->
<para>
</para>
@parent_class:
@setup:
@reset:
@add_element:
@remove_element:
@add_scheduler:
@remove_scheduler:
@state_transition:
@scheduling_change:
@lock_element:
@unlock_element:
@yield:
@interrupt:
@error:
@pad_link:
@pad_unlink:
@pad_select:
@clock_wait:
@iterate:
@show:
@object_sync:
@_gst_reserved:
<!-- ##### STRUCT GstEvent ##### -->
<para>
</para>
@data:
@type:
@timestamp:
@src:
<!-- ##### ENUM GstElementState ##### --> <!-- ##### ENUM GstElementState ##### -->
<para> <para>

43
docs/gst/tmpl/gsturi.sgml
View file

@ -31,56 +31,19 @@ and the element property that can handle a given URI.
<!-- ##### MACRO GST_URI_HANDLER ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_IS_URI_HANDLER ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_URI_HANDLER_GET_INTERFACE ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_URI_HANDLER_CLASS ##### -->
<para>
</para>
@obj:
<!-- ##### STRUCT GstURIHandler ##### --> <!-- ##### STRUCT GstURIHandler ##### -->
<para> <para>
</para> </para>
<!-- ##### STRUCT GstURIHandlerInterface ##### --> <!-- ##### MACRO GST_URI_TYPE_IS_VALID ##### -->
<para> <para>
</para> </para>
@parent: @type:
@new_uri:
@get_type:
@get_protocols:
@get_uri:
@set_uri:
@_gst_reserved:
<!-- ##### FUNCTION gst_uri_protocol_is_valid ##### --> <!-- ##### FUNCTION gst_uri_protocol_is_valid ##### -->
<para> <para>

8
docs/gst/tmpl/gsturitype.sgml
View file

@ -21,11 +21,3 @@ GstURIType
<!-- ##### FUNCTION gst_uri_get_uri_type ##### -->
<para>
</para>
@Returns:

2
docs/gst/tmpl/gstutils.sgml
View file

@ -2,7 +2,7 @@
gstutils gstutils
<!-- ##### SECTION Short_Description ##### --> <!-- ##### SECTION Short_Description ##### -->
various utility functions
<!-- ##### SECTION Long_Description ##### --> <!-- ##### SECTION Long_Description ##### -->
<para> <para>

2
docs/gst/tmpl/gstxml.sgml
View file

@ -2,7 +2,7 @@
GstXML GstXML
<!-- ##### SECTION Short_Description ##### --> <!-- ##### SECTION Short_Description ##### -->
XML save/restore operations of pipelines
<!-- ##### SECTION Long_Description ##### --> <!-- ##### SECTION Long_Description ##### -->
<para> <para>

16
docs/pwg/advanced-dparams.xml
View file

@ -50,7 +50,7 @@
<row> <row>
<entry><emphasis>Frequency and resolution of updates</emphasis></entry> <entry><emphasis>Frequency and resolution of updates</emphasis></entry>
<entry>Object properties will only be updated between calls to _get, _chain or _loop</entry> <entry>Object properties will only be updated between calls to _get, _chain or _loop</entry>
<entry>dparams can be updated at any rate independant of calls to _get, _chain or _loop up to sample-level accuracy</entry> <entry>dparams can be updated at any rate independent of calls to _get, _chain or _loop up to sample-level accuracy</entry>
</row> </row>
</tbody> </tbody>
</tgroup> </tgroup>
@ -124,7 +124,7 @@
</sect1> </sect1>
<sect1 id="section-dparam-define"> <sect1 id="section-dparam-define">
<title>Defining Parameter Specificiations</title> <title>Defining Parameter Specifications</title>
<para> <para>
You can define the dparams you need anywhere within your element but will You can define the dparams you need anywhere within your element but will
usually need to do so in only a couple of places: usually need to do so in only a couple of places:
@ -139,7 +139,7 @@
<para> <para>
Whenever a new pad is created so that parameters can affect data going Whenever a new pad is created so that parameters can affect data going
into or out of a specific pad. An example of this would be a mixer into or out of a specific pad. An example of this would be a mixer
element where a seperate volume parameter is needed on every pad. element where a separate volume parameter is needed on every pad.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -203,7 +203,7 @@
This method is the simplest and has the lowest overhead for parameters This method is the simplest and has the lowest overhead for parameters
which change less frequently than the sample rate. First you need which change less frequently than the sample rate. First you need
somewhere to store the parameter - this will usually be in your element's somewhere to store the parameter - this will usually be in your element's
stuct. struct.
</para> </para>
<programlisting> <programlisting>
struct _GstExample { struct _GstExample {
@ -248,7 +248,7 @@
<para> <para>
The following code illustrates an instance where you might want to use the The following code illustrates an instance where you might want to use the
callback method. If you had a volume dparam which was represented by a callback method. If you had a volume dparam which was represented by a
gfloat number, your element may only deal with integer arithmatic. The gfloat number, your element may only deal with integer arithmetic. The
callback could be used to calculate the integer scaler when the volume callback could be used to calculate the integer scaler when the volume
changes. First you will need somewhere to store these values. changes. First you will need somewhere to store these values.
</para> </para>
@ -281,7 +281,7 @@
); );
</programlisting> </programlisting>
<para> <para>
The callback function needs to conform to this signiture The callback function needs to conform to this signature
</para> </para>
<programlisting> <programlisting>
typedef void (*GstDPMUpdateFunction) (GValue *value, gpointer data); typedef void (*GstDPMUpdateFunction) (GValue *value, gpointer data);
@ -335,7 +335,7 @@ gst_example_update_volume(GValue *value, gpointer data)
<para> <para>
The array method is currently the least mature of the three methods and is The array method is currently the least mature of the three methods and is
not yet ready to be used in elements, but plugin writers should be aware not yet ready to be used in elements, but plugin writers should be aware
of its existance for the future. of its existence for the future.
</para> </para>
</sect2> </sect2>
</sect1> </sect1>
@ -491,7 +491,7 @@ example_chain (GstPad *pad, GstBuffer *buf)
</para> </para>
</sect2> </sect2>
<sect2 id="section-dparam-audio-video"> <sect2 id="section-dparam-audio-video">
<title>DParam Manager Modes</title> <title>Dynamic Parameters for Video</title>
<para> <para>
All of the explanation so far has presumed that the buffer contains audio All of the explanation so far has presumed that the buffer contains audio
data with many samples. Video should be regarded differently since a video data with many samples. Video should be regarded differently since a video

8
docs/pwg/advanced-events.xml
View file

@ -1,7 +1,7 @@
<chapter id="chapter-advanced-events"> <chapter id="chapter-advanced-events">
<title>Events: Seeking, Navigation and More</title> <title>Events: Seeking, Navigation and More</title>
<para> <para>
There are many different event types but only 2 ways they can travel accross There are many different event types but only 2 ways they can travel across
the pipeline: downstream or upstream. It is very important to understand the pipeline: downstream or upstream. It is very important to understand
how both of those methods work because if one element in the pipeline is not how both of those methods work because if one element in the pipeline is not
handling them correctly the whole event system of the pipeline is broken. handling them correctly the whole event system of the pipeline is broken.
@ -17,7 +17,7 @@
or directly in the function call arguments. So when receiving dataflow or directly in the function call arguments. So when receiving dataflow
from the sink pad you have to check first if this data chunk is an event. from the sink pad you have to check first if this data chunk is an event.
If that's the case you check what kind of event it is to react on relevant If that's the case you check what kind of event it is to react on relevant
ones and then forward others dowstream using ones and then forward others downstream using
<function>gst_pad_event_default</function>. Here is an example for both <function>gst_pad_event_default</function>. Here is an example for both
loop and chain based elements. loop and chain based elements.
</para> </para>
@ -157,7 +157,7 @@ gst_my_filter_handle_src_event (GstPad *pad,
<title>All Events Together</title> <title>All Events Together</title>
<para> <para>
In this chapter follows a list of all defined events that are currently In this chapter follows a list of all defined events that are currently
being used, plus how they should be used/interpretted. Events are stored being used, plus how they should be used/interpreted. Events are stored
in a <classname>GstEvent</classname> structure, which is simply a big in a <classname>GstEvent</classname> structure, which is simply a big
C union with the types for each event in it. For the next development C union with the types for each event in it. For the next development
cycle, we intend to switch events over to <classname>GstStructure</classname>, cycle, we intend to switch events over to <classname>GstStructure</classname>,
@ -186,7 +186,7 @@ gst_my_filter_handle_src_event (GstPad *pad,
downstream and set itself to EOS (<function>gst_element_set_eos ()</function>). downstream and set itself to EOS (<function>gst_element_set_eos ()</function>).
<function>gst_pad_event_default ()</function> takes care of all this, <function>gst_pad_event_default ()</function> takes care of all this,
so most elements do not need to support this event. Exceptions are so most elements do not need to support this event. Exceptions are
elements that explicitely need to close a resource down on EOS, and elements that explicitly need to close a resource down on EOS, and
N-to-1 elements. Note that the stream itself is <emphasis>not</emphasis> N-to-1 elements. Note that the stream itself is <emphasis>not</emphasis>
a resource that should be closed down on EOS! Applications might seek a resource that should be closed down on EOS! Applications might seek
back to a point before EOS and set the pipeline to PLAYING again. back to a point before EOS and set the pipeline to PLAYING again.

4
docs/pwg/building-boiler.xml
View file

@ -174,7 +174,7 @@ U gst-template/gst-app/src/Makefile.am
<sect1 id="section-boiler-details"> <sect1 id="section-boiler-details">
<title>GstElementDetails</title> <title>GstElementDetails</title>
<para> <para>
The GstElementDetails structure gives a heirarchical type for the element, The GstElementDetails structure gives a hierarchical type for the element,
a human-readable description of the element, as well as author and version a human-readable description of the element, as well as author and version
data. The entries are: data. The entries are:
</para> </para>
@ -182,7 +182,7 @@ U gst-template/gst-app/src/Makefile.am
<listitem><para> <listitem><para>
A long, english, name for the element. A long, english, name for the element.
</para></listitem><listitem><para> </para></listitem><listitem><para>
The type of the element, as a heirarchy. The heirarchy is defined by The type of the element, as a hierarchy. The hierarchy is defined by
specifying the top level category, followed by a "/", followed by the specifying the top level category, followed by a "/", followed by the
next level category, etc. The type should be defined according to the next level category, etc. The type should be defined according to the
guidelines elsewhere in this document. (FIXME: write the guidelines, and guidelines elsewhere in this document. (FIXME: write the guidelines, and

10
docs/random/ensonic/dparams.txt
View file

@ -1,11 +1,21 @@
$Id$ $Id$
* cleanup of dparams * cleanup of dparams
* even though it is long try to stick to the prefix "dparam" for the whole library
* e.g. avoid namespace clashes with "dataprotocol" which is using "dp" as well :-(
* resolve g_return_if_fail() into GST_WARNING and return() * resolve g_return_if_fail() into GST_WARNING and return()
in cases where the caller has to handle the problem in cases where the caller has to handle the problem
* rename * rename
GST_TYPE_DPSMOOTH to GST_TYPE_DPARAM_SMOOTH GST_TYPE_DPSMOOTH to GST_TYPE_DPARAM_SMOOTH
GST_TYPE_DP_LININT to GST_TYPE_DPARAM_LININT GST_TYPE_DP_LININT to GST_TYPE_DPARAM_LININT
there seems to be nobody using them, as they still look unfinished there seems to be nobody using them, as they still look unfinished
* move modes into extra modules
dparam_mode_synchronous
dparam_mode_asynchronous
dparam_mode_disabled
* documentation
* state of unitconvert
* state of sychronous params
* concept for global, voice params * concept for global, voice params

32
docs/random/ensonic/interfaces.txt Normal file
View file

@ -0,0 +1,32 @@
$Id$
* new general interfaces
* GST_TYPE_PRESET_MANAGER
- add preset managment
- API:
GList *get_presets();
void activate_preset_by_index(glong index);
void activate_preset_by_name(const gchar *name);
void add_current(const gchar *name);
void remove_preset_by_index(glong index);
void remove_preset_by_name(const gchar *name);
- features
- there should always be a default preset
- questions
- were and how do we store the presets?
* GST_TYPE_UI_HINT
- add hints to generate 'good' looking interfaces to elements
- API:
- features
- grouping of parameters
* new interfaces for audio applications
* GST_TYPE_MUSIC_GENERATOR
- add hints so that application can find out which params to use to
play notes and/or to trigger sounds
- API:
DParam *get_note_dparam();
DParam *get_trigger_dparam();
- questions
- can we use this to support multiple voices?

2
gst/gsterror.h
View file

@ -38,7 +38,7 @@ G_BEGIN_DECLS
* the core GStreamer library */ * the core GStreamer library */
/* FIXME: should we divide in numerical blocks so we can easily add /* FIXME: should we divide in numerical blocks so we can easily add
for example PAD errors later ? */ for example PAD errors later ? */
typedef enum typedef enum
{ {
GST_CORE_ERROR_FAILED = 1, GST_CORE_ERROR_FAILED = 1,
GST_CORE_ERROR_TOO_LAZY, GST_CORE_ERROR_TOO_LAZY,

6
gst/gstinterface.h
View file

@ -45,11 +45,13 @@ G_BEGIN_DECLS
typedef struct _GstImplementsInterface GstImplementsInterface; typedef struct _GstImplementsInterface GstImplementsInterface;
typedef struct _GstImplementsInterfaceClass GstImplementsInterfaceClass;
/* This small extra virtual function is here to provide an /* This small extra virtual function is here to provide an
* interface functionality on a per-instance basis rather * interface functionality on a per-instance basis rather
* than a per-class basis, which is the case for glib. * than a per-class basis, which is the case for glib.
*/ */
typedef struct _GstImplementsInterfaceClass { struct _GstImplementsInterfaceClass {
GTypeInterface parent; GTypeInterface parent;
/* virtual functions */ /* virtual functions */
@ -57,7 +59,7 @@ typedef struct _GstImplementsInterfaceClass {
GType iface_type); GType iface_type);
gpointer _gst_reserved[GST_PADDING]; gpointer _gst_reserved[GST_PADDING];
} GstImplementsInterfaceClass; };
#define GST_IMPLEMENTS_INTERFACE_CHECK_INSTANCE_CAST(obj, type, cast_t) \ #define GST_IMPLEMENTS_INTERFACE_CHECK_INSTANCE_CAST(obj, type, cast_t) \
((cast_t *) gst_implements_interface_cast ((obj), (type))) ((cast_t *) gst_implements_interface_cast ((obj), (type)))

2
gst/gstparse.h
View file

@ -2,7 +2,7 @@
* Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu> * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
* 2000 Wim Taymans <wtay@chello.be> * 2000 Wim Taymans <wtay@chello.be>
* *
* filename: * gstparse.h: get a pipeline from a text pipeline description
* *
* This library is free software; you can redistribute it and/or * This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public * modify it under the terms of the GNU Library General Public

2
gst/gstxml.h
View file

@ -2,7 +2,7 @@
* Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu> * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
* 2000 Wim Taymans <wim.taymans@chello.be> * 2000 Wim Taymans <wim.taymans@chello.be>
* *
* gstxml.h: Header for XML save/restore operations * gstxml.h: Header for XML save/restore operations of pipelines
* *
* This library is free software; you can redistribute it and/or * This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public * modify it under the terms of the GNU Library General Public

7
libs/gst/control/control.c
View file

@ -26,6 +26,13 @@
GST_DEBUG_CATEGORY (_gst_control_debug); GST_DEBUG_CATEGORY (_gst_control_debug);
#define GST_CAT_DEFAULT _gst_control_debug #define GST_CAT_DEFAULT _gst_control_debug
/**
* gst_control_init:
* @argc: pointer to application's argc
* @argv: pointer to application's argv
*
* Initializes the GStreamer control library, registering modes and units
*/
void void
gst_control_init (int *argc, char **argv[]) gst_control_init (int *argc, char **argv[])
{ {