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