更新时间:2019-11-20
接口名称 |
接口描述 |
---|---|
设置业务参数。 |
|
初始化终端SDK组件。 |
|
去初始化终端SDK组件。 |
|
释放SDK内部分配的内存。 |
接口描述
设置业务参数。
注意事项
无。
方法定义
TSDK_API TSDK_RESULT tsdk_set_config_param(IN TSDK_E_CONFIG_ID config_id, IN TSDK_VOID *param); |
参数描述
参数名 |
是否必须 |
类型 |
描述 |
---|---|---|---|
[in] config_id |
是 |
参数配置ID。 |
|
[in] param |
是 |
TSDK_VOID * |
参数值,根据配置的ID确定数据类型。 |
返回值
类型 |
描述 |
---|---|
TSDK_RESULT |
成功返回TSDK_SUCCESS,失败返回相应错误码。 |
代码示例
int ret; TSDK_S_LOG_PARAM logParam; memset(&logParam,0,sizeof(TSDK_S_LOG_PARAM)); logParam.file_count = 1; logParam.level = TSDK_E_LOG_DEBUG; logParam.max_size_kb = 4 * 1024; strncpy_s(logParam.path, TSDK_D_MAX_PATH_LEN,"./terminal_sdk_log", _TRUNCATE); ret = tsdk_set_config_param(TSDK_E_CONFIG_LOG_PARAM, &logParam); if (TSDK_SUCCESS != ret) { LOG_D_AUTH_LOGIN_INFO("set log param failed"); } return ret; |
接口描述
初始化终端SDK组件。
注意事项
无。
方法定义
TSDK_API TSDK_RESULT tsdk_init(IN TSDK_S_APP_INFO_PARAM *app_info, IN TSDK_FN_CALLBACK_PTR notify); |
参数描述
参数名 |
是否必须 |
类型 |
描述 |
---|---|---|---|
[in] app_info |
是 |
应用程序信息参数。 |
|
[in] notify |
是 |
事件通知回调函数地址。 |
返回值
类型 |
描述 |
---|---|
TSDK_RESULT |
成功返回TSDK_SUCCESS,失败返回相应错误码。 |
代码示例
int ret; TSDK_S_APP_INFO_PARAM app_info; memset(&app_info, 0, sizeof(app_info)); app_info.client_type = TSDK_E_CLIENT_PC; strcpy_s(app_info.product_name, TSDK_D_MAX_PRODUCT_NAME_LEN + 1, "eSDK-Desktop"); app_info.support_audio_and_video_call = 1; app_info.support_audio_and_video_conf = 1; app_info.support_ctd = 1; app_info.support_data_conf = 1; app_info.support_rich_media_message = 1; app_info.support_enterprise_address_book = 1; app_info.support_im = 1; ret = tsdk_init(&app_info, COMPONENT_FN_CALLBACK_PTR); return ret; |
接口描述
去初始化终端SDK组件。
注意事项
程序退出前请调用,调用前停止相关业务。
方法定义
TSDK_API TSDK_RESULT tsdk_uninit(TSDK_VOID); |
参数描述
无。
返回值
类型 |
描述 |
---|---|
TSDK_RESULT |
成功返回TSDK_SUCCESS,失败返回相应错误码。 |
代码示例
int ret; ret = tsdk_uninit(); return ret; |
接口描述
释放SDK内部分配的内存。
注意事项
仅用于释放TSDK 组件接口或回调通知中返回的内存。
方法定义
TSDK_VOID tsdk_release_sdk_mem(IN TSDK_VOID* memory_ptr); |
参数描述
参数名 |
是否必须 |
类型 |
描述 |
---|---|---|---|
[in] memory_ptr |
是 |
TSDK_VOID * |
待释放的内存资源地址。 |
返回值
无。