<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>st-util</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><link rel="start" href="index.html" title="streamtuner Developers Manual"><link rel="up" href="api-reference.html" title="API Reference"><link rel="prev" href="streamtuner-st-transfer-api.html" title="st-transfer"><link rel="next" href="streamtuner-st-version-api.html" title="st-version"><meta name="generator" content="GTK-Doc V1.2 (XML mode)"><style type="text/css"> .synopsis, .classsynopsis { background: #eeeeee; border: solid 1px #aaaaaa; padding: 0.5em; } .programlisting { background: #feffde; border: solid 1px #e9ed1c; padding: 0.5em; } .variablelist { padding: 4px; margin-left: 3em; } .navigation { background: #daffd1; border: solid 1px #74ff54; margin-top: 0.5em; margin-bottom: 0.5em; } .navigation a { color: #2fba0f; } .navigation a:visited { color: #22850b; } .navigation .title { font-size: 200%; } </style></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="streamtuner-st-transfer-api.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="api-reference.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">streamtuner Developers Manual</th><td><a accesskey="n" href="streamtuner-st-version-api.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="streamtuner-st-util-api"></a><div class="titlepage"></div><div class="refnamediv"><h2><span class="refentrytitle">st-util</span></h2><p>st-util — miscellaneous utility functions.</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis"> #define <a href="streamtuner-st-util-api.html#ST-NUMERIC-CAPS">ST_NUMERIC</a> char* <a href="streamtuner-st-util-api.html#st-format-bitrate">st_format_bitrate</a> (int bitrate); char* <a href="streamtuner-st-util-api.html#st-format-samplerate">st_format_samplerate</a> (int samplerate); char* <a href="streamtuner-st-util-api.html#st-format-channels">st_format_channels</a> (int channels); char* <a href="streamtuner-st-util-api.html#st-format-audio-properties">st_format_audio_properties</a> (int bitrate, int samplerate, int channels); char* <a href="streamtuner-st-util-api.html#st-strchr-span">st_strchr_span</a> (const char *str, int c); char* <a href="streamtuner-st-util-api.html#st-strstr-span">st_strstr_span</a> (const char *big, const char *little); char* <a href="streamtuner-st-util-api.html#st-str-has-prefix-span">st_str_has_prefix_span</a> (const char *str, const char *prefix); gboolean <a href="streamtuner-st-util-api.html#st-str-like">st_str_like</a> (const char *str, const char *charset); GdkPixbuf* <a href="streamtuner-st-util-api.html#st-pixbuf-new-from-file">st_pixbuf_new_from_file</a> (const char *filename); GtkWidget* <a href="streamtuner-st-util-api.html#st-hig-section-new">st_hig_section_new</a> (const char *title, GtkWidget *contents); void <a href="streamtuner-st-util-api.html#st-set-tooltip">st_set_tooltip</a> (GtkWidget *widget, const char *tooltip); </pre></div><div class="refsect1" lang="en"><a name="id2636993"></a><h2>Description</h2><p> </p></div><div class="refsect1" lang="en"><a name="id2637002"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2637076"></a><h3><a name="ST-NUMERIC-CAPS"></a>ST_NUMERIC</h3><a class="indexterm" name="id2637084"></a><pre class="programlisting">#define ST_NUMERIC "0123456789" </pre><p> </p></div><hr><div class="refsect2" lang="en"><a name="id2637099"></a><h3><a name="st-format-bitrate"></a>st_format_bitrate ()</h3><a class="indexterm" name="id2637108"></a><pre class="programlisting">char* st_format_bitrate (int bitrate);</pre><p> Formats <i class="parameter"><tt>bitrate</tt></i> as a string.</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>bitrate</tt></i> :</span></td><td> a bitrate to format, expressed in kilobits per seconds. </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> <i class="parameter"><tt>bitrate</tt></i> formatted as a string, which should be freed when no longer needed. </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2637174"></a><h3><a name="st-format-samplerate"></a>st_format_samplerate ()</h3><a class="indexterm" name="id2637182"></a><pre class="programlisting">char* st_format_samplerate (int samplerate);</pre><p> Formats <i class="parameter"><tt>samplerate</tt></i> as a string.</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>samplerate</tt></i> :</span></td><td> a samplerate to format, expressed in Hz. </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> <i class="parameter"><tt>samplerate</tt></i> formatted as a string, which should be freed when no longer needed. </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2637317"></a><h3><a name="st-format-channels"></a>st_format_channels ()</h3><a class="indexterm" name="id2637325"></a><pre class="programlisting">char* st_format_channels (int channels);</pre><p> Formats <i class="parameter"><tt>channels</tt></i> as a string.</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>channels</tt></i> :</span></td><td> a number of audio channels, which must be greater than 0. </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> <i class="parameter"><tt>channels</tt></i> formatted as a string, which should be freed when no longer needed. </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2637392"></a><h3><a name="st-format-audio-properties"></a>st_format_audio_properties ()</h3><a class="indexterm" name="id2637400"></a><pre class="programlisting">char* st_format_audio_properties (int bitrate, int samplerate, int channels);</pre><p> Formats <i class="parameter"><tt>bitrate</tt></i>, <i class="parameter"><tt>samplerate</tt></i> and <i class="parameter"><tt>channels</tt></i> as a string.</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>bitrate</tt></i> :</span></td><td> a bitrate expressed in kbps, or 0. </td></tr><tr><td><span class="term"><i class="parameter"><tt>samplerate</tt></i> :</span></td><td> a samplerate expressed in kbps, or 0. </td></tr><tr><td><span class="term"><i class="parameter"><tt>channels</tt></i> :</span></td><td> a number of audio channels, or 0. </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> a formatted string, which should be freed when no longer needed. </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2637512"></a><h3><a name="st-strchr-span"></a>st_strchr_span ()</h3><a class="indexterm" name="id2637521"></a><pre class="programlisting">char* st_strchr_span (const char *str, int c);</pre><p> Locates the first occurrence of <i class="parameter"><tt>c</tt></i> (converted to a char) in <i class="parameter"><tt>str</tt></i>.</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>str</tt></i> :</span></td><td> a string. </td></tr><tr><td><span class="term"><i class="parameter"><tt>c</tt></i> :</span></td><td> a character to locate, which must not be 0. </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> a pointer to the character following the first occurrence of <i class="parameter"><tt>c</tt></i> in <i class="parameter"><tt>str</tt></i>, or <tt class="literal">NULL</tt> if <i class="parameter"><tt>c</tt></i> does not appear in <i class="parameter"><tt>str</tt></i>. </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2637703"></a><h3><a name="st-strstr-span"></a>st_strstr_span ()</h3><a class="indexterm" name="id2637712"></a><pre class="programlisting">char* st_strstr_span (const char *big, const char *little);</pre><p> Locates the first occurrence of <i class="parameter"><tt>little</tt></i> in <i class="parameter"><tt>big</tt></i>.</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>big</tt></i> :</span></td><td> a string. </td></tr><tr><td><span class="term"><i class="parameter"><tt>little</tt></i> :</span></td><td> a string to search for in <i class="parameter"><tt>big</tt></i>. </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> a pointer to the character following the first occurrence of <i class="parameter"><tt>little</tt></i> in <i class="parameter"><tt>big</tt></i>, or <tt class="literal">NULL</tt> if <i class="parameter"><tt>little</tt></i> does not appear in <i class="parameter"><tt>big</tt></i>. </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2637830"></a><h3><a name="st-str-has-prefix-span"></a>st_str_has_prefix_span ()</h3><a class="indexterm" name="id2637838"></a><pre class="programlisting">char* st_str_has_prefix_span (const char *str, const char *prefix);</pre><p> Checks if <i class="parameter"><tt>str</tt></i> begins with <i class="parameter"><tt>prefix</tt></i>.</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>str</tt></i> :</span></td><td> a string. </td></tr><tr><td><span class="term"><i class="parameter"><tt>prefix</tt></i> :</span></td><td> the prefix to look for. </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> a pointer to the character following <i class="parameter"><tt>prefix</tt></i> in <i class="parameter"><tt>str</tt></i>, or <tt class="literal">NULL</tt> if <i class="parameter"><tt>str</tt></i> does not begin with <i class="parameter"><tt>prefix</tt></i>. </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2637950"></a><h3><a name="st-str-like"></a>st_str_like ()</h3><a class="indexterm" name="id2637959"></a><pre class="programlisting">gboolean st_str_like (const char *str, const char *charset);</pre><p> Checks if all the characters of <i class="parameter"><tt>str</tt></i> are members of <i class="parameter"><tt>charset</tt></i>.</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>str</tt></i> :</span></td><td> a string. </td></tr><tr><td><span class="term"><i class="parameter"><tt>charset</tt></i> :</span></td><td> a set of characters. </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> <tt class="literal">TRUE</tt> if all the characters of <i class="parameter"><tt>str</tt></i> are members of <i class="parameter"><tt>charset</tt></i>. </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2638060"></a><h3><a name="st-pixbuf-new-from-file"></a>st_pixbuf_new_from_file ()</h3><a class="indexterm" name="id2638069"></a><pre class="programlisting">GdkPixbuf* st_pixbuf_new_from_file (const char *filename);</pre><p> Creates a new pixbuf by loading an image from a file. If the file cannot be loaded, <a href="streamtuner-st-dialog-api.html#st-notice"><tt class="function">st_notice()</tt></a> will be used to print the error.</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>filename</tt></i> :</span></td><td> the name of the file to load. </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> a new <span class="type">GdkPixbuf</span>, or <tt class="literal">NULL</tt> on error. </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2638145"></a><h3><a name="st-hig-section-new"></a>st_hig_section_new ()</h3><a class="indexterm" name="id2638153"></a><pre class="programlisting">GtkWidget* st_hig_section_new (const char *title, GtkWidget *contents);</pre><p> Creates a new HIG-compliant section, as defined by <a href="http://developer.gnome.org/projects/gup/hig/2.0/design-window.html" target="_top">Window Layout</a>.</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>title</tt></i> :</span></td><td> the section title. </td></tr><tr><td><span class="term"><i class="parameter"><tt>contents</tt></i> :</span></td><td> the widget to use as section contents. </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> a new <span class="type">GtkVBox</span> containing <i class="parameter"><tt>title</tt></i> and <i class="parameter"><tt>contents</tt></i>. </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2638253"></a><h3><a name="st-set-tooltip"></a>st_set_tooltip ()</h3><a class="indexterm" name="id2638262"></a><pre class="programlisting">void st_set_tooltip (GtkWidget *widget, const char *tooltip);</pre><p> Sets the tooltip of <i class="parameter"><tt>widget</tt></i> using the global <span class="type">GtkTooltips</span> object used by streamtuner.</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>widget</tt></i> :</span></td><td> a widget. </td></tr><tr><td><span class="term"><i class="parameter"><tt>tooltip</tt></i> :</span></td><td> a tooltip text. </td></tr></tbody></table></div></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="streamtuner-st-transfer-api.html"><b><< st-transfer</b></a></td><td align="right"><a accesskey="n" href="streamtuner-st-version-api.html"><b>st-version >></b></a></td></tr></table></body></html>