docs/gst/tmpl/gstelement.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GstElement
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Abstract base class for all pipeline elements
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 GstElement is the base class needed to construct an element that can be
  10 used in a GStreamer pipeline.  As such, it is not a functional entity, and
  11 cannot do anything when placed in a pipeline.
  12 </para>
  13
  14 <para>
  15 The name of a GstElement can be get with gst_element_get_name() and set with
  16 gst_element_set_name().  For speed, GST_ELEMENT_NAME() can be used in the
  17 core.
  18 Do not use this in plug-ins or applications in order to retain ABI
  19 compatibility.
  20 </para>
  21
  22 <para>
  23 All elements have pads (of the type #GstPad).  These pads link to pads on
  24 other elements.  Buffers flow between these linked pads.
  25 A GstElement has a GList of #GstPad structures for all their input (or sink)
  26 and output (or source) pads.
  27 Core and plug-in writers can add and remove pads with gst_element_add_pad()
  28 and gst_element_remove_pad().
  29 Application writers can manipulate ghost pads (copies of real pads inside a bin)
  30 with gst_element_add_ghost_pad() and gst_element_remove_ghost_pad().
  31 A pad of an element can be retrieved by name with gst_element_get_pad().
  32 A GList of all pads can be retrieved with gst_element_get_pad_list().
  33 </para>
  34
  35 <para>
  36 Elements can be linked through their pads.
  37 If the link is straightforward, use the gst_element_link()
  38 convenience function to link two elements, or gst_element_link_many()
  39 for more elements in a row.
  40 Use gst_element_link_filtered() to link two elements constrained by
  41 a specified set of #GstCaps.
  42 For finer control, use gst_element_link_pads() and
  43 gst_element_link_pads_filtered() to specify the pads to link on
  44 each element by name.
  45 </para>
  46
  47 <para>
  48 Each element has a state (see #GstElementState).  You can get and set the state
  49 of an element with gst_element_get_state() and gst_element_set_state().
  50 You can wait for an element to change it's state with gst_element_wait_state_change().
  51 To get a string representation of a #GstElementState, use
  52 gst_element_state_get_name().
  53 </para>
  54
  55 <para>
  56 You can get and set a #GstClock on an element using gst_element_get_clock()
  57 and gst_element_set_clock().  You can wait for the clock to reach a given
  58 #GstClockTime using gst_element_clock_wait().
  59 </para>
  60
  61 <!-- ##### SECTION See_Also ##### -->
  62 <para>
  63 #GstElementFactory, #GstPad
  64 </para>
  65
  66 <!-- basic object functions -->
  67
  68 <!-- ##### STRUCT GstElementDetails ##### -->
  69 <para>
  70 This struct is used to define public information about the element.  It
  71 describes the element, mostly for the benefit of editors.
  72 </para>
  73
  74 @longname:
  75 @klass:
  76 @description:
  77 @author:
  78 @_gst_reserved:
  79
  80 <!-- ##### MACRO GST_ELEMENT_DETAILS ##### -->
  81 <para>
  82
  83 </para>
  84
  85 @longname:
  86 @klass:
  87 @description:
  88 @author:
  89
  90
  91 <!-- ##### MACRO GST_IS_ELEMENT_DETAILS ##### -->
  92 <para>
  93
  94 </para>
  95
  96 @details:
  97
  98
  99 <!-- ##### MACRO GST_NUM_STATES ##### -->
 100 <para>
 101 The maximun number of states.
 102 </para>
 103
 104
 105
 106 <!-- ##### MACRO GST_STATE ##### -->
 107 <para>
 108 This macro returns the current state of the element.
 109 </para>
 110
 111 @obj: Element to return state for.
 112
 113
 114 <!-- ##### MACRO GST_STATE_PENDING ##### -->
 115 <para>
 116 This macro returns the currently pending state of the element.
 117 </para>
 118
 119 @obj: Element to return the pending state for.
 120
 121
 122 <!-- ##### MACRO GST_STATE_TRANSITION ##### -->
 123 <para>
 124 Returns the state transition this object is going through.
 125 </para>
 126
 127 @obj: the Element to return the state transition for
 128
 129
 130 <!-- ##### MACRO GST_STATE_NULL_TO_READY ##### -->
 131 <para>
 132 The Element is going from the NULL state to the READY state.
 133 </para>
 134
 135
 136
 137 <!-- ##### MACRO GST_STATE_READY_TO_PAUSED ##### -->
 138 <para>
 139 The Element is going from the READY state to the PAUSED state.
 140 </para>
 141
 142
 143
 144 <!-- ##### MACRO GST_STATE_PAUSED_TO_PLAYING ##### -->
 145 <para>
 146 The Element is going from the PAUSED state to the PLAYING state.
 147 </para>
 148
 149
 150
 151 <!-- ##### MACRO GST_STATE_PLAYING_TO_PAUSED ##### -->
 152 <para>
 153 The Element is going from the PLAYING state to the PAUSED state.
 154 </para>
 155
 156
 157
 158 <!-- ##### MACRO GST_STATE_PAUSED_TO_READY ##### -->
 159 <para>
 160 The Element is going from the PAUSED state to the READY state.
 161 </para>
 162
 163
 164
 165 <!-- ##### MACRO GST_STATE_READY_TO_NULL ##### -->
 166 <para>
 167 The Element is going from the READY state to the NULL state.
 168 </para>
 169
 170
 171
 172 <!-- ##### MACRO GST_ELEMENT_CLASS ##### -->
 173 <para>
 174
 175 </para>
 176
 177 @klass:
 178
 179
 180 <!-- ##### MACRO GST_ELEMENT_QUERY_TYPE_FUNCTION ##### -->
 181 <para>
 182 Helper macro to create query type functions
 183 </para>
 184
 185 @functionname: The function name
 186 @...: list of query types.
 187
 188
 189 <!-- ##### MACRO GST_ELEMENT_FORMATS_FUNCTION ##### -->
 190 <para>
 191 Halper macro to create element format functions
 192 </para>
 193
 194 @functionname: The function name
 195 @...: formats
 196
 197
 198 <!-- ##### MACRO GST_ELEMENT_EVENT_MASK_FUNCTION ##### -->
 199 <para>
 200 A helper macro to create a mask function
 201 </para>
 202
 203 @functionname: the name of the mask function
 204 @...: Masks
 205
 206
 207 <!-- ##### ENUM GstElementFlags ##### -->
 208 <para>
 209 This enum defines the standard flags that an element may have.
 210 </para>
 211
 212 @GST_ELEMENT_COMPLEX:
 213 @GST_ELEMENT_DECOUPLED:
 214 @GST_ELEMENT_THREAD_SUGGESTED:
 215 @GST_ELEMENT_INFINITE_LOOP:
 216 @GST_ELEMENT_NEW_LOOPFUNC:
 217 @GST_ELEMENT_EVENT_AWARE:
 218 @GST_ELEMENT_USE_THREADSAFE_PROPERTIES:
 219 @GST_ELEMENT_SCHEDULER_PRIVATE1:
 220 @GST_ELEMENT_SCHEDULER_PRIVATE2:
 221 @GST_ELEMENT_LOCKED_STATE:
 222 @GST_ELEMENT_IN_ERROR:
 223 @GST_ELEMENT_FLAG_LAST:
 224
 225 <!-- ##### MACRO GST_ELEMENT_IS_THREAD_SUGGESTED ##### -->
 226 <para>
 227 Queries whether the Element should be placed in a thread.
 228 </para>
 229
 230 @obj: a #GstElement to query
 231
 232
 233 <!-- ##### MACRO GST_ELEMENT_IS_EVENT_AWARE ##### -->
 234 <para>
 235 Query wether this element can handle events.
 236 </para>
 237
 238 @obj: a #GstElement to query
 239
 240
 241 <!-- ##### MACRO GST_ELEMENT_IS_DECOUPLED ##### -->
 242 <para>
 243 Queries if the Element is decoupled.
 244 </para>
 245
 246 @obj: a #GstElement to query
 247
 248
 249 <!-- ##### MACRO GST_ELEMENT_NAME ##### -->
 250 <para>
 251 Gets the name of this element.  Used in the core.  Not ABI-compatible.
 252 </para>
 253
 254 @obj: A #GstElement to query
 255
 256
 257 <!-- ##### MACRO GST_ELEMENT_PARENT ##### -->
 258 <para>
 259 Get the parent object of this element.
 260 </para>
 261
 262 @obj: a #GstElement to query
 263
 264
 265 <!-- ##### MACRO GST_ELEMENT_MANAGER ##### -->
 266 <para>
 267 Get the manager of this element.
 268 </para>
 269
 270 @obj: a #GstElement to query
 271
 272
 273 <!-- ##### MACRO GST_ELEMENT_SCHED ##### -->
 274 <para>
 275 Get the scheduler of this element.
 276 </para>
 277
 278 @obj: a #GstElement to query
 279
 280
 281 <!-- ##### MACRO GST_ELEMENT_CLOCK ##### -->
 282 <para>
 283 Get the clock of this element
 284 </para>
 285
 286 @obj: a #GstElement to query
 287
 288
 289 <!-- ##### MACRO GST_ELEMENT_PADS ##### -->
 290 <para>
 291 Get the pads of this elements.
 292 </para>
 293
 294 @obj: a #GstElement to query
 295
 296
 297 <!-- ##### MACRO GST_ELEMENT_ERROR ##### -->
 298 <para>
 299
 300 </para>
 301
 302 @el:
 303 @domain:
 304 @code:
 305 @message:
 306 @debug:
 307
 308
 309 <!-- ##### USER_FUNCTION GstElementLoopFunction ##### -->
 310 <para>
 311 This function type is used to specify a loop function for the element.  It
 312 is passed the element in question, and is expect to return only in error
 313 circumstances.
 314 </para>
 315
 316 @element: The element in question.
 317
 318
 319 <!-- ##### USER_FUNCTION GstElementPreRunFunction ##### -->
 320 <para>
 321 The signature of the function to execute after this element
 322 is scheduled.
 323 </para>
 324
 325 @element: The element
 326
 327
 328 <!-- ##### USER_FUNCTION GstElementPostRunFunction ##### -->
 329 <para>
 330 The signature of the function to execute before this element
 331 is scheduled.
 332 </para>
 333
 334 @element: The element
 335
 336
 337 <!-- ##### FUNCTION gst_element_class_add_pad_template ##### -->
 338 <para>
 339
 340 </para>
 341
 342 @klass:
 343 @templ:
 344
 345
 346 <!-- ##### FUNCTION gst_element_class_install_std_props ##### -->
 347 <para>
 348
 349 </para>
 350
 351 @klass:
 352 @first_name:
 353 @Varargs:
 354
 355
 356 <!-- ##### FUNCTION gst_element_class_set_details ##### -->
 357 <para>
 358
 359 </para>
 360
 361 @klass:
 362 @details:
 363
 364
 365 <!-- ##### MACRO gst_element_default_deep_notify ##### -->
 366 <para>
 367 The default deep notify handler that prints out the property change
 368 notifications to stdout.
 369 </para>
 370
 371
 372
 373 <!-- ##### FUNCTION gst_element_default_error ##### -->
 374 <para>
 375
 376 </para>
 377
 378 @object:
 379 @orig:
 380 @error:
 381 @debug:
 382
 383
 384 <!-- ##### FUNCTION gst_element_set_loop_function ##### -->
 385 <para>
 386
 387 </para>
 388
 389 @element:
 390 @loop:
 391
 392
 393 <!-- ##### MACRO gst_element_get_name ##### -->
 394 <para>
 395 Gets the name of the element.
 396 </para>
 397
 398 @elem:
 399 @Returns: the name of the element.
 400
 401
 402 <!-- link -->
 403
 404
 405 <!-- ##### MACRO gst_element_set_name ##### -->
 406 <para>
 407 Sets the name of the element, getting rid of the old name if there was one.
 408 </para>
 409
 410 @elem: a #GstElement to set the name of.
 411 @name: the new name of the element.
 412
 413
 414 <!-- ##### MACRO gst_element_get_parent ##### -->
 415 <para>
 416 Gets the parent of an element.
 417 </para>
 418
 419 @elem: a #GstElement to get the parent of.
 420 @Returns: the #GstObject parent of the element.
 421
 422
 423 <!-- ##### MACRO gst_element_set_parent ##### -->
 424 <para>
 425 Sets the parent of an element.
 426 </para>
 427
 428 @elem: a #GstElement to set the parent of.
 429 @parent:  the new #GstObject parent of the object.
 430
 431
 432 <!-- ##### FUNCTION gst_element_set ##### -->
 433 <para>
 434
 435 </para>
 436
 437 @element:
 438 @first_property_name:
 439 @Varargs:
 440
 441
 442 <!-- ##### FUNCTION gst_element_get ##### -->
 443 <para>
 444
 445 </para>
 446
 447 @element:
 448 @first_property_name:
 449 @Varargs:
 450
 451
 452 <!-- ##### FUNCTION gst_element_set_valist ##### -->
 453 <para>
 454
 455 </para>
 456
 457 @element:
 458 @first_property_name:
 459 @var_args:
 460
 461
 462 <!-- ##### FUNCTION gst_element_get_valist ##### -->
 463 <para>
 464
 465 </para>
 466
 467 @element:
 468 @first_property_name:
 469 @var_args:
 470
 471
 472 <!-- ##### FUNCTION gst_element_set_property ##### -->
 473 <para>
 474
 475 </para>
 476
 477 @element:
 478 @property_name:
 479 @value:
 480
 481
 482 <!-- ##### FUNCTION gst_element_get_property ##### -->
 483 <para>
 484
 485 </para>
 486
 487 @element:
 488 @property_name:
 489 @value:
 490
 491
 492 <!-- ##### FUNCTION gst_element_enable_threadsafe_properties ##### -->
 493 <para>
 494
 495 </para>
 496
 497 @element:
 498
 499
 500 <!-- ##### FUNCTION gst_element_disable_threadsafe_properties ##### -->
 501 <para>
 502
 503 </para>
 504
 505 @element:
 506
 507
 508 <!-- ##### FUNCTION gst_element_set_pending_properties ##### -->
 509 <para>
 510
 511 </para>
 512
 513 @element:
 514
 515
 516 <!-- ##### FUNCTION gst_element_requires_clock ##### -->
 517 <para>
 518
 519 </para>
 520
 521 @element:
 522 @Returns:
 523
 524
 525 <!-- ##### FUNCTION gst_element_provides_clock ##### -->
 526 <para>
 527
 528 </para>
 529
 530 @element:
 531 @Returns:
 532
 533
 534 <!-- ##### FUNCTION gst_element_get_clock ##### -->
 535 <para>
 536
 537 </para>
 538
 539 @element:
 540 @Returns:
 541
 542
 543 <!-- ##### FUNCTION gst_element_set_clock ##### -->
 544 <para>
 545
 546 </para>
 547
 548 @element:
 549 @clock:
 550
 551
 552 <!-- ##### FUNCTION gst_element_clock_wait ##### -->
 553 <para>
 554
 555 </para>
 556
 557 @element:
 558 @id:
 559 @jitter:
 560 @Returns:
 561 <!-- # Unused Parameters # -->
 562 @clock:
 563 @time:
 564
 565
 566 <!-- ##### FUNCTION gst_element_get_time ##### -->
 567 <para>
 568
 569 </para>
 570
 571 @element:
 572 @Returns:
 573
 574
 575 <!-- ##### FUNCTION gst_element_wait ##### -->
 576 <para>
 577
 578 </para>
 579
 580 @element:
 581 @timestamp:
 582 @Returns:
 583
 584
 585 <!-- ##### FUNCTION gst_element_set_time ##### -->
 586 <para>
 587
 588 </para>
 589
 590 @element:
 591 @time:
 592
 593
 594 <!-- ##### FUNCTION gst_element_set_time_delay ##### -->
 595 <para>
 596
 597 </para>
 598
 599 @element:
 600 @time:
 601 @delay:
 602
 603
 604 <!-- ##### FUNCTION gst_element_adjust_time ##### -->
 605 <para>
 606
 607 </para>
 608
 609 @element:
 610 @diff:
 611
 612
 613 <!-- ##### FUNCTION gst_element_is_indexable ##### -->
 614 <para>
 615
 616 </para>
 617
 618 @element:
 619 @Returns:
 620
 621
 622 <!-- ##### FUNCTION gst_element_set_index ##### -->
 623 <para>
 624
 625 </para>
 626
 627 @element:
 628 @index:
 629
 630
 631 <!-- ##### FUNCTION gst_element_get_index ##### -->
 632 <para>
 633
 634 </para>
 635
 636 @element:
 637 @Returns:
 638
 639
 640 <!-- ##### FUNCTION gst_element_release_locks ##### -->
 641 <para>
 642
 643 </para>
 644
 645 @element:
 646 @Returns:
 647
 648
 649 <!-- ##### FUNCTION gst_element_yield ##### -->
 650 <para>
 651
 652 </para>
 653
 654 @element:
 655
 656
 657 <!-- ##### FUNCTION gst_element_interrupt ##### -->
 658 <para>
 659
 660 </para>
 661
 662 @element:
 663 @Returns:
 664
 665
 666 <!-- ##### FUNCTION gst_element_set_scheduler ##### -->
 667 <para>
 668
 669 </para>
 670
 671 @element:
 672 @sched:
 673
 674
 675 <!-- ##### FUNCTION gst_element_get_scheduler ##### -->
 676 <para>
 677
 678 </para>
 679
 680 @element:
 681 @Returns:
 682
 683
 684 <!-- ##### FUNCTION gst_element_add_pad ##### -->
 685 <para>
 686
 687 </para>
 688
 689 @element:
 690 @pad:
 691
 692
 693 <!-- ##### FUNCTION gst_element_remove_pad ##### -->
 694 <para>
 695
 696 </para>
 697
 698 @element:
 699 @pad:
 700
 701
 702 <!-- ##### FUNCTION gst_element_add_ghost_pad ##### -->
 703 <para>
 704
 705 </para>
 706
 707 @element:
 708 @pad:
 709 @name:
 710 @Returns:
 711
 712
 713 <!-- ##### FUNCTION gst_element_remove_ghost_pad ##### -->
 714 <para>
 715
 716 </para>
 717
 718 @element:
 719 @pad:
 720
 721
 722 <!-- pad template manipulation -->
 723
 724
 725 <!-- ##### FUNCTION gst_element_get_pad ##### -->
 726 <para>
 727
 728 </para>
 729
 730 @element:
 731 @name:
 732 @Returns: GList of #GstPads
 733
 734
 735 <!-- ##### FUNCTION gst_element_get_static_pad ##### -->
 736 <para>
 737
 738 </para>
 739
 740 @element:
 741 @name:
 742 @Returns:
 743
 744
 745 <!-- ##### FUNCTION gst_element_get_request_pad ##### -->
 746 <para>
 747
 748 </para>
 749
 750 @element:
 751 @name:
 752 @Returns:
 753
 754
 755 <!-- ##### FUNCTION gst_element_release_request_pad ##### -->
 756 <para>
 757
 758 </para>
 759
 760 @element:
 761 @pad:
 762
 763
 764 <!-- ##### FUNCTION gst_element_get_pad_list ##### -->
 765 <para>
 766
 767 </para>
 768
 769 @element:
 770 @Returns:
 771
 772
 773 <!-- ##### FUNCTION gst_element_get_compatible_pad ##### -->
 774 <para>
 775
 776 </para>
 777
 778 @element:
 779 @pad:
 780 @Returns:
 781
 782
 783 <!-- ##### FUNCTION gst_element_get_compatible_pad_filtered ##### -->
 784 <para>
 785
 786 </para>
 787
 788 @element:
 789 @pad:
 790 @filtercaps:
 791 @Returns:
 792
 793
 794 <!-- ##### FUNCTION gst_element_class_get_pad_template ##### -->
 795 <para>
 796
 797 </para>
 798
 799 @element_class:
 800 @name:
 801 @Returns:
 802
 803
 804 <!-- ##### FUNCTION gst_element_class_get_pad_template_list ##### -->
 805 <para>
 806
 807 </para>
 808
 809 @element_class:
 810 @Returns:
 811
 812
 813 <!-- ##### FUNCTION gst_element_get_pad_template ##### -->
 814 <para>
 815
 816 </para>
 817
 818 @element:
 819 @name:
 820 @Returns:
 821
 822
 823 <!-- ##### FUNCTION gst_element_get_pad_template_list ##### -->
 824 <para>
 825
 826 </para>
 827
 828 @element:
 829 @Returns:
 830
 831
 832
 833 <!-- scheduling -->
 834
 835
 836 <!-- ##### FUNCTION gst_element_get_compatible_pad_template ##### -->
 837 <para>
 838
 839 </para>
 840
 841 @element:
 842 @compattempl:
 843 @Returns:
 844
 845
 846 <!-- ##### FUNCTION gst_element_link ##### -->
 847 <para>
 848
 849 </para>
 850
 851 @src:
 852 @dest:
 853 @Returns:
 854
 855
 856 <!-- ##### FUNCTION gst_element_link_many ##### -->
 857 <para>
 858
 859 </para>
 860
 861 @element_1:
 862 @element_2:
 863 @Varargs:
 864 @Returns:
 865
 866
 867 <!-- ##### FUNCTION gst_element_link_filtered ##### -->
 868 <para>
 869
 870 </para>
 871
 872 @src:
 873 @dest:
 874 @filtercaps:
 875 @Returns:
 876
 877
 878 <!-- ##### FUNCTION gst_element_unlink ##### -->
 879 <para>
 880
 881 </para>
 882
 883 @src:
 884 @dest:
 885
 886
 887 <!-- ##### FUNCTION gst_element_unlink_many ##### -->
 888 <para>
 889
 890 </para>
 891
 892 @element_1:
 893 @element_2:
 894 @Varargs:
 895
 896
 897 <!-- ##### FUNCTION gst_element_link_pads ##### -->
 898 <para>
 899
 900 </para>
 901
 902 @src:
 903 @srcpadname:
 904 @dest:
 905 @destpadname:
 906 @Returns:
 907
 908
 909 <!-- ##### FUNCTION gst_element_link_pads_filtered ##### -->
 910 <para>
 911
 912 </para>
 913
 914 @src:
 915 @srcpadname:
 916 @dest:
 917 @destpadname:
 918 @filtercaps:
 919 @Returns:
 920
 921
 922 <!-- ##### FUNCTION gst_element_unlink_pads ##### -->
 923 <para>
 924
 925 </para>
 926
 927 @src:
 928 @srcpadname:
 929 @dest:
 930 @destpadname:
 931
 932
 933 <!-- pad manipulation -->
 934
 935
 936 <!-- ##### FUNCTION gst_element_get_event_masks ##### -->
 937 <para>
 938
 939 </para>
 940
 941 @element:
 942 @Returns:
 943
 944
 945 <!-- ##### FUNCTION gst_element_send_event ##### -->
 946 <para>
 947
 948 </para>
 949
 950 @element:
 951 @event:
 952 @Returns:
 953
 954
 955 <!-- ##### FUNCTION gst_element_seek ##### -->
 956 <para>
 957
 958 </para>
 959
 960 @element:
 961 @seek_type:
 962 @offset:
 963 @Returns:
 964
 965
 966 <!-- ##### FUNCTION gst_element_get_query_types ##### -->
 967 <para>
 968
 969 </para>
 970
 971 @element:
 972 @Returns:
 973
 974
 975 <!-- ##### FUNCTION gst_element_query ##### -->
 976 <para>
 977
 978 </para>
 979
 980 @element:
 981 @type:
 982 @format:
 983 @value:
 984 @Returns:
 985
 986
 987 <!-- ##### FUNCTION gst_element_get_formats ##### -->
 988 <para>
 989
 990 </para>
 991
 992 @element:
 993 @Returns:
 994
 995
 996 <!-- ##### FUNCTION gst_element_convert ##### -->
 997 <para>
 998
 999 </para>
1000
1001 @element:
1002 @src_format:
1003 @src_value:
1004 @dest_format:
1005 @dest_value:
1006 @Returns:
1007
1008
1009 <!-- ##### FUNCTION gst_element_found_tags ##### -->
1010 <para>
1011
1012 </para>
1013
1014 @element:
1015 @tag_list:
1016
1017
1018 <!-- ##### FUNCTION gst_element_found_tags_for_pad ##### -->
1019 <para>
1020
1021 </para>
1022
1023 @element:
1024 @pad:
1025 @timestamp:
1026 @list:
1027
1028
1029 <!-- ##### FUNCTION gst_element_set_eos ##### -->
1030 <para>
1031
1032 </para>
1033
1034 @element:
1035
1036
1037 <!-- ##### FUNCTION gst_element_error_full ##### -->
1038 <para>
1039
1040 </para>
1041
1042 @element:
1043 @domain:
1044 @code:
1045 @message:
1046 @debug:
1047 @file:
1048 @function:
1049 @line:
1050
1051
1052 <!-- ##### FUNCTION gst_element_is_locked_state ##### -->
1053 <para>
1054
1055 </para>
1056
1057 @element:
1058 @Returns:
1059
1060
1061 <!-- ##### FUNCTION gst_element_set_locked_state ##### -->
1062 <para>
1063
1064 </para>
1065
1066 @element:
1067 @locked_state:
1068
1069
1070 <!-- ##### FUNCTION gst_element_sync_state_with_parent ##### -->
1071 <para>
1072
1073 </para>
1074
1075 @element:
1076 @Returns:
1077
1078
1079 <!-- ##### FUNCTION gst_element_get_state ##### -->
1080 <para>
1081
1082 </para>
1083
1084 @element:
1085 @Returns:
1086
1087
1088 <!-- ##### FUNCTION gst_element_set_state ##### -->
1089 <para>
1090
1091 </para>
1092
1093 @element:
1094 @state:
1095 @Returns:
1096
1097
1098 <!-- ##### FUNCTION gst_element_wait_state_change ##### -->
1099 <para>
1100
1101 </para>
1102
1103 @element:
1104
1105
1106 <!-- ##### FUNCTION gst_element_state_get_name ##### -->
1107 <para>
1108
1109 </para>
1110
1111 @state:
1112 @Returns:
1113
1114
1115 <!-- ##### FUNCTION gst_element_get_factory ##### -->
1116 <para>
1117
1118 </para>
1119
1120 @element:
1121 @Returns:
1122
1123
1124 <!-- ##### FUNCTION gst_element_get_managing_bin ##### -->
1125 <para>
1126
1127 </para>
1128
1129 @element:
1130 @Returns:
1131
1132 <!-- clocking -->
1133
1134
1135 <!-- ##### MACRO GST_TYPE_ELEMENT_FACTORY ##### -->
1136 <para>
1137
1138 </para>
1139
1140
1141
1142 <!-- ##### MACRO GST_ELEMENT_FACTORY ##### -->
1143 <para>
1144
1145 </para>
1146
1147 @obj:
1148
1149
1150 <!-- ##### MACRO GST_ELEMENT_FACTORY_CLASS ##### -->
1151 <para>
1152
1153 </para>
1154
1155 @klass:
1156
1157
1158 <!-- ##### MACRO GST_IS_ELEMENT_FACTORY ##### -->
1159 <para>
1160
1161 </para>
1162
1163 @obj:
1164
1165
1166 <!-- ##### MACRO GST_IS_ELEMENT_FACTORY_CLASS ##### -->
1167 <para>
1168
1169 </para>
1170
1171 @klass:
1172
1173
1174 <!-- ##### FUNCTION gst_element_factory_get_type ##### -->
1175 <para>
1176
1177 </para>
1178
1179 @Returns:
1180
1181
1182 <!-- ##### FUNCTION gst_element_register ##### -->
1183 <para>
1184
1185 </para>
1186
1187 @plugin:
1188 @name:
1189 @rank:
1190 @type:
1191 @Returns:
1192 <!-- # Unused Parameters # -->
1193 @elementname:
1194
1195
1196 <!-- ##### FUNCTION gst_element_factory_find ##### -->
1197 <para>
1198
1199 </para>
1200
1201 @name:
1202 @Returns:
1203
1204
1205 <!-- ##### FUNCTION gst_element_factory_get_element_type ##### -->
1206 <para>
1207
1208 </para>
1209
1210 @factory:
1211 @Returns:
1212
1213
1214 <!-- ##### FUNCTION gst_element_factory_get_longname ##### -->
1215 <para>
1216
1217 </para>
1218
1219 @factory:
1220 @Returns:
1221
1222
1223 <!-- ##### FUNCTION gst_element_factory_get_klass ##### -->
1224 <para>
1225
1226 </para>
1227
1228 @factory:
1229 @Returns:
1230
1231
1232 <!-- ##### FUNCTION gst_element_factory_get_description ##### -->
1233 <para>
1234
1235 </para>
1236
1237 @factory:
1238 @Returns:
1239
1240
1241 <!-- ##### FUNCTION gst_element_factory_get_author ##### -->
1242 <para>
1243
1244 </para>
1245
1246 @factory:
1247 @Returns:
1248
1249
1250 <!-- ##### FUNCTION gst_element_factory_get_num_pad_templates ##### -->
1251 <para>
1252
1253 </para>
1254
1255 @factory:
1256 @Returns:
1257
1258
1259 <!-- ##### FUNCTION gst_element_factory_get_pad_templates ##### -->
1260 <para>
1261
1262 </para>
1263
1264 @factory:
1265 @Returns:
1266
1267
1268 <!-- ##### FUNCTION gst_element_factory_get_uri_type ##### -->
1269 <para>
1270
1271 </para>
1272
1273 @factory:
1274 @Returns:
1275
1276
1277 <!-- ##### FUNCTION gst_element_factory_get_uri_protocols ##### -->
1278 <para>
1279
1280 </para>
1281
1282 @factory:
1283 @Returns:
1284
1285
1286 <!-- ##### FUNCTION gst_element_factory_create ##### -->
1287 <para>
1288
1289 </para>
1290
1291 @factory:
1292 @name:
1293 @Returns:
1294
1295
1296 <!-- ##### FUNCTION gst_element_factory_make ##### -->
1297 <para>
1298
1299 </para>
1300
1301 @factoryname:
1302 @name:
1303 @Returns:
1304
1305
1306 <!-- ##### FUNCTION gst_element_factory_can_src_caps ##### -->
1307 <para>
1308
1309 </para>
1310
1311 @factory:
1312 @caps:
1313 @Returns:
1314
1315
1316 <!-- ##### FUNCTION gst_element_factory_can_sink_caps ##### -->
1317 <para>
1318
1319 </para>
1320
1321 @factory:
1322 @caps:
1323 @Returns:
1324
1325
1326 <!-- ##### SIGNAL GstElement::eos ##### -->
1327 <para>
1328 Signal emited when the element goes to PAUSED due to an end-of-stream
1329 condition.
1330 </para>
1331
1332 @gstelement: the object which received the signal.
1333
1334 <!-- ##### SIGNAL GstElement::error ##### -->
1335 <para>
1336 This signal is emitted when an element has encountered an error that caused
1337 it to fail performing its function.
1338 </para>
1339
1340 @gstelement: the object which received the signal.
1341 @arg1: the original #GstElement that generated the error.
1342 @arg2: a #GError containing the translated error message.
1343 @arg3: a debug string providing additional untranslated debug information, or NULL.
1344
1345 <!-- ##### SIGNAL GstElement::found-tag ##### -->
1346 <para>
1347
1348 </para>
1349
1350 @gstelement: the object which received the signal.
1351 @arg1:
1352 @arg2:
1353
1354 <!-- ##### SIGNAL GstElement::new-pad ##### -->
1355 <para>
1356 Is triggered whenever a new pad is added to an element.
1357 </para>
1358
1359 @gstelement: the object which received the signal.
1360 @arg1: the new pad that was added
1361
1362 <!-- ##### SIGNAL GstElement::pad-removed ##### -->
1363 <para>
1364 Is triggered whenever a pad has been removed from the element.
1365 </para>
1366
1367 @gstelement: the object which received the signal.
1368 @arg1: The pad that was removed.
1369
1370 <!-- ##### SIGNAL GstElement::state-change ##### -->
1371 <para>
1372 Is triggered whenever the state of an element changes.
1373 </para>
1374
1375 @gstelement: the object which received the signal.
1376 @arg1: the new state of the object
1377 @arg2:
1378