gstreamer/docs/libs/gstreamer-libs-sections.txt
Stefan Kost d7fe3b3c7b docs/: add new API entries to the docs
Original commit message from CVS:
* docs/gst/gstreamer-docs.sgml:
* docs/gst/gstreamer-sections.txt:
* docs/libs/gstreamer-libs-sections.txt:
add new API entries to the docs
* libs/gst/controller/Makefile.am:
* libs/gst/controller/gstcontroller.c:
* libs/gst/controller/gstcontroller.h:
* libs/gst/controller/gstcontrollerprivate.h:
* libs/gst/controller/gsthelper.c:
* libs/gst/controller/gstinterpolation.c:
move private structs to private header
* po/README:
gstreamer-0.7 -> gstreamer-0.10
* tests/check/libs/struct_i386.h:
remove private structs
2006-01-13 14:21:48 +00:00

357 lines
7 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
GST_DP_VERSION_MAJOR
GST_DP_VERSION_MINOR
gst_dp_init
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>
</SECTION>
<SECTION>
<FILE>gstcontroller</FILE>
<TITLE>GstController</TITLE>
<INCLUDE>gst/controller/gstcontroller.h</INCLUDE>
GstController
GstInterpolateMode
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
gst_controller_set_from_list
gst_controller_unset
gst_controller_get
gst_controller_get_all
gst_controller_sync_values
gst_controller_get_value_arrays
gst_controller_get_value_array
gst_controller_set_interpolation_mode
GST_PARAM_CONTROLLABLE
<SUBSECTION Standard>
GstControllerClass
GST_CONTROLLER
GST_IS_CONTROLLER
GST_CONTROLLER_CLASS
GST_IS_CONTROLLER_CLASS
GST_CONTROLLER_GET_CLASS
GST_TYPE_CONTROLLER
<SUBSECTION Private>
InterpolateGet
InterpolateGetValueArray
GST_CONTROLLED_PROPERTY
gst_controller_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_sync_values
gst_object_get_value_arrays
gst_object_get_value_array
<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_flush
gst_adapter_available
gst_adapter_available_fast
gst_adapter_take
<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
GstBaseSrcFlags
gst_base_src_is_live
gst_base_src_set_live
gst_base_src_set_format
GST_BASE_SRC_PAD
<SUBSECTION Standard>
GstBaseSrcClass
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
GST_BASE_SINK_PAD
<SUBSECTION Standard>
GstBaseSinkClass
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>
gst_base_sink_get_type
</SECTION>
<SECTION>
<FILE>gstbasetransform</FILE>
<TITLE>GstBaseTransform</TITLE>
<INCLUDE>gst/base/gstbasetransform.h</INCLUDE>
GstBaseTransform
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_SINK_NAME
GST_BASE_TRANSFORM_SRC_NAME
<SUBSECTION Standard>
GstBaseTransformClass
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
<SUBSECTION Private>
gst_base_transform_get_type
</SECTION>
<SECTION>
<FILE>gstcollectpads</FILE>
<TITLE>GstCollectPads</TITLE>
<INCLUDE>gst/base/gstcollectpads.h</INCLUDE>
GstCollectData
GstCollectPads
GstCollectPadsFunction
gst_collect_pads_new
gst_collect_pads_set_function
gst_collect_pads_add_pad
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_peek
gst_collect_pads_pop
gst_collect_pads_available
gst_collect_pads_read
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_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>
# net
<SECTION>
<FILE>gstnetclientclock</FILE>
<TITLE>GstNetClientClock</TITLE>
<INCLUDE>gst/net/gstnet.h</INCLUDE>
GstNetClientClock
gst_net_client_clock_new
<SUBSECTION Standard>
GstNetClientClockClass
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>
</SECTION>
<SECTION>
<FILE>gstnettimeprovider</FILE>
<TITLE>GstNetTimeProvider</TITLE>
<INCLUDE>gst/net/gstnet.h</INCLUDE>
GstNetTimeProvider
gst_net_time_provider_new
<SUBSECTION Standard>
GstNetTimeProviderClass
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>
<SUBSECTION Private>
ASSERT_BUFFER_REFCOUNT
ASSERT_CAPS_REFCOUNT
ASSERT_CRITICAL
ASSERT_WARNING
ASSERT_MINI_OBJECT_REFCOUNT
ASSERT_OBJECT_REFCOUNT
ASSERT_OBJECT_REFCOUNT_BETWEEN
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
GST_START_TEST
GST_END_TEST
sync_cond
mutex
GST_CAT_DEFAULT
thread_list
start_cond
fail_unless_equals_int
fail_unless_equals_string
fail_unless_equals_uint64
fail_unless_message_error
gst_check_chain_func
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
</SECTION>
# misc
# TODO : add gsttypefindhelper