doc/reference/libpurple/signals_sound.xml

   1 <?xml version='1.0' encoding="ISO-8859-1"?>
   2 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
   4 ]>
   5 <chapter id="chapter-signals-sound">
   6 <title>Sound signals</title>
   7
   8 <refsect1 id="sound.signals" role="signal_proto">
   9 <title role="signal_proto.title">List of signals</title>
  10 <synopsis>
  11   &quot;<link linkend="sound-playing-sound-event">playing-sound-event</link>&quot;
  12 </synopsis>
  13 </refsect1>
  14
  15 <refsect1 id="sound.signal-details" role="signals">
  16 <title role="signals.title">Signal details</title>
  17
  18 <refsect2 id="sound-playing-sound-event" role="signal">
  19  <title>The <literal>&quot;playing-sound-event&quot;</literal> signal</title>
  20 <programlisting>
  21 gboolean            user_function                      (PurpleSoundEventID event,
  22                                                         PurpleAccount *account,
  23                                                         gpointer user_data)
  24 </programlisting>
  25   <para>
  26 Emitted when libpurple is going to play a sound event. This can be used to cancel playing sound by returning TRUE.
  27   </para>
  28   <variablelist role="params">
  29   <varlistentry>
  30     <term><parameter>event</parameter>&#160;:</term>
  31     <listitem><simpara>The event this sound represents.</simpara></listitem>
  32   </varlistentry>
  33   <varlistentry>
  34     <term><parameter>account</parameter>&#160;:</term>
  35     <listitem><simpara>The account the sound is being played for.</simpara></listitem>
  36   </varlistentry>
  37   <varlistentry>
  38     <term><parameter>user_data</parameter>&#160;:</term>
  39     <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
  40   </varlistentry>
  41   <varlistentry>
  42     <term><emphasis>Returns</emphasis>&#160;:</term>
  43     <listitem><simpara><literal>TRUE</literal> if the sound should not be played, or <literal>FALSE</literal> otherwise.</simpara></listitem>
  44   </varlistentry>
  45   </variablelist>
  46 </refsect2>
  47
  48 </refsect1>
  49
  50 </chapter>