gstreamer/docs/gst/gstreamer-sections.txt
Wim Taymans 3d34ce7b95 Updated the manual and the docs.
Original commit message from CVS:
Updated the manual and the docs.
Removed the esdsink in gst/elements/ we have a real one not in the
plugins dir.
Added more APIs to query the plugins, types and caps. more fields now
have a getter and a setter. This is needed to make gstreamer wrapper
fiendly.
Added gst_element_disconnect beacuse we also have a gst_element_connect
2001-01-06 02:35:17 +00:00

846 lines
14 KiB
Text

<INCLUDE>gst/gst.h</INCLUDE>
<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_getcurrent
cothread_main
cothread_set_data
cothread_get_data
<SUBSECTION Standard>
SETUP_STACK
GET_SP
JUMP
SET_SP
</SECTION>
<SECTION>
<FILE>gst</FILE>
<TITLE>Gst</TITLE>
gst_init
gst_main
gst_main_quit
<SUBSECTION Standard>
</SECTION>
<SECTION>
<FILE>gstinfo</FILE>
<TITLE>gstinfo</TITLE>
gst_get_category_name
gst_info_get_categories
gst_info_set_categories
gst_info_enable_category
gst_info_disable_category
gst_default_info_handler
GST_INFO_ENABLED
GST_INFO
GST_INFO_ELEMENT
gst_debug_get_categories
gst_debug_set_categories
gst_debug_enable_category
gst_debug_disable_category
GST_DEBUG_SET_STRING
GST_DEBUG_ENTER
GST_DEBUG_ENTER_STRING
GST_DEBUG_LEAVE
GST_DEBUG_LEAVE_STRING
GST_DEBUG_NOPREFIX
GST_DEBUG
GST_DEBUG_ENABLE_CATEGORIES
GST_DEBUG_FUNCPTR
GST_DEBUG_PREFIX
GST_DEBUG_ENABLED
GST_DEBUG_FUNCPTR_NAME
GST_DEBUG_PAD_NAME
GST_ERROR
GST_ERROR_OBJECT
gst_default_error_handler
GstInfoHandler
GstErrorHandler
</SECTION>
<SECTION>
<FILE>gstextratypes</FILE>
<TITLE>GstExtraTypes</TITLE>
GST_TYPE_FILENAME
gst_extra_get_filename_type
<SUBSECTION Standard>
</SECTION>
<SECTION>
<FILE>gstscheduler</FILE>
<TITLE>GstScheduler</TITLE>
gst_bin_schedule_func
</SECTION>
<SECTION>
<FILE>gstbin</FILE>
<TITLE>GstBin</TITLE>
GstBinFlags
GstBin
gst_bin_new
gst_bin_destroy
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
gst_bin_schedule
<SUBSECTION Standard>
GstBinClass
gst_bin_get_type
GST_TYPE_BIN
GST_BIN
GST_BIN_CLASS
GST_IS_BIN
GST_IS_BIN_CLASS
gst_bin_details
gst_bin_use_cothreads
_GstBinChain
</SECTION>
<SECTION>
<FILE>gstbuffer</FILE>
<TITLE>GstBuffer</TITLE>
GST_BUFFER_FLAGS
GST_BUFFER_FLAG_IS_SET
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_new_from_pool
gst_buffer_create_sub
gst_buffer_append
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
</SECTION>
<SECTION>
<FILE>gstbufferpool</FILE>
GstBufferPool
GstBufferPoolCreateFunction
GstBufferPoolDestroyFunction
gst_buffer_pool_new
gst_buffer_pool_new_buffer
gst_buffer_pool_destroy_buffer
gst_buffer_pool_set_create_function
gst_buffer_pool_set_destroy_function
gst_buffer_pool_destroy
<SUBSECTION Standard>
GST_BUFFER_POOL
</SECTION>
<SECTION>
<FILE>gstelement</FILE>
<TITLE>GstElement</TITLE>
GstElementState
GstElementStateReturn
GST_STATE
GST_STATE_PENDING
GST_STATE_TRANSITION
GST_STATE_NULL_TO_READY
GST_STATE_READY_TO_PLAYING
GST_STATE_PLAYING_TO_PAUSED
GST_STATE_PAUSED_TO_PLAYING
GST_STATE_PLAYING_TO_READY
GST_STATE_READY_TO_NULL
GstElementFlags
GST_ELEMENT_IS_THREAD_SUGGESTED
GST_ELEMENT_IS_COTHREAD_STOPPING
GstElement
GstElementDetails
GstElementFactory
GstElementLoopFunction
gst_element_new
gst_element_destroy
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_get_pad
gst_element_get_pad_list
gst_element_get_padtemplate_list
gst_element_add_ghost_pad
gst_element_remove_ghost_pad
gst_element_connect
gst_element_disconnect
gst_element_set_state
gst_element_error
gst_element_get_factory
gst_element_signal_eos
gst_element_save_thyself
gst_element_load_thyself
gst_elementfactory_new
gst_elementfactory_destroy
gst_elementfactory_add_padtemplate
gst_elementfactory_find
gst_elementfactory_get_list
gst_elementfactory_can_src_caps
gst_elementfactory_can_sink_caps
gst_elementfactory_can_src_caps_list
gst_elementfactory_can_sink_caps_list
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_IS_ELEMENT
GST_IS_ELEMENT_CLASS
gst_element_get_type
</SECTION>
<SECTION>
<FILE>gstclock</FILE>
GstClockTime
GstClockTimeDiff
GST_CLOCK_DIFF
GstClock
gst_clock_new
gst_clock_get_system
gst_clock_register
gst_clock_set
gst_clock_reset
gst_clock_wait
gst_clock_current_diff
</SECTION>
<SECTION>
<FILE>gstlog</FILE>
GST_SHOW_INFO
gst_info
<SUBSECTION Standard>
</SECTION>
<SECTION>
<FILE>gstmeta</FILE>
GST_META_FLAGS
GST_META_FLAG_IS_SET
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
</SECTION>
<SECTION>
<FILE>gstobject</FILE>
<TITLE>GstObject</TITLE>
GST_OBJECT_FLAG_LAST
GstObject
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
gst_object_get_path_string
<SUBSECTION Standard>
gst_object_get_type
GstObjectClass
GST_TYPE_OBJECT
GST_OBJECT
GST_OBJECT_CLASS
GST_IS_OBJECT
GST_IS_OBJECT_CLASS
</SECTION>
<SECTION>
<FILE>gstpad</FILE>
<TITLE>GstPad</TITLE>
GST_PAD_CONNECTED
GST_PAD_CAN_PULL
GstPad
GstPadChainFunction
GstPadGetFunction
GstPadGetRegionFunction
GstPadQoSFunction
GstPadEOSFunction
GstPadPushFunction
GstPadPullFunction
GstPadPullRegionFunction
GstPadDirection
GstPadFlags
gst_pad_new
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_qos_function
gst_pad_set_eos_function
gst_pad_set_caps_list
gst_pad_get_caps_list
gst_pad_get_caps_by_name
gst_pad_check_compatibility
gst_pad_set_name
gst_pad_get_name
gst_pad_set_parent
gst_pad_get_parent
gst_pad_add_ghost_parent
gst_pad_remove_ghost_parent
gst_pad_get_ghost_parents
gst_pad_get_peer
gst_pad_connect
gst_pad_disconnect
gst_pad_push
gst_pad_pull
gst_pad_pull_region
gst_pad_pullregion
gst_pad_select
gst_pad_set_eos
gst_pad_eos_func
gst_pad_handle_qos
gst_pad_eos
gst_pad_save_thyself
gst_pad_load_and_connect
GstPadFactoryEntry
GstPadFactory[]
GST_PAD_FACTORY_SOMETIMES
GST_PAD_FACTORY_ALWAYS
GST_PAD_FACTORY_SINK
GST_PAD_FACTORY_SRC
GST_PAD_FACTORY_CAPS
GstPadPresence
GstPadTemplate
gst_padtemplate_new
gst_padtemplate_create
gst_padtemplate_load_thyself
gst_padtemplate_save_thyself
<SUBSECTION Standard>
GstPadClass
GST_TYPE_PAD
GST_PAD
GST_PAD_CLASS
GST_IS_PAD
GST_IS_PAD_CLASS
gst_pad_get_type
GstPadTemplateClass
GST_TYPE_PADTEMPLATE
GST_PADTEMPLATE
GST_PADTEMPLATE_CLASS
GST_IS_PADTEMPLATE
GST_IS_PADTEMPLATE_CLASS
gst_padtemplate_get_type
</SECTION>
<SECTION>
<FILE>gstpipeline</FILE>
<TITLE>GstPipeline</TITLE>
GstPipeline
gst_pipeline_new
gst_pipeline_add_sink
gst_pipeline_add_src
gst_pipeline_autoplug
gst_pipeline_destroy
gst_pipeline_iterate
<SUBSECTION Standard>
GstPipelineClass
gst_pipeline_get_type
GST_TYPE_PIPELINE
GST_PIPELINE
GST_PIPELINE_CLASS
GST_IS_PIPELINE
GST_IS_PIPELINE_CLASS
gst_pipeline_details
</SECTION>
<SECTION>
<FILE>gstautoplug</FILE>
<TITLE>GstAutoplug</TITLE>
GST_AUTOPLUG_MAX_COST
GstAutoplugCostFunction
GstAutoplugListFunction
gst_autoplug_caps
gst_autoplug_pads
gst_autoplug_caps_list
<SUBSECTION Standard>
GstAutoplug
GST_AUTOPLUG
GST_IS_AUTOPLUG
GST_TYPE_AUTOPLUG
gst_autoplug_get_type
GST_AUTOPLUG_CLASS
GST_IS_AUTOPLUG_CLASS
</SECTION>
<SECTION>
<FILE>gstplugin</FILE>
<TITLE>GstPlugin</TITLE>
GstPlugin
GstPluginElement
GstPluginInitFunc
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_library_load
gst_plugin_add_factory
gst_plugin_add_type
gst_plugin_find
gst_plugin_get_list
gst_plugin_get_factory_list
gst_plugin_get_type_list
gst_plugin_find_elementfactory
gst_plugin_load_elementfactory
gst_plugin_load_typefactory
gst_plugin_load_thyself
gst_plugin_save_thyself
<SUBSECTION Standard>
</SECTION>
<SECTION>
<FILE>gsttee</FILE>
<TITLE>GstTee</TITLE>
GstTee
gst_tee_new
gst_tee_chain
gst_tee_new_pad
<SUBSECTION Standard>
gst_tee_get_type
GstTeeClass
GST_TYPE_TEE
GST_TEE
GST_TEE_CLASS
GST_IS_TEE
GST_IS_TEE_CLASS
</SECTION>
<SECTION>
<FILE>gstthread</FILE>
<TITLE>GstThread</TITLE>
GstThreadState
GstThread
gst_thread_new
<SUBSECTION Standard>
GstThreadClass
gst_thread_get_type
GST_TYPE_THREAD
GST_THREAD
GST_THREAD_CLASS
GST_IS_THREAD
GST_IS_THREAD_CLASS
gst_thread_details
</SECTION>
<SECTION>
<FILE>gsttrace</FILE>
<TITLE>GstTrace</TITLE>
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
<SUBSECTION Standard>
</SECTION>
<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>gstcaps</FILE>
<TITLE>GstCaps</TITLE>
GstCaps
GstCapsFactoryEntry
GstCapsFactory[]
gst_caps_new
gst_caps_new_with_props
gst_caps_register
gst_caps_register_count
gst_caps_get_name
gst_caps_set_mime
gst_caps_set_type_id
gst_caps_get_type_id
gst_caps_get_mime
gst_caps_set_name
gst_caps_set_props
gst_caps_get_props
gst_caps_check_compatibility
gst_caps_list_check_compatibility
gst_caps_save_thyself
gst_caps_load_thyself
<SUBSECTION Standard>
</SECTION>
<SECTION>
<FILE>gstprops</FILE>
<TITLE>GstProps</TITLE>
GstProps
GstPropsFactoryEntry
GstPropsFactory[]
GST_PROPS_LIST
GST_PROPS_INT
GST_PROPS_INT_RANGE
GST_PROPS_FOURCC
GST_PROPS_FOURCC_INT
GST_PROPS_BOOLEAN
gst_props_register
gst_props_register_count
gst_props_new
gst_props_merge
gst_props_check_compatibility
gst_props_save_thyself
gst_props_load_thyself
<SUBSECTION Standard>
GstPropsEntry
GstPropsListFactory[]
GstPropsId
GST_PROPS_END_ID
GST_PROPS_LIST_ID
GST_PROPS_INT_ID
GST_PROPS_INT_RANGE_ID
GST_PROPS_FOURCC_ID
GST_PROPS_BOOL_ID
GST_PROPS_LAST_ID
</SECTION>
<SECTION>
<FILE>gstutils</FILE>
<TITLE>GstUtils</TITLE>
gst_util_get_int_arg
gst_util_get_bool_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
gst_util_dump_mem
<SUBSECTION Standard>
</SECTION>
<SECTION>
<FILE>gstxml</FILE>
<TITLE>GstXml</TITLE>
GstXML
gst_xml_new
gst_xml_write
gst_xml_get_element
gst_xml_get_topelements
<SUBSECTION Standard>
gst_xml_get_type
GST_XML
GST_IS_XML
GST_IS_XML_CLASS
GST_TYPE_XML
GST_XML_CLASS
GstXMLClass
</SECTION>
<SECTION>
<FILE>gstcpu</FILE>
<TITLE>GstCpu</TITLE>
GstCPUFlags
gst_cpu_get_flags
</SECTION>
<SECTION>
<FILE>gstasyncdisksrc</FILE>
<TITLE>GstAsyncDiskSrc</TITLE>
GstAsyncDiskSrcFlags
<SUBSECTION Standard>
GstAsyncDiskSrc
GstAsyncDiskSrcClass
gst_asyncdisksrc_get_type
GST_TYPE_ASYNCDISKSRC
GST_ASYNCDISKSRC
GST_ASYNCDISKSRC_CLASS
GST_IS_ASYNCDISKSRC
GST_IS_ASYNCDISKSRC_CLASS
</SECTION>
<SECTION>
<FILE>gstaudiosink</FILE>
<TITLE>GstAudioSink</TITLE>
<SUBSECTION Standard>
GstAudioSink
GstAudioSinkClass
GstAudioSinkFlags
gst_audiosink_get_type
GST_TYPE_AUDIOSINK
GST_AUDIOSINK
GST_AUDIOSINK_CLASS
GST_IS_AUDIOSINK
GST_IS_AUDIOSINK_CLASS
gst_audiosink_factory_init
</SECTION>
<SECTION>
<FILE>gstaudiosrc</FILE>
<TITLE>GstAudioSrc</TITLE>
<SUBSECTION Standard>
GstAudioSrc
GstAudioSrcClass
GstAudioSrcFlags
gst_audiosrc_get_type
GST_TYPE_AUDIOSRC
GST_AUDIOSRC
GST_AUDIOSRC_CLASS
GST_IS_AUDIOSRC
GST_IS_AUDIOSRC_CLASS
</SECTION>
<SECTION>
<FILE>gstdisksrc</FILE>
<TITLE>GstDiskSrc</TITLE>
GstDiskSrcFlags
<SUBSECTION Standard>
GstDiskSrc
GstDiskSrcClass
gst_disksrc_get_type
GST_TYPE_DISKSRC
GST_DISKSRC
GST_DISKSRC_CLASS
GST_IS_DISKSRC
GST_IS_DISKSRC_CLASS
gst_disksrc_details
</SECTION>
<SECTION>
<FILE>gstfakesink</FILE>
<TITLE>GstFakeSink</TITLE>
<SUBSECTION Standard>
GstFakeSink
GstFakeSinkClass
gst_fakesink_get_type
GST_TYPE_FAKESINK
GST_FAKESINK
GST_FAKESINK_CLASS
GST_IS_FAKESINK
GST_IS_FAKESINK_CLASS
</SECTION>
<SECTION>
<FILE>gstfakesrc</FILE>
<TITLE>GstFakeSrc</TITLE>
<SUBSECTION Standard>
GstFakeSrc
GstFakeSrcOutputType
gst_fakesrc_get_type
GstFakeSrcClass
GST_TYPE_FAKESRC
GST_FAKESRC
GST_FAKESRC_CLASS
GST_IS_FAKESRC
GST_IS_FAKESRC_CLASS
</SECTION>
<SECTION>
<FILE>gstfdsink</FILE>
<TITLE>GstFdSink</TITLE>
<SUBSECTION Standard>
GstFdSink
GstFdSinkClass
gst_fdsink_get_type
GST_TYPE_FDSINK
GST_FDSINK
GST_FDSINK_CLASS
GST_IS_FDSINK
GST_IS_FDSINK_CLASS
</SECTION>
<SECTION>
<FILE>gstfdsrc</FILE>
<TITLE>GstFdSrc</TITLE>
<SUBSECTION Standard>
GstFdSrc
GstFdSrcClass
gst_fdsrc_get_type
GST_TYPE_FDSRC
GST_FDSRC
GST_FDSRC_CLASS
GST_IS_FDSRC
GST_IS_FDSRC_CLASS
</SECTION>
<SECTION>
<FILE>gsthttpsrc</FILE>
<TITLE>GstHttpSrc</TITLE>
<SUBSECTION Standard>
GstHttpSrc
GstHttpSrcFlags
gst_httpsrc_get_type
GstHttpSrcClass
GST_TYPE_HTTPSRC
GST_HTTPSRC
GST_HTTPSRC_CLASS
GST_IS_HTTPSRC
GST_IS_HTTPSRC_CLASS
</SECTION>
<SECTION>
<FILE>gstidentity</FILE>
<TITLE>GstIdentity</TITLE>
<SUBSECTION Standard>
GstIdentity
GstIdentityClass
gst_identity_get_type
GST_TYPE_IDENTITY
GST_IDENTITY
GST_IDENTITY_CLASS
GST_IS_IDENTITY
GST_IS_IDENTITY_CLASS
</SECTION>
<SECTION>
<FILE>gstqueue</FILE>
<TITLE>GstQueue</TITLE>
<SUBSECTION Standard>
GstQueue
GstQueueClass
gst_queue_get_type
GST_TYPE_QUEUE
GST_QUEUE
GST_QUEUE_CLASS
GST_IS_QUEUE
GST_IS_QUEUE_CLASS
</SECTION>
<SECTION>
<FILE>gstsinesrc</FILE>
<TITLE>GstSineSrc</TITLE>
<SUBSECTION Standard>
GstSineSrc
GstSineSrcClass
gst_sinesrc_get_type
GST_TYPE_SINESRC
GST_SINESRC
GST_SINESRC_CLASS
GST_IS_SINESRC
GST_IS_SINESRC_CLASS
</SECTION>
<SECTION>
<FILE>gstpipefilter</FILE>
<TITLE>GstPipefilter</TITLE>
<SUBSECTION Standard>
GST_TYPE_PIPEFILTER
GST_PIPEFILTER
GST_PIPEFILTER_CLASS
GST_IS_PIPEFILTER
GST_IS_PIPEFILTER_CLASS
GstPipeFilterFlags
GstPipefilter
GstPipefilterClass
gst_pipefilter_get_type
</SECTION>
<SECTION>
<FILE>gsttypefind</FILE>
<TITLE>GstTypeFind</TITLE>
<SUBSECTION Standard>
GstTypeFind
GstTypeFindClass
gst_typefind_get_type
GST_TYPE_TYPEFIND
GST_TYPEFIND
GST_TYPEFIND_CLASS
GST_IS_TYPEFIND
GST_IS_TYPEFIND_CLASS
</SECTION>
<SECTION>
<INCLUDE>gst/meta/audioraw.h</INCLUDE>
<FILE>audioraw</FILE>
MetaAudioRaw
</SECTION>
<SECTION>
<INCLUDE>gst/meta/spectrum.h</INCLUDE>
<FILE>spectrum</FILE>
MetaAudioSpectrum
</SECTION>
<SECTION>
<INCLUDE>gst/meta/videoraw.h</INCLUDE>
<FILE>videoraw</FILE>
MetaVideoRaw
MetaDGA
MetaOverlay
OverlayClip
</SECTION>