blob: b344fbf2c8d459c05b009498bc8a6e3322b3097a [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GstVersion</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GStreamer 1.0 Core Reference Manual">
<link rel="up" href="libgstreamer.html" title="GStreamer Core Library">
<link rel="prev" href="gstreamer-GstValue.html" title="GstValue">
<link rel="next" href="gstreamer-support.html" title="GStreamer Core Support">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="gstreamer-GstValue.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgstreamer.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 1.0 Core Reference Manual</th>
<td><a accesskey="n" href="gstreamer-support.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#gstreamer-GstVersion.synopsis" class="shortcut">Top</a>
 | 
<a href="#gstreamer-GstVersion.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="gstreamer-GstVersion"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gstreamer-GstVersion.top_of_page"></a>GstVersion</span></h2>
<p>GstVersion — GStreamer version macros.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="gstreamer-GstVersion.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;gst/gst.h&gt;
#define <a class="link" href="gstreamer-GstVersion.html#GST-VERSION-MAJOR:CAPS" title="GST_VERSION_MAJOR">GST_VERSION_MAJOR</a>
#define <a class="link" href="gstreamer-GstVersion.html#GST-VERSION-MINOR:CAPS" title="GST_VERSION_MINOR">GST_VERSION_MINOR</a>
#define <a class="link" href="gstreamer-GstVersion.html#GST-VERSION-MICRO:CAPS" title="GST_VERSION_MICRO">GST_VERSION_MICRO</a>
#define <a class="link" href="gstreamer-GstVersion.html#GST-VERSION-NANO:CAPS" title="GST_VERSION_NANO">GST_VERSION_NANO</a>
#define <a class="link" href="gstreamer-GstVersion.html#GST-CHECK-VERSION:CAPS" title="GST_CHECK_VERSION()">GST_CHECK_VERSION</a> (major,
minor,
micro)
</pre>
</div>
<div class="refsect1">
<a name="gstreamer-GstVersion.description"></a><h2>Description</h2>
<p>
Use the GST_VERSION_* macros e.g. when defining own plugins. The GStreamer
runtime checks if these plugin and core version match and refuses to use a
plugin compiled against a different version of GStreamer.
You can also use the macros to keep the GStreamer version information in
your application.
</p>
<p>
Use the <a class="link" href="gstreamer-Gst.html#gst-version" title="gst_version ()"><code class="function">gst_version()</code></a> function if you want to know which version of
GStreamer you are currently linked against.
</p>
<p>
The version macros get defined by including "gst/gst.h".
</p>
</div>
<div class="refsect1">
<a name="gstreamer-GstVersion.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GST-VERSION-MAJOR:CAPS"></a><h3>GST_VERSION_MAJOR</h3>
<pre class="programlisting">#define GST_VERSION_MAJOR (1)
</pre>
<p>
The major version of GStreamer at compile time:
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-VERSION-MINOR:CAPS"></a><h3>GST_VERSION_MINOR</h3>
<pre class="programlisting">#define GST_VERSION_MINOR (0)
</pre>
<p>
The minor version of GStreamer at compile time:
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-VERSION-MICRO:CAPS"></a><h3>GST_VERSION_MICRO</h3>
<pre class="programlisting">#define GST_VERSION_MICRO (10)
</pre>
<p>
The micro version of GStreamer at compile time:
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-VERSION-NANO:CAPS"></a><h3>GST_VERSION_NANO</h3>
<pre class="programlisting">#define GST_VERSION_NANO (0)
</pre>
<p>
The nano version of GStreamer at compile time:
Actual releases have 0, GIT versions have 1, prerelease versions have 2-...
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-CHECK-VERSION:CAPS"></a><h3>GST_CHECK_VERSION()</h3>
<pre class="programlisting">#define GST_CHECK_VERSION(major,minor,micro)</pre>
<p>
Check whether a GStreamer version equal to or greater than
major.minor.micro is present.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>major</code></em> :</span></p></td>
<td>a number indicating the major version</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>minor</code></em> :</span></p></td>
<td>a number indicating the minor version</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>micro</code></em> :</span></p></td>
<td>a number indicating the micro version</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>