sound.h

Go to the documentation of this file.

 
/* purple
 *
 * Purple is the legal property of its developers, whose names are too numerous
 * to list here.  Please refer to the COPYRIGHT file distributed with this
 * source distribution.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
 */
#ifndef _PURPLE_SOUND_H_
#define _PURPLE_SOUND_H_
 
#include "account.h"
 
/**************************************************************************/
/**************************************************************************/
 
 
typedef enum _PurpleSoundEventID
{
    PURPLE_SOUND_BUDDY_ARRIVE = 0, 
    PURPLE_SOUND_BUDDY_LEAVE,      
    PURPLE_SOUND_RECEIVE,          
    PURPLE_SOUND_FIRST_RECEIVE,    
    PURPLE_SOUND_SEND,             
    PURPLE_SOUND_CHAT_JOIN,        
    PURPLE_SOUND_CHAT_LEAVE,       
    PURPLE_SOUND_CHAT_YOU_SAY,     
    PURPLE_SOUND_CHAT_SAY,         
    PURPLE_SOUND_POUNCE_DEFAULT,   
    PURPLE_SOUND_CHAT_NICK,        
    PURPLE_SOUND_GOT_ATTENTION,    
    PURPLE_NUM_SOUNDS              
} PurpleSoundEventID;
 
typedef struct _PurpleSoundUiOps
{
    void (*init)(void);
    void (*uninit)(void);
    void (*play_file)(const char *filename);
    void (*play_event)(PurpleSoundEventID event);
 
    void (*_purple_reserved1)(void);
    void (*_purple_reserved2)(void);
    void (*_purple_reserved3)(void);
    void (*_purple_reserved4)(void);
} PurpleSoundUiOps;
 
#ifdef __cplusplus
extern "C" {
#endif
 
/**************************************************************************/
/**************************************************************************/
void purple_sound_play_file(const char *filename, const PurpleAccount *account);
 
void purple_sound_play_event(PurpleSoundEventID event, const PurpleAccount *account);
 
void purple_sound_set_ui_ops(PurpleSoundUiOps *ops);
 
PurpleSoundUiOps *purple_sound_get_ui_ops(void);
 
void purple_sound_init(void);
 
void purple_sound_uninit(void);
 
void *purple_sounds_get_handle(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _PURPLE_SOUND_H_ */