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 gst_controller_init
  63 gst_controller_new
  64 gst_controller_new_list
  65 gst_controller_new_valist
  66 gst_controller_remove_properties
  67 gst_controller_remove_properties_list
  68 gst_controller_remove_properties_valist
  69 gst_controller_set_disabled
  70 gst_controller_set_property_disabled
  71 gst_controller_suggest_next_sync
  72 gst_controller_sync_values
  73 gst_controller_get_control_source
  74 gst_controller_set_control_source
  75 gst_controller_get
  76 gst_controller_get_value_arrays
  77 gst_controller_get_value_array
  78 gst_controller_set
  79 gst_controller_set_from_list
  80 gst_controller_unset
  81 gst_controller_unset_all
  82 gst_controller_get_all
  83 gst_controller_set_interpolation_mode
  84 <SUBSECTION Standard>
  85 GstControllerClass
  86 GstControllerPrivate
  87 GST_CONTROLLER
  88 GST_IS_CONTROLLER
  89 GST_CONTROLLER_CLASS
  90 GST_IS_CONTROLLER_CLASS
  91 GST_CONTROLLER_GET_CLASS
  92 GST_TYPE_CONTROLLER
  93 <SUBSECTION Private>
  94 gst_controller_get_type
  95 </SECTION>
  96
  97 <SECTION>
  98 <FILE>gstcontrolsource</FILE>
  99 <TITLE>GstControlSource</TITLE>
 100 <INCLUDE>libs/controller/gstcontrolsource.h</INCLUDE>
 101 GstControlSource
 102 GstControlSourceClass
 103 GstControlSourceBind
 104 GstControlSourceGetValue
 105 GstControlSourceGetValueArray
 106 GstTimedValue
 107 GstValueArray
 108 gst_control_source_bind
 109 gst_control_source_get_value
 110 gst_control_source_get_value_array
 111 <SUBSECTION Standard>
 112 GST_CONTROL_SOURCE
 113 GST_IS_CONTROL_SOURCE
 114 GST_CONTROL_SOURCE_CLASS
 115 GST_IS_CONTROL_SOURCE_CLASS
 116 GST_CONTROL_SOURCE_GET_CLASS
 117 GST_TYPE_CONTROL_SOURCE
 118 <SUBSECTION Private>
 119 gst_control_source_get_type
 120 </SECTION>
 121
 122 <SECTION>
 123 <FILE>gstinterpolationcontrolsource</FILE>
 124 <TITLE>GstInterpolationControlSource</TITLE>
 125 <INCLUDE>libs/controller/gstinterpolationcontrolsource.h</INCLUDE>
 126 GstInterpolationControlSource
 127 GstInterpolateMode
 128 gst_interpolation_control_source_new
 129 gst_interpolation_control_source_set
 130 gst_interpolation_control_source_set_from_list
 131 gst_interpolation_control_source_set_interpolation_mode
 132 gst_interpolation_control_source_get_all
 133 gst_interpolation_control_source_unset
 134 gst_interpolation_control_source_unset_all
 135 gst_interpolation_control_source_get_count
 136 <SUBSECTION Standard>
 137 GstInterpolationControlSourceClass
 138 GstInterpolationControlSourcePrivate
 139 GST_INTERPOLATION_CONTROL_SOURCE
 140 GST_IS_INTERPOLATION_CONTROL_SOURCE
 141 GST_INTERPOLATION_CONTROL_SOURCE_CLASS
 142 GST_IS_INTERPOLATION_CONTROL_SOURCE_CLASS
 143 GST_INTERPOLATION_CONTROL_SOURCE_GET_CLASS
 144 GST_TYPE_INTERPOLATION_CONTROL_SOURCE
 145 <SUBSECTION Private>
 146 gst_interpolation_control_source_get_type
 147 </SECTION>
 148
 149 <SECTION>
 150 <FILE>gstlfocontrolsource</FILE>
 151 <TITLE>GstLFOControlSource</TITLE>
 152 <INCLUDE>libs/controller/gstlfocontrolsource.h</INCLUDE>
 153 GstLFOControlSource
 154 GstLFOWaveform
 155 gst_lfo_control_source_new
 156 <SUBSECTION Standard>
 157 GstLFOControlSourceClass
 158 GstLFOControlSourcePrivate
 159 GST_IS_LFO_CONTROL_SOURCE
 160 GST_IS_LFO_CONTROL_SOURCE_CLASS
 161 GST_LFO_CONTROL_SOURCE
 162 GST_LFO_CONTROL_SOURCE_CLASS
 163 GST_LFO_CONTROL_SOURCE_GET_CLASS
 164 GST_TYPE_LFO_CONTROL_SOURCE
 165 GST_TYPE_LFO_WAVEFORM
 166 <SUBSECTION Private>
 167 gst_lfo_control_source_get_type
 168 gst_lfo_waveform_get_type
 169 </SECTION>
 170
 171 <SECTION>
 172 <FILE>gstcontrollergobject</FILE>
 173 <TITLE>GstControllerGObject</TITLE>
 174 <INCLUDE>libs/controller/gstcontroller.h</INCLUDE>
 175 gst_object_control_properties
 176 gst_object_uncontrol_properties
 177 gst_object_get_controller
 178 gst_object_set_controller
 179 gst_object_suggest_next_sync
 180 gst_object_sync_values
 181 gst_object_get_control_source
 182 gst_object_set_control_source
 183 gst_object_get_value_arrays
 184 gst_object_get_value_array
 185 gst_object_get_control_rate
 186 gst_object_set_control_rate
 187 <SUBSECTION Standard>
 188 <SUBSECTION Private>
 189 </SECTION>
 190
 191 # base classes
 192
 193 <SECTION>
 194 <FILE>gstadapter</FILE>
 195 <TITLE>GstAdapter</TITLE>
 196 <INCLUDE>gst/base/gstadapter.h</INCLUDE>
 197 GstAdapter
 198 gst_adapter_new
 199 gst_adapter_clear
 200 gst_adapter_push
 201 gst_adapter_peek
 202 gst_adapter_copy
 203 gst_adapter_flush
 204 gst_adapter_available
 205 gst_adapter_available_fast
 206 gst_adapter_take
 207 gst_adapter_take_buffer
 208 <SUBSECTION Standard>
 209 GstAdapterClass
 210 GST_ADAPTER
 211 GST_IS_ADAPTER
 212 GST_TYPE_ADAPTER
 213 GST_ADAPTER_CLASS
 214 GST_IS_ADAPTER_CLASS
 215 GST_ADAPTER_GET_CLASS
 216 <SUBSECTION Private>
 217 gst_adapter_get_type
 218 </SECTION>
 219
 220
 221 <SECTION>
 222 <FILE>gstbasesrc</FILE>
 223 <TITLE>GstBaseSrc</TITLE>
 224 <INCLUDE>gst/base/gstbasesrc.h</INCLUDE>
 225 GstBaseSrc
 226 GstBaseSrcClass
 227 GstBaseSrcFlags
 228
 229 gst_base_src_wait_playing
 230 gst_base_src_is_live
 231 gst_base_src_set_live
 232 gst_base_src_set_format
 233 gst_base_src_query_latency
 234 gst_base_src_get_do_timestamp
 235 gst_base_src_set_do_timestamp
 236
 237 GST_BASE_SRC_PAD
 238 <SUBSECTION Standard>
 239 GstBaseSrcPrivate
 240 GST_BASE_SRC
 241 GST_BASE_SRC_CAST
 242 GST_IS_BASE_SRC
 243 GST_TYPE_BASE_SRC
 244 GST_BASE_SRC_CLASS
 245 GST_IS_BASE_SRC_CLASS
 246 GST_BASE_SRC_GET_CLASS
 247 <SUBSECTION Private>
 248 gst_base_src_get_type
 249 </SECTION>
 250
 251 <SECTION>
 252 <FILE>gstbasesink</FILE>
 253 <TITLE>GstBaseSink</TITLE>
 254 <INCLUDE>gst/base/gstbasesink.h</INCLUDE>
 255 GstBaseSink
 256 GstBaseSinkClass
 257
 258 gst_base_sink_query_latency
 259 gst_base_sink_get_latency
 260 gst_base_sink_wait_preroll
 261 gst_base_sink_wait_clock
 262 gst_base_sink_wait_eos
 263 gst_base_sink_set_sync
 264 gst_base_sink_get_sync
 265 gst_base_sink_set_max_lateness
 266 gst_base_sink_get_max_lateness
 267 gst_base_sink_set_qos_enabled
 268 gst_base_sink_is_qos_enabled
 269 gst_base_sink_set_async_enabled
 270 gst_base_sink_is_async_enabled
 271 gst_base_sink_set_ts_offset
 272 gst_base_sink_get_ts_offset
 273 gst_base_sink_set_render_delay
 274 gst_base_sink_get_render_delay
 275 gst_base_sink_get_last_buffer
 276
 277 GST_BASE_SINK_PAD
 278
 279 <SUBSECTION Standard>
 280 GST_BASE_SINK
 281 GST_BASE_SINK_CAST
 282 GST_IS_BASE_SINK
 283 GST_TYPE_BASE_SINK
 284 GST_BASE_SINK_CLASS
 285 GST_IS_BASE_SINK_CLASS
 286 GST_BASE_SINK_GET_CLASS
 287 <SUBSECTION Private>
 288 GstBaseSinkPrivate
 289 gst_base_sink_get_type
 290 </SECTION>
 291
 292
 293 <SECTION>
 294 <FILE>gstbasetransform</FILE>
 295 <TITLE>GstBaseTransform</TITLE>
 296 <INCLUDE>gst/base/gstbasetransform.h</INCLUDE>
 297 GstBaseTransform
 298 GstBaseTransformClass
 299
 300 gst_base_transform_is_passthrough
 301 gst_base_transform_set_passthrough
 302 gst_base_transform_is_in_place
 303 gst_base_transform_set_in_place
 304 gst_base_transform_is_qos_enabled
 305 gst_base_transform_set_qos_enabled
 306 gst_base_transform_update_qos
 307 gst_base_transform_set_gap_aware
 308 gst_base_transform_suggest
 309
 310 GST_BASE_TRANSFORM_SINK_NAME
 311 GST_BASE_TRANSFORM_SRC_NAME
 312 GST_BASE_TRANSFORM_SINK_PAD
 313 GST_BASE_TRANSFORM_SRC_PAD
 314
 315 GST_BASE_TRANSFORM_FLOW_DROPPED
 316
 317 GST_BASE_TRANSFORM_LOCK
 318 GST_BASE_TRANSFORM_UNLOCK
 319
 320 <SUBSECTION Standard>
 321 GST_BASE_TRANSFORM
 322 GST_IS_BASE_TRANSFORM
 323 GST_TYPE_BASE_TRANSFORM
 324 GST_BASE_TRANSFORM_CLASS
 325 GST_IS_BASE_TRANSFORM_CLASS
 326 GST_BASE_TRANSFORM_GET_CLASS
 327 GST_BASE_TRANSFORM_CAST
 328 <SUBSECTION Private>
 329 GstBaseTransformPrivate
 330 gst_base_transform_get_type
 331 </SECTION>
 332
 333
 334 <SECTION>
 335 <FILE>gstcollectpads</FILE>
 336 <TITLE>GstCollectPads</TITLE>
 337 <INCLUDE>gst/base/gstcollectpads.h</INCLUDE>
 338 GstCollectData
 339 GstCollectPads
 340 GstCollectPadsFunction
 341 GstCollectDataDestroyNotify
 342 gst_collect_pads_new
 343 gst_collect_pads_set_function
 344 gst_collect_pads_add_pad
 345 gst_collect_pads_add_pad_full
 346 gst_collect_pads_remove_pad
 347 gst_collect_pads_is_active
 348 gst_collect_pads_collect
 349 gst_collect_pads_collect_range
 350 gst_collect_pads_start
 351 gst_collect_pads_stop
 352 gst_collect_pads_set_flushing
 353 gst_collect_pads_peek
 354 gst_collect_pads_pop
 355 gst_collect_pads_available
 356 gst_collect_pads_read
 357 gst_collect_pads_read_buffer
 358 gst_collect_pads_take_buffer
 359 gst_collect_pads_flush
 360 <SUBSECTION Standard>
 361 GstCollectPadsClass
 362 GST_COLLECT_PADS
 363 GST_IS_COLLECT_PADS
 364 GST_TYPE_COLLECT_PADS
 365 GST_COLLECT_PADS_CLASS
 366 GST_IS_COLLECT_PADS_CLASS
 367 GST_COLLECT_PADS_GET_CLASS
 368 <SUBSECTION Private>
 369 gst_collect_pads_get_type
 370 GST_COLLECT_PADS_GET_PAD_LOCK
 371 GST_COLLECT_PADS_PAD_LOCK
 372 GST_COLLECT_PADS_PAD_UNLOCK
 373 GST_COLLECT_PADS_BROADCAST
 374 GST_COLLECT_PADS_GET_COND
 375 GST_COLLECT_PADS_SIGNAL
 376 GST_COLLECT_PADS_WAIT
 377 </SECTION>
 378
 379
 380 <SECTION>
 381 <FILE>gstpushsrc</FILE>
 382 <TITLE>GstPushSrc</TITLE>
 383 <INCLUDE>gst/base/gstpushsrc.h</INCLUDE>
 384 GstPushSrc
 385 <SUBSECTION Standard>
 386 GstPushSrcClass
 387 GST_PUSH_SRC
 388 GST_IS_PUSH_SRC
 389 GST_TYPE_PUSH_SRC
 390 GST_PUSH_SRC_CLASS
 391 GST_IS_PUSH_SRC_CLASS
 392 GST_PUSH_SRC_GET_CLASS
 393 <SUBSECTION Private>
 394 gst_push_src_get_type
 395 </SECTION>
 396
 397 <SECTION>
 398 <FILE>gsttypefindhelper</FILE>
 399 <TITLE>GstTypeFindHelper</TITLE>
 400 <INCLUDE>gst/base/gsttypefindhelper.h</INCLUDE>
 401 gst_type_find_helper
 402 gst_type_find_helper_for_buffer
 403 GstTypeFindHelperGetRangeFunction
 404 gst_type_find_helper_get_range
 405 <SUBSECTION Private>
 406 </SECTION>
 407
 408 <SECTION>
 409 <FILE>gstdataqueue</FILE>
 410 <TITLE>GstDataQueue</TITLE>
 411 <INCLUDE>gst/base/gstdataqueue.h</INCLUDE>
 412 GstDataQueue
 413 GstDataQueueSize
 414 GstDataQueueCheckFullFunction
 415 GstDataQueueItem
 416 gst_data_queue_new
 417 gst_data_queue_push
 418 gst_data_queue_pop
 419 gst_data_queue_flush
 420 gst_data_queue_set_flushing
 421 gst_data_queue_drop_head
 422 gst_data_queue_is_full
 423 gst_data_queue_is_empty
 424 gst_data_queue_get_level
 425 gst_data_queue_limits_changed
 426 <SUBSECTION Standard>
 427 GstDataQueueClass
 428 GST_DATA_QUEUE
 429 GST_IS_DATA_QUEUE
 430 GST_TYPE_DATA_QUEUE
 431 GST_DATA_QUEUE_CLASS
 432 GST_IS_DATA_QUEUE_CLASS
 433 <SUBSECTION Private>
 434 gst_data_queue_get_type
 435 </SECTION>
 436
 437 # net
 438
 439 <SECTION>
 440 <FILE>gstnetclientclock</FILE>
 441 <TITLE>GstNetClientClock</TITLE>
 442 <INCLUDE>gst/net/gstnet.h</INCLUDE>
 443 GstNetClientClock
 444 gst_net_client_clock_new
 445 <SUBSECTION Standard>
 446 GstNetClientClockClass
 447 GstNetClientClockPrivate
 448 GST_NET_CLIENT_CLOCK
 449 GST_IS_NET_CLIENT_CLOCK
 450 GST_TYPE_NET_CLIENT_CLOCK
 451 GST_NET_CLIENT_CLOCK_CLASS
 452 GST_IS_NET_CLIENT_CLOCK_CLASS
 453 <SUBSECTION Private>
 454 gst_net_client_clock_get_type
 455 </SECTION>
 456
 457
 458 <SECTION>
 459 <FILE>gstnettimepacket</FILE>
 460 <TITLE>GstNetTimePacket</TITLE>
 461 <INCLUDE>gst/net/gstnet.h</INCLUDE>
 462 GstNetTimePacket
 463 GST_NET_TIME_PACKET_SIZE
 464 gst_net_time_packet_new
 465 gst_net_time_packet_receive
 466 gst_net_time_packet_send
 467 gst_net_time_packet_serialize
 468 <SUBSECTION Standard>
 469 <SUBSECTION Private>
 470 socklen_t
 471 </SECTION>
 472
 473
 474 <SECTION>
 475 <FILE>gstnettimeprovider</FILE>
 476 <TITLE>GstNetTimeProvider</TITLE>
 477 <INCLUDE>gst/net/gstnet.h</INCLUDE>
 478 GstNetTimeProvider
 479 gst_net_time_provider_new
 480 <SUBSECTION Standard>
 481 GstNetTimeProviderClass
 482 GstNetTimeProviderPrivate
 483 GST_NET_TIME_PROVIDER
 484 GST_IS_NET_TIME_PROVIDER
 485 GST_TYPE_NET_TIME_PROVIDER
 486 GST_NET_TIME_PROVIDER_CLASS
 487 GST_IS_NET_TIME_PROVIDER_CLASS
 488 <SUBSECTION Private>
 489 gst_net_time_provider_get_type
 490 </SECTION>
 491
 492 <SECTION>
 493 <FILE>gstcheck</FILE>
 494 <TITLE>GstCheck</TITLE>
 495 <INCLUDE>gst/check/gstcheck.h</INCLUDE>
 496 GST_START_TEST
 497 GST_END_TEST
 498
 499 ASSERT_BUFFER_REFCOUNT
 500 ASSERT_CAPS_REFCOUNT
 501 ASSERT_CRITICAL
 502 ASSERT_WARNING
 503 ASSERT_MINI_OBJECT_REFCOUNT
 504 ASSERT_OBJECT_REFCOUNT
 505 ASSERT_OBJECT_REFCOUNT_BETWEEN
 506 ASSERT_SET_STATE
 507
 508 fail_unless_equals_int
 509 fail_unless_equals_float
 510 fail_unless_equals_string
 511 fail_unless_equals_uint64
 512 fail_unless_message_error
 513
 514 assert_equals_int
 515 assert_equals_float
 516 assert_equals_string
 517 assert_equals_uint64
 518 assert_message_error
 519
 520 gst_check_init
 521 gst_check_message_error
 522 gst_check_setup_element
 523 gst_check_setup_sink_pad
 524 gst_check_setup_src_pad
 525 gst_check_setup_sink_pad_by_name
 526 gst_check_setup_src_pad_by_name
 527 gst_check_teardown_pad_by_name
 528 gst_check_teardown_element
 529 gst_check_teardown_sink_pad
 530 gst_check_teardown_src_pad
 531 gst_check_drop_buffers
 532 gst_check_caps_equal
 533 gst_check_element_push_buffer_list
 534 gst_check_element_push_buffer
 535 gst_check_run_suite
 536
 537 <SUBSECTION Private>
 538 MAIN_INIT
 539 MAIN_START_THREADS
 540 MAIN_START_THREAD_FUNCTION
 541 MAIN_START_THREAD_FUNCTIONS
 542 MAIN_STOP_THREADS
 543 MAIN_SYNCHRONIZE
 544 THREAD_START
 545 THREAD_STARTED
 546 THREAD_SWITCH
 547 THREAD_SYNCHRONIZE
 548 THREAD_TEST_RUNNING
 549
 550 sync_cond
 551 mutex
 552 GST_CAT_DEFAULT
 553 thread_list
 554 start_cond
 555 GST_CHECK_MAIN
 556
 557 gst_check_chain_func
 558 gst_check_abi_list
 559
 560 buffers
 561 check_cond
 562 check_mutex
 563 </SECTION>
 564
 565 <SECTION>
 566 <FILE>gstcheckbufferstraw</FILE>
 567 <TITLE>GstBufferStraw</TITLE>
 568 <INCLUDE>gst/check/gstbufferstraw.h</INCLUDE>
 569 gst_buffer_straw_start_pipeline
 570 gst_buffer_straw_get_buffer
 571 gst_buffer_straw_stop_pipeline
 572 </SECTION>