annotate doc/sound-signals.dox @ 17697:ae7a4134e499

Changing this timer to run every 50 milliseconds instead of every 5 milliseconds. The timer is used to integrate our glib mainloop with silcclient's mainloop. Some Red Hat people complained that the timer causes the CPU to wake up really often and that hurts out power consumption on laptops and what not. Ideally the integration wouldn't need the timeout thing and would instead by event-driven. http://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=242398

/** @page sound-signals Sound Signals

 @signals
  @signal playing-sound-event
 @endsignals

 <hr>

 @signaldef playing-sound-event
  @signalproto
gboolean (*playing_sound_event)(PurpleSoundEventID event, PurpleAccount *account);
  @endsignalproto
  @signaldesc
   Emitted when libpurple is going to play a sound event. This can be used to cancel playing sound by returning TRUE.
  @param event   The event this sound represents.
  @param account The account the sound is being played for.
  @return @c TRUE if the sound should not be played, or @c FALSE otherwise.
 @endsignaldef

 */
// vim: syntax=c tw=75 et