/usr/share/gtk-doc/html/ges-1.0/GESPipeline.html is in libges-1.0-doc 1.2.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 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 342 343 344 345 346 347 348 349 350 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 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 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 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 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 707 708 709 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GStreamer Editing Services 1.2.1 Reference Manual: GESPipeline</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GStreamer Editing Services 1.2.1 Reference Manual">
<link rel="up" href="ch05.html" title="Convenience classes">
<link rel="prev" href="ch05.html" title="Convenience classes">
<link rel="next" href="ch06.html" title="Serialization Classes">
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#GESPipeline.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GESPipeline.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#GESPipeline.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#GESPipeline.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch05.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch05.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ch06.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GESPipeline"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GESPipeline.top_of_page"></a>GESPipeline</span></h2>
<p>GESPipeline — Convenience GstPipeline for editing.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GESPipeline.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GESPipeline.html" title="GESPipeline"><span class="returnvalue">GESPipeline</span></a> *
</td>
<td class="function_name">
<a class="link" href="GESPipeline.html#ges-pipeline-new" title="ges_pipeline_new ()">ges_pipeline_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GESPipeline.html#ges-pipeline-set-timeline" title="ges_pipeline_set_timeline ()">ges_pipeline_set_timeline</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GESPipeline.html#ges-pipeline-set-mode" title="ges_pipeline_set_mode ()">ges_pipeline_set_mode</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GESPipeline.html#ges-pipeline-set-render-settings" title="ges_pipeline_set_render_settings ()">ges_pipeline_set_render_settings</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html"><span class="returnvalue">GstElement</span></a> *
</td>
<td class="function_name">
<a class="link" href="GESPipeline.html#ges-pipeline-preview-get-audio-sink" title="ges_pipeline_preview_get_audio_sink ()">ges_pipeline_preview_get_audio_sink</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html"><span class="returnvalue">GstElement</span></a> *
</td>
<td class="function_name">
<a class="link" href="GESPipeline.html#ges-pipeline-preview-get-video-sink" title="ges_pipeline_preview_get_video_sink ()">ges_pipeline_preview_get_video_sink</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GESPipeline.html#ges-pipeline-preview-set-audio-sink" title="ges_pipeline_preview_set_audio_sink ()">ges_pipeline_preview_set_audio_sink</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GESPipeline.html#ges-pipeline-preview-set-video-sink" title="ges_pipeline_preview_set_video_sink ()">ges_pipeline_preview_set_video_sink</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ges-GES-Enums.html#GESPipelineFlags" title="enum GESPipelineFlags"><span class="returnvalue">GESPipelineFlags</span></a>
</td>
<td class="function_name">
<a class="link" href="GESPipeline.html#ges-pipeline-get-mode" title="ges_pipeline_get_mode ()">ges_pipeline_get_mode</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gstreamer-1.0/gstreamer-GstSample.html#GstSample"><span class="returnvalue">GstSample</span></a> *
</td>
<td class="function_name">
<a class="link" href="GESPipeline.html#ges-pipeline-get-thumbnail" title="ges_pipeline_get_thumbnail ()">ges_pipeline_get_thumbnail</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gstreamer-1.0/gstreamer-GstSample.html#GstSample"><span class="returnvalue">GstSample</span></a> *
</td>
<td class="function_name">
<a class="link" href="GESPipeline.html#ges-pipeline-get-thumbnail-rgb24" title="ges_pipeline_get_thumbnail_rgb24 ()">ges_pipeline_get_thumbnail_rgb24</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GESPipeline.html#ges-pipeline-save-thumbnail" title="ges_pipeline_save_thumbnail ()">ges_pipeline_save_thumbnail</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GESPipeline.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html"><span class="type">GstElement</span></a> *</td>
<td class="property_name"><a class="link" href="GESPipeline.html#GESPipeline--audio-sink" title="The “audio-sink” property">audio-sink</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="ges-GES-Enums.html#GESPipelineFlags" title="enum GESPipelineFlags"><span class="type">GESPipelineFlags</span></a></td>
<td class="property_name"><a class="link" href="GESPipeline.html#GESPipeline--mode" title="The “mode” property">mode</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="GESTimeline.html" title="GESTimeline"><span class="type">GESTimeline</span></a> *</td>
<td class="property_name"><a class="link" href="GESPipeline.html#GESPipeline--timeline" title="The “timeline” property">timeline</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html"><span class="type">GstElement</span></a> *</td>
<td class="property_name"><a class="link" href="GESPipeline.html#GESPipeline--video-sink" title="The “video-sink” property">video-sink</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GESPipeline.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GESPipeline.html#GESPipeline-struct" title="GESPipeline">GESPipeline</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GESPipeline.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html">GstObject</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html">GstElement</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstBin.html">GstBin</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstPipeline.html">GstPipeline</a>
<span class="lineart">╰──</span> GESPipeline
</pre>
</div>
<div class="refsect1">
<a name="GESPipeline.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GESPipeline implements
<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstChildProxy.html">GstChildProxy</a> and <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/gst-plugins-base-libs-gstvideooverlay.html#GstVideoOverlay">GstVideoOverlay</a>.</p>
</div>
<div class="refsect1">
<a name="GESPipeline.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <ges/ges.h>
</pre>
</div>
<div class="refsect1">
<a name="GESPipeline.description"></a><h2>Description</h2>
<p><a class="link" href="GESPipeline.html" title="GESPipeline"><span class="type">GESPipeline</span></a> allows developers to view and render <a class="link" href="GESTimeline.html" title="GESTimeline"><span class="type">GESTimeline</span></a>
in a simple fashion.
Its usage is inspired by the 'playbin' element from gst-plugins-base.</p>
</div>
<div class="refsect1">
<a name="GESPipeline.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="ges-pipeline-new"></a><h3>ges_pipeline_new ()</h3>
<pre class="programlisting"><a class="link" href="GESPipeline.html" title="GESPipeline"><span class="returnvalue">GESPipeline</span></a> *
ges_pipeline_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new conveninence <a class="link" href="GESPipeline.html" title="GESPipeline"><span class="type">GESPipeline</span></a>.</p>
<div class="refsect3">
<a name="id-1.6.2.10.2.5"></a><h4>Returns</h4>
<p> the new <a class="link" href="GESPipeline.html" title="GESPipeline"><span class="type">GESPipeline</span></a>.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ges-pipeline-set-timeline"></a><h3>ges_pipeline_set_timeline ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
ges_pipeline_set_timeline (<em class="parameter"><code><a class="link" href="GESPipeline.html" title="GESPipeline"><span class="type">GESPipeline</span></a> *pipeline</code></em>,
<em class="parameter"><code><a class="link" href="GESTimeline.html" title="GESTimeline"><span class="type">GESTimeline</span></a> *timeline</code></em>);</pre>
<p>Sets the timeline to use in this pipeline.</p>
<p>The reference to the <em class="parameter"><code>timeline</code></em>
will be stolen by the <em class="parameter"><code>pipeline</code></em>
.</p>
<div class="refsect3">
<a name="id-1.6.2.10.3.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>pipeline</p></td>
<td class="parameter_description"><p>a <a class="link" href="GESPipeline.html" title="GESPipeline"><span class="type">GESPipeline</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>timeline</p></td>
<td class="parameter_description"><p>the <a class="link" href="GESTimeline.html" title="GESTimeline"><span class="type">GESTimeline</span></a> to set on the <em class="parameter"><code>pipeline</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.6.2.10.3.7"></a><h4>Returns</h4>
<p> TRUE if the <em class="parameter"><code>timeline</code></em>
could be successfully set on the <em class="parameter"><code>pipeline</code></em>
,
else FALSE.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ges-pipeline-set-mode"></a><h3>ges_pipeline_set_mode ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
ges_pipeline_set_mode (<em class="parameter"><code><a class="link" href="GESPipeline.html" title="GESPipeline"><span class="type">GESPipeline</span></a> *pipeline</code></em>,
<em class="parameter"><code><a class="link" href="ges-GES-Enums.html#GESPipelineFlags" title="enum GESPipelineFlags"><span class="type">GESPipelineFlags</span></a> mode</code></em>);</pre>
<p>switches the <em class="parameter"><code>pipeline</code></em>
to the specified <em class="parameter"><code>mode</code></em>
. The default mode when
creating a <a class="link" href="GESPipeline.html" title="GESPipeline"><span class="type">GESPipeline</span></a> is <a class="link" href="ges-GES-Enums.html#GES-PIPELINE-MODE-PREVIEW:CAPS"><span class="type">GES_PIPELINE_MODE_PREVIEW</span></a>.</p>
<p>Note: The <em class="parameter"><code>pipeline</code></em>
will be set to <span class="type">GST_STATE_NULL</span> during this call due to
the internal changes that happen. The caller will therefore have to
set the <em class="parameter"><code>pipeline</code></em>
to the requested state after calling this method.</p>
<div class="refsect3">
<a name="id-1.6.2.10.4.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>pipeline</p></td>
<td class="parameter_description"><p>a <a class="link" href="GESPipeline.html" title="GESPipeline"><span class="type">GESPipeline</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mode</p></td>
<td class="parameter_description"><p>the <a class="link" href="ges-GES-Enums.html#GESPipelineFlags" title="enum GESPipelineFlags"><span class="type">GESPipelineFlags</span></a> to use</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.6.2.10.4.7"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the mode was properly set, else <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ges-pipeline-set-render-settings"></a><h3>ges_pipeline_set_render_settings ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
ges_pipeline_set_render_settings (<em class="parameter"><code><a class="link" href="GESPipeline.html" title="GESPipeline"><span class="type">GESPipeline</span></a> *pipeline</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *output_uri</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/gst-plugins-base-libs-encoding-profile.html#GstEncodingProfile"><span class="type">GstEncodingProfile</span></a> *profile</code></em>);</pre>
<p>Specify where the pipeline shall be rendered and with what settings.</p>
<p>A copy of <em class="parameter"><code>profile</code></em>
and <em class="parameter"><code>output_uri</code></em>
will be done internally, the caller can
safely free those values afterwards.</p>
<p>This method must be called before setting the pipeline mode to
<a class="link" href="ges-GES-Enums.html#GES-PIPELINE-MODE-RENDER:CAPS"><span class="type">GES_PIPELINE_MODE_RENDER</span></a></p>
<div class="refsect3">
<a name="id-1.6.2.10.5.7"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>pipeline</p></td>
<td class="parameter_description"><p>a <a class="link" href="GESPipeline.html" title="GESPipeline"><span class="type">GESPipeline</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>output_uri</p></td>
<td class="parameter_description"><p>the URI to which the timeline will be rendered</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>profile</p></td>
<td class="parameter_description"><p>the <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/gst-plugins-base-libs-encoding-profile.html#GstEncodingProfile"><span class="type">GstEncodingProfile</span></a> to use to render the timeline.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.6.2.10.5.8"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the settings were aknowledged properly, else <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a></p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ges-pipeline-preview-get-audio-sink"></a><h3>ges_pipeline_preview_get_audio_sink ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html"><span class="returnvalue">GstElement</span></a> *
ges_pipeline_preview_get_audio_sink (<em class="parameter"><code><a class="link" href="GESPipeline.html" title="GESPipeline"><span class="type">GESPipeline</span></a> *self</code></em>);</pre>
<p>Obtains a pointer to playsink's audio sink element that is used for
displaying audio when the <a class="link" href="GESPipeline.html" title="GESPipeline"><span class="type">GESPipeline</span></a> is in <a class="link" href="ges-GES-Enums.html#GES-PIPELINE-MODE-PREVIEW:CAPS"><code class="literal">GES_PIPELINE_MODE_PREVIEW</code></a></p>
<p>The caller is responsible for unreffing the returned element with
<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#gst-object-unref"><span class="type">gst_object_unref</span></a>.</p>
<div class="refsect3">
<a name="id-1.6.2.10.6.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GESPipeline.html" title="GESPipeline"><span class="type">GESPipeline</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.6.2.10.6.7"></a><h4>Returns</h4>
<p> a pointer to the playsink audio sink <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html"><span class="type">GstElement</span></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ges-pipeline-preview-get-video-sink"></a><h3>ges_pipeline_preview_get_video_sink ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html"><span class="returnvalue">GstElement</span></a> *
ges_pipeline_preview_get_video_sink (<em class="parameter"><code><a class="link" href="GESPipeline.html" title="GESPipeline"><span class="type">GESPipeline</span></a> *self</code></em>);</pre>
<p>Obtains a pointer to playsink's video sink element that is used for
displaying video when the <a class="link" href="GESPipeline.html" title="GESPipeline"><span class="type">GESPipeline</span></a> is in <a class="link" href="ges-GES-Enums.html#GES-PIPELINE-MODE-PREVIEW:CAPS"><code class="literal">GES_PIPELINE_MODE_PREVIEW</code></a></p>
<p>The caller is responsible for unreffing the returned element with
<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#gst-object-unref"><span class="type">gst_object_unref</span></a>.</p>
<div class="refsect3">
<a name="id-1.6.2.10.7.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GESPipeline.html" title="GESPipeline"><span class="type">GESPipeline</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.6.2.10.7.7"></a><h4>Returns</h4>
<p> a pointer to the playsink video sink <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html"><span class="type">GstElement</span></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ges-pipeline-preview-set-audio-sink"></a><h3>ges_pipeline_preview_set_audio_sink ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ges_pipeline_preview_set_audio_sink (<em class="parameter"><code><a class="link" href="GESPipeline.html" title="GESPipeline"><span class="type">GESPipeline</span></a> *self</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html"><span class="type">GstElement</span></a> *sink</code></em>);</pre>
<p>Sets playsink's audio sink element that is used for displaying audio when
the <a class="link" href="GESPipeline.html" title="GESPipeline"><span class="type">GESPipeline</span></a> is in <a class="link" href="ges-GES-Enums.html#GES-PIPELINE-MODE-PREVIEW:CAPS"><code class="literal">GES_PIPELINE_MODE_PREVIEW</code></a></p>
<div class="refsect3">
<a name="id-1.6.2.10.8.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GESPipeline.html" title="GESPipeline"><span class="type">GESPipeline</span></a> in <code class="literal">GST_STATE_NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sink</p></td>
<td class="parameter_description"><p> a audio sink <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html"><span class="type">GstElement</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ges-pipeline-preview-set-video-sink"></a><h3>ges_pipeline_preview_set_video_sink ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ges_pipeline_preview_set_video_sink (<em class="parameter"><code><a class="link" href="GESPipeline.html" title="GESPipeline"><span class="type">GESPipeline</span></a> *self</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html"><span class="type">GstElement</span></a> *sink</code></em>);</pre>
<p>Sets playsink's video sink element that is used for displaying video when
the <a class="link" href="GESPipeline.html" title="GESPipeline"><span class="type">GESPipeline</span></a> is in <a class="link" href="ges-GES-Enums.html#GES-PIPELINE-MODE-PREVIEW:CAPS"><code class="literal">GES_PIPELINE_MODE_PREVIEW</code></a></p>
<div class="refsect3">
<a name="id-1.6.2.10.9.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GESPipeline.html" title="GESPipeline"><span class="type">GESPipeline</span></a> in <code class="literal">GST_STATE_NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sink</p></td>
<td class="parameter_description"><p> a video sink <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html"><span class="type">GstElement</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ges-pipeline-get-mode"></a><h3>ges_pipeline_get_mode ()</h3>
<pre class="programlisting"><a class="link" href="ges-GES-Enums.html#GESPipelineFlags" title="enum GESPipelineFlags"><span class="returnvalue">GESPipelineFlags</span></a>
ges_pipeline_get_mode (<em class="parameter"><code><a class="link" href="GESPipeline.html" title="GESPipeline"><span class="type">GESPipeline</span></a> *pipeline</code></em>);</pre>
<div class="refsect3">
<a name="id-1.6.2.10.10.4"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>pipeline</p></td>
<td class="parameter_description"><p>a <a class="link" href="GESPipeline.html" title="GESPipeline"><span class="type">GESPipeline</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.6.2.10.10.5"></a><h4>Returns</h4>
<p> the <a class="link" href="ges-GES-Enums.html#GESPipelineFlags" title="enum GESPipelineFlags"><span class="type">GESPipelineFlags</span></a> currently in use.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ges-pipeline-get-thumbnail"></a><h3>ges_pipeline_get_thumbnail ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gstreamer-1.0/gstreamer-GstSample.html#GstSample"><span class="returnvalue">GstSample</span></a> *
ges_pipeline_get_thumbnail (<em class="parameter"><code><a class="link" href="GESPipeline.html" title="GESPipeline"><span class="type">GESPipeline</span></a> *self</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>);</pre>
<p>Returns a <a href="/usr/share/gtk-doc/html/gstreamer-1.0/gstreamer-GstSample.html#GstSample"><span class="type">GstSample</span></a> with the currently playing image in the format specified by
caps. The caller should free the sample with <a href="/usr/share/gtk-doc/html/gstreamer-1.0/gstreamer-GstSample.html#gst-sample-unref"><span class="type">gst_sample_unref</span></a> when finished. If ANY
caps are specified, the information will be returned in the whatever format
is currently used by the sink. This information can be retrieve from caps
associated with the buffer.</p>
<div class="refsect3">
<a name="id-1.6.2.10.11.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GESPipeline.html" title="GESPipeline"><span class="type">GESPipeline</span></a> in <code class="literal">GST_STATE_PLAYING</code> or <code class="literal">GST_STATE_PAUSED</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>caps</p></td>
<td class="parameter_description"><p> caps specifying current format. Use <a href="/usr/share/gtk-doc/html/gstreamer-1.0/gstreamer-GstCaps.html#GST-CAPS-ANY:CAPS"><code class="literal">GST_CAPS_ANY</code></a>
for native size. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.6.2.10.11.6"></a><h4>Returns</h4>
<p> a <a href="/usr/share/gtk-doc/html/gstreamer-1.0/gstreamer-GstSample.html#GstSample"><span class="type">GstSample</span></a> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ges-pipeline-get-thumbnail-rgb24"></a><h3>ges_pipeline_get_thumbnail_rgb24 ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gstreamer-1.0/gstreamer-GstSample.html#GstSample"><span class="returnvalue">GstSample</span></a> *
ges_pipeline_get_thumbnail_rgb24 (<em class="parameter"><code><a class="link" href="GESPipeline.html" title="GESPipeline"><span class="type">GESPipeline</span></a> *self</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> width</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> height</code></em>);</pre>
<p>A convenience method for <em class="parameter"><code>ges_pipeline_get_thumbnail</code></em>
which
returns a buffer in 24-bit RGB, optionally scaled to the specified width
and height. If -1 is specified for either dimension, it will be left at
native size. You can retreive this information from the caps associated
with the buffer.</p>
<p>The caller is responsible for unreffing the returned sample with
<a href="/usr/share/gtk-doc/html/gstreamer-1.0/gstreamer-GstSample.html#gst-sample-unref"><span class="type">gst_sample_unref</span></a>.</p>
<div class="refsect3">
<a name="id-1.6.2.10.12.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GESPipeline.html" title="GESPipeline"><span class="type">GESPipeline</span></a> in <code class="literal">GST_STATE_PLAYING</code> or <code class="literal">GST_STATE_PAUSED</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>the requested width or -1 for native size</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>the requested height or -1 for native size</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.6.2.10.12.7"></a><h4>Returns</h4>
<p> a <a href="/usr/share/gtk-doc/html/gstreamer-1.0/gstreamer-GstSample.html#GstSample"><span class="type">GstSample</span></a> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ges-pipeline-save-thumbnail"></a><h3>ges_pipeline_save_thumbnail ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
ges_pipeline_save_thumbnail (<em class="parameter"><code><a class="link" href="GESPipeline.html" title="GESPipeline"><span class="type">GESPipeline</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">int</span> width</code></em>,
<em class="parameter"><code><span class="type">int</span> height</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *format</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *location</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Saves the current frame to the specified <em class="parameter"><code>location</code></em>
.</p>
<div class="refsect3">
<a name="id-1.6.2.10.13.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GESPipeline.html" title="GESPipeline"><span class="type">GESPipeline</span></a> in <code class="literal">GST_STATE_PLAYING</code> or <code class="literal">GST_STATE_PAUSED</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>the requested width or -1 for native size</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>the requested height or -1 for native size</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>format</p></td>
<td class="parameter_description"><p>a string specifying the desired mime type (for example,
image/jpeg)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>location</p></td>
<td class="parameter_description"><p>the path to save the thumbnail</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> An error to be set in case
something wrong happens or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.6.2.10.13.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the thumbnail was properly save, else <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p>
<p></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GESPipeline.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GESPipeline-struct"></a><h3>GESPipeline</h3>
<pre class="programlisting">typedef struct _GESPipeline GESPipeline;</pre>
</div>
</div>
<div class="refsect1">
<a name="GESPipeline.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GESPipeline--audio-sink"></a><h3>The <code class="literal">“audio-sink”</code> property</h3>
<pre class="programlisting"> “audio-sink” <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html"><span class="type">GstElement</span></a> *</pre>
<p>Audio sink for the preview.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="GESPipeline--mode"></a><h3>The <code class="literal">“mode”</code> property</h3>
<pre class="programlisting"> “mode” <a class="link" href="ges-GES-Enums.html#GESPipelineFlags" title="enum GESPipelineFlags"><span class="type">GESPipelineFlags</span></a></pre>
<p>Pipeline mode. See <a class="link" href="GESPipeline.html#ges-pipeline-set-mode" title="ges_pipeline_set_mode ()"><code class="function">ges_pipeline_set_mode()</code></a> for more
info.</p>
<p>Flags: Read / Write</p>
<p>Default value: GES_PIPELINE_MODE_PREVIEW_AUDIO | GES_PIPELINE_MODE_PREVIEW_VIDEO</p>
</div>
<hr>
<div class="refsect2">
<a name="GESPipeline--timeline"></a><h3>The <code class="literal">“timeline”</code> property</h3>
<pre class="programlisting"> “timeline” <a class="link" href="GESTimeline.html" title="GESTimeline"><span class="type">GESTimeline</span></a> *</pre>
<p>Timeline to use in this pipeline. See also
<a class="link" href="GESPipeline.html#ges-pipeline-set-timeline" title="ges_pipeline_set_timeline ()"><code class="function">ges_pipeline_set_timeline()</code></a> for more info.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="GESPipeline--video-sink"></a><h3>The <code class="literal">“video-sink”</code> property</h3>
<pre class="programlisting"> “video-sink” <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html"><span class="type">GstElement</span></a> *</pre>
<p>Video sink for the preview.</p>
<p>Flags: Read / Write</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.20</div>
</body>
</html>
|