mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-30 05:31:15 +00:00
Code Issues 1 Projects Releases Wiki Activity

enabled gobject hierarchy in the gtk-doc enabled the GstQueue class in the gtk-doc added a few missing symbols so tha...

Browse source 
Original commit message from CVS:
enabled gobject hierarchy in the gtk-doc
enabled the GstQueue class in the gtk-doc
added a few missing symbols so that the hierachy works
This commit is contained in:
Stefan Kost 2004-05-14 14:00:04 +00:00
parent afd9f869a8
commit 8178973c41
9 changed files with 311 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -4,7 +4,6 @@
<!ENTITY % version-entities SYSTEM "../version.entities">
%version-entities;
<!ENTITY Gst SYSTEM "xml/gst.xml">
<!ENTITY Gst SYSTEM "xml/gst.xml">
<!ENTITY GstAtomic SYSTEM "xml/gstatomic.xml">
<!ENTITY GstBin SYSTEM "xml/gstbin.xml">
<!ENTITY GstBuffer SYSTEM "xml/gstbuffer.xml">
@ -44,8 +43,9 @@
<!ENTITY GstUri SYSTEM "xml/gsturi.xml">
<!ENTITY GstValue SYSTEM "xml/gstvalue.xml">
<!ENTITY GstXML SYSTEM "xml/gstxml.xml">
<!-- these are elements without API docs
<!ENTITY GstQueue SYSTEM "xml/gstqueue.xml">
<!-- these are elements without API docs
...
-->
<!ENTITY GstAggregator SYSTEM "xml/gstaggregator.xml">
@ -61,7 +61,7 @@
<!ENTITY GstMD5Sink SYSTEM "xml/gstmd5sink.xml">
<!ENTITY GstTee SYSTEM "xml/gsttee.xml">
<!ENTITY gstreamer-tree-index SYSTEM "xml/tree_index.xml">
<!ENTITY gstreamer-tree-index SYSTEM "xml/tree_index.sgml">
<!ENTITY hash "#">
]>
@ -102,7 +102,9 @@ with some more specialized elements.</para>
&GstProbe;
&GstQuery;
<!-- no API docs
&GstQueue; -->
...
-->
&GstQueue;
&GstRegistry;
&GstRegistryPool;
&GstScheduler;
@ -160,14 +162,12 @@ with some more specialized elements.</para>
</chapter>
-->
<!--
<chapter id="gst-index">
<title>Index</title>
<sect1>
<title>Object Hierarchy</title>
&gstreamer-tree-index;
</sect1>
<chapter>
<title>Object Hierarchy</title>
&gstreamer-tree-index;
</chapter>
-->
<index/>
</book>

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

@ -258,6 +258,8 @@ gst_data_get_type
<SECTION>
<FILE>gstelement</FILE>
GstElement
GstElementClass
GstElementDetails
GST_ELEMENT_DETAILS
GST_IS_ELEMENT_DETAILS
@ -594,6 +596,8 @@ GST_OBJECT_GET_CLASS
<SECTION>
<FILE>gstpad</FILE>
GstPad
GstPadClass
GstRealPad
GstGhostPad
GstRealPadClass
@ -843,9 +847,9 @@ GST_PLUGIN_FEATURE_GET_CLASS
<FILE>gstqueue</FILE>
<TITLE>GstQueue</TITLE>
GstQueue
GstQueueClass
GstQueueSize
<SUBSECTION Standard>
GstQueueClass
GST_QUEUE
GST_IS_QUEUE
GST_TYPE_QUEUE
@ -899,6 +903,8 @@ GST_REGISTRY_GET_CLASS
<SECTION>
<FILE>gstscheduler</FILE>
GstScheduler
GstSchedulerClass
GstSchedulerFlags
GST_SCHEDULER_PARENT
GST_SCHEDULER_STATE

2
docs/gst/gstreamer.types
View file

@ -17,3 +17,5 @@ gst_scheduler_get_type
gst_index_get_type
gst_index_factory_get_type
gst_xml_get_type
gst_queue_get_type
gst_xml_registry_get_type

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

@ -65,6 +65,127 @@ and gst_element_set_clock(). You can wait for the clock to reach a given
<!-- basic object functions -->
<!-- ##### 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 GstElementDetails ##### -->
<para>
This struct is used to define public information about the element. It
@ -1132,6 +1253,14 @@ Sets the parent of an element.
<!-- clocking -->
<!-- ##### FUNCTION gst_element_no_more_pads ##### -->
<para>
</para>
@element:
<!-- ##### FUNCTION gst_element_factory_get_type ##### -->
<para>

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

@ -57,6 +57,20 @@ Last reviewed on December 13th, 2002 (0.5.0.1)
#GstPadTemplate, #GstElement, #GstEvent
</para>
<!-- ##### STRUCT GstPad ##### -->
<para>
</para>
<!-- ##### STRUCT GstPadClass ##### -->
<para>
</para>
@parent_class:
@_gst_reserved:
<!-- ##### STRUCT GstRealPad ##### -->
<para>

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

@ -31,6 +31,98 @@ The queue blocks by default.
</para>
<!-- ##### SIGNAL GstQueue::overrun ##### -->
<para>
</para>
@gstqueue: the object which received the signal.
<!-- ##### SIGNAL GstQueue::running ##### -->
<para>
</para>
@gstqueue: the object which received the signal.
<!-- ##### SIGNAL GstQueue::underrun ##### -->
<para>
</para>
@gstqueue: the object which received the signal.
<!-- ##### ARG GstQueue:block-timeout ##### -->
<para>
</para>
<!-- ##### ARG GstQueue:current-level-buffers ##### -->
<para>
</para>
<!-- ##### ARG GstQueue:current-level-bytes ##### -->
<para>
</para>
<!-- ##### ARG GstQueue:current-level-time ##### -->
<para>
</para>
<!-- ##### ARG GstQueue:leaky ##### -->
<para>
</para>
<!-- ##### ARG GstQueue:max-size-buffers ##### -->
<para>
</para>
<!-- ##### ARG GstQueue:max-size-bytes ##### -->
<para>
</para>
<!-- ##### ARG GstQueue:max-size-time ##### -->
<para>
</para>
<!-- ##### ARG GstQueue:may-deadlock ##### -->
<para>
</para>
<!-- ##### ARG GstQueue:min-threshold-buffers ##### -->
<para>
</para>
<!-- ##### ARG GstQueue:min-threshold-bytes ##### -->
<para>
</para>
<!-- ##### ARG GstQueue:min-threshold-time ##### -->
<para>
</para>
<!-- ##### STRUCT GstQueueClass ##### -->
<para>
</para>
@parent_class:
@underrun:
@running:
@overrun:
@_gst_reserved:
<!-- ##### STRUCT GstQueueSize ##### -->
<para>

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

@ -14,6 +14,40 @@ This is a base class for custom schedulers.
</para>
<!-- ##### 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:
<!-- ##### ENUM GstSchedulerFlags ##### -->
<para>
Flags for the scheduler

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

@ -124,22 +124,20 @@ template.
<!-- ##### SIGNAL GstElement::eos ##### -->
<para>
Signal emited when the element goes to PAUSED due to an end-of-stream
condition.
</para>
@gstelement: the object which received the signal.
<!-- ##### SIGNAL GstElement::error ##### -->
<para>
This signal is emitted when an element has encountered an error that caused
it to fail performing its function.
</para>
@gstelement: the object which received the signal.
@arg1: the original #GstElement that generated the error.
@arg2: a #GError containing the translated error message.
@arg3: a debug string providing additional untranslated debug information, or NULL.
@arg1:
@arg2:
@arg3:
<!-- ##### SIGNAL GstElement::found-tag ##### -->
<para>
@ -152,27 +150,34 @@ it to fail performing its function.
<!-- ##### SIGNAL GstElement::new-pad ##### -->
<para>
Is triggered whenever a new pad is added to an element.
</para>
@gstelement: the object which received the signal.
@arg1:
<!-- ##### SIGNAL GstElement::no-more-pads ##### -->
<para>
</para>
@gstelement: the object which received the signal.
@arg1: the new pad that was added
<!-- ##### SIGNAL GstElement::pad-removed ##### -->
<para>
Is triggered whenever a pad has been removed from the element.
</para>
@gstelement: the object which received the signal.
@arg1: The pad that was removed.
@arg1:
<!-- ##### SIGNAL GstElement::state-change ##### -->
<para>
Is triggered whenever the state of an element changes.
</para>
@gstelement: the object which received the signal.
@arg1: the new state of the object
@arg1:
@arg2:
<!-- ##### STRUCT GstElementClass ##### -->
@ -208,6 +213,7 @@ Is triggered whenever the state of an element changes.
@get_index:
@set_index:
@set_state:
@no_more_pads:
@_gst_reserved:
<!-- ##### STRUCT GstBin ##### -->

2
gst/gst.h
View file

@ -47,6 +47,7 @@
#include <gst/gstpad.h>
#include <gst/gstpipeline.h>
#include <gst/gstplugin.h>
#include <gst/gstqueue.h>
#include <gst/gstscheduler.h>
#include <gst/gststructure.h>
#include <gst/gstsystemclock.h>
@ -64,6 +65,7 @@
#include <gst/gstparse.h>
#include <gst/gstregistry.h>
#include <gst/gstregistrypool.h>
#include <gst/registries/gstxmlregistry.h>
/* API compatibility stuff */
#include <gst/gstcompat.h>