doc/reference/libpurple/signals_sound.xml

<?xml version='1.0' encoding="ISO-8859-1"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
]>
<chapter id="chapter-signals-sound">
<title>Sound signals</title>

<refsect1 id="sound.signals" role="signal_proto">
<title role="signal_proto.title">List of signals</title>
<synopsis>
  &quot;<link linkend="sound-playing-sound-event">playing-sound-event</link>&quot;
</synopsis>
</refsect1>

<refsect1 id="sound.signal-details" role="signals">
<title role="signals.title">Signal details</title>

<refsect2 id="sound-playing-sound-event" role="signal">
 <title>The <literal>&quot;playing-sound-event&quot;</literal> signal</title>
<programlisting>
gboolean            user_function                      (PurpleSoundEventID event,
                                                        PurpleAccount *account,
                                                        gpointer user_data)
</programlisting>
  <para>
Emitted when libpurple is going to play a sound event. This can be used to cancel playing sound by returning TRUE.
  </para>
  <variablelist role="params">
  <varlistentry>
    <term><parameter>event</parameter>&#160;:</term>
    <listitem><simpara>The event this sound represents.</simpara></listitem>
  </varlistentry>
  <varlistentry>
    <term><parameter>account</parameter>&#160;:</term>
    <listitem><simpara>The account the sound is being played for.</simpara></listitem>
  </varlistentry>
  <varlistentry>
    <term><parameter>user_data</parameter>&#160;:</term>
    <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
  </varlistentry>
  <varlistentry>
    <term><emphasis>Returns</emphasis>&#160;:</term>
    <listitem><simpara><literal>TRUE</literal> if the sound should not be played, or <literal>FALSE</literal> otherwise.</simpara></listitem>
  </varlistentry>
  </variablelist>
</refsect2>

</refsect1>

</chapter>