<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gstaudioclock</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" href="index.html" title="GStreamer Base Plugins 0.10 Library Reference Manual">
<link rel="up" href="gstreamer-audio.html" title="Audio Library">
<link rel="prev" href="gst-plugins-base-libs-gstaudio.html" title="gstaudio">
<link rel="next" href="gst-plugins-base-libs-gstaudiofilter.html" title="gstaudiofilter">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gstreamer-plugins-base.html" title="Part I. GStreamer Base Plugins Libraries">
<link rel="chapter" href="gstreamer-audio.html" title="Audio Library">
<link rel="chapter" href="gstreamer-cdda.html" title="CDDA Library">
<link rel="chapter" href="gstreamer-ffft.html" title="FFT Library">
<link rel="chapter" href="gstreamer-floatcast.html" title="FloatCast Library">
<link rel="chapter" href="gstreamer-interfaces.html" title="Interfaces Library">
<link rel="chapter" href="gstreamer-netbuffer.html" title="Network Buffer Library">
<link rel="chapter" href="gstreamer-riff.html" title="Riff Media Library">
<link rel="chapter" href="gstreamer-rtp.html" title="RTP Library">
<link rel="chapter" href="gstreamer-rtsp.html" title="RTSP Library">
<link rel="chapter" href="gstreamer-sdp.html" title="SDP Library">
<link rel="chapter" href="gstreamer-tag.html" title="Tag Support Library">
<link rel="chapter" href="gstreamer-base-utils.html" title="Base Utils Library">
<link rel="chapter" href="gstreamer-video.html" title="Video Library">
<link rel="part" href="gstreamer-libs-hierarchy.html" title="Part II. Object Hierarchy">
<link rel="index" href="api-index.html" title="Index">
</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="2">
<tr valign="middle">
<td><a accesskey="p" href="gst-plugins-base-libs-gstaudio.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="gstreamer-audio.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GStreamer Base Plugins 0.10 Library Reference Manual</th>
<td><a accesskey="n" href="gst-plugins-base-libs-gstaudiofilter.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2559240" class="shortcut">Top</a>
 | 
<a href="#id2559388" class="shortcut">Description</a>
 | 
<a href="#id2559339" class="shortcut">Object Hierarchy</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="gst-plugins-base-libs-gstaudioclock"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2559240"></a><span class="refentrytitle">gstaudioclock</span>
</h2>
<p>gstaudioclock — Helper object for implementing audio clocks</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<a name="GstAudioClock"></a><pre class="synopsis">
#include <gst/audio/gstaudioclock.h>
<a href="gst-plugins-base-libs-gstaudioclock.html#GstAudioClock-struct">GstAudioClock</a>;
GstClockTime (<a href="gst-plugins-base-libs-gstaudioclock.html#GstAudioClockGetTimeFunc">*GstAudioClockGetTimeFunc</a>) (GstClock *clock,
gpointer user_data);
GstClock* <a href="gst-plugins-base-libs-gstaudioclock.html#gst-audio-clock-new">gst_audio_clock_new</a> (gchar *name,
<a href="gst-plugins-base-libs-gstaudioclock.html#GstAudioClockGetTimeFunc">GstAudioClockGetTimeFunc</a> func,
gpointer user_data);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2559339"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GstObject
+----GstClock
+----GstSystemClock
+----GstAudioClock
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2559388"></a><h2>Description</h2>
<p>
<a href="gst-plugins-base-libs-gstaudioclock.html#GstAudioClock"><span class="type">GstAudioClock</span></a> makes it easy for elements to implement a <span class="type">GstClock</span>, they
simply need to provide a function that returns the current clock time.
</p>
<p>
This object is internally used to implement the clock in <a href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a>.
</p>
<p>
Last reviewed on 2006-09-27 (0.10.12)</p>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2559441"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2559451"></a><h3>
<a name="GstAudioClock-struct"></a>GstAudioClock</h3>
<a class="indexterm" name="id2559464"></a><pre class="programlisting">typedef struct _GstAudioClock GstAudioClock;</pre>
<p>
Opaque <a href="gst-plugins-base-libs-gstaudioclock.html#GstAudioClock"><span class="type">GstAudioClock</span></a>.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559492"></a><h3>
<a name="GstAudioClockGetTimeFunc"></a>GstAudioClockGetTimeFunc ()</h3>
<a class="indexterm" name="id2559504"></a><pre class="programlisting">GstClockTime (*GstAudioClockGetTimeFunc) (GstClock *clock,
gpointer user_data);</pre>
<p>
This function will be called whenever the current clock time needs to be
calculated. If this function returns <span class="type">GST_CLOCK_TIME_NONE</span>, the last reported
time will be returned by the clock.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>clock</code></em> :</span></td>
<td> the <a href="gst-plugins-base-libs-gstaudioclock.html#GstAudioClock"><span class="type">GstAudioClock</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td> user data
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the current time or <span class="type">GST_CLOCK_TIME_NONE</span> if the previous time should
be used.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559617"></a><h3>
<a name="gst-audio-clock-new"></a>gst_audio_clock_new ()</h3>
<a class="indexterm" name="id2559629"></a><pre class="programlisting">GstClock* gst_audio_clock_new (gchar *name,
<a href="gst-plugins-base-libs-gstaudioclock.html#GstAudioClockGetTimeFunc">GstAudioClockGetTimeFunc</a> func,
gpointer user_data);</pre>
<p>
Create a new <a href="gst-plugins-base-libs-gstaudioclock.html#GstAudioClock"><span class="type">GstAudioClock</span></a> instance. Whenever the clock time should be
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
<span class="type">GST_CLOCK_TIME_NONE</span>, the clock will return the last reported time.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> the name of the clock
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>func</code></em> :</span></td>
<td> a function
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td> user data
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a new <a href="gst-plugins-base-libs-gstaudioclock.html#GstAudioClock"><span class="type">GstAudioClock</span></a> casted to a <span class="type">GstClock</span>.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2559788"></a><h2>See Also</h2>
<a href="gst-plugins-base-libs-gstbaseaudiosink.html#GstBaseAudioSink"><span class="type">GstBaseAudioSink</span></a>, <span class="type">GstSystemClock</span>
</div>
</div>
</body>
</html>
