ppsip 使用文档.docVIP

ppsip 使用文档 ppsip 使用文档 1 1. 简介 1 2. 数据结构 1 2.1 sip注册信息的结构 1 2.2 语音编码信息的结构 2 2.3 总共支持的编码信息的结构 2 2.4 .注册时候要传给SipRegister的结构 2 3. 函数 2 3.1 Sip 相关的函数 3 3.2 音频设备相关函数 5 1. 简介 ppsip是一个构建于osip2 + exosip2 + ortp + mediastreamer2 + speex之上的高层sip库, 它高效,稳定,简单而又不缺乏灵活性,你可以使用它在几分钟之内构建出一个可以在Win2K/WinXP/Vista/WinCE平台运行的Sip User Agent. 该文档的具体用法可以参考SipAgentDemo. 2. 数据结构 2.1 sip注册信息的结构 typedef struct _user_sip_configure { char szPhoneNumber[CONF_ITEM_LEN]; // 号码 char szUserName[CONF_ITEM_LEN]; //用户名,可以和号码相同 char szPassword[CONF_ITEM_LEN];//密码 char szDomain[CONF_ITEM_LEN];//Domain,可以和Proxy相同 char szProxy[CONF_ITEM_LEN];//注册的服务器地址 char szStun[CONF_ITEM_LEN];// stun服务器地址 int iSipPort; //本地的 Sip使用的端口 int iRTPProt;//本地的 RTP 使用的端口 bool bUseStun; //是否使用stun bool bAutoRegister;// 是否自动注册,建议值设为1 }SipUserConfig; 2.2 语音编码信息的结构 typedef struct _codec_info { int iPayLoadType; // 编码的PayLoadType int iSampleRate; //采样率 char szName[32];// 名字,也就是MIME }CodecInfo; 比如g711 alaw 为{8, 8000, “Alaw”}, 2.3 总共支持的编码信息的结构 typedef struct _support_codec { int iSupportCodecNumbers; CodecInfo CodecInfos[16];// }SipSupportCodec; ppsip暂时只支持 g711 alaw, g711 ulaw, g729, ,speex和四种.,所以你传进去的结构只能少于这四种,多于则无效 2.4 .注册时候要传给SipRegister的结构 typedef struct _user_configure { SipSupportCodec SupportCodec; SipUserConfig SipConfig; }UserConfig; 3. 函数 函数总共分两部分,第一部分是建立一次sip呼叫所需要的函数,第二部分是音频设备相关的函数. 3.1 Sip 相关的函数 函数: void SipRegister(UserConfig* conf, void (CALLBACK* SipEvent)(int iLineNumber, int iEventType, WPARAM wParam, LPARAM lParam, void* pInstance), void* pAppInstance); 功能: 向sip服务器注册 参数: Conf: 注册信息,要仔细填写,否则会注册不成功 SipEvent: 回调函数,底层的信息会通过这个函数回传给上层 pAppInstance: 传给回调函数的参数 返回值: 无 函数: int SipDialCall(char* szDialNumber, int iAuidoIn, int iAudioOut) 功能: 主动发起一次呼叫 参数: szDialNumber: 被呼叫的号码 iAudioIn: 录音设备的id, 可以通过下面将要介绍的音频相关函数获得 iAudioOut:回放设备id,获得方法同上 返回值: 如果呼叫成功或是正在处理,则返回一个线路ID,这个ID值会在以后的函数中使用,必须保存, 如果出错,则返回-1. 函数: BOOL SipHangup(int iChoseLine); 功能: 根据当前的状态,可以是挂断正在进行的呼叫,拒绝接听或是放弃一次呼叫 参数: iChoseLine: 这个线路的ID值是调用SipDial得到或是调用S