Tizen 2.0 Release
[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.76.1">
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.18 (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>"                     <span class="type">guint64</span>               : 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 <div class="refsynopsisdiv">
90 <h2>Synopsis</h2>
91 <div class="refsect2">
92 <a name="idp11928896"></a><h3>Element Information</h3>
93 <div class="variablelist"><table border="0">
94 <col align="left" valign="top">
95 <tbody>
96 <tr>
97 <td><p><span class="term">plugin</span></p></td>
98 <td>
99             <a class="link" href="gst-plugins-good-plugins-plugin-1394.html#plugin-1394">1394</a>
100           </td>
101 </tr>
102 <tr>
103 <td><p><span class="term">author</span></p></td>
104 <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>
105 </tr>
106 <tr>
107 <td><p><span class="term">class</span></p></td>
108 <td>Source/Video</td>
109 </tr>
110 </tbody>
111 </table></div>
112 </div>
113 <hr>
114 <div class="refsect2">
115 <a name="idp7349840"></a><h3>Element Pads</h3>
116 <div class="variablelist"><table border="0">
117 <col align="left" valign="top">
118 <tbody>
119 <tr>
120 <td><p><span class="term">name</span></p></td>
121 <td>src</td>
122 </tr>
123 <tr>
124 <td><p><span class="term">direction</span></p></td>
125 <td>source</td>
126 </tr>
127 <tr>
128 <td><p><span class="term">presence</span></p></td>
129 <td>always</td>
130 </tr>
131 <tr>
132 <td><p><span class="term">details</span></p></td>
133 <td>video/x-dv, format=(string){ NTSC, PAL }, systemstream=(boolean)true</td>
134 </tr>
135 </tbody>
136 </table></div>
137 </div>
138 </div>
139 <p>
140 </p>
141 </div>
142 <div class="refsect1">
143 <a name="gst-plugins-good-plugins-dv1394src.details"></a><h2>Details</h2>
144 <div class="refsect2">
145 <a name="GstDV1394Src-struct"></a><h3>struct GstDV1394Src</h3>
146 <pre class="programlisting">struct GstDV1394Src;</pre>
147 <p>
148 </p>
149 </div>
150 </div>
151 <div class="refsect1">
152 <a name="gst-plugins-good-plugins-dv1394src.property-details"></a><h2>Property Details</h2>
153 <div class="refsect2">
154 <a name="GstDV1394Src--channel"></a><h3>The <code class="literal">"channel"</code> property</h3>
155 <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>
156 <p>Channel number for listening.</p>
157 <p>Allowed values: [0,64]</p>
158 <p>Default value: 63</p>
159 </div>
160 <hr>
161 <div class="refsect2">
162 <a name="GstDV1394Src--consecutive"></a><h3>The <code class="literal">"consecutive"</code> property</h3>
163 <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>
164 <p>send n consecutive frames after skipping.</p>
165 <p>Allowed values: &gt;= 1</p>
166 <p>Default value: 1</p>
167 </div>
168 <hr>
169 <div class="refsect2">
170 <a name="GstDV1394Src--drop-incomplete"></a><h3>The <code class="literal">"drop-incomplete"</code> property</h3>
171 <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>
172 <p>drop incomplete frames.</p>
173 <p>Default value: TRUE</p>
174 </div>
175 <hr>
176 <div class="refsect2">
177 <a name="GstDV1394Src--guid"></a><h3>The <code class="literal">"guid"</code> property</h3>
178 <pre class="programlisting">  "guid"                     <span class="type">guint64</span>               : Read / Write</pre>
179 <p>select one of multiple DV devices by its GUID. use a hexadecimal like 0xhhhhhhhhhhhhhhhh. (0 = no guid).</p>
180 <p>Default value: 0</p>
181 </div>
182 <hr>
183 <div class="refsect2">
184 <a name="GstDV1394Src--port"></a><h3>The <code class="literal">"port"</code> property</h3>
185 <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>
186 <p>Port number (-1 automatic).</p>
187 <p>Allowed values: [G_MAXULONG,16]</p>
188 <p>Default value: -1</p>
189 </div>
190 <hr>
191 <div class="refsect2">
192 <a name="GstDV1394Src--skip"></a><h3>The <code class="literal">"skip"</code> property</h3>
193 <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>
194 <p>skip n frames.</p>
195 <p>Allowed values: &gt;= 0</p>
196 <p>Default value: 0</p>
197 </div>
198 <hr>
199 <div class="refsect2">
200 <a name="GstDV1394Src--use-avc"></a><h3>The <code class="literal">"use-avc"</code> property</h3>
201 <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>
202 <p>Use AV/C VTR control.</p>
203 <p>Default value: TRUE</p>
204 </div>
205 <hr>
206 <div class="refsect2">
207 <a name="GstDV1394Src--device-name"></a><h3>The <code class="literal">"device-name"</code> property</h3>
208 <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>
209 <p>user-friendly name of the device.</p>
210 <p>Default value: "Default"</p>
211 </div>
212 </div>
213 <div class="refsect1">
214 <a name="gst-plugins-good-plugins-dv1394src.signal-details"></a><h2>Signal Details</h2>
215 <div class="refsect2">
216 <a name="GstDV1394Src-frame-dropped"></a><h3>The <code class="literal">"frame-dropped"</code> signal</h3>
217 <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,
218                                                         <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>
219 <p>
220 </p>
221 <div class="variablelist"><table border="0">
222 <col align="left" valign="top">
223 <tbody>
224 <tr>
225 <td><p><span class="term"><em class="parameter"><code>gstdv1394src</code></em> :</span></p></td>
226 <td>the object which received the signal.</td>
227 </tr>
228 <tr>
229 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
230 <td>user data set when the signal handler was connected.</td>
231 </tr>
232 </tbody>
233 </table></div>
234 </div>
235 </div>
236 </div>
237 <div class="footer">
238 <hr>
239           Generated by GTK-Doc V1.18</div>
240 </body>
241 </html>