mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-07-02 20:55:55 +00:00
56a79fbfcc
Original commit message from CVS: Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the HTML output somewhere on the website tonight. In order to actually generate the docs, you'll have to install all the DocBook tools, as well as gtk-doc from GNOME cvs. (see http://developer.gnome.org/arch/doc/tools.html) Notes (I'll codify these some day): - Don't believe the Gnome page, always edit the SOURCES when documenting a given function, never the tmpl file. - I'll be re-arranging things a lot, but gtk-doc is smart enough to merge any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are two entirely separate animals. We should probably have a virtual mutex on the entire docs/gst/ directory, over and above what CVS does. - I'm going to try to end up with a book set (docbook terms), where docs/gst/ is only one book. There'd be another called docs/manual/, and another docs/plugins/, etc. If you have any comments as to how these should be done, gstreamer-devel is the place.
578 lines
9.3 KiB
Plaintext
578 lines
9.3 KiB
Plaintext
<SECTION>
|
|
<FILE>gstobject</FILE>
|
|
GstObject
|
|
<TITLE>GstObject</TITLE>
|
|
GST_FLAGS
|
|
GST_FLAG_IS_SET
|
|
GST_FLAG_SET
|
|
GST_FLAG_UNSET
|
|
GST_LOCK
|
|
GST_TRYLOCK
|
|
GST_UNLOCK
|
|
gst_object_new
|
|
gst_object_set_parent
|
|
gst_object_get_parent
|
|
gst_object_unparent
|
|
gst_object_ref
|
|
gst_object_unref
|
|
gst_object_sink
|
|
gst_object_destroy
|
|
<SUBSECTION Standard>
|
|
gst_object_get_type
|
|
GST_TYPE_OBJECT
|
|
GST_IS_OBJECT
|
|
GST_OBJECT_CLASS
|
|
GST_IS_OBJECT_CLASS
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstbin</FILE>
|
|
GST_BIN
|
|
<TITLE>GstBin</TITLE>
|
|
gst_bin_new
|
|
gst_bin_add
|
|
gst_bin_remove
|
|
gst_bin_get_by_name
|
|
gst_bin_get_list
|
|
gst_bin_set_state_type
|
|
gst_bin_iterate
|
|
gst_bin_create_plan
|
|
<SUBSECTION Standard>
|
|
GST_TYPE_BIN
|
|
GST_IS_BIN
|
|
gst_bin_get_type
|
|
GST_BIN_CLASS
|
|
GST_IS_BIN_CLASS
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstbuffer</FILE>
|
|
GST_BUFFER
|
|
GST_BUFFER_FLAGS
|
|
GST_BUFFER_FLAG_SET
|
|
GST_BUFFER_FLAG_UNSET
|
|
GST_BUFFER_TYPE
|
|
GST_BUFFER_DATA
|
|
GST_BUFFER_SIZE
|
|
GST_BUFFER_OFFSET
|
|
GST_BUFFER_MAXSIZE
|
|
GST_BUFFER_TIMESTAMP
|
|
GST_BUFFER_LOCK
|
|
GST_BUFFER_TRYLOCK
|
|
GST_BUFFER_UNLOCK
|
|
GstBufferFlags
|
|
GstBuffer
|
|
gst_buffer_new
|
|
gst_buffer_create_sub
|
|
gst_buffer_ref
|
|
gst_buffer_ref_by_count
|
|
gst_buffer_unref
|
|
gst_buffer_destroy
|
|
gst_buffer_add_meta
|
|
gst_buffer_get_first_meta
|
|
gst_buffer_get_metas
|
|
gst_buffer_remove_meta
|
|
<SUBSECTION Standard>
|
|
GST_BUFFER_FLAG_IS_SET
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstconnection</FILE>
|
|
GST_CONNECTION
|
|
<TITLE>GstConnection</TITLE>
|
|
gst_connection_new
|
|
gst_connection_push
|
|
<SUBSECTION Standard>
|
|
GST_TYPE_CONNECTION
|
|
GST_IS_CONNECTION
|
|
gst_connection_get_type
|
|
GST_CONNECTION_CLASS
|
|
GST_IS_CONNECTION_CLASS
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstelement</FILE>
|
|
GstElementState
|
|
GST_STATE
|
|
GST_STATE_IS_SET
|
|
GST_STATE_SET
|
|
GST_STATE_UNSET
|
|
GST_ELEMENT
|
|
GstElementDetails
|
|
GstElementFactory
|
|
GstElementLoopFunction
|
|
<TITLE>GstElement</TITLE>
|
|
gst_element_new
|
|
gst_element_set_loop_function
|
|
gst_element_set_name
|
|
gst_element_get_name
|
|
gst_element_set_manager
|
|
gst_element_get_manager
|
|
gst_element_add_pad
|
|
gst_element_add_ghost_pad
|
|
gst_element_get_pad
|
|
gst_element_get_pad_list
|
|
gst_element_connect
|
|
gst_element_set_state
|
|
gst_element_error
|
|
gst_element_change_state
|
|
gst_element_destroy
|
|
gst_element_save_thyself
|
|
gst_elementfactory_new
|
|
gst_elementfactory_register
|
|
gst_elementfactory_find
|
|
gst_elementfactory_get_list
|
|
gst_elementfactory_create
|
|
gst_elementfactory_make
|
|
gst_element_loopfunc_wrapper
|
|
<SUBSECTION Standard>
|
|
GST_TYPE_ELEMENT
|
|
GST_IS_ELEMENT
|
|
gst_element_get_type
|
|
GST_ELEMENT_CLASS
|
|
GST_IS_ELEMENT_CLASS
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstfilter</FILE>
|
|
GST_FILTER
|
|
<TITLE>GstFilter</TITLE>
|
|
gst_filter_new
|
|
<SUBSECTION Standard>
|
|
GST_TYPE_FILTER
|
|
GST_IS_FILTER
|
|
gst_filter_get_type
|
|
GST_FILTER_CLASS
|
|
GST_IS_FILTER_CLASS
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstmeta</FILE>
|
|
GST_META
|
|
GST_META_FLAGS
|
|
GST_META_FLAG_SET
|
|
GST_META_FLAG_UNSET
|
|
GstMetaFlags
|
|
GstMeta
|
|
gst_meta_new_size
|
|
gst_meta_new
|
|
gst_meta_ref
|
|
gst_meta_unref
|
|
<SUBSECTION Standard>
|
|
GST_META_FLAG_IS_SET
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstpad</FILE>
|
|
GST_PAD
|
|
GST_PAD_CONNECTED
|
|
GstPadChainFunction
|
|
GstPadPushFunction
|
|
GstPadDirection
|
|
<TITLE>GstPad</TITLE>
|
|
gst_pad_new
|
|
gst_pad_destroy
|
|
gst_pad_get_direction
|
|
gst_pad_set_chain_function
|
|
gst_pad_get_type_id
|
|
gst_pad_set_type_id
|
|
gst_pad_set_name
|
|
gst_pad_get_name
|
|
gst_pad_get_directory
|
|
gst_pad_set_parent
|
|
gst_pad_add_ghost_parent
|
|
gst_pad_remove_ghost_parent
|
|
gst_pad_get_parent
|
|
gst_pad_get_ghost_parents
|
|
gst_pad_get_peer
|
|
gst_pad_connect
|
|
gst_pad_push
|
|
gst_pad_pull
|
|
gst_pad_save_thyself
|
|
<SUBSECTION Standard>
|
|
GST_TYPE_PAD
|
|
GST_IS_PAD
|
|
gst_pad_get_type
|
|
GST_PAD_CLASS
|
|
GST_IS_PAD_CLASS
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstpipeline</FILE>
|
|
GST_PIPELINE
|
|
<TITLE>GstPipeline</TITLE>
|
|
gst_pipeline_new
|
|
gst_pipeline_destroy
|
|
gst_pipeline_iterate
|
|
<SUBSECTION Standard>
|
|
GST_TYPE_PIPELINE
|
|
GST_IS_PIPELINE
|
|
gst_pipeline_get_type
|
|
GST_PIPELINE_CLASS
|
|
GST_IS_PIPELINE_CLASS
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstsink</FILE>
|
|
GST_SINK
|
|
<TITLE>GstSink</TITLE>
|
|
gst_sink_new
|
|
<SUBSECTION Standard>
|
|
GST_TYPE_SINK
|
|
GST_IS_SINK
|
|
gst_sink_get_type
|
|
GST_SINK_CLASS
|
|
GST_IS_SINK_CLASS
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstsrc</FILE>
|
|
GST_SRC
|
|
GstSrcFlags
|
|
GST_SRC_FLAGS
|
|
GST_SRC_ASYNC
|
|
<TITLE>GstSrc</TITLE>
|
|
GST_SRC_SET_FLAGS
|
|
GST_SRC_UNSET_FLAGS
|
|
gst_src_signal_eos
|
|
gst_src_push
|
|
gst_src_push_region
|
|
<SUBSECTION Standard>
|
|
GST_TYPE_SRC
|
|
GST_IS_SRC
|
|
gst_src_get_type
|
|
GST_SRC_CLASS
|
|
GST_IS_SRC_CLASS
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gsttee</FILE>
|
|
GST_TEE
|
|
<TITLE>GstTee</TITLE>
|
|
gst_tee_new
|
|
gst_tee_chain
|
|
gst_tee_new_pad
|
|
<SUBSECTION Standard>
|
|
GST_TYPE_TEE
|
|
GST_IS_TEE
|
|
gst_tee_get_type
|
|
GST_TEE_CLASS
|
|
GST_IS_TEE_CLASS
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstthread</FILE>
|
|
GstThreadState
|
|
GST_THREAD
|
|
<TITLE>GstThread</TITLE>
|
|
gst_thread_new
|
|
gst_thread_main_loop
|
|
gst_thread_iterate
|
|
<SUBSECTION Standard>
|
|
GST_TYPE_THREAD
|
|
GST_IS_THREAD
|
|
gst_thread_get_type
|
|
GST_THREAD_CLASS
|
|
GST_IS_THREAD_CLASS
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstasyncdisksrc</FILE>
|
|
GST_ASYNCDISKSRC
|
|
GstAsyncDiskSrcFlags
|
|
<TITLE>GstAsyncDiskSrc</TITLE>
|
|
<SUBSECTION Standard>
|
|
GST_TYPE_ASYNCDISKSRC
|
|
GST_IS_ASYNCDISKSRC
|
|
gst_asyncdisksrc_get_type
|
|
GST_ASYNCDISKSRC_CLASS
|
|
GST_IS_ASYNCDISKSRC_CLASS
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstaudiosink</FILE>
|
|
GST_AUDIOSINK
|
|
<TITLE>GstAudioSink</TITLE>
|
|
gst_audiosink_new
|
|
gst_audiosink_chain
|
|
gst_audiosink_sync_parms
|
|
gst_audiosink_set_format
|
|
gst_audiosink_set_channels
|
|
gst_audiosink_set_frequency
|
|
<SUBSECTION Standard>
|
|
GST_TYPE_AUDIOSINK
|
|
GST_IS_AUDIOSINK
|
|
gst_audiosink_get_type
|
|
GST_AUDIOSINK_CLASS
|
|
GST_IS_AUDIOSINK_CLASS
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstaudiosrc</FILE>
|
|
GST_AUDIOSRC
|
|
<TITLE>GstAudioSrc</TITLE>
|
|
gst_audiosrc_new
|
|
gst_audiosrc_push
|
|
<SUBSECTION Standard>
|
|
GST_TYPE_AUDIOSRC
|
|
GST_IS_AUDIOSRC
|
|
gst_audiosrc_get_type
|
|
GST_AUDIOSRC_CLASS
|
|
GST_IS_AUDIOSRC_CLASS
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstdisksrc</FILE>
|
|
GST_DISKSRC
|
|
GstDiskSrcFlags
|
|
<TITLE>GstDiskSrc</TITLE>
|
|
<SUBSECTION Standard>
|
|
GST_TYPE_DISKSRC
|
|
GST_IS_DISKSRC
|
|
gst_disksrc_get_type
|
|
GST_DISKSRC_CLASS
|
|
GST_IS_DISKSRC_CLASS
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstesdsink</FILE>
|
|
GST_ESDSINK
|
|
<TITLE>GstEsdSink</TITLE>
|
|
gst_esdsink_new
|
|
gst_esdsink_chain
|
|
gst_esdsink_sync_parms
|
|
gst_esdsink_set_format
|
|
gst_esdsink_set_channels
|
|
gst_esdsink_set_frequency
|
|
<SUBSECTION Standard>
|
|
GST_TYPE_ESDSINK
|
|
GST_IS_ESDSINK
|
|
gst_esdsink_get_type
|
|
GST_ESDSINK_CLASS
|
|
GST_IS_ESDSINK_CLASS
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstfakesink</FILE>
|
|
GST_FAKESINK
|
|
<TITLE>GstFakeSink</TITLE>
|
|
gst_fakesink_new
|
|
gst_fakesink_chain
|
|
<SUBSECTION Standard>
|
|
GST_TYPE_FAKESINK
|
|
GST_IS_FAKESINK
|
|
gst_fakesink_get_type
|
|
GST_FAKESINK_CLASS
|
|
GST_IS_FAKESINK_CLASS
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstfakesrc</FILE>
|
|
GST_FAKESRC
|
|
<TITLE>GstFakeSrc</TITLE>
|
|
gst_fakesrc_new
|
|
gst_fakesrc_push
|
|
<SUBSECTION Standard>
|
|
GST_TYPE_FAKESRC
|
|
GST_IS_FAKESRC
|
|
gst_fakesrc_get_type
|
|
GST_FAKESRC_CLASS
|
|
GST_IS_FAKESRC_CLASS
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstfdsink</FILE>
|
|
GST_FDSINK
|
|
<TITLE>GstFdSink</TITLE>
|
|
gst_fdsink_new
|
|
gst_fdsink_new_with_fd
|
|
gst_fdsink_chain
|
|
<SUBSECTION Standard>
|
|
GST_TYPE_FDSINK
|
|
GST_IS_FDSINK
|
|
gst_fdsink_get_type
|
|
GST_FDSINK_CLASS
|
|
GST_IS_FDSINK_CLASS
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstfdsrc</FILE>
|
|
GST_FDSRC
|
|
<TITLE>GstFdSrc</TITLE>
|
|
<SUBSECTION Standard>
|
|
GST_TYPE_FDSRC
|
|
GST_IS_FDSRC
|
|
gst_fdsrc_get_type
|
|
GST_FDSRC_CLASS
|
|
GST_IS_FDSRC_CLASS
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gsthttpsrc</FILE>
|
|
GST_HTTPSRC
|
|
<TITLE>GstHttpSrc</TITLE>
|
|
<SUBSECTION Standard>
|
|
GST_TYPE_HTTPSRC
|
|
GST_IS_HTTPSRC
|
|
gst_httpsrc_get_type
|
|
GST_HTTPSRC_CLASS
|
|
GST_IS_HTTPSRC_CLASS
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstidentity</FILE>
|
|
GST_IDENTITY
|
|
<TITLE>GstIdentity</TITLE>
|
|
gst_identity_new
|
|
gst_identity_chain
|
|
<SUBSECTION Standard>
|
|
GST_TYPE_IDENTITY
|
|
GST_IS_IDENTITY
|
|
gst_identity_get_type
|
|
GST_IDENTITY_CLASS
|
|
GST_IS_IDENTITY_CLASS
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstqueue</FILE>
|
|
GST_QUEUE
|
|
<TITLE>GstQueue</TITLE>
|
|
gst_queue_new
|
|
gst_queue_chain
|
|
gst_queue_push
|
|
<SUBSECTION Standard>
|
|
GST_TYPE_QUEUE
|
|
GST_IS_QUEUE
|
|
gst_queue_get_type
|
|
GST_QUEUE_CLASS
|
|
GST_IS_QUEUE_CLASS
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstsinesrc</FILE>
|
|
GST_SINESRC
|
|
<TITLE>GstSineSrc</TITLE>
|
|
gst_sinesrc_new
|
|
gst_sinesrc_push
|
|
<SUBSECTION Standard>
|
|
GST_TYPE_SINESRC
|
|
GST_IS_SINESRC
|
|
gst_sinesrc_get_type
|
|
GST_SINESRC_CLASS
|
|
GST_IS_SINESRC_CLASS
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>cothreads</FILE>
|
|
COTHREAD_STACKSIZE
|
|
COTHREAD_MAXTHREADS
|
|
STACK_SIZE
|
|
CURRENT_STACK_FRAME
|
|
cothread_state
|
|
cothread_context
|
|
cothread_func
|
|
COTHREAD_STARTED
|
|
cothread_init
|
|
cothread_create
|
|
cothread_setfunc
|
|
cothread_switch
|
|
cothread_main
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gst</FILE>
|
|
gst_init
|
|
DEBUG
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstlog</FILE>
|
|
GST_SHOW_INFO
|
|
gst_info
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstplugin</FILE>
|
|
GstPlugin
|
|
GstPluginElement
|
|
GstPluginInitFunc
|
|
gst_plugin_new
|
|
gst_plugin_set_longname
|
|
gst_plugin_init
|
|
gst_plugin_load_all
|
|
gst_plugin_load
|
|
gst_plugin_load_absolute
|
|
gst_plugin_add_factory
|
|
gst_plugin_find
|
|
gst_plugin_get_list
|
|
gst_plugin_find_elementfactory
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gsttrace</FILE>
|
|
gst_trace_read_tsc
|
|
GstTrace
|
|
GstTraceEntry
|
|
gst_trace_new
|
|
gst_trace_destroy
|
|
gst_trace_flush
|
|
gst_trace_get_size
|
|
gst_trace_get_offset
|
|
gst_trace_get_remaining
|
|
gst_trace_set_default
|
|
TRACE_ENABLE
|
|
gst_trace_add_entry
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gsttype</FILE>
|
|
GstTypeFindFunc
|
|
GstType
|
|
GstTypeFactory
|
|
gst_type_initialize
|
|
gst_type_register
|
|
gst_type_find_by_mime
|
|
gst_type_find_by_ext
|
|
gst_type_add_src
|
|
gst_type_add_sink
|
|
gst_type_get_srcs
|
|
gst_type_get_sinks
|
|
gst_type_find_by_id
|
|
gst_type_get_list
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstutils</FILE>
|
|
gst_util_get_int_arg
|
|
gst_util_get_long_arg
|
|
gst_util_get_float_arg
|
|
gst_util_get_double_arg
|
|
gst_util_get_string_arg
|
|
gst_util_get_pointer_arg
|
|
gst_util_get_widget_arg
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstxml</FILE>
|
|
gst_xml_write
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>plugin</FILE>
|
|
plugin_initialize
|
|
plugin_load_all
|
|
plugin_load
|
|
plugin_load_absolute
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>audioraw</FILE>
|
|
MetaAudioRaw
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>spectrum</FILE>
|
|
MetaAudioSpectrum
|
|
</SECTION>
|
|
|