docs/libs/gstreamer-libs-sections.txt

   1 # GStreamer Libraries API reference sections
   2
   3 ## please add sections in alphabetical order using the following template
   4 # leave two empty lines between sections
   5 # <SECTION>
   6 # <FILE>gstxxx</FILE>
   7 # <TITLE>GstXxx</TITLE>
   8 # typedefs
   9 # macros
  10 # constructor
  11 # methods
  12 # <SUBSECTION Standard>
  13 # <SUBSECTION Private>
  14 # </SECTION>
  15
  16 <SECTION>
  17 <FILE>gstdataprotocol</FILE>
  18 <INCLUDE>gst/dataprotocol/dataprotocol.h</INCLUDE>
  19 GstDPHeaderFlag
  20 GstDPPayloadType
  21
  22 GST_DP_HEADER_LENGTH
  23 GstDPVersion
  24 GST_DP_VERSION_MAJOR
  25 GST_DP_VERSION_MINOR
  26
  27 gst_dp_init
  28
  29 GstDPHeaderFromBufferFunction
  30 GstDPPacketFromCapsFunction
  31 GstDPPacketFromEventFunction
  32 GstDPPacketizer
  33 gst_dp_packetizer_new
  34 gst_dp_packetizer_free
  35
  36 gst_dp_crc
  37
  38 gst_dp_header_payload_length
  39 gst_dp_header_payload_type
  40
  41 gst_dp_header_from_buffer
  42 gst_dp_packet_from_caps
  43 gst_dp_packet_from_event
  44
  45 gst_dp_buffer_from_header
  46 gst_dp_caps_from_packet
  47 gst_dp_event_from_packet
  48
  49 gst_dp_validate_header
  50 gst_dp_validate_payload
  51 gst_dp_validate_packet
  52 <SUBSECTION Standard>
  53 GST_TYPE_DP_VERSION
  54 gst_dp_version_get_type
  55 </SECTION>
  56
  57 <SECTION>
  58 <FILE>gstcontroller</FILE>
  59 <TITLE>GstController</TITLE>
  60 <INCLUDE>gst/controller/gstcontroller.h</INCLUDE>
  61 GstController
  62 GstInterpolateMode
  63 gst_controller_init
  64 gst_controller_new
  65 gst_controller_new_list
  66 gst_controller_new_valist
  67 gst_controller_remove_properties
  68 gst_controller_remove_properties_list
  69 gst_controller_remove_properties_valist
  70 gst_controller_set
  71 gst_controller_set_from_list
  72 gst_controller_unset
  73 gst_controller_unset_all
  74 gst_controller_get
  75 gst_controller_get_all
  76 gst_controller_sync_values
  77 gst_controller_get_value_arrays
  78 gst_controller_get_value_array
  79 gst_controller_set_interpolation_mode
  80 GST_PARAM_CONTROLLABLE
  81 <SUBSECTION Standard>
  82 GstControllerClass
  83 GstControllerPrivate
  84 GST_CONTROLLER
  85 GST_IS_CONTROLLER
  86 GST_CONTROLLER_CLASS
  87 GST_IS_CONTROLLER_CLASS
  88 GST_CONTROLLER_GET_CLASS
  89 GST_TYPE_CONTROLLER
  90 <SUBSECTION Private>
  91 InterpolateGet
  92 InterpolateGetValueArray
  93 GST_CONTROLLED_PROPERTY
  94 gst_controller_get_type
  95 </SECTION>
  96
  97 <SECTION>
  98 <FILE>gstcontrollergobject</FILE>
  99 <TITLE>GstControllerGObject</TITLE>
 100 <INCLUDE>libs/controller/gstcontroller.h</INCLUDE>
 101 gst_object_control_properties
 102 gst_object_uncontrol_properties
 103 gst_object_get_controller
 104 gst_object_set_controller
 105 gst_object_sync_values
 106 gst_object_get_value_arrays
 107 gst_object_get_value_array
 108 gst_object_get_control_rate
 109 gst_object_set_control_rate
 110 <SUBSECTION Standard>
 111 <SUBSECTION Private>
 112 </SECTION>
 113
 114
 115 # base classes
 116
 117 <SECTION>
 118 <FILE>gstadapter</FILE>
 119 <TITLE>GstAdapter</TITLE>
 120 <INCLUDE>gst/base/gstadapter.h</INCLUDE>
 121 GstAdapter
 122 gst_adapter_new
 123 gst_adapter_clear
 124 gst_adapter_push
 125 gst_adapter_peek
 126 gst_adapter_flush
 127 gst_adapter_available
 128 gst_adapter_available_fast
 129 gst_adapter_take
 130 gst_adapter_take_buffer
 131 <SUBSECTION Standard>
 132 GstAdapterClass
 133 GST_ADAPTER
 134 GST_IS_ADAPTER
 135 GST_TYPE_ADAPTER
 136 GST_ADAPTER_CLASS
 137 GST_IS_ADAPTER_CLASS
 138 GST_ADAPTER_GET_CLASS
 139 <SUBSECTION Private>
 140 gst_adapter_get_type
 141 </SECTION>
 142
 143
 144 <SECTION>
 145 <FILE>gstbasesrc</FILE>
 146 <TITLE>GstBaseSrc</TITLE>
 147 <INCLUDE>gst/base/gstbasesrc.h</INCLUDE>
 148 GstBaseSrc
 149 GstBaseSrcClass
 150 GstBaseSrcFlags
 151
 152 gst_base_src_is_live
 153 gst_base_src_set_live
 154 gst_base_src_set_format
 155
 156 GST_BASE_SRC_PAD
 157 <SUBSECTION Standard>
 158 GstBaseSrcPrivate
 159 GST_BASE_SRC
 160 GST_BASE_SRC_CAST
 161 GST_IS_BASE_SRC
 162 GST_TYPE_BASE_SRC
 163 GST_BASE_SRC_CLASS
 164 GST_IS_BASE_SRC_CLASS
 165 GST_BASE_SRC_GET_CLASS
 166 <SUBSECTION Private>
 167 gst_base_src_get_type
 168 </SECTION>
 169
 170
 171 <SECTION>
 172 <FILE>gstbasesink</FILE>
 173 <TITLE>GstBaseSink</TITLE>
 174 <INCLUDE>gst/base/gstbasesink.h</INCLUDE>
 175 GstBaseSink
 176 GstBaseSinkClass
 177
 178 gst_base_sink_set_sync
 179 gst_base_sink_get_sync
 180 gst_base_sink_set_max_lateness
 181 gst_base_sink_get_max_lateness
 182 gst_base_sink_is_qos_enabled
 183 gst_base_sink_set_qos_enabled
 184
 185 GST_BASE_SINK_PAD
 186
 187 <SUBSECTION Standard>
 188 GST_BASE_SINK
 189 GST_BASE_SINK_CAST
 190 GST_IS_BASE_SINK
 191 GST_TYPE_BASE_SINK
 192 GST_BASE_SINK_CLASS
 193 GST_IS_BASE_SINK_CLASS
 194 GST_BASE_SINK_GET_CLASS
 195 <SUBSECTION Private>
 196 GstBaseSinkPrivate
 197 gst_base_sink_get_type
 198 </SECTION>
 199
 200
 201 <SECTION>
 202 <FILE>gstbasetransform</FILE>
 203 <TITLE>GstBaseTransform</TITLE>
 204 <INCLUDE>gst/base/gstbasetransform.h</INCLUDE>
 205 GstBaseTransform
 206 GstBaseTransformClass
 207
 208 gst_base_transform_is_passthrough
 209 gst_base_transform_set_passthrough
 210 gst_base_transform_is_in_place
 211 gst_base_transform_set_in_place
 212 gst_base_transform_is_qos_enabled
 213 gst_base_transform_set_qos_enabled
 214 gst_base_transform_update_qos
 215
 216 GST_BASE_TRANSFORM_SINK_NAME
 217 GST_BASE_TRANSFORM_SRC_NAME
 218 GST_BASE_TRANSFORM_SINK_PAD
 219 GST_BASE_TRANSFORM_SRC_PAD
 220
 221 <SUBSECTION Standard>
 222 GST_BASE_TRANSFORM
 223 GST_IS_BASE_TRANSFORM
 224 GST_TYPE_BASE_TRANSFORM
 225 GST_BASE_TRANSFORM_CLASS
 226 GST_IS_BASE_TRANSFORM_CLASS
 227 GST_BASE_TRANSFORM_GET_CLASS
 228 GST_BASE_TRANSFORM_CAST
 229 <SUBSECTION Private>
 230 GstBaseTransformPrivate
 231 gst_base_transform_get_type
 232 </SECTION>
 233
 234
 235 <SECTION>
 236 <FILE>gstcollectpads</FILE>
 237 <TITLE>GstCollectPads</TITLE>
 238 <INCLUDE>gst/base/gstcollectpads.h</INCLUDE>
 239 GstCollectData
 240 GstCollectPads
 241 GstCollectPadsFunction
 242 gst_collect_pads_new
 243 gst_collect_pads_set_function
 244 gst_collect_pads_add_pad
 245 gst_collect_pads_remove_pad
 246 gst_collect_pads_is_active
 247 gst_collect_pads_collect
 248 gst_collect_pads_collect_range
 249 gst_collect_pads_start
 250 gst_collect_pads_stop
 251 gst_collect_pads_set_flushing
 252 gst_collect_pads_peek
 253 gst_collect_pads_pop
 254 gst_collect_pads_available
 255 gst_collect_pads_read
 256 gst_collect_pads_flush
 257 GST_COLLECT_PADS_PAD_LOCK
 258 GST_COLLECT_PADS_PAD_UNLOCK
 259 GST_COLLECT_PADS_GET_PAD_LOCK
 260 <SUBSECTION Standard>
 261 GstCollectPadsClass
 262 GST_COLLECT_PADS
 263 GST_IS_COLLECT_PADS
 264 GST_TYPE_COLLECT_PADS
 265 GST_COLLECT_PADS_CLASS
 266 GST_IS_COLLECT_PADS_CLASS
 267 GST_COLLECT_PADS_GET_CLASS
 268 <SUBSECTION Private>
 269 gst_collect_pads_get_type
 270 GST_COLLECT_PADS_BROADCAST
 271 GST_COLLECT_PADS_GET_COND
 272 GST_COLLECT_PADS_SIGNAL
 273 GST_COLLECT_PADS_WAIT
 274 </SECTION>
 275
 276
 277 <SECTION>
 278 <FILE>gstpushsrc</FILE>
 279 <TITLE>GstPushSrc</TITLE>
 280 <INCLUDE>gst/base/gstpushsrc.h</INCLUDE>
 281 GstPushSrc
 282 <SUBSECTION Standard>
 283 GstPushSrcClass
 284 GST_PUSH_SRC
 285 GST_IS_PUSH_SRC
 286 GST_TYPE_PUSH_SRC
 287 GST_PUSH_SRC_CLASS
 288 GST_IS_PUSH_SRC_CLASS
 289 GST_PUSH_SRC_GET_CLASS
 290 <SUBSECTION Private>
 291 gst_push_src_get_type
 292 </SECTION>
 293
 294 <SECTION>
 295 <FILE>gsttypefindhelper</FILE>
 296 <TITLE>GstTypeFindHelper</TITLE>
 297 <INCLUDE>gst/base/gsttypefindhelper.h</INCLUDE>
 298 gst_type_find_helper
 299 gst_type_find_helper_for_buffer
 300 GstTypeFindHelperGetRangeFunction
 301 gst_type_find_helper_get_range
 302 <SUBSECTION Private>
 303 </SECTION>
 304
 305 # net
 306
 307 <SECTION>
 308 <FILE>gstnetclientclock</FILE>
 309 <TITLE>GstNetClientClock</TITLE>
 310 <INCLUDE>gst/net/gstnet.h</INCLUDE>
 311 GstNetClientClock
 312 gst_net_client_clock_new
 313 <SUBSECTION Standard>
 314 GstNetClientClockClass
 315 GST_NET_CLIENT_CLOCK
 316 GST_IS_NET_CLIENT_CLOCK
 317 GST_TYPE_NET_CLIENT_CLOCK
 318 GST_NET_CLIENT_CLOCK_CLASS
 319 GST_IS_NET_CLIENT_CLOCK_CLASS
 320 <SUBSECTION Private>
 321 gst_net_client_clock_get_type
 322 </SECTION>
 323
 324
 325 <SECTION>
 326 <FILE>gstnettimepacket</FILE>
 327 <TITLE>GstNetTimePacket</TITLE>
 328 <INCLUDE>gst/net/gstnet.h</INCLUDE>
 329 GstNetTimePacket
 330 GST_NET_TIME_PACKET_SIZE
 331 gst_net_time_packet_new
 332 gst_net_time_packet_receive
 333 gst_net_time_packet_send
 334 gst_net_time_packet_serialize
 335 <SUBSECTION Standard>
 336 <SUBSECTION Private>
 337 </SECTION>
 338
 339
 340 <SECTION>
 341 <FILE>gstnettimeprovider</FILE>
 342 <TITLE>GstNetTimeProvider</TITLE>
 343 <INCLUDE>gst/net/gstnet.h</INCLUDE>
 344 GstNetTimeProvider
 345 gst_net_time_provider_new
 346 <SUBSECTION Standard>
 347 GstNetTimeProviderClass
 348 GST_NET_TIME_PROVIDER
 349 GST_IS_NET_TIME_PROVIDER
 350 GST_TYPE_NET_TIME_PROVIDER
 351 GST_NET_TIME_PROVIDER_CLASS
 352 GST_IS_NET_TIME_PROVIDER_CLASS
 353 <SUBSECTION Private>
 354 gst_net_time_provider_get_type
 355 </SECTION>
 356
 357 <SECTION>
 358 <FILE>gstcheck</FILE>
 359 <TITLE>GstCheck</TITLE>
 360 <INCLUDE>gst/check/gstcheck.h</INCLUDE>
 361 GST_START_TEST
 362 GST_END_TEST
 363
 364 ASSERT_BUFFER_REFCOUNT
 365 ASSERT_CAPS_REFCOUNT
 366 ASSERT_CRITICAL
 367 ASSERT_WARNING
 368 ASSERT_MINI_OBJECT_REFCOUNT
 369 ASSERT_OBJECT_REFCOUNT
 370 ASSERT_OBJECT_REFCOUNT_BETWEEN
 371 ASSERT_SET_STATE
 372
 373 fail_unless_equals_int
 374 fail_unless_equals_string
 375 fail_unless_equals_uint64
 376 fail_unless_message_error
 377
 378 assert_equals_int
 379 assert_equals_string
 380 assert_equals_uint64
 381 assert_message_error
 382
 383 gst_check_init
 384 gst_check_message_error
 385 gst_check_setup_element
 386 gst_check_setup_sink_pad
 387 gst_check_setup_src_pad
 388 gst_check_teardown_element
 389 gst_check_teardown_sink_pad
 390 gst_check_teardown_src_pad
 391 gst_check_run_suite
 392
 393 <SUBSECTION Private>
 394 MAIN_INIT
 395 MAIN_START_THREADS
 396 MAIN_START_THREAD_FUNCTION
 397 MAIN_START_THREAD_FUNCTIONS
 398 MAIN_STOP_THREADS
 399 MAIN_SYNCHRONIZE
 400 THREAD_START
 401 THREAD_STARTED
 402 THREAD_SWITCH
 403 THREAD_SYNCHRONIZE
 404 THREAD_TEST_RUNNING
 405
 406 sync_cond
 407 mutex
 408 GST_CAT_DEFAULT
 409 thread_list
 410 start_cond
 411 GST_CHECK_MAIN
 412
 413 gst_check_chain_func
 414 gst_check_abi_list
 415 </SECTION>
 416
 417 <SECTION>
 418 <FILE>gstcheckbufferstraw</FILE>
 419 <TITLE>GstBufferStraw</TITLE>
 420 <INCLUDE>gst/check/gstbufferstraw.h</INCLUDE>
 421 gst_buffer_straw_start_pipeline
 422 gst_buffer_straw_get_buffer
 423 gst_buffer_straw_stop_pipeline
 424 </SECTION>