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
|
<refentry id="streamtuner-st-settings-api">
<refmeta>
<refentrytitle>st-settings</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>STREAMTUNER Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>st-settings</refname><refpurpose>functions for getting streamtuner settings.</refpurpose>
</refnamediv>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
const <link linkend="char">char</link>* <link linkend="st-settings-get-private-dir">st_settings_get_private_dir</link> (void);
<link linkend="char">char</link>* <link linkend="st-settings-get-music-dir">st_settings_get_music_dir</link> (void);
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
</para>
</refsect1>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="st-settings-get-private-dir"/>st_settings_get_private_dir ()</title>
<indexterm><primary>st_settings_get_private_dir</primary></indexterm><programlisting>const <link linkend="char">char</link>* st_settings_get_private_dir (void);</programlisting>
<para>
Gets the streamtuner private directory (the value passed to the -d
command line argument, or ~/.streamtuner).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the private directory.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="st-settings-get-music-dir"/>st_settings_get_music_dir ()</title>
<indexterm><primary>st_settings_get_music_dir</primary></indexterm><programlisting><link linkend="char">char</link>* st_settings_get_music_dir (void);</programlisting>
<para>
Gets the streamtuner music directory, which can be set by the user
from the preferences.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the music directory, or <literal>NULL</literal> if unset. The returned
string must be freed when no longer needed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
