• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3<head>
4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5<title>decklinkaudiosrc: GStreamer Bad Plugins 1.0 Plugins Reference Manual</title>
6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7<link rel="home" href="index.html" title="GStreamer Bad Plugins 1.0 Plugins Reference Manual">
8<link rel="up" href="ch01.html" title="gst-plugins-bad Elements">
9<link rel="prev" href="gst-plugins-bad-plugins-decklinkaudiosink.html" title="decklinkaudiosink">
10<link rel="next" href="gst-plugins-bad-plugins-decklinkvideosink.html" title="decklinkvideosink">
11<meta name="generator" content="GTK-Doc V1.28 (XML mode)">
12<link rel="stylesheet" href="style.css" type="text/css">
13</head>
14<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16<td width="100%" align="left" class="shortcuts">
17<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span18                  <a href="#gst-plugins-bad-plugins-decklinkaudiosrc.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span19                  <a href="#gst-plugins-bad-plugins-decklinkaudiosrc.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span20                  <a href="#gst-plugins-bad-plugins-decklinkaudiosrc.properties" class="shortcut">Properties</a></span>
21</td>
22<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
23<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
24<td><a accesskey="p" href="gst-plugins-bad-plugins-decklinkaudiosink.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
25<td><a accesskey="n" href="gst-plugins-bad-plugins-decklinkvideosink.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
26</tr></table>
27<div class="refentry">
28<a name="gst-plugins-bad-plugins-decklinkaudiosrc"></a><div class="titlepage"></div>
29<div class="refnamediv"><table width="100%"><tr>
30<td valign="top">
31<h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-decklinkaudiosrc.top_of_page"></a>decklinkaudiosrc</span></h2>
32<p>decklinkaudiosrc — Inputs Audio from a BlackMagic DeckLink Device</p>
33</td>
34<td class="gallery_image" valign="top" align="right"></td>
35</tr></table></div>
36<div class="refsect1">
37<a name="gst-plugins-bad-plugins-decklinkaudiosrc.properties"></a><h2>Properties</h2>
38<div class="informaltable"><table class="informaltable" border="0">
39<colgroup>
40<col width="150px" class="properties_type">
41<col width="300px" class="properties_name">
42<col width="200px" class="properties_flags">
43</colgroup>
44<tbody>
45<tr>
46<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></td>
47<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-decklinkaudiosrc.html#GstDecklinkAudioSrc--alignment-threshold" title="The “alignment-threshold” property">alignment-threshold</a></td>
48<td class="property_flags">Read / Write</td>
49</tr>
50<tr>
51<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
52<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-decklinkaudiosrc.html#GstDecklinkAudioSrc--buffer-size" title="The “buffer-size” property">buffer-size</a></td>
53<td class="property_flags">Read / Write</td>
54</tr>
55<tr>
56<td class="property_type"><span class="type">GstDecklinkAudioConnection</span></td>
57<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-decklinkaudiosrc.html#GstDecklinkAudioSrc--connection" title="The “connection” property">connection</a></td>
58<td class="property_flags">Read / Write / Construct</td>
59</tr>
60<tr>
61<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
62<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-decklinkaudiosrc.html#GstDecklinkAudioSrc--device-number" title="The “device-number” property">device-number</a></td>
63<td class="property_flags">Read / Write / Construct</td>
64</tr>
65<tr>
66<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></td>
67<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-decklinkaudiosrc.html#GstDecklinkAudioSrc--discont-wait" title="The “discont-wait” property">discont-wait</a></td>
68<td class="property_flags">Read / Write</td>
69</tr>
70<tr>
71<td class="property_type"><span class="type">GstDecklinkAudioChannels</span></td>
72<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-decklinkaudiosrc.html#GstDecklinkAudioSrc--channels" title="The “channels” property">channels</a></td>
73<td class="property_flags">Read / Write / Construct</td>
74</tr>
75<tr>
76<td class="property_type">
77<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
78<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-decklinkaudiosrc.html#GstDecklinkAudioSrc--hw-serial-number" title="The “hw-serial-number” property">hw-serial-number</a></td>
79<td class="property_flags">Read</td>
80</tr>
81</tbody>
82</table></div>
83</div>
84<a name="GstDecklinkAudioSrc"></a><div class="refsect1">
85<a name="gst-plugins-bad-plugins-decklinkaudiosrc.other"></a><h2>Types and Values</h2>
86<div class="informaltable"><table class="informaltable" width="100%" border="0">
87<colgroup>
88<col width="150px" class="name">
89<col class="description">
90</colgroup>
91<tbody><tr>
92<td class="datatype_keyword">struct</td>
93<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-decklinkaudiosrc.html#GstDecklinkAudioSrc-struct" title="struct GstDecklinkAudioSrc">GstDecklinkAudioSrc</a></td>
94</tr></tbody>
95</table></div>
96</div>
97<div class="refsect1">
98<a name="gst-plugins-bad-plugins-decklinkaudiosrc.object-hierarchy"></a><h2>Object Hierarchy</h2>
99<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
100    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
101        <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a>
102            <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a>
103                <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseSrc.html#GstBaseSrc-struct">GstBaseSrc</a>
104                    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstPushSrc.html#GstPushSrc-struct">GstPushSrc</a>
105                        <span class="lineart">╰──</span> GstDecklinkAudioSrc
106</pre>
107</div>
108<div class="refsect1">
109<a name="gst-plugins-bad-plugins-decklinkaudiosrc.description"></a><h2>Description</h2>
110<p>Capture Video and Audio from a BlackMagic DeckLink Device. Can only be used
111in conjunction with decklinkvideosink.</p>
112<div class="refsect3">
113<a name="id-1.2.55.7.3"></a><h4>Sample pipeline</h4>
114<div class="informalexample">
115  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
116    <tbody>
117      <tr>
118        <td class="listing_lines" align="right"><pre>1
1192
1203</pre></td>
121        <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> \
122  decklinkvideosrc device<span class="gtkdoc opt">-</span>number<span class="gtkdoc opt">=</span><span class="number">0</span> mode<span class="gtkdoc opt">=</span><span class="number">1080</span>p25 <span class="gtkdoc opt">!</span> autovideosink \
123  decklinkaudiosrc device<span class="gtkdoc opt">-</span>number<span class="gtkdoc opt">=</span><span class="number">0</span> <span class="gtkdoc opt">!</span> autoaudiosink</pre></td>
124      </tr>
125    </tbody>
126  </table>
127</div>
128
129<p>
130Capturing 1080p25 video and audio from the SDI-In of Card 0. Devices are numbered
131starting with 0.</p>
132</div>
133<div class="refsynopsisdiv">
134<h2>Synopsis</h2>
135<div class="refsect2">
136<a name="id-1.2.55.7.4.1"></a><h3>Element Information</h3>
137<div class="variablelist"><table border="0" class="variablelist">
138<colgroup>
139<col align="left" valign="top">
140<col>
141</colgroup>
142<tbody>
143<tr>
144<td><p><span class="term">plugin</span></p></td>
145<td>
146            <a class="link" href="gst-plugins-bad-plugins-plugin-decklink.html#plugin-decklink">decklink</a>
147          </td>
148</tr>
149<tr>
150<td><p><span class="term">author</span></p></td>
151<td>David Schleef &lt;ds@entropywave.com&gt;, Sebastian Dröge &lt;sebastian@centricular.com&gt;</td>
152</tr>
153<tr>
154<td><p><span class="term">class</span></p></td>
155<td>Audio/Source/Hardware</td>
156</tr>
157</tbody>
158</table></div>
159</div>
160<hr>
161<div class="refsect2">
162<a name="id-1.2.55.7.4.2"></a><h3>Element Pads</h3>
163<div class="variablelist"><table border="0" class="variablelist">
164<colgroup>
165<col align="left" valign="top">
166<col>
167</colgroup>
168<tbody>
169<tr>
170<td><p><span class="term">name</span></p></td>
171<td>src</td>
172</tr>
173<tr>
174<td><p><span class="term">direction</span></p></td>
175<td>source</td>
176</tr>
177<tr>
178<td><p><span class="term">presence</span></p></td>
179<td>always</td>
180</tr>
181<tr>
182<td><p><span class="term">details</span></p></td>
183<td>audio/x-raw, format=(string){ S16LE, S32LE }, channels=(int)2, rate=(int)48000, layout=(string)interleaved</td>
184</tr>
185<tr>
186<td><p><span class="term"></span></p></td>
187<td> audio/x-raw, format=(string){ S16LE, S32LE }, channels=(int){ 8, 16 }, channel-mask=(bitmask)0x0000000000000000, rate=(int)48000, layout=(string)interleaved</td>
188</tr>
189</tbody>
190</table></div>
191</div>
192</div>
193</div>
194<div class="refsect1">
195<a name="gst-plugins-bad-plugins-decklinkaudiosrc.functions_details"></a><h2>Functions</h2>
196<p></p>
197</div>
198<div class="refsect1">
199<a name="gst-plugins-bad-plugins-decklinkaudiosrc.other_details"></a><h2>Types and Values</h2>
200<div class="refsect2">
201<a name="GstDecklinkAudioSrc-struct"></a><h3>struct GstDecklinkAudioSrc</h3>
202<pre class="programlisting">struct GstDecklinkAudioSrc;</pre>
203</div>
204</div>
205<div class="refsect1">
206<a name="gst-plugins-bad-plugins-decklinkaudiosrc.property-details"></a><h2>Property Details</h2>
207<div class="refsect2">
208<a name="GstDecklinkAudioSrc--alignment-threshold"></a><h3>The <code class="literal">“alignment-threshold”</code> property</h3>
209<pre class="programlisting">  “alignment-threshold”      <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></pre>
210<p>Timestamp alignment threshold in nanoseconds.</p>
211<p>Flags: Read / Write</p>
212<p>Allowed values: &lt;= 18446744073709551614</p>
213<p>Default value: 40000000</p>
214</div>
215<hr>
216<div class="refsect2">
217<a name="GstDecklinkAudioSrc--buffer-size"></a><h3>The <code class="literal">“buffer-size”</code> property</h3>
218<pre class="programlisting">  “buffer-size”              <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
219<p>Size of internal buffer in number of video frames.</p>
220<p>Flags: Read / Write</p>
221<p>Allowed values: [1,G_MAXINT]</p>
222<p>Default value: 5</p>
223</div>
224<hr>
225<div class="refsect2">
226<a name="GstDecklinkAudioSrc--connection"></a><h3>The <code class="literal">“connection”</code> property</h3>
227<pre class="programlisting">  “connection”               <span class="type">GstDecklinkAudioConnection</span></pre>
228<p>Audio input connection to use.</p>
229<p>Flags: Read / Write / Construct</p>
230<p>Default value: Automatic</p>
231</div>
232<hr>
233<div class="refsect2">
234<a name="GstDecklinkAudioSrc--device-number"></a><h3>The <code class="literal">“device-number”</code> property</h3>
235<pre class="programlisting">  “device-number”            <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
236<p>Output device instance to use.</p>
237<p>Flags: Read / Write / Construct</p>
238<p>Allowed values: &gt;= 0</p>
239<p>Default value: 0</p>
240</div>
241<hr>
242<div class="refsect2">
243<a name="GstDecklinkAudioSrc--discont-wait"></a><h3>The <code class="literal">“discont-wait”</code> property</h3>
244<pre class="programlisting">  “discont-wait”             <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></pre>
245<p>Window of time in nanoseconds to wait before creating a discontinuity.</p>
246<p>Flags: Read / Write</p>
247<p>Allowed values: &lt;= 18446744073709551614</p>
248<p>Default value: 1000000000</p>
249</div>
250<hr>
251<div class="refsect2">
252<a name="GstDecklinkAudioSrc--channels"></a><h3>The <code class="literal">“channels”</code> property</h3>
253<pre class="programlisting">  “channels”                 <span class="type">GstDecklinkAudioChannels</span></pre>
254<p>Audio channels.</p>
255<p>Flags: Read / Write / Construct</p>
256<p>Default value: 2 Channels</p>
257</div>
258<hr>
259<div class="refsect2">
260<a name="GstDecklinkAudioSrc--hw-serial-number"></a><h3>The <code class="literal">“hw-serial-number”</code> property</h3>
261<pre class="programlisting">  “hw-serial-number”         <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
262<p>The serial number (hardware ID) of the Decklink card.</p>
263<p>Flags: Read</p>
264<p>Default value: NULL</p>
265</div>
266</div>
267<div class="refsect1">
268<a name="gst-plugins-bad-plugins-decklinkaudiosrc.see-also"></a><h2>See Also</h2>
269<p>decklinkvideosrc</p>
270</div>
271</div>
272<div class="footer">
273<hr>Generated by GTK-Doc V1.28</div>
274</body>
275</html>