From: Wim Taymans Date: Sun, 9 Dec 2001 13:17:13 +0000 (+0000) Subject: Updated the API docs X-Git-Tag: BRANCH-BUILD1-200112101-ROOT~33 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=3e5a0a6d725209e28b0f4f427b6d844712b5e772;p=platform%2Fupstream%2Fgstreamer.git Updated the API docs Original commit message from CVS: Updated the API docs --- diff --git a/docs/gst/gstreamer-docs.sgml b/docs/gst/gstreamer-docs.sgml index 8e6f224..a89d623 100644 --- a/docs/gst/gstreamer-docs.sgml +++ b/docs/gst/gstreamer-docs.sgml @@ -22,6 +22,7 @@ + @@ -48,6 +49,7 @@ + @@ -90,6 +92,7 @@ with some more specialized elements. &GstProps; &GstQueue; &GstScheduler; + &GstSchedulerFactory; &GstThread; &GstTimeCache; &GstType; @@ -127,6 +130,8 @@ with some more specialized elements. &GstPipefilter; &GstIdentity; + &GstStatistics; + &GstTee; diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt index 1be9bf4..0828583 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
gstscheduler -GstSchedule +GstScheduler 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 -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
+gstschedulerfactory +GstSchedulerFactory +gst_schedulerfactory_create +gst_schedulerfactory_destroy +gst_schedulerfactory_find +gst_schedulerfactory_get_list +gst_schedulerfactory_make +gst_schedulerfactory_new + +gst_schedulerfactory_get_type +GST_IS_SCHEDULERFACTORY +GST_IS_SCHEDULERFACTORY_CLASS +GST_SCHEDULERFACTORY +GST_SCHEDULERFACTORY_CLASS +GST_TYPE_SCHEDULERFACTORY +GstSchedulerFactory +GstSchedulerFactoryClass +
+ + +
gstbin GstBin GstBinFlags @@ -346,12 +360,12 @@ GST_BIN_CLASS_FAST GST_IS_BIN GST_IS_BIN_CLASS gst_bin_details -_GstBinChain
gstparse GstParse +GstParseErrors gst_parse_launch
@@ -466,6 +480,7 @@ GST_TYPE_EVENT GstElement 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
+gststatistics +GstStatistics + +GstStatistics +GstStatisticsClass +stats +GST_STATISTICS +GST_IS_STATISTICS +GST_TYPE_STATISTICS +gst_statistics_get_type +GST_STATISTICS_CLASS +GST_IS_STATISTICS_CLASS +
+ + +
gsttypefind GstTypeFind diff --git a/docs/gst/gstreamer.hierarchy b/docs/gst/gstreamer.hierarchy index a5e36a2..362276e 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 a16572f..93beaa3 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 61d1925..89a073e 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. +@object: diff --git a/docs/gst/tmpl/gstautoplugfactory.sgml b/docs/gst/tmpl/gstautoplugfactory.sgml index 649c2aa..4742b30 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 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. 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 8bdb5db..c3716e4 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 + + +The maximun number of states. + + + + 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: @@ -159,6 +166,14 @@ Query wether this element is in the End Of Stream state. @obj: The element to query + + +Query wether this element can handle events. + + +@obj: The element to query + + Get the parent object of this element. @@ -436,6 +451,14 @@ instead. @elem: + + + + + +@element: + + @@ -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: @@ -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. - - - -Is trigered whenever a new ghost pad is added to an element - - -@gstelement: the object which received the signal. -@arg1: the new ghost pad that was added - - - - - - -@gstelement: the object which received the signal. -@arg1: The ghost pad that was removed. - Is trigered whenever an error occured diff --git a/docs/gst/tmpl/gstpad.sgml b/docs/gst/tmpl/gstpad.sgml index 9d493e0..03b15ad 100644 --- a/docs/gst/tmpl/gstpad.sgml +++ b/docs/gst/tmpl/gstpad.sgml @@ -670,6 +670,15 @@ Destroy the pad. @Returns: + + + + + +@pad: +@event: + + diff --git a/docs/gst/tmpl/gstpadtemplate.sgml b/docs/gst/tmpl/gstpadtemplate.sgml index 39d714e..2ddd5f6 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(). +@object: +@name_template: +@direction: +@presence: +@caps: @@ -202,11 +207,3 @@ Get the padtemplate of the factory created with GST_PADTEMPLATE_FACTORY() @Returns: - - - - - -@gstpadtemplate: the object which received the signal. -@arg1: - diff --git a/docs/gst/tmpl/gstparse.sgml b/docs/gst/tmpl/gstparse.sgml index 44961a5..88ba7cb 100644 --- a/docs/gst/tmpl/gstparse.sgml +++ b/docs/gst/tmpl/gstparse.sgml @@ -44,6 +44,15 @@ can be made with . + + + + + +@GST_PARSE_ERROR_SYNTAX: +@GST_PARSE_ERROR_CREATING_ELEMENT: +@GST_PARSE_ERROR_NOSUCH_ELEMENT: + diff --git a/docs/gst/tmpl/gstreamer-unused.sgml b/docs/gst/tmpl/gstreamer-unused.sgml index 900eee8..3d58560 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. + + +Fast macro to add an element to the scheduler. + + +@sched: The scheduler to add the element to. +@element: The element to add to the scheduler. + + + +Fast macro to disable the element. + + +@sched: The scheduler. +@element: The element to disable. + + + +Fast macro to enable the element in the scheduler. + + +@sched: The scheduler. +@element: The element to activate. + + + +Fast macro to perform one iteration of the scheduler. + + +@sched: The scheduler to iterate. + + + +Fast macro to lock a given element. + + +@sched: The scheduler. +@element: The element to lock. + + + +Fast macro to connect two pads. + + +@sched: The scheduler. +@srcpad: The source pad. +@sinkpad: The sink pad. + + + +Fast macro to disconnect two pads. + + +@sched: The scheduler. +@srcpad: The source pad. +@sinkpad: The sink pad. + + + +Fast macro to remove an element from the scheduler. + + +@sched: The scheduler to remove the element from. +@element: The element to remove from the scheduler. + + + +Handy macro to check for a non NULL scheduler. The next block of statements +will only be axecuted if the scheduler is not NULL. + + +@sched: the scheduler to query. + + + +Fast macro to unlock a given element. + + +@sched: The scheduler. +@element: The element to unlock. + @@ -2417,6 +2498,23 @@ Get the size of the file. + + + + + +@gstelement: the object which received the signal. +@arg1: The ghost pad that was removed. + + + + +Is trigered whenever a new ghost pad is added to an element + + +@gstelement: the object which received the signal. +@arg1: the new ghost pad that was added + @@ -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 + + + + + +@gstpadtemplate: the object which received the signal. +@arg1: + @@ -2694,6 +2800,19 @@ Specify wether the queue blocks or not. + + + + + +@sched: +@disabled: +@elements: +@num_elements: +@entry: +@cothreaded_elements: +@schedule: + @@ -2808,6 +2927,13 @@ Flags for the GstSrc element + + +TRUE if the thread should be created. + + + + @@ -4788,6 +4914,95 @@ Call the EOS function of the pad @connection: + + + + + +@sched: +@element: + + + + + + +@sched: +@element: + + + + + + +@sched: +@element: + + + + + + +@sched: +@Returns: + + + + + + +@parent: +@Returns: + + + + + + +@sched: +@srcpad: +@sinkpad: + + + + + + +@sched: +@srcpad: +@sinkpad: + + + + + + +@sched: +@padlist: +@Returns: + + + + + + +@sched: +@element: + + + + + + +@sched: + + + + + + +@Returns: + diff --git a/docs/gst/tmpl/gstscheduler.sgml b/docs/gst/tmpl/gstscheduler.sgml index 3786040..132cb46 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. - + @sched: -@disabled: -@elements: -@num_elements: -@entry: -@cothreaded_elements: -@schedule: - - - -Handy macro to check for a non NULL scheduler. The next block of statements -will only be axecuted if the scheduler is not NULL. - - -@sched: the scheduler to query. - - - - -Fast macro to add an element to the scheduler. - - -@sched: The scheduler to add the element to. -@element: The element to add to the scheduler. - - - - -Fast macro to remove an element from the scheduler. - - -@sched: The scheduler to remove the element from. -@element: The element to remove from the scheduler. - - - - -Fast macro to enable the element in the scheduler. - - -@sched: The scheduler. -@element: The element to activate. - - - - -Fast macro to disable the element. - - -@sched: The scheduler. -@element: The element to disable. - - - - -Fast macro to lock a given element. - - -@sched: The scheduler. -@element: The element to lock. - - - - -Fast macro to unlock a given element. - - -@sched: The scheduler. -@element: The element to unlock. - - - - -Fast macro to connect two pads. - - -@sched: The scheduler. -@srcpad: The source pad. -@sinkpad: The sink pad. - - - - -Fast macro to disconnect two pads. - - -@sched: The scheduler. -@srcpad: The source pad. -@sinkpad: The sink pad. - - - - -Fast macro to perform one iteration of the scheduler. - - -@sched: The scheduler to iterate. +@element: - + -@parent: -@Returns: +@sched: +@element: - + @@ -145,7 +50,7 @@ Fast macro to perform one iteration of the scheduler. @element: - + @@ -154,68 +59,68 @@ Fast macro to perform one iteration of the scheduler. @element: - + @sched: -@element: +@srcpad: +@sinkpad: - + @sched: -@element: +@srcpad: +@sinkpad: - + @sched: -@srcpad: -@sinkpad: +@padlist: +@Returns: - + @sched: -@srcpad: -@sinkpad: +@Returns: - + @sched: -@padlist: -@Returns: - + @sched: -@Returns: +@element: - + @sched: +@element: diff --git a/docs/gst/tmpl/gstschedulerfactory.sgml b/docs/gst/tmpl/gstschedulerfactory.sgml new file mode 100644 index 0000000..7a02fb8 --- /dev/null +++ b/docs/gst/tmpl/gstschedulerfactory.sgml @@ -0,0 +1,89 @@ + +GstSchedulerFactory + + +Create schedulers from a factory + + + +A schedulerfactory is used to create instances of a scheduler. It +can be added to a #GstPlugin as it extends #GstPluginFeature. + + +Use gst_schedulerfactory_new() to create a new scheduler which can be registered +to a plugin with gst_plugin_add_feature(). + + +Use gst_schedulerfactory_find() to find the named schedulerfactory. +or use gst_schedulerfactory_get_list() to get a list of all available schedulers. + + +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. + + +Use gst_schedulerfactory_destroy() to remove the factory from the global list. + + + + + + + + + + + + +@factory: +@parent: +@Returns: + + + + + + + +@factory: + + + + + + + +@name: +@Returns: + + + + + + + +@Returns: + + + + + + + +@name: +@parent: +@Returns: + + + + + + + +@name: +@longdesc: +@type: +@Returns: + + diff --git a/docs/gst/tmpl/gststatistics.sgml b/docs/gst/tmpl/gststatistics.sgml new file mode 100644 index 0000000..0966d3e --- /dev/null +++ b/docs/gst/tmpl/gststatistics.sgml @@ -0,0 +1,69 @@ + +GstStatistics + + +Provide statistics about data that passes this plugin + + + +The plugin doesn't alter the data but provides statistics about +the data stream, such as buffers/bytes/events etc. + + + + + + + + + + + + +@gststatistics: the object which received the signal. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/gst/tmpl/gstthread.sgml b/docs/gst/tmpl/gstthread.sgml index 29151cb..85f271d 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: -@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 @@ -45,9 +43,3 @@ Thread flags: @Returns: - - -TRUE if the thread should be created. - - -