<!entity GstPlugin SYSTEM "sgml/gstplugin.sgml">
<!entity GstPluginFeature SYSTEM "sgml/gstpluginfeature.sgml">
<!entity GstThread SYSTEM "sgml/gstthread.sgml">
+<!entity GstRegistry SYSTEM "sgml/gstregistry.sgml">
<!entity GstScheduler SYSTEM "sgml/gstscheduler.sgml">
<!entity GstSchedulerFactory SYSTEM "sgml/gstschedulerfactory.sgml">
<!entity GstTrace SYSTEM "sgml/gsttrace.sgml">
&GstPluginFeature;
&GstProps;
&GstQueue;
+ &GstRegistry;
&GstScheduler;
&GstSchedulerFactory;
&GstSystemClock;
gst_scheduler_factory_create
gst_scheduler_factory_destroy
gst_scheduler_factory_find
-gst_scheduler_factory_get_list
gst_scheduler_factory_make
gst_scheduler_factory_new
gst_scheduler_factory_get_default_name
<TITLE>GstBin</TITLE>
GstBinFlags
GstBin
+GstBinPrePostIterateFunction
gst_bin_new
gst_bin_destroy
gst_bin_add
gst_bin_get_list
gst_bin_set_state_type
gst_bin_iterate
+gst_bin_set_post_iterate_function
+gst_bin_set_pre_iterate_function
gst_bin_child_state_change
-gst_bin_child_error
gst_bin_auto_clock
gst_bin_get_clock
gst_bin_use_clock
<FILE>gstparse</FILE>
<TITLE>GstParse</TITLE>
GstParseError
+GST_PARSE_ERROR
+gst_parse_error_quark
gst_parse_launch
gst_parse_launchv
</SECTION>
GST_EVENT_SRC
GST_EVENT_TIMESTAMP
GstSeekType
+GstSeekAccuracy
GST_EVENT_SEEK_TYPE
+GST_EVENT_SEEK_FORMAT
+GST_EVENT_SEEK_METHOD
+GST_EVENT_SEEK_FLAGS
GST_EVENT_SEEK_OFFSET
-GST_EVENT_SEEK_FLUSH
-GST_EVENT_INFO_PROPS
+GST_EVENT_SEEK_ACCURACY
+GST_SEEK_FLAGS_MASK
+GST_SEEK_FLAGS_SHIFT
+GST_SEEK_FORMAT_MASK
+GST_SEEK_FORMAT_SHIFT
+GST_SEEK_METHOD_MASK
+GST_SEEK_METHOD_SHIFT
+GST_EVENT_DISCONT_NEW_MEDIA
+GST_EVENT_DISCONT_OFFSET
+GST_EVENT_DISCONT_OFFSET_LEN
GstEvent
gst_event_new
-gst_event_free
gst_event_copy
+gst_event_free
gst_event_new_seek
+gst_event_new_discontinuous
+gst_event_discont_get_value
+gst_event_new_filler
gst_event_new_flush
-gst_event_new_info
<SUBSECTION Standard>
GST_EVENT
GST_IS_EVENT
gst_element_get_pad
gst_element_get_static_pad
gst_element_get_request_pad
+gst_element_release_request_pad
gst_element_get_pad_list
+gst_element_get_pad_template
gst_element_get_pad_template_list
-gst_element_get_pad_template_by_name
gst_element_class_add_pad_template
gst_element_connect
gst_element_disconnect_many
gst_element_disconnect_pads
gst_element_get_compatible_pad
-gst_element_get_compatible_static_pad
-gst_element_get_compatible_request_pad
gst_element_get_compatible_pad_filtered
+gst_element_get_compatible_pad_template
gst_element_set_state
gst_element_get_state
gst_element_set_eos
gst_element_interrupt
gst_element_yield
+gst_element_release_locks
gst_element_get_clock
gst_element_set_clock
gst_element_set_parent
gst_element_get_managing_bin
+GstElementPostRunFunction
+GstElementPreRunFunction
+
+gst_element_disable_threadsafe_properties
+gst_element_enable_threadsafe_properties
+gst_element_get
+gst_element_get_property
+gst_element_get_valist
+gst_element_set
+gst_element_set_pending_properties
+gst_element_set_property
+gst_element_set_valist
+
+gst_element_query
+gst_element_send_event
+
GstElementState
GstElementStateReturn
GST_NUM_STATES
</SECTION>
<SECTION>
-<FILE>gstelement_factory</FILE>
+<FILE>gstelementfactory</FILE>
<TITLE>GstElementFactory</TITLE>
GstElementDetails
gst_element_factory_new
gst_element_factory_find
-gst_element_factory_get_list
gst_element_factory_add_pad_template
gst_element_factory_can_src_caps
gst_element_factory_can_sink_caps
gst_element_factory_create
gst_element_factory_make
+gst_element_factory_set_rank
+GST_ELEMENT_RANK_MARGINAL
+GST_ELEMENT_RANK_NONE
+GST_ELEMENT_RANK_PRIMARY
+GST_ELEMENT_RANK_SECONDARY
<SUBSECTION Standard>
GstElementFactory
GST_ELEMENT_FACTORY
gst_autoplug_factory_new
gst_autoplug_factory_destroy
gst_autoplug_factory_find
-gst_autoplug_factory_get_list
gst_autoplug_factory_create
gst_autoplug_factory_make
<SUBSECTION Standard>
GstClockCallback
GstClockID
GstClockReturn
+GST_CLOCK_TIME_NONE
+GST_SECOND
+GST_MSECOND
+GST_USECOND
+GST_NSECOND
GST_CLOCK_DIFF
GST_TIMEVAL_TO_TIME
+GST_TIME_TO_TIMEVAL
GstClock
+gst_clock_set_speed
+gst_clock_get_speed
gst_clock_set_active
gst_clock_is_active
+gst_clock_reset
+gst_clock_handle_discont
gst_clock_async_supported
+gst_clock_wait
gst_clock_wait_async
gst_clock_cancel_wait_async
gst_clock_notify_async
gst_clock_remove_notify_async
-gst_clock_unlock_id
gst_clock_wait_id
gst_clock_get_next_id
+gst_clock_unlock_id
gst_clock_get_time
gst_clock_id_get_time
gst_clock_get_resolution
gst_clock_set_resolution
-gst_clock_set_speed
-gst_clock_get_speed
-gst_clock_reset
-gst_clock_wait
<SUBSECTION Standard>
gst_clock_get_type
GST_TYPE_CLOCK
GST_IS_CLOCK_CLASS
</SECTION>
+<SECTION>
+<FILE>gstregistry</FILE>
+<TITLE>GstRegistry</TITLE>
+GstRegistryReturn
+GstRegistryFlags
+<TITLE>GstRegistry</TITLE>
+gst_registry_load
+gst_registry_is_loaded
+gst_registry_save
+gst_registry_rebuild
+gst_registry_unload
+gst_registry_add_path
+gst_registry_get_path_list
+gst_registry_clear_paths
+gst_registry_add_plugin
+gst_registry_remove_plugin
+gst_registry_find_plugin
+gst_registry_find_feature
+gst_registry_load_plugin
+gst_registry_unload_plugin
+gst_registry_update_plugin
+gst_registry_pool_list
+gst_registry_pool_add
+gst_registry_pool_remove
+gst_registry_pool_add_plugin
+gst_registry_pool_load_all
+gst_registry_pool_plugin_list
+gst_registry_pool_feature_list
+gst_registry_pool_find_plugin
+gst_registry_pool_find_feature
+gst_registry_pool_get_prefered
+<SUBSECTION Standard>
+REGISTRY_DIR_PERMS
+REGISTRY_TMPFILE_PERMS
+REGISTRY_FILE_PERMS
+GLOBAL_REGISTRY_DIR
+GLOBAL_REGISTRY_FILE
+GLOBAL_REGISTRY_FILE_TMP
+LOCAL_REGISTRY_DIR
+LOCAL_REGISTRY_FILE
+LOCAL_REGISTRY_FILE_TMP
+GST_REGISTRY
+GST_IS_REGISTRY
+GST_TYPE_REGISTRY
+gst_registry_get_type
+GST_REGISTRY_CLASS
+GST_IS_REGISTRY_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>gstsystemclock</FILE>
+<TITLE>GstSystemClock</TITLE>
+gst_system_clock_obtain
+<SUBSECTION Standard>
+GST_SYSTEM_CLOCK
+GST_IS_SYSTEM_CLOCK
+GST_TYPE_SYSTEM_CLOCK
+gst_system_clock_get_type
+GST_SYSTEM_CLOCK_CLASS
+GST_IS_SYSTEM_CLOCK_CLASS
+</SECTION>
+
+
<SECTION>
<FILE>gstlog</FILE>
<SUBSECTION Standard>
GstPad
GstPadChainFunction
GstPadGetFunction
-GstPadGetRegionFunction
GstPadBufferPoolFunction
GstPadGetCapsFunction
-GstRegionType
-GstPadPullRegionFunction
GstPadEventFunction
GstPadConnectFunction
GstPadConnectReturn
+GstPadConvertFunction
+GstPadDispatcherFunc
+GstPadIntConnFunction
+
+GstPadQueryType
+GstPadQueryFunction
GstPadDirection
GstPadFlags
gst_pad_new
+gst_pad_custom_new
+gst_pad_custom_new_from_template
gst_pad_destroy
gst_pad_new_from_template
gst_pad_get_direction
gst_pad_set_chain_function
gst_pad_set_get_function
-gst_pad_set_getregion_function
gst_pad_set_bufferpool_function
gst_pad_set_connect_function
gst_pad_set_getcaps_function
gst_pad_can_connect_filtered
gst_pad_push
gst_pad_pull
-gst_pad_pullregion
gst_pad_get_bufferpool
gst_pad_load_and_connect
gst_pad_proxy_connect
gst_pad_peek
gst_pad_select
gst_pad_selectv
+
+gst_pad_dispatcher
+
gst_pad_send_event
gst_pad_event_default
gst_pad_set_event_function
+gst_pad_set_convert_function
+gst_pad_convert
+gst_pad_convert_default
+
+gst_pad_get_internal_connections
+gst_pad_get_internal_connections_default
+gst_pad_set_internal_connection_function
+
+gst_pad_set_query_function
+gst_pad_query
+gst_pad_query_default
+
+
GstRealPad
-GST_RPAD_LEN
-GST_RPAD_OFFSET
GST_RPAD_SCHED
-GST_RPAD_REGIONTYPE
GST_RPAD_DIRECTION
GST_RPAD_CAPS
GST_RPAD_PEER
GST_RPAD_FILTER
GST_RPAD_APPFILTER
GST_RPAD_GETFUNC
-GST_RPAD_GETREGIONFUNC
-GST_RPAD_PULLREGIONFUNC
GST_RPAD_BUFFERPOOLFUNC
GST_RPAD_CHAINHANDLER
GST_RPAD_EVENTFUNC
GST_RPAD_GETHANDLER
GST_RPAD_CONNECTFUNC
GST_RPAD_GETCAPSFUNC
+GST_RPAD_CONVERTFUNC
+GST_RPAD_INTCONNFUNC
+GST_RPAD_QUERYFUNC
GST_GPAD_REALPAD
GstGhostPad
<SECTION>
<FILE>gstpadtemplate</FILE>
-<TITLE>GstPAD_TEMPLATE</TITLE>
+<TITLE>GstPadTemplate</TITLE>
GstPadPresence
-GstPAD_TEMPLATE
+GstPadTemplate
GST_PAD_TEMPLATE_CAPS
GST_PAD_TEMPLATE_DIRECTION
GST_PAD_TEMPLATE_NAME_TEMPLATE
GST_PAD_TEMPLATE_FIXED
GST_PAD_TEMPLATE_IS_FIXED
gst_pad_template_new
-gst_pad_template_load_thyself
-gst_pad_template_save_thyself
gst_pad_template_get_caps
gst_pad_template_get_caps_by_name
<SUBSECTION Standard>
-GstPAD_TEMPLATEClass
+GstPadTemplateClass
GST_TYPE_PAD_TEMPLATE
GST_PAD_TEMPLATE
GST_PAD_TEMPLATE_CLASS
<SECTION>
<FILE>gstplugin</FILE>
<TITLE>GstPlugin</TITLE>
+GST_PLUGIN_ERROR
+gst_plugin_error_quark
+GstPluginError
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
gst_plugin_get_longname
gst_plugin_set_longname
gst_plugin_get_filename
gst_plugin_is_loaded
-gst_plugin_load_all
-gst_plugin_load
-gst_plugin_load_absolute
-gst_plugin_add_path
-gst_library_load
-gst_plugin_find
-gst_plugin_get_list
-gst_plugin_load_thyself
-gst_plugin_save_thyself
-gst_plugin_add_feature
gst_plugin_get_feature_list
+gst_plugin_find_feature
gst_plugin_load_plugin
-gst_plugin_unload_all
+gst_plugin_unload_plugin
+gst_plugin_add_feature
+gst_plugin_load
+gst_library_load
<SUBSECTION Standard>
+GST_PLUGIN
</SECTION>
<SECTION>
<FILE>gstpluginfeature</FILE>
<TITLE>GstPluginFeature</TITLE>
+GST_PLUGIN_FEATURE_NAME
gst_plugin_feature_ensure_loaded
gst_plugin_feature_unload_thyself
<SUBSECTION Standard>
GstTypeFindFunc
gst_type_factory_new
gst_type_factory_find
-gst_type_factory_get_list
<SUBSECTION Standard>
GST_TYPE_FACTORY
GST_IS_TYPE_FACTORY
<FILE>gstprops</FILE>
<TITLE>GstProps</TITLE>
GstProps
-GstPropsEntry
GstPropsType
GST_TYPE_PROPS
GST_MAKE_FOURCC
GST_PROPS_FLOAT
GST_PROPS_FLOAT_RANGE
GST_PROPS_INT_POSITIVE
+GstPropsEntry
gst_props_new
gst_props_newv
+gst_props_empty_new
gst_props_merge
gst_props_copy
gst_props_copy_on_write
gst_props_normalize
gst_props_set
gst_props_get
+gst_props_get_safe
+gst_props_has_property
gst_props_has_fixed_property
gst_props_has_property_typed
gst_props_intersect
gst_props_load_thyself
gst_props_get_entry
+gst_props_add_entry
+gst_props_entry_new
gst_props_entry_get
gst_props_entry_get_boolean
gst_props_entry_get_float
int
main (int argc, char *argv[])
{
- // initialize the GStreamer library
+ /* initialize the GStreamer library */
gst_init (&argc, &argv);
...
}
</programlisting>
</para>
+
+<para>
+You can also use a popt table to initialize your own parameters as shown in the next code
+fragment:
+ <programlisting>
+ static gboolean stats = FALSE;
+ ...
+
+ int
+ main (int argc, char *argv[])
+ {
+ struct poptOption options[] = {
+ { "stats", 's', POPT_ARG_NONE|POPT_ARGFLAG_STRIP, &stats, 0,
+ "Show pad stats", NULL},
+ POPT_TABLEEND
+ };
+
+ /* initialize the GStreamer library */
+ gst_init_with_popt_table (&argc, &argv, options);
+
+ ...
+ }
+ </programlisting>
+</para>
<para>
Use gst_version() to query the library version at runtime or use the GST_VERSION_* macros
to find the version at compile time.
@Returns:
-<!-- ##### FUNCTION gst_autoplug_factory_get_list ##### -->
-<para>
-
-</para>
-
-@Returns:
-
-
<!-- ##### FUNCTION gst_autoplug_factory_create ##### -->
<para>
<para>
gst_bin_destroy() is used to destroy the bin.
</para>
+<para>
+To control the selection of the clock in a bin, you can use the following methods:
+gst_bin_auto_clock() to let the bin select a clock automatically, gst_bin_get_clock() to
+get the current clock of the bin and gst_bin_use_clock() to specify a clock explicitly.
+</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
+<!-- ##### USER_FUNCTION GstBinPrePostIterateFunction ##### -->
+<para>
+The signature of the callback for the post and pre iterate function as set with
+gst_bin_set_pre_iterate_function() and gst_bin_set_post_iterate_function().
+</para>
+
+@bin: The bin that performed the callback
+@data: user data
+
+
<!-- ##### FUNCTION gst_bin_new ##### -->
<para>
@Returns:
+<!-- ##### FUNCTION gst_bin_set_post_iterate_function ##### -->
+<para>
+
+</para>
+
+@bin:
+@func:
+@func_data:
+
+
+<!-- ##### FUNCTION gst_bin_set_pre_iterate_function ##### -->
+<para>
+
+</para>
+
+@bin:
+@func:
+@func_data:
+
+
<!-- ##### FUNCTION gst_bin_child_state_change ##### -->
<para>
@GST_BUFFER_READONLY: buffer is read-only
@GST_BUFFER_ORIGINAL: buffer is not a copy of another buffer
@GST_BUFFER_DONTFREE: do not try to free the data when this buffer is unreferenced
+@GST_BUFFER_DISCONTINOUS: This buffer is the first one after a discontinuity in the stream
+@GST_BUFFER_KEY_UNIT: This buffer holds a key unit, a unit that can be decoded independently
+ of other buffers
+@GST_BUFFER_PREROLL: This buffer should be decoded but not rendered, it is mainly used
+ to resynchronise the stream
<!-- ##### STRUCT GstBuffer ##### -->
<para>
@Returns:
+<!-- ##### FUNCTION gst_caps_copy_1 ##### -->
+<para>
+
+</para>
+
+@caps:
+@Returns:
+
+
<!-- ##### FUNCTION gst_caps_copy_on_write ##### -->
<para>
@caps: the caps to query
@name: the name of the property
+@type:
<!-- ##### FUNCTION gst_caps_normalize ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+GStreamer uses a global clock to synchronise the plugins in a pipeline.
+Different clock implementations are possible by implementing this abstract
+base class.
+</para>
+<para>
+The clock time is always measured in nanoseconds, with the clock being set
+to 0 when the pipeline goes to READY. Usually all renderers sync to the global
+clock so that the clock is always a good measure of the time in the pipeline.
</para>
<!-- ##### SECTION See_Also ##### -->
<!-- ##### TYPEDEF GstClockTime ##### -->
<para>
-A datatype to hold a time, measured in microseconds.
+A datatype to hold a time, measured in nanoseconds.
</para>
<!-- ##### TYPEDEF GstClockTimeDiff ##### -->
<para>
-A datatype to hold a timedifference, measured in microseconds.
+A datatype to hold a timedifference, measured in nanoseconds.
</para>
@GST_CLOCK_EARLY: The operation was scheduled too late.
@GST_CLOCK_ERROR: An error occured
+<!-- ##### MACRO GST_CLOCK_TIME_NONE ##### -->
+<para>
+Constant to define an undefined clock time
+</para>
+
+
+
+<!-- ##### MACRO GST_SECOND ##### -->
+<para>
+Constant that defines one GStreamer second
+</para>
+
+
+
+<!-- ##### MACRO GST_MSECOND ##### -->
+<para>
+Constant that defines one GStreamer millisecond
+</para>
+
+
+
+<!-- ##### MACRO GST_USECOND ##### -->
+<para>
+Constant that defines one GStreamer microsecond
+</para>
+
+
+
+<!-- ##### MACRO GST_NSECOND ##### -->
+<para>
+Constant that defines one GStreamer nanosecond
+</para>
+
+
+
<!-- ##### MACRO GST_CLOCK_DIFF ##### -->
<para>
Calculate a difference between to clock times.
@tv: the timeval to convert
+<!-- ##### MACRO GST_TIME_TO_TIMEVAL ##### -->
+<para>
+Convert a GstClockTime to a GTimeVal
+</para>
+
+@t: The GstClockTime to convert
+@tv: The target timeval
+
+
<!-- ##### STRUCT GstClock ##### -->
<para>
The opaque data structure of the clock.
</para>
-<!-- ##### FUNCTION gst_clock_set_active ##### -->
+<!-- ##### FUNCTION gst_clock_set_speed ##### -->
<para>
</para>
@clock:
-@active:
+@speed:
-<!-- ##### FUNCTION gst_clock_is_active ##### -->
+<!-- ##### FUNCTION gst_clock_get_speed ##### -->
<para>
</para>
@clock:
@Returns:
+<!-- # Unused Parameters # -->
+@speed:
-<!-- ##### FUNCTION gst_clock_async_supported ##### -->
+<!-- ##### FUNCTION gst_clock_set_active ##### -->
<para>
</para>
@clock:
-@Returns:
+@active:
-<!-- ##### FUNCTION gst_clock_wait_async ##### -->
+<!-- ##### FUNCTION gst_clock_is_active ##### -->
<para>
</para>
@clock:
-@time:
-@func:
-@user_data:
@Returns:
-<!-- ##### FUNCTION gst_clock_cancel_wait_async ##### -->
+<!-- ##### FUNCTION gst_clock_reset ##### -->
<para>
</para>
@clock:
-@id:
-<!-- ##### FUNCTION gst_clock_notify_async ##### -->
+<!-- ##### FUNCTION gst_clock_handle_discont ##### -->
<para>
</para>
@clock:
-@interval:
-@func:
-@user_data:
+@time:
@Returns:
-<!-- ##### FUNCTION gst_clock_remove_notify_async ##### -->
+<!-- ##### FUNCTION gst_clock_async_supported ##### -->
<para>
</para>
@clock:
-@id:
+@Returns:
-<!-- ##### FUNCTION gst_clock_unlock_id ##### -->
+<!-- ##### FUNCTION gst_clock_wait ##### -->
<para>
</para>
@clock:
-@id:
+@time:
+@jitter:
+@Returns:
-<!-- ##### FUNCTION gst_clock_wait_id ##### -->
+<!-- ##### FUNCTION gst_clock_wait_async ##### -->
<para>
</para>
@clock:
-@id:
+@time:
+@func:
+@user_data:
@Returns:
-<!-- ##### FUNCTION gst_clock_get_next_id ##### -->
+<!-- ##### FUNCTION gst_clock_cancel_wait_async ##### -->
<para>
</para>
@clock:
-@Returns:
+@id:
-<!-- ##### FUNCTION gst_clock_get_time ##### -->
+<!-- ##### FUNCTION gst_clock_notify_async ##### -->
<para>
</para>
@clock:
+@interval:
+@func:
+@user_data:
@Returns:
-<!-- ##### FUNCTION gst_clock_id_get_time ##### -->
+<!-- ##### FUNCTION gst_clock_remove_notify_async ##### -->
<para>
</para>
+@clock:
@id:
-@Returns:
-<!-- ##### FUNCTION gst_clock_get_resolution ##### -->
+<!-- ##### FUNCTION gst_clock_wait_id ##### -->
<para>
</para>
@clock:
+@id:
+@jitter:
@Returns:
-<!-- ##### FUNCTION gst_clock_set_resolution ##### -->
+<!-- ##### FUNCTION gst_clock_get_next_id ##### -->
<para>
</para>
@clock:
-@resolution:
+@Returns:
-<!-- ##### FUNCTION gst_clock_set_speed ##### -->
+<!-- ##### FUNCTION gst_clock_unlock_id ##### -->
<para>
</para>
@clock:
-@speed:
+@id:
-<!-- ##### FUNCTION gst_clock_get_speed ##### -->
+<!-- ##### FUNCTION gst_clock_get_time ##### -->
<para>
</para>
@clock:
@Returns:
-<!-- # Unused Parameters # -->
-@speed:
-<!-- ##### FUNCTION gst_clock_reset ##### -->
+<!-- ##### FUNCTION gst_clock_id_get_time ##### -->
<para>
</para>
-@clock:
+@id:
+@Returns:
-<!-- ##### FUNCTION gst_clock_wait ##### -->
+<!-- ##### FUNCTION gst_clock_get_resolution ##### -->
<para>
</para>
@clock:
-@time:
@Returns:
+<!-- ##### FUNCTION gst_clock_set_resolution ##### -->
+<para>
+
+</para>
+
+@clock:
+@resolution:
+
+
@Returns:
+<!-- ##### FUNCTION gst_element_release_request_pad ##### -->
+<para>
+
+</para>
+
+@element:
+@pad:
+
+
<!-- ##### FUNCTION gst_element_get_pad_list ##### -->
<para>
@Returns:
+<!-- ##### FUNCTION gst_element_get_pad_template ##### -->
+<para>
+
+</para>
+
+@element:
+@name:
+@Returns:
+
+
<!-- ##### FUNCTION gst_element_get_pad_template_list ##### -->
<para>
@Returns:
+<!-- ##### FUNCTION gst_element_get_compatible_pad_template ##### -->
+<para>
+
+</para>
+
+@element:
+@compattempl:
+@Returns:
+
+
<!-- ##### FUNCTION gst_element_set_state ##### -->
<para>
@element:
+<!-- ##### FUNCTION gst_element_release_locks ##### -->
+<para>
+
+</para>
+
+@element:
+@Returns:
+
+
<!-- ##### FUNCTION gst_element_get_clock ##### -->
<para>
@element:
@clock:
@time:
+@jitter:
@Returns:
<!-- clocking -->
+<!-- ##### USER_FUNCTION GstElementPostRunFunction ##### -->
+<para>
+
+</para>
+
+@element:
+
+
+<!-- ##### USER_FUNCTION GstElementPreRunFunction ##### -->
+<para>
+
+</para>
+
+@element:
+
+
+<!-- ##### FUNCTION gst_element_disable_threadsafe_properties ##### -->
+<para>
+
+</para>
+
+@element:
+
+
+<!-- ##### FUNCTION gst_element_enable_threadsafe_properties ##### -->
+<para>
+
+</para>
+
+@element:
+
+
+<!-- ##### FUNCTION gst_element_get ##### -->
+<para>
+
+</para>
+
+@element:
+@first_property_name:
+@Varargs:
+
+
+<!-- ##### FUNCTION gst_element_get_property ##### -->
+<para>
+
+</para>
+
+@element:
+@property_name:
+@value:
+
+
+<!-- ##### FUNCTION gst_element_get_valist ##### -->
+<para>
+
+</para>
+
+@element:
+@first_property_name:
+@var_args:
+
+
+<!-- ##### FUNCTION gst_element_set ##### -->
+<para>
+
+</para>
+
+@element:
+@first_property_name:
+@Varargs:
+
+
+<!-- ##### FUNCTION gst_element_set_pending_properties ##### -->
+<para>
+
+</para>
+
+@element:
+
+
+<!-- ##### FUNCTION gst_element_set_property ##### -->
+<para>
+
+</para>
+
+@element:
+@property_name:
+@value:
+
+
+<!-- ##### FUNCTION gst_element_set_valist ##### -->
+<para>
+
+</para>
+
+@element:
+@first_property_name:
+@var_args:
+
+
+<!-- ##### FUNCTION gst_element_query ##### -->
+<para>
+
+</para>
+
+@element:
+@type:
+@format:
+@value:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_element_send_event ##### -->
+<para>
+
+</para>
+
+@element:
+@event:
+@Returns:
+
+
<!-- ##### ENUM GstElementState ##### -->
<para>
This enum defines the standard states an element may be in. You will normally
@GST_ELEMENT_COMPLEX:
@GST_ELEMENT_DECOUPLED:
@GST_ELEMENT_THREAD_SUGGESTED:
-@GST_ELEMENT_NO_SEEK:
@GST_ELEMENT_INFINITE_LOOP:
-@GST_ELEMENT_SCHEDULER_PRIVATE1:
-@GST_ELEMENT_SCHEDULER_PRIVATE2:
@GST_ELEMENT_NEW_LOOPFUNC:
@GST_ELEMENT_EVENT_AWARE:
+@GST_ELEMENT_USE_THREADSAFE_PROPERTIES:
+@GST_ELEMENT_SCHEDULER_PRIVATE1:
+@GST_ELEMENT_SCHEDULER_PRIVATE2:
@GST_ELEMENT_FLAG_LAST:
<!-- ##### MACRO GST_ELEMENT_IS_THREAD_SUGGESTED ##### -->
@obj: a #GstElement to query
+<!-- ##### SIGNAL GstElement::deep-notify ##### -->
+<para>
+
+</para>
+
+@gstelement: the object which received the signal.
+@arg1:
+@arg2:
+
<!-- ##### SIGNAL GstElement::eos ##### -->
<para>
with gst_plugin_add_feature().
</para>
<para>
-gst_element_factory_get_list() is used to get a list of all available factories in
-the plugin repository.
-</para>
-<para>
gst_element_factory_add_pad_template() is used to add a padtemplate to the factory.
This function will enable the application to query for elementfactories that handle
a specific media type.
...
</programlisting>
</para>
+<para>
+An elementfactory can be assigned a rank with gst_element_factory_set_rank()
+so that the autopluggers can select a plugin more appropriatly
+</para>
<!-- ##### SECTION See_Also ##### -->
<para>
@author:
@copyright:
+<!-- ##### FUNCTION gst_element_factory_new ##### -->
+<para>
+
+</para>
+
+@name:
+@type:
+@details:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_element_factory_find ##### -->
+<para>
+
+</para>
+
+@name:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_element_factory_add_pad_template ##### -->
+<para>
+
+</para>
+
+@elementfactory:
+@templ:
+
+
+<!-- ##### FUNCTION gst_element_factory_can_src_caps ##### -->
+<para>
+
+</para>
+
+@factory:
+@caps:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_element_factory_can_sink_caps ##### -->
+<para>
+
+</para>
+
+@factory:
+@caps:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_element_factory_create ##### -->
+<para>
+
+</para>
+
+@factory:
+@name:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_element_factory_make ##### -->
+<para>
+
+</para>
+
+@factoryname:
+@name:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_element_factory_set_rank ##### -->
+<para>
+
+</para>
+
+@factory:
+@rank:
+
+
+<!-- ##### MACRO GST_ELEMENT_RANK_MARGINAL ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO GST_ELEMENT_RANK_NONE ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO GST_ELEMENT_RANK_PRIMARY ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO GST_ELEMENT_RANK_SECONDARY ##### -->
+<para>
+
+</para>
+
+
+
@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.
-@GST_EVENT_NEW_MEDIA:
-@GST_EVENT_INFO: an informational event
-@GST_EVENT_ERROR: an error event
+@GST_EVENT_NEW_MEDIA: a new media stream is started
+@GST_EVENT_QOS: a quality of service event
+@GST_EVENT_SEEK: a seek event.
+@GST_EVENT_FILLER: a dummy element that should be ignored by plugins
<!-- ##### MACRO GST_EVENT_TYPE ##### -->
<para>
The different types of seek events.
</para>
-@GST_SEEK_ANY: the seek is performed anyway.
-@GST_SEEK_TIMEOFFSET_SET:
-@GST_SEEK_BYTEOFFSET_SET:
-@GST_SEEK_BYTEOFFSET_CUR:
-@GST_SEEK_BYTEOFFSET_END:
+@GST_SEEK_METHOD_CUR: Seek to an relative position
+@GST_SEEK_METHOD_SET: Seek to an absolute position
+@GST_SEEK_METHOD_END: Seek relative to the end of the stream
+@GST_SEEK_FLAG_FLUSH: Flush any pending data while seeking
+@GST_SEEK_FLAG_ACCURATE: Seek as accuratly as possible
+@GST_SEEK_FLAG_KEY_UNIT: Seek to a nearby key unit
+
+<!-- ##### ENUM GstSeekAccuracy ##### -->
+<para>
+The seekaccuracy gives more information of how the seek was performed,
+if the seek was accurate or fuzzy.
+</para>
+
+@GST_SEEK_CERTAIN:
+@GST_SEEK_FUZZY:
<!-- ##### MACRO GST_EVENT_SEEK_TYPE ##### -->
<para>
@event: The event to query.
+<!-- ##### MACRO GST_EVENT_SEEK_FORMAT ##### -->
+<para>
+The format of the seek value
+</para>
+
+@event: The event operate on
+
+
+<!-- ##### MACRO GST_EVENT_SEEK_METHOD ##### -->
+<para>
+The seek method to use as one of #GstSeekType
+</para>
+
+@event: The event operate on
+
+
+<!-- ##### MACRO GST_EVENT_SEEK_FLAGS ##### -->
+<para>
+The optional seek flags
+</para>
+
+@event: The event operate on
+
+
<!-- ##### MACRO GST_EVENT_SEEK_OFFSET ##### -->
<para>
Get the offset of the seek event.
@event: The event to query.
-<!-- ##### MACRO GST_EVENT_SEEK_FLUSH ##### -->
+<!-- ##### MACRO GST_EVENT_SEEK_ACCURACY ##### -->
<para>
-Qeury wether the seek event also needs a flush.
+Indicates how accurate the event was performed.
</para>
-@event: The event to query.
+@event: The event to query
+
+<!-- ##### MACRO GST_SEEK_FLAGS_MASK ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO GST_SEEK_FLAGS_SHIFT ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO GST_SEEK_FORMAT_MASK ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO GST_SEEK_FORMAT_SHIFT ##### -->
+<para>
+
+</para>
-<!-- ##### MACRO GST_EVENT_INFO_PROPS ##### -->
+
+
+<!-- ##### MACRO GST_SEEK_METHOD_MASK ##### -->
<para>
-The properties of the info event
+
+</para>
+
+
+
+<!-- ##### MACRO GST_SEEK_METHOD_SHIFT ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO GST_EVENT_DISCONT_NEW_MEDIA ##### -->
+<para>
+Flag that indicates the discont event was because of a new media
+type.
+</para>
+
+@event: The event to operate on
+
+
+<!-- ##### MACRO GST_EVENT_DISCONT_OFFSET ##### -->
+<para>
+The offset of the discont event. A discont evetn can hold up to 8 different
+format/value pairs.
</para>
@event: The event to query
+@i: The offset/value pair.
+
+
+<!-- ##### MACRO GST_EVENT_DISCONT_OFFSET_LEN ##### -->
+<para>
+Get the number of offset/value pairs this event has.
+</para>
+
+@event: The event to query.
<!-- ##### STRUCT GstEvent ##### -->
@data: The parent data type.
@type: The event type.
@timestamp: The event timestamp.
-@src:
+@src: The object that generated the event
<!-- ##### FUNCTION gst_event_new ##### -->
<para>
@Returns:
-<!-- ##### FUNCTION gst_event_free ##### -->
+<!-- ##### FUNCTION gst_event_copy ##### -->
<para>
</para>
@event:
+@Returns:
-<!-- ##### FUNCTION gst_event_copy ##### -->
+<!-- ##### FUNCTION gst_event_free ##### -->
<para>
</para>
@event:
-@Returns:
<!-- ##### FUNCTION gst_event_new_seek ##### -->
@type:
@offset:
-@flush:
@Returns:
-<!-- ##### MACRO gst_event_new_flush ##### -->
+<!-- ##### FUNCTION gst_event_new_discontinuous ##### -->
<para>
-Create a new flush event.
+
</para>
+@new_media:
+@format1:
+@Varargs:
+@Returns:
-<!-- ##### FUNCTION gst_event_new_info ##### -->
+<!-- ##### FUNCTION gst_event_discont_get_value ##### -->
<para>
</para>
-@firstname:
-@Varargs:
+@event:
+@format:
+@value:
@Returns:
+<!-- ##### MACRO gst_event_new_filler ##### -->
+<para>
+Create a new dummy event that should be ignored
+</para>
+
+
+
+<!-- ##### MACRO gst_event_new_flush ##### -->
+<para>
+Create a new flush event.
+</para>
+
+
+
@Returns:
-<!-- ##### SIGNAL GstObject::deep-notify ##### -->
-<para>
-
-</para>
-
-@gstobject: the object which received the signal.
-@arg1:
-@arg2:
-
<!-- ##### SIGNAL GstObject::object-saved ##### -->
<para>
Is trigered whenever a new object is saved to XML. You can connect to
@Returns: a #GstBuffer
-<!-- ##### USER_FUNCTION GstPadGetRegionFunction ##### -->
-<para>
-The function that will be called when pulling a region buffer.
-You can specify which buffer to get using an offset/length pair or
-a start/stop timecode pair.
-</para>
-
-@pad: the pad to get a buffer from
-@type: the type of region to get (time or offset based)
-@offset: the offset of the region to get
-@len: the length of the region to get
-@Returns: a #GstBuffer
-
-
<!-- ##### USER_FUNCTION GstPadBufferPoolFunction ##### -->
<para>
The function that will be called when a bufferpool is requested
@Returns: The caps of the pad.
-<!-- ##### ENUM GstRegionType ##### -->
-<para>
-the region types for #gst_pad_pullregion.
-</para>
-
-@GST_REGION_VOID:
-@GST_REGION_OFFSET_LEN: an offet/length pair
-@GST_REGION_TIME_LEN: a time start/length pair
-
-<!-- ##### USER_FUNCTION GstPadPullRegionFunction ##### -->
-<para>
-The function that will be called when pulling a region buffer.
-You can specify which buffer to get using an offset/length pair or
-a start/stop timecode pair.
-</para>
-
-@pad: the pad to get a buffer from
-@type: the type of region to get (time or offset based)
-@offset: the offset of the region to get
-@len: the length of the region to get
-@Returns: a #GstBuffer
-
-
<!-- ##### USER_FUNCTION GstPadEventFunction ##### -->
<para>
Function signature to handle an event for the pad.
<!-- ##### ENUM GstPadConnectReturn ##### -->
<para>
+The result of a pad connection.
+</para>
+
+@GST_PAD_CONNECT_REFUSED: The connectino was refused
+@GST_PAD_CONNECT_DELAYED: The connection was delayed, probably because the
+ element needs more specific pad caps.
+@GST_PAD_CONNECT_OK: The connection succeeded.
+@GST_PAD_CONNECT_DONE: The connection succeeded, any more attempts are not needed.
+
+<!-- ##### USER_FUNCTION GstPadConvertFunction ##### -->
+<para>
+The signature of a convert function.
+</para>
+
+@pad: The pad to perform the convert on
+@src_format: The source format of the conversion
+@src_value: The source value of the conversion
+@dest_format: a pointer to the destination format
+@dest_value: a pointer to the destination value
+@Returns: TRUE if the conversion could be performed.
+
+
+<!-- ##### USER_FUNCTION GstPadDispatcherFunc ##### -->
+<para>
+The signature of the dispatcher callback.
+</para>
+
+@pad: The pad that is being dispatched
+@data: user data
+@Returns: TRUE if no further pads need to be processed
+
+
+<!-- ##### USER_FUNCTION GstPadIntConnFunction ##### -->
+<para>
+The signature of the internal pad connection function
+</para>
+
+@pad: The pad to query
+@Returns: a Glist of pads that connect to the requested pad internally to the
+ parent element. g_list_free() after use.
+
+
+<!-- ##### ENUM GstPadQueryType ##### -->
+<para>
+The different supported query types
+</para>
+
+@GST_PAD_QUERY_TOTAL: Query the total stream time
+@GST_PAD_QUERY_POSITION: Query the current stream position
+@GST_PAD_QUERY_LATENCY: Query the latency on the pad
+<!-- ##### USER_FUNCTION GstPadQueryFunction ##### -->
+<para>
+The signature of query function
</para>
-@GST_PAD_CONNECT_REFUSED:
-@GST_PAD_CONNECT_DELAYED:
-@GST_PAD_CONNECT_OK:
-@GST_PAD_CONNECT_DONE:
+@pad: The pad to query
+@type: The query type
+@format: a pointer to the target format
+@value: a pointer to the target value
+@Returns: TRUE if the query could be performed
+
<!-- ##### ENUM GstPadDirection ##### -->
<para>
@Returns:
+<!-- ##### FUNCTION gst_pad_custom_new ##### -->
+<para>
+
+</para>
+
+@type:
+@name:
+@direction:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_pad_custom_new_from_template ##### -->
+<para>
+
+</para>
+
+@type:
+@templ:
+@name:
+@Returns:
+
+
<!-- ##### MACRO gst_pad_destroy ##### -->
<para>
Destroy the pad.
@get:
-<!-- ##### FUNCTION gst_pad_set_getregion_function ##### -->
-<para>
-
-</para>
-
-@pad:
-@getregion:
-
-
<!-- ##### FUNCTION gst_pad_set_bufferpool_function ##### -->
<para>
@Returns:
-<!-- ##### FUNCTION gst_pad_pullregion ##### -->
-<para>
-
-</para>
-
-@pad:
-@type:
-@offset:
-@len:
-@Returns:
-<!-- # Unused Parameters # -->
-@size:
-
-
<!-- ##### FUNCTION gst_pad_get_bufferpool ##### -->
<para>
@Returns:
+<!-- ##### FUNCTION gst_pad_dispatcher ##### -->
+<para>
+
+</para>
+
+@pad:
+@dispatch:
+@data:
+@Returns:
+
+
<!-- ##### FUNCTION gst_pad_send_event ##### -->
<para>
@pad:
@event:
+@Returns:
<!-- ##### FUNCTION gst_pad_set_event_function ##### -->
@event:
+<!-- ##### FUNCTION gst_pad_set_convert_function ##### -->
+<para>
+
+</para>
+
+@pad:
+@convert:
+
+
+<!-- ##### FUNCTION gst_pad_convert ##### -->
+<para>
+
+</para>
+
+@pad:
+@src_format:
+@src_value:
+@dest_format:
+@dest_value:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_pad_convert_default ##### -->
+<para>
+
+</para>
+
+@pad:
+@src_format:
+@src_value:
+@dest_format:
+@dest_value:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_pad_get_internal_connections ##### -->
+<para>
+
+</para>
+
+@pad:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_pad_get_internal_connections_default ##### -->
+<para>
+
+</para>
+
+@pad:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_pad_set_internal_connection_function ##### -->
+<para>
+
+</para>
+
+@pad:
+@intconn:
+
+
+<!-- ##### FUNCTION gst_pad_set_query_function ##### -->
+<para>
+
+</para>
+
+@pad:
+@query:
+
+
+<!-- ##### FUNCTION gst_pad_query ##### -->
+<para>
+
+</para>
+
+@pad:
+@type:
+@format:
+@value:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_pad_query_default ##### -->
+<para>
+
+</para>
+
+@pad:
+@type:
+@format:
+@value:
+@Returns:
+
+
<!-- ##### STRUCT GstRealPad ##### -->
<para>
@sched_private:
@peer:
@bufpen:
-@regiontype:
-@offset:
-@len:
@chainfunc:
@chainhandler:
@getfunc:
@gethandler:
@eventfunc:
@eventhandler:
-@getregionfunc:
-@pullregionfunc:
+@convertfunc:
+@queryfunc:
+@intconnfunc:
@getcapsfunc:
@connectfunc:
@bufferpoolfunc:
@ghostpads:
-<!-- ##### MACRO GST_RPAD_LEN ##### -->
-<para>
-Get the length of the region that is being pulled.
-</para>
-
-@pad: the real pad to query.
-
-
-<!-- ##### MACRO GST_RPAD_OFFSET ##### -->
-<para>
-Get the offset of the region that is being pulled.
-</para>
-
-@pad: the real pad to query.
-
-
<!-- ##### MACRO GST_RPAD_SCHED ##### -->
<para>
Get the scheduler of this real pad.
@pad: the real pad to query.
-<!-- ##### MACRO GST_RPAD_REGIONTYPE ##### -->
-<para>
-Get the type of the region that is being pulled.
-</para>
-
-@pad: the real pad to query.
-
-
<!-- ##### MACRO GST_RPAD_DIRECTION ##### -->
<para>
Get the direction of the real pad.
@pad: the real pad to query.
-<!-- ##### MACRO GST_RPAD_GETREGIONFUNC ##### -->
-<para>
-Get the getregion function of the real pad.
-</para>
-
-@pad: the real pad to query.
-
-
-<!-- ##### MACRO GST_RPAD_PULLREGIONFUNC ##### -->
-<para>
-Get the pullregion function of the real pad.
-</para>
-
-@pad: the real pad to query.
-
-
<!-- ##### MACRO GST_RPAD_BUFFERPOOLFUNC ##### -->
<para>
Get the bufferpoolfunction from the real pad.
@pad: the pad to query
+<!-- ##### MACRO GST_RPAD_CONVERTFUNC ##### -->
+<para>
+Get the convert function of this pad
+</para>
+
+@pad: the pad to query
+
+
+<!-- ##### MACRO GST_RPAD_INTCONNFUNC ##### -->
+<para>
+Get the internal connection function of this pad
+</para>
+
+@pad: the pad to query
+
+
+<!-- ##### MACRO GST_RPAD_QUERYFUNC ##### -->
+<para>
+Get the query function of this pad
+</para>
+
+@pad: the pad to query
+
+
<!-- ##### MACRO GST_GPAD_REALPAD ##### -->
<para>
Get the real pad of this ghost pad.
@GST_PAD_REQUEST: th pad is only available on request with
gst_element_request_pad_by_name() or gst_element_request_compatible_pad().
+<!-- ##### STRUCT GstPadTemplate ##### -->
+<para>
+
+</para>
+
+
<!-- ##### MACRO GST_PAD_TEMPLATE_CAPS ##### -->
<para>
Get a handle to the padtemplate #GstCaps
@Returns:
-<!-- ##### FUNCTION gst_pad_template_load_thyself ##### -->
-<para>
-
-</para>
-
-@parent:
-@Returns:
-
-
-<!-- ##### FUNCTION gst_pad_template_save_thyself ##### -->
-<para>
-
-</para>
-
-@templ:
-@parent:
-@Returns:
-
-
<!-- ##### FUNCTION gst_pad_template_get_caps ##### -->
<para>
</para>
-@GST_PARSE_ERROR_SYNTAX:
-@GST_PARSE_ERROR_NO_SUCH_ELEMENT:
-@GST_PARSE_ERROR_NO_SUCH_PROPERTY:
-@GST_PARSE_ERROR_CONNECT:
+@GST_PARSE_ERROR_SYNTAX: A syntax error was detected
+@GST_PARSE_ERROR_NO_SUCH_ELEMENT: The pipeline description contains a non existing element
+@GST_PARSE_ERROR_NO_SUCH_PROPERTY: The pipeline description contains a non existing element property
+@GST_PARSE_ERROR_CONNECT: A pad connection could not be made
+
+<!-- ##### MACRO GST_PARSE_ERROR ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION gst_parse_error_quark ##### -->
+<para>
+
+</para>
+
+@Returns:
+
<!-- ##### FUNCTION gst_parse_launch ##### -->
<para>
Once you have a handle to a #GstPlugin, you can add any object that subclasses #GstPluginFeature.
</para>
<para>
-use gst_plugin_find(), gst_plugin_get_list() and gst_plugin_get_feature_list()
-to query the plugin repository.
+use gst_plugin_find_feature() and gst_plugin_get_feature_list() to find features in a plugin.
</para>
<para>
Usually plugins are always automaticlly loaded so you don't need to call gst_plugin_load() explicitly
#GstPluginFeature, #GstType, #GstAutoplug, #GstElementFactory
</para>
+<!-- ##### MACRO GST_PLUGIN_ERROR ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION gst_plugin_error_quark ##### -->
+<para>
+
+</para>
+
+@Returns:
+
+
+<!-- ##### ENUM GstPluginError ##### -->
+<para>
+The plugin loading errors
+</para>
+
+@GST_PLUGIN_ERROR_MODULE: The plugin could not be loaded
+@GST_PLUGIN_ERROR_DEPENDENCIES: The plugin has unresolved dependencies
+
<!-- ##### STRUCT GstPlugin ##### -->
<para>
@filename:
@features:
@numfeatures:
+@manager:
@module:
+@init_called:
<!-- ##### USER_FUNCTION GstPluginInitFunc ##### -->
<para>
@init: The init function of this plugin.
+<!-- ##### FUNCTION gst_plugin_new ##### -->
+<para>
+
+</para>
+
+@filename:
+@Returns:
+<!-- # Unused Parameters # -->
+@name:
+@major:
+@minor:
+
+
<!-- ##### FUNCTION gst_plugin_set_name ##### -->
<para>
@Returns:
-<!-- ##### FUNCTION gst_plugin_load_all ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### FUNCTION gst_plugin_load ##### -->
-<para>
-
-</para>
-
-@name:
-@Returns:
-
-
-<!-- ##### FUNCTION gst_plugin_load_absolute ##### -->
-<para>
-
-</para>
-
-@name:
-@Returns:
-
-
-<!-- ##### FUNCTION gst_plugin_add_path ##### -->
-<para>
-
-</para>
-
-@path:
-
-
-<!-- ##### FUNCTION gst_library_load ##### -->
+<!-- ##### FUNCTION gst_plugin_get_feature_list ##### -->
<para>
</para>
-@name:
+@plugin:
@Returns:
-<!-- ##### FUNCTION gst_plugin_find ##### -->
+<!-- ##### FUNCTION gst_plugin_find_feature ##### -->
<para>
</para>
+@plugin:
@name:
+@type:
@Returns:
-<!-- ##### FUNCTION gst_plugin_get_list ##### -->
+<!-- ##### FUNCTION gst_plugin_load_plugin ##### -->
<para>
</para>
+@plugin:
+@error:
@Returns:
-<!-- ##### FUNCTION gst_plugin_load_thyself ##### -->
+<!-- ##### FUNCTION gst_plugin_unload_plugin ##### -->
<para>
</para>
-@parent:
-
-
-<!-- ##### FUNCTION gst_plugin_save_thyself ##### -->
-<para>
-
-</para>
-
-@parent:
+@plugin:
@Returns:
@feature:
-<!-- ##### FUNCTION gst_plugin_get_feature_list ##### -->
+<!-- ##### FUNCTION gst_plugin_load ##### -->
<para>
</para>
-@plugin:
+@name:
@Returns:
-<!-- ##### FUNCTION gst_plugin_load_plugin ##### -->
+<!-- ##### FUNCTION gst_library_load ##### -->
<para>
</para>
-@plugin:
+@name:
@Returns:
-<!-- ##### FUNCTION gst_plugin_unload_all ##### -->
-<para>
-
-</para>
-
-
-
#GstPlugin
</para>
+<!-- ##### MACRO GST_PLUGIN_FEATURE_NAME ##### -->
+<para>
+Get the name of the feature
+</para>
+
+@feature: The feature to query
+
+
<!-- ##### FUNCTION gst_plugin_feature_ensure_loaded ##### -->
<para>
@fixed: indicates that this props has no lists or ranges
@properties: the properties
-<!-- ##### STRUCT GstPropsEntry ##### -->
-<para>
-
-</para>
-
-
<!-- ##### ENUM GstPropsType ##### -->
<para>
+<!-- ##### STRUCT GstPropsEntry ##### -->
+<para>
+An entry hols one key/value pair.
+</para>
+
+
<!-- ##### FUNCTION gst_props_new ##### -->
<para>
@Returns:
+<!-- ##### FUNCTION gst_props_empty_new ##### -->
+<para>
+
+</para>
+
+@Returns:
+
+
<!-- ##### FUNCTION gst_props_merge ##### -->
<para>
@Returns:
+<!-- ##### FUNCTION gst_props_get_safe ##### -->
+<para>
+
+</para>
+
+@props:
+@first_name:
+@Varargs:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_props_has_property ##### -->
+<para>
+
+</para>
+
+@props:
+@name:
+@Returns:
+
+
<!-- ##### FUNCTION gst_props_has_fixed_property ##### -->
<para>
@Returns:
+<!-- ##### FUNCTION gst_props_add_entry ##### -->
+<para>
+
+</para>
+
+@props:
+@entry:
+
+
+<!-- ##### FUNCTION gst_props_entry_new ##### -->
+<para>
+
+</para>
+
+@name:
+@Varargs:
+@Returns:
+
+
<!-- ##### FUNCTION gst_props_entry_get ##### -->
<para>
GstDiskSrc
-<!-- ##### SECTION ./tmpl/gstelementfactory.sgml:Long_Description ##### -->
+<!-- ##### SECTION ./tmpl/gstelement_factory.sgml:Long_Description ##### -->
<para>
-GstElementFactory is used to create instances of elements. A GstElementfactory
-can be added to a #GstPlugin as it is also a #GstPluginFeature.
-</para>
-<para>
-Use gst_element_factory_new() to create a new factory which can be added to a plugin
-with gst_plugin_add_feature().
-</para>
-<para>
-gst_element_factory_get_list() is used to get a list of all available factories in
-the plugin repository.
-</para>
-<para>
-gst_element_factory_add_pad_template() is used to add a padtemplate to the factory.
-This function will enable the application to query for elementfactories that handle
-a specific media type.
-</para>
-<para>
-Use the gst_element_factory_find() and gst_element_factory_create() functions
-to create element instances or use gst_element_factory_make() as a convenient
-shortcut.
-</para>
-<para>
-The following code example shows you how to create a GstDiskSrc element.
-</para>
-
-<para>
- <programlisting role="C">
- #include <gst/gst.h>
- GstElement *src;
- GstElementFactory *srcfactory;
-
- gst_init(&argc,&argv);
-
- srcfactory = gst_element_factory_find("filesrc");
- g_return_if_fail(srcfactory != NULL);
-
- src = gst_element_factory_create(srcfactory,"src");
- g_return_if_fail(src != NULL);
- ...
- </programlisting>
</para>
-<!-- ##### SECTION ./tmpl/gstelementfactory.sgml:See_Also ##### -->
+<!-- ##### SECTION ./tmpl/gstelement_factory.sgml:See_Also ##### -->
<para>
-#GstElement, #GstPlugin, #GstPluginFeature, #GstPadTemplate.
+
</para>
-<!-- ##### SECTION ./tmpl/gstelementfactory.sgml:Short_Description ##### -->
-Create GstElements from a factory
+<!-- ##### SECTION ./tmpl/gstelement_factory.sgml:Short_Description ##### -->
-<!-- ##### SECTION ./tmpl/gstelementfactory.sgml:Title ##### -->
+
+<!-- ##### SECTION ./tmpl/gstelement_factory.sgml:Title ##### -->
GstElementFactory
<!-- ##### SECTION ./tmpl/gstmd5sink.sgml:Long_Description ##### -->
<para>
-
+MD5 Sink can be used to automate regression tests on media pipelines by
+computing a hash on the resulting buffers.
</para>
<!-- ##### SECTION ./tmpl/gstmd5sink.sgml:Short_Description ##### -->
-
+Compute a hash on buffer data.
<!-- ##### SECTION ./tmpl/gstmd5sink.sgml:Title ##### -->
GstStatistics
-<!-- ##### SECTION ./tmpl/gstsystemclock.sgml:Long_Description ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstsystemclock.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/gstsystemclock.sgml:Short_Description ##### -->
-
-
-
-<!-- ##### SECTION ./tmpl/gstsystemclock.sgml:Title ##### -->
-GstSystemClock
-
-
<!-- ##### SECTION ./tmpl/gsttypefind.sgml:Long_Description ##### -->
<para>
This element can be added to the pipeline and will notify the listener of
@klass: <<<<<<< gstreamer-unused.sgml
+<!-- ##### MACRO GST_EVENT_DISCONT_FLUSH ##### -->
+<para>
+Set or get the flush flag of the discont event.
+</para>
+
+@event: The event to operate on
+
+<!-- ##### MACRO GST_EVENT_INFO_PROPS ##### -->
+<para>
+The properties of the info event
+</para>
+
+@event: The event to query
+
+<!-- ##### MACRO GST_EVENT_SEEK_FLUSH ##### -->
+<para>
+Qeury wether the seek event also needs a flush.
+</para>
+
+@event: The event to query.
+
<!-- ##### MACRO GST_FAKESINK ##### -->
<para>
@pad: the real pad to query.
+<!-- ##### MACRO GST_RPAD_GETREGIONFUNC ##### -->
+<para>
+Get the getregion function of the real pad.
+</para>
+
+@pad: the real pad to query.
+
+<!-- ##### MACRO GST_RPAD_LEN ##### -->
+<para>
+Get the length of the region that is being pulled.
+</para>
+
+@pad: the real pad to query.
+
<!-- ##### MACRO GST_RPAD_NEGOTIATEFUNC ##### -->
<para>
Get the negotiate function from the real pad.
@pad: the real pad to query.
+<!-- ##### MACRO GST_RPAD_OFFSET ##### -->
+<para>
+Get the offset of the region that is being pulled.
+</para>
+
+@pad: the real pad to query.
+
<!-- ##### MACRO GST_RPAD_PULLFUNC ##### -->
<para>
Get the pullfunction of the real pad.
@pad: the real pad to query.
+<!-- ##### MACRO GST_RPAD_PULLREGIONFUNC ##### -->
+<para>
+Get the pullregion function of the real pad.
+</para>
+
+@pad: the real pad to query.
+
<!-- ##### MACRO GST_RPAD_PUSHFUNC ##### -->
<para>
Get the pushfunction of the real pad.
@pad: the real pad to query.
+<!-- ##### MACRO GST_RPAD_REGIONTYPE ##### -->
+<para>
+Get the type of the region that is being pulled.
+</para>
+
+@pad: the real pad to query.
+
<!-- ##### MACRO GST_SCHEDULE_ADD_ELEMENT ##### -->
<para>
Fast macro to add an element to the scheduler.
</para>
+<!-- ##### ARG GstMD5Sink:md5 ##### -->
+<para>
+
+</para>
+
+
<!-- ##### STRUCT GstMeta ##### -->
<para>
@GST_MULTIDISKSRC_OPEN:
@GST_MULTIDISKSRC_FLAG_LAST:
+<!-- ##### SIGNAL GstObject::deep-notify ##### -->
+<para>
+
+</para>
+
+@gstobject: the object which received the signal.
+@arg1:
+@arg2:
+
<!-- ##### STRUCT GstObjectClass ##### -->
<para>
</para>
+<!-- ##### USER_FUNCTION GstPadGetRegionFunction ##### -->
+<para>
+The function that will be called when pulling a region buffer.
+You can specify which buffer to get using an offset/length pair or
+a start/stop timecode pair.
+</para>
+
+@pad: the pad to get a buffer from
+@type: the type of region to get (time or offset based)
+@offset: the offset of the region to get
+@len: the length of the region to get
+@Returns: a #GstBuffer
+
<!-- ##### USER_FUNCTION GstPadNegotiateFunction ##### -->
<para>
The function that will be called when negotiating.
@pad: the pad to pull
@Returns: a GstBuffer
+<!-- ##### USER_FUNCTION GstPadPullRegionFunction ##### -->
+<para>
+The function that will be called when pulling a region buffer.
+You can specify which buffer to get using an offset/length pair or
+a start/stop timecode pair.
+</para>
+
+@pad: the pad to get a buffer from
+@type: the type of region to get (time or offset based)
+@offset: the offset of the region to get
+@len: the length of the region to get
+@Returns: a #GstBuffer
+
<!-- ##### USER_FUNCTION GstPadPushFunction ##### -->
<para>
@pad: the pad that sent the QoS message
@qos_message: the message
-<!-- ##### STRUCT GstPadTemplate ##### -->
-<para>
-
-</para>
-
-
<!-- ##### ENUM GstParseErrors ##### -->
<para>
</para>
+<!-- ##### ENUM GstRegionType ##### -->
+<para>
+the region types for #gst_pad_pullregion.
+</para>
+
+@GST_REGION_VOID:
+@GST_REGION_OFFSET_LEN: an offet/length pair
+@GST_REGION_TIME_LEN: a time start/length pair
+
+<!-- ##### STRUCT GstRegistryRead ##### -->
+<para>
+
+</para>
+
+@global_reg:
+@local_reg:
+
+<!-- ##### STRUCT GstRegistryWrite ##### -->
+<para>
+
+</para>
+
+@dir:
+@file:
+@tmp_file:
+
<!-- ##### STRUCT GstScheduleChain ##### -->
<para>
</para>
-@clock:
<!-- ##### STRUCT GstTee ##### -->
<para>
@y1:
@y2:
+<!-- ##### MACRO REGISTRY_DIR_PERMS ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### MACRO REGISTRY_FILE_PERMS ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### MACRO REGISTRY_TMPFILE_PERMS ##### -->
+<para>
+
+</para>
+
+
<!-- ##### MACRO STACK_SIZE ##### -->
<para>
@srccaps:
@sinkcaps:
+<!-- ##### FUNCTION gst_autoplug_factory_get_list ##### -->
+<para>
+
+</para>
+
+@Returns:
+
<!-- ##### FUNCTION gst_autoplug_factory_load_thyself ##### -->
<para>
@buffer:
@meta:
-<!-- ##### FUNCTION gst_caps_copy_1 ##### -->
-<para>
-
-</para>
-
-@caps:
-@Returns:
-
<!-- ##### FUNCTION gst_caps_list_check_compatibility ##### -->
<para>
@parent:
@Returns:
-<!-- ##### FUNCTION gst_element_send_event ##### -->
-<para>
-
-</para>
-
-@element:
-@event:
-
<!-- ##### FUNCTION gst_element_signal_eos ##### -->
<para>
@esdsink:
+<!-- ##### FUNCTION gst_event_new_info ##### -->
+<para>
+
+</para>
+
+@firstname:
+@Varargs:
+@Returns:
+
<!-- ##### FUNCTION gst_extra_get_filename_type ##### -->
<para>
@size:
@Returns:
+<!-- ##### FUNCTION gst_pad_pullregion ##### -->
+<para>
+
+</para>
+
+@pad:
+@type:
+@offset:
+@len:
+@Returns:
+@size:
+
<!-- ##### FUNCTION gst_pad_remove_ghost_parent ##### -->
<para>
@pad:
@eos:
+<!-- ##### FUNCTION gst_pad_set_getregion_function ##### -->
+<para>
+
+</para>
+
+@pad:
+@getregion:
+
<!-- ##### FUNCTION gst_pad_set_negotiate_function ##### -->
<para>
@caps:
@Returns:
+<!-- ##### FUNCTION gst_pad_template_load_thyself ##### -->
+<para>
+
+</para>
+
+@parent:
+@Returns:
+
+<!-- ##### FUNCTION gst_pad_template_save_thyself ##### -->
+<para>
+
+</para>
+
+@templ:
+@parent:
+@Returns:
+
<!-- ##### FUNCTION gst_pad_try_connect ##### -->
<para>
@plugin:
@factory:
+<!-- ##### FUNCTION gst_plugin_add_path ##### -->
+<para>
+
+</para>
+
+@path:
+
<!-- ##### FUNCTION gst_plugin_add_type ##### -->
<para>
@Returns:
+<!-- ##### FUNCTION gst_plugin_find ##### -->
+<para>
+
+</para>
+
+@name:
+@Returns:
+
<!-- ##### FUNCTION gst_plugin_get_autoplug_list ##### -->
<para>
@plugin:
@Returns:
+<!-- ##### FUNCTION gst_plugin_get_list ##### -->
+<para>
+
+</para>
+
+@Returns:
+
<!-- ##### FUNCTION gst_plugin_get_type_list ##### -->
<para>
</para>
+<!-- ##### FUNCTION gst_plugin_load_absolute ##### -->
+<para>
+
+</para>
+
+@name:
+@Returns:
+
+<!-- ##### FUNCTION gst_plugin_load_all ##### -->
+<para>
+
+</para>
+
+
<!-- ##### FUNCTION gst_plugin_load_autoplug_factory ##### -->
<para>
@name:
@Returns:
+<!-- ##### FUNCTION gst_plugin_load_thyself ##### -->
+<para>
+
+</para>
+
+@parent:
+
<!-- ##### FUNCTION gst_plugin_load_type_factory ##### -->
<para>
@mime:
-<!-- ##### FUNCTION gst_plugin_new ##### -->
+<!-- ##### FUNCTION gst_plugin_save_thyself ##### -->
<para>
</para>
-@name:
-@major:
-@minor:
+@parent:
@Returns:
+<!-- ##### FUNCTION gst_plugin_unload_all ##### -->
+<para>
+
+</para>
+
+
<!-- ##### FUNCTION gst_props_get_boolean ##### -->
<para>
@connection:
+<!-- ##### FUNCTION gst_registry_option_set ##### -->
+<para>
+
+</para>
+
+@registry:
+
+<!-- ##### FUNCTION gst_registry_read_get ##### -->
+<para>
+
+</para>
+
+@Returns:
+
+<!-- ##### FUNCTION gst_registry_write_get ##### -->
+<para>
+
+</para>
+
+@Returns:
+
<!-- ##### FUNCTION gst_schedule_add_element ##### -->
<para>
@sched:
@element:
+<!-- ##### FUNCTION gst_scheduler_factory_get_list ##### -->
+<para>
+
+</para>
+
+@Returns:
+
<!-- ##### FUNCTION gst_scheduler_factory_get_type ##### -->
<para>
@src:
-<!-- ##### FUNCTION gst_system_clock_obtain ##### -->
-<para>
-
-</para>
-
-@Returns:
-
<!-- ##### FUNCTION gst_tee_chain ##### -->
<para>
</para>
+<!-- ##### FUNCTION gst_type_factory_get_list ##### -->
+<para>
+
+</para>
+
+@Returns:
+
<!-- ##### FUNCTION gst_type_factory_load_thyself ##### -->
<para>
--- /dev/null
+<!-- ##### SECTION Title ##### -->
+GstRegistry
+
+<!-- ##### SECTION Short_Description ##### -->
+Abstract class for managing plugins.
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+The registry holds the available plugins in the system.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+#GstPlugin, #GstPluginFeature
+</para>
+
+<!-- ##### ENUM GstRegistryReturn ##### -->
+<para>
+
+</para>
+
+@GST_REGISTRY_OK:
+@GST_REGISTRY_LOAD_ERROR:
+@GST_REGISTRY_SAVE_ERROR:
+@GST_REGISTRY_PLUGIN_LOAD_ERROR:
+@GST_REGISTRY_PLUGIN_SIGNATURE_ERROR:
+
+<!-- ##### ENUM GstRegistryFlags ##### -->
+<para>
+
+</para>
+
+@GST_REGISTRY_READABLE:
+@GST_REGISTRY_WRITABLE:
+@GST_REGISTRY_REMOTE:
+@GST_REGISTRY_DELAYED_LOADING:
+
+<!-- ##### FUNCTION gst_registry_load ##### -->
+<para>
+
+</para>
+
+@registry:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_registry_is_loaded ##### -->
+<para>
+
+</para>
+
+@registry:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_registry_save ##### -->
+<para>
+
+</para>
+
+@registry:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_registry_rebuild ##### -->
+<para>
+
+</para>
+
+@registry:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_registry_unload ##### -->
+<para>
+
+</para>
+
+@registry:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_registry_add_path ##### -->
+<para>
+
+</para>
+
+@registry:
+@path:
+
+
+<!-- ##### FUNCTION gst_registry_get_path_list ##### -->
+<para>
+
+</para>
+
+@registry:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_registry_clear_paths ##### -->
+<para>
+
+</para>
+
+@registry:
+
+
+<!-- ##### FUNCTION gst_registry_add_plugin ##### -->
+<para>
+
+</para>
+
+@registry:
+@plugin:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_registry_remove_plugin ##### -->
+<para>
+
+</para>
+
+@registry:
+@plugin:
+
+
+<!-- ##### FUNCTION gst_registry_find_plugin ##### -->
+<para>
+
+</para>
+
+@registry:
+@name:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_registry_find_feature ##### -->
+<para>
+
+</para>
+
+@registry:
+@name:
+@type:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_registry_load_plugin ##### -->
+<para>
+
+</para>
+
+@registry:
+@plugin:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_registry_unload_plugin ##### -->
+<para>
+
+</para>
+
+@registry:
+@plugin:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_registry_update_plugin ##### -->
+<para>
+
+</para>
+
+@registry:
+@plugin:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_registry_pool_list ##### -->
+<para>
+
+</para>
+
+@Returns:
+
+
+<!-- ##### FUNCTION gst_registry_pool_add ##### -->
+<para>
+
+</para>
+
+@registry:
+@priority:
+
+
+<!-- ##### FUNCTION gst_registry_pool_remove ##### -->
+<para>
+
+</para>
+
+@registry:
+
+
+<!-- ##### FUNCTION gst_registry_pool_add_plugin ##### -->
+<para>
+
+</para>
+
+@plugin:
+
+
+<!-- ##### FUNCTION gst_registry_pool_load_all ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION gst_registry_pool_plugin_list ##### -->
+<para>
+
+</para>
+
+@Returns:
+
+
+<!-- ##### FUNCTION gst_registry_pool_feature_list ##### -->
+<para>
+
+</para>
+
+@type:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_registry_pool_find_plugin ##### -->
+<para>
+
+</para>
+
+@name:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_registry_pool_find_feature ##### -->
+<para>
+
+</para>
+
+@name:
+@type:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_registry_pool_get_prefered ##### -->
+<para>
+
+</para>
+
+@flags:
+@Returns:
+
+
@element:
@clock:
@time:
+@jitter:
@Returns:
@Returns:
-<!-- ##### FUNCTION gst_scheduler_factory_get_list ##### -->
-<para>
-
-</para>
-
-@Returns:
-
-
<!-- ##### FUNCTION gst_scheduler_factory_make ##### -->
<para>
--- /dev/null
+<!-- ##### SECTION Title ##### -->
+GstSystemClock
+
+<!-- ##### SECTION Short_Description ##### -->
+A default clock that uses the current system time
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+The System clock is an implementation of GstClock using the
+system time.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+#GstClock
+</para>
+
+<!-- ##### FUNCTION gst_system_clock_obtain ##### -->
+<para>
+
+</para>
+
+@Returns:
+
+
<!-- ##### SECTION Long_Description ##### -->
<para>
A bin that will become a thread if possible when the pipeline is started
-up. Can contain any set of GstObjects except another GstThread. All
-starting points and/or clocked events must be registered with this object,
-to be dealt with in the separate thread.
-
+up. It can contain any set of GstObjects.
+</para>
+<para>
+A Thread can act as a toplevel bin as it has its own scheduler.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
-
+#GstBin, #GstPipeline
</para>
<!-- ##### ENUM GstThreadState ##### -->
Thread flags:
</para>
-@GST_THREAD_STATE_STARTED:
+@GST_THREAD_STATE_STARTED: The thread is started
@GST_THREAD_STATE_SPINNING: The thread is runnning
@GST_THREAD_STATE_REAPING: The thread is ending.
@GST_THREAD_FLAG_LAST: subclass use this to start their enumeration
@Returns:
-<!-- ##### FUNCTION gst_type_factory_get_list ##### -->
-<para>
-
-</para>
-
-@Returns:
-
-