File: st-m3u-api.xml

package info (click to toggle)
streamtuner 0.99.99-15
  • links: PTS
  • area: main
  • in suites: lenny, squeeze
  • size: 5,220 kB
  • ctags: 2,980
  • sloc: ansic: 27,119; sh: 8,206; xml: 4,811; makefile: 444; python: 366
file content (80 lines) | stat: -rw-r--r-- 2,537 bytes parent folder | download | duplicates (3)
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
<refentry id="streamtuner-st-m3u-api">
<refmeta>
<refentrytitle>st-m3u</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>STREAMTUNER Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>st-m3u</refname><refpurpose>functions for handling M3U playlists.</refpurpose>
</refnamediv>

<refsynopsisdiv><title>Synopsis</title>

<synopsis>



<link linkend="char">char</link>*       <link linkend="st-m3u-mktemp">st_m3u_mktemp</link>                   (const <link linkend="char">char</link> *prefix,
                                             <link linkend="GSList">GSList</link> *uri_list,
                                             <link linkend="GError">GError</link> **err);
</synopsis>
</refsynopsisdiv>









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

</para>
</refsect1>

<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="st-m3u-mktemp"/>st_m3u_mktemp ()</title>
<indexterm><primary>st_m3u_mktemp</primary></indexterm><programlisting><link linkend="char">char</link>*       st_m3u_mktemp                   (const <link linkend="char">char</link> *prefix,
                                             <link linkend="GSList">GSList</link> *uri_list,
                                             <link linkend="GError">GError</link> **err);</programlisting>
<para>
Creates a temporary M3U playlist. <parameter>uri_list</parameter> must be a list of
strings which will be written to the playlist.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>prefix</parameter>&nbsp;:</term>
<listitem><simpara> the prefix to use for the temporary filename. Should be in
the form "streamtuner.handler.XXXXXX", where handler is the name of
the handler.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uri_list</parameter>&nbsp;:</term>
<listitem><simpara> a list of URIs to write.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>err</parameter>&nbsp;:</term>
<listitem><simpara> a location to store errors, or <literal>NULL</literal>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the full pathname of the temporary file, or <literal>NULL</literal> on
failure (in such case, <parameter>err</parameter> will be set).  The pathname should be
freed when it is no longer needed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>



<refsect1>
<title>See Also</title>
<para>
<link linkend="streamtuner-st-pls-api">st-pls</link>
</para>
</refsect1>

</refentry>