This file is indexed.

/usr/share/gtk-doc/html/cogl-gst/CoglGstVideoSink.html is in libcogl-doc 1.22.0-2.

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
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CoglGstVideoSink: Cogl GST 2.0 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Cogl GST 2.0 Reference Manual">
<link rel="up" href="cogl-gst-general-apis.html" title="General APIs">
<link rel="prev" href="cogl-gst-general-apis.html" title="General APIs">
<link rel="next" href="coglglossary.html" title="Glossaries">
<meta name="generator" content="GTK-Doc V1.24 (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="5"><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="#CoglGstVideoSink.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#CoglGstVideoSink.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#CoglGstVideoSink.properties" class="shortcut">Properties</a></span><span id="nav_signals">  <span class="dim">|</span> 
                  <a href="#CoglGstVideoSink.signals" class="shortcut">Signals</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="cogl-gst-general-apis.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="cogl-gst-general-apis.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="coglglossary.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="CoglGstVideoSink"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="CoglGstVideoSink.top_of_page"></a>CoglGstVideoSink</span></h2>
<p>CoglGstVideoSink — A video sink for integrating a GStreamer
  pipeline with a Cogl pipeline.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="CoglGstVideoSink.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="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="returnvalue">CoglGstVideoSink</span></a> *
</td>
<td class="function_name">
<a class="link" href="CoglGstVideoSink.html#cogl-gst-video-sink-new" title="cogl_gst_video_sink_new ()">cogl_gst_video_sink_new</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="CoglGstVideoSink.html#cogl-gst-video-sink-set-context" title="cogl_gst_video_sink_set_context ()">cogl_gst_video_sink_set_context</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">CoglPipeline</span> *
</td>
<td class="function_name">
<a class="link" href="CoglGstVideoSink.html#cogl-gst-video-sink-get-pipeline" title="cogl_gst_video_sink_get_pipeline ()">cogl_gst_video_sink_get_pipeline</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="CoglGstVideoSink.html#cogl-gst-video-sink-attach-frame" title="cogl_gst_video_sink_attach_frame ()">cogl_gst_video_sink_attach_frame</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="CoglGstVideoSink.html#cogl-gst-video-sink-setup-pipeline" title="cogl_gst_video_sink_setup_pipeline ()">cogl_gst_video_sink_setup_pipeline</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="CoglGstVideoSink.html#cogl-gst-video-sink-get-free-layer" title="cogl_gst_video_sink_get_free_layer ()">cogl_gst_video_sink_get_free_layer</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="CoglGstVideoSink.html#cogl-gst-video-sink-set-first-layer" title="cogl_gst_video_sink_set_first_layer ()">cogl_gst_video_sink_set_first_layer</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="CoglGstVideoSink.html#cogl-gst-video-sink-set-default-sample" title="cogl_gst_video_sink_set_default_sample ()">cogl_gst_video_sink_set_default_sample</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">CoglBool</span>
</td>
<td class="function_name">
<a class="link" href="CoglGstVideoSink.html#cogl-gst-video-sink-is-ready" title="cogl_gst_video_sink_is_ready ()">cogl_gst_video_sink_is_ready</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">float</span>
</td>
<td class="function_name">
<a class="link" href="CoglGstVideoSink.html#cogl-gst-video-sink-get-aspect" title="cogl_gst_video_sink_get_aspect ()">cogl_gst_video_sink_get_aspect</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">float</span>
</td>
<td class="function_name">
<a class="link" href="CoglGstVideoSink.html#cogl-gst-video-sink-get-width-for-height" title="cogl_gst_video_sink_get_width_for_height ()">cogl_gst_video_sink_get_width_for_height</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">float</span>
</td>
<td class="function_name">
<a class="link" href="CoglGstVideoSink.html#cogl-gst-video-sink-get-height-for-width" title="cogl_gst_video_sink_get_height_for_width ()">cogl_gst_video_sink_get_height_for_width</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="CoglGstVideoSink.html#cogl-gst-video-sink-fit-size" title="cogl_gst_video_sink_fit_size ()">cogl_gst_video_sink_fit_size</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="CoglGstVideoSink.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"><span class="type">gint</span></td>
<td class="property_name"><a class="link" href="CoglGstVideoSink.html#CoglGstVideoSink--update-priority" title="The “update-priority” property">update-priority</a></td>
<td class="property_flags">Read / Write</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="CoglGstVideoSink.signals"></a><h2>Signals</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="CoglGstVideoSink.html#CoglGstVideoSink-new-frame" title="The “new-frame” signal">new-frame</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="CoglGstVideoSink.html#CoglGstVideoSink-pipeline-ready" title="The “pipeline-ready” signal">pipeline-ready</a></td>
<td class="signal_flags">Run Last</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="CoglGstVideoSink.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">struct</td>
<td class="function_name"><a class="link" href="CoglGstVideoSink.html#CoglGstVideoSink-struct" title="struct CoglGstVideoSink">CoglGstVideoSink</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="CoglGstVideoSink.html#CoglGstVideoSinkClass" title="struct CoglGstVideoSinkClass">CoglGstVideoSinkClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="CoglGstVideoSink.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> GInitiallyUnowned
        <span class="lineart">╰──</span> GstObject
            <span class="lineart">╰──</span> GstElement
                <span class="lineart">╰──</span> GstBaseSink
                    <span class="lineart">╰──</span> CoglGstVideoSink
</pre>
</div>
<div class="refsect1">
<a name="CoglGstVideoSink.description"></a><h2>Description</h2>
<p><a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="type">CoglGstVideoSink</span></a> is a subclass of <span class="type">GstBaseSink</span> which can be used to
create a <span class="type">CoglPipeline</span> for rendering the frames of the video.</p>
<p>To create a basic video player, an application can create a
<span class="type">GstPipeline</span> as normal using <code class="function">gst_pipeline_new()</code> and set the
sink on it to one created with <a class="link" href="CoglGstVideoSink.html#cogl-gst-video-sink-new" title="cogl_gst_video_sink_new ()"><code class="function">cogl_gst_video_sink_new()</code></a>. The
application can then listen for the <a class="link" href="CoglGstVideoSink.html#CoglGstVideoSink-new-frame" title="The “new-frame” signal"><span class="type">“new-frame”</span></a>
signal which will be emitted whenever there are new textures ready
for rendering. For simple rendering, the application can just call
<a class="link" href="CoglGstVideoSink.html#cogl-gst-video-sink-get-pipeline" title="cogl_gst_video_sink_get_pipeline ()"><code class="function">cogl_gst_video_sink_get_pipeline()</code></a> in the signal handler and use
the returned pipeline to paint the new frame.</p>
<p>An application is also free to do more advanced rendering by
customizing the pipeline. In that case it should listen for the
<a class="link" href="CoglGstVideoSink.html#CoglGstVideoSink-pipeline-ready" title="The “pipeline-ready” signal"><span class="type">“pipeline-ready”</span></a> signal which will be emitted as
soon as the sink has determined enough information about the video
to know how it should be rendered. In the handler for this signal,
the application can either make modifications to a copy of the
pipeline returned by <a class="link" href="CoglGstVideoSink.html#cogl-gst-video-sink-get-pipeline" title="cogl_gst_video_sink_get_pipeline ()"><code class="function">cogl_gst_video_sink_get_pipeline()</code></a> or it can
create its own pipeline from scratch and ask the sink to configure
it with <a class="link" href="CoglGstVideoSink.html#cogl-gst-video-sink-setup-pipeline" title="cogl_gst_video_sink_setup_pipeline ()"><code class="function">cogl_gst_video_sink_setup_pipeline()</code></a>. If a custom pipeline
is created using one of these methods then the application should
call <a class="link" href="CoglGstVideoSink.html#cogl-gst-video-sink-attach-frame" title="cogl_gst_video_sink_attach_frame ()"><code class="function">cogl_gst_video_sink_attach_frame()</code></a> on the pipeline before
rendering in order to update the textures on the pipeline's layers.</p>
<p>If the <code class="literal">COGL_FEATURE_ID_GLSL</code> feature is available then the pipeline
used by the sink will have a shader snippet with a function in it
called cogl_gst_sample_video0 which takes a single vec2 argument.
This can be used by custom snippets set the by the application to
sample from the video. The vec2 argument represents the normalised
coordinates within the video. The function returns a vec4
containing a pre-multiplied RGBA color of the pixel within the
video.</p>
</div>
<div class="refsect1">
<a name="CoglGstVideoSink.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="cogl-gst-video-sink-new"></a><h3>cogl_gst_video_sink_new ()</h3>
<pre class="programlisting"><a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="returnvalue">CoglGstVideoSink</span></a> *
cogl_gst_video_sink_new (<em class="parameter"><code><span class="type">CoglContext</span> *ctx</code></em>);</pre>
<p>Creates a new <a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="type">CoglGstVideoSink</span></a> which will create resources for use
with the given context.</p>
<div class="refsect3">
<a name="id-1.2.3.2.9.2.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>ctx</p></td>
<td class="parameter_description"><p>The <span class="type">CoglContext</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.2.9.2.6"></a><h4>Returns</h4>
<p> a new <a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="type">CoglGstVideoSink</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>
<p class="since">Since: 1.16</p>
</div>
<hr>
<div class="refsect2">
<a name="cogl-gst-video-sink-set-context"></a><h3>cogl_gst_video_sink_set_context ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cogl_gst_video_sink_set_context (<em class="parameter"><code><a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="type">CoglGstVideoSink</span></a> *vt</code></em>,
                                 <em class="parameter"><code><span class="type">CoglContext</span> *ctx</code></em>);</pre>
<p>Sets the <span class="type">CoglContext</span> that the video sink should use for creating
any resources. This function would normally only be used if the
sink was constructed via <code class="function">gst_element_factory_make()</code> instead of
<a class="link" href="CoglGstVideoSink.html#cogl-gst-video-sink-new" title="cogl_gst_video_sink_new ()"><code class="function">cogl_gst_video_sink_new()</code></a>.</p>
<div class="refsect3">
<a name="id-1.2.3.2.9.3.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>vt</p></td>
<td class="parameter_description"><p>The <a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="type">CoglGstVideoSink</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ctx</p></td>
<td class="parameter_description"><p>The <span class="type">CoglContext</span> for the sink to use</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 1.16</p>
</div>
<hr>
<div class="refsect2">
<a name="cogl-gst-video-sink-get-pipeline"></a><h3>cogl_gst_video_sink_get_pipeline ()</h3>
<pre class="programlisting"><span class="returnvalue">CoglPipeline</span> *
cogl_gst_video_sink_get_pipeline (<em class="parameter"><code><a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="type">CoglGstVideoSink</span></a> *vt</code></em>);</pre>
<p>Returns a pipeline suitable for rendering the current frame of the
given video sink. The pipeline will already have the textures for
the frame attached. For simple rendering, an application will
typically call this function immediately before it paints the
video. It can then just paint a rectangle using the returned
pipeline.</p>
<p>An application is free to make a copy of this
pipeline and modify it for custom rendering.</p>
<p>Note: it is considered an error to call this function before the
<a class="link" href="CoglGstVideoSink.html#CoglGstVideoSink-pipeline-ready" title="The “pipeline-ready” signal"><span class="type">“pipeline-ready”</span></a> signal is emitted.</p>
<div class="refsect3">
<a name="id-1.2.3.2.9.4.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>vt</p></td>
<td class="parameter_description"><p>The <a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="type">CoglGstVideoSink</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.2.9.4.8"></a><h4>Returns</h4>
<p> the pipeline for rendering the
current frame. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: 1.16</p>
</div>
<hr>
<div class="refsect2">
<a name="cogl-gst-video-sink-attach-frame"></a><h3>cogl_gst_video_sink_attach_frame ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cogl_gst_video_sink_attach_frame (<em class="parameter"><code><a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="type">CoglGstVideoSink</span></a> *sink</code></em>,
                                  <em class="parameter"><code><span class="type">CoglPipeline</span> *pln</code></em>);</pre>
<p>Updates the given pipeline with the textures for the current frame.
This can be used if the application wants to customize the
rendering using its own pipeline. Typically this would be called in
response to the <a class="link" href="CoglGstVideoSink.html#CoglGstVideoSink-new-frame" title="The “new-frame” signal"><span class="type">“new-frame”</span></a> signal which is
emitted whenever the new textures are available. The application
would then make a copy of its template pipeline and call this to
set the textures.</p>
<div class="refsect3">
<a name="id-1.2.3.2.9.5.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>sink</p></td>
<td class="parameter_description"><p>The <a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="type">CoglGstVideoSink</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pln</p></td>
<td class="parameter_description"><p>A <span class="type">CoglPipeline</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 1.16</p>
</div>
<hr>
<div class="refsect2">
<a name="cogl-gst-video-sink-setup-pipeline"></a><h3>cogl_gst_video_sink_setup_pipeline ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cogl_gst_video_sink_setup_pipeline (<em class="parameter"><code><a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="type">CoglGstVideoSink</span></a> *sink</code></em>,
                                    <em class="parameter"><code><span class="type">CoglPipeline</span> *pipeline</code></em>);</pre>
<p>Configures the given pipeline so that will be able to render the
video for the <em class="parameter"><code>sink</code></em>
. This should only be used if the application
wants to perform some custom rendering using its own pipeline.
Typically an application will call this in response to the
<a class="link" href="CoglGstVideoSink.html#CoglGstVideoSink-pipeline-ready" title="The “pipeline-ready” signal"><span class="type">“pipeline-ready”</span></a> signal.</p>
<p>Note: it is considered an error to call this function before the
<a class="link" href="CoglGstVideoSink.html#CoglGstVideoSink-pipeline-ready" title="The “pipeline-ready” signal"><span class="type">“pipeline-ready”</span></a> signal is emitted.</p>
<div class="refsect3">
<a name="id-1.2.3.2.9.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>sink</p></td>
<td class="parameter_description"><p>The <a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="type">CoglGstVideoSink</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pipeline</p></td>
<td class="parameter_description"><p>A <span class="type">CoglPipeline</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 1.16</p>
</div>
<hr>
<div class="refsect2">
<a name="cogl-gst-video-sink-get-free-layer"></a><h3>cogl_gst_video_sink_get_free_layer ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
cogl_gst_video_sink_get_free_layer (<em class="parameter"><code><a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="type">CoglGstVideoSink</span></a> *sink</code></em>);</pre>
<p>This can be used when doing specialised rendering of the video by
customizing the pipeline. <a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="type">CoglGstVideoSink</span></a> may use up to three
private layers on the pipeline in order to attach the textures of
the video frame. This function will return the index of the next
available unused layer after the sink's internal layers. This can
be used by the application to add additional layers, for example to
blend in another color in the fragment processing.</p>
<div class="refsect3">
<a name="id-1.2.3.2.9.7.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>sink</p></td>
<td class="parameter_description"><p>The <a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="type">CoglGstVideoSink</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.2.9.7.6"></a><h4>Returns</h4>
<p> the index of the next available layer after the
sink's internal layers.</p>
</div>
<p class="since">Since: 1.16</p>
</div>
<hr>
<div class="refsect2">
<a name="cogl-gst-video-sink-set-first-layer"></a><h3>cogl_gst_video_sink_set_first_layer ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cogl_gst_video_sink_set_first_layer (<em class="parameter"><code><a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="type">CoglGstVideoSink</span></a> *sink</code></em>,
                                     <em class="parameter"><code><span class="type">int</span> first_layer</code></em>);</pre>
<p>Sets the index of the first layer that the sink will use for its
rendering. This is useful if the application wants to have custom
layers that appear before the layers added by the sink. In that
case by default the sink's layers will be modulated with the result
of the application's layers that come before <em class="parameter"><code>first_layer</code></em>
.</p>
<p>Note that if this function is called then the name of the function
to call in the shader snippets to sample the video will also
change. For example, if <em class="parameter"><code>first_layer</code></em>
 is three then the function
will be cogl_gst_sample_video3.</p>
<div class="refsect3">
<a name="id-1.2.3.2.9.8.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>sink</p></td>
<td class="parameter_description"><p>The <a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="type">CoglGstVideoSink</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>first_layer</p></td>
<td class="parameter_description"><p>The new first layer</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 1.16</p>
</div>
<hr>
<div class="refsect2">
<a name="cogl-gst-video-sink-set-default-sample"></a><h3>cogl_gst_video_sink_set_default_sample ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cogl_gst_video_sink_set_default_sample
                               (<em class="parameter"><code><a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="type">CoglGstVideoSink</span></a> *sink</code></em>,
                                <em class="parameter"><code><span class="type">CoglBool</span> default_sample</code></em>);</pre>
<p>By default the pipeline generated by
<a class="link" href="CoglGstVideoSink.html#cogl-gst-video-sink-setup-pipeline" title="cogl_gst_video_sink_setup_pipeline ()"><code class="function">cogl_gst_video_sink_setup_pipeline()</code></a> and
<a class="link" href="CoglGstVideoSink.html#cogl-gst-video-sink-get-pipeline" title="cogl_gst_video_sink_get_pipeline ()"><code class="function">cogl_gst_video_sink_get_pipeline()</code></a> will have a layer with a shader
snippet that automatically samples the video. If the application
wants to sample the video in a completely custom way using its own
shader snippet it can set <em class="parameter"><code>default_sample</code></em>
 to <code class="literal">FALSE</code> to avoid this
default snippet being added. In that case the application's snippet
can call cogl_gst_sample_video0 to sample the texture itself.</p>
<div class="refsect3">
<a name="id-1.2.3.2.9.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>sink</p></td>
<td class="parameter_description"><p>The <a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="type">CoglGstVideoSink</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>default_sample</p></td>
<td class="parameter_description"><p>Whether to add the default sampling</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 1.16</p>
</div>
<hr>
<div class="refsect2">
<a name="cogl-gst-video-sink-is-ready"></a><h3>cogl_gst_video_sink_is_ready ()</h3>
<pre class="programlisting"><span class="returnvalue">CoglBool</span>
cogl_gst_video_sink_is_ready (<em class="parameter"><code><a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="type">CoglGstVideoSink</span></a> *sink</code></em>);</pre>
<p>Returns whether the pipeline is ready and so
<a class="link" href="CoglGstVideoSink.html#cogl-gst-video-sink-get-pipeline" title="cogl_gst_video_sink_get_pipeline ()"><code class="function">cogl_gst_video_sink_get_pipeline()</code></a> and
<a class="link" href="CoglGstVideoSink.html#cogl-gst-video-sink-setup-pipeline" title="cogl_gst_video_sink_setup_pipeline ()"><code class="function">cogl_gst_video_sink_setup_pipeline()</code></a> can be called without causing error.</p>
<p>Note: Normally an application will wait until the
<a class="link" href="CoglGstVideoSink.html#CoglGstVideoSink-pipeline-ready" title="The “pipeline-ready” signal"><span class="type">“pipeline-ready”</span></a> signal is emitted instead of
polling the ready status with this api, but sometimes when a sink
is passed between components that didn't have an opportunity to
connect a signal handler this can be useful.</p>
<div class="refsect3">
<a name="id-1.2.3.2.9.10.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>sink</p></td>
<td class="parameter_description"><p>The <a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="type">CoglGstVideoSink</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.2.9.10.7"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the sink is ready, else <code class="literal">FALSE</code></p>
</div>
<p class="since">Since: 1.16</p>
</div>
<hr>
<div class="refsect2">
<a name="cogl-gst-video-sink-get-aspect"></a><h3>cogl_gst_video_sink_get_aspect ()</h3>
<pre class="programlisting"><span class="returnvalue">float</span>
cogl_gst_video_sink_get_aspect (<em class="parameter"><code><a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="type">CoglGstVideoSink</span></a> *sink</code></em>);</pre>
<p>Returns a width-for-height aspect ratio that lets you calculate a
suitable width for displaying your video based on a given height by
multiplying your chosen height by the returned aspect ratio.</p>
<p>This aspect ratio is calculated based on the underlying size of the
video buffers and the current pixel-aspect-ratio.</p>
<div class="refsect3">
<a name="id-1.2.3.2.9.11.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>sink</p></td>
<td class="parameter_description"><p>A <a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="type">CoglGstVideoSink</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.2.9.11.7"></a><h4>Returns</h4>
<p> a width-for-height aspect ratio</p>
</div>
<p class="since">Since: 1.16</p>
<p class="stability">Stability Level: <acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.

The Unstable interface level is a warning that these interfaces are  subject to
change without warning and should not be used in unbundled products.

Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym></p>
</div>
<hr>
<div class="refsect2">
<a name="cogl-gst-video-sink-get-width-for-height"></a><h3>cogl_gst_video_sink_get_width_for_height ()</h3>
<pre class="programlisting"><span class="returnvalue">float</span>
cogl_gst_video_sink_get_width_for_height
                               (<em class="parameter"><code><a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="type">CoglGstVideoSink</span></a> *sink</code></em>,
                                <em class="parameter"><code><span class="type">float</span> height</code></em>);</pre>
<p>Calculates a suitable output width for a specific output <em class="parameter"><code>height</code></em>

that will maintain the video's aspect ratio.</p>
<div class="refsect3">
<a name="id-1.2.3.2.9.12.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>sink</p></td>
<td class="parameter_description"><p>A <a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="type">CoglGstVideoSink</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>A specific output <em class="parameter"><code>height</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.2.9.12.6"></a><h4>Returns</h4>
<p> An output width for the given output <em class="parameter"><code>height</code></em>
.</p>
</div>
<p class="since">Since: 1.16</p>
<p class="stability">Stability Level: <acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.

The Unstable interface level is a warning that these interfaces are  subject to
change without warning and should not be used in unbundled products.

Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym></p>
</div>
<hr>
<div class="refsect2">
<a name="cogl-gst-video-sink-get-height-for-width"></a><h3>cogl_gst_video_sink_get_height_for_width ()</h3>
<pre class="programlisting"><span class="returnvalue">float</span>
cogl_gst_video_sink_get_height_for_width
                               (<em class="parameter"><code><a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="type">CoglGstVideoSink</span></a> *sink</code></em>,
                                <em class="parameter"><code><span class="type">float</span> width</code></em>);</pre>
<p>Calculates a suitable output height for a specific output <em class="parameter"><code>width</code></em>

that will maintain the video's aspect ratio.</p>
<div class="refsect3">
<a name="id-1.2.3.2.9.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>sink</p></td>
<td class="parameter_description"><p>A <a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="type">CoglGstVideoSink</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>A specific output <em class="parameter"><code>width</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.2.9.13.6"></a><h4>Returns</h4>
<p> An output height for the given output <em class="parameter"><code>width</code></em>
.</p>
</div>
<p class="since">Since: 1.16</p>
<p class="stability">Stability Level: <acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.

The Unstable interface level is a warning that these interfaces are  subject to
change without warning and should not be used in unbundled products.

Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym></p>
</div>
<hr>
<div class="refsect2">
<a name="cogl-gst-video-sink-fit-size"></a><h3>cogl_gst_video_sink_fit_size ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cogl_gst_video_sink_fit_size (<em class="parameter"><code><a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="type">CoglGstVideoSink</span></a> *sink</code></em>,
                              <em class="parameter"><code>const <span class="type">CoglGstRectangle</span> *available</code></em>,
                              <em class="parameter"><code><span class="type">CoglGstRectangle</span> *output</code></em>);</pre>
<p>Calculates a suitable <em class="parameter"><code>output</code></em>
 rectangle that can fit inside the
<em class="parameter"><code>available</code></em>
 space while maintaining the aspect ratio of the current
video.</p>
<p>Applications would typically use this api for "letterboxing" by
using this api to position a video inside a fixed screen space and
filling the remaining space with black borders.</p>
<div class="refsect3">
<a name="id-1.2.3.2.9.14.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>sink</p></td>
<td class="parameter_description"><p>A <a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="type">CoglGstVideoSink</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>available</p></td>
<td class="parameter_description"><p> The space available for video output. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>output</p></td>
<td class="parameter_description"><p> The return location for the calculated output position. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 1.16</p>
<p class="stability">Stability Level: <acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.

The Unstable interface level is a warning that these interfaces are  subject to
change without warning and should not be used in unbundled products.

Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym></p>
</div>
</div>
<div class="refsect1">
<a name="CoglGstVideoSink.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="CoglGstVideoSink-struct"></a><h3>struct CoglGstVideoSink</h3>
<pre class="programlisting">struct CoglGstVideoSink;</pre>
<p>The <a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="type">CoglGstVideoSink</span></a> structure contains only private data and
should be accessed using the provided API.</p>
<p class="since">Since: 1.16</p>
</div>
<hr>
<div class="refsect2">
<a name="CoglGstVideoSinkClass"></a><h3>struct CoglGstVideoSinkClass</h3>
<pre class="programlisting">struct CoglGstVideoSinkClass {
  void (* new_frame) (CoglGstVideoSink *sink);
  void (* pipeline_ready) (CoglGstVideoSink *sink);
};
</pre>
<div class="refsect3">
<a name="id-1.2.3.2.10.3.4"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="CoglGstVideoSinkClass.new-frame"></a>new_frame</code></em> ()</p></td>
<td class="struct_member_description"><p>handler for the <a class="link" href="CoglGstVideoSink.html#CoglGstVideoSink-new-frame" title="The “new-frame” signal"><span class="type">“new-frame”</span></a> signal</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="CoglGstVideoSinkClass.pipeline-ready"></a>pipeline_ready</code></em> ()</p></td>
<td class="struct_member_description"><p>handler for the <a class="link" href="CoglGstVideoSink.html#CoglGstVideoSink-pipeline-ready" title="The “pipeline-ready” signal"><span class="type">“pipeline-ready”</span></a> signal</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 1.16</p>
</div>
</div>
<div class="refsect1">
<a name="CoglGstVideoSink.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="CoglGstVideoSink--update-priority"></a><h3>The <code class="literal">“update-priority”</code> property</h3>
<pre class="programlisting">  “update-priority”          <span class="type">gint</span></pre>
<p>Priority of video updates in the thread.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: &gt;= -2147483647</p>
<p>Default value: 100</p>
</div>
</div>
<div class="refsect1">
<a name="CoglGstVideoSink.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="CoglGstVideoSink-new-frame"></a><h3>The <code class="literal">“new-frame”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="type">CoglGstVideoSink</span></a> *sink,
               <span class="type">gpointer</span>          user_data)</pre>
<p>The sink will emit this signal whenever there are new textures
available for a new frame of the video. After this signal is
emitted, an application can call <a class="link" href="CoglGstVideoSink.html#cogl-gst-video-sink-get-pipeline" title="cogl_gst_video_sink_get_pipeline ()"><code class="function">cogl_gst_video_sink_get_pipeline()</code></a>
to get a pipeline suitable for rendering the frame. If the
application is using a custom pipeline it can alternatively call
<a class="link" href="CoglGstVideoSink.html#cogl-gst-video-sink-attach-frame" title="cogl_gst_video_sink_attach_frame ()"><code class="function">cogl_gst_video_sink_attach_frame()</code></a> to attach the textures.</p>
<div class="refsect3">
<a name="id-1.2.3.2.12.2.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>sink</p></td>
<td class="parameter_description"><p>the <a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="type">CoglGstVideoSink</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
<p class="since">Since: 1.16</p>
</div>
<hr>
<div class="refsect2">
<a name="CoglGstVideoSink-pipeline-ready"></a><h3>The <code class="literal">“pipeline-ready”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="type">CoglGstVideoSink</span></a> *sink,
               <span class="type">gpointer</span>          user_data)</pre>
<p>The sink will emit this signal as soon as it has gathered enough
information from the video to configure a pipeline. If the
application wants to do some customized rendering, it can setup its
pipeline after this signal is emitted. The application's pipeline
will typically either be a copy of the one returned by
<a class="link" href="CoglGstVideoSink.html#cogl-gst-video-sink-get-pipeline" title="cogl_gst_video_sink_get_pipeline ()"><code class="function">cogl_gst_video_sink_get_pipeline()</code></a> or it can be a completely custom
pipeline which is setup using <a class="link" href="CoglGstVideoSink.html#cogl-gst-video-sink-setup-pipeline" title="cogl_gst_video_sink_setup_pipeline ()"><code class="function">cogl_gst_video_sink_setup_pipeline()</code></a>.</p>
<p>Note that it is an error to call either of those functions before
this signal is emitted. The <a class="link" href="CoglGstVideoSink.html#CoglGstVideoSink-new-frame" title="The “new-frame” signal"><span class="type">“new-frame”</span></a> signal
will only be emitted after the pipeline is ready so the application
could also create its pipeline in the handler for that.</p>
<div class="refsect3">
<a name="id-1.2.3.2.12.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>sink</p></td>
<td class="parameter_description"><p>the <a class="link" href="CoglGstVideoSink.html" title="CoglGstVideoSink"><span class="type">CoglGstVideoSink</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
<p class="since">Since: 1.16</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>