gstelement.sgml 10.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
<!-- ##### SECTION Title ##### -->
GstElement

<!-- ##### SECTION Short_Description ##### -->
Base class for all pipeline elements

<!-- ##### SECTION Long_Description ##### -->
<para>
GstElement is the base class needed to construct an element that can be
used in a GST pipeline.  As such, it is not a functional entity, and
cannot do anything when placed in a pipeline.
</para>

<para>
All GstElements have a list containing the #GstPad structure for all their
inputs and outputs.  These can be added with gst_element_add_pad() or
gst_element_add_ghost_pad(), and retrieved by name with
gst_element_get_pad(), or in a list form by gst_element_get_pad_list().
</para>

<para>
gst_element_connect() is a convenience function provided to make it
simpler to connect pads of two elements together.
</para>

<!-- ##### SECTION See_Also ##### -->
<para>
#GstElementFactory
</para>

<!-- ##### ENUM GstElementState ##### -->
<para>
This enum defines the standard states an element may be in.  You will normally
use gst_element_set_state() to change the state of an element.

</para>

@GST_STATE_VOID_PENDING: 
@GST_STATE_NULL: Reset the state of an element.
@GST_STATE_READY: will make the element ready to start processing data. some
elements might have a non trivial way to initialize themselves.
@GST_STATE_PAUSED: means there really is data flowing temporary stops the data flow.
@GST_STATE_PLAYING: means there really is data flowing through the graph.

<!-- ##### ENUM GstElementStateReturn ##### -->
<para>
This enum defines the standard return values that an element
can return after a state change.

</para>

@GST_STATE_FAILURE: the element could not perform the state change
@GST_STATE_SUCCESS: the element successfully changed its state
@GST_STATE_ASYNC: the element will asynchronously change its state as soon as possible

<!-- ##### MACRO GST_NUM_STATES ##### -->
<para>
The maximun number of states.
</para>



<!-- ##### MACRO GST_STATE ##### -->
<para>
This macro returns the current state of the element.
</para>

@obj: Element to return state for.


<!-- ##### MACRO GST_STATE_PENDING ##### -->
<para>
This macro returns the currently pending state of the element.
</para>

@obj: Element to return the pending state for.


<!-- ##### MACRO GST_STATE_TRANSITION ##### -->
<para>
Returns the state transition this object is going through.
</para>

@obj: the Element to return the state transition for


<!-- ##### MACRO GST_STATE_NULL_TO_READY ##### -->
<para>
The Element is going from the NULL state to the READY state.
</para>



<!-- ##### MACRO GST_STATE_READY_TO_PAUSED ##### -->
<para>
The Element is going from the READY state to the PAUSED state.
</para>



<!-- ##### MACRO GST_STATE_PAUSED_TO_READY ##### -->
<para>
The Element is going from the PAUSED state to the READY state.
</para>



<!-- ##### MACRO GST_STATE_PLAYING_TO_PAUSED ##### -->
<para>
The Element is going from the PLAYING state to the PAUSED state.
</para>



<!-- ##### MACRO GST_STATE_PAUSED_TO_PLAYING ##### -->
<para>
The Element is going from the PAUSED state to the PLAYING state.
</para>



<!-- ##### MACRO GST_STATE_READY_TO_NULL ##### -->
<para>
The Element is going from the READY state to the NULL state.
</para>



<!-- ##### ENUM GstElementFlags ##### -->
<para>
This enum defines the standard flags that an element may have.
</para>

@GST_ELEMENT_COMPLEX: 
@GST_ELEMENT_DECOUPLED: 
@GST_ELEMENT_THREAD_SUGGESTED: 
@GST_ELEMENT_NO_SEEK: 
@GST_ELEMENT_INFINITE_LOOP: 
@GST_ELEMENT_SCHEDULER_PRIVATE1: 
@GST_ELEMENT_SCHEDULER_PRIVATE2: 
@GST_ELEMENT_NEW_LOOPFUNC: 
@GST_ELEMENT_EVENT_AWARE: 
@GST_ELEMENT_FLAG_LAST: 

<!-- ##### MACRO GST_ELEMENT_IS_THREAD_SUGGESTED ##### -->
<para>
Queries whether the Element should be placed in a thread.
</para>

@obj: The element to query


<!-- ##### MACRO GST_ELEMENT_IS_DECOUPLED ##### -->
<para>
Queries if the Element is decoupled.
</para>

@obj: The element to query


<!-- ##### MACRO GST_ELEMENT_IS_EOS ##### -->
<para>
Query wether this element is in the End Of Stream state.
</para>

@obj: The element to query


<!-- ##### MACRO GST_ELEMENT_IS_EVENT_AWARE ##### -->
<para>
Query wether this element can handle events.
</para>

@obj: The element to query


<!-- ##### MACRO GST_ELEMENT_PARENT ##### -->
<para>
Get the parent object of this element.
</para>

@obj: The element to query


<!-- ##### MACRO GST_ELEMENT_NAME ##### -->
<para>
Get the name of this element.
</para>

@obj: The element to query


<!-- ##### MACRO GST_ELEMENT_PADS ##### -->
<para>
Get the pads of this elements.
</para>

@obj: The element to query


<!-- ##### MACRO GST_ELEMENT_SCHED ##### -->
<para>
Get the scheduler of this element.
</para>

@obj: The element to query


<!-- ##### MACRO GST_ELEMENT_MANAGER ##### -->
<para>
Get the manager of this element.
</para>

@obj: The element to query


Wim Taymans's avatar
Wim Taymans committed
217 218 219 220 221 222 223 224
<!-- ##### MACRO GST_ELEMENT_CLOCK ##### -->
<para>
Get the clock of this element
</para>

@obj: the Element to query


225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
<!-- ##### STRUCT GstElement ##### -->
<para>

</para>


<!-- ##### USER_FUNCTION GstElementLoopFunction ##### -->
<para>
This function type is used to specify a loop function for the element.  It
is passed the element in question, and is expect to return only in error
circumstances.
</para>

@element: The element in question.


Wim Taymans's avatar
Wim Taymans committed
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
<!-- ##### USER_FUNCTION GstElementGetClockFunction ##### -->
<para>
The function to get the clock from a clock providing element
</para>

@element: The element to get the clock of
@Returns: The clock provided by the element


<!-- ##### USER_FUNCTION GstElementSetClockFunction ##### -->
<para>
The function to set the clock on a clock receiving element.
</para>

@element: The element to set the clock on
@clock: The clock to set on the element


259
<!-- ##### FUNCTION gst_element_class_add_pad_template ##### -->
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
<para>

</para>

@klass: 
@templ: 
<!-- # Unused Parameters # -->
@element: 


<!-- ##### MACRO gst_element_destroy ##### -->
<para>
Destroy the element. This is potentially dangerous, use gst_object_unref
instead.
</para>

@element: the element to destroy


<!-- ##### FUNCTION gst_element_set_loop_function ##### -->
<para>

</para>

@element: 
@loop: 


<!-- ##### FUNCTION gst_element_set_name ##### -->
<para>

</para>

@element: 
@name: 


<!-- ##### FUNCTION gst_element_get_name ##### -->
<para>

</para>

@element: 
@Returns: 


<!-- ##### FUNCTION gst_element_get_sched ##### -->
<para>

</para>

@element: 
@Returns: 


<!-- ##### FUNCTION gst_element_set_sched ##### -->
<para>

</para>

@element: 
@sched: 


<!-- ##### FUNCTION gst_element_set_parent ##### -->
<para>

</para>

@element: 
@parent: 


<!-- ##### FUNCTION gst_element_get_parent ##### -->
<para>

</para>

@element: 
@Returns: 


Wim Taymans's avatar
Wim Taymans committed
342 343 344 345 346 347 348 349 350
<!-- ##### FUNCTION gst_element_get_managing_bin ##### -->
<para>

</para>

@element: 
@Returns: 


351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378
<!-- ##### FUNCTION gst_element_add_pad ##### -->
<para>

</para>

@element: 
@pad: 


<!-- ##### FUNCTION gst_element_remove_pad ##### -->
<para>

</para>

@element: 
@pad: 


<!-- ##### FUNCTION gst_element_get_pad ##### -->
<para>

</para>

@element: 
@name: 
@Returns: GList of pads


379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
<!-- ##### FUNCTION gst_element_get_static_pad ##### -->
<para>

</para>

@element: 
@name: 
@Returns: 


<!-- ##### FUNCTION gst_element_get_request_pad ##### -->
<para>

</para>

@element: 
@name: 
@Returns: 


399 400 401 402 403 404 405 406 407
<!-- ##### FUNCTION gst_element_get_pad_list ##### -->
<para>

</para>

@element: 
@Returns: 


408
<!-- ##### FUNCTION gst_element_get_pad_template_list ##### -->
409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
<para>

</para>

@element: 
@Returns: 


<!-- ##### FUNCTION gst_element_add_ghost_pad ##### -->
<para>

</para>

@element: 
@pad: 
@name: 
Wim Taymans's avatar
Wim Taymans committed
425
@Returns: 
426 427 428 429 430 431 432 433 434 435 436


<!-- ##### FUNCTION gst_element_remove_ghost_pad ##### -->
<para>

</para>

@element: 
@pad: 


437
<!-- ##### FUNCTION gst_element_get_compatible_pad ##### -->
438 439 440 441 442
<para>

</para>

@element: 
443
@pad: 
444 445 446
@Returns: 


Wim Taymans's avatar
Wim Taymans committed
447 448 449 450 451 452 453 454 455 456 457
<!-- ##### FUNCTION gst_element_get_compatible_pad_filtered ##### -->
<para>

</para>

@element: 
@pad: 
@filtercaps: 
@Returns: 


458 459 460 461 462 463 464
<!-- ##### FUNCTION gst_element_connect ##### -->
<para>

</para>

@src: 
@dest: 
465 466 467
@Returns: 
<!-- # Unused Parameters # -->
@srcpadname: 
468
@destpadname: 
469 470 471 472 473 474 475 476 477 478


<!-- ##### FUNCTION gst_element_connect_many ##### -->
<para>

</para>

@element_1: 
@element_2: 
@Varargs: 
479 480 481 482 483 484 485 486 487 488 489 490
@Returns: 


<!-- ##### FUNCTION gst_element_connect_filtered ##### -->
<para>

</para>

@src: 
@dest: 
@filtercaps: 
@Returns: 
491 492 493
<!-- # Unused Parameters # -->
@srcpadname: 
@destpadname: 
494 495


496
<!-- ##### FUNCTION gst_element_connect_pads ##### -->
Wim Taymans's avatar
Wim Taymans committed
497 498 499 500 501
<para>

</para>

@src: 
502
@srcpadname: 
Wim Taymans's avatar
Wim Taymans committed
503
@dest: 
504
@destpadname: 
Wim Taymans's avatar
Wim Taymans committed
505 506 507
@Returns: 


508
<!-- ##### FUNCTION gst_element_connect_pads_filtered ##### -->
Wim Taymans's avatar
Wim Taymans committed
509 510 511 512 513
<para>

</para>

@src: 
514
@srcpadname: 
Wim Taymans's avatar
Wim Taymans committed
515
@dest: 
516
@destpadname: 
Wim Taymans's avatar
Wim Taymans committed
517 518 519 520
@filtercaps: 
@Returns: 


521
<!-- ##### FUNCTION gst_element_disconnect ##### -->
Wim Taymans's avatar
Wim Taymans committed
522 523 524 525
<para>

</para>

526 527 528 529 530
@src: 
@dest: 
<!-- # Unused Parameters # -->
@srcpadname: 
@destpadname: 
Wim Taymans's avatar
Wim Taymans committed
531 532


533
<!-- ##### FUNCTION gst_element_disconnect_many ##### -->
534 535 536 537
<para>

</para>

538 539 540
@element_1: 
@element_2: 
@Varargs: 
541 542


543
<!-- ##### FUNCTION gst_element_disconnect_pads ##### -->
Wim Taymans's avatar
Wim Taymans committed
544 545 546 547 548
<para>

</para>

@src: 
549
@srcpadname: 
Wim Taymans's avatar
Wim Taymans committed
550
@dest: 
551
@destpadname: 
Wim Taymans's avatar
Wim Taymans committed
552 553


554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
<!-- ##### FUNCTION gst_element_set_state ##### -->
<para>

</para>

@element: 
@state: 
@Returns: 


<!-- ##### FUNCTION gst_element_get_state ##### -->
<para>

</para>

@element: 
@Returns: 
<!-- # Unused Parameters # -->
@elem: 


<!-- ##### FUNCTION gst_element_wait_state_change ##### -->
<para>

</para>

@element: 


<!-- ##### FUNCTION gst_element_statename ##### -->
<para>

</para>

@state: 
@Returns: 


Wim Taymans's avatar
Wim Taymans committed
592
<!-- ##### FUNCTION gst_element_error ##### -->
593 594 595 596 597
<para>

</para>

@element: 
Wim Taymans's avatar
Wim Taymans committed
598
@error: 
599 600 601
@Varargs: 


Wim Taymans's avatar
Wim Taymans committed
602
<!-- ##### FUNCTION gst_element_get_factory ##### -->
603 604 605 606 607
<para>

</para>

@element: 
Wim Taymans's avatar
Wim Taymans committed
608
@Returns: 
609 610


Wim Taymans's avatar
Wim Taymans committed
611
<!-- ##### FUNCTION gst_element_set_eos ##### -->
612 613 614 615 616 617 618
<para>

</para>

@element: 


Wim Taymans's avatar
Wim Taymans committed
619
<!-- ##### FUNCTION gst_element_interrupt ##### -->
620 621 622 623 624
<para>

</para>

@element: 
Wim Taymans's avatar
Wim Taymans committed
625
@Returns: 
626 627


Wim Taymans's avatar
Wim Taymans committed
628
<!-- ##### FUNCTION gst_element_yield ##### -->
629 630 631 632
<para>

</para>

Wim Taymans's avatar
Wim Taymans committed
633
@element: 
634 635


Wim Taymans's avatar
Wim Taymans committed
636
<!-- ##### FUNCTION gst_element_clock_wait ##### -->
637 638 639 640 641
<para>

</para>

@element: 
Wim Taymans's avatar
Wim Taymans committed
642 643 644
@clock: 
@time: 
@Returns: 
645 646


Wim Taymans's avatar
Wim Taymans committed
647
<!-- ##### FUNCTION gst_element_get_clock ##### -->
648 649 650 651 652 653 654 655
<para>

</para>

@element: 
@Returns: 


Wim Taymans's avatar
Wim Taymans committed
656
<!-- ##### FUNCTION gst_element_set_clock ##### -->
657 658 659 660 661
<para>

</para>

@element: 
Wim Taymans's avatar
Wim Taymans committed
662
@clock: 
663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679


<!-- ##### SIGNAL GstElement::eos ##### -->
<para>

</para>

@gstelement: the object which received the signal.

<!-- ##### SIGNAL GstElement::error ##### -->
<para>
Is trigered whenever an error occured

</para>

@gstelement: the object which received the signal.
@arg1: the error message
Wim Taymans's avatar
Wim Taymans committed
680
@arg2: 
681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706

<!-- ##### SIGNAL GstElement::new-pad ##### -->
<para>
Is trigered whenever a new pad is added to an element
</para>

@gstelement: the object which received the signal.
@arg1: the new pad that was added

<!-- ##### SIGNAL GstElement::pad-removed ##### -->
<para>

</para>

@gstelement: the object which received the signal.
@arg1: The pad that was removed.

<!-- ##### SIGNAL GstElement::state-change ##### -->
<para>
Is trigered whenever the state of an element changes
</para>

@gstelement: the object which received the signal.
@arg1: the new state of the object
@arg2: