<refentry id="streamtuner-st-version-api">
<refmeta>
<refentrytitle>st-version</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>STREAMTUNER Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>st-version</refname><refpurpose>functions and variables for getting the streamtuner versions.</refpurpose>
</refnamediv>

<refsynopsisdiv><title>Synopsis</title>

<synopsis>



#define     <link linkend="ST-MAJOR-VERSION-CAPS">ST_MAJOR_VERSION</link>
#define     <link linkend="ST-MINOR-VERSION-CAPS">ST_MINOR_VERSION</link>
#define     <link linkend="ST-MICRO-VERSION-CAPS">ST_MICRO_VERSION</link>
#define     <link linkend="ST-API-MAJOR-VERSION-CAPS">ST_API_MAJOR_VERSION</link>
#define     <link linkend="ST-API-MINOR-VERSION-CAPS">ST_API_MINOR_VERSION</link>
extern      const unsigned int <link linkend="st-major-version">st_major_version</link>;
extern      const unsigned int <link linkend="st-minor-version">st_minor_version</link>;
extern      const unsigned int <link linkend="st-micro-version">st_micro_version</link>;
extern      const unsigned int <link linkend="st-api-major-version">st_api_major_version</link>;
extern      const unsigned int <link linkend="st-api-minor-version">st_api_minor_version</link>;
<link linkend="gboolean">gboolean</link>    <link linkend="st-check-api-version">st_check_api_version</link>            (unsigned <link linkend="int">int</link> required_major_version,
                                             unsigned <link linkend="int">int</link> minimum_minor_version);
</synopsis>
</refsynopsisdiv>









<refsect1>
<title>Description</title>
<para>

</para>
</refsect1>

<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="ST-MAJOR-VERSION-CAPS"/>ST_MAJOR_VERSION</title>
<indexterm><primary>ST_MAJOR_VERSION</primary></indexterm><programlisting>#define ST_MAJOR_VERSION		0
</programlisting>
<para>
The streamtuner major version number.
</para></refsect2>
<refsect2>
<title><anchor id="ST-MINOR-VERSION-CAPS"/>ST_MINOR_VERSION</title>
<indexterm><primary>ST_MINOR_VERSION</primary></indexterm><programlisting>#define ST_MINOR_VERSION		99
</programlisting>
<para>
The streamtuner minor version number.
</para></refsect2>
<refsect2>
<title><anchor id="ST-MICRO-VERSION-CAPS"/>ST_MICRO_VERSION</title>
<indexterm><primary>ST_MICRO_VERSION</primary></indexterm><programlisting>#define ST_MICRO_VERSION		99
</programlisting>
<para>
The streamtuner micro version number.
</para></refsect2>
<refsect2>
<title><anchor id="ST-API-MAJOR-VERSION-CAPS"/>ST_API_MAJOR_VERSION</title>
<indexterm><primary>ST_API_MAJOR_VERSION</primary></indexterm><programlisting>#define ST_API_MAJOR_VERSION		5
</programlisting>
<para>
The streamtuner API major version number, which is increased when
backwards compatibility is not preserved.
</para></refsect2>
<refsect2>
<title><anchor id="ST-API-MINOR-VERSION-CAPS"/>ST_API_MINOR_VERSION</title>
<indexterm><primary>ST_API_MINOR_VERSION</primary></indexterm><programlisting>#define ST_API_MINOR_VERSION		8
</programlisting>
<para>
The streamtuner API minor version number, which is increased when new
features are added, preserving backwards compatibility.
</para></refsect2>
<refsect2>
<title><anchor id="st-major-version"/>st_major_version</title>
<indexterm><primary>st_major_version</primary></indexterm><programlisting>extern const unsigned int st_major_version;
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="st-minor-version"/>st_minor_version</title>
<indexterm><primary>st_minor_version</primary></indexterm><programlisting>extern const unsigned int st_minor_version;
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="st-micro-version"/>st_micro_version</title>
<indexterm><primary>st_micro_version</primary></indexterm><programlisting>extern const unsigned int st_micro_version;
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="st-api-major-version"/>st_api_major_version</title>
<indexterm><primary>st_api_major_version</primary></indexterm><programlisting>extern const unsigned int st_api_major_version;
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="st-api-minor-version"/>st_api_minor_version</title>
<indexterm><primary>st_api_minor_version</primary></indexterm><programlisting>extern const unsigned int st_api_minor_version;
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="st-check-api-version"/>st_check_api_version ()</title>
<indexterm><primary>st_check_api_version</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    st_check_api_version            (unsigned <link linkend="int">int</link> required_major_version,
                                             unsigned <link linkend="int">int</link> minimum_minor_version);</programlisting>
<para>
Checks if the streamtuner API version matches
<parameter>required_major_version</parameter> and <parameter>minimum_minor_version</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>required_major_version</parameter>&nbsp;:</term>
<listitem><simpara> the required major API version.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>minimum_minor_version</parameter>&nbsp;:</term>
<listitem><simpara> the minimum minor API version.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if the requirements are met.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>
