~ubuntu-branches/ubuntu/karmic/gst-plugins-base0.10/karmic-updates

« back to all changes in this revision

Viewing changes to docs/libs/html/gst-plugins-base-libs-gstaudioclock.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastian Dröge
  • Date: 2009-10-05 18:10:19 UTC
  • mfrom: (14.3.4 squeeze)
  • Revision ID: james.westby@ubuntu.com-20091005181019-vcb3daxz031og2sh
Tags: 0.10.25-1
* New upstream release, 'Standard disclaimers apply':
  + debian/libgstreamer-plugins-base.symbols:
    - Updated for the new version.

Show diffs side-by-side

added added

removed removed

Lines of Context:
62
62
 
63
63
                    <a class="link" href="gst-plugins-base-libs-gstaudioclock.html#GstAudioClock-struct" title="GstAudioClock">GstAudioClock</a>;
64
64
<a
65
 
href="../gstreamer-0.10/GstClock.html#GstClockTime"
 
65
href="/usr/share/gtk-doc/html/gstreamer-0.10/GstClock.html#GstClockTime"
66
66
>GstClockTime</a>        (<a class="link" href="gst-plugins-base-libs-gstaudioclock.html#GstAudioClockGetTimeFunc" title="GstAudioClockGetTimeFunc ()">*GstAudioClockGetTimeFunc</a>)         (<a
67
 
href="../gstreamer-0.10/GstClock.html"
 
67
href="/usr/share/gtk-doc/html/gstreamer-0.10/GstClock.html"
68
68
>GstClock</a> *clock,
69
69
                                                         <a
70
 
href="../glib/glib-Basic-Types.html#gpointer"
 
70
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
71
71
>gpointer</a> user_data);
72
72
<a
73
 
href="../gstreamer-0.10/GstClock.html"
 
73
href="/usr/share/gtk-doc/html/gstreamer-0.10/GstClock.html"
74
74
>GstClock</a>*           <a class="link" href="gst-plugins-base-libs-gstaudioclock.html#gst-audio-clock-new" title="gst_audio_clock_new ()">gst_audio_clock_new</a>                 (const <a
75
 
href="../glib/glib-Basic-Types.html#gchar"
 
75
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
76
76
>gchar</a> *name,
77
77
                                                         <a class="link" href="gst-plugins-base-libs-gstaudioclock.html#GstAudioClockGetTimeFunc" title="GstAudioClockGetTimeFunc ()">GstAudioClockGetTimeFunc</a> func,
78
78
                                                         <a
79
 
href="../glib/glib-Basic-Types.html#gpointer"
 
79
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
80
80
>gpointer</a> user_data);
81
81
</pre>
82
82
</div>
84
84
<a name="gst-plugins-base-libs-gstaudioclock.object-hierarchy"></a><h2>Object Hierarchy</h2>
85
85
<pre class="synopsis">
86
86
  <a
87
 
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
 
87
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
88
88
>GObject</a>
89
89
   +----<a
90
 
href="../gstreamer-0.10/GstObject.html"
 
90
href="/usr/share/gtk-doc/html/gstreamer-0.10/GstObject.html"
91
91
>GstObject</a>
92
92
         +----<a
93
 
href="../gstreamer-0.10/GstClock.html"
 
93
href="/usr/share/gtk-doc/html/gstreamer-0.10/GstClock.html"
94
94
>GstClock</a>
95
95
               +----<a
96
 
href="../gstreamer-0.10/GstSystemClock.html"
 
96
href="/usr/share/gtk-doc/html/gstreamer-0.10/GstSystemClock.html"
97
97
>GstSystemClock</a>
98
98
                     +----GstAudioClock
99
99
</pre>
102
102
<a name="gst-plugins-base-libs-gstaudioclock.description"></a><h2>Description</h2>
103
103
<p>
104
104
<a class="link" href="gst-plugins-base-libs-gstaudioclock.html#GstAudioClock"><span class="type">GstAudioClock</span></a> makes it easy for elements to implement a <a
105
 
href="../gstreamer-0.10/GstClock.html"
 
105
href="/usr/share/gtk-doc/html/gstreamer-0.10/GstClock.html"
106
106
><span class="type">GstClock</span></a>, they
107
107
simply need to provide a function that returns the current clock time.
108
108
</p>
132
132
<div class="refsect2" lang="en">
133
133
<a name="GstAudioClockGetTimeFunc"></a><h3>GstAudioClockGetTimeFunc ()</h3>
134
134
<pre class="programlisting"><a
135
 
href="../gstreamer-0.10/GstClock.html#GstClockTime"
 
135
href="/usr/share/gtk-doc/html/gstreamer-0.10/GstClock.html#GstClockTime"
136
136
>GstClockTime</a>        (*GstAudioClockGetTimeFunc)         (<a
137
 
href="../gstreamer-0.10/GstClock.html"
 
137
href="/usr/share/gtk-doc/html/gstreamer-0.10/GstClock.html"
138
138
>GstClock</a> *clock,
139
139
                                                         <a
140
 
href="../glib/glib-Basic-Types.html#gpointer"
 
140
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
141
141
>gpointer</a> user_data);</pre>
142
142
<p>
143
143
This function will be called whenever the current clock time needs to be
144
144
calculated. If this function returns <a
145
 
href="../gstreamer-0.10/GstClock.html#GST-CLOCK-TIME-NONE--CAPS"
 
145
href="/usr/share/gtk-doc/html/gstreamer-0.10/GstClock.html#GST-CLOCK-TIME-NONE--CAPS"
146
146
><span class="type">GST_CLOCK_TIME_NONE</span></a>, the last reported
147
147
time will be returned by the clock.</p>
148
148
<p>
163
163
<tr>
164
164
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
165
165
<td> the current time or <a
166
 
href="../gstreamer-0.10/GstClock.html#GST-CLOCK-TIME-NONE--CAPS"
 
166
href="/usr/share/gtk-doc/html/gstreamer-0.10/GstClock.html#GST-CLOCK-TIME-NONE--CAPS"
167
167
><span class="type">GST_CLOCK_TIME_NONE</span></a> if the previous time should
168
168
be used.
169
169
</td>
175
175
<div class="refsect2" lang="en">
176
176
<a name="gst-audio-clock-new"></a><h3>gst_audio_clock_new ()</h3>
177
177
<pre class="programlisting"><a
178
 
href="../gstreamer-0.10/GstClock.html"
 
178
href="/usr/share/gtk-doc/html/gstreamer-0.10/GstClock.html"
179
179
>GstClock</a>*           gst_audio_clock_new                 (const <a
180
 
href="../glib/glib-Basic-Types.html#gchar"
 
180
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
181
181
>gchar</a> *name,
182
182
                                                         <a class="link" href="gst-plugins-base-libs-gstaudioclock.html#GstAudioClockGetTimeFunc" title="GstAudioClockGetTimeFunc ()">GstAudioClockGetTimeFunc</a> func,
183
183
                                                         <a
184
 
href="../glib/glib-Basic-Types.html#gpointer"
 
184
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
185
185
>gpointer</a> user_data);</pre>
186
186
<p>
187
187
Create a new <a class="link" href="gst-plugins-base-libs-gstaudioclock.html#GstAudioClock"><span class="type">GstAudioClock</span></a> instance. Whenever the clock time should be
188
188
calculated it will call <em class="parameter"><code>func</code></em> with <em class="parameter"><code>user_data</code></em>. When <em class="parameter"><code>func</code></em> returns
189
189
<a
190
 
href="../gstreamer-0.10/GstClock.html#GST-CLOCK-TIME-NONE--CAPS"
 
190
href="/usr/share/gtk-doc/html/gstreamer-0.10/GstClock.html#GST-CLOCK-TIME-NONE--CAPS"
191
191
><span class="type">GST_CLOCK_TIME_NONE</span></a>, the clock will return the last reported time.</p>
192
192
<p>
193
193
</p>
212
212
<tr>
213
213
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
214
214
<td> a new <a class="link" href="gst-plugins-base-libs-gstaudioclock.html#GstAudioClock"><span class="type">GstAudioClock</span></a> casted to a <a
215
 
href="../gstreamer-0.10/GstClock.html"
 
215
href="/usr/share/gtk-doc/html/gstreamer-0.10/GstClock.html"
216
216
><span class="type">GstClock</span></a>.
217
217
</td>
218
218
</tr>
223
223
<div class="refsect1" lang="en">
224
224
<a name="gst-plugins-base-libs-gstaudioclock.see-also"></a><h2>See Also</h2>
225
225
#GstBaseAudioSink, <a
226
 
href="../gstreamer-0.10/GstSystemClock.html"
 
226
href="/usr/share/gtk-doc/html/gstreamer-0.10/GstSystemClock.html"
227
227
><span class="type">GstSystemClock</span></a>
228
228
</div>
229
229
</div>