1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
|
<refentry id="streamtuner-st-util-api">
<refmeta>
<refentrytitle>st-util</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>STREAMTUNER Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>st-util</refname><refpurpose>miscellaneous utility functions.</refpurpose>
</refnamediv>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
#define <link linkend="ST-NUMERIC-CAPS">ST_NUMERIC</link>
<link linkend="char">char</link>* <link linkend="st-format-bitrate">st_format_bitrate</link> (<link linkend="int">int</link> bitrate);
<link linkend="char">char</link>* <link linkend="st-format-samplerate">st_format_samplerate</link> (<link linkend="int">int</link> samplerate);
<link linkend="char">char</link>* <link linkend="st-format-channels">st_format_channels</link> (<link linkend="int">int</link> channels);
<link linkend="char">char</link>* <link linkend="st-format-audio-properties">st_format_audio_properties</link> (<link linkend="int">int</link> bitrate,
<link linkend="int">int</link> samplerate,
<link linkend="int">int</link> channels);
<link linkend="char">char</link>* <link linkend="st-strchr-span">st_strchr_span</link> (const <link linkend="char">char</link> *str,
<link linkend="int">int</link> c);
<link linkend="char">char</link>* <link linkend="st-strstr-span">st_strstr_span</link> (const <link linkend="char">char</link> *big,
const <link linkend="char">char</link> *little);
<link linkend="char">char</link>* <link linkend="st-str-has-prefix-span">st_str_has_prefix_span</link> (const <link linkend="char">char</link> *str,
const <link linkend="char">char</link> *prefix);
<link linkend="gboolean">gboolean</link> <link linkend="st-str-like">st_str_like</link> (const <link linkend="char">char</link> *str,
const <link linkend="char">char</link> *charset);
<link linkend="GdkPixbuf">GdkPixbuf</link>* <link linkend="st-pixbuf-new-from-file">st_pixbuf_new_from_file</link> (const <link linkend="char">char</link> *filename);
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="st-hig-section-new">st_hig_section_new</link> (const <link linkend="char">char</link> *title,
<link linkend="GtkWidget">GtkWidget</link> *contents);
<link linkend="void">void</link> <link linkend="st-set-tooltip">st_set_tooltip</link> (<link linkend="GtkWidget">GtkWidget</link> *widget,
const <link linkend="char">char</link> *tooltip);
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
</para>
</refsect1>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="ST-NUMERIC-CAPS"/>ST_NUMERIC</title>
<indexterm><primary>ST_NUMERIC</primary></indexterm><programlisting>#define ST_NUMERIC "0123456789"
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="st-format-bitrate"/>st_format_bitrate ()</title>
<indexterm><primary>st_format_bitrate</primary></indexterm><programlisting><link linkend="char">char</link>* st_format_bitrate (<link linkend="int">int</link> bitrate);</programlisting>
<para>
Formats <parameter>bitrate</parameter> as a string.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>bitrate</parameter> :</term>
<listitem><simpara> a bitrate to format, expressed in kilobits per seconds.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <parameter>bitrate</parameter> formatted as a string, which should be freed
when no longer needed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="st-format-samplerate"/>st_format_samplerate ()</title>
<indexterm><primary>st_format_samplerate</primary></indexterm><programlisting><link linkend="char">char</link>* st_format_samplerate (<link linkend="int">int</link> samplerate);</programlisting>
<para>
Formats <parameter>samplerate</parameter> as a string.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>samplerate</parameter> :</term>
<listitem><simpara> a samplerate to format, expressed in Hz.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <parameter>samplerate</parameter> formatted as a string, which should be
freed when no longer needed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="st-format-channels"/>st_format_channels ()</title>
<indexterm><primary>st_format_channels</primary></indexterm><programlisting><link linkend="char">char</link>* st_format_channels (<link linkend="int">int</link> channels);</programlisting>
<para>
Formats <parameter>channels</parameter> as a string.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>channels</parameter> :</term>
<listitem><simpara> a number of audio channels, which must be greater than
0.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <parameter>channels</parameter> formatted as a string, which should be
freed when no longer needed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="st-format-audio-properties"/>st_format_audio_properties ()</title>
<indexterm><primary>st_format_audio_properties</primary></indexterm><programlisting><link linkend="char">char</link>* st_format_audio_properties (<link linkend="int">int</link> bitrate,
<link linkend="int">int</link> samplerate,
<link linkend="int">int</link> channels);</programlisting>
<para>
Formats <parameter>bitrate</parameter>, <parameter>samplerate</parameter> and <parameter>channels</parameter> as a string.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>bitrate</parameter> :</term>
<listitem><simpara> a bitrate expressed in kbps, or 0.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>samplerate</parameter> :</term>
<listitem><simpara> a samplerate expressed in kbps, or 0.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>channels</parameter> :</term>
<listitem><simpara> a number of audio channels, or 0.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a formatted string, which should be freed when no
longer needed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="st-strchr-span"/>st_strchr_span ()</title>
<indexterm><primary>st_strchr_span</primary></indexterm><programlisting><link linkend="char">char</link>* st_strchr_span (const <link linkend="char">char</link> *str,
<link linkend="int">int</link> c);</programlisting>
<para>
Locates the first occurrence of <parameter>c</parameter> (converted to a char) in <parameter>str</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>str</parameter> :</term>
<listitem><simpara> a string.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>c</parameter> :</term>
<listitem><simpara> a character to locate, which must not be 0.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a pointer to the character following the first
occurrence of <parameter>c</parameter> in <parameter>str</parameter>, or <literal>NULL</literal> if <parameter>c</parameter> does not appear in <parameter>str</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="st-strstr-span"/>st_strstr_span ()</title>
<indexterm><primary>st_strstr_span</primary></indexterm><programlisting><link linkend="char">char</link>* st_strstr_span (const <link linkend="char">char</link> *big,
const <link linkend="char">char</link> *little);</programlisting>
<para>
Locates the first occurrence of <parameter>little</parameter> in <parameter>big</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>big</parameter> :</term>
<listitem><simpara> a string.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>little</parameter> :</term>
<listitem><simpara> a string to search for in <parameter>big</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a pointer to the character following the first
occurrence of <parameter>little</parameter> in <parameter>big</parameter>, or <literal>NULL</literal> if <parameter>little</parameter> does not appear
in <parameter>big</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="st-str-has-prefix-span"/>st_str_has_prefix_span ()</title>
<indexterm><primary>st_str_has_prefix_span</primary></indexterm><programlisting><link linkend="char">char</link>* st_str_has_prefix_span (const <link linkend="char">char</link> *str,
const <link linkend="char">char</link> *prefix);</programlisting>
<para>
Checks if <parameter>str</parameter> begins with <parameter>prefix</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>str</parameter> :</term>
<listitem><simpara> a string.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>prefix</parameter> :</term>
<listitem><simpara> the prefix to look for.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a pointer to the character following <parameter>prefix</parameter> in <parameter>str</parameter>,
or <literal>NULL</literal> if <parameter>str</parameter> does not begin with <parameter>prefix</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="st-str-like"/>st_str_like ()</title>
<indexterm><primary>st_str_like</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> st_str_like (const <link linkend="char">char</link> *str,
const <link linkend="char">char</link> *charset);</programlisting>
<para>
Checks if all the characters of <parameter>str</parameter> are members of <parameter>charset</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>str</parameter> :</term>
<listitem><simpara> a string.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>charset</parameter> :</term>
<listitem><simpara> a set of characters.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if all the characters of <parameter>str</parameter> are members of
<parameter>charset</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="st-pixbuf-new-from-file"/>st_pixbuf_new_from_file ()</title>
<indexterm><primary>st_pixbuf_new_from_file</primary></indexterm><programlisting><link linkend="GdkPixbuf">GdkPixbuf</link>* st_pixbuf_new_from_file (const <link linkend="char">char</link> *filename);</programlisting>
<para>
Creates a new pixbuf by loading an image from a file. If the file
cannot be loaded, <link linkend="st-notice"><function>st_notice()</function></link> will be used to print the error.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>filename</parameter> :</term>
<listitem><simpara> the name of the file to load.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GdkPixbuf"><type>GdkPixbuf</type></link>, or <literal>NULL</literal> on error.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="st-hig-section-new"/>st_hig_section_new ()</title>
<indexterm><primary>st_hig_section_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* st_hig_section_new (const <link linkend="char">char</link> *title,
<link linkend="GtkWidget">GtkWidget</link> *contents);</programlisting>
<para>
Creates a new HIG-compliant section, as defined by
<ulink url="http://developer.gnome.org/projects/gup/hig/2.0/design-window.html" type="http">Window Layout</ulink>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>title</parameter> :</term>
<listitem><simpara> the section title.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>contents</parameter> :</term>
<listitem><simpara> the widget to use as section contents.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GtkVBox"><type>GtkVBox</type></link> containing <parameter>title</parameter> and <parameter>contents</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="st-set-tooltip"/>st_set_tooltip ()</title>
<indexterm><primary>st_set_tooltip</primary></indexterm><programlisting><link linkend="void">void</link> st_set_tooltip (<link linkend="GtkWidget">GtkWidget</link> *widget,
const <link linkend="char">char</link> *tooltip);</programlisting>
<para>
Sets the tooltip of <parameter>widget</parameter> using the global <link linkend="GtkTooltips"><type>GtkTooltips</type></link> object
used by streamtuner.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>widget</parameter> :</term>
<listitem><simpara> a widget.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>tooltip</parameter> :</term>
<listitem><simpara> a tooltip text.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
