mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-26 19:51:11 +00:00
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.
This commit is contained in:
parent
4f1f3da896
commit
9ba56f4181
35 changed files with 2767 additions and 321 deletions
|
@ -1,10 +1,11 @@
|
|||
<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
|
||||
|
||||
<!entity gstreamer-cothreads SYSTEM "sgml/cothreads.sgml">
|
||||
<!entity Gst SYSTEM "sgml/gst.sgml">
|
||||
<!entity GstInfo SYSTEM "sgml/gstinfo.sgml">
|
||||
<!entity GstBin SYSTEM "sgml/gstbin.sgml">
|
||||
<!entity GstData SYSTEM "sgml/gstdata.sgml">
|
||||
<!entity GstBuffer SYSTEM "sgml/gstbuffer.sgml">
|
||||
<!entity GstEvent SYSTEM "sgml/gstevent.sgml">
|
||||
<!entity GstBufferPool SYSTEM "sgml/gstbufferpool.sgml">
|
||||
<!entity GstCpu SYSTEM "sgml/gstcpu.sgml">
|
||||
<!entity GstElement SYSTEM "sgml/gstelement.sgml">
|
||||
|
@ -15,34 +16,37 @@
|
|||
<!entity GstAutoplug SYSTEM "sgml/gstautoplug.sgml">
|
||||
<!entity GstParse SYSTEM "sgml/gstparse.sgml">
|
||||
<!entity GstPlugin SYSTEM "sgml/gstplugin.sgml">
|
||||
<!entity GstPluginFeature SYSTEM "sgml/gstpluginfeature.sgml">
|
||||
<!entity GstThread SYSTEM "sgml/gstthread.sgml">
|
||||
<!entity GstScheduler SYSTEM "sgml/gstscheduler.sgml">
|
||||
<!entity GstTrace SYSTEM "sgml/gsttrace.sgml">
|
||||
<!entity GstType SYSTEM "sgml/gsttype.sgml">
|
||||
<!entity GstTypeFactory SYSTEM "sgml/gsttypefactory.sgml">
|
||||
<!entity GstCaps SYSTEM "sgml/gstcaps.sgml">
|
||||
<!entity GstProps SYSTEM "sgml/gstprops.sgml">
|
||||
<!entity GstClock SYSTEM "sgml/gstclock.sgml">
|
||||
<!entity GstUtils SYSTEM "sgml/gstutils.sgml">
|
||||
<!entity GstXML SYSTEM "sgml/gstxml.sgml">
|
||||
<!entity GstQueue SYSTEM "sgml/gstqueue.sgml">
|
||||
<!entity GstTypeFind SYSTEM "sgml/gsttypefind.sgml">
|
||||
<!entity GstTimeCache SYSTEM "sgml/gsttimecache.sgml">
|
||||
<!entity cothreads SYSTEM "sgml/cothreads.sgml">
|
||||
|
||||
<!entity GstStaticAutoplug SYSTEM "sgml/gststaticautoplug.sgml">
|
||||
<!entity GstStaticAutoplugRender SYSTEM "sgml/gststaticautoplugrender.sgml">
|
||||
<!entity GstAggregator SYSTEM "sgml/gstaggregator.sgml">
|
||||
<!entity GstFakeSrc SYSTEM "sgml/gstfakesrc.sgml">
|
||||
<!entity GstFakeSink SYSTEM "sgml/gstfakesink.sgml">
|
||||
<!entity GstFileSrc SYSTEM "sgml/gstfilesrc.sgml">
|
||||
<!entity GstDiskSrc SYSTEM "sgml/gstdisksrc.sgml">
|
||||
<!entity GstDiskSink SYSTEM "sgml/gstdisksink.sgml">
|
||||
<!entity GstHttpSrc SYSTEM "sgml/gsthttpsrc.sgml">
|
||||
<!entity GstFdSrc SYSTEM "sgml/gstfdsrc.sgml">
|
||||
<!entity GstSineSrc SYSTEM "sgml/gstsinesrc.sgml">
|
||||
<!entity GstFdSink SYSTEM "sgml/gstfdsink.sgml">
|
||||
<!entity GstIdentity SYSTEM "sgml/gstidentity.sgml">
|
||||
<!entity GstPipefilter SYSTEM "sgml/gstpipefilter.sgml">
|
||||
<!entity GstTee SYSTEM "sgml/gsttee.sgml">
|
||||
|
||||
<!entity spectrum SYSTEM "sgml/spectrum.sgml">
|
||||
|
||||
<!entity gstreamer-tree-index SYSTEM "sgml/tree_index.sgml">
|
||||
]>
|
||||
|
||||
|
@ -65,20 +69,26 @@ with some more specialized elements.</para>
|
|||
&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.</para>
|
|||
</programlisting>
|
||||
</para>
|
||||
|
||||
&GstAggregator;
|
||||
|
||||
&GstFakeSrc;
|
||||
&GstFakeSink;
|
||||
|
||||
<!-- &GstFileSrc; -->
|
||||
&GstDiskSrc;
|
||||
&GstDiskSink;
|
||||
|
||||
&GstHttpSrc;
|
||||
|
||||
&GstSineSrc;
|
||||
|
||||
&GstFdSrc;
|
||||
&GstFdSink;
|
||||
|
||||
|
|
|
@ -2,6 +2,9 @@
|
|||
|
||||
<SECTION>
|
||||
<FILE>gobject2gtk</FILE>
|
||||
<TITLE>GObject</TITLE>
|
||||
<SUBSECTION Standard>
|
||||
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
|
||||
<TITLE>GObject</TITLE>
|
||||
g_object_get_type
|
||||
<SUBSECTION Standard>
|
||||
g_cclosure_marshal_VOID__OBJECT
|
||||
G_IS_OBJECT
|
||||
G_TYPE_OBJECT
|
||||
|
@ -173,11 +222,12 @@ cothread_trylock
|
|||
<FILE>gst</FILE>
|
||||
<TITLE>Gst</TITLE>
|
||||
gst_init
|
||||
gst_version
|
||||
gst_main
|
||||
gst_main_quit
|
||||
GST_VERSION_MICRO
|
||||
GST_VERSION_MAJOR
|
||||
GST_VERSION_MINOR
|
||||
GST_VERSION_MICRO
|
||||
<SUBSECTION Standard>
|
||||
</SECTION>
|
||||
|
||||
|
@ -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
|
||||
<SUBSECTION Standard>
|
||||
GST_DEBUG_CHAR_MODE
|
||||
GST_DEBUG_ENABLED
|
||||
GST_DEBUG_ENABLE_CATEGORIES
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
|
@ -224,6 +276,7 @@ GstErrorHandler
|
|||
GST_TYPE_FILENAME
|
||||
gst_extra_get_filename_type
|
||||
<SUBSECTION Standard>
|
||||
GST_DISABLE_LOADSAVE_REGISTRY
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
|
@ -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
|
||||
<SUBSECTION Standard>
|
||||
|
@ -300,9 +354,20 @@ GST_ARCH_SETUP_STACK
|
|||
GST_ARCH_PRESETJMP
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gstdata</FILE>
|
||||
<TITLE>GstData</TITLE>
|
||||
GstData
|
||||
<SUBSECTION Standard>
|
||||
GST_DATA
|
||||
GST_DATA_TYPE
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gstbuffer</FILE>
|
||||
<TITLE>GstBuffer</TITLE>
|
||||
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,29 +399,59 @@ 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
|
||||
|
||||
<SUBSECTION Standard>
|
||||
GST_BUFFER
|
||||
GST_TYPE_BUFFER
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gstbufferpool</FILE>
|
||||
<TITLE>GstBufferPool</TITLE>
|
||||
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
|
||||
<SUBSECTION Standard>
|
||||
GST_BUFFER_POOL
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gstevent</FILE>
|
||||
<TITLE>GstEvent</TITLE>
|
||||
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
|
||||
<SUBSECTION Standard>
|
||||
GST_EVENT
|
||||
GST_IS_EVENT
|
||||
GST_TYPE_EVENT
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gstelement</FILE>
|
||||
<TITLE>GstElement</TITLE>
|
||||
|
@ -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
|
||||
<SUBSECTION Standard>
|
||||
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
|
||||
</SECTION>
|
||||
|
||||
|
||||
|
@ -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
|
||||
<SUBSECTION Standard>
|
||||
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
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gstclock</FILE>
|
||||
<TITLE>GstClock</TITLE>
|
||||
GstClockTime
|
||||
GstClockTimeDiff
|
||||
GST_CLOCK_DIFF
|
||||
|
@ -477,9 +584,9 @@ gst_clock_current_diff
|
|||
|
||||
<SECTION>
|
||||
<FILE>gstlog</FILE>
|
||||
GST_SHOW_INFO
|
||||
gst_info
|
||||
<SUBSECTION Standard>
|
||||
GST_SHOW_INFO
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
|
@ -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
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
|
@ -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,22 +834,33 @@ 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
|
||||
|
||||
<SUBSECTION Standard>
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gstpluginfeature</FILE>
|
||||
<TITLE>GstPluginFeature</TITLE>
|
||||
gst_plugin_feature_ensure_loaded
|
||||
gst_plugin_feature_unload_thyself
|
||||
<SUBSECTION Standard>
|
||||
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
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gsttee</FILE>
|
||||
<TITLE>GstTee</TITLE>
|
||||
|
@ -783,19 +916,32 @@ gst_trace_add_entry
|
|||
<SECTION>
|
||||
<FILE>gsttype</FILE>
|
||||
<TITLE>GstType</TITLE>
|
||||
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
|
||||
<SUBSECTION Standard>
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gsttypefactory</FILE>
|
||||
<TITLE>GstTypeFactory</TITLE>
|
||||
GstTypeFactory
|
||||
GstTypeDefinition
|
||||
GstTypeFindFunc
|
||||
gst_typefactory_new
|
||||
gst_typefactory_find
|
||||
<SUBSECTION Standard>
|
||||
GST_TYPEFACTORY
|
||||
GST_IS_TYPEFACTORY
|
||||
GST_TYPE_TYPEFACTORY
|
||||
gst_typefactory_get_type
|
||||
GST_TYPEFACTORY_CLASS
|
||||
GST_IS_TYPEFACTORY_CLASS
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gstcaps</FILE>
|
||||
<TITLE>GstCaps</TITLE>
|
||||
|
@ -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
|
||||
<SUBSECTION Standard>
|
||||
</SECTION>
|
||||
|
||||
|
@ -921,6 +1069,31 @@ GstCPUFlags
|
|||
gst_cpu_get_flags
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gsttimecache</FILE>
|
||||
<TITLE>GstTimeCache</TITLE>
|
||||
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
|
||||
<SUBSECTION Standard>
|
||||
GstTimeCache
|
||||
GST_TIMECACHE
|
||||
GST_IS_TIMECACHE
|
||||
GST_TYPE_TIMECACHE
|
||||
gst_timecache_get_type
|
||||
GST_TIMECACHE_CLASS
|
||||
GST_IS_TIMECACHE_CLASS
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gststaticautoplug</FILE>
|
||||
<TITLE>GstStaticAutoplug</TITLE>
|
||||
|
@ -947,6 +1120,28 @@ GST_STATIC_AUTOPLUG_RENDER_CLASS
|
|||
GST_IS_STATIC_AUTOPLUG_RENDER_CLASS
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gstaggregator</FILE>
|
||||
<TITLE>GstAggregator</TITLE>
|
||||
GstAggregatorSchedType
|
||||
<SUBSECTION Standard>
|
||||
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
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gstfilesrc</FILE>
|
||||
<TITLE>GstFileSrc</TITLE>
|
||||
<SUBSECTION Standard>
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gstdisksrc</FILE>
|
||||
<TITLE>GstDiskSrc</TITLE>
|
||||
|
@ -974,6 +1169,7 @@ GST_FAKESINK
|
|||
GST_FAKESINK_CLASS
|
||||
GST_IS_FAKESINK
|
||||
GST_IS_FAKESINK_CLASS
|
||||
gst_fakesink_factory_init
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
|
@ -989,6 +1185,10 @@ GST_FAKESRC
|
|||
GST_FAKESRC_CLASS
|
||||
GST_IS_FAKESRC
|
||||
GST_IS_FAKESRC_CLASS
|
||||
GstFakeSrcDataType
|
||||
GstFakeSrcFillType
|
||||
GstFakeSrcSizeType
|
||||
gst_fakesrc_factory_init
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
|
@ -1062,21 +1262,6 @@ GST_IS_QUEUE
|
|||
GST_IS_QUEUE_CLASS
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gstsinesrc</FILE>
|
||||
<TITLE>GstSineSrc</TITLE>
|
||||
<SUBSECTION Standard>
|
||||
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
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gstpipefilter</FILE>
|
||||
<TITLE>GstPipefilter</TITLE>
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -23,7 +23,7 @@ of data out of their src element.
|
|||
|
||||
<!-- ##### MACRO CURRENT_STACK_FRAME ##### -->
|
||||
<para>
|
||||
|
||||
Get the current stack frame.
|
||||
</para>
|
||||
|
||||
|
||||
|
|
16
docs/gst/tmpl/gobject2gtk.sgml
Normal file
16
docs/gst/tmpl/gobject2gtk.sgml
Normal file
|
@ -0,0 +1,16 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
GObject
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
|
@ -7,7 +7,7 @@ Media library supporting arbitrary formats and filter graphs.
|
|||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
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,6 +39,16 @@ pipeline</ulink> and Microsoft's DirectShow for some background.
|
|||
@argv:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_version ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@major:
|
||||
@minor:
|
||||
@micro:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_main ##### -->
|
||||
<para>
|
||||
|
||||
|
@ -53,23 +63,23 @@ pipeline</ulink> and Microsoft's DirectShow for some background.
|
|||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_VERSION_MICRO ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_VERSION_MAJOR ##### -->
|
||||
<para>
|
||||
|
||||
The major version of GStreamer at compile time
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_VERSION_MINOR ##### -->
|
||||
<para>
|
||||
|
||||
The minor version of GStreamer at compile time
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_VERSION_MICRO ##### -->
|
||||
<para>
|
||||
The micro version of GStreamer at compile time
|
||||
</para>
|
||||
|
||||
|
||||
|
|
42
docs/gst/tmpl/gstaggregator.sgml
Normal file
42
docs/gst/tmpl/gstaggregator.sgml
Normal file
|
@ -0,0 +1,42 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
GstAggregator
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Combine buffers.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
The aggregator is mainly used for testing purposes. It has several
|
||||
methods to request buffers from its pads.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ENUM GstAggregatorSchedType ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@AGGREGATOR_LOOP:
|
||||
@AGGREGATOR_LOOP_PEEK:
|
||||
@AGGREGATOR_LOOP_SELECT:
|
||||
@AGGREGATOR_CHAIN:
|
||||
|
||||
<!-- ##### ARG GstAggregator:num-pads ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GstAggregator:silent ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GstAggregator:sched ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
|
@ -2,10 +2,14 @@
|
|||
gstarch
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
Architecural specific macros and functions.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
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.
|
||||
|
||||
</para>
|
||||
|
||||
|
@ -16,31 +20,31 @@ gstarch
|
|||
|
||||
<!-- ##### MACRO GST_ARCH_CALL ##### -->
|
||||
<para>
|
||||
|
||||
Jumps to a specific location in memory.
|
||||
</para>
|
||||
|
||||
@target:
|
||||
@target: the memory to jump to.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_ARCH_SET_SP ##### -->
|
||||
<para>
|
||||
|
||||
Sets the stackpointer.
|
||||
</para>
|
||||
|
||||
@stackpointer:
|
||||
@stackpointer: the stackpointer to set.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_ARCH_SETUP_STACK ##### -->
|
||||
<para>
|
||||
|
||||
Make toom on the stack?
|
||||
</para>
|
||||
|
||||
@sp:
|
||||
@sp: the stackpointer to modify.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_ARCH_PRESETJMP ##### -->
|
||||
<para>
|
||||
|
||||
Do something funny, which is required on some archs..
|
||||
</para>
|
||||
|
||||
|
||||
|
|
|
@ -7,7 +7,7 @@ Automatically create and connect elements
|
|||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
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.
|
||||
</para>
|
||||
|
@ -92,7 +92,7 @@ Use the regular gst_object_destroy() call to destroy the autoplugger.
|
|||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
GstStaticAutoplug, GstStaticAutoplugRender
|
||||
#GstStaticAutoplug, #GstStaticAutoplugRender
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GstAutoplug ##### -->
|
||||
|
|
|
@ -57,9 +57,25 @@ regardless of the refcount (dangerous).
|
|||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
#GstBufferPool, #GstPad
|
||||
#GstBufferPool, #GstPad, #GstData
|
||||
</para>
|
||||
|
||||
<!-- ##### MACRO GST_IS_BUFFER ##### -->
|
||||
<para>
|
||||
Check if the object is a buffer.
|
||||
</para>
|
||||
|
||||
@buf: The object to check
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER ##### -->
|
||||
<para>
|
||||
Cast an object to a GstBuffer
|
||||
</para>
|
||||
|
||||
@buf: The object to cast.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_FLAGS ##### -->
|
||||
<para>
|
||||
Get the flags from this buffer.
|
||||
|
@ -151,14 +167,6 @@ Get the bufferpool private data.
|
|||
@buf: GstBuffer
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_POOL_LOCK ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pool:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_LOCK ##### -->
|
||||
<para>
|
||||
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.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_COPY_FUNC ##### -->
|
||||
<para>
|
||||
Call the buffer specific copy function on the given buffer.
|
||||
</para>
|
||||
|
||||
@buf: the buffer to copy.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_FREE_FUNC ##### -->
|
||||
<para>
|
||||
Call the buffer specific free function on the given buffer.
|
||||
</para>
|
||||
|
||||
@buf: the buffer to free.
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstBufferCopyFunc ##### -->
|
||||
<para>
|
||||
This function is used to copy the buffer contents.
|
||||
</para>
|
||||
|
||||
@srcbuf: the src buffer
|
||||
@Returns:
|
||||
<!-- # Unused Parameters # -->
|
||||
@dstbuf: the destination buffer
|
||||
|
||||
|
||||
|
@ -266,9 +292,11 @@ used when data in a stream has been skipped
|
|||
</para>
|
||||
|
||||
@pool:
|
||||
@location:
|
||||
@offset:
|
||||
@size:
|
||||
@Returns:
|
||||
<!-- # Unused Parameters # -->
|
||||
@location:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_copy ##### -->
|
||||
|
@ -312,15 +340,6 @@ used when data in a stream has been skipped
|
|||
@buffer:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_ref_by_count ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
@count:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_unref ##### -->
|
||||
<para>
|
||||
|
||||
|
@ -337,3 +356,35 @@ used when data in a stream has been skipped
|
|||
@buffer:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_is_span_fast ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buf1:
|
||||
@buf2:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_merge ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buf1:
|
||||
@buf2:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_span ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buf1:
|
||||
@offset:
|
||||
@buf2:
|
||||
@len:
|
||||
@Returns:
|
||||
|
||||
|
||||
|
|
|
@ -57,6 +57,43 @@ A bufferpool can be requested from a pad with the gst_pad_get_bufferpool() funct
|
|||
@destroy_hook:
|
||||
@user_data:
|
||||
|
||||
<!-- ##### USER_FUNCTION GstBufferPoolBufferNewFunction ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pool:
|
||||
@location:
|
||||
@size:
|
||||
@user_data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstBufferPoolDestroyHook ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pool:
|
||||
@user_data:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_POOL_UNLOCK ##### -->
|
||||
<para>
|
||||
Lock the given bufferpool.
|
||||
</para>
|
||||
|
||||
@pool: The pool to lock.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_BUFFER_POOL_LOCK ##### -->
|
||||
<para>
|
||||
Unlock the given bufferpool.
|
||||
</para>
|
||||
|
||||
@pool: the bufferpool to unlock.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_pool_new ##### -->
|
||||
<para>
|
||||
|
||||
|
@ -112,3 +149,58 @@ A bufferpool can be requested from a pad with the gst_pad_get_bufferpool() funct
|
|||
@oldpool:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_pool_set_user_data ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pool:
|
||||
@user_data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_pool_get_user_data ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pool:
|
||||
@user_data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_pool_set_buffer_copy_function ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pool:
|
||||
@copy:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_pool_set_buffer_free_function ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pool:
|
||||
@destroy:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_pool_set_buffer_new_function ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pool:
|
||||
@create:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_pool_set_destroy_hook ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pool:
|
||||
@destroy:
|
||||
|
||||
|
||||
|
|
|
@ -67,7 +67,7 @@ takes a list of key value pairs in the #GstProps syntax as shown by this example
|
|||
</para>
|
||||
<para>
|
||||
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.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
|
|
|
@ -1,12 +1,12 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
gstclock
|
||||
GstClock
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
Clocking and synchronisation.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
GstClock provides an easy way to synchonize against a global clock.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
|
@ -28,11 +28,13 @@ gstclock
|
|||
|
||||
<!-- ##### MACRO GST_CLOCK_DIFF ##### -->
|
||||
<para>
|
||||
|
||||
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.
|
||||
</para>
|
||||
|
||||
@s:
|
||||
@e:
|
||||
@s: first timestamp
|
||||
@e: second timestamp
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstClock ##### -->
|
||||
|
|
24
docs/gst/tmpl/gstdata.sgml
Normal file
24
docs/gst/tmpl/gstdata.sgml
Normal file
|
@ -0,0 +1,24 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
GstData
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Common structure for GstBuffer and GstEvent
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
This structure provides a common base for #GstBuffer and #GstEvent. It is the
|
||||
main data type that is passed along in a pipeline.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
#GstBuffer, #GstEvent
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GstData ##### -->
|
||||
<para>
|
||||
The base structure
|
||||
</para>
|
||||
|
||||
@type: The type of this data.
|
||||
|
|
@ -86,14 +86,14 @@ The Element is going from the NULL state to the READY state.
|
|||
|
||||
<!-- ##### MACRO GST_STATE_READY_TO_PAUSED ##### -->
|
||||
<para>
|
||||
|
||||
The Element is going from the READY state to the PAUSED state.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_STATE_PAUSED_TO_READY ##### -->
|
||||
<para>
|
||||
|
||||
The Element is going from the PAUSED state to the READY state.
|
||||
</para>
|
||||
|
||||
|
||||
|
@ -185,18 +185,18 @@ Get the pads of this elements.
|
|||
|
||||
<!-- ##### MACRO GST_ELEMENT_SCHED ##### -->
|
||||
<para>
|
||||
|
||||
Get the scheduler of this element.
|
||||
</para>
|
||||
|
||||
@obj:
|
||||
@obj: The element to query
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_ELEMENT_MANAGER ##### -->
|
||||
<para>
|
||||
|
||||
Get the manager of this element.
|
||||
</para>
|
||||
|
||||
@obj:
|
||||
@obj: The element to query
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstElement ##### -->
|
||||
|
@ -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.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_element_class_add_padtemplate ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@element:
|
||||
@templ:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_element_destroy ##### -->
|
||||
<para>
|
||||
|
||||
|
@ -439,6 +449,15 @@ circumstances.
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_element_get_state ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@elem:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_element_statename ##### -->
|
||||
<para>
|
||||
|
||||
|
@ -586,7 +605,7 @@ Is trigered whenever a new pad is added to an element
|
|||
</para>
|
||||
|
||||
@gstelement: the object which received the signal.
|
||||
@arg1:
|
||||
@arg1: The pad that was removed.
|
||||
|
||||
<!-- ##### SIGNAL GstElement::new-ghost-pad ##### -->
|
||||
<para>
|
||||
|
@ -603,7 +622,7 @@ Is trigered whenever a new ghost pad is added to an element
|
|||
</para>
|
||||
|
||||
@gstelement: the object which received the signal.
|
||||
@arg1:
|
||||
@arg1: The ghost pad that was removed.
|
||||
|
||||
<!-- ##### SIGNAL GstElement::error ##### -->
|
||||
<para>
|
||||
|
|
121
docs/gst/tmpl/gstevent.sgml
Normal file
121
docs/gst/tmpl/gstevent.sgml
Normal file
|
@ -0,0 +1,121 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
GstEvent
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Event definitions.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
The event classes are used to construct and query events.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ENUM GstEventType ##### -->
|
||||
<para>
|
||||
The different major types of events.
|
||||
</para>
|
||||
|
||||
@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.
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_TYPE ##### -->
|
||||
<para>
|
||||
Get the event type.
|
||||
</para>
|
||||
|
||||
@event: The event to query.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_TIMESTAMP ##### -->
|
||||
<para>
|
||||
Get the timestamp of the event.
|
||||
</para>
|
||||
|
||||
@event: The event to query.
|
||||
|
||||
|
||||
<!-- ##### ENUM GstSeekType ##### -->
|
||||
<para>
|
||||
The different types of seek events.
|
||||
</para>
|
||||
|
||||
@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
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_SEEK_TYPE ##### -->
|
||||
<para>
|
||||
Get the seektype of the GST_EVENT_SEEK.
|
||||
</para>
|
||||
|
||||
@event: The event to query.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_SEEK_OFFSET ##### -->
|
||||
<para>
|
||||
Get the offset of the seek 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.
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstEvent ##### -->
|
||||
<para>
|
||||
The event data structure.
|
||||
</para>
|
||||
|
||||
@data: The parent data type.
|
||||
@type: The event type.
|
||||
@timestamp: The event timestamp.
|
||||
|
||||
<!-- ##### FUNCTION gst_event_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_event_free ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@event:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_event_new_seek ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@offset:
|
||||
@flush:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_event_new_flush ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
|
@ -16,7 +16,7 @@ GstExtraTypes
|
|||
|
||||
<!-- ##### MACRO GST_TYPE_FILENAME ##### -->
|
||||
<para>
|
||||
|
||||
A type that can be used to indicate a filename.
|
||||
</para>
|
||||
|
||||
|
||||
|
|
|
@ -34,3 +34,8 @@ with the buffer. (fakesink)
|
|||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GstFakeSink:dump ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
|
|
@ -37,6 +37,36 @@ The <classname>GstFakeSrc</classname> generates empty buffers. (fakesrc)
|
|||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GstFakeSrc:data ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GstFakeSrc:sizetype ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GstFakeSrc:sizemin ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GstFakeSrc:sizemax ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GstFakeSrc:parentsize ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GstFakeSrc:filltype ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GstFakeSrc:pattern ##### -->
|
||||
<para>
|
||||
|
||||
|
@ -57,3 +87,8 @@ The <classname>GstFakeSrc</classname> generates empty buffers. (fakesrc)
|
|||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GstFakeSrc:dump ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
|
51
docs/gst/tmpl/gstfilesrc.sgml
Normal file
51
docs/gst/tmpl/gstfilesrc.sgml
Normal file
|
@ -0,0 +1,51 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
GstFileSrc
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GstFileSrc:location ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GstFileSrc:filesize ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GstFileSrc:fd ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GstFileSrc:blocksize ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GstFileSrc:offset ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GstFileSrc:mmapsize ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GstFileSrc:touch ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
|
@ -159,11 +159,12 @@ in addition to the given string.
|
|||
|
||||
<!-- ##### MACRO GST_DEBUG_LEAVE ##### -->
|
||||
<para>
|
||||
|
||||
Called at the end of a function, it simply prints out a DEBUG string of "leaving"
|
||||
in addition to the given string.
|
||||
</para>
|
||||
|
||||
@format:
|
||||
@args...:
|
||||
@format: printf-stype format string
|
||||
@args...: printf arguments
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DEBUG ##### -->
|
||||
|
@ -176,75 +177,55 @@ Print out debugging information.
|
|||
@args...: printf arguments
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DEBUG_ENABLE_CATEGORIES ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DEBUG_FUNCPTR ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@ptr:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DEBUG_ENABLED ##### -->
|
||||
<para>
|
||||
|
||||
Add a function to the global function pointer table used for debugging.
|
||||
</para>
|
||||
|
||||
@ptr: The pointer to add to the function table.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DEBUG_FUNCPTR_NAME ##### -->
|
||||
<para>
|
||||
|
||||
Get the name of the given function pointer by looking up its name in the global
|
||||
function table.
|
||||
</para>
|
||||
|
||||
@ptr:
|
||||
@ptr: The pointer to look up.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DEBUG_PAD_NAME ##### -->
|
||||
<para>
|
||||
|
||||
Print out debugging statements for a pad.
|
||||
</para>
|
||||
|
||||
@pad:
|
||||
@pad: The pad to debug.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DEBUG_THREAD_ARGS ##### -->
|
||||
<para>
|
||||
|
||||
Part of the colorized debug functions for threads
|
||||
</para>
|
||||
|
||||
@id:
|
||||
@id: The thread id.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DEBUG_THREAD_FORMAT ##### -->
|
||||
<para>
|
||||
|
||||
Part of the colorized debug functions for threads
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DEBUG_ELEMENT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@cat:
|
||||
@element:
|
||||
@format:
|
||||
@args...:
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DEBUG_CHAR_MODE ##### -->
|
||||
<para>
|
||||
|
||||
Print out usefull debugging info of an element.
|
||||
</para>
|
||||
|
||||
@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.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_ERROR ##### -->
|
||||
|
@ -312,6 +293,13 @@ Print out an error condition and abort the application.
|
|||
@string:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_debug_print_stack_trace ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstInfoHandler ##### -->
|
||||
<para>
|
||||
|
||||
|
|
|
@ -14,13 +14,6 @@ gstlog
|
|||
|
||||
</para>
|
||||
|
||||
<!-- ##### MACRO GST_SHOW_INFO ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_info ##### -->
|
||||
<para>
|
||||
|
||||
|
|
|
@ -238,6 +238,15 @@ Check if the object has been destroyed.
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_object_restore_thyself ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@parent:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_object_get_path_string ##### -->
|
||||
<para>
|
||||
|
||||
|
|
|
@ -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
|
||||
<!-- # Unused Parameters # -->
|
||||
@size: the size of the region to get
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstPadNewCapsFunction ##### -->
|
||||
|
@ -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
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstPadEventFunction ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pad:
|
||||
@event:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### ENUM GstPadDirection ##### -->
|
||||
<para>
|
||||
|
@ -515,6 +522,17 @@ Destroy the pad.
|
|||
|
||||
</para>
|
||||
|
||||
@srcpad:
|
||||
@sinkpad:
|
||||
<!-- # Unused Parameters # -->
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_pad_try_connect ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@srcpad:
|
||||
@sinkpad:
|
||||
@Returns:
|
||||
|
@ -625,6 +643,76 @@ Destroy the pad.
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_pad_event ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pad:
|
||||
@event:
|
||||
@timestamp:
|
||||
@data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_pad_ghost_save_thyself ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pad:
|
||||
@bin:
|
||||
@parent:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_pad_peek ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pad:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_pad_select ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@padlist:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_pad_selectv ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pad:
|
||||
@Varargs:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_pad_send_event ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pad:
|
||||
@event:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_pad_set_event_function ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pad:
|
||||
@event:
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstRealPad ##### -->
|
||||
<para>
|
||||
|
||||
|
@ -671,10 +759,10 @@ Get the offset of the region that is being pulled.
|
|||
|
||||
<!-- ##### MACRO GST_RPAD_SCHED ##### -->
|
||||
<para>
|
||||
|
||||
Get the scheduler of this real pad.
|
||||
</para>
|
||||
|
||||
@pad:
|
||||
@pad: the real pad to query.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_RPAD_REGIONTYPE ##### -->
|
||||
|
@ -773,6 +861,38 @@ Get the bufferpoolfunction from the real pad.
|
|||
@pad: the real pad to query.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_RPAD_CHAINHANDLER ##### -->
|
||||
<para>
|
||||
Get the eventhandler function from the real pad.
|
||||
</para>
|
||||
|
||||
@pad: the real pad to query.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_RPAD_EVENTFUNC ##### -->
|
||||
<para>
|
||||
Get the event function of this real pad.
|
||||
</para>
|
||||
|
||||
@pad: the real pad to query.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_RPAD_EVENTHANDLER ##### -->
|
||||
<para>
|
||||
Get the eventhandler function of this real pad.
|
||||
</para>
|
||||
|
||||
@pad: the real pad to query.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_RPAD_GETHANDLER ##### -->
|
||||
<para>
|
||||
Get the gethandler function of this real pad.
|
||||
</para>
|
||||
|
||||
@pad: the real pad to query.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_GPAD_REALPAD ##### -->
|
||||
<para>
|
||||
Get the real pad of this ghost pad.
|
||||
|
|
|
@ -7,25 +7,8 @@ Dynamically loadable Elements
|
|||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
GStreamer is extensible so <classname>GstElements</classname> can be loaded at runtime. A plugin
|
||||
system can provide one or more of the following basic <application>GStreamer</application>
|
||||
objects factories:
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
A #GstElementFactory: the components to build a pipeline.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
A #GstTypeFactory: A MIME type and an optional typefind function.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
A #GstAutoplugFactory: An object used to automatically construct pipelines.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
system can provide one or more of the basic <application>GStreamer</application>
|
||||
#GstPluginFeature subclasses.
|
||||
</para>
|
||||
<para>
|
||||
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.
|
||||
</para>
|
||||
<para>
|
||||
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.
|
||||
</para>
|
||||
<para>
|
||||
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.
|
||||
</para>
|
||||
<para>
|
||||
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.
|
|||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
#GstElement, #GstType, #GstAutoplug
|
||||
#GstPluginFeature, #GstType, #GstAutoplug, #GstElementFactory
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GstPlugin ##### -->
|
||||
|
@ -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.
|
||||
|
||||
<!-- ##### MACRO GST_PLUGIN_DESC ##### -->
|
||||
<para>
|
||||
A handy macro to define a plugin description. This macro handles with all the issues
|
||||
involved with the different linking methods for this plugin.
|
||||
</para>
|
||||
|
||||
@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.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_PLUGIN_DESC_DYNAMIC ##### -->
|
||||
<para>
|
||||
The macro used to define dynamically loaded plugins.
|
||||
</para>
|
||||
|
||||
@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.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_PLUGIN_DESC_STATIC ##### -->
|
||||
<para>
|
||||
A macro used to define a statically linked plugin.
|
||||
</para>
|
||||
|
||||
@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.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_new ##### -->
|
||||
<para>
|
||||
|
||||
|
@ -230,3 +246,37 @@ loaded will use this variable to initialize the plugin.
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_add_feature ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@plugin:
|
||||
@feature:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_get_feature_list ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@plugin:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_load_plugin ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@plugin:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_unload_all ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
|
|
32
docs/gst/tmpl/gstpluginfeature.sgml
Normal file
32
docs/gst/tmpl/gstpluginfeature.sgml
Normal file
|
@ -0,0 +1,32 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
GstPluginFeature
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
The base class for plugable objects.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
This is a base class for anything that can be added to a #GstPlugin.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
#GstPlugin
|
||||
</para>
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_feature_ensure_loaded ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@feature:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_plugin_feature_unload_thyself ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@feature:
|
||||
|
||||
|
File diff suppressed because it is too large
Load diff
|
@ -6,7 +6,7 @@ An abstract class for plugable schedulers.
|
|||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
This is a base class for custom schedulers.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
|
@ -16,10 +16,11 @@ An abstract class for plugable schedulers.
|
|||
|
||||
<!-- ##### MACRO GST_SCHED_PARENT ##### -->
|
||||
<para>
|
||||
Get the parent #GstElement of this scheduler.
|
||||
|
||||
</para>
|
||||
|
||||
@sched:
|
||||
@sched: the scheduler to query.
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstScheduleChain ##### -->
|
||||
|
@ -37,92 +38,93 @@ An abstract class for plugable schedulers.
|
|||
|
||||
<!-- ##### MACRO GST_SCHEDULE_SAFETY ##### -->
|
||||
<para>
|
||||
|
||||
Handy macro to check for a non NULL scheduler. The next block of statements
|
||||
will only be axecuted if the scheduler is not NULL.
|
||||
</para>
|
||||
|
||||
@sched:
|
||||
@sched: the scheduler to query.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SCHEDULE_ADD_ELEMENT ##### -->
|
||||
<para>
|
||||
|
||||
Fast macro to add an element to the scheduler.
|
||||
</para>
|
||||
|
||||
@sched:
|
||||
@element:
|
||||
@sched: The scheduler to add the element to.
|
||||
@element: The element to add to the scheduler.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SCHEDULE_REMOVE_ELEMENT ##### -->
|
||||
<para>
|
||||
|
||||
Fast macro to remove an element from the scheduler.
|
||||
</para>
|
||||
|
||||
@sched:
|
||||
@element:
|
||||
@sched: The scheduler to remove the element from.
|
||||
@element: The element to remove from the scheduler.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SCHEDULE_ENABLE_ELEMENT ##### -->
|
||||
<para>
|
||||
|
||||
Fast macro to enable the element in the scheduler.
|
||||
</para>
|
||||
|
||||
@sched:
|
||||
@element:
|
||||
@sched: The scheduler.
|
||||
@element: The element to activate.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SCHEDULE_DISABLE_ELEMENT ##### -->
|
||||
<para>
|
||||
|
||||
Fast macro to disable the element.
|
||||
</para>
|
||||
|
||||
@sched:
|
||||
@element:
|
||||
@sched: The scheduler.
|
||||
@element: The element to disable.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SCHEDULE_LOCK_ELEMENT ##### -->
|
||||
<para>
|
||||
|
||||
Fast macro to lock a given element.
|
||||
</para>
|
||||
|
||||
@sched:
|
||||
@element:
|
||||
@sched: The scheduler.
|
||||
@element: The element to lock.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SCHEDULE_UNLOCK_ELEMENT ##### -->
|
||||
<para>
|
||||
|
||||
Fast macro to unlock a given element.
|
||||
</para>
|
||||
|
||||
@sched:
|
||||
@element:
|
||||
@sched: The scheduler.
|
||||
@element: The element to unlock.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SCHEDULE_PAD_CONNECT ##### -->
|
||||
<para>
|
||||
|
||||
Fast macro to connect two pads.
|
||||
</para>
|
||||
|
||||
@sched:
|
||||
@srcpad:
|
||||
@sinkpad:
|
||||
@sched: The scheduler.
|
||||
@srcpad: The source pad.
|
||||
@sinkpad: The sink pad.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SCHEDULE_PAD_DISCONNECT ##### -->
|
||||
<para>
|
||||
|
||||
Fast macro to disconnect two pads.
|
||||
</para>
|
||||
|
||||
@sched:
|
||||
@srcpad:
|
||||
@sinkpad:
|
||||
@sched: The scheduler.
|
||||
@srcpad: The source pad.
|
||||
@sinkpad: The sink pad.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_SCHEDULE_ITERATE ##### -->
|
||||
<para>
|
||||
|
||||
Fast macro to perform one iteration of the scheduler.
|
||||
</para>
|
||||
|
||||
@sched:
|
||||
@sched: The scheduler to iterate.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_schedule_new ##### -->
|
||||
|
@ -190,6 +192,16 @@ An abstract class for plugable schedulers.
|
|||
@sinkpad:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_schedule_pad_select ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@sched:
|
||||
@padlist:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_schedule_iterate ##### -->
|
||||
<para>
|
||||
|
||||
|
|
|
@ -1,46 +0,0 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
GstSineSrc
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Create a sine wave of a given frequency and volume. (sinesrc)
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
Create a sine wave of a given frequency and volume.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GstSineSrc:volume ##### -->
|
||||
<para>
|
||||
The volume as a double 0.0 is silent, 1.0 is loudest.
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GstSineSrc:format ##### -->
|
||||
<para>
|
||||
The format ad defined in soundcard.h
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GstSineSrc:samplerate ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GstSineSrc:tablesize ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GstSineSrc:freq ##### -->
|
||||
<para>
|
||||
The frequency.
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GstSineSrc:buffersize ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
130
docs/gst/tmpl/gsttimecache.sgml
Normal file
130
docs/gst/tmpl/gsttimecache.sgml
Normal file
|
@ -0,0 +1,130 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
GstTimeCache
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Cache time and byteoffsets.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
This clas is used by plugins to manage time vs byte offsets. It is mainly
|
||||
used for efficient seeking.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GstTimeCacheEntry ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@location:
|
||||
@timestamp:
|
||||
|
||||
<!-- ##### STRUCT GstTimeCacheGroup ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@minlocation:
|
||||
@maxlocation:
|
||||
|
||||
<!-- ##### ENUM GstTimeCacheCertainty ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GST_TIMECACHE_UNKNOWN:
|
||||
@GST_TIMECACHE_CERTAIN:
|
||||
@GST_TIMECACHE_FUZZY_LOCATION:
|
||||
@GST_TIMECACHE_FUZZY_TIMESTAMP:
|
||||
@GST_TIMECACHE_FUZZY:
|
||||
|
||||
<!-- ##### FUNCTION gst_timecache_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_timecache_get_group ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@tc:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_timecache_new_group ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@tc:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_timecache_set_group ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@tc:
|
||||
@groupnum:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_timecache_set_certainty ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@tc:
|
||||
@certainty:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_timecache_get_certainty ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@tc:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_timecache_add_entry ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@tc:
|
||||
@location:
|
||||
@timestamp:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_timecache_find_location ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@tc:
|
||||
@location:
|
||||
@timestamp:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_timecache_find_timestamp ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@tc:
|
||||
@timestamp:
|
||||
@location:
|
||||
@Returns:
|
||||
|
||||
|
|
@ -111,7 +111,7 @@ Tracing functionality
|
|||
|
||||
<!-- ##### MACRO TRACE_ENABLE ##### -->
|
||||
<para>
|
||||
|
||||
must be defined to activate the tracing functionality.
|
||||
</para>
|
||||
|
||||
|
||||
|
|
|
@ -49,20 +49,9 @@ valid mp3 decoder, and thus the whole point of the type system.
|
|||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
#GstTypeFactory
|
||||
</para>
|
||||
|
||||
<!-- ##### USER_FUNCTION GstTypeFindFunc ##### -->
|
||||
<para>
|
||||
This is the function that will be called when a typefind has to be
|
||||
performed by a plugin.
|
||||
</para>
|
||||
|
||||
@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
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstType ##### -->
|
||||
<para>
|
||||
A type.
|
||||
|
@ -73,16 +62,6 @@ A type.
|
|||
@exts:
|
||||
@factories:
|
||||
|
||||
<!-- ##### STRUCT GstTypeFactory ##### -->
|
||||
<para>
|
||||
The struct with the typefactory information.
|
||||
</para>
|
||||
|
||||
@feature:
|
||||
@mime:
|
||||
@exts:
|
||||
@typefindfunc:
|
||||
|
||||
<!-- ##### FUNCTION gst_type_register ##### -->
|
||||
<para>
|
||||
|
||||
|
|
67
docs/gst/tmpl/gsttypefactory.sgml
Normal file
67
docs/gst/tmpl/gsttypefactory.sgml
Normal file
|
@ -0,0 +1,67 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
GstTypeFactory
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Add types to plugins.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
A GstTypeFactory is used to add a new type and a typedetection function
|
||||
to a plugin.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
#GstPluginFeature
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GstTypeFactory ##### -->
|
||||
<para>
|
||||
The struct with the typefactory information.
|
||||
</para>
|
||||
|
||||
@feature:
|
||||
@mime:
|
||||
@exts:
|
||||
@typefindfunc:
|
||||
|
||||
<!-- ##### STRUCT GstTypeDefinition ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@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.
|
||||
|
||||
<!-- ##### USER_FUNCTION GstTypeFindFunc ##### -->
|
||||
<para>
|
||||
This is the function that will be called when a typefind has to be
|
||||
performed by a plugin.
|
||||
</para>
|
||||
|
||||
@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;
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_typefactory_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@definition:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_typefactory_find ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@Returns:
|
||||
|
||||
|
|
@ -103,3 +103,23 @@ Some convenience functions
|
|||
@size:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_print_element_args ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buf:
|
||||
@indent:
|
||||
@element:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_print_pad_caps ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buf:
|
||||
@indent:
|
||||
@pad:
|
||||
|
||||
|
||||
|
|
Loading…
Reference in a new issue