mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-12-02 22:46:35 +00:00
4a638e29d9
Original commit message from CVS: * docs/gst/gstreamer-docs.sgml: * docs/gst/gstreamer-sections.txt: * gst/gstparamspecs.c: * gst/gstparamspecs.h: Add GST_PARAM_CONTROLLABLE and GST_PARAM_USER_SHIFT. Move paramspec docs to own section. * gst/gstvalue.c: This now only documents GValue. * docs/libs/gstreamer-libs-sections.txt: * libs/gst/controller/gstcontroller.h: Remove GST_PARAM_CONTROLLABLE.
566 lines
12 KiB
Text
566 lines
12 KiB
Text
# GStreamer Libraries API reference sections
|
|
|
|
## please add sections in alphabetical order using the following template
|
|
# leave two empty lines between sections
|
|
# <SECTION>
|
|
# <FILE>gstxxx</FILE>
|
|
# <TITLE>GstXxx</TITLE>
|
|
# typedefs
|
|
# macros
|
|
# constructor
|
|
# methods
|
|
# <SUBSECTION Standard>
|
|
# <SUBSECTION Private>
|
|
# </SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstdataprotocol</FILE>
|
|
<INCLUDE>gst/dataprotocol/dataprotocol.h</INCLUDE>
|
|
GstDPHeaderFlag
|
|
GstDPPayloadType
|
|
|
|
GST_DP_HEADER_LENGTH
|
|
GstDPVersion
|
|
GST_DP_VERSION_MAJOR
|
|
GST_DP_VERSION_MINOR
|
|
|
|
gst_dp_init
|
|
|
|
GstDPHeaderFromBufferFunction
|
|
GstDPPacketFromCapsFunction
|
|
GstDPPacketFromEventFunction
|
|
GstDPPacketizer
|
|
gst_dp_packetizer_new
|
|
gst_dp_packetizer_free
|
|
|
|
gst_dp_crc
|
|
|
|
gst_dp_header_payload_length
|
|
gst_dp_header_payload_type
|
|
|
|
gst_dp_header_from_buffer
|
|
gst_dp_packet_from_caps
|
|
gst_dp_packet_from_event
|
|
|
|
gst_dp_buffer_from_header
|
|
gst_dp_caps_from_packet
|
|
gst_dp_event_from_packet
|
|
|
|
gst_dp_validate_header
|
|
gst_dp_validate_payload
|
|
gst_dp_validate_packet
|
|
<SUBSECTION Standard>
|
|
GST_TYPE_DP_VERSION
|
|
gst_dp_version_get_type
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstcontroller</FILE>
|
|
<TITLE>GstController</TITLE>
|
|
<INCLUDE>gst/controller/gstcontroller.h</INCLUDE>
|
|
GstController
|
|
gst_controller_init
|
|
gst_controller_new
|
|
gst_controller_new_list
|
|
gst_controller_new_valist
|
|
gst_controller_remove_properties
|
|
gst_controller_remove_properties_list
|
|
gst_controller_remove_properties_valist
|
|
gst_controller_set_disabled
|
|
gst_controller_set_property_disabled
|
|
gst_controller_suggest_next_sync
|
|
gst_controller_sync_values
|
|
gst_controller_get_control_source
|
|
gst_controller_set_control_source
|
|
gst_controller_get
|
|
gst_controller_get_value_arrays
|
|
gst_controller_get_value_array
|
|
gst_controller_set
|
|
gst_controller_set_from_list
|
|
gst_controller_unset
|
|
gst_controller_unset_all
|
|
gst_controller_get_all
|
|
gst_controller_set_interpolation_mode
|
|
<SUBSECTION Standard>
|
|
GstControllerClass
|
|
GstControllerPrivate
|
|
GST_CONTROLLER
|
|
GST_IS_CONTROLLER
|
|
GST_CONTROLLER_CLASS
|
|
GST_IS_CONTROLLER_CLASS
|
|
GST_CONTROLLER_GET_CLASS
|
|
GST_TYPE_CONTROLLER
|
|
<SUBSECTION Private>
|
|
GST_CONTROLLED_PROPERTY
|
|
gst_controller_get_type
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstcontrolsource</FILE>
|
|
<TITLE>GstControlSource</TITLE>
|
|
<INCLUDE>libs/controller/gstcontrolsource.h</INCLUDE>
|
|
GstControlSource
|
|
GstControlSourceClass
|
|
GstControlSourceBind
|
|
GstControlSourceGetValue
|
|
GstControlSourceGetValueArray
|
|
GstTimedValue
|
|
GstValueArray
|
|
gst_control_source_bind
|
|
gst_control_source_get_value
|
|
gst_control_source_get_value_array
|
|
<SUBSECTION Standard>
|
|
GST_CONTROL_SOURCE
|
|
GST_IS_CONTROL_SOURCE
|
|
GST_CONTROL_SOURCE_CLASS
|
|
GST_IS_CONTROL_SOURCE_CLASS
|
|
GST_CONTROL_SOURCE_GET_CLASS
|
|
GST_TYPE_CONTROL_SOURCE
|
|
<SUBSECTION Private>
|
|
gst_control_source_get_type
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstinterpolationcontrolsource</FILE>
|
|
<TITLE>GstInterpolationControlSource</TITLE>
|
|
<INCLUDE>libs/controller/gstinterpolationcontrolsource.h</INCLUDE>
|
|
GstInterpolationControlSource
|
|
GstInterpolateMode
|
|
gst_interpolation_control_source_new
|
|
gst_interpolation_control_source_set
|
|
gst_interpolation_control_source_set_from_list
|
|
gst_interpolation_control_source_set_interpolation_mode
|
|
gst_interpolation_control_source_get_all
|
|
gst_interpolation_control_source_unset
|
|
gst_interpolation_control_source_unset_all
|
|
gst_interpolation_control_source_get_count
|
|
<SUBSECTION Standard>
|
|
GstInterpolationControlSourceClass
|
|
GstInterpolationControlSourcePrivate
|
|
GST_INTERPOLATION_CONTROL_SOURCE
|
|
GST_IS_INTERPOLATION_CONTROL_SOURCE
|
|
GST_INTERPOLATION_CONTROL_SOURCE_CLASS
|
|
GST_IS_INTERPOLATION_CONTROL_SOURCE_CLASS
|
|
GST_INTERPOLATION_CONTROL_SOURCE_GET_CLASS
|
|
GST_TYPE_INTERPOLATION_CONTROL_SOURCE
|
|
<SUBSECTION Private>
|
|
gst_interpolation_control_source_get_type
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstlfocontrolsource</FILE>
|
|
<TITLE>GstLFOControlSource</TITLE>
|
|
<INCLUDE>libs/controller/gstlfocontrolsource.h</INCLUDE>
|
|
GstLFOControlSource
|
|
GstLFOWaveform
|
|
gst_lfo_control_source_new
|
|
<SUBSECTION Standard>
|
|
GstLFOControlSourceClass
|
|
GstLFOControlSourcePrivate
|
|
GST_IS_LFO_CONTROL_SOURCE
|
|
GST_IS_LFO_CONTROL_SOURCE_CLASS
|
|
GST_LFO_CONTROL_SOURCE
|
|
GST_LFO_CONTROL_SOURCE_CLASS
|
|
GST_LFO_CONTROL_SOURCE_GET_CLASS
|
|
GST_TYPE_LFO_CONTROL_SOURCE
|
|
GST_TYPE_LFO_WAVEFORM
|
|
<SUBSECTION Private>
|
|
gst_lfo_control_source_get_type
|
|
gst_lfo_waveform_get_type
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstcontrollergobject</FILE>
|
|
<TITLE>GstControllerGObject</TITLE>
|
|
<INCLUDE>libs/controller/gstcontroller.h</INCLUDE>
|
|
gst_object_control_properties
|
|
gst_object_uncontrol_properties
|
|
gst_object_get_controller
|
|
gst_object_set_controller
|
|
gst_object_suggest_next_sync
|
|
gst_object_sync_values
|
|
gst_object_get_control_source
|
|
gst_object_set_control_source
|
|
gst_object_get_value_arrays
|
|
gst_object_get_value_array
|
|
gst_object_get_control_rate
|
|
gst_object_set_control_rate
|
|
<SUBSECTION Standard>
|
|
<SUBSECTION Private>
|
|
</SECTION>
|
|
|
|
# base classes
|
|
|
|
<SECTION>
|
|
<FILE>gstadapter</FILE>
|
|
<TITLE>GstAdapter</TITLE>
|
|
<INCLUDE>gst/base/gstadapter.h</INCLUDE>
|
|
GstAdapter
|
|
gst_adapter_new
|
|
gst_adapter_clear
|
|
gst_adapter_push
|
|
gst_adapter_peek
|
|
gst_adapter_copy
|
|
gst_adapter_flush
|
|
gst_adapter_available
|
|
gst_adapter_available_fast
|
|
gst_adapter_take
|
|
gst_adapter_take_buffer
|
|
<SUBSECTION Standard>
|
|
GstAdapterClass
|
|
GST_ADAPTER
|
|
GST_IS_ADAPTER
|
|
GST_TYPE_ADAPTER
|
|
GST_ADAPTER_CLASS
|
|
GST_IS_ADAPTER_CLASS
|
|
GST_ADAPTER_GET_CLASS
|
|
<SUBSECTION Private>
|
|
gst_adapter_get_type
|
|
</SECTION>
|
|
|
|
|
|
<SECTION>
|
|
<FILE>gstbasesrc</FILE>
|
|
<TITLE>GstBaseSrc</TITLE>
|
|
<INCLUDE>gst/base/gstbasesrc.h</INCLUDE>
|
|
GstBaseSrc
|
|
GstBaseSrcClass
|
|
GstBaseSrcFlags
|
|
|
|
gst_base_src_wait_playing
|
|
gst_base_src_is_live
|
|
gst_base_src_set_live
|
|
gst_base_src_set_format
|
|
gst_base_src_query_latency
|
|
gst_base_src_get_do_timestamp
|
|
gst_base_src_set_do_timestamp
|
|
|
|
GST_BASE_SRC_PAD
|
|
<SUBSECTION Standard>
|
|
GstBaseSrcPrivate
|
|
GST_BASE_SRC
|
|
GST_BASE_SRC_CAST
|
|
GST_IS_BASE_SRC
|
|
GST_TYPE_BASE_SRC
|
|
GST_BASE_SRC_CLASS
|
|
GST_IS_BASE_SRC_CLASS
|
|
GST_BASE_SRC_GET_CLASS
|
|
<SUBSECTION Private>
|
|
gst_base_src_get_type
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstbasesink</FILE>
|
|
<TITLE>GstBaseSink</TITLE>
|
|
<INCLUDE>gst/base/gstbasesink.h</INCLUDE>
|
|
GstBaseSink
|
|
GstBaseSinkClass
|
|
|
|
gst_base_sink_query_latency
|
|
gst_base_sink_get_latency
|
|
gst_base_sink_wait_preroll
|
|
gst_base_sink_wait_eos
|
|
gst_base_sink_set_sync
|
|
gst_base_sink_get_sync
|
|
gst_base_sink_set_max_lateness
|
|
gst_base_sink_get_max_lateness
|
|
gst_base_sink_set_qos_enabled
|
|
gst_base_sink_is_qos_enabled
|
|
gst_base_sink_set_async_enabled
|
|
gst_base_sink_is_async_enabled
|
|
gst_base_sink_set_ts_offset
|
|
gst_base_sink_get_ts_offset
|
|
gst_base_sink_get_last_buffer
|
|
|
|
GST_BASE_SINK_PAD
|
|
|
|
<SUBSECTION Standard>
|
|
GST_BASE_SINK
|
|
GST_BASE_SINK_CAST
|
|
GST_IS_BASE_SINK
|
|
GST_TYPE_BASE_SINK
|
|
GST_BASE_SINK_CLASS
|
|
GST_IS_BASE_SINK_CLASS
|
|
GST_BASE_SINK_GET_CLASS
|
|
<SUBSECTION Private>
|
|
GstBaseSinkPrivate
|
|
gst_base_sink_get_type
|
|
</SECTION>
|
|
|
|
|
|
<SECTION>
|
|
<FILE>gstbasetransform</FILE>
|
|
<TITLE>GstBaseTransform</TITLE>
|
|
<INCLUDE>gst/base/gstbasetransform.h</INCLUDE>
|
|
GstBaseTransform
|
|
GstBaseTransformClass
|
|
|
|
gst_base_transform_is_passthrough
|
|
gst_base_transform_set_passthrough
|
|
gst_base_transform_is_in_place
|
|
gst_base_transform_set_in_place
|
|
gst_base_transform_is_qos_enabled
|
|
gst_base_transform_set_qos_enabled
|
|
gst_base_transform_update_qos
|
|
gst_base_transform_set_gap_aware
|
|
|
|
GST_BASE_TRANSFORM_SINK_NAME
|
|
GST_BASE_TRANSFORM_SRC_NAME
|
|
GST_BASE_TRANSFORM_SINK_PAD
|
|
GST_BASE_TRANSFORM_SRC_PAD
|
|
|
|
GST_BASE_TRANSFORM_FLOW_DROPPED
|
|
|
|
GST_BASE_TRANSFORM_LOCK
|
|
GST_BASE_TRANSFORM_UNLOCK
|
|
|
|
<SUBSECTION Standard>
|
|
GST_BASE_TRANSFORM
|
|
GST_IS_BASE_TRANSFORM
|
|
GST_TYPE_BASE_TRANSFORM
|
|
GST_BASE_TRANSFORM_CLASS
|
|
GST_IS_BASE_TRANSFORM_CLASS
|
|
GST_BASE_TRANSFORM_GET_CLASS
|
|
GST_BASE_TRANSFORM_CAST
|
|
<SUBSECTION Private>
|
|
GstBaseTransformPrivate
|
|
gst_base_transform_get_type
|
|
</SECTION>
|
|
|
|
|
|
<SECTION>
|
|
<FILE>gstcollectpads</FILE>
|
|
<TITLE>GstCollectPads</TITLE>
|
|
<INCLUDE>gst/base/gstcollectpads.h</INCLUDE>
|
|
GstCollectData
|
|
GstCollectPads
|
|
GstCollectPadsFunction
|
|
GstCollectDataDestroyNotify
|
|
gst_collect_pads_new
|
|
gst_collect_pads_set_function
|
|
gst_collect_pads_add_pad
|
|
gst_collect_pads_add_pad_full
|
|
gst_collect_pads_remove_pad
|
|
gst_collect_pads_is_active
|
|
gst_collect_pads_collect
|
|
gst_collect_pads_collect_range
|
|
gst_collect_pads_start
|
|
gst_collect_pads_stop
|
|
gst_collect_pads_set_flushing
|
|
gst_collect_pads_peek
|
|
gst_collect_pads_pop
|
|
gst_collect_pads_available
|
|
gst_collect_pads_read
|
|
gst_collect_pads_read_buffer
|
|
gst_collect_pads_take_buffer
|
|
gst_collect_pads_flush
|
|
<SUBSECTION Standard>
|
|
GstCollectPadsClass
|
|
GST_COLLECT_PADS
|
|
GST_IS_COLLECT_PADS
|
|
GST_TYPE_COLLECT_PADS
|
|
GST_COLLECT_PADS_CLASS
|
|
GST_IS_COLLECT_PADS_CLASS
|
|
GST_COLLECT_PADS_GET_CLASS
|
|
<SUBSECTION Private>
|
|
gst_collect_pads_get_type
|
|
GST_COLLECT_PADS_GET_PAD_LOCK
|
|
GST_COLLECT_PADS_PAD_LOCK
|
|
GST_COLLECT_PADS_PAD_UNLOCK
|
|
GST_COLLECT_PADS_BROADCAST
|
|
GST_COLLECT_PADS_GET_COND
|
|
GST_COLLECT_PADS_SIGNAL
|
|
GST_COLLECT_PADS_WAIT
|
|
</SECTION>
|
|
|
|
|
|
<SECTION>
|
|
<FILE>gstpushsrc</FILE>
|
|
<TITLE>GstPushSrc</TITLE>
|
|
<INCLUDE>gst/base/gstpushsrc.h</INCLUDE>
|
|
GstPushSrc
|
|
<SUBSECTION Standard>
|
|
GstPushSrcClass
|
|
GST_PUSH_SRC
|
|
GST_IS_PUSH_SRC
|
|
GST_TYPE_PUSH_SRC
|
|
GST_PUSH_SRC_CLASS
|
|
GST_IS_PUSH_SRC_CLASS
|
|
GST_PUSH_SRC_GET_CLASS
|
|
<SUBSECTION Private>
|
|
gst_push_src_get_type
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gsttypefindhelper</FILE>
|
|
<TITLE>GstTypeFindHelper</TITLE>
|
|
<INCLUDE>gst/base/gsttypefindhelper.h</INCLUDE>
|
|
gst_type_find_helper
|
|
gst_type_find_helper_for_buffer
|
|
GstTypeFindHelperGetRangeFunction
|
|
gst_type_find_helper_get_range
|
|
<SUBSECTION Private>
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstdataqueue</FILE>
|
|
<TITLE>GstDataQueue</TITLE>
|
|
<INCLUDE>gst/base/gstdataqueue.h</INCLUDE>
|
|
GstDataQueue
|
|
GstDataQueueSize
|
|
GstDataQueueCheckFullFunction
|
|
GstDataQueueItem
|
|
gst_data_queue_new
|
|
gst_data_queue_push
|
|
gst_data_queue_pop
|
|
gst_data_queue_flush
|
|
gst_data_queue_set_flushing
|
|
gst_data_queue_drop_head
|
|
gst_data_queue_is_full
|
|
gst_data_queue_is_empty
|
|
gst_data_queue_get_level
|
|
gst_data_queue_limits_changed
|
|
<SUBSECTION Standard>
|
|
GstDataQueueClass
|
|
GST_DATA_QUEUE
|
|
GST_IS_DATA_QUEUE
|
|
GST_TYPE_DATA_QUEUE
|
|
GST_DATA_QUEUE_CLASS
|
|
GST_IS_DATA_QUEUE_CLASS
|
|
<SUBSECTION Private>
|
|
gst_data_queue_get_type
|
|
</SECTION>
|
|
|
|
# net
|
|
|
|
<SECTION>
|
|
<FILE>gstnetclientclock</FILE>
|
|
<TITLE>GstNetClientClock</TITLE>
|
|
<INCLUDE>gst/net/gstnet.h</INCLUDE>
|
|
GstNetClientClock
|
|
gst_net_client_clock_new
|
|
<SUBSECTION Standard>
|
|
GstNetClientClockClass
|
|
GstNetClientClockPrivate
|
|
GST_NET_CLIENT_CLOCK
|
|
GST_IS_NET_CLIENT_CLOCK
|
|
GST_TYPE_NET_CLIENT_CLOCK
|
|
GST_NET_CLIENT_CLOCK_CLASS
|
|
GST_IS_NET_CLIENT_CLOCK_CLASS
|
|
<SUBSECTION Private>
|
|
gst_net_client_clock_get_type
|
|
</SECTION>
|
|
|
|
|
|
<SECTION>
|
|
<FILE>gstnettimepacket</FILE>
|
|
<TITLE>GstNetTimePacket</TITLE>
|
|
<INCLUDE>gst/net/gstnet.h</INCLUDE>
|
|
GstNetTimePacket
|
|
GST_NET_TIME_PACKET_SIZE
|
|
gst_net_time_packet_new
|
|
gst_net_time_packet_receive
|
|
gst_net_time_packet_send
|
|
gst_net_time_packet_serialize
|
|
<SUBSECTION Standard>
|
|
<SUBSECTION Private>
|
|
socklen_t
|
|
</SECTION>
|
|
|
|
|
|
<SECTION>
|
|
<FILE>gstnettimeprovider</FILE>
|
|
<TITLE>GstNetTimeProvider</TITLE>
|
|
<INCLUDE>gst/net/gstnet.h</INCLUDE>
|
|
GstNetTimeProvider
|
|
gst_net_time_provider_new
|
|
<SUBSECTION Standard>
|
|
GstNetTimeProviderClass
|
|
GstNetTimeProviderPrivate
|
|
GST_NET_TIME_PROVIDER
|
|
GST_IS_NET_TIME_PROVIDER
|
|
GST_TYPE_NET_TIME_PROVIDER
|
|
GST_NET_TIME_PROVIDER_CLASS
|
|
GST_IS_NET_TIME_PROVIDER_CLASS
|
|
<SUBSECTION Private>
|
|
gst_net_time_provider_get_type
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstcheck</FILE>
|
|
<TITLE>GstCheck</TITLE>
|
|
<INCLUDE>gst/check/gstcheck.h</INCLUDE>
|
|
GST_START_TEST
|
|
GST_END_TEST
|
|
|
|
ASSERT_BUFFER_REFCOUNT
|
|
ASSERT_CAPS_REFCOUNT
|
|
ASSERT_CRITICAL
|
|
ASSERT_WARNING
|
|
ASSERT_MINI_OBJECT_REFCOUNT
|
|
ASSERT_OBJECT_REFCOUNT
|
|
ASSERT_OBJECT_REFCOUNT_BETWEEN
|
|
ASSERT_SET_STATE
|
|
|
|
fail_unless_equals_int
|
|
fail_unless_equals_float
|
|
fail_unless_equals_string
|
|
fail_unless_equals_uint64
|
|
fail_unless_message_error
|
|
|
|
assert_equals_int
|
|
assert_equals_float
|
|
assert_equals_string
|
|
assert_equals_uint64
|
|
assert_message_error
|
|
|
|
gst_check_init
|
|
gst_check_message_error
|
|
gst_check_setup_element
|
|
gst_check_setup_sink_pad
|
|
gst_check_setup_src_pad
|
|
gst_check_teardown_element
|
|
gst_check_teardown_sink_pad
|
|
gst_check_teardown_src_pad
|
|
gst_check_drop_buffers
|
|
gst_check_caps_equal
|
|
gst_check_element_push_buffer_list
|
|
gst_check_element_push_buffer
|
|
gst_check_run_suite
|
|
|
|
<SUBSECTION Private>
|
|
MAIN_INIT
|
|
MAIN_START_THREADS
|
|
MAIN_START_THREAD_FUNCTION
|
|
MAIN_START_THREAD_FUNCTIONS
|
|
MAIN_STOP_THREADS
|
|
MAIN_SYNCHRONIZE
|
|
THREAD_START
|
|
THREAD_STARTED
|
|
THREAD_SWITCH
|
|
THREAD_SYNCHRONIZE
|
|
THREAD_TEST_RUNNING
|
|
|
|
sync_cond
|
|
mutex
|
|
GST_CAT_DEFAULT
|
|
thread_list
|
|
start_cond
|
|
GST_CHECK_MAIN
|
|
|
|
gst_check_chain_func
|
|
gst_check_abi_list
|
|
|
|
buffers
|
|
check_cond
|
|
check_mutex
|
|
</SECTION>
|
|
|
|
<SECTION>
|
|
<FILE>gstcheckbufferstraw</FILE>
|
|
<TITLE>GstBufferStraw</TITLE>
|
|
<INCLUDE>gst/check/gstbufferstraw.h</INCLUDE>
|
|
gst_buffer_straw_start_pipeline
|
|
gst_buffer_straw_get_buffer
|
|
gst_buffer_straw_stop_pipeline
|
|
</SECTION>
|