1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>GstDateTime</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="GStreamer 0.10 Core Reference Manual">
8 <link rel="up" href="libgstreamer.html" title="GStreamer Core Library">
9 <link rel="prev" href="gstreamer-gstconfig.html" title="gstconfig">
10 <link rel="next" href="GstElement.html" title="GstElement">
11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
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">
17 <td><a accesskey="p" href="gstreamer-gstconfig.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="libgstreamer.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 0.10 Core Reference Manual</th>
21 <td><a accesskey="n" href="GstElement.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#gstreamer-GstDateTime.synopsis" class="shortcut">Top</a>
26 <a href="#gstreamer-GstDateTime.description" class="shortcut">Description</a>
29 <div class="refentry">
30 <a name="gstreamer-GstDateTime"></a><div class="titlepage"></div>
31 <div class="refnamediv"><table width="100%"><tr>
33 <h2><span class="refentrytitle"><a name="gstreamer-GstDateTime.top_of_page"></a>GstDateTime</span></h2>
34 <p>GstDateTime — A date, time and timezone structure</p>
36 <td valign="top" align="right"></td>
38 <div class="refsynopsisdiv">
39 <a name="gstreamer-GstDateTime.synopsis"></a><h2>Synopsis</h2>
40 <pre class="synopsis">
41 #include <gst/gst.h>
43 <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime">GstDateTime</a>;
44 #define <a class="link" href="gstreamer-GstDateTime.html#GST-TYPE-DATE-TIME:CAPS" title="GST_TYPE_DATE_TIME">GST_TYPE_DATE_TIME</a>
45 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="gstreamer-GstDateTime.html#gst-date-time-get-day" title="gst_date_time_get_day ()">gst_date_time_get_day</a> (<em class="parameter"><code>const <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a> *datetime</code></em>);
46 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="gstreamer-GstDateTime.html#gst-date-time-get-month" title="gst_date_time_get_month ()">gst_date_time_get_month</a> (<em class="parameter"><code>const <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a> *datetime</code></em>);
47 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="gstreamer-GstDateTime.html#gst-date-time-get-hour" title="gst_date_time_get_hour ()">gst_date_time_get_hour</a> (<em class="parameter"><code>const <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a> *datetime</code></em>);
48 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="gstreamer-GstDateTime.html#gst-date-time-get-microsecond" title="gst_date_time_get_microsecond ()">gst_date_time_get_microsecond</a> (<em class="parameter"><code>const <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a> *datetime</code></em>);
49 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="gstreamer-GstDateTime.html#gst-date-time-get-minute" title="gst_date_time_get_minute ()">gst_date_time_get_minute</a> (<em class="parameter"><code>const <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a> *datetime</code></em>);
50 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a> <a class="link" href="gstreamer-GstDateTime.html#gst-date-time-get-time-zone-offset" title="gst_date_time_get_time_zone_offset ()">gst_date_time_get_time_zone_offset</a> (<em class="parameter"><code>const <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a> *datetime</code></em>);
51 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="gstreamer-GstDateTime.html#gst-date-time-get-second" title="gst_date_time_get_second ()">gst_date_time_get_second</a> (<em class="parameter"><code>const <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a> *datetime</code></em>);
52 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="gstreamer-GstDateTime.html#gst-date-time-get-year" title="gst_date_time_get_year ()">gst_date_time_get_year</a> (<em class="parameter"><code>const <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a> *datetime</code></em>);
53 <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="returnvalue">GstDateTime</span></a> * <a class="link" href="gstreamer-GstDateTime.html#gst-date-time-new" title="gst_date_time_new ()">gst_date_time_new</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> tzoffset</code></em>,
54 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> year</code></em>,
55 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> month</code></em>,
56 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> day</code></em>,
57 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> hour</code></em>,
58 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> minute</code></em>,
59 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> seconds</code></em>);
60 <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="returnvalue">GstDateTime</span></a> * <a class="link" href="gstreamer-GstDateTime.html#gst-date-time-new-from-unix-epoch-local-time" title="gst_date_time_new_from_unix_epoch_local_time ()">gst_date_time_new_from_unix_epoch_local_time</a>
61 (<em class="parameter"><code><span class="type">gint64</span> secs</code></em>);
62 <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="returnvalue">GstDateTime</span></a> * <a class="link" href="gstreamer-GstDateTime.html#gst-date-time-new-from-unix-epoch-utc" title="gst_date_time_new_from_unix_epoch_utc ()">gst_date_time_new_from_unix_epoch_utc</a>
63 (<em class="parameter"><code><span class="type">gint64</span> secs</code></em>);
64 <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="returnvalue">GstDateTime</span></a> * <a class="link" href="gstreamer-GstDateTime.html#gst-date-time-new-local-time" title="gst_date_time_new_local_time ()">gst_date_time_new_local_time</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> year</code></em>,
65 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> month</code></em>,
66 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> day</code></em>,
67 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> hour</code></em>,
68 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> minute</code></em>,
69 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> seconds</code></em>);
70 <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="returnvalue">GstDateTime</span></a> * <a class="link" href="gstreamer-GstDateTime.html#gst-date-time-new-now-local-time" title="gst_date_time_new_now_local_time ()">gst_date_time_new_now_local_time</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
71 <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="returnvalue">GstDateTime</span></a> * <a class="link" href="gstreamer-GstDateTime.html#gst-date-time-new-now-utc" title="gst_date_time_new_now_utc ()">gst_date_time_new_now_utc</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
72 <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="returnvalue">GstDateTime</span></a> * <a class="link" href="gstreamer-GstDateTime.html#gst-date-time-ref" title="gst_date_time_ref ()">gst_date_time_ref</a> (<em class="parameter"><code><a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a> *datetime</code></em>);
73 <span class="returnvalue">void</span> <a class="link" href="gstreamer-GstDateTime.html#gst-date-time-unref" title="gst_date_time_unref ()">gst_date_time_unref</a> (<em class="parameter"><code><a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a> *datetime</code></em>);
76 <div class="refsect1">
77 <a name="gstreamer-GstDateTime.description"></a><h2>Description</h2>
79 Struct to store date, time and timezone information altogether.
80 <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a> is refcounted and immutable.
83 Date information is handled using the proleptic Gregorian calendar.
86 Provides basic creation functions and accessor functions to its fields.
89 <div class="refsect1">
90 <a name="gstreamer-GstDateTime.details"></a><h2>Details</h2>
91 <div class="refsect2">
92 <a name="GstDateTime"></a><h3>GstDateTime</h3>
93 <pre class="programlisting">typedef struct _GstDateTime GstDateTime;</pre>
95 Opaque, immutable, refcounted struct that stores date, time and timezone
96 information. It currently supports ranges from 0001-01-01 to
97 9999-12-31 in the Gregorian proleptic calendar.
100 Use the acessor functions to get the stored values.
104 <div class="refsect2">
105 <a name="GST-TYPE-DATE-TIME:CAPS"></a><h3>GST_TYPE_DATE_TIME</h3>
106 <pre class="programlisting">#define GST_TYPE_DATE_TIME gst_date_time_get_type ()
109 a boxed <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> type for <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a> that represents a date and time.
111 <div class="variablelist"><table border="0">
112 <col align="left" valign="top">
114 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
115 <td>the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> of GstDateTime</td>
118 <p class="since">Since 0.10.31</p>
121 <div class="refsect2">
122 <a name="gst-date-time-get-day"></a><h3>gst_date_time_get_day ()</h3>
123 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gst_date_time_get_day (<em class="parameter"><code>const <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a> *datetime</code></em>);</pre>
125 Returns the day of this <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a>.
127 <div class="variablelist"><table border="0">
128 <col align="left" valign="top">
131 <td><p><span class="term"><em class="parameter"><code>datetime</code></em> :</span></p></td>
132 <td>a <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a>
136 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
137 <td>The day of this <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a>
142 <p class="since">Since 0.10.31</p>
145 <div class="refsect2">
146 <a name="gst-date-time-get-month"></a><h3>gst_date_time_get_month ()</h3>
147 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gst_date_time_get_month (<em class="parameter"><code>const <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a> *datetime</code></em>);</pre>
149 Returns the month of this <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a>. January is 1, February is 2, etc..
151 <div class="variablelist"><table border="0">
152 <col align="left" valign="top">
155 <td><p><span class="term"><em class="parameter"><code>datetime</code></em> :</span></p></td>
156 <td>a <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a>
160 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
161 <td>The month of this <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a>
166 <p class="since">Since 0.10.31</p>
169 <div class="refsect2">
170 <a name="gst-date-time-get-hour"></a><h3>gst_date_time_get_hour ()</h3>
171 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gst_date_time_get_hour (<em class="parameter"><code>const <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a> *datetime</code></em>);</pre>
173 Retrieves the hour of the day represented by <em class="parameter"><code>datetime</code></em> in the gregorian
174 calendar. The return is in the range of 0 to 23.
176 <div class="variablelist"><table border="0">
177 <col align="left" valign="top">
180 <td><p><span class="term"><em class="parameter"><code>datetime</code></em> :</span></p></td>
181 <td>a <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a>
185 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
186 <td>the hour of the day</td>
190 <p class="since">Since 0.10.31</p>
193 <div class="refsect2">
194 <a name="gst-date-time-get-microsecond"></a><h3>gst_date_time_get_microsecond ()</h3>
195 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gst_date_time_get_microsecond (<em class="parameter"><code>const <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a> *datetime</code></em>);</pre>
197 Retrieves the fractional part of the seconds in microseconds represented by
198 <em class="parameter"><code>datetime</code></em> in the gregorian calendar.
200 <div class="variablelist"><table border="0">
201 <col align="left" valign="top">
204 <td><p><span class="term"><em class="parameter"><code>datetime</code></em> :</span></p></td>
205 <td>a <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a>
209 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
210 <td>the microsecond of the second</td>
214 <p class="since">Since 0.10.31</p>
217 <div class="refsect2">
218 <a name="gst-date-time-get-minute"></a><h3>gst_date_time_get_minute ()</h3>
219 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gst_date_time_get_minute (<em class="parameter"><code>const <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a> *datetime</code></em>);</pre>
221 Retrieves the minute of the hour represented by <em class="parameter"><code>datetime</code></em> in the gregorian
224 <div class="variablelist"><table border="0">
225 <col align="left" valign="top">
228 <td><p><span class="term"><em class="parameter"><code>datetime</code></em> :</span></p></td>
229 <td>a <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a>
233 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
234 <td>the minute of the hour</td>
238 <p class="since">Since 0.10.31</p>
241 <div class="refsect2">
242 <a name="gst-date-time-get-time-zone-offset"></a><h3>gst_date_time_get_time_zone_offset ()</h3>
243 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a> gst_date_time_get_time_zone_offset (<em class="parameter"><code>const <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a> *datetime</code></em>);</pre>
245 Retrieves the offset from UTC in hours that the timezone specified
246 by <em class="parameter"><code>datetime</code></em> represents. Timezones ahead (to the east) of UTC have positive
247 values, timezones before (to the west) of UTC have negative values.
248 If <em class="parameter"><code>datetime</code></em> represents UTC time, then the offset is zero.
250 <div class="variablelist"><table border="0">
251 <col align="left" valign="top">
254 <td><p><span class="term"><em class="parameter"><code>datetime</code></em> :</span></p></td>
255 <td>a <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a>
259 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
260 <td>the offset from UTC in hours</td>
264 <p class="since">Since 0.10.31</p>
267 <div class="refsect2">
268 <a name="gst-date-time-get-second"></a><h3>gst_date_time_get_second ()</h3>
269 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gst_date_time_get_second (<em class="parameter"><code>const <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a> *datetime</code></em>);</pre>
271 Retrieves the second of the minute represented by <em class="parameter"><code>datetime</code></em> in the gregorian
274 <div class="variablelist"><table border="0">
275 <col align="left" valign="top">
278 <td><p><span class="term"><em class="parameter"><code>datetime</code></em> :</span></p></td>
279 <td>a <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a>
283 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
284 <td>the second represented by <em class="parameter"><code>datetime</code></em>
289 <p class="since">Since 0.10.31</p>
292 <div class="refsect2">
293 <a name="gst-date-time-get-year"></a><h3>gst_date_time_get_year ()</h3>
294 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gst_date_time_get_year (<em class="parameter"><code>const <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a> *datetime</code></em>);</pre>
296 Returns the year of this <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a>
298 <div class="variablelist"><table border="0">
299 <col align="left" valign="top">
302 <td><p><span class="term"><em class="parameter"><code>datetime</code></em> :</span></p></td>
303 <td>a <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a>
307 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
308 <td>The year of this <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a>
313 <p class="since">Since 0.10.31</p>
316 <div class="refsect2">
317 <a name="gst-date-time-new"></a><h3>gst_date_time_new ()</h3>
318 <pre class="programlisting"><a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="returnvalue">GstDateTime</span></a> * gst_date_time_new (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> tzoffset</code></em>,
319 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> year</code></em>,
320 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> month</code></em>,
321 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> day</code></em>,
322 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> hour</code></em>,
323 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> minute</code></em>,
324 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> seconds</code></em>);</pre>
326 Creates a new <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a> using the date and times in the gregorian calendar
327 in the supplied timezone.
330 <em class="parameter"><code>year</code></em> should be from 1 to 9999, <em class="parameter"><code>month</code></em> should be from 1 to 12, <em class="parameter"><code>day</code></em> from
331 1 to 31, <em class="parameter"><code>hour</code></em> from 0 to 23, <em class="parameter"><code>minutes</code></em> and <em class="parameter"><code>seconds</code></em> from 0 to 59.
334 Note that <em class="parameter"><code>tzoffset</code></em> is a float and was chosen so for being able to handle
335 some fractional timezones, while it still keeps the readability of
336 represeting it in hours for most timezones.
339 Free-function: gst_date_time_unref
341 <div class="variablelist"><table border="0">
342 <col align="left" valign="top">
345 <td><p><span class="term"><em class="parameter"><code>tzoffset</code></em> :</span></p></td>
346 <td>Offset from UTC in hours.</td>
349 <td><p><span class="term"><em class="parameter"><code>year</code></em> :</span></p></td>
350 <td>the gregorian year</td>
353 <td><p><span class="term"><em class="parameter"><code>month</code></em> :</span></p></td>
354 <td>the gregorian month</td>
357 <td><p><span class="term"><em class="parameter"><code>day</code></em> :</span></p></td>
358 <td>the day of the gregorian month</td>
361 <td><p><span class="term"><em class="parameter"><code>hour</code></em> :</span></p></td>
362 <td>the hour of the day</td>
365 <td><p><span class="term"><em class="parameter"><code>minute</code></em> :</span></p></td>
366 <td>the minute of the hour</td>
369 <td><p><span class="term"><em class="parameter"><code>seconds</code></em> :</span></p></td>
370 <td>the second of the minute</td>
373 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
374 <td>the newly created <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
379 <p class="since">Since 0.10.31</p>
382 <div class="refsect2">
383 <a name="gst-date-time-new-from-unix-epoch-local-time"></a><h3>gst_date_time_new_from_unix_epoch_local_time ()</h3>
384 <pre class="programlisting"><a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="returnvalue">GstDateTime</span></a> * gst_date_time_new_from_unix_epoch_local_time
385 (<em class="parameter"><code><span class="type">gint64</span> secs</code></em>);</pre>
387 Creates a new <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a> using the time since Jan 1, 1970 specified by
388 <em class="parameter"><code>secs</code></em>. The <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a> is in the local timezone.
391 Free-function: gst_date_time_unref
393 <div class="variablelist"><table border="0">
394 <col align="left" valign="top">
397 <td><p><span class="term"><em class="parameter"><code>secs</code></em> :</span></p></td>
398 <td>seconds from the Unix epoch</td>
401 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
402 <td>the newly created <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
407 <p class="since">Since 0.10.31</p>
410 <div class="refsect2">
411 <a name="gst-date-time-new-from-unix-epoch-utc"></a><h3>gst_date_time_new_from_unix_epoch_utc ()</h3>
412 <pre class="programlisting"><a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="returnvalue">GstDateTime</span></a> * gst_date_time_new_from_unix_epoch_utc
413 (<em class="parameter"><code><span class="type">gint64</span> secs</code></em>);</pre>
415 Creates a new <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a> using the time since Jan 1, 1970 specified by
416 <em class="parameter"><code>secs</code></em>. The <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a> is in the UTC timezone.
419 Free-function: gst_date_time_unref
421 <div class="variablelist"><table border="0">
422 <col align="left" valign="top">
425 <td><p><span class="term"><em class="parameter"><code>secs</code></em> :</span></p></td>
426 <td>seconds from the Unix epoch</td>
429 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
430 <td>the newly created <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
435 <p class="since">Since 0.10.31</p>
438 <div class="refsect2">
439 <a name="gst-date-time-new-local-time"></a><h3>gst_date_time_new_local_time ()</h3>
440 <pre class="programlisting"><a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="returnvalue">GstDateTime</span></a> * gst_date_time_new_local_time (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> year</code></em>,
441 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> month</code></em>,
442 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> day</code></em>,
443 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> hour</code></em>,
444 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> minute</code></em>,
445 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> seconds</code></em>);</pre>
447 Creates a new <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a> using the date and times in the gregorian calendar
448 in the local timezone.
451 <em class="parameter"><code>year</code></em> should be from 1 to 9999, <em class="parameter"><code>month</code></em> should be from 1 to 12, <em class="parameter"><code>day</code></em> from
452 1 to 31, <em class="parameter"><code>hour</code></em> from 0 to 23, <em class="parameter"><code>minutes</code></em> and <em class="parameter"><code>seconds</code></em> from 0 to 59.
455 Free-function: gst_date_time_unref
457 <div class="variablelist"><table border="0">
458 <col align="left" valign="top">
461 <td><p><span class="term"><em class="parameter"><code>year</code></em> :</span></p></td>
462 <td>the gregorian year</td>
465 <td><p><span class="term"><em class="parameter"><code>month</code></em> :</span></p></td>
466 <td>the gregorian month</td>
469 <td><p><span class="term"><em class="parameter"><code>day</code></em> :</span></p></td>
470 <td>the day of the gregorian month</td>
473 <td><p><span class="term"><em class="parameter"><code>hour</code></em> :</span></p></td>
474 <td>the hour of the day</td>
477 <td><p><span class="term"><em class="parameter"><code>minute</code></em> :</span></p></td>
478 <td>the minute of the hour</td>
481 <td><p><span class="term"><em class="parameter"><code>seconds</code></em> :</span></p></td>
482 <td>the second of the minute</td>
485 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
486 <td>the newly created <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
491 <p class="since">Since 0.10.31</p>
494 <div class="refsect2">
495 <a name="gst-date-time-new-now-local-time"></a><h3>gst_date_time_new_now_local_time ()</h3>
496 <pre class="programlisting"><a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="returnvalue">GstDateTime</span></a> * gst_date_time_new_now_local_time (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
498 Creates a new <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a> representing the current date and time.
501 Free-function: gst_date_time_unref
503 <div class="variablelist"><table border="0">
504 <col align="left" valign="top">
506 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
507 <td>the newly created <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a> which should
508 be freed with <a class="link" href="gstreamer-GstDateTime.html#gst-date-time-unref" title="gst_date_time_unref ()"><code class="function">gst_date_time_unref()</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
512 <p class="since">Since 0.10.31</p>
515 <div class="refsect2">
516 <a name="gst-date-time-new-now-utc"></a><h3>gst_date_time_new_now_utc ()</h3>
517 <pre class="programlisting"><a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="returnvalue">GstDateTime</span></a> * gst_date_time_new_now_utc (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
519 Creates a new <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a> that represents the current instant at Universal
523 Free-function: gst_date_time_unref
525 <div class="variablelist"><table border="0">
526 <col align="left" valign="top">
528 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
529 <td>the newly created <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a> which should
530 be freed with <a class="link" href="gstreamer-GstDateTime.html#gst-date-time-unref" title="gst_date_time_unref ()"><code class="function">gst_date_time_unref()</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
534 <p class="since">Since 0.10.31</p>
537 <div class="refsect2">
538 <a name="gst-date-time-ref"></a><h3>gst_date_time_ref ()</h3>
539 <pre class="programlisting"><a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="returnvalue">GstDateTime</span></a> * gst_date_time_ref (<em class="parameter"><code><a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a> *datetime</code></em>);</pre>
541 Atomically increments the reference count of <em class="parameter"><code>datetime</code></em> by one.
543 <div class="variablelist"><table border="0">
544 <col align="left" valign="top">
547 <td><p><span class="term"><em class="parameter"><code>datetime</code></em> :</span></p></td>
548 <td>a <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a>
552 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
553 <td>the reference <em class="parameter"><code>datetime</code></em>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
558 <p class="since">Since 0.10.31</p>
561 <div class="refsect2">
562 <a name="gst-date-time-unref"></a><h3>gst_date_time_unref ()</h3>
563 <pre class="programlisting"><span class="returnvalue">void</span> gst_date_time_unref (<em class="parameter"><code><a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a> *datetime</code></em>);</pre>
565 Atomically decrements the reference count of <em class="parameter"><code>datetime</code></em> by one. When the
566 reference count reaches zero, the structure is freed.
568 <div class="variablelist"><table border="0">
569 <col align="left" valign="top">
571 <td><p><span class="term"><em class="parameter"><code>datetime</code></em> :</span></p></td>
572 <td>a <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
576 <p class="since">Since 0.10.31</p>
582 Generated by GTK-Doc V1.18</div>