view doc/sound-signals.dox @ 22920:abb17e7e2e98

For chats created using the "normal" (i.e. Join a Chat) flow, there will always be prpl_info->chat_info, but for stuff like the MSN conferences, there will not necessarily be. Eion Robb noticed this issue. Fixes #5777. -------------------------------------------------------------------------------

/** @page sound-signals Sound Signals

 @signals
  @signal playing-sound-event
 @endsignals

 @see sound.h

 <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.doxygen tw=75 et