From 9ba56f4181e10b4d8609d444e6e844a68f339796 Mon Sep 17 00:00:00 2001 From: Wim Taymans Date: Fri, 19 Oct 2001 22:49:35 +0000 Subject: [PATCH] Get the API docs back in shape. This batch of patches contain the updates that don't require source code comment chan... Original commit message from CVS: Get the API docs back in shape. This batch of patches contain the updates that don't require source code comment changes. --- docs/gst/gstreamer-docs.sgml | 25 +- docs/gst/gstreamer-sections.txt | 319 ++++-- docs/gst/gstreamer.hierarchy | 27 +- docs/gst/gstreamer.types.in | 2 + docs/gst/tmpl/cothreads.sgml | 2 +- docs/gst/tmpl/gobject2gtk.sgml | 16 + docs/gst/tmpl/gst.sgml | 20 +- docs/gst/tmpl/gstaggregator.sgml | 42 + docs/gst/tmpl/gstarch.sgml | 20 +- docs/gst/tmpl/gstautoplug.sgml | 4 +- docs/gst/tmpl/gstbuffer.sgml | 81 +- docs/gst/tmpl/gstbufferpool.sgml | 92 ++ docs/gst/tmpl/gstcaps.sgml | 2 +- docs/gst/tmpl/gstclock.sgml | 14 +- docs/gst/tmpl/gstdata.sgml | 24 + docs/gst/tmpl/gstelement.sgml | 35 +- docs/gst/tmpl/gstevent.sgml | 121 +++ docs/gst/tmpl/gstextratypes.sgml | 2 +- docs/gst/tmpl/gstfakesink.sgml | 5 + docs/gst/tmpl/gstfakesrc.sgml | 35 + docs/gst/tmpl/gstfilesrc.sgml | 51 + docs/gst/tmpl/gstinfo.sgml | 64 +- docs/gst/tmpl/gstlog.sgml | 7 - docs/gst/tmpl/gstobject.sgml | 9 + docs/gst/tmpl/gstpad.sgml | 128 ++- docs/gst/tmpl/gstplugin.sgml | 98 +- docs/gst/tmpl/gstpluginfeature.sgml | 32 + docs/gst/tmpl/gstreamer-unused.sgml | 1879 ++++++++++++++++++++++++++++++----- docs/gst/tmpl/gstscheduler.sgml | 76 +- docs/gst/tmpl/gstsinesrc.sgml | 46 - docs/gst/tmpl/gsttimecache.sgml | 130 +++ docs/gst/tmpl/gsttrace.sgml | 2 +- docs/gst/tmpl/gsttype.sgml | 23 +- docs/gst/tmpl/gsttypefactory.sgml | 67 ++ docs/gst/tmpl/gstutils.sgml | 20 + 35 files changed, 2983 insertions(+), 537 deletions(-) create mode 100644 docs/gst/tmpl/gobject2gtk.sgml create mode 100644 docs/gst/tmpl/gstaggregator.sgml create mode 100644 docs/gst/tmpl/gstdata.sgml create mode 100644 docs/gst/tmpl/gstevent.sgml create mode 100644 docs/gst/tmpl/gstfilesrc.sgml create mode 100644 docs/gst/tmpl/gstpluginfeature.sgml delete mode 100644 docs/gst/tmpl/gstsinesrc.sgml create mode 100644 docs/gst/tmpl/gsttimecache.sgml create mode 100644 docs/gst/tmpl/gsttypefactory.sgml diff --git a/docs/gst/gstreamer-docs.sgml b/docs/gst/gstreamer-docs.sgml index 1f318a6..b387539 100644 --- a/docs/gst/gstreamer-docs.sgml +++ b/docs/gst/gstreamer-docs.sgml @@ -1,10 +1,11 @@ + + @@ -15,34 +16,37 @@ + + + + + + - - - ]> @@ -65,20 +69,26 @@ with some more specialized elements. &GstBuffer; &GstBufferPool; &GstCaps; + &GstClock; &GstCpu; + &GstData; &GstElement; + &GstEvent; &GstInfo; &GstObject; &GstPad; &GstParse; &GstPipeline; &GstPlugin; + &GstPluginFeature; &GstProps; &GstQueue; - &GstThread; &GstScheduler; + &GstThread; + &GstTimeCache; &GstTrace; &GstType; + &GstTypeFactory; &GstTypeFind; &GstUtils; &GstXML; @@ -119,16 +129,17 @@ with some more specialized elements. + &GstAggregator; + &GstFakeSrc; &GstFakeSink; + &GstDiskSrc; &GstDiskSink; &GstHttpSrc; - &GstSineSrc; - &GstFdSrc; &GstFdSink; diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt index ef1fa23..548d4a5 100644 --- a/docs/gst/gstreamer-sections.txt +++ b/docs/gst/gstreamer-sections.txt @@ -2,6 +2,9 @@
gobject2gtk +GObject + +g_object_get_type GObject G_MAXUINT G_MAXULONG @@ -30,6 +33,30 @@ G_TYPE_STRING G_TYPE_POINTER G_TYPE_BOXED G_TYPE_PARAM +G_BEGIN_DECLS +G_E +G_END_DECLS +G_LN10 +G_LN2 +G_PI +G_PI_2 +G_PI_4 +G_SIGNAL_NO_HOOKS +G_SIGNAL_NO_RECURSE +G_SIGNAL_RUN_CLEANUP +G_SQRT2 +G_TYPE_INSTANCE_GET_CLASS +G_VALUE_HOLDS_BOOLEAN +G_VALUE_HOLDS_CHAR +G_VALUE_HOLDS_DOUBLE +G_VALUE_HOLDS_FLOAT +G_VALUE_HOLDS_INT +G_VALUE_HOLDS_LONG +G_VALUE_HOLDS_POINTER +G_VALUE_HOLDS_STRING +G_VALUE_HOLDS_UCHAR +G_VALUE_HOLDS_UINT +G_VALUE_HOLDS_ULONG g_cclosure_marshal_VOID__VOID g_cclosure_marshal_VOID__BOOLEAN g_cclosure_marshal_VOID__CHAR @@ -50,6 +77,31 @@ g_cclosure_marshal_STRING__OBJECT_POINTER g_cclosure_marshal_VOID__UINT_POINTER gst_marshal_VOID__OBJECT_POINTER gst_marshal_VOID__INT_INT +gst_marshal_VOID__POINTER +gst_marshal_VOID__VOID +gst_marshal_VOID__INT +gst_marshal_VOID__STRING +gst_marshal_VOID__OBJECT +gst_marshal_VOID__BOOLEAN +g2g_object_run_dispose +g_list_delete_link +g_log_domain_gstreamer +g_object_run_dispose +g_signal_handlers_destroy +g_signal_list_ids +g_slist_delete_link +g_string_printf +g_string_printfa +g_type_class_peek_parent +g_type_init +g_type_is_a +g_type_parent +g_value_copy +g_value_get_char +g_value_get_uchar +g_value_set_char +g_value_set_uchar +g_value_unset g_object_get_property g_object_set GType @@ -135,9 +187,6 @@ g_value_set_string g_value_get_pointer g_value_set_pointer G_OBJECT -GObject -g_object_get_type - g_cclosure_marshal_VOID__OBJECT G_IS_OBJECT G_TYPE_OBJECT @@ -173,11 +222,12 @@ cothread_trylock gst Gst gst_init +gst_version gst_main gst_main_quit -GST_VERSION_MICRO GST_VERSION_MAJOR GST_VERSION_MINOR +GST_VERSION_MICRO
@@ -200,22 +250,24 @@ gst_debug_disable_category GST_DEBUG_ENTER GST_DEBUG_LEAVE GST_DEBUG -GST_DEBUG_ENABLE_CATEGORIES GST_DEBUG_FUNCPTR -GST_DEBUG_ENABLED GST_DEBUG_FUNCPTR_NAME GST_DEBUG_PAD_NAME GST_DEBUG_THREAD_ARGS GST_DEBUG_THREAD_FORMAT GST_DEBUG_ELEMENT -GST_DEBUG_CHAR_MODE GST_ERROR GST_ERROR_OBJECT GstDebugHandler gst_default_debug_handler gst_default_error_handler +gst_debug_print_stack_trace GstInfoHandler GstErrorHandler + +GST_DEBUG_CHAR_MODE +GST_DEBUG_ENABLED +GST_DEBUG_ENABLE_CATEGORIES
@@ -224,6 +276,7 @@ GstErrorHandler GST_TYPE_FILENAME gst_extra_get_filename_type +GST_DISABLE_LOADSAVE_REGISTRY
@@ -248,6 +301,7 @@ 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 @@ -301,8 +355,19 @@ GST_ARCH_PRESETJMP
+gstdata +GstData +GstData + +GST_DATA +GST_DATA_TYPE +
+ +
gstbuffer GstBuffer +GST_IS_BUFFER +GST_BUFFER GST_BUFFER_FLAGS GST_BUFFER_FLAG_IS_SET GST_BUFFER_FLAG_SET @@ -314,14 +379,13 @@ GST_BUFFER_MAXSIZE GST_BUFFER_TIMESTAMP GST_BUFFER_BUFFERPOOL GST_BUFFER_POOL_PRIVATE -GST_BUFFER_POOL_LOCK GST_BUFFER_LOCK GST_BUFFER_TRYLOCK GST_BUFFER_UNLOCK GST_BUFFER_PARENT GST_BUFFER_MAXAGE - - +GST_BUFFER_COPY_FUNC +GST_BUFFER_FREE_FUNC GstBufferCopyFunc GstBufferFreeFunc GstBufferFlags @@ -335,30 +399,60 @@ gst_buffer_ref gst_buffer_ref_by_count gst_buffer_unref gst_buffer_destroy +gst_buffer_is_span_fast +gst_buffer_merge +gst_buffer_span + -GST_BUFFER +GST_TYPE_BUFFER
gstbufferpool +GstBufferPool GstBufferPool -GstBufferPoolCreateFunction -GstBufferPoolDestroyFunction +GstBufferPoolBufferNewFunction +GstBufferPoolDestroyHook +GST_BUFFER_POOL_UNLOCK +GST_BUFFER_POOL_LOCK gst_buffer_pool_new -gst_buffer_pool_new_buffer -gst_buffer_pool_destroy_buffer gst_buffer_pool_ref gst_buffer_pool_ref_by_count gst_buffer_pool_unref -gst_buffer_pool_set_create_function -gst_buffer_pool_set_destroy_function gst_buffer_pool_destroy gst_buffer_pool_get_default +gst_buffer_pool_set_user_data +gst_buffer_pool_get_user_data +gst_buffer_pool_set_buffer_copy_function +gst_buffer_pool_set_buffer_free_function +gst_buffer_pool_set_buffer_new_function +gst_buffer_pool_set_destroy_hook GST_BUFFER_POOL
+gstevent +GstEvent +GstEventType +GST_EVENT_TYPE +GST_EVENT_TIMESTAMP +GstSeekType +GST_EVENT_SEEK_TYPE +GST_EVENT_SEEK_OFFSET +GST_EVENT_SEEK_FLUSH +GstEvent +gst_event_new +gst_event_free +gst_event_new_seek +gst_event_new_flush + +GST_EVENT +GST_IS_EVENT +GST_TYPE_EVENT +
+ +
gstelement GstElement GstElementState @@ -385,7 +479,7 @@ GstElement GstElementDetails GstElementFactory GstElementLoopFunction -gst_element_new +gst_element_class_add_padtemplate gst_element_destroy gst_element_set_loop_function gst_element_set_name @@ -407,13 +501,13 @@ gst_element_request_pad_by_name gst_element_connect gst_element_disconnect gst_element_set_state +gst_element_get_state gst_element_statename gst_element_error gst_element_get_factory gst_element_signal_eos gst_element_restore_thyself gst_elementfactory_new -gst_elementfactory_destroy gst_elementfactory_add_padtemplate gst_elementfactory_find gst_elementfactory_get_list @@ -421,16 +515,23 @@ gst_elementfactory_can_src_caps gst_elementfactory_can_sink_caps gst_elementfactory_create gst_elementfactory_make -gst_elementfactory_save_thyself -gst_elementfactory_load_thyself GstElementClass GST_TYPE_ELEMENT GST_ELEMENT GST_ELEMENT_CLASS +GST_ELEMENT_FAST +GST_ELEMENT_CLASS_FAST GST_IS_ELEMENT GST_IS_ELEMENT_CLASS gst_element_get_type +gst_elementfactory_get_type +GstElementFactoryClass +GST_TYPE_ELEMENTFACTORY +GST_ELEMENTFACTORY +GST_ELEMENTFACTORY_CLASS +GST_IS_ELEMENTFACTORY +GST_IS_ELEMENTFACTORY_CLASS
@@ -449,8 +550,6 @@ gst_autoplugfactory_find gst_autoplugfactory_get_list gst_autoplugfactory_create gst_autoplugfactory_make -gst_autoplugfactory_save_thyself -gst_autoplugfactory_load_thyself GST_AUTOPLUG GST_IS_AUTOPLUG @@ -458,10 +557,18 @@ GST_TYPE_AUTOPLUG gst_autoplug_get_type GST_AUTOPLUG_CLASS GST_IS_AUTOPLUG_CLASS +gst_autoplugfactory_get_type +GstAutoplugFactoryClass +GST_TYPE_AUTOPLUGFACTORY +GST_AUTOPLUGFACTORY +GST_AUTOPLUGFACTORY_CLASS +GST_IS_AUTOPLUGFACTORY +GST_IS_AUTOPLUGFACTORY_CLASS
gstclock +GstClock GstClockTime GstClockTimeDiff GST_CLOCK_DIFF @@ -477,9 +584,9 @@ gst_clock_current_diff
gstlog -GST_SHOW_INFO gst_info +GST_SHOW_INFO
@@ -499,7 +606,6 @@ GST_OBJECT_PARENT GST_OBJECT_NAME GST_OBJECT_FLOATING GST_OBJECT_DESTROYED -gst_object_new gst_object_check_uniqueness gst_object_set_parent gst_object_get_parent @@ -511,6 +617,7 @@ gst_object_unref gst_object_sink gst_object_destroy gst_object_save_thyself +gst_object_restore_thyself gst_object_get_path_string gst_class_signal_emit_by_name gst_class_signal_connect @@ -522,6 +629,8 @@ GST_OBJECT GST_OBJECT_CLASS GST_IS_OBJECT GST_IS_OBJECT_CLASS +GST_OBJECT_FAST +GST_OBJECT_CLASS_FAST
@@ -542,18 +651,15 @@ GstPad GstPadChainFunction GstPadGetFunction GstPadGetRegionFunction -GstPadQoSFunction -GstPadEOSFunction GstPadNewCapsFunction GstPadBufferPoolFunction GstPadNegotiateReturn GstPadNegotiateFunction -GstPadPushFunction -GstPadPullFunction GstRegionType GstPadPullRegionFunction +GstPadEventFunction GstPadDirection GstPadFlags @@ -565,8 +671,6 @@ gst_pad_set_chain_function gst_pad_set_get_function gst_pad_set_getregion_function gst_pad_set_negotiate_function -gst_pad_set_qos_function -gst_pad_set_eos_function gst_pad_set_newcaps_function gst_pad_set_bufferpool_function gst_pad_set_caps @@ -586,20 +690,25 @@ gst_pad_remove_ghost_pad gst_pad_get_ghost_pad_list gst_pad_get_peer gst_pad_connect +gst_pad_try_connect gst_pad_disconnect gst_pad_push gst_pad_pull gst_pad_pullregion gst_pad_get_bufferpool -gst_pad_set_eos -gst_pad_handle_qos -gst_pad_eos gst_pad_load_and_connect gst_pad_negotiate_proxy gst_pad_renegotiate gst_pad_get_padtemplate gst_pad_get_padtemplate_caps -gst_pad_eos_func +gst_pad_event +gst_pad_ghost_save_thyself +gst_pad_peek +gst_pad_select +gst_pad_selectv +gst_pad_send_event +gst_pad_set_event_function + GstRealPad @@ -614,14 +723,15 @@ GST_RPAD_BUFPEN GST_RPAD_CHAINFUNC GST_RPAD_GETFUNC GST_RPAD_GETREGIONFUNC -GST_RPAD_PUSHFUNC -GST_RPAD_PULLFUNC GST_RPAD_PULLREGIONFUNC -GST_RPAD_QOSFUNC -GST_RPAD_EOSFUNC GST_RPAD_NEGOTIATEFUNC GST_RPAD_NEWCAPSFUNC GST_RPAD_BUFFERPOOLFUNC +GST_RPAD_CHAINHANDLER +GST_RPAD_EVENTFUNC +GST_RPAD_EVENTHANDLER +GST_RPAD_GETHANDLER + GST_GPAD_REALPAD GstGhostPad @@ -647,24 +757,33 @@ GstPadClass GST_TYPE_PAD GST_PAD GST_PAD_CLASS +GST_PAD_FAST +GST_PAD_CLASS_FAST GST_IS_PAD GST_IS_PAD_CLASS +GST_IS_PAD_FAST gst_pad_get_type GstRealPadClass GST_TYPE_REAL_PAD GST_REAL_PAD GST_REAL_PAD_CLASS +GST_REAL_PAD_FAST +GST_REAL_PAD_CLASS_FAST GST_IS_REAL_PAD GST_IS_REAL_PAD_CLASS +GST_IS_REAL_PAD_FAST gst_real_pad_get_type GstGhostPadClass GST_TYPE_GHOST_PAD GST_GHOST_PAD GST_GHOST_PAD_CLASS +GST_GHOST_PAD_FAST +GST_GHOST_PAD_CLASS_FAST GST_IS_GHOST_PAD GST_IS_GHOST_PAD_CLASS +GST_IS_GHOST_PAD_FAST gst_ghost_pad_get_type GstPadTemplateClass @@ -700,6 +819,9 @@ gst_pipeline_details GstPlugin GstPluginInitFunc GstPluginDesc +GST_PLUGIN_DESC +GST_PLUGIN_DESC_DYNAMIC +GST_PLUGIN_DESC_STATIC gst_plugin_new gst_plugin_set_name gst_plugin_get_name @@ -712,20 +834,31 @@ gst_plugin_load gst_plugin_load_absolute gst_plugin_add_path gst_library_load -gst_plugin_add_factory -gst_plugin_add_type -gst_plugin_add_autoplugger gst_plugin_find gst_plugin_get_list -gst_plugin_get_factory_list -gst_plugin_get_type_list -gst_plugin_get_autoplug_list -gst_plugin_load_elementfactory -gst_plugin_load_typefactory -gst_plugin_load_autoplugfactory gst_plugin_load_thyself gst_plugin_save_thyself +gst_plugin_add_feature +gst_plugin_get_feature_list +gst_plugin_load_plugin +gst_plugin_unload_all + + +
+ +
+gstpluginfeature +GstPluginFeature +gst_plugin_feature_ensure_loaded +gst_plugin_feature_unload_thyself +GstPluginFeature +GST_PLUGIN_FEATURE +GST_IS_PLUGIN_FEATURE +GST_TYPE_PLUGIN_FEATURE +gst_plugin_feature_get_type +GST_PLUGIN_FEATURE_CLASS +GST_IS_PLUGIN_FEATURE_CLASS
@@ -783,20 +916,33 @@ gst_trace_add_entry
gsttype GstType -GstTypeFindFunc GstType -GstTypeFactory gst_type_register gst_type_find_by_mime gst_type_find_by_ext gst_type_find_by_id gst_type_get_list -gst_typefactory_load_thyself -gst_typefactory_save_thyself
+gsttypefactory +GstTypeFactory +GstTypeFactory +GstTypeDefinition +GstTypeFindFunc +gst_typefactory_new +gst_typefactory_find + +GST_TYPEFACTORY +GST_IS_TYPEFACTORY +GST_TYPE_TYPEFACTORY +gst_typefactory_get_type +GST_TYPEFACTORY_CLASS +GST_IS_TYPEFACTORY_CLASS +
+ +
gstcaps GstCaps GST_CAPS_LOCK @@ -888,6 +1034,8 @@ gst_util_get_double_arg gst_util_get_string_arg gst_util_get_pointer_arg gst_util_dump_mem +gst_print_element_args +gst_print_pad_caps
@@ -922,6 +1070,31 @@ gst_cpu_get_flags
+gsttimecache +GstTimeCache +GstTimeCacheEntry +GstTimeCacheGroup +GstTimeCacheCertainty +gst_timecache_new +gst_timecache_get_group +gst_timecache_new_group +gst_timecache_set_group +gst_timecache_set_certainty +gst_timecache_get_certainty +gst_timecache_add_entry +gst_timecache_find_location +gst_timecache_find_timestamp + +GstTimeCache +GST_TIMECACHE +GST_IS_TIMECACHE +GST_TYPE_TIMECACHE +gst_timecache_get_type +GST_TIMECACHE_CLASS +GST_IS_TIMECACHE_CLASS +
+ +
gststaticautoplug GstStaticAutoplug @@ -948,6 +1121,28 @@ GST_IS_STATIC_AUTOPLUG_RENDER_CLASS
+gstaggregator +GstAggregator +GstAggregatorSchedType + +gst_aggregator_details +GstAggregator +gst_aggregator_factory_init +GST_AGGREGATOR +GST_IS_AGGREGATOR +GST_TYPE_AGGREGATOR +gst_aggregator_get_type +GST_AGGREGATOR_CLASS +GST_IS_AGGREGATOR_CLASS +
+ +
+gstfilesrc +GstFileSrc + +
+ +
gstdisksrc GstDiskSrc GstDiskSrcFlags @@ -974,6 +1169,7 @@ GST_FAKESINK GST_FAKESINK_CLASS GST_IS_FAKESINK GST_IS_FAKESINK_CLASS +gst_fakesink_factory_init
@@ -989,6 +1185,10 @@ GST_FAKESRC GST_FAKESRC_CLASS GST_IS_FAKESRC GST_IS_FAKESRC_CLASS +GstFakeSrcDataType +GstFakeSrcFillType +GstFakeSrcSizeType +gst_fakesrc_factory_init
@@ -1063,21 +1263,6 @@ GST_IS_QUEUE_CLASS
-gstsinesrc -GstSineSrc - -GstSineSrc -GstSineSrcClass -gst_sinesrc_get_type -gst_sinesrc_factory_init -GST_TYPE_SINESRC -GST_SINESRC -GST_SINESRC_CLASS -GST_IS_SINESRC -GST_IS_SINESRC_CLASS -
- -
gstpipefilter GstPipefilter diff --git a/docs/gst/gstreamer.hierarchy b/docs/gst/gstreamer.hierarchy index 9e10a00..fa34a9a 100644 --- a/docs/gst/gstreamer.hierarchy +++ b/docs/gst/gstreamer.hierarchy @@ -1,7 +1,31 @@ GtkObject GtkWidget GtkRange + GtkScrollbar + GtkVScrollbar + GtkHScrollbar + GtkScale + GtkHScale + GtkVScale GtkContainer + GtkBin + GtkScrolledWindow + GtkButton + GtkToggleButton + GtkCheckButton + GtkRadioButton + GtkPaned + GtkVPaned + GtkHPaned + GtkBox + GtkHBox + GtkCombo + GtkCList + GtkEditable + GtkEntry + GtkSpinButton + GtkData + GtkAdjustment GObject GstObject GstXml @@ -10,12 +34,13 @@ GtkObject GstPipeline GstThread GstTee + GstAggregator GstFakeSrc GstFakeSink + GstFileSrc GstDiskSrc GstHttpSrc GstFdSrc - GstSineSrc GstFdSink GstPipefilter GstIdentity diff --git a/docs/gst/gstreamer.types.in b/docs/gst/gstreamer.types.in index 5020474..d5bc1de 100644 --- a/docs/gst/gstreamer.types.in +++ b/docs/gst/gstreamer.types.in @@ -10,9 +10,11 @@ gst_pad_get_type gst_thread_get_type gst_tee_get_type +gst_aggregator_get_type gst_fakesrc_get_type gst_fakesink_get_type +gst_filesrc_get_type gst_disksrc_get_type @GST_HTTPSRC_GET_TYPE@ gst_fdsrc_get_type diff --git a/docs/gst/tmpl/cothreads.sgml b/docs/gst/tmpl/cothreads.sgml index 2932447..7bb30e8 100644 --- a/docs/gst/tmpl/cothreads.sgml +++ b/docs/gst/tmpl/cothreads.sgml @@ -23,7 +23,7 @@ of data out of their src element. - +Get the current stack frame. diff --git a/docs/gst/tmpl/gobject2gtk.sgml b/docs/gst/tmpl/gobject2gtk.sgml new file mode 100644 index 0000000..2122412 --- /dev/null +++ b/docs/gst/tmpl/gobject2gtk.sgml @@ -0,0 +1,16 @@ + +GObject + + + + + + + + + + + + + + diff --git a/docs/gst/tmpl/gst.sgml b/docs/gst/tmpl/gst.sgml index 546b49c..3e31202 100644 --- a/docs/gst/tmpl/gst.sgml +++ b/docs/gst/tmpl/gst.sgml @@ -7,7 +7,7 @@ Media library supporting arbitrary formats and filter graphs. GStreamer is a framework for constructing graphs of various filters -(termed elements here) that will handly streaming media. Any discreet +(termed elements here) that will handle streaming media. Any discreet (packetizable) media type is supported, with provisions for automatically determining source type. Metadata can be passed with all data to provide formatting/framing information. Plugins are heavily used to provide for @@ -39,21 +39,24 @@ pipeline and Microsoft's DirectShow for some background. @argv: - + +@major: +@minor: +@micro: - + - + @@ -62,14 +65,21 @@ pipeline and Microsoft's DirectShow for some background. - +The major version of GStreamer at compile time +The minor version of GStreamer at compile time + + + + + +The micro version of GStreamer at compile time diff --git a/docs/gst/tmpl/gstaggregator.sgml b/docs/gst/tmpl/gstaggregator.sgml new file mode 100644 index 0000000..0777fce --- /dev/null +++ b/docs/gst/tmpl/gstaggregator.sgml @@ -0,0 +1,42 @@ + +GstAggregator + + +Combine buffers. + + + +The aggregator is mainly used for testing purposes. It has several +methods to request buffers from its pads. + + + + + + + + + + + + +@AGGREGATOR_LOOP: +@AGGREGATOR_LOOP_PEEK: +@AGGREGATOR_LOOP_SELECT: +@AGGREGATOR_CHAIN: + + + + + + + + + + + + + + + + diff --git a/docs/gst/tmpl/gstarch.sgml b/docs/gst/tmpl/gstarch.sgml index c8cc02a..49ac6d0 100644 --- a/docs/gst/tmpl/gstarch.sgml +++ b/docs/gst/tmpl/gstarch.sgml @@ -2,10 +2,14 @@ gstarch - +Architecural specific macros and functions. +This file contains various macros and function for performing common +GStreamer tasks that requires some knowledge of the underlaying architecture. +Porting to other CPU architectures will typically require adding appropriate +implementations in this file. @@ -16,31 +20,31 @@ gstarch - +Jumps to a specific location in memory. -@target: +@target: the memory to jump to. - +Sets the stackpointer. -@stackpointer: +@stackpointer: the stackpointer to set. - +Make toom on the stack? -@sp: +@sp: the stackpointer to modify. - +Do something funny, which is required on some archs.. diff --git a/docs/gst/tmpl/gstautoplug.sgml b/docs/gst/tmpl/gstautoplug.sgml index 050429c..61e1815 100644 --- a/docs/gst/tmpl/gstautoplug.sgml +++ b/docs/gst/tmpl/gstautoplug.sgml @@ -7,7 +7,7 @@ Automatically create and connect elements GstAutoplug is an abstract class that is used for constructing and -connecting elements. Two types og autopluggers exist: renderer ones and non +connecting elements. Two types of autopluggers exist: renderer ones and non renderer ones. the renderer autopluggers will not have any src pads while the non renderer ones do. @@ -92,7 +92,7 @@ Use the regular gst_object_destroy() call to destroy the autoplugger. -GstStaticAutoplug, GstStaticAutoplugRender +#GstStaticAutoplug, #GstStaticAutoplugRender diff --git a/docs/gst/tmpl/gstbuffer.sgml b/docs/gst/tmpl/gstbuffer.sgml index 94ccbc2..3d9d190 100644 --- a/docs/gst/tmpl/gstbuffer.sgml +++ b/docs/gst/tmpl/gstbuffer.sgml @@ -57,9 +57,25 @@ regardless of the refcount (dangerous). -#GstBufferPool, #GstPad +#GstBufferPool, #GstPad, #GstData + + +Check if the object is a buffer. + + +@buf: The object to check + + + + +Cast an object to a GstBuffer + + +@buf: The object to cast. + + Get the flags from this buffer. @@ -151,14 +167,6 @@ Get the bufferpool private data. @buf: GstBuffer - - - - - -@pool: - - This macro will obtain a lock on the object, making serialization @@ -204,12 +212,30 @@ Get the maximun age of a buffer. @buf: GstBuffer to get the maxage of. + + +Call the buffer specific copy function on the given buffer. + + +@buf: the buffer to copy. + + + + +Call the buffer specific free function on the given buffer. + + +@buf: the buffer to free. + + This function is used to copy the buffer contents. @srcbuf: the src buffer +@Returns: + @dstbuf: the destination buffer @@ -266,9 +292,11 @@ used when data in a stream has been skipped @pool: -@location: +@offset: @size: @Returns: + +@location: @@ -312,16 +340,15 @@ used when data in a stream has been skipped @buffer: - + @buffer: -@count: - + @@ -329,11 +356,35 @@ used when data in a stream has been skipped @buffer: - + -@buffer: +@buf1: +@buf2: +@Returns: + + + + + + + +@buf1: +@buf2: +@Returns: + + + + + + + +@buf1: +@offset: +@buf2: +@len: +@Returns: diff --git a/docs/gst/tmpl/gstbufferpool.sgml b/docs/gst/tmpl/gstbufferpool.sgml index 874a650..69ba1ae 100644 --- a/docs/gst/tmpl/gstbufferpool.sgml +++ b/docs/gst/tmpl/gstbufferpool.sgml @@ -57,6 +57,43 @@ A bufferpool can be requested from a pad with the gst_pad_get_bufferpool() funct @destroy_hook: @user_data: + + + + + +@pool: +@location: +@size: +@user_data: +@Returns: + + + + + + + +@pool: +@user_data: + + + + +Lock the given bufferpool. + + +@pool: The pool to lock. + + + + +Unlock the given bufferpool. + + +@pool: the bufferpool to unlock. + + @@ -112,3 +149,58 @@ A bufferpool can be requested from a pad with the gst_pad_get_bufferpool() funct @oldpool: + + + + + +@pool: +@user_data: + + + + + + + +@pool: +@user_data: +@Returns: + + + + + + + +@pool: +@copy: + + + + + + + +@pool: +@destroy: + + + + + + + +@pool: +@create: + + + + + + + +@pool: +@destroy: + + diff --git a/docs/gst/tmpl/gstcaps.sgml b/docs/gst/tmpl/gstcaps.sgml index b9f4cbb..961ad6c 100644 --- a/docs/gst/tmpl/gstcaps.sgml +++ b/docs/gst/tmpl/gstcaps.sgml @@ -67,7 +67,7 @@ takes a list of key value pairs in the #GstProps syntax as shown by this example before modifying a GstCaps, it is a good idea to make a copy if it first with -gst_caps_copy_on_write(). This will copy thr GstCaps if the refcount is >1. +gst_caps_copy_on_write(). This will copy the GstCaps if the refcount is >1. diff --git a/docs/gst/tmpl/gstclock.sgml b/docs/gst/tmpl/gstclock.sgml index 888a957..45b8c9a 100644 --- a/docs/gst/tmpl/gstclock.sgml +++ b/docs/gst/tmpl/gstclock.sgml @@ -1,12 +1,12 @@ -gstclock +GstClock - +Clocking and synchronisation. - +GstClock provides an easy way to synchonize against a global clock. @@ -28,11 +28,13 @@ gstclock - +Calculate the difference between to timestamps. This does not create +and absolute difference so the result might be negative if the first +timestamp is less than the second timestamp. -@s: -@e: +@s: first timestamp +@e: second timestamp diff --git a/docs/gst/tmpl/gstdata.sgml b/docs/gst/tmpl/gstdata.sgml new file mode 100644 index 0000000..4f1c83b --- /dev/null +++ b/docs/gst/tmpl/gstdata.sgml @@ -0,0 +1,24 @@ + +GstData + + +Common structure for GstBuffer and GstEvent + + + +This structure provides a common base for #GstBuffer and #GstEvent. It is the +main data type that is passed along in a pipeline. + + + + +#GstBuffer, #GstEvent + + + + +The base structure + + +@type: The type of this data. + diff --git a/docs/gst/tmpl/gstelement.sgml b/docs/gst/tmpl/gstelement.sgml index 496724a..14c9e08 100644 --- a/docs/gst/tmpl/gstelement.sgml +++ b/docs/gst/tmpl/gstelement.sgml @@ -86,14 +86,14 @@ The Element is going from the NULL state to the READY state. - +The Element is going from the READY state to the PAUSED state. - +The Element is going from the PAUSED state to the READY state. @@ -185,18 +185,18 @@ Get the pads of this elements. - +Get the scheduler of this element. -@obj: +@obj: The element to query - +Get the manager of this element. -@obj: +@obj: The element to query @@ -227,6 +227,7 @@ GstElementDetails struct for the element. @feature: @type: +@details_dynamic: @details: @padtemplates: @numpadtemplates: @@ -241,6 +242,15 @@ circumstances. @element: The element in question. + + + + + +@element: +@templ: + + @@ -439,6 +449,15 @@ circumstances. @Returns: + + + + + +@elem: +@Returns: + + @@ -586,7 +605,7 @@ Is trigered whenever a new pad is added to an element @gstelement: the object which received the signal. -@arg1: +@arg1: The pad that was removed. @@ -603,7 +622,7 @@ Is trigered whenever a new ghost pad is added to an element @gstelement: the object which received the signal. -@arg1: +@arg1: The ghost pad that was removed. diff --git a/docs/gst/tmpl/gstevent.sgml b/docs/gst/tmpl/gstevent.sgml new file mode 100644 index 0000000..a2e5865 --- /dev/null +++ b/docs/gst/tmpl/gstevent.sgml @@ -0,0 +1,121 @@ + +GstEvent + + +Event definitions. + + + +The event classes are used to construct and query events. + + + + + + + + + +The different major types of events. + + +@GST_EVENT_UNKNOWN: unknown event. +@GST_EVENT_EOS: an end-of-stream event. +@GST_EVENT_FLUSH: a flush event. +@GST_EVENT_EMPTY: an empty event. +@GST_EVENT_SEEK: a seek event. +@GST_EVENT_DISCONTINUOUS: a discontinuous event to indicate the stream has a discontinuity. + + + +Get the event type. + + +@event: The event to query. + + + + +Get the timestamp of the event. + + +@event: The event to query. + + + + +The different types of seek events. + + +@GST_SEEK_ANY: the seek is performed anyway. +@GST_SEEK_TIMEOFFSET: this is a seek to specific timeoffset +@GST_SEEK_BYTEOFFSET: this is a seek to specific byteoffset + + + +Get the seektype of the GST_EVENT_SEEK. + + +@event: The event to query. + + + + +Get the offset of the seek event. + + +@event: The event to query. + + + + +Qeury wether the seek event also needs a flush. + + +@event: The event to query. + + + + +The event data structure. + + +@data: The parent data type. +@type: The event type. +@timestamp: The event timestamp. + + + + + + +@type: +@Returns: + + + + + + + +@event: + + + + + + + +@type: +@offset: +@flush: +@Returns: + + + + + + + + + diff --git a/docs/gst/tmpl/gstextratypes.sgml b/docs/gst/tmpl/gstextratypes.sgml index af34d4b..ddb3e57 100644 --- a/docs/gst/tmpl/gstextratypes.sgml +++ b/docs/gst/tmpl/gstextratypes.sgml @@ -16,7 +16,7 @@ GstExtraTypes - +A type that can be used to indicate a filename. diff --git a/docs/gst/tmpl/gstfakesink.sgml b/docs/gst/tmpl/gstfakesink.sgml index 1aac92d..b0a7392 100644 --- a/docs/gst/tmpl/gstfakesink.sgml +++ b/docs/gst/tmpl/gstfakesink.sgml @@ -34,3 +34,8 @@ with the buffer. (fakesink) + + + + + diff --git a/docs/gst/tmpl/gstfakesrc.sgml b/docs/gst/tmpl/gstfakesrc.sgml index 323cb0b..e97ac91 100644 --- a/docs/gst/tmpl/gstfakesrc.sgml +++ b/docs/gst/tmpl/gstfakesrc.sgml @@ -37,6 +37,36 @@ The GstFakeSrc generates empty buffers. (fakesrc) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -57,3 +87,8 @@ The GstFakeSrc generates empty buffers. (fakesrc) + + + + + diff --git a/docs/gst/tmpl/gstfilesrc.sgml b/docs/gst/tmpl/gstfilesrc.sgml new file mode 100644 index 0000000..404552b --- /dev/null +++ b/docs/gst/tmpl/gstfilesrc.sgml @@ -0,0 +1,51 @@ + +GstFileSrc + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/gst/tmpl/gstinfo.sgml b/docs/gst/tmpl/gstinfo.sgml index 4f07d1a..d0fa8de 100644 --- a/docs/gst/tmpl/gstinfo.sgml +++ b/docs/gst/tmpl/gstinfo.sgml @@ -159,11 +159,12 @@ in addition to the given string. - +Called at the end of a function, it simply prints out a DEBUG string of "leaving" +in addition to the given string. -@format: -@args...: +@format: printf-stype format string +@args...: printf arguments @@ -176,75 +177,55 @@ Print out debugging information. @args...: printf arguments - - - - - - - - - - -@ptr: - - - - - +Add a function to the global function pointer table used for debugging. +@ptr: The pointer to add to the function table. - +Get the name of the given function pointer by looking up its name in the global +function table. -@ptr: +@ptr: The pointer to look up. - +Print out debugging statements for a pad. -@pad: +@pad: The pad to debug. - +Part of the colorized debug functions for threads -@id: +@id: The thread id. - +Part of the colorized debug functions for threads - - - -@cat: -@element: -@format: -@args...: - - - - - +Print out usefull debugging info of an element. +@cat: The category of this debugging statement. +@element: The element to debug. +@format: A printf-like string. +@args...: The argument for the printf-like string. @@ -312,6 +293,13 @@ Print out an error condition and abort the application. @string: + + + + + + + diff --git a/docs/gst/tmpl/gstlog.sgml b/docs/gst/tmpl/gstlog.sgml index 77b7d60..f4af303 100644 --- a/docs/gst/tmpl/gstlog.sgml +++ b/docs/gst/tmpl/gstlog.sgml @@ -14,13 +14,6 @@ gstlog - - - - - - - diff --git a/docs/gst/tmpl/gstobject.sgml b/docs/gst/tmpl/gstobject.sgml index 6de54c9..e0b652b 100644 --- a/docs/gst/tmpl/gstobject.sgml +++ b/docs/gst/tmpl/gstobject.sgml @@ -238,6 +238,15 @@ Check if the object has been destroyed. @Returns: + + + + + +@object: +@parent: + + diff --git a/docs/gst/tmpl/gstpad.sgml b/docs/gst/tmpl/gstpad.sgml index 3c62b9a..cb105fe 100644 --- a/docs/gst/tmpl/gstpad.sgml +++ b/docs/gst/tmpl/gstpad.sgml @@ -185,8 +185,6 @@ a start/stop timecode pair. @offset: the offset of the region to get @len: the length of the region to get @Returns: a #GstBuffer - -@size: the size of the region to get @@ -250,8 +248,17 @@ a start/stop timecode pair. @offset: the offset of the region to get @len: the length of the region to get @Returns: a #GstBuffer + + + + + +@pad: +@event: +@Returns: + @@ -517,6 +524,17 @@ Destroy the pad. @srcpad: @sinkpad: + +@Returns: + + + + + + + +@srcpad: +@sinkpad: @Returns: @@ -625,6 +643,76 @@ Destroy the pad. @Returns: + + + + + +@pad: +@event: +@timestamp: +@data: +@Returns: + + + + + + + +@pad: +@bin: +@parent: +@Returns: + + + + + + + +@pad: +@Returns: + + + + + + + +@padlist: +@Returns: + + + + + + + +@pad: +@Varargs: +@Returns: + + + + + + + +@pad: +@event: +@Returns: + + + + + + + +@pad: +@event: + + @@ -671,10 +759,10 @@ Get the offset of the region that is being pulled. - +Get the scheduler of this real pad. -@pad: +@pad: the real pad to query. @@ -773,6 +861,38 @@ Get the bufferpoolfunction from the real pad. @pad: the real pad to query. + + +Get the eventhandler function from the real pad. + + +@pad: the real pad to query. + + + + +Get the event function of this real pad. + + +@pad: the real pad to query. + + + + +Get the eventhandler function of this real pad. + + +@pad: the real pad to query. + + + + +Get the gethandler function of this real pad. + + +@pad: the real pad to query. + + Get the real pad of this ghost pad. diff --git a/docs/gst/tmpl/gstplugin.sgml b/docs/gst/tmpl/gstplugin.sgml index 0668663..3e2fad1 100644 --- a/docs/gst/tmpl/gstplugin.sgml +++ b/docs/gst/tmpl/gstplugin.sgml @@ -7,25 +7,8 @@ Dynamically loadable Elements GStreamer is extensible so GstElements can be loaded at runtime. A plugin -system can provide one or more of the following basic GStreamer -objects factories: - - - - A #GstElementFactory: the components to build a pipeline. - - - - - A #GstTypeFactory: A MIME type and an optional typefind function. - - - - - A #GstAutoplugFactory: An object used to automatically construct pipelines. - - - +system can provide one or more of the basic GStreamer +#GstPluginFeature subclasses. A plugin should export a symbol plugin_desc that is a struct of type #GstPluginDesc. @@ -38,12 +21,11 @@ Optionally a new plugin is created with gst_plugin_new(). this function will ret to the GstPlugin or NULL if the plugin could not be created. -Once you have a handle to a #GstPlugin, you can add the different types of factories -to it with gst_plugin_add_factory(), gst_plugin_add_type(), gst_plugin_add_autoplugger(). +Once you have a handle to a #GstPlugin, you can add any object that subclasses #GstPluginFeature. -use gst_plugin_find(), gst_plugin_get_list(), gst_plugin_get_factory_list(), gst_plugin_get_type_list() and -gst_plugin_get_autoplug_list() to query the plugin repository. +use gst_plugin_find(), gst_plugin_get_list() and gst_plugin_get_feature_list() +to query the plugin repository. Plugins are always automaticlly loaded so you don't need to call gst_plugin_load() explicitly @@ -52,7 +34,7 @@ to bring it into memory. -#GstElement, #GstType, #GstAutoplug +#GstPluginFeature, #GstType, #GstAutoplug, #GstElementFactory @@ -89,6 +71,40 @@ loaded will use this variable to initialize the plugin. @name: The name of the plugin @plugin_init: The init function of this plugin. + + +A handy macro to define a plugin description. This macro handles with all the issues +involved with the different linking methods for this plugin. + + +@major: The major version of GStreamer this plugin was compiled against. +@minor: The minor version of GStreamer this plugin was compiled against. +@name: The name of the plugin. +@init: The init function of this plugin. + + + + +The macro used to define dynamically loaded plugins. + + +@major: The major version of GStreamer this plugin was compiled against. +@minor: The minor version of GStreamer this plugin was compiled against. +@name: The name of the plugin. +@init: The init function of this plugin. + + + + +A macro used to define a statically linked plugin. + + +@major: The major version of GStreamer this plugin was compiled against. +@minor: The minor version of GStreamer this plugin was compiled against. +@name: The name of the plugin. +@init: The init function of this plugin. + + @@ -230,3 +246,37 @@ loaded will use this variable to initialize the plugin. @Returns: + + + + + +@plugin: +@feature: + + + + + + + +@plugin: +@Returns: + + + + + + + +@plugin: +@Returns: + + + + + + + + + diff --git a/docs/gst/tmpl/gstpluginfeature.sgml b/docs/gst/tmpl/gstpluginfeature.sgml new file mode 100644 index 0000000..3211c20 --- /dev/null +++ b/docs/gst/tmpl/gstpluginfeature.sgml @@ -0,0 +1,32 @@ + +GstPluginFeature + + +The base class for plugable objects. + + + +This is a base class for anything that can be added to a #GstPlugin. + + + + +#GstPlugin + + + + + + + +@feature: + + + + + + + +@feature: + + diff --git a/docs/gst/tmpl/gstreamer-unused.sgml b/docs/gst/tmpl/gstreamer-unused.sgml index 55f641d..724293f 100644 --- a/docs/gst/tmpl/gstreamer-unused.sgml +++ b/docs/gst/tmpl/gstreamer-unused.sgml @@ -313,6 +313,26 @@ Provide context for buffers GstMeta + + +Create a sine wave of a given frequency and volume. + + + + + + + + + + +Create a sine wave of a given frequency and volume. (sinesrc) + + + +GstSineSrc + + The sink is the end of the filter graph. A typical sink would be an audio @@ -504,6 +524,57 @@ g_print messages. @format: @args...: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@name: +@value_type: +@flags: + @@ -560,13 +631,6 @@ g_print messages. @klass: - - - - - -@buf: - @@ -607,6 +671,38 @@ A flag indicating that SSE instructions are supported. + + + + + +@data: + + + + + + +@data: + + + + + + + + + + + + + + + + + + + Combine #GST_DEBUG_ENTER and #GST_DEBUG_SET_STRING. @@ -1357,6 +1453,12 @@ Get the QoS function of the real pad. @pad: the real pad to query. + + + + + + @@ -1653,455 +1755,872 @@ This macro unsets the given state on the element. - + - + -Specify how many bytes to read at a time. + - + -Get the size of the current file. + +@class_size: +@base_init: +@base_finalize: +@class_init: +@class_finalize: +@class_data: +@instance_size: +@n_preallocs: +@instance_init: +@value_table: - + -Specify the location of the file to read. + - + -Specify the current offset in the file. + - + +@f: - + - + - - - - -GST_ASYNCDISKSRC_OPEN -the asyncdisksrc is open for reading - - - -@GST_ASYNCDISKSRC_OPEN: -@GST_ASYNCDISKSRC_FLAG_LAST: - + +@pspec: - + -The buffer is sent to the sound card. + -@gstaudiosink: the object which received the signal. -@arg1: the audiosink. - + - + - + - + +@obj: - + +@gclass: - + - + -The number of bytes per read. + +@a: +@b: +@c: - + -The number of channels (mono, stereo, ...) + - + -Get the current number of bytes read. + - + -The audio format as defined in soundcard.h + - + -The frequency. + - + - + - + -The function called when a buffer has to be created for this pool. + -@pool: the pool from which to create the buffer -@user_data: any user data -@Returns: a new buffer from the pool - + -This function will be called when the given buffer has to be returned to -the pool. + -@pool: the pool to return the buffer to -@buffer: the buffer to return -@user_data: any user data - + -@GST_CAPS_ALWAYS: -@GST_CAPS_MAYBE: - + - + - + - + - + - + -Is emited after the buffer has been written to the disk. + -@gstdisksink: the object which received the signal. - + - + -The filename to write to. + - + - + -Get the size of the file. + - + - + - + - + - + - + +@klass: - + +@o: +@t: +@c: - + - + - + - + - + - + - + - + - + - + +@value: - + +@value: - + +@value: - + +@value: - + +@value: - + -@lock: for locking purposes -@flags: the flags of the meta data -@data: the meta data -@size: the size of the meta data +@value: - + -Flags indicating properties about the meta data. + -@GST_META_FREEABLE: the meta data can be freed +@value: - + +@value: - + -Indicates this pad is active + +@value: - + +@value: -<<<<<<< gstreamer-unused.sgml + + + - +@value: + + -The function that will be called in an EOS case. + -@pad: the pad that needs to be set to EOS state -@Returns: TRUE if EOS was successful, FALSE otherwise +@v: - + -Defines an entry for a padfactory. + - + -The padfactory. +Specify how many bytes to read at a time. - + -The function that will be called when pulling buffers. +Get the size of the current file. -@pad: the pad to pull -@Returns: a GstBuffer - + - -The function that will be called when pushing a buffers. +Specify the location of the file to read. -@pad: the pad to push -@buf: a GstBuffer to push - + -The function that will be called when a QoS message is sent. +Specify the current offset in the file. -@pad: the pad that sent the QoS message -@qos_message: the message - + + + + + + + + + + + + + + + + + + +GST_ASYNCDISKSRC_OPEN +the asyncdisksrc is open for reading + + + + + + +@GST_ASYNCDISKSRC_OPEN: +@GST_ASYNCDISKSRC_FLAG_LAST: + + + + + + + + + +The buffer is sent to the sound card. + + +@gstaudiosink: the object which received the signal. +@arg1: the audiosink. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +The number of bytes per read. + + + + + +The number of channels (mono, stereo, ...) + + + + + +Get the current number of bytes read. + + + + + +The audio format as defined in soundcard.h + + + + + +The frequency. + + + + + + + + + + + + + + + + + +The function called when a buffer has to be created for this pool. + + +@pool: the pool from which to create the buffer +@user_data: any user data +@Returns: a new buffer from the pool + + + +This function will be called when the given buffer has to be returned to +the pool. + + +@pool: the pool to return the buffer to +@buffer: the buffer to return +@user_data: any user data + + + + + + +@GST_CAPS_ALWAYS: +@GST_CAPS_MAYBE: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Is emited after the buffer has been written to the disk. + + +@gstdisksink: the object which received the signal. + + + + + + + + + +The filename to write to. + + + + + + + + + + + +Get the size of the file. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@lock: for locking purposes +@flags: the flags of the meta data +@data: the meta data +@size: the size of the meta data + + + +Flags indicating properties about the meta data. + + +@GST_META_FREEABLE: the meta data can be freed + + + + + + + + + +Indicates this pad is active + + + + + + + + + +<<<<<<< gstreamer-unused.sgml + + + + +The function that will be called in an EOS case. + + +@pad: the pad that needs to be set to EOS state +@Returns: TRUE if EOS was successful, FALSE otherwise + + + +Defines an entry for a padfactory. + + + + + +The padfactory. + + + + + +The function that will be called when pulling buffers. + + +@pad: the pad to pull +@Returns: a GstBuffer + + + + +The function that will be called when pushing a buffers. + + +@pad: the pad to push +@buf: a GstBuffer to push + + + +The function that will be called when a QoS message is sent. + + +@pad: the pad that sent the QoS message +@qos_message: the message + + @@ -2113,250 +2632,1074 @@ The function that will be called when a QoS message is sent. - + + + + + + + + + + + + + + + + + +@GST_PROPS_END_ID_NUM: +@GST_PROPS_LIST_ID_NUM: +@GST_PROPS_INT_ID_NUM: +@GST_PROPS_INT_RANGE_ID_NUM: +@GST_PROPS_FOURCC_ID_NUM: +@GST_PROPS_BOOL_ID_NUM: + + + + + + + + + + + + + + + +Specify wether the queue blocks or not. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +The number of channels. + + + + + +The format ad defined in soundcard.h + + + + + +The frequency. + + + + + +The fequency. + + + + + + + + + + + + + + + + + +The volume as a double 0.0 is silent, 1.0 is loudest. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +An eos signal is triggered whenever the GstSrc has reached the end of +the stream. + + + +@gstsrc: the object which received the signal. +@arg1: the object which received the signal + + + + + + + + + +Flags for the GstSrc element + + +@GST_SRC_ASYNC: Indicates that this src is asynchronous +@GST_SRC_FLAG_LAST: subclasses can use this to number their flags + + + + + + + + + + + + + + + + + + + + + +Query the element for the current mime type + + + + + +Is trigered whenever the state of an element changes + + +@gstelement: the object which received the signal. +@arg1: the new state of the object + + + + + + +@cat: +@format: +@args...: + + + + + + +@cat: +@element: +@format: +@args...: + + + + + + +@meta: +@format: +@channels: +@frequency: +@bps: + + + + + + +@meta: +@bands: +@channels: +@interleaved: +@lowfreq: +@highfreq: +@steps: + + + + + + +@base: +@swidth: +@sheight: +@bytes_per_line: + + + + + + +@wx: +@wy: +@overlay_element: +@clip_count: +@overlay_clip: +@width: +@height: +@did_overlay: +@fully_obscured: + + + + + + +@meta: +@format: +@visual: +@width: +@height: +@overlay_info: +@dga_info: + + + + + + +@x1: +@x2: +@y1: +@y2: + + + + + + + + + + + + +@oclass: +@name: +@Returns: + + + + + + +@oclass: +@property_id: +@pspec: + + + + + + +@oclass: +@n_properties: +@Returns: + + + + + + +@type: +@blah_varargs_stuff: +@Returns: + + + + + + +@object: + + + + + + +@name: +@nick: +@blurb: +@def: +@flags: +@Returns: + + + + + + +@name: +@nick: +@blurb: +@min: +@max: +@def: +@flags: +@Returns: + + + + + + +@name: +@nick: +@blurb: +@e: +@def: +@flags: +@Returns: + + + + + + +@name: +@nick: +@blurb: +@min: +@max: +@def: +@flags: +@Returns: + + + + + + +@name: +@nick: +@blurb: +@min: +@max: +@def: +@flags: +@Returns: + + + + + + +@name: +@nick: +@blurb: +@min: +@max: +@def: +@flags: +@Returns: + + + + + + +@name: +@nick: +@blurb: +@flags: +@Returns: + + + + + + +@name: +@nick: +@blurb: +@def: +@flags: +@Returns: + + + + + + +@name: +@nick: +@blurb: +@min: +@max: +@def: +@flags: +@Returns: + + + + + + +@name: +@nick: +@blurb: +@min: +@max: +@def: +@flags: +@Returns: + + + + + + +@signal_name: +@object_type: +@signal_flags: +@function_offset: +@accumulator: +@Returns: + + + + + + +@parent_type: +@type_name: +@info: +@flags: +@Returns: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@list: +@llink: +@Returns: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@obj: +@argname: +@pspec: + + + + + + +@Returns: + + + + + + + + + + + + +@obj: + + + + + + + + + + + + +@o: +@args...: + + + + + + +@obj: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + -@GST_PROPS_END_ID_NUM: -@GST_PROPS_LIST_ID_NUM: -@GST_PROPS_INT_ID_NUM: -@GST_PROPS_INT_RANGE_ID_NUM: -@GST_PROPS_FOURCC_ID_NUM: -@GST_PROPS_BOOL_ID_NUM: - + - + +@o: +@id: - + -Specify wether the queue blocks or not. + +@o: +@id: - + +@x: - + +@type: +@n_ids: +@Returns: - + - + -The number of channels. + - + -The fequency. + +@list: +@llink: +@Returns: - + - + - + +@c: - + - + -An eos signal is triggered whenever the GstSrc has reached the end of -the stream. -@gstsrc: the object which received the signal. -@arg1: the object which received the signal +@c: - + +@t: - + -Flags for the GstSrc element + -@GST_SRC_ASYNC: Indicates that this src is asynchronous -@GST_SRC_FLAG_LAST: subclasses can use this to number their flags - + - + +@t: - + +@t: - + -Query the element for the current mime type + - + -Is trigered whenever the state of an element changes + -@gstelement: the object which received the signal. -@arg1: the new state of the object +@src_val: +@dest_val: - + -@cat: -@format: -@args...: +@value: - + -@cat: -@element: -@format: -@args...: +@value: - + -@meta: -@format: -@channels: -@frequency: -@bps: +@value: - + -@meta: -@bands: -@channels: -@interleaved: -@lowfreq: -@highfreq: -@steps: +@value: - + -@base: -@swidth: -@sheight: -@bytes_per_line: +@value: - + -@wx: -@wy: -@overlay_element: -@clip_count: -@overlay_clip: -@width: -@height: -@did_overlay: -@fully_obscured: +@value: - + -@meta: -@format: -@visual: -@width: -@height: -@overlay_info: -@dga_info: +@value: - + -@x1: -@x2: -@y1: -@y2: +@value: - + + + + + +@value: + + + + + + +@value: + + + + + + +@value: + + + + + + +@value: + + + + + + +@value: +@t: + + + + + + +@value: +@data: + + + + + + +@value: +@data: + + + + + + +@value: +@data: + + + + + + +@value: +@data: + + + + + + +@value: +@data: + + + + + + +@value: +@data: + + + + + + +@value: +@data: + + + + + + +@value: +@data: + + + + + + +@value: +@data: + + + + + + +@value: +@data: + + + + + + +@value: +@data: + + + + + + +@value: +@data: + + + + + + +@val: + + @@ -2585,6 +3928,14 @@ Is trigered whenever the state of an element changes @destroy: @user_data: + + + + + +@buffer: +@count: + @@ -2967,6 +4318,54 @@ Is trigered whenever the state of an element changes @name: @Returns: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Create new meta data. @@ -3116,15 +4515,6 @@ Call the EOS function of the pad @parent: @Returns: - - - - - -@nextpad: -@Varargs: -@Returns: - @@ -3215,6 +4605,13 @@ Call the EOS function of the pad @plugin: @factory: + + + + + +@Returns: + diff --git a/docs/gst/tmpl/gstscheduler.sgml b/docs/gst/tmpl/gstscheduler.sgml index 4703905..3786040 100644 --- a/docs/gst/tmpl/gstscheduler.sgml +++ b/docs/gst/tmpl/gstscheduler.sgml @@ -6,7 +6,7 @@ An abstract class for plugable schedulers. - +This is a base class for custom schedulers. @@ -16,10 +16,11 @@ An abstract class for plugable schedulers. +Get the parent #GstElement of this scheduler. -@sched: +@sched: the scheduler to query. @@ -37,92 +38,93 @@ An abstract class for plugable schedulers. - +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: +@sched: the scheduler to query. - +Fast macro to add an element to the scheduler. -@sched: -@element: +@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: -@element: +@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: -@element: +@sched: The scheduler. +@element: The element to activate. - +Fast macro to disable the element. -@sched: -@element: +@sched: The scheduler. +@element: The element to disable. - +Fast macro to lock a given element. -@sched: -@element: +@sched: The scheduler. +@element: The element to lock. - +Fast macro to unlock a given element. -@sched: -@element: +@sched: The scheduler. +@element: The element to unlock. - +Fast macro to connect two pads. -@sched: -@srcpad: -@sinkpad: +@sched: The scheduler. +@srcpad: The source pad. +@sinkpad: The sink pad. - +Fast macro to disconnect two pads. -@sched: -@srcpad: -@sinkpad: +@sched: The scheduler. +@srcpad: The source pad. +@sinkpad: The sink pad. - +Fast macro to perform one iteration of the scheduler. -@sched: +@sched: The scheduler to iterate. @@ -190,6 +192,16 @@ An abstract class for plugable schedulers. @sinkpad: + + + + + +@sched: +@padlist: +@Returns: + + diff --git a/docs/gst/tmpl/gstsinesrc.sgml b/docs/gst/tmpl/gstsinesrc.sgml deleted file mode 100644 index f925976..0000000 --- a/docs/gst/tmpl/gstsinesrc.sgml +++ /dev/null @@ -1,46 +0,0 @@ - -GstSineSrc - - -Create a sine wave of a given frequency and volume. (sinesrc) - - - -Create a sine wave of a given frequency and volume. - - - - - - - - - -The volume as a double 0.0 is silent, 1.0 is loudest. - - - - -The format ad defined in soundcard.h - - - - - - - - - - - - - - -The frequency. - - - - - - - diff --git a/docs/gst/tmpl/gsttimecache.sgml b/docs/gst/tmpl/gsttimecache.sgml new file mode 100644 index 0000000..bc55049 --- /dev/null +++ b/docs/gst/tmpl/gsttimecache.sgml @@ -0,0 +1,130 @@ + +GstTimeCache + + +Cache time and byteoffsets. + + + +This clas is used by plugins to manage time vs byte offsets. It is mainly +used for efficient seeking. + + + + + + + + + + + + +@location: +@timestamp: + + + + + + +@minlocation: +@maxlocation: + + + + + + +@GST_TIMECACHE_UNKNOWN: +@GST_TIMECACHE_CERTAIN: +@GST_TIMECACHE_FUZZY_LOCATION: +@GST_TIMECACHE_FUZZY_TIMESTAMP: +@GST_TIMECACHE_FUZZY: + + + + + + +@Returns: + + + + + + + +@tc: +@Returns: + + + + + + + +@tc: +@Returns: + + + + + + + +@tc: +@groupnum: +@Returns: + + + + + + + +@tc: +@certainty: + + + + + + + +@tc: +@Returns: + + + + + + + +@tc: +@location: +@timestamp: + + + + + + + +@tc: +@location: +@timestamp: +@Returns: + + + + + + + +@tc: +@timestamp: +@location: +@Returns: + + diff --git a/docs/gst/tmpl/gsttrace.sgml b/docs/gst/tmpl/gsttrace.sgml index 3b50e7f..2221681 100644 --- a/docs/gst/tmpl/gsttrace.sgml +++ b/docs/gst/tmpl/gsttrace.sgml @@ -111,7 +111,7 @@ Tracing functionality - +must be defined to activate the tracing functionality. diff --git a/docs/gst/tmpl/gsttype.sgml b/docs/gst/tmpl/gsttype.sgml index 9b2ec82..fbd9b8c 100644 --- a/docs/gst/tmpl/gsttype.sgml +++ b/docs/gst/tmpl/gsttype.sgml @@ -49,20 +49,9 @@ valid mp3 decoder, and thus the whole point of the type system. - - - - - -This is the function that will be called when a typefind has to be -performed by a plugin. +#GstTypeFactory -@buf: the buffer with media on which to perform the typefind -@priv: private; don't touch -@Returns: a boolean indicating if the typedetection was successfull - - A type. @@ -73,16 +62,6 @@ A type. @exts: @factories: - - -The struct with the typefactory information. - - -@feature: -@mime: -@exts: -@typefindfunc: - diff --git a/docs/gst/tmpl/gsttypefactory.sgml b/docs/gst/tmpl/gsttypefactory.sgml new file mode 100644 index 0000000..d0cb554 --- /dev/null +++ b/docs/gst/tmpl/gsttypefactory.sgml @@ -0,0 +1,67 @@ + +GstTypeFactory + + +Add types to plugins. + + + +A GstTypeFactory is used to add a new type and a typedetection function +to a plugin. + + + + +#GstPluginFeature + + + + +The struct with the typefactory information. + + +@feature: +@mime: +@exts: +@typefindfunc: + + + + + + +@name: The name of this factory +@mime: The mime type of the new type. +@exts: The extensions of this type. +@typefindfunc: An optional typefind function. + + + +This is the function that will be called when a typefind has to be +performed by a plugin. + + +@buf: the buffer with media on which to perform the typefind +@priv: private; don't touch +@Returns: A #GstCaps structure describing the type or NULL if the + type was not recognized by this function; + + + + + + + +@definition: +@Returns: + + + + + + + +@name: +@Returns: + + diff --git a/docs/gst/tmpl/gstutils.sgml b/docs/gst/tmpl/gstutils.sgml index 657347c..ab95593 100644 --- a/docs/gst/tmpl/gstutils.sgml +++ b/docs/gst/tmpl/gstutils.sgml @@ -103,3 +103,23 @@ Some convenience functions @size: + + + + + +@buf: +@indent: +@element: + + + + + + + +@buf: +@indent: +@pad: + + -- 2.7.4