c6367c8d38f6e26510c2717a56aaa50212146161
[framework/multimedia/gst-plugins-good0.10.git] / docs / plugins / html / gst-plugins-good-plugins-dv1394src.html
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>dv1394src</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7 <link rel="home" href="index.html" title="GStreamer Good Plugins 0.10 Plugins Reference Manual">
8 <link rel="up" href="ch01.html" title="gst-plugins-good Elements">
9 <link rel="prev" href="gst-plugins-good-plugins-directsoundsink.html" title="directsoundsink">
10 <link rel="next" href="gst-plugins-good-plugins-dvdec.html" title="dvdec">
11 <meta name="generator" content="GTK-Doc V1.17 (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="2">
16 <tr valign="middle">
17 <td><a accesskey="p" href="gst-plugins-good-plugins-directsoundsink.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">GStreamer Good Plugins 0.10 Plugins Reference Manual</th>
21 <td><a accesskey="n" href="gst-plugins-good-plugins-dvdec.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22 </tr>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#gst-plugins-good-plugins-dv1394src.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#gst-plugins-good-plugins-dv1394src.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#gst-plugins-good-plugins-dv1394src.object-hierarchy" class="shortcut">Object Hierarchy</a>
29                    | 
30                   <a href="#gst-plugins-good-plugins-dv1394src.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
31                    | 
32                   <a href="#gst-plugins-good-plugins-dv1394src.properties" class="shortcut">Properties</a>
33                    | 
34                   <a href="#gst-plugins-good-plugins-dv1394src.signals" class="shortcut">Signals</a>
35 </td></tr>
36 </table>
37 <div class="refentry">
38 <a name="gst-plugins-good-plugins-dv1394src"></a><div class="titlepage"></div>
39 <div class="refnamediv"><table width="100%"><tr>
40 <td valign="top">
41 <h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-dv1394src.top_of_page"></a>dv1394src</span></h2>
42 <p>dv1394src — Source for DV video data from firewire port</p>
43 </td>
44 <td valign="top" align="right"></td>
45 </tr></table></div>
46 <div class="refsynopsisdiv">
47 <a name="gst-plugins-good-plugins-dv1394src.synopsis"></a><h2>Synopsis</h2>
48 <a name="GstDV1394Src"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-dv1394src.html#GstDV1394Src-struct" title="struct GstDV1394Src">GstDV1394Src</a>;
49 </pre>
50 </div>
51 <div class="refsect1">
52 <a name="gst-plugins-good-plugins-dv1394src.object-hierarchy"></a><h2>Object Hierarchy</h2>
53 <pre class="synopsis">
54   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
55    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
56          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
57                +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseSrc.html">GstBaseSrc</a>
58                      +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstPushSrc.html">GstPushSrc</a>
59                            +----GstDV1394Src
60 </pre>
61 </div>
62 <div class="refsect1">
63 <a name="gst-plugins-good-plugins-dv1394src.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
64 <p>
65 GstDV1394Src implements
66  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstUriHandler.html#GstURIHandler">GstURIHandler</a> and  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe">GstPropertyProbe</a>.</p>
67 </div>
68 <div class="refsect1">
69 <a name="gst-plugins-good-plugins-dv1394src.properties"></a><h2>Properties</h2>
70 <pre class="synopsis">
71   "<a class="link" href="gst-plugins-good-plugins-dv1394src.html#GstDV1394Src--channel" title='The "channel" property'>channel</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
72   "<a class="link" href="gst-plugins-good-plugins-dv1394src.html#GstDV1394Src--consecutive" title='The "consecutive" property'>consecutive</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
73   "<a class="link" href="gst-plugins-good-plugins-dv1394src.html#GstDV1394Src--drop-incomplete" title='The "drop-incomplete" property'>drop-incomplete</a>"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
74   "<a class="link" href="gst-plugins-good-plugins-dv1394src.html#GstDV1394Src--guid" title='The "guid" property'>guid</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a>               : Read / Write
75   "<a class="link" href="gst-plugins-good-plugins-dv1394src.html#GstDV1394Src--port" title='The "port" property'>port</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
76   "<a class="link" href="gst-plugins-good-plugins-dv1394src.html#GstDV1394Src--skip" title='The "skip" property'>skip</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
77   "<a class="link" href="gst-plugins-good-plugins-dv1394src.html#GstDV1394Src--use-avc" title='The "use-avc" property'>use-avc</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
78   "<a class="link" href="gst-plugins-good-plugins-dv1394src.html#GstDV1394Src--device-name" title='The "device-name" property'>device-name</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read
79 </pre>
80 </div>
81 <div class="refsect1">
82 <a name="gst-plugins-good-plugins-dv1394src.signals"></a><h2>Signals</h2>
83 <pre class="synopsis">
84   "<a class="link" href="gst-plugins-good-plugins-dv1394src.html#GstDV1394Src-frame-dropped" title='The "frame-dropped" signal'>frame-dropped</a>"                                  : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
85 </pre>
86 </div>
87 <div class="refsect1">
88 <a name="gst-plugins-good-plugins-dv1394src.description"></a><h2>Description</h2>
89 <p>
90 Read DV (digital video) data from firewire port.
91 </p>
92 <p>
93 </p>
94 <div class="refsect2">
95 <a name="idp9866928"></a><h3>Example launch line</h3>
96 <div class="informalexample">
97   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
98     <tbody>
99       <tr>
100         <td class="listing_lines" align="right"><pre>1</pre></td>
101         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch dv1394src <span class="gtkdoc opt">!</span> queue <span class="gtkdoc opt">!</span> dvdemux name<span class="gtkdoc opt">=</span>d <span class="gtkdoc opt">!</span> queue <span class="gtkdoc opt">!</span> dvdec <span class="gtkdoc opt">!</span> xvimagesink d<span class="gtkdoc opt">. !</span> queue <span class="gtkdoc opt">!</span> alsasink</pre></td>
102       </tr>
103     </tbody>
104   </table>
105 </div>
106  This pipeline captures from the firewire port and displays it (might need
107 format converters for audio/video).
108 </div>
109 <p>
110 </p>
111 <div class="refsynopsisdiv">
112 <h2>Synopsis</h2>
113 <div class="refsect2">
114 <a name="idp7464848"></a><h3>Element Information</h3>
115 <div class="variablelist"><table border="0">
116 <col align="left" valign="top">
117 <tbody>
118 <tr>
119 <td><p><span class="term">plugin</span></p></td>
120 <td>
121             <a class="link" href="gst-plugins-good-plugins-plugin-1394.html#plugin-1394">1394</a>
122           </td>
123 </tr>
124 <tr>
125 <td><p><span class="term">author</span></p></td>
126 <td>Erik Walthinsen &lt;omega@temple-baptist.com&gt;, Daniel Fischer &lt;dan@f3c.com&gt;, Wim Taymans &lt;wim@fluendo.com&gt;, Zaheer Abbas Merali &lt;zaheerabbas at merali dot org&gt;</td>
127 </tr>
128 <tr>
129 <td><p><span class="term">class</span></p></td>
130 <td>Source/Video</td>
131 </tr>
132 </tbody>
133 </table></div>
134 </div>
135 <hr>
136 <div class="refsect2">
137 <a name="idp10959920"></a><h3>Element Pads</h3>
138 <div class="variablelist"><table border="0">
139 <col align="left" valign="top">
140 <tbody>
141 <tr>
142 <td><p><span class="term">name</span></p></td>
143 <td>src</td>
144 </tr>
145 <tr>
146 <td><p><span class="term">direction</span></p></td>
147 <td>source</td>
148 </tr>
149 <tr>
150 <td><p><span class="term">presence</span></p></td>
151 <td>always</td>
152 </tr>
153 <tr>
154 <td><p><span class="term">details</span></p></td>
155 <td>video/x-dv, format=(string){ NTSC, PAL }, systemstream=(boolean)true</td>
156 </tr>
157 </tbody>
158 </table></div>
159 </div>
160 </div>
161 <p>
162 </p>
163 </div>
164 <div class="refsect1">
165 <a name="gst-plugins-good-plugins-dv1394src.details"></a><h2>Details</h2>
166 <div class="refsect2">
167 <a name="GstDV1394Src-struct"></a><h3>struct GstDV1394Src</h3>
168 <pre class="programlisting">struct GstDV1394Src;</pre>
169 <p>
170 </p>
171 </div>
172 </div>
173 <div class="refsect1">
174 <a name="gst-plugins-good-plugins-dv1394src.property-details"></a><h2>Property Details</h2>
175 <div class="refsect2">
176 <a name="GstDV1394Src--channel"></a><h3>The <code class="literal">"channel"</code> property</h3>
177 <pre class="programlisting">  "channel"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
178 <p>Channel number for listening.</p>
179 <p>Allowed values: [0,64]</p>
180 <p>Default value: 63</p>
181 </div>
182 <hr>
183 <div class="refsect2">
184 <a name="GstDV1394Src--consecutive"></a><h3>The <code class="literal">"consecutive"</code> property</h3>
185 <pre class="programlisting">  "consecutive"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
186 <p>send n consecutive frames after skipping.</p>
187 <p>Allowed values: &gt;= 1</p>
188 <p>Default value: 1</p>
189 </div>
190 <hr>
191 <div class="refsect2">
192 <a name="GstDV1394Src--drop-incomplete"></a><h3>The <code class="literal">"drop-incomplete"</code> property</h3>
193 <pre class="programlisting">  "drop-incomplete"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
194 <p>drop incomplete frames.</p>
195 <p>Default value: TRUE</p>
196 </div>
197 <hr>
198 <div class="refsect2">
199 <a name="GstDV1394Src--guid"></a><h3>The <code class="literal">"guid"</code> property</h3>
200 <pre class="programlisting">  "guid"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a>               : Read / Write</pre>
201 <p>select one of multiple DV devices by its GUID. use a hexadecimal like 0xhhhhhhhhhhhhhhhh. (0 = no guid).</p>
202 <p>Default value: 0</p>
203 </div>
204 <hr>
205 <div class="refsect2">
206 <a name="GstDV1394Src--port"></a><h3>The <code class="literal">"port"</code> property</h3>
207 <pre class="programlisting">  "port"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
208 <p>Port number (-1 automatic).</p>
209 <p>Allowed values: [G_MAXULONG,16]</p>
210 <p>Default value: -1</p>
211 </div>
212 <hr>
213 <div class="refsect2">
214 <a name="GstDV1394Src--skip"></a><h3>The <code class="literal">"skip"</code> property</h3>
215 <pre class="programlisting">  "skip"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
216 <p>skip n frames.</p>
217 <p>Allowed values: &gt;= 0</p>
218 <p>Default value: 0</p>
219 </div>
220 <hr>
221 <div class="refsect2">
222 <a name="GstDV1394Src--use-avc"></a><h3>The <code class="literal">"use-avc"</code> property</h3>
223 <pre class="programlisting">  "use-avc"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
224 <p>Use AV/C VTR control.</p>
225 <p>Default value: TRUE</p>
226 </div>
227 <hr>
228 <div class="refsect2">
229 <a name="GstDV1394Src--device-name"></a><h3>The <code class="literal">"device-name"</code> property</h3>
230 <pre class="programlisting">  "device-name"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read</pre>
231 <p>
232 Descriptive name of the currently opened device
233 </p>
234 <p>Default value: "Default"</p>
235 <p class="since">Since 0.10.7</p>
236 </div>
237 </div>
238 <div class="refsect1">
239 <a name="gst-plugins-good-plugins-dv1394src.signal-details"></a><h2>Signal Details</h2>
240 <div class="refsect2">
241 <a name="GstDV1394Src-frame-dropped"></a><h3>The <code class="literal">"frame-dropped"</code> signal</h3>
242 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="gst-plugins-good-plugins-dv1394src.html#GstDV1394Src"><span class="type">GstDV1394Src</span></a> *gstdv1394src,
243                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)         : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
244 <p>
245 </p>
246 <div class="variablelist"><table border="0">
247 <col align="left" valign="top">
248 <tbody>
249 <tr>
250 <td><p><span class="term"><em class="parameter"><code>gstdv1394src</code></em> :</span></p></td>
251 <td>the object which received the signal.</td>
252 </tr>
253 <tr>
254 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
255 <td>user data set when the signal handler was connected.</td>
256 </tr>
257 </tbody>
258 </table></div>
259 </div>
260 </div>
261 </div>
262 <div class="footer">
263 <hr>
264           Generated by GTK-Doc V1.17</div>
265 </body>
266 </html>