diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/gst/Makefile.am | 14 | ||||
| -rw-r--r-- | docs/gst/gstreamer-docs.sgml | 5 | ||||
| -rw-r--r-- | docs/gst/gstreamer-sections.txt | 98 | ||||
| -rw-r--r-- | docs/gst/gstreamer.hierarchy | 7 | ||||
| -rw-r--r-- | docs/gst/gstreamer.types.in | 3 | ||||
| -rw-r--r-- | docs/gst/tmpl/gstautoplug.sgml | 1 | ||||
| -rw-r--r-- | docs/gst/tmpl/gstautoplugfactory.sgml | 4 | ||||
| -rw-r--r-- | docs/gst/tmpl/gstelement.sgml | 43 | ||||
| -rw-r--r-- | docs/gst/tmpl/gstpad.sgml | 9 | ||||
| -rw-r--r-- | docs/gst/tmpl/gstpadtemplate.sgml | 13 | ||||
| -rw-r--r-- | docs/gst/tmpl/gstparse.sgml | 9 | ||||
| -rw-r--r-- | docs/gst/tmpl/gstreamer-unused.sgml | 215 | ||||
| -rw-r--r-- | docs/gst/tmpl/gstscheduler.sgml | 141 | ||||
| -rw-r--r-- | docs/gst/tmpl/gstschedulerfactory.sgml | 89 | ||||
| -rw-r--r-- | docs/gst/tmpl/gststatistics.sgml | 69 | ||||
| -rw-r--r-- | docs/gst/tmpl/gstthread.sgml | 8 |
16 files changed, 533 insertions, 195 deletions
diff --git a/docs/gst/Makefile.am b/docs/gst/Makefile.am index 7373723915..05b6aaeccc 100644 --- a/docs/gst/Makefile.am +++ b/docs/gst/Makefile.am @@ -9,10 +9,10 @@ DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml # The directory containing the source code (if it contains documentation). DOC_SOURCE_DIR=$(top_srcdir)/gst -# thomas +# FIXME : # there's something wrong with gstreamer-sections.txt not being in the dist -# maybe it doesn't resolve -EXTRA_DIST = gstreamer.types.in gstreamer.hierarchy $(DOC_MODULE)-sections.txt $(DOC_MAIN_SGML_FILE) +# maybe it doesn't resolve; we're adding it below for now +EXTRA_DIST = gstreamer.types.in gstreamer.hierarchy $(DOC_MODULE)-sections.txt gstreamer-sections.txt $(DOC_MAIN_SGML_FILE) HTML_DIR=$(datadir)/gstreamer/html @@ -91,7 +91,9 @@ scanobj: $(srcdir)/$(DOC_MODULE).types gtkdoc-scanobj --module=$(DOC_MODULE) gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) +# FIXME: this is nasty, we shouldn't have to do this, HELP tmpl: scanobj gstreamer-decl.txt + if test ! -e gstreamer-sections.txt; then cp $(top_srcdir)/docs/gst/gstreamer-sections.txt .; fi gtkdoc-mktmpl --module=$(DOC_MODULE) sgml: tmpl @@ -104,8 +106,14 @@ html: sgml clean-local: rm -rf *~ *.bak *.signals *-unused.txt *.args *.o *.lo .libs sgml html +# FIXME : thomas added all sgml files and some other things to make +# make distcheck work distclean-local: clean rm -rf $(DOC_MODULE)-decl-list.txt + rm -rf gstreamer-*.txt + rm -rf tmpl/*.sgml + rm gstreamer.hierarchy + rm *.stamp install-data-local: html/book1.html $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR) diff --git a/docs/gst/gstreamer-docs.sgml b/docs/gst/gstreamer-docs.sgml index 8e6f224caf..a89d623451 100644 --- a/docs/gst/gstreamer-docs.sgml +++ b/docs/gst/gstreamer-docs.sgml @@ -22,6 +22,7 @@ <!entity GstPluginFeature SYSTEM "sgml/gstpluginfeature.sgml"> <!entity GstThread SYSTEM "sgml/gstthread.sgml"> <!entity GstScheduler SYSTEM "sgml/gstscheduler.sgml"> +<!entity GstSchedulerFactory SYSTEM "sgml/gstschedulerfactory.sgml"> <!entity GstTrace SYSTEM "sgml/gsttrace.sgml"> <!entity GstType SYSTEM "sgml/gsttype.sgml"> <!entity GstTypeFactory SYSTEM "sgml/gsttypefactory.sgml"> @@ -48,6 +49,7 @@ <!entity GstFdSink SYSTEM "sgml/gstfdsink.sgml"> <!entity GstIdentity SYSTEM "sgml/gstidentity.sgml"> <!entity GstPipefilter SYSTEM "sgml/gstpipefilter.sgml"> +<!entity GstStatistics SYSTEM "sgml/gststatistics.sgml"> <!entity GstTee SYSTEM "sgml/gsttee.sgml"> <!entity gstreamer-tree-index SYSTEM "sgml/tree_index.sgml"> @@ -90,6 +92,7 @@ with some more specialized elements.</para> &GstProps; &GstQueue; &GstScheduler; + &GstSchedulerFactory; &GstThread; &GstTimeCache; &GstType; @@ -127,6 +130,8 @@ with some more specialized elements.</para> &GstPipefilter; &GstIdentity; + &GstStatistics; + &GstTee; </chapter> diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt index 1be9bf4e24..0828583c54 100644 --- a/docs/gst/gstreamer-sections.txt +++ b/docs/gst/gstreamer-sections.txt @@ -34,6 +34,9 @@ G_TYPE_STRING G_TYPE_POINTER G_TYPE_BOXED G_TYPE_PARAM +G_CSET_A_2_Z +G_CSET_DIGITS +G_CSET_a_2_z G_BEGIN_DECLS G_E G_END_DECLS @@ -190,6 +193,7 @@ g_value_get_string g_value_set_string g_value_get_pointer g_value_set_pointer +g_strcanon g_string_append_printf G_OBJECT g_cclosure_marshal_VOID__OBJECT @@ -286,42 +290,52 @@ GST_DISABLE_LOADSAVE_REGISTRY <SECTION> <FILE>gstscheduler</FILE> -<TITLE>GstSchedule</TITLE> +<TITLE>GstScheduler</TITLE> GST_SCHED_PARENT -GstScheduleChain -GST_SCHEDULE_SAFETY -GST_SCHEDULE_ADD_ELEMENT -GST_SCHEDULE_REMOVE_ELEMENT -GST_SCHEDULE_ENABLE_ELEMENT -GST_SCHEDULE_DISABLE_ELEMENT -GST_SCHEDULE_LOCK_ELEMENT -GST_SCHEDULE_UNLOCK_ELEMENT -GST_SCHEDULE_PAD_CONNECT -GST_SCHEDULE_PAD_DISCONNECT -GST_SCHEDULE_ITERATE -gst_schedule_new -gst_schedule_add_element -gst_schedule_remove_element -gst_schedule_enable_element -gst_schedule_disable_element -gst_schedule_pad_connect -gst_schedule_pad_disconnect -gst_schedule_pad_select -gst_schedule_iterate -gst_schedule_show +gst_scheduler_add_element +gst_scheduler_remove_element +gst_scheduler_enable_element +gst_scheduler_disable_element +gst_scheduler_pad_connect +gst_scheduler_pad_disconnect +gst_scheduler_pad_select +gst_scheduler_iterate +gst_scheduler_show +gst_scheduler_lock_element +gst_scheduler_unlock_element <SUBSECTION Standard> -GstSchedule -GST_SCHEDULE -GST_SCHEDULE_FAST -GST_IS_SCHEDULE -GST_TYPE_SCHEDULE -gst_schedule_get_type -GST_SCHEDULE_CLASS -GST_SCHEDULE_CLASS_FAST -GST_IS_SCHEDULE_CLASS +GstScheduler +GstSchedulerClass +gst_scheduler_get_type +GST_SCHEDULER +GST_IS_SCHEDULER +GST_TYPE_SCHEDULER +GST_SCHEDULER_CLASS +GST_IS_SCHEDULER_CLASS </SECTION> <SECTION> +<FILE>gstschedulerfactory</FILE> +<TITLE>GstSchedulerFactory</TITLE> +gst_schedulerfactory_create +gst_schedulerfactory_destroy +gst_schedulerfactory_find +gst_schedulerfactory_get_list +gst_schedulerfactory_make +gst_schedulerfactory_new +<SUBSECTION Standard> +gst_schedulerfactory_get_type +GST_IS_SCHEDULERFACTORY +GST_IS_SCHEDULERFACTORY_CLASS +GST_SCHEDULERFACTORY +GST_SCHEDULERFACTORY_CLASS +GST_TYPE_SCHEDULERFACTORY +GstSchedulerFactory +GstSchedulerFactoryClass +</SECTION> + + +<SECTION> <FILE>gstbin</FILE> <TITLE>GstBin</TITLE> GstBinFlags @@ -346,12 +360,12 @@ GST_BIN_CLASS_FAST GST_IS_BIN GST_IS_BIN_CLASS gst_bin_details -_GstBinChain </SECTION> <SECTION> <FILE>gstparse</FILE> <TITLE>GstParse</TITLE> +GstParseErrors gst_parse_launch </SECTION> @@ -466,6 +480,7 @@ GST_TYPE_EVENT <TITLE>GstElement</TITLE> GstElementState GstElementStateReturn +GST_NUM_STATES GST_STATE GST_STATE_PENDING GST_STATE_TRANSITION @@ -479,6 +494,7 @@ GstElementFlags GST_ELEMENT_IS_THREAD_SUGGESTED GST_ELEMENT_IS_COTHREAD_STOPPING GST_ELEMENT_IS_EOS +GST_ELEMENT_IS_EVENT_AWARE GST_ELEMENT_PARENT GST_ELEMENT_NAME GST_ELEMENT_PADS @@ -509,6 +525,7 @@ gst_element_connect gst_element_disconnect gst_element_set_state gst_element_get_state +gst_element_wait_state_change gst_element_statename gst_element_error gst_element_get_factory @@ -726,6 +743,7 @@ gst_pad_peek gst_pad_select gst_pad_selectv gst_pad_send_event +gst_pad_event_default gst_pad_set_event_function @@ -1300,6 +1318,22 @@ gst_pipefilter_get_type </SECTION> <SECTION> +<FILE>gststatistics</FILE> +<TITLE>GstStatistics</TITLE> +<SUBSECTION Standard> +GstStatistics +GstStatisticsClass +stats +GST_STATISTICS +GST_IS_STATISTICS +GST_TYPE_STATISTICS +gst_statistics_get_type +GST_STATISTICS_CLASS +GST_IS_STATISTICS_CLASS +</SECTION> + + +<SECTION> <FILE>gsttypefind</FILE> <TITLE>GstTypeFind</TITLE> <SUBSECTION Standard> diff --git a/docs/gst/gstreamer.hierarchy b/docs/gst/gstreamer.hierarchy index a5e36a2515..362276e962 100644 --- a/docs/gst/gstreamer.hierarchy +++ b/docs/gst/gstreamer.hierarchy @@ -45,14 +45,11 @@ GtkObject GstPipefilter GstIdentity GstQueue + GstStatistics GstTypeFind GstPad - GstPadTemplate GstPluginFeature GstAutoplugFactory GstTypeFactory GstElementFactory - GstSchedule - GstAutoplug - GstStaticAutoplug - GstStaticAutoplugRender + GstSchedulerFactory diff --git a/docs/gst/gstreamer.types.in b/docs/gst/gstreamer.types.in index a16572f7f3..93beaa3999 100644 --- a/docs/gst/gstreamer.types.in +++ b/docs/gst/gstreamer.types.in @@ -10,10 +10,10 @@ gst_pad_get_type gst_thread_get_type gst_tee_get_type gst_plugin_feature_get_type -gst_schedule_get_type gst_autoplugfactory_get_type gst_typefactory_get_type gst_elementfactory_get_type +gst_schedulerfactory_get_type gst_xml_get_type gst_aggregator_get_type @@ -31,5 +31,6 @@ gst_pipefilter_get_type gst_identity_get_type gst_queue_get_type +gst_statistics_get_type gst_typefind_get_type diff --git a/docs/gst/tmpl/gstautoplug.sgml b/docs/gst/tmpl/gstautoplug.sgml index 61d1925a41..89a073ea53 100644 --- a/docs/gst/tmpl/gstautoplug.sgml +++ b/docs/gst/tmpl/gstautoplug.sgml @@ -98,6 +98,7 @@ Use the regular gst_object_destroy() call to destroy the autoplugger. </para> +@object: <!-- ##### ENUM GstAutoplugFlags ##### --> <para> diff --git a/docs/gst/tmpl/gstautoplugfactory.sgml b/docs/gst/tmpl/gstautoplugfactory.sgml index 649c2aace7..4742b30636 100644 --- a/docs/gst/tmpl/gstautoplugfactory.sgml +++ b/docs/gst/tmpl/gstautoplugfactory.sgml @@ -19,8 +19,8 @@ or use gst_autoplugfactory_get_list() to get a list of all available autoplugge </para> <para> Once an autoplugfactory has been obtained use gst_autoplugfactory_create() to -instantiate a real autopugger. Optionally gst_autoplugfactory_make() to create -and autoplugger from the named factory. +instantiate a real autoplugger. Optionally gst_autoplugfactory_make() to create +a autoplugger from the named factory. </para> <para> Use gst_autoplugfactory_destroy() to remove the factory from the global list. diff --git a/docs/gst/tmpl/gstelement.sgml b/docs/gst/tmpl/gstelement.sgml index 8bdb5dbfcc..c3716e4d09 100644 --- a/docs/gst/tmpl/gstelement.sgml +++ b/docs/gst/tmpl/gstelement.sgml @@ -53,6 +53,13 @@ can return after a state change. @GST_STATE_SUCCESS: the element successfully changed its state @GST_STATE_ASYNC: the element will asynchronously change its state as soon as possible +<!-- ##### MACRO GST_NUM_STATES ##### --> +<para> +The maximun number of states. +</para> + + + <!-- ##### MACRO GST_STATE ##### --> <para> This macro returns the current state of the element. @@ -132,7 +139,7 @@ This enum defines the standard flags that an element may have. @GST_ELEMENT_NEW_LOOPFUNC: @GST_ELEMENT_COTHREAD_STOPPING: @GST_ELEMENT_USE_COTHREAD: -@GST_ELEMENT_EOS: +@GST_ELEMENT_EVENT_AWARE: @GST_ELEMENT_FLAG_LAST: <!-- ##### MACRO GST_ELEMENT_IS_THREAD_SUGGESTED ##### --> @@ -159,6 +166,14 @@ Query wether this element is in the End Of Stream state. @obj: The element to query +<!-- ##### MACRO GST_ELEMENT_IS_EVENT_AWARE ##### --> +<para> +Query wether this element can handle events. +</para> + +@obj: The element to query + + <!-- ##### MACRO GST_ELEMENT_PARENT ##### --> <para> Get the parent object of this element. @@ -436,6 +451,14 @@ instead. @elem: +<!-- ##### FUNCTION gst_element_wait_state_change ##### --> +<para> + +</para> + +@element: + + <!-- ##### FUNCTION gst_element_statename ##### --> <para> @@ -488,6 +511,7 @@ Is trigered whenever the state of an element changes @gstelement: the object which received the signal. @arg1: the new state of the object +@arg2: <!-- ##### SIGNAL GstElement::new-pad ##### --> <para> @@ -505,23 +529,6 @@ Is trigered whenever a new pad is added to an element @gstelement: the object which received the signal. @arg1: The pad that was removed. -<!-- ##### SIGNAL GstElement::new-ghost-pad ##### --> -<para> - -Is trigered whenever a new ghost pad is added to an element -</para> - -@gstelement: the object which received the signal. -@arg1: the new ghost pad that was added - -<!-- ##### SIGNAL GstElement::ghost-pad-removed ##### --> -<para> - -</para> - -@gstelement: the object which received the signal. -@arg1: The ghost pad that was removed. - <!-- ##### SIGNAL GstElement::error ##### --> <para> Is trigered whenever an error occured diff --git a/docs/gst/tmpl/gstpad.sgml b/docs/gst/tmpl/gstpad.sgml index 9d493e01bf..03b15ade78 100644 --- a/docs/gst/tmpl/gstpad.sgml +++ b/docs/gst/tmpl/gstpad.sgml @@ -670,6 +670,15 @@ Destroy the pad. @Returns: +<!-- ##### FUNCTION gst_pad_event_default ##### --> +<para> + +</para> + +@pad: +@event: + + <!-- ##### FUNCTION gst_pad_set_event_function ##### --> <para> diff --git a/docs/gst/tmpl/gstpadtemplate.sgml b/docs/gst/tmpl/gstpadtemplate.sgml index 39d714ed94..2ddd5f6066 100644 --- a/docs/gst/tmpl/gstpadtemplate.sgml +++ b/docs/gst/tmpl/gstpadtemplate.sgml @@ -86,6 +86,11 @@ gst_element_request_pad_by_name() or gst_element_request_compatible_pad(). </para> +@object: +@name_template: +@direction: +@presence: +@caps: <!-- ##### MACRO GST_PADTEMPLATE_CAPS ##### --> <para> @@ -202,11 +207,3 @@ Get the padtemplate of the factory created with GST_PADTEMPLATE_FACTORY() @Returns: -<!-- ##### SIGNAL GstPadTemplate::pad-created ##### --> -<para> - -</para> - -@gstpadtemplate: the object which received the signal. -@arg1: - diff --git a/docs/gst/tmpl/gstparse.sgml b/docs/gst/tmpl/gstparse.sgml index 44961a548f..88ba7cbd1a 100644 --- a/docs/gst/tmpl/gstparse.sgml +++ b/docs/gst/tmpl/gstparse.sgml @@ -44,6 +44,15 @@ can be made with <option>{}</option>. </para> +<!-- ##### ENUM GstParseErrors ##### --> +<para> + +</para> + +@GST_PARSE_ERROR_SYNTAX: +@GST_PARSE_ERROR_CREATING_ELEMENT: +@GST_PARSE_ERROR_NOSUCH_ELEMENT: + <!-- ##### FUNCTION gst_parse_launch ##### --> <para> diff --git a/docs/gst/tmpl/gstreamer-unused.sgml b/docs/gst/tmpl/gstreamer-unused.sgml index 900eee8d71..3d585603ea 100644 --- a/docs/gst/tmpl/gstreamer-unused.sgml +++ b/docs/gst/tmpl/gstreamer-unused.sgml @@ -1453,6 +1453,87 @@ Get the QoS function of the real pad. @pad: the real pad to query. +<!-- ##### MACRO GST_SCHEDULE_ADD_ELEMENT ##### --> +<para> +Fast macro to add an element to the scheduler. +</para> + +@sched: The scheduler to add the element to. +@element: The element to add to the scheduler. + +<!-- ##### MACRO GST_SCHEDULE_DISABLE_ELEMENT ##### --> +<para> +Fast macro to disable the element. +</para> + +@sched: The scheduler. +@element: The element to disable. + +<!-- ##### MACRO GST_SCHEDULE_ENABLE_ELEMENT ##### --> +<para> +Fast macro to enable the element in the scheduler. +</para> + +@sched: The scheduler. +@element: The element to activate. + +<!-- ##### MACRO GST_SCHEDULE_ITERATE ##### --> +<para> +Fast macro to perform one iteration of the scheduler. +</para> + +@sched: The scheduler to iterate. + +<!-- ##### MACRO GST_SCHEDULE_LOCK_ELEMENT ##### --> +<para> +Fast macro to lock a given element. +</para> + +@sched: The scheduler. +@element: The element to lock. + +<!-- ##### MACRO GST_SCHEDULE_PAD_CONNECT ##### --> +<para> +Fast macro to connect two pads. +</para> + +@sched: The scheduler. +@srcpad: The source pad. +@sinkpad: The sink pad. + +<!-- ##### MACRO GST_SCHEDULE_PAD_DISCONNECT ##### --> +<para> +Fast macro to disconnect two pads. +</para> + +@sched: The scheduler. +@srcpad: The source pad. +@sinkpad: The sink pad. + +<!-- ##### MACRO GST_SCHEDULE_REMOVE_ELEMENT ##### --> +<para> +Fast macro to remove an element from the scheduler. +</para> + +@sched: The scheduler to remove the element from. +@element: The element to remove from the scheduler. + +<!-- ##### MACRO GST_SCHEDULE_SAFETY ##### --> +<para> +Handy macro to check for a non NULL scheduler. The next block of statements +will only be axecuted if the scheduler is not NULL. +</para> + +@sched: the scheduler to query. + +<!-- ##### MACRO GST_SCHEDULE_UNLOCK_ELEMENT ##### --> +<para> +Fast macro to unlock a given element. +</para> + +@sched: The scheduler. +@element: The element to unlock. + <!-- ##### MACRO GST_SHOW_INFO ##### --> <para> @@ -2417,6 +2498,23 @@ Get the size of the file. </para> +<!-- ##### SIGNAL GstElement::ghost-pad-removed ##### --> +<para> + +</para> + +@gstelement: the object which received the signal. +@arg1: The ghost pad that was removed. + +<!-- ##### SIGNAL GstElement::new-ghost-pad ##### --> +<para> + +Is trigered whenever a new ghost pad is added to an element +</para> + +@gstelement: the object which received the signal. +@arg1: the new ghost pad that was added + <!-- ##### STRUCT GstElementClass ##### --> <para> @@ -2628,6 +2726,14 @@ The function that will be called when a QoS message is sent. @pad: the pad that sent the QoS message @qos_message: the message +<!-- ##### SIGNAL GstPadTemplate::pad-created ##### --> +<para> + +</para> + +@gstpadtemplate: the object which received the signal. +@arg1: + <!-- ##### STRUCT GstPipelineClass ##### --> <para> @@ -2694,6 +2800,19 @@ Specify wether the queue blocks or not. </para> +<!-- ##### STRUCT GstScheduleChain ##### --> +<para> + +</para> + +@sched: +@disabled: +@elements: +@num_elements: +@entry: +@cothreaded_elements: +@schedule: + <!-- ##### STRUCT GstSineSrc ##### --> <para> @@ -2808,6 +2927,13 @@ Flags for the GstSrc element </para> +<!-- ##### ARG GstThread:create-thread ##### --> +<para> +TRUE if the thread should be created. + +</para> + + <!-- ##### STRUCT GstThreadClass ##### --> <para> @@ -4788,6 +4914,95 @@ Call the EOS function of the pad @connection: +<!-- ##### FUNCTION gst_schedule_add_element ##### --> +<para> + +</para> + +@sched: +@element: + +<!-- ##### FUNCTION gst_schedule_disable_element ##### --> +<para> + +</para> + +@sched: +@element: + +<!-- ##### FUNCTION gst_schedule_enable_element ##### --> +<para> + +</para> + +@sched: +@element: + +<!-- ##### FUNCTION gst_schedule_iterate ##### --> +<para> + +</para> + +@sched: +@Returns: + +<!-- ##### FUNCTION gst_schedule_new ##### --> +<para> + +</para> + +@parent: +@Returns: + +<!-- ##### FUNCTION gst_schedule_pad_connect ##### --> +<para> + +</para> + +@sched: +@srcpad: +@sinkpad: + +<!-- ##### FUNCTION gst_schedule_pad_disconnect ##### --> +<para> + +</para> + +@sched: +@srcpad: +@sinkpad: + +<!-- ##### FUNCTION gst_schedule_pad_select ##### --> +<para> + +</para> + +@sched: +@padlist: +@Returns: + +<!-- ##### FUNCTION gst_schedule_remove_element ##### --> +<para> + +</para> + +@sched: +@element: + +<!-- ##### FUNCTION gst_schedule_show ##### --> +<para> + +</para> + +@sched: + +<!-- ##### FUNCTION gst_schedulerfactory_get_type ##### --> +<para> + +</para> + +@Returns: + <!-- ##### FUNCTION gst_sinesrc_get_type ##### --> <para> diff --git a/docs/gst/tmpl/gstscheduler.sgml b/docs/gst/tmpl/gstscheduler.sgml index 378604017b..132cb46f6e 100644 --- a/docs/gst/tmpl/gstscheduler.sgml +++ b/docs/gst/tmpl/gstscheduler.sgml @@ -23,120 +23,25 @@ Get the parent #GstElement of this scheduler. @sched: the scheduler to query. -<!-- ##### STRUCT GstScheduleChain ##### --> +<!-- ##### FUNCTION gst_scheduler_add_element ##### --> <para> </para> @sched: -@disabled: -@elements: -@num_elements: -@entry: -@cothreaded_elements: -@schedule: - -<!-- ##### MACRO GST_SCHEDULE_SAFETY ##### --> -<para> -Handy macro to check for a non NULL scheduler. The next block of statements -will only be axecuted if the scheduler is not NULL. -</para> - -@sched: the scheduler to query. - - -<!-- ##### MACRO GST_SCHEDULE_ADD_ELEMENT ##### --> -<para> -Fast macro to add an element to the scheduler. -</para> - -@sched: The scheduler to add the element to. -@element: The element to add to the scheduler. - - -<!-- ##### MACRO GST_SCHEDULE_REMOVE_ELEMENT ##### --> -<para> -Fast macro to remove an element from the scheduler. -</para> - -@sched: The scheduler to remove the element from. -@element: The element to remove from the scheduler. - - -<!-- ##### MACRO GST_SCHEDULE_ENABLE_ELEMENT ##### --> -<para> -Fast macro to enable the element in the scheduler. -</para> - -@sched: The scheduler. -@element: The element to activate. - - -<!-- ##### MACRO GST_SCHEDULE_DISABLE_ELEMENT ##### --> -<para> -Fast macro to disable the element. -</para> - -@sched: The scheduler. -@element: The element to disable. - - -<!-- ##### MACRO GST_SCHEDULE_LOCK_ELEMENT ##### --> -<para> -Fast macro to lock a given element. -</para> - -@sched: The scheduler. -@element: The element to lock. - - -<!-- ##### MACRO GST_SCHEDULE_UNLOCK_ELEMENT ##### --> -<para> -Fast macro to unlock a given element. -</para> - -@sched: The scheduler. -@element: The element to unlock. - - -<!-- ##### MACRO GST_SCHEDULE_PAD_CONNECT ##### --> -<para> -Fast macro to connect two pads. -</para> - -@sched: The scheduler. -@srcpad: The source pad. -@sinkpad: The sink pad. - - -<!-- ##### MACRO GST_SCHEDULE_PAD_DISCONNECT ##### --> -<para> -Fast macro to disconnect two pads. -</para> - -@sched: The scheduler. -@srcpad: The source pad. -@sinkpad: The sink pad. - - -<!-- ##### MACRO GST_SCHEDULE_ITERATE ##### --> -<para> -Fast macro to perform one iteration of the scheduler. -</para> - -@sched: The scheduler to iterate. +@element: -<!-- ##### FUNCTION gst_schedule_new ##### --> +<!-- ##### FUNCTION gst_scheduler_remove_element ##### --> <para> </para> -@parent: -@Returns: +@sched: +@element: -<!-- ##### FUNCTION gst_schedule_add_element ##### --> +<!-- ##### FUNCTION gst_scheduler_enable_element ##### --> <para> </para> @@ -145,7 +50,7 @@ Fast macro to perform one iteration of the scheduler. @element: -<!-- ##### FUNCTION gst_schedule_remove_element ##### --> +<!-- ##### FUNCTION gst_scheduler_disable_element ##### --> <para> </para> @@ -154,68 +59,68 @@ Fast macro to perform one iteration of the scheduler. @element: -<!-- ##### FUNCTION gst_schedule_enable_element ##### --> +<!-- ##### FUNCTION gst_scheduler_pad_connect ##### --> <para> </para> @sched: -@element: +@srcpad: +@sinkpad: -<!-- ##### FUNCTION gst_schedule_disable_element ##### --> +<!-- ##### FUNCTION gst_scheduler_pad_disconnect ##### --> <para> </para> @sched: -@element: +@srcpad: +@sinkpad: -<!-- ##### FUNCTION gst_schedule_pad_connect ##### --> +<!-- ##### FUNCTION gst_scheduler_pad_select ##### --> <para> </para> @sched: -@srcpad: -@sinkpad: +@padlist: +@Returns: -<!-- ##### FUNCTION gst_schedule_pad_disconnect ##### --> +<!-- ##### FUNCTION gst_scheduler_iterate ##### --> <para> </para> @sched: -@srcpad: -@sinkpad: +@Returns: -<!-- ##### FUNCTION gst_schedule_pad_select ##### --> +<!-- ##### FUNCTION gst_scheduler_show ##### --> <para> </para> @sched: -@padlist: -@Returns: -<!-- ##### FUNCTION gst_schedule_iterate ##### --> +<!-- ##### FUNCTION gst_scheduler_lock_element ##### --> <para> </para> @sched: -@Returns: +@element: -<!-- ##### FUNCTION gst_schedule_show ##### --> +<!-- ##### FUNCTION gst_scheduler_unlock_element ##### --> <para> </para> @sched: +@element: diff --git a/docs/gst/tmpl/gstschedulerfactory.sgml b/docs/gst/tmpl/gstschedulerfactory.sgml new file mode 100644 index 0000000000..7a02fb8806 --- /dev/null +++ b/docs/gst/tmpl/gstschedulerfactory.sgml @@ -0,0 +1,89 @@ +<!-- ##### SECTION Title ##### --> +GstSchedulerFactory + +<!-- ##### SECTION Short_Description ##### --> +Create schedulers from a factory + +<!-- ##### SECTION Long_Description ##### --> +<para> +A schedulerfactory is used to create instances of a scheduler. It +can be added to a #GstPlugin as it extends #GstPluginFeature. +</para> +<para> +Use gst_schedulerfactory_new() to create a new scheduler which can be registered +to a plugin with gst_plugin_add_feature(). +</para> +<para> +Use gst_schedulerfactory_find() to find the named schedulerfactory. +or use gst_schedulerfactory_get_list() to get a list of all available schedulers. +</para> +<para> +Once an schedulerfactory has been obtained use gst_schedulerfactory_create() to +instantiate a real scheduler. Optionally gst_schedulerfactory_make() to create +a scheduler from the named factory. +</para> +<para> +Use gst_schedulerfactory_destroy() to remove the factory from the global list. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### FUNCTION gst_schedulerfactory_create ##### --> +<para> + +</para> + +@factory: +@parent: +@Returns: + + +<!-- ##### FUNCTION gst_schedulerfactory_destroy ##### --> +<para> + +</para> + +@factory: + + +<!-- ##### FUNCTION gst_schedulerfactory_find ##### --> +<para> + +</para> + +@name: +@Returns: + + +<!-- ##### FUNCTION gst_schedulerfactory_get_list ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION gst_schedulerfactory_make ##### --> +<para> + +</para> + +@name: +@parent: +@Returns: + + +<!-- ##### FUNCTION gst_schedulerfactory_new ##### --> +<para> + +</para> + +@name: +@longdesc: +@type: +@Returns: + + diff --git a/docs/gst/tmpl/gststatistics.sgml b/docs/gst/tmpl/gststatistics.sgml new file mode 100644 index 0000000000..0966d3e7f5 --- /dev/null +++ b/docs/gst/tmpl/gststatistics.sgml @@ -0,0 +1,69 @@ +<!-- ##### SECTION Title ##### --> +GstStatistics + +<!-- ##### SECTION Short_Description ##### --> +Provide statistics about data that passes this plugin + +<!-- ##### SECTION Long_Description ##### --> +<para> +The plugin doesn't alter the data but provides statistics about +the data stream, such as buffers/bytes/events etc. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SIGNAL GstStatistics::update ##### --> +<para> + +</para> + +@gststatistics: the object which received the signal. + +<!-- ##### ARG GstStatistics:buffers ##### --> +<para> + +</para> + +<!-- ##### ARG GstStatistics:bytes ##### --> +<para> + +</para> + +<!-- ##### ARG GstStatistics:events ##### --> +<para> + +</para> + +<!-- ##### ARG GstStatistics:buffer-update-freq ##### --> +<para> + +</para> + +<!-- ##### ARG GstStatistics:bytes-update-freq ##### --> +<para> + +</para> + +<!-- ##### ARG GstStatistics:event-update-freq ##### --> +<para> + +</para> + +<!-- ##### ARG GstStatistics:update-on-eos ##### --> +<para> + +</para> + +<!-- ##### ARG GstStatistics:update ##### --> +<para> + +</para> + +<!-- ##### ARG GstStatistics:silent ##### --> +<para> + +</para> + diff --git a/docs/gst/tmpl/gstthread.sgml b/docs/gst/tmpl/gstthread.sgml index 29151cb704..85f271d45b 100644 --- a/docs/gst/tmpl/gstthread.sgml +++ b/docs/gst/tmpl/gstthread.sgml @@ -23,11 +23,9 @@ to be dealt with in the separate thread. Thread flags: </para> -@GST_THREAD_CREATE: The thread is being created. @GST_THREAD_STATE_STARTED: @GST_THREAD_STATE_SPINNING: The thread is runnning @GST_THREAD_STATE_REAPING: The thread is ending. -@GST_THREAD_STATE_ELEMENT_CHANGED: @GST_THREAD_FLAG_LAST: subclass use this to start their enumeration <!-- ##### STRUCT GstThread ##### --> @@ -45,9 +43,3 @@ Thread flags: @Returns: -<!-- ##### ARG GstThread:create-thread ##### --> -<para> -TRUE if the thread should be created. - -</para> - |