Initialize Tizen 2.3
[framework/multimedia/gstreamer0.10.git] / wearable / docs / gst / html / gstreamer-GstDateTime.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>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">
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="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>
22 </tr>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#gstreamer-GstDateTime.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#gstreamer-GstDateTime.description" class="shortcut">Description</a>
27 </td></tr>
28 </table>
29 <div class="refentry">
30 <a name="gstreamer-GstDateTime"></a><div class="titlepage"></div>
31 <div class="refnamediv"><table width="100%"><tr>
32 <td valign="top">
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>
35 </td>
36 <td valign="top" align="right"></td>
37 </tr></table></div>
38 <div class="refsynopsisdiv">
39 <a name="gstreamer-GstDateTime.synopsis"></a><h2>Synopsis</h2>
40 <pre class="synopsis">
41 #include &lt;gst/gst.h&gt;
42
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>);
74 </pre>
75 </div>
76 <div class="refsect1">
77 <a name="gstreamer-GstDateTime.description"></a><h2>Description</h2>
78 <p>
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.
81 </p>
82 <p>
83 Date information is handled using the proleptic Gregorian calendar.
84 </p>
85 <p>
86 Provides basic creation functions and accessor functions to its fields.
87 </p>
88 </div>
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>
94 <p>
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.
98 </p>
99 <p>
100 Use the acessor functions to get the stored values.
101 </p>
102 </div>
103 <hr>
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 ()
107 </pre>
108 <p>
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.
110 </p>
111 <div class="variablelist"><table border="0">
112 <col align="left" valign="top">
113 <tbody><tr>
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>
116 </tr></tbody>
117 </table></div>
118 <p class="since">Since 0.10.31</p>
119 </div>
120 <hr>
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>
124 <p>
125 Returns the day of this <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a>.
126 </p>
127 <div class="variablelist"><table border="0">
128 <col align="left" valign="top">
129 <tbody>
130 <tr>
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>
133 </td>
134 </tr>
135 <tr>
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>
138 </td>
139 </tr>
140 </tbody>
141 </table></div>
142 <p class="since">Since 0.10.31</p>
143 </div>
144 <hr>
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>
148 <p>
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..
150 </p>
151 <div class="variablelist"><table border="0">
152 <col align="left" valign="top">
153 <tbody>
154 <tr>
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>
157 </td>
158 </tr>
159 <tr>
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>
162 </td>
163 </tr>
164 </tbody>
165 </table></div>
166 <p class="since">Since 0.10.31</p>
167 </div>
168 <hr>
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>
172 <p>
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.
175 </p>
176 <div class="variablelist"><table border="0">
177 <col align="left" valign="top">
178 <tbody>
179 <tr>
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>
182 </td>
183 </tr>
184 <tr>
185 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
186 <td>the hour of the day</td>
187 </tr>
188 </tbody>
189 </table></div>
190 <p class="since">Since 0.10.31</p>
191 </div>
192 <hr>
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>
196 <p>
197 Retrieves the fractional part of the seconds in microseconds represented by
198 <em class="parameter"><code>datetime</code></em> in the gregorian calendar.
199 </p>
200 <div class="variablelist"><table border="0">
201 <col align="left" valign="top">
202 <tbody>
203 <tr>
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>
206 </td>
207 </tr>
208 <tr>
209 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
210 <td>the microsecond of the second</td>
211 </tr>
212 </tbody>
213 </table></div>
214 <p class="since">Since 0.10.31</p>
215 </div>
216 <hr>
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>
220 <p>
221 Retrieves the minute of the hour represented by <em class="parameter"><code>datetime</code></em> in the gregorian
222 calendar.
223 </p>
224 <div class="variablelist"><table border="0">
225 <col align="left" valign="top">
226 <tbody>
227 <tr>
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>
230 </td>
231 </tr>
232 <tr>
233 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
234 <td>the minute of the hour</td>
235 </tr>
236 </tbody>
237 </table></div>
238 <p class="since">Since 0.10.31</p>
239 </div>
240 <hr>
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>
244 <p>
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.
249 </p>
250 <div class="variablelist"><table border="0">
251 <col align="left" valign="top">
252 <tbody>
253 <tr>
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>
256 </td>
257 </tr>
258 <tr>
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>
261 </tr>
262 </tbody>
263 </table></div>
264 <p class="since">Since 0.10.31</p>
265 </div>
266 <hr>
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>
270 <p>
271 Retrieves the second of the minute represented by <em class="parameter"><code>datetime</code></em> in the gregorian
272 calendar.
273 </p>
274 <div class="variablelist"><table border="0">
275 <col align="left" valign="top">
276 <tbody>
277 <tr>
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>
280 </td>
281 </tr>
282 <tr>
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>
285 </td>
286 </tr>
287 </tbody>
288 </table></div>
289 <p class="since">Since 0.10.31</p>
290 </div>
291 <hr>
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>
295 <p>
296 Returns the year of this <a class="link" href="gstreamer-GstDateTime.html#GstDateTime" title="GstDateTime"><span class="type">GstDateTime</span></a>
297 </p>
298 <div class="variablelist"><table border="0">
299 <col align="left" valign="top">
300 <tbody>
301 <tr>
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>
304 </td>
305 </tr>
306 <tr>
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>
309 </td>
310 </tr>
311 </tbody>
312 </table></div>
313 <p class="since">Since 0.10.31</p>
314 </div>
315 <hr>
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>
325 <p>
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.
328 </p>
329 <p>
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.
332 </p>
333 <p>
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.
337 </p>
338 <p>
339 Free-function: gst_date_time_unref
340 </p>
341 <div class="variablelist"><table border="0">
342 <col align="left" valign="top">
343 <tbody>
344 <tr>
345 <td><p><span class="term"><em class="parameter"><code>tzoffset</code></em> :</span></p></td>
346 <td>Offset from UTC in hours.</td>
347 </tr>
348 <tr>
349 <td><p><span class="term"><em class="parameter"><code>year</code></em> :</span></p></td>
350 <td>the gregorian year</td>
351 </tr>
352 <tr>
353 <td><p><span class="term"><em class="parameter"><code>month</code></em> :</span></p></td>
354 <td>the gregorian month</td>
355 </tr>
356 <tr>
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>
359 </tr>
360 <tr>
361 <td><p><span class="term"><em class="parameter"><code>hour</code></em> :</span></p></td>
362 <td>the hour of the day</td>
363 </tr>
364 <tr>
365 <td><p><span class="term"><em class="parameter"><code>minute</code></em> :</span></p></td>
366 <td>the minute of the hour</td>
367 </tr>
368 <tr>
369 <td><p><span class="term"><em class="parameter"><code>seconds</code></em> :</span></p></td>
370 <td>the second of the minute</td>
371 </tr>
372 <tr>
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>
375 </td>
376 </tr>
377 </tbody>
378 </table></div>
379 <p class="since">Since 0.10.31</p>
380 </div>
381 <hr>
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>
386 <p>
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.
389 </p>
390 <p>
391 Free-function: gst_date_time_unref
392 </p>
393 <div class="variablelist"><table border="0">
394 <col align="left" valign="top">
395 <tbody>
396 <tr>
397 <td><p><span class="term"><em class="parameter"><code>secs</code></em> :</span></p></td>
398 <td>seconds from the Unix epoch</td>
399 </tr>
400 <tr>
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>
403 </td>
404 </tr>
405 </tbody>
406 </table></div>
407 <p class="since">Since 0.10.31</p>
408 </div>
409 <hr>
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>
414 <p>
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.
417 </p>
418 <p>
419 Free-function: gst_date_time_unref
420 </p>
421 <div class="variablelist"><table border="0">
422 <col align="left" valign="top">
423 <tbody>
424 <tr>
425 <td><p><span class="term"><em class="parameter"><code>secs</code></em> :</span></p></td>
426 <td>seconds from the Unix epoch</td>
427 </tr>
428 <tr>
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>
431 </td>
432 </tr>
433 </tbody>
434 </table></div>
435 <p class="since">Since 0.10.31</p>
436 </div>
437 <hr>
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>
446 <p>
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.
449 </p>
450 <p>
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.
453 </p>
454 <p>
455 Free-function: gst_date_time_unref
456 </p>
457 <div class="variablelist"><table border="0">
458 <col align="left" valign="top">
459 <tbody>
460 <tr>
461 <td><p><span class="term"><em class="parameter"><code>year</code></em> :</span></p></td>
462 <td>the gregorian year</td>
463 </tr>
464 <tr>
465 <td><p><span class="term"><em class="parameter"><code>month</code></em> :</span></p></td>
466 <td>the gregorian month</td>
467 </tr>
468 <tr>
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>
471 </tr>
472 <tr>
473 <td><p><span class="term"><em class="parameter"><code>hour</code></em> :</span></p></td>
474 <td>the hour of the day</td>
475 </tr>
476 <tr>
477 <td><p><span class="term"><em class="parameter"><code>minute</code></em> :</span></p></td>
478 <td>the minute of the hour</td>
479 </tr>
480 <tr>
481 <td><p><span class="term"><em class="parameter"><code>seconds</code></em> :</span></p></td>
482 <td>the second of the minute</td>
483 </tr>
484 <tr>
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>
487 </td>
488 </tr>
489 </tbody>
490 </table></div>
491 <p class="since">Since 0.10.31</p>
492 </div>
493 <hr>
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>
497 <p>
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.
499 </p>
500 <p>
501 Free-function: gst_date_time_unref
502 </p>
503 <div class="variablelist"><table border="0">
504 <col align="left" valign="top">
505 <tbody><tr>
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>
509 </td>
510 </tr></tbody>
511 </table></div>
512 <p class="since">Since 0.10.31</p>
513 </div>
514 <hr>
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>
518 <p>
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
520 coordinated time.
521 </p>
522 <p>
523 Free-function: gst_date_time_unref
524 </p>
525 <div class="variablelist"><table border="0">
526 <col align="left" valign="top">
527 <tbody><tr>
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>
531 </td>
532 </tr></tbody>
533 </table></div>
534 <p class="since">Since 0.10.31</p>
535 </div>
536 <hr>
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>
540 <p>
541 Atomically increments the reference count of <em class="parameter"><code>datetime</code></em> by one.
542 </p>
543 <div class="variablelist"><table border="0">
544 <col align="left" valign="top">
545 <tbody>
546 <tr>
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>
549 </td>
550 </tr>
551 <tr>
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>
554 </td>
555 </tr>
556 </tbody>
557 </table></div>
558 <p class="since">Since 0.10.31</p>
559 </div>
560 <hr>
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>
564 <p>
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.
567 </p>
568 <div class="variablelist"><table border="0">
569 <col align="left" valign="top">
570 <tbody><tr>
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>
573 </td>
574 </tr></tbody>
575 </table></div>
576 <p class="since">Since 0.10.31</p>
577 </div>
578 </div>
579 </div>
580 <div class="footer">
581 <hr>
582           Generated by GTK-Doc V1.18</div>
583 </body>
584 </html>