docs/gst/tmpl/gstelement.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GstElement
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 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 GST 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 All GstElements have a list containing the #GstPad structure for all their
  16 inputs and outputs.  These can be added with gst_element_add_pad() or
  17 gst_element_add_ghost_pad(), and retrieved by name with
  18 gst_element_get_pad(), or in a list form by gst_element_get_pad_list().
  19 </para>
  20
  21 <para>
  22 gst_element_connect() is a convenience function provided to make it
  23 simpler to connect pads of two elements together.
  24 </para>
  25
  26 <!-- ##### SECTION See_Also ##### -->
  27 <para>
  28
  29 </para>
  30
  31 <!-- ##### ENUM GstElementState ##### -->
  32 <para>
  33 This enum defines the standard states an element may be in.  You will normally
  34 use gst_element_set_state() to change the state of an element.
  35
  36 </para>
  37
  38 @GST_STATE_NONE_PENDING: The element is in the desired state.
  39 @GST_STATE_NULL: Reset the state of an element.
  40 @GST_STATE_READY: will make the element ready to start processing data. some
  41 elements might have a non trivial way to initialize themselves.
  42 @GST_STATE_PLAYING: means there really is data flowing through the graph.
  43 @GST_STATE_PAUSED: means there really is data flowing temporary stops the data flow.
  44
  45 <!-- ##### ENUM GstElementStateReturn ##### -->
  46 <para>
  47 This enum defines the standard return values that an element
  48 can return after a state change.
  49
  50 </para>
  51
  52 @GST_STATE_FAILURE: the element could not perform the state change
  53 @GST_STATE_SUCCESS: the element successfully changed its state
  54 @GST_STATE_ASYNC: the element will asynchronously change its state as soon as possible
  55
  56 <!-- ##### MACRO GST_STATE ##### -->
  57 <para>
  58 This macro returns the entire state of the element.
  59 </para>
  60
  61 @obj: Element to return state for.
  62
  63
  64 <!-- ##### MACRO GST_STATE_PENDING ##### -->
  65 <para>
  66 This macro returns the currently pending state of the element.
  67 </para>
  68
  69 @obj: Element to return the pending state for.
  70
  71
  72 <!-- ##### MACRO GST_STATE_TRANSITION ##### -->
  73 <para>
  74 Returns the state transition this object is going through
  75 </para>
  76
  77 @obj: the Element to return the tate transition for
  78
  79
  80 <!-- ##### MACRO GST_STATE_NULL_TO_READY ##### -->
  81 <para>
  82 The Element is going from the NULL state to the READY state
  83 </para>
  84
  85
  86
  87 <!-- ##### MACRO GST_STATE_READY_TO_PLAYING ##### -->
  88 <para>
  89 The Element is going from the READY state to the PLAYING state
  90 </para>
  91
  92
  93
  94 <!-- ##### MACRO GST_STATE_PLAYING_TO_PAUSED ##### -->
  95 <para>
  96 The Element is going from the PLAYING state to the PAUSED state
  97 </para>
  98
  99
 100
 101 <!-- ##### MACRO GST_STATE_PAUSED_TO_PLAYING ##### -->
 102 <para>
 103 The Element is going from the PAUSED state to the PLAYING state
 104 </para>
 105
 106
 107
 108 <!-- ##### MACRO GST_STATE_PLAYING_TO_READY ##### -->
 109 <para>
 110 The Element is going from the PLAYING state to the READY state
 111 </para>
 112
 113
 114
 115 <!-- ##### MACRO GST_STATE_READY_TO_NULL ##### -->
 116 <para>
 117 The Element is going from the READY state to the NULL state
 118 </para>
 119
 120
 121
 122 <!-- ##### ENUM GstElementFlags ##### -->
 123 <para>
 124 This enum defines the standard flags that an element
 125 may have.
 126 </para>
 127
 128 @GST_ELEMENT_COMPLEX:
 129 @GST_ELEMENT_DECOUPLED:
 130 @GST_ELEMENT_THREAD_SUGGESTED:
 131 @GST_ELEMENT_NO_SEEK:
 132 @GST_ELEMENT_NEW_LOOPFUNC:
 133 @GST_ELEMENT_COTHREAD_STOPPING:
 134 @GST_ELEMENT_USE_COTHREAD:
 135 @GST_ELEMENT_FLAG_LAST:
 136
 137 <!-- ##### MACRO GST_ELEMENT_IS_THREAD_SUGGESTED ##### -->
 138 <para>
 139 Queries whether the Element should be placed in a thread
 140 </para>
 141
 142 @obj: The element to query
 143
 144
 145 <!-- ##### MACRO GST_ELEMENT_IS_COTHREAD_STOPPING ##### -->
 146 <para>
 147 Queries whether the cothread holding this element needs to be stopped
 148 </para>
 149
 150 @obj: The element to query
 151
 152
 153 <!-- ##### STRUCT GstElement ##### -->
 154 <para>
 155
 156 </para>
 157
 158
 159 <!-- ##### STRUCT GstElementDetails ##### -->
 160 <para>
 161 This struct is used to define public information about the element.  It
 162 describes the element, mostly for the benefit of editors.
 163 </para>
 164
 165 @longname:
 166 @klass:
 167 @description:
 168 @version:
 169 @author:
 170 @copyright:
 171
 172 <!-- ##### STRUCT GstElementFactory ##### -->
 173 <para>
 174 This factory is used when registering the element, and contains the name
 175 of the element, the GtkType value for it, as well as a pointer to the
 176 GstElementDetails struct for the element.
 177 </para>
 178
 179 @name:
 180 @type:
 181 @details:
 182 @padtemplates:
 183
 184 <!-- ##### USER_FUNCTION GstElementLoopFunction ##### -->
 185 <para>
 186 This function type is used to specify a loop function for the element.  It
 187 is passed the element in question, and is expect to return only in error
 188 circumstances.
 189 </para>
 190
 191 @element: The element in question.
 192
 193
 194 <!-- ##### FUNCTION gst_element_new ##### -->
 195 <para>
 196
 197 </para>
 198
 199 @Returns:
 200
 201
 202 <!-- ##### MACRO gst_element_destroy ##### -->
 203 <para>
 204
 205 </para>
 206
 207 @element: the element to destroy
 208
 209
 210 <!-- ##### FUNCTION gst_element_set_loop_function ##### -->
 211 <para>
 212
 213 </para>
 214
 215 @element:
 216 @loop:
 217
 218
 219 <!-- ##### FUNCTION gst_element_set_name ##### -->
 220 <para>
 221
 222 </para>
 223
 224 @element:
 225 @name:
 226
 227
 228 <!-- ##### FUNCTION gst_element_get_name ##### -->
 229 <para>
 230
 231 </para>
 232
 233 @element:
 234 @Returns:
 235
 236
 237 <!-- ##### FUNCTION gst_element_set_manager ##### -->
 238 <para>
 239
 240 </para>
 241
 242 @element:
 243 @manager:
 244
 245
 246 <!-- ##### FUNCTION gst_element_get_manager ##### -->
 247 <para>
 248
 249 </para>
 250
 251 @element:
 252 @Returns:
 253
 254
 255 <!-- ##### FUNCTION gst_element_add_pad ##### -->
 256 <para>
 257
 258 </para>
 259
 260 @element:
 261 @pad:
 262
 263
 264 <!-- ##### FUNCTION gst_element_get_pad ##### -->
 265 <para>
 266
 267 </para>
 268
 269 @element:
 270 @name:
 271 @Returns: GList of pads
 272
 273
 274 <!-- ##### FUNCTION gst_element_get_pad_list ##### -->
 275 <para>
 276
 277 </para>
 278
 279 @element:
 280 @Returns:
 281
 282
 283 <!-- ##### FUNCTION gst_element_get_padtemplate_list ##### -->
 284 <para>
 285
 286 </para>
 287
 288 @element:
 289 @Returns:
 290
 291
 292 <!-- ##### FUNCTION gst_element_add_ghost_pad ##### -->
 293 <para>
 294
 295 </para>
 296
 297 @element:
 298 @pad:
 299
 300
 301 <!-- ##### FUNCTION gst_element_remove_ghost_pad ##### -->
 302 <para>
 303
 304 </para>
 305
 306 @element:
 307 @pad:
 308
 309
 310 <!-- ##### FUNCTION gst_element_connect ##### -->
 311 <para>
 312
 313 </para>
 314
 315 @src:
 316 @srcpadname:
 317 @dest:
 318 @destpadname:
 319
 320
 321 <!-- ##### FUNCTION gst_element_set_state ##### -->
 322 <para>
 323
 324 </para>
 325
 326 @element:
 327 @state:
 328 @Returns:
 329
 330
 331 <!-- ##### FUNCTION gst_element_error ##### -->
 332 <para>
 333
 334 </para>
 335
 336 @element:
 337 @error:
 338
 339
 340 <!-- ##### FUNCTION gst_element_get_factory ##### -->
 341 <para>
 342
 343 </para>
 344
 345 @element:
 346 @Returns:
 347
 348
 349 <!-- ##### FUNCTION gst_element_signal_eos ##### -->
 350 <para>
 351
 352 </para>
 353
 354 @element:
 355
 356
 357 <!-- ##### FUNCTION gst_element_save_thyself ##### -->
 358 <para>
 359
 360 </para>
 361
 362 @element:
 363 @parent:
 364 @Returns:
 365
 366
 367 <!-- ##### FUNCTION gst_element_load_thyself ##### -->
 368 <para>
 369
 370 </para>
 371
 372 @parent:
 373 @elements:
 374 @Returns:
 375
 376
 377 <!-- ##### FUNCTION gst_elementfactory_new ##### -->
 378 <para>
 379
 380 </para>
 381
 382 @name:
 383 @type:
 384 @details:
 385 @Returns:
 386
 387
 388 <!-- ##### FUNCTION gst_elementfactory_destroy ##### -->
 389 <para>
 390
 391 </para>
 392
 393 @elementfactory:
 394
 395
 396 <!-- ##### FUNCTION gst_elementfactory_add_padtemplate ##### -->
 397 <para>
 398
 399 </para>
 400
 401 @elementfactory:
 402 @temp:
 403 <!-- # Unused Parameters # -->
 404 @pad:
 405
 406
 407 <!-- ##### FUNCTION gst_elementfactory_find ##### -->
 408 <para>
 409
 410 </para>
 411
 412 @name:
 413 @Returns:
 414
 415
 416 <!-- ##### FUNCTION gst_elementfactory_get_list ##### -->
 417 <para>
 418
 419 </para>
 420
 421 @Returns:
 422
 423
 424 <!-- ##### FUNCTION gst_elementfactory_can_src_caps ##### -->
 425 <para>
 426
 427 </para>
 428
 429 @factory:
 430 @caps:
 431 @Returns:
 432
 433
 434 <!-- ##### FUNCTION gst_elementfactory_can_sink_caps ##### -->
 435 <para>
 436
 437 </para>
 438
 439 @factory:
 440 @caps:
 441 @Returns:
 442
 443
 444 <!-- ##### FUNCTION gst_elementfactory_can_src_caps_list ##### -->
 445 <para>
 446
 447 </para>
 448
 449 @factory:
 450 @caps:
 451 @Returns:
 452
 453
 454 <!-- ##### FUNCTION gst_elementfactory_can_sink_caps_list ##### -->
 455 <para>
 456
 457 </para>
 458
 459 @factory:
 460 @caps:
 461 @Returns:
 462
 463
 464 <!-- ##### FUNCTION gst_elementfactory_create ##### -->
 465 <para>
 466
 467 </para>
 468
 469 @factory:
 470 @name:
 471 @Returns:
 472
 473
 474 <!-- ##### FUNCTION gst_elementfactory_make ##### -->
 475 <para>
 476
 477 </para>
 478
 479 @factoryname:
 480 @name:
 481 @Returns:
 482
 483
 484 <!-- ##### FUNCTION gst_elementfactory_save_thyself ##### -->
 485 <para>
 486
 487 </para>
 488
 489 @factory:
 490 @parent:
 491 @Returns:
 492
 493
 494 <!-- ##### FUNCTION gst_elementfactory_load_thyself ##### -->
 495 <para>
 496
 497 </para>
 498
 499 @parent:
 500 @Returns:
 501
 502
 503 <!-- ##### SIGNAL GstElement::state-change ##### -->
 504 <para>
 505 Is trigered whenever the state of an element changes
 506 </para>
 507
 508 @gstelement: the object which received the signal.
 509 @arg1: the new state of the object
 510
 511 <!-- ##### SIGNAL GstElement::new-pad ##### -->
 512 <para>
 513 Is trigered whenever a new pad is added to an element
 514 </para>
 515
 516 @gstelement: the object which received the signal.
 517 @arg1: the new pad that was added
 518
 519 <!-- ##### SIGNAL GstElement::new-ghost-pad ##### -->
 520 <para>
 521
 522 Is trigered whenever a new ghost pad is added to an element
 523 </para>
 524
 525 @gstelement: the object which received the signal.
 526 @arg1: the new ghost pad that was added
 527
 528 <!-- ##### SIGNAL GstElement::error ##### -->
 529 <para>
 530 Is trigered whenever an error occured
 531
 532 </para>
 533
 534 @gstelement: the object which received the signal.
 535 @arg1: the error message
 536
 537 <!-- ##### SIGNAL GstElement::eos ##### -->
 538 <para>
 539
 540 </para>
 541
 542 @gstelement: the object which received the signal.
 543