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
|
<refentry id="streamtuner-st-action-api">
<refmeta>
<refentrytitle>st-action</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>STREAMTUNER Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>st-action</refname><refpurpose>functions for defining and executing actions.</refpurpose>
</refnamediv>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
<link linkend="void">void</link> <link linkend="st-action-register">st_action_register</link> (const <link linkend="char">char</link> *id,
const <link linkend="char">char</link> *label,
const <link linkend="char">char</link> *command);
<link linkend="gboolean">gboolean</link> <link linkend="st-action-run">st_action_run</link> (const <link linkend="char">char</link> *id,
const <link linkend="char">char</link> *uri,
<link linkend="GError">GError</link> **err);
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
These functions provide support for defining actions which can be
customized from the streamtuner preferences, and for running them with
an URI parameter.
</para>
</refsect1>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="st-action-register"/>st_action_register ()</title>
<indexterm><primary>st_action_register</primary></indexterm><programlisting><link linkend="void">void</link> st_action_register (const <link linkend="char">char</link> *id,
const <link linkend="char">char</link> *label,
const <link linkend="char">char</link> *command);</programlisting>
<para>
Registers a new action. The action will appear in the applications
page of the streamtuner preferences, and the user will be able to
modify its associated command.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>id</parameter> :</term>
<listitem><simpara> an unique id for the action.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>label</parameter> :</term>
<listitem><simpara> a human-readable label for the action.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>command</parameter> :</term>
<listitem><simpara> the default command for the action, or <literal>NULL</literal>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="st-action-run"/>st_action_run ()</title>
<indexterm><primary>st_action_run</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> st_action_run (const <link linkend="char">char</link> *id,
const <link linkend="char">char</link> *uri,
<link linkend="GError">GError</link> **err);</programlisting>
<para>
Runs action <parameter>id</parameter> with <parameter>uri</parameter> as parameter. The action must have been
previously registered with <link linkend="st-action-register"><function>st_action_register()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>id</parameter> :</term>
<listitem><simpara> the id of the action to run.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uri</parameter> :</term>
<listitem><simpara> the URI to run the action on.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>err</parameter> :</term>
<listitem><simpara> a location to report errors, or <literal>NULL</literal>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> on success, <literal>FALSE</literal> on failure.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
