wx.h

浏览该文件的文档.

/** \file wx.h
 */
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#if 0
/** 设备端使用 wxInit2() */
int _wxInit(const char *data_path, const char *app_id, const char *model_id);
 
 
/** 初始化微信voip模块.
 * @data_path 非易失可写路径，用于保存wxvoip 的注册文件
 * @note 在 on_status(STATUS_UPDATESERVICE, ...) 回调里收到 ECGS_TYPE_WXVOIP
 *       服务并且在有效期时调用本接口
 */
int _wxInit2(const char *data_path);
#endif
 
/** 注册微信Voip模块. 在TciStart()前调用 */
int wxInit(void);
 
#if 0
/** 接听微信小程序呼叫.
 * @param roomid 呼叫标识，来自 on_status(@ref STATUS_CALL, ...) 回调的参数
 * @return 0:ok; 其它:错误
 */
int wxAnswer(const char *roomid);
 
/** 拒接呼叫
 * @param roomid 呼叫标识，来自 on_status(@ref STATUS_CALL, ...) 回调的参数
 */
int wxReject(const char *roomid);
 
/** 挂断当前通话
 * @return 0
 */
int wxHangup();
#endif
 
/** Wx VoIP 用户 */
struct WxUser {
    char openid[48];   ///< 用户标识
    char nickname[32]; ///< 昵称
};
/** 获取呼叫对象列表.
 * @param ppWxUser 成功时*ppWxUser中返回用户数组指针，调用者要用 free() 释放
 * @param pNUsers 成功时*pNUsers返回数组大小
 * @return 0:成功；其它:错误码定义在 ec_const.h 
 *
 * @note - 使用带key的uuid，才会返回 nickname
 *       - 使用自己的帐号体系的用户需要使用自己的方式获取呼叫对象，不能调用此接口.
 */
int wxGetUsers(struct WxUser **ppWxUser, int *pNUsers);
 
/** 微信voip内部通知回调.
 * @param type 类型.见下表
 * @param data \c type 相关的数据
 * @param len  \c data 指向数据的大小
 * @return <0 意味出错. >=0表示正常处理, 具体值看下表
 * 
 * @note
 * - 获取/更新 sn_ticket. 使用自己的帐号体系的用户才需要实现
 *   - \c type = 0
 *   - \c data 缓冲区用于返回 sn_ticket 字符串, 包括结尾的 \0
 *   - \c len data 指向的缓冲区长度
 *   - 返回值: 成功时，返回 sn_ticket的长度 + 1，否则返回-1
 *   - 说明: 如果不是遇到不可恢复错误(例如帐号无效)，该操作应该反复重试直到成功
 */
typedef int (*TGWXVOIPCALLBACK)(int type, void *data, int len);
 
/** 设置回调.
 * @note 用于使用自用帐号体系的用户。
 */
void wxSetCallback(TGWXVOIPCALLBACK cb);
 
/** 呼叫小程序
 * @param openid 小程序用户标识。
 * @param openid 小程序用户标识
 * @param timeout 呼叫超时设置，单位:秒. 取值15~60
 * @return  参看 wx_err.h
 * @note 呼叫前要通过别的方式获取到设备可以呼叫的用户列表(通讯录)，然后引导操作者 \n
 *       选择(手动, 或通过人脸识别或刷卡等身份识别方式确定操作者绑定的)呼叫对象.
 */
int wxCall2(const char *openid, int timeout);
int wxCall(const char *openid);
 
/** 取消小程序外呼或挂断通话 */
int wxCancelCall();
 
/** 反初始化wxvoip模块 */
void wxUninit(void);
 
const char *wxGetErrStr(int err);
 
//#define WX_E_CALL_HAS_GONE  -30001  ///< wxAnswer/wxReject: 呼入已无效
#ifdef __cplusplus
} /* extern "C" */
#endif