File: st-state-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 (60 lines) | stat: -rw-r--r-- 1,921 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
<refentry id="streamtuner-st-state-api">
<refmeta>
<refentrytitle>st-state</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>STREAMTUNER Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>st-state</refname><refpurpose>functions for getting the state of streamtuner.</refpurpose>
</refnamediv>

<refsynopsisdiv><title>Synopsis</title>

<synopsis>



<link linkend="gboolean">gboolean</link>    <link linkend="st-is-aborted">st_is_aborted</link>                   (void);
</synopsis>
</refsynopsisdiv>









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

</para>
</refsect1>

<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="st-is-aborted"/>st_is_aborted ()</title>
<indexterm><primary>st_is_aborted</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    st_is_aborted                   (void);</programlisting>
<para>
Checks if the user has aborted the current task. Must only be called
from <link linkend="STHandlerReloadCallback"><function>STHandlerReloadCallback()</function></link>, <link linkend="STHandlerReloadMultipleCallback"><function>STHandlerReloadMultipleCallback()</function></link>,
<link linkend="STStreamResolveCallback"><function>STStreamResolveCallback()</function></link>, <link linkend="STStreamTuneInCallback"><function>STStreamTuneInCallback()</function></link>,
<link linkend="STStreamRecordCallback"><function>STStreamRecordCallback()</function></link>, <link linkend="STStreamBrowseCallback"><function>STStreamBrowseCallback()</function></link> or
<link linkend="STStreamTuneInMultipleCallback"><function>STStreamTuneInMultipleCallback()</function></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if the user has aborted the current task.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>