接口参考_湖南轩利_为用户提供一站式的云服务及音视频整体解决方案

会议管理

接口名称	接口描述
tsdk_book_conference	预约会议。
tsdk_query_conference_list	获取会议列表。
tsdk_query_conference_detail	获取会议详细信息。

会议控制

接口名称	接口描述
tsdk_join_conference	主动加入会议。
tsdk_accept_conference	接听会议来电。
tsdk_reject_conference	拒绝会议来电。
tsdk_leave_conference	离开会议。
tsdk_end_conference	结束会议。
tsdk_upgrade_conference	升级会议。
tsdk_mute_conference	闭音会议。
tsdk_add_attendee	添加与会者。
tsdk_redial_attendee	重拨与会者。
tsdk_hang_up_attendee	挂断与会者。
tsdk_remove_attendee	删除与会者。
tsdk_mute_attendee	闭音与会者。
tsdk_set_handup	设置或取消举手。
tsdk_set_video_mode	设置视频会议模式。
tsdk_watch_attendee	观看指定与会者。
tsdk_broadcast_attendee	广播或取消广播与会者。
tsdk_request_chairman	申请主席权限。
tsdk_release_chairman	释放主席权限。
tsdk_postpone_conference	延长会议。
tsdk_join_data_conference	加入数据会议。
tsdk_p2p_transfer_to_conference	两方通话转多方会议。
tsdk_join_conference_by_anonymous	匿名方式加入会议。
tsdk_set_record_broadcast	设置会议录播。
tsdk_set_live_broadcast	设置会议直播。

数据会议

接口名称	接口描述
tsdk_set_presenter	设置主讲人。
tsdk_request_chairman	申请主讲人。
tsdk_app_share_set_owner	设置屏幕共享的拥有者。
tsdk_app_share_start	开始共享。
tsdk_app_share_stop	停止共享。
tsdk_app_share_get_screen_data	获取屏幕数据。
tsdk_doc_share_open_document	打开共享文档。
tsdk_doc_share_close_document	关闭一个文档。
tsdk_doc_share_set_current_page	设置当前页面。
tsdk_doc_share_set_canvas_size	设置显示区域的大小。
tsdk_doc_share_get_surface_bmp	获取当前页面图像。
tsdk_doc_share_get_syn_document_info	获取服务器上的当前信息。
tsdk_doc_share_set_background_color	设置背景颜色。
tsdk_doc_share_set_display_mode	设置显示模式。
tsdk_send_chat_msg_in_conference	发送即时消息。
tsdk_whiteboard_new_document	新建白板文档。
tsdk_whiteboard_delete_document	删除白板文档。
tsdk_whiteboard_new_page	新建白板页。
tsdk_whiteboard_delete_page	删除指定页面。
tsdk_annotation_create_start	开始创建一个标注。
tsdk_annotation_create_update	标注创建过程中更新数据。
tsdk_annotation_create_done	标注创建结束。
tsdk_annotation_select_start	开启鼠标选择功能。
tsdk_annotation_select_update	更新鼠标选择功能。
tsdk_annotation_select_done	结束鼠标选择。
tsdk_annotation_laser_pointer_start	开始激光点。
tsdk_annotation_laser_pointer_moveto	移动激光点。
tsdk_annotation_laser_pointer_stop	结束激光点。
tsdk_annotation_text_create	创建文字标注。
tsdk_annotation_text_update	更新文字标注。
tsdk_annotation_edit_start	开始编辑标注。
tsdk_annotation_text_get_info	获取一个文字标注的信息。
tsdk_annotation_edit_update	编辑标注过程中的数据更新。
tsdk_annotation_edit_done	标注编辑完成。
tsdk_annotation_hit_test_point	测试点是否落在标注上。
tsdk_annotation_hit_test_rect	测试矩形框包括的标注。
tsdk_annotation_hit_test_line	测试直线包括的标注。
tsdk_annotation_set_select	设置标注的选中状态。
tsdk_annotation_delete_annotation	删除标注。
tsdk_annotation_get_annotation_info	获取指定标注的信息。
tsdk_annotation_set_pen	设置画笔属性。
tsdk_annotation_set_brush	设置画刷属性。
tsdk_set_current_sharing_component	设置共享组件。
tsdk_doc_share_set_zoom_mode	设置文档共享的缩放模式。
tsdk_app_share_attach_render	绑定AS共享显示窗口。
tsdk_app_share_detach_render	解绑AS共享显示窗口。
tsdk_app_share_set_render_view_size	设置AS共享显示大小。
tsdk_get_share_statistic_info	获取共享统计信息。

tsdk_book_conference

接口描述

预约会议（延时召开或立即召开）。

前提条件

鉴权登录成功。
会议环境参数已设置。

注意事项

当实际与会者数目多于设置的方数时服务会自动扩大会议方数，当填写方数小于3时，服务器默认会议方数为3。
会议开始时间如果没有指定，则表示会议马上开始。
服务器默认时间为UTC时间，在预约时需将预约时间转换为UTC时间。

如果创建的是立即会议，会议创建成功后，SDK会自动加入会议.

方法定义

TSDK_API TSDK_RESULT tsdk_book_conference(IN TSDK_S_BOOK_CONF_INFO *book_conf_info) 

									 

参数描述

参数名	是否必须	类型	描述
[in] book_conf_info	是	TSDK_S_BOOK_CONF_INFO*	预约会议信息。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码，取值参考TSDK_E_CONF_ERR_ID。

代码示例

TSDK_RESULT ret;
ret = tsdk_book_conference(bookConfInfo);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("book conf failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_query_conference_list

接口描述

用户调用本接口，可以获取用户会议列表，包括用户自己创建的会议，以及待参加的会议。

前提条件

鉴权登录成功。
会议环境参数已设置。

注意事项

对应的回调事件为TSDK_E_CONF_EVT_QUERY_CONF_LIST_RESULT。

方法定义

TSDK_API TSDK_RESULT tsdk_query_conference_list(IN TSDK_S_QUERY_CONF_LIST_REQ *query_req)

参数描述

参数名	是否必须	类型	描述
[in] query_req	是	TSDK_S_QUERY_CONF_LIST_REQ*	获取会议列表信息请求结构。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_RESULT ret;
ret = tsdk_query_conference_list(arg);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("get conf list failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_query_conference_detail

接口描述

调用此接口可获取指定会议的详细信息。

前提条件

鉴权登录成功。
会议环境参数已设置。

注意事项

对应的回调事件为TSDK_E_CONF_EVT_QUERY_CONF_DETAIL_RESULT。

方法定义

TSDK_API TSDK_RESULT tsdk_query_conference_detail(IN TSDK_S_QUERY_CONF_DETAIL_REQ *query_req) 

									 

参数描述

参数名	是否必须	类型	描述
[in] query_req	是	TSDK_S_QUERY_CONF_DETAIL_REQ *	获取会议详细信息请求结构。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_RESULT ret;
ret = tsdk_query_conference_detail(arg);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("query conference detail failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_join_conference

接口描述

调用此接口主动加入会议。

注意事项

对应的回调事件为TSDK_E_CONF_EVT_JOIN_CONF_RESULT。

方法定义

TSDK_API TSDK_RESULT tsdk_join_conference(IN TSDK_S_CONF_JOIN_PARAM* conf_join_param, IN TSDK_CHAR* join_number, IN TSDK_BOOL is_video_join, OUT TSDK_UINT32 *call_id);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_join_param	是	TSDK_S_CONF_JOIN_PARAM	入会参数。
[in] join_number	是	TSDK_CHAR *	入会号码。
[in] is_video_join	是	TSDK_BOOL	是否视频接入会议。
[out] call_id	是	TSDK_UINT32	会议对应的呼叫ID，在使用SIP终端号码入会时有效。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_RESULT ret;
ret = tsdk_join_conference(confJoinParam, joinNumber, isVideoJoin, callId);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("join conf failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_accept_conference

接口描述

接听会议来电。

注意事项

无。

方法定义

TSDK_API TSDK_RESULT tsdk_accept_conference(IN TSDK_UINT32 conf_handle, IN TSDK_BOOL join_video_conf) 

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[in] join_video_conf	是	TSDK_BOOL	是否接入视频会议。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_RESULT ret;
ret = tsdk_accept_conference(confHandle, isJoinVideo);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("accept conf failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_reject_conference

接口描述

收到邀请加入会议的请求时，通过调用此接口拒绝会议来电邀请。

注意事项

无。

方法定义

TSDK_API TSDK_RESULT tsdk_reject_conference(IN TSDK_UINT32 conf_handle)

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_RESULT ret;
ret = tsdk_reject_conference(confHandle);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("reject conf failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_leave_conference

接口描述

与会者可以通过调用本接口，在会议中主动退出会议。

注意事项

对应的最终结果事件通知为TSDK_E_CONF_EVT_INFO_AND_STATUS_UPDATE。

方法定义

TSDK_API TSDK_RESULT tsdk_leave_conference(IN TSDK_UINT32 conf_handle) 

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_RESULT ret;
ret = tsdk_leave_conference(confHandle);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("leave conf failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_end_conference

接口描述

会议主席可以通过调用本接口结束正在召开的会议。

注意事项

回调事件：TSDK_E_CONF_EVT_CONF_END_IND。

方法定义

TSDK_API TSDK_RESULT tsdk_end_conference  ( IN TSDK_UINT32  conf_handle ) 

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_RESULT ret;
ret = tsdk_end_conference(confHandle);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("end conf failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_upgrade_conference

接口描述

本接口用于升级会议模式，包括语音会议升级为数据会议、视频会议升级为数据会议。

注意事项

前提条件：已创建待升级的会议。

对应的结果事件通知为TSDK_E_CONF_EVT_CONFCTRL_OPERATION_RESULT。

方法定义

TSDK_API TSDK_RESULT tsdk_upgrade_conference(IN TSDK_UINT32 conf_handle, IN TSDK_S_CONF_UPGRADE_PARAM* upgrade_param);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[in] upgrade_param	是	TSDK_S_CONF_UPGRADE_PARAM*	会议升级参数(可选，当前可填写为空)。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_RESULT ret;
ret = tsdk_upgrade_conference(confHandle, upgradeParam);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("update data conf failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_mute_conference

接口描述

设置或取消闭音会场。

注意事项

设置会议闭音后，除主席外，其他所有与会者均不可说（只可听）。
前提条件：与会者通过主席身份加入会议。
对应的结果事件通知为TSDK_E_CONF_EVT_CONFCTRL_OPERATION_RESULT。

方法定义

TSDK_API TSDK_RESULT tsdk_mute_conference(IN TSDK_UINT32 conf_handle, IN TSDK_BOOL is_mute)

									 

参数描述

参数名

是否必须

类型

描述

[in] conf_handle

是

TSDK_UINT32

会控句柄。

[in] is_mute

是

TSDK_BOOL

是否闭音。

TSDK_TURE：闭音
TSDK_FALSE：取消闭音

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_RESULT ret;
ret = tsdk_mute_conference(confHandle, isMute);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("mute conference failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_add_attendee

接口描述

会议主席添加新的与会者加入会议。

注意事项

前提条件：与会者通过主席身份加入会议。

对应的结果事件通知为TSDK_E_CONF_EVT_CONFCTRL_OPERATION_RESULT。

方法定义

TSDK_API TSDK_RESULT tsdk_add_attendee(IN TSDK_UINT32 conf_handle, IN const TSDK_S_ADD_ATTENDEES_INFO* add_attendees_info);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[in] add_attendees_info	是	TSDK_S_ADD_ATTENDEES_INFO*	添加与会者信息。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_RESULT ret;
ret = tsdk_add_attendee(confHandle, addAttendeeInfo);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("add conf member failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_redial_attendee

接口描述

重拨与会者。

注意事项

无。

方法定义

TSDK_API TSDK_RESULT tsdk_redial_attendee(IN TSDK_UINT32 conf_handle, IN const TSDK_CHAR* attendee);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[in] attendee	是	TSDK_CHAR*	与会者号码。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_UINT32 confHandle = get_data_conf_handle();
TSDK_RESULT ret;
ret = tsdk_redial_attendee(confHandle,attendee);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("redial attendee failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_hang_up_attendee

接口描述

挂断与会者。

注意事项

前提条件：与会者通过主席身份加入会议。

对应的结果事件通知为TSDK_E_CONF_EVT_CONFCTRL_OPERATION_RESULT。

方法定义

TSDK_API TSDK_RESULT tsdk_hang_up_attendee(IN TSDK_UINT32 conf_handle, IN const TSDK_CHAR* attendee);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[in] attendee	是	TSDK_CHAR*	与会者号码。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_RESULT ret;
ret = tsdk_hang_up_attendee(confHandle, attendee);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("hangup mem failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_remove_attendee

接口描述

删除与会者，包括踢出正在会议中的与会者、移除已离会的与会者和取消正在邀请的与会者。

注意事项

对应的结果事件通知为TSDK_E_CONF_EVT_CONFCTRL_OPERATION_RESULT。

方法定义

TSDK_API TSDK_RESULT tsdk_remove_attendee(IN TSDK_UINT32 conf_handle, IN const TSDK_CHAR* attendee);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[in] attendee	是	TSDK_CHAR*	与会者号码。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_RESULT ret;
ret = tsdk_remove_attendee(confHandle, attendee);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("remove mem failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_mute_attendee

接口描述

设置与会者闭音。设置闭音后，该与会者不可说（只可听）。

注意事项

前提条件：主席和与会者均已在会议中。

主席可对所有与会者设置或取消闭音，普通与会者只可对自己设置或取消闭音，被设置闭音时，与会者可听不可说。

对应的结果事件通知为TSDK_E_CONF_EVT_CONFCTRL_OPERATION_RESULT。

方法定义

TSDK_API TSDK_RESULT tsdk_mute_attendee(IN TSDK_UINT32 conf_handle, IN const TSDK_CHAR* attendee, IN TSDK_BOOL is_mute);

									 

参数描述

参数名

是否必须

类型

描述

[in] conf_handle

是

TSDK_UINT32

会控句柄。

[in] attendee

是

TSDK_CHAR *

与会者号码。

[in] is_mute

是

TSDK_BOOL

是否闭音。

TSDK_TURE：闭音
TSDK_FALSE：取消闭音

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_RESULT ret;
ret = tsdk_mute_attendee(confHandle, attendee, isMute);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("mute mem failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_set_handup

接口描述

会议中，普通与会者可以调用本接口设置或取消自己的举手，会议主席可以调用本接口取消其他与会者的举手。

注意事项

前提条件：主席和与会者均已在会议中。

对应的结果事件通知为TSDK_E_CONF_EVT_CONFCTRL_OPERATION_RESULT。

方法定义

TSDK_API TSDK_RESULT tsdk_set_handup(IN TSDK_UINT32 conf_handle, IN TSDK_BOOL is_handup, IN const TSDK_CHAR* attendee)

									 

参数描述

参数名

是否必须

类型

描述

[in] conf_handle

是

TSDK_UINT32

会控句柄。

[in] is_handup

是

TSDK_BOOL

是否举手。

TSDK_TURE：设置举手
TSDK_FALSE：取消举手

[in] attendee

是

TSDK_CHAR *

与会者号码（若设置自己，则无需填写）。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_RESULT ret;
ret = tsdk_set_handup(confHandle, isHandup, attendee);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("hand up failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_set_video_mode

接口描述

设置会议视频模式。

注意事项

对应的结果事件通知为TSDK_E_CONF_EVT_CONFCTRL_OPERATION_RESULT。

方法定义

TSDK_API TSDK_RESULT tsdk_set_video_mode(IN TSDK_UINT32 conf_handle, IN TSDK_E_CONF_VIDEO_MODE mode)

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[in] mode	是	TSDK_E_CONF_VIDEO_MODE	会议视频模式。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_RESULT ret;
ret = tsdk_set_video_mode(confHandle, confMode);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("set video conf mode failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_watch_attendee

接口描述

当主席广播会场时，主席侧可以选看会场，被广播的与会者侧以及其他与会者侧都不可以选看会场。

注意事项

前提条件：主席和与会者均已在会议中，且当前会议模式为“自由模式”。

建议应用程序UI在主席广播会场时，屏蔽选看入口。

对应的结果事件通知为TSDK_E_CONF_EVT_CONFCTRL_OPERATION_RESULT。

方法定义

TSDK_API TSDK_RESULT tsdk_watch_attendee(IN TSDK_UINT32 conf_handle, IN TSDK_S_WATCH_ATTENDEES_INFO* watch_attendee_info);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[in] watch_attendee_info	是	TSDK_S_WATCH_ATTENDEES_INFO*	选看与会者画面参数信息。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_RESULT ret;
ret = tsdk_watch_attendee(confHandle, attendee);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("watch attendee failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_broadcast_attendee

接口描述

广播或取消广播指定与会者（会场）。

注意事项

前提条件：主席和与会者均已在会议中，且当前会议模式为“广播模式”。

对应的结果事件通知为TSDK_E_CONF_EVT_CONFCTRL_OPERATION_RESULT。

方法定义

TSDK_API TSDK_RESULT tsdk_broadcast_attendee(IN TSDK_UINT32 conf_handle, IN TSDK_CHAR* attendee, IN TSDK_BOOL is_roadcast)

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[in] attendee	是	TSDK_CHAR*	与会者号码。
[in] is_roadcast	是	TSDK_BOOL	广播或是取消广播。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_RESULT ret;
ret = tsdk_broadcast_attendee(confHandle, attendee, isRoadcast);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("broadcast attendee failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_request_chairman

接口描述

申请主席权限。

注意事项

对应的结果事件通知为TSDK_E_CONF_EVT_CONFCTRL_OPERATION_RESULT。

方法定义

TSDK_API TSDK_RESULT tsdk_request_chairman(IN TSDK_UINT32 conf_handle, IN TSDK_CHAR* password)

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[in] password	是	TSDK_CHAR*	主席密码，On-premise VC会议和Hosted VC会议需要填写。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_RESULT ret;
ret = tsdk_request_chairman(confHandle,pwd);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("request chairman failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_release_chairman

接口描述

释放主席权限。

注意事项

对应的结果事件通知为TSDK_E_CONF_EVT_CONFCTRL_OPERATION_RESULT。

方法定义

TSDK_API TSDK_RESULT tsdk_release_chairman(IN TSDK_UINT32 conf_handle)

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_RESULT ret;
ret = tsdk_release_chairman(confHandle);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("release chairman failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_postpone_conference

接口描述

延长会议。

注意事项

对应的结果事件通知为TSDK_E_CONF_EVT_CONFCTRL_OPERATION_RESULT。

方法定义

TSDK_API TSDK_RESULT tsdk_postpone_conference(IN TSDK_UINT32 conf_handle, IN TSDK_UINT16 time);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[in] time	是	TSDK_UINT16	延长时间，单位：分钟。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_RESULT ret;
ret = tsdk_postpone_conference(confHandle,time);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("postpone conference failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_join_data_conference

接口描述

加入数据会议。

注意事项

对应的结果事件通知为TSDK_E_CONF_EVT_JOIN_DATA_CONF_RESULT。

方法定义

TSDK_API TSDK_RESULT tsdk_join_data_conference(IN TSDK_UINT32 conf_handle)

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_RESULT ret;
ret = tsdk_join_data_conference(confHandle);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("join data conf failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_p2p_transfer_to_conference

接口描述

两方通话转多方会议。

注意事项

无。

方法定义

TSDK_API TSDK_RESULT tsdk_p2p_transfer_to_conference(IN TSDK_UINT32 call_id, IN TSDK_S_BOOK_CONF_INFO *book_conf_info);

									 

参数描述

参数名	是否必须	类型	描述
[in] call_id	是	TSDK_UINT32	点对点通话呼叫id。
[in] book_conf_info	是	TSDK_S_BOOK_CONF_INFO *	预约会议信息。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码，取值参考TSDK_E_CONF_ERR_ID。

代码示例

TSDK_RESULT ret;
ret = tsdk_p2p_transfer_to_conference(callId,bookConfInfo);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("p2p transfer to conference failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_join_conference_by_anonymous

接口描述

匿名方式加入会议。

注意事项

无。

方法定义

TSDK_INT32 tsdk_join_conference_by_anonymous(IN TSDK_S_CONF_ANONYMOUS_JOIN_PARAM *conf_join_param);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_join_param	是	TSDK_S_CONF_ANONYMOUS_JOIN_PARAM *	匿名入会参数。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

// c code
TSDK_RESULT ret;
ret = tsdk_join_conference_by_anonymous(confJoinParam);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("join conference by anonymous failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_set_record_broadcast

接口描述

设置会议录播。

注意事项

对应的结果事件通知为TSDK_E_CONF_EVT_CONFCTRL_OPERATION_RESULT。

方法定义

TSDK_API TSDK_RESULT tsdk_set_record_broadcast(IN TSDK_UINT32 conf_handle, IN TSDK_E_CONF_RECORD_STATUS record_broadcast);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[in] record_broadcast	是	TSDK_E_CONF_RECORD_STATUS	会议录播状态。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_set_live_broadcast

接口描述

设置会议直播。

注意事项

对应的结果事件通知为TSDK_E_CONF_EVT_CONFCTRL_OPERATION_RESULT。

方法定义

TSDK_API TSDK_RESULT tsdk_set_live_broadcast(IN TSDK_UINT32 conf_handle, IN TSDK_E_CONF_RECORD_STATUS live_broadcast);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[in] live_broadcast	是	TSDK_E_CONF_RECORD_STATUS	会议直播状态。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_set_presenter

接口描述

设置主讲人。

注意事项

无。

方法定义

TSDK_API TSDK_RESULT tsdk_set_presenter(IN TSDK_UINT32 conf_handle, IN const TSDK_CHAR* attendee);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[in] const attendee	是	TSDK_CHAR*	与会者号码。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_RESULT ret;
ret = tsdk_set_presenter(confHandle, attendee);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("set presenter failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_request_presenter

接口描述

申请主讲人。

注意事项

无。

方法定义

TSDK_API TSDK_RESULT tsdk_request_presenter(IN TSDK_UINT32 conf_handle);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_UINT32 confHandle = get_data_conf_handle();
TSDK_RESULT ret;
ret = tsdk_request_presenter(confHandle);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("share start failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_app_share_set_owner

接口描述

设置屏幕共享的拥有者。

注意事项

无。

方法定义

TSDK_API TSDK_RESULT tsdk_app_share_set_owner(IN TSDK_UINT32 conf_handle, IN const TSDK_CHAR* attendee, IN TSDK_E_CONF_AS_ACTION_TYPE action);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[in] attendee	是	TSDK_CHAR*	与会者号码。
[in] action	是	TSDK_E_CONF_AS_ACTION_TYPE	设置动作, 参考TSDK_E_CONF_AS_ACTION_TYPE。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_RESULT ret;
ret = tsdk_app_share_set_owner(confHandle, attendee, action);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("share set owner failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_app_share_start

接口描述

开始桌面共享或应用程序共享。

注意事项

无。

方法定义

TSDK_API TSDK_RESULT tsdk_app_share_start(IN TSDK_UINT32 conf_handle, IN TSDK_E_CONF_APP_SHARE_TYPE share_type);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[in] share_type	是	TSDK_E_CONF_APP_SHARE_TYPE	应用共享类型。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_UINT32 confHandle = get_data_conf_handle();
TSDK_RESULT ret;
ret = tsdk_app_share_start(confHandle, shareType);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("share start failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_app_share_stop

接口描述

停止桌面共享或应用程序共享。

注意事项

无。

方法定义

TSDK_API TSDK_RESULT tsdk_app_share_stop(IN TSDK_UINT32 conf_handle);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_RESULT ret;
ret = tsdk_app_share_stop(confHandle);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("share stop failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_app_share_get_screen_data

接口描述

获取屏幕数据。

注意事项

无。

方法定义

TSDK_API TSDK_RESULT tsdk_app_share_get_screen_data(IN TSDK_UINT32 conf_handle, OUT TSDK_S_CONF_AS_SCREEN_DATA *screen_data);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[out] screen_data	是	TSDK_S_CONF_AS_SCREEN_DATA*	屏幕数据。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_RESULT ret;
ret = tsdk_app_share_get_screen_data(confHandle, screenData);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("share get screen data failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_doc_share_open_document

接口描述

打开共享文档。

注意事项

用于PC，移动设备不支持此功能。

方法定义

TSDK_API TSDK_RESULT tsdk_doc_share_open_document(IN TSDK_UINT32 conf_handle, 
    IN const TSDK_CHAR* file_name, IN TSDK_E_DOC_SHARE_OPTION option, OUT TSDK_UINT32* document_id);

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[in] file_name	是	TSDK_CHAR*	要打开的共享文档的全路径(utf8编码字符串)，不能为NULL。
[in] option	是	TSDK_E_DOC_SHARE_OPTION	打开文档选项。 TSDK_E_DOC_SHARE_QUALITY 质量优先，优先采用EMF格式 TSDK_E_DOC_SHARE_SIZE 带宽优先，优先采用JPG格式
[out] document_id	是	TSDK_UINT32*	文档ID。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

CString docmentPath;
CFileDialog filedlg(TRUE);
if (filedlg.DoModal())
{
    docmentPath = filedlg.GetPathName();
}
unsigned int newdocid = 0;
service_data_conf_ds_share_open_document(CTools::UNICODE2UTF(docmentPath).c_str(),&newdocid);

int service_data_conf_ds_share_open_document(const char* file_path,unsigned int* doc_id)
{
   TSDK_RESULT ret;
   ret = tsdk_doc_share_open_document(confHandle,file_path,TSDK_E_DOC_SHARE_SIZE,doc_id);
   if (TSDK_SUCCESS != ret)
   {
       LOG_D_CALL_ERROR("share open document failed. result=%#x", ret);
       return -1;
}
return TSDK_SUCCESS;
}

									 

tsdk_doc_share_close_document

接口描述

关闭一个文档。

注意事项

用于PC，移动设备不支持此功能。

方法定义

TSDK_API TSDK_RESULT tsdk_doc_share_close_document(IN TSDK_UINT32 conf_handle, IN TSDK_UINT32 document_id);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[in] document_id	是	TSDK_UINT32	文档ID。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_RESULT ret;
ret = tsdk_doc_share_close_document(confHandle,docId);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("close document failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_doc_share_set_current_page

接口描述

设置当前显示的页面。

注意事项

无。

方法定义

TSDK_API TSDK_RESULT tsdk_doc_share_set_current_page(IN TSDK_UINT32 conf_handle, IN TSDK_S_DOC_PAGE_BASE_INFO* page_info, IN TSDK_BOOL is_sync);

									 

参数描述

参数

是否必须

类型

描述

[in] conf_handle

是

TSDK_UINT32

会控句柄，为0时用于文档预览。

[in] page_info

是

TSDK_S_DOC_PAGE_BASE_INFO*

页面信息，参考结构体TSDK_S_DOC_PAGE_BASE_INFO。

[in] is_sync

是

TSDK_BOOL

是否同步设置。

TRUE同步
FALSE非同步

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_RESULT ret;
TSDK_S_DOC_PAGE_BASE_INFO page_info;
page_info.component_id = TSDK_E_COMPONENT_DS;
page_info.document_id = docId;
page_info.page_index = pageIndex;
ret = tsdk_doc_share_set_current_page(confHandle,&page_info,isSyn);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("set current page failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_doc_share_set_canvas_size

接口描述

设置显示区域的大小。

注意事项

无。

方法定义

TSDK_API TSDK_RESULT tsdk_doc_share_set_canvas_size(IN TSDK_UINT32 conf_handle,
    IN TSDK_E_COMPONENT_ID component_id, TSDK_S_SIZE *size, IN TSDK_BOOL is_redraw);

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会议句柄, 为0时，用于文档预览。
[in] component_id	是	TSDK_E_COMPONENT_ID	组件ID，TSDK_E_COMPONENT_DS表示共享文档。
[in] size	是	TSDK_S_SIZE *	显示区域的宽高，以TWIPS为单位。
[in] is_redraw	是	TSDK_BOOL	是否立刻重绘。 TRUE重绘 FALSE不重绘

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_S_SIZE c_size;
c_size.width = size.width;
c_size.high = size.high;
(void)tsdk_doc_share_set_canvas_size(conf_handle, TSDK_E_COMPONENT_DS, &c_size,TSDK_TRUE);
return 0;

									 

tsdk_doc_share_get_surface_bmp

接口描述

获取渲染好的当前页面图像。

注意事项

无。

方法定义

TSDK_API TSDK_VOID* tsdk_doc_share_get_surface_bmp(IN TSDK_UINT32 conf_handle,
    IN TSDK_E_COMPONENT_ID component_id, OUT TSDK_UINT32* width, OUT TSDK_UINT32* height);

参数描述

参数	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会议句柄为0时，用于文档预览。
[in] component_id	是	TSDK_E_COMPONENT_ID	组件ID，TSDK_E_COMPONENT_DS表示共享文档。
[out] width	是	TSDK_UINT32*	图像的宽度，以TWIPS为单位。
[out] height	是	TSDK_UINT32*	图像的高度，以TWIPS为单位。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

unsigned int bmpWidth;
unsigned int bmpHeight;

void* data = NULL;
data = tsdk_doc_share_get_surface_bmp(confHandle,TSDK_E_COMPONENT_DS,&bmpWidth,&bmpHeight);
if (NULL == data)
{
    LOG_D_CALL_ERROR("get surface bmp failed.");
    return NULL;
}
return data;

									 

tsdk_doc_share_get_syn_document_info

接口描述

获取服务器上的当前信息。

注意事项

无。

方法定义

TSDK_API TSDK_RESULT tsdk_doc_share_get_syn_document_info(IN TSDK_UINT32 conf_handle,
    IN TSDK_E_COMPONENT_ID component_id, OUT TSDK_S_DOC_PAGE_DETAIL_INFO* info);

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会议句柄为0时，用于文档预览。
[in] component_id	是	TSDK_E_COMPONENT_ID	组件ID，TSDK_E_COMPONENT_DS表示共享文档。
[out] info	是	TSDK_S_DOC_PAGE_DETAIL_INFO*	文档同步信息

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_S_DOC_PAGE_DETAIL_INFO info;
service_data_conf_ds_share_get_syn_document_info(&info);
m_docId = info.doc_page_info.document_id;
m_pageNum = info.doc_page_info.page_index;

int service_data_conf_ds_share_get_syn_document_info(TSDK_S_DOC_PAGE_DETAIL_INFO* sync_info)
{
    TSDK_RESULT ret;
    ret = tsdk_doc_share_get_syn_document_info(confHandle,TSDK_E_COMPONENT_DS,sync_info);
    if (TSDK_SUCCESS != ret)
    {
        LOG_D_CALL_ERROR("get syn document info failed. result=%#x", ret);
        return -1;
    }
    return TSDK_SUCCESS;
}

									 

tsdk_doc_share_set_background_color

接口描述

设置文档共享模块画布的背景色。

注意事项

用于PC，移动设备不支持此功能。

方法定义

TSDK_API TSDK_RESULT tsdk_doc_share_set_background_color(IN TSDK_UINT32 conf_handle,
    IN TSDK_E_COMPONENT_ID component_id, IN TSDK_UINT32 background_color);

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会议句柄为0时，用于文档预览。
[in] component_id	是	TSDK_E_COMPONENT_ID	组件ID，TSDK_E_COMPONENT_DS表示共享文档。
[in] background_color	是	TSDK_UINT32	背景颜色。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_RESULT ret;
ret = tsdk_doc_share_set_background_color(confHandle,TSDK_E_COMPONENT_DS,0xFFFFFFFF);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("set background color failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_doc_share_set_display_mode

接口描述

设置文档共享模块的显示模式。

注意事项

用于PC，移动设备不支持此功能。

方法定义

TSDK_API TSDK_RESULT tsdk_doc_share_set_display_mode(IN TSDK_UINT32 conf_handle,
    IN TSDK_E_COMPONENT_ID component_id, IN TSDK_E_DOC_SHARE_DISPLAY_MODE display_mode);

参数描述

参数名

是否必须

类型

描述

[in] conf_handle

是

TSDK_UINT32

会议句柄为0时，用于文档预览。

[in] component_id

是

TSDK_E_COMPONENT_ID

组件ID，TSDK_E_COMPONENT_DS表示共享文档。

[in] display_mode

是

TSDK_E_DOC_SHARE_DISPLAY_MODE

显示模式。

TSDK_E_DOC_SHARE_DISPLAY_MODE_FREE 自由模式
TSDK_E_DOC_SHARE_DISPLAY_MODE_CENTER 中心显示

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_send_chat_msg_in_conference

接口描述

会议中发送即时消息。

注意事项

无。

方法定义

TSDK_API TSDK_RESULT tsdk_send_chat_msg_in_conference(IN TSDK_UINT32 conf_handle, IN TSDK_S_CONF_CHAT_MSG_INFO* chat_msg_info);

									 

参数描述

参数	是否必须	类型	可选/必选	描述
[in] conf_handle	是	TSDK_UINT32	必选	会控句柄。
[in] chat_msg_info	是	TSDK_S_CONF_CHAT_MSG_INFO*	必选	聊天相关信息，参考结构体TSDK_S_CONF_CHAT_MSG_INFO。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_RESULT ret;
ret = tsdk_send_chat_msg_in_conference(confHandle, chatMsgInfo);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("send chat msg failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_whiteboard_new_document

接口描述

新建一个空的白板文档。

注意事项

用于PC，移动设备不支持此功能。

方法定义

TSDK_API TSDK_RESULT tsdk_whiteboard_new_document(IN TSDK_UINT32 conf_handle, OUT TSDK_UINT32* document_id);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[out] document_id	是	TSDK_UINT32*	白板文档ID。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_whiteboard_delete_document

接口描述

删除白板文档。

注意事项

用于PC，移动设备不支持此功能。

方法定义

TSDK_API TSDK_RESULT tsdk_whiteboard_delete_document(IN TSDK_UINT32 conf_handle, IN TSDK_UINT32 document_id);

									 

参数描述

参数	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[in] document_id	是	TSDK_UINT32	白板文档ID。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_whiteboard_new_page

接口描述

在指定的白板文档中新建白板页。

注意事项

用于PC，移动设备不支持此功能。

方法定义

TSDK_API TSDK_RESULT tsdk_whiteboard_new_page(IN TSDK_UINT32 conf_handle, IN TSDK_UINT32 document_id, 
    IN TSDK_INT32 width, IN TSDK_INT32 height, OUT TSDK_UINT32* page_id);

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[in] document_id	是	TSDK_UINT32	白板文档ID。
[in] width	是	TSDK_UINT32	要创建的页面的宽度，以TWIPS为单位。
[in] height	是	TSDK_UINT32	要创建的页面的高度，以TWIPS为单位。
[out] page_id	是	TSDK_UINT32*	指定白板页面的ID。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_whiteboard_delete_page

接口描述

删除指定白板文档中的指定页面。

注意事项

用于PC，移动设备不支持此功能。

方法定义

TSDK_API TSDK_RESULT tsdk_whiteboard_delete_page(IN TSDK_UINT32 conf_handle, IN TSDK_UINT32 document_id, IN TSDK_UINT32 page_id);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[in] document_id	是	TSDK_UINT32	白板文档ID。
[in] page_id	是	TSDK_UINT32	指定白板页面的ID。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_annotation_create_start

接口描述

开始创建一个标注。

注意事项

无。

方法定义

TSDK_API TSDK_RESULT tsdk_annotation_create_start(IN TSDK_UINT32 conf_handle, IN TSDK_E_COMPONENT_ID component_id, IN TSDK_S_DOC_PAGE_BASE_INFO* page_info, IN TSDK_E_ANNOTATION_MAIN_TYPE main_type, IN TSDK_UINT32 sub_type, IN TSDK_S_POINT *point);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄为0时，用于文档预览。
[in]component_id	是	TSDK_E_COMPONENT_ID	组件ID。
[in] page_info	是	TSDK_S_DOC_PAGE_BASE_INFO*	页面信息。
[in] main_type	是	TSDK_E_ANNOTATION_MAIN_TYPE	标注主类型，这里暂时只有DS_ANNOT_TYPE_DRAWING和DS_ANNOT_TYPE_CUSTOMER两种。
[in] sub_type	是	TSDK_UINT32	标注子类型，包括DRAWING的子类型和通过conf_annotation_reg_customer_type注册的类型。
[in] point	是	TSDK_S_POINT*	创建标注的起点，一般是鼠标按下的点或图片标注的左上角，以TWIPS为单位，且该值必须是相对于页面左上角并且无缩放情况下的值，向下向右为正。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_annotation_create_update

接口描述

标注创建过程中更新数据。

注意事项

用于PC，移动设备不支持此功能。

方法定义

TSDK_API TSDK_RESULT tsdk_annotation_create_update(IN TSDK_UINT32 conf_handle, IN TSDK_E_COMPONENT_ID component_id, IN TSDK_VOID* data);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄为0时，用于文档预览。
[in] component_id	是	TSDK_E_COMPONENT_ID	组件ID，TSDK_E_COMPONENT_DS表示共享文档。
[in] main_type	是	TSDK_E_ANNOTATION_MAIN_TYPE	标注主类型，这里暂时只有TSDK_E_ANNOTATION_DRAWING。
[in] data	是	TSDK_VOID*	更新数据，对于DS_ANNOT_TYPE_DRAWING类的标注，数据类型为CreateDrawingData。对于DS_ANNOT_TYPE_CUSTOMER类的标注，数据类型为CreateCustomerData。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_annotation_create_done

接口描述

标注创建结束。

注意事项

无。

方法定义

TSDK_API TSDK_RESULT tsdk_annotation_create_done(IN TSDK_UINT32 conf_handle, IN TSDK_E_COMPONENT_ID component_id, 
    IN TSDK_BOOL is_cancel, OUT TSDK_UINT32* annotation_id);

参数描述

参数	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄为0时，用于文档预览。
[in] component_id	是	TSDK_E_COMPONENT_ID	组件ID。
[in] is_cancel	是	TSDK_BOOL	是取消创建还是创建完成。 0：完成创建 1：取消创建，完成创建则该标注被添加到创建的页面上，取消创建则会删除该标注
[out] annotation_id	是	TSDK_UINT32*	创建完成后通过该参数返回该标注的ID，如果为NULL则不返回。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_annotation_select_start

接口描述

开启鼠标选择功能。

注意事项

用于PC，移动设备不支持此功能。

方法定义

TSDK_API TSDK_RESULT tsdk_annotation_select_start(IN TSDK_UINT32 conf_handle, IN TSDK_E_COMPONENT_ID component_id, IN TSDK_S_DOC_PAGE_BASE_INFO* page_info, IN TSDK_S_POINT *point);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄为0时，用于文档预览。
[in] component_id	是	TSDK_E_COMPONENT_ID	组件ID。
[in] page_info	是	TSDK_S_DOC_PAGE_BASE_INFO*	页面信息。
[in] point	是	TSDK_S_POINT*	创建标注的起点，一般是鼠标按下的点或图片标注的左上角，以TWIPS为单位，且该值必须是相对于页面左上角并且无缩放情况下的值，向下向右为正。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_annotation_select_update

接口描述

更新鼠标选择功能。

注意事项

用于PC，移动设备不支持此功能。

方法定义

TSDK_API TSDK_RESULT tsdk_annotation_select_update(IN TSDK_UINT32 conf_handle, IN TSDK_E_COMPONENT_ID component_id, TSDK_S_POINT *point);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄为0时，用于文档预览。
[in] component_id	是	TSDK_E_COMPONENT_ID	组件ID。
[in] point	是	TSDK_S_POINT*	当前点。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_annotation_select_done

接口描述

结束鼠标选择。

注意事项

用于PC，移动设备不支持此功能。

方法定义

TSDK_API TSDK_RESULT tsdk_annotation_select_done(IN TSDK_UINT32 conf_handle, IN TSDK_E_COMPONENT_ID component_id, TSDK_S_POINT *point,
    IN TSDK_E_ANNOTATION_SELECT_MODE select_mode, IN TSDK_CHAR* attendee, OUT TSDK_UINT32** annotation_id_list, OUT TSDK_UINT32 *count);

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄为0时用于文档预览。
[in] component_id	是	TSDK_E_COMPONENT_ID	组件ID。
[in] point	是	TSDK_S_POINT*	结束点。
[in] select_mode	是	TSDK_E_ANNOTATION_SELECT_MODE	选择模式
[in] attendee	是	TSDK_CHAR*	选择的用户ID。
[out] annotation_id_list	是	TSDK_UINT32**	被选择的标注列表
[out] count	是	TSDK_UINT32*	通过该参数返回选中标注数组中的元素个数。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_annotation_laser_pointer_start

接口描述

开始激光点。

注意事项

用于PC，移动设备不支持此功能。

方法定义

TSDK_API TSDK_RESULT tsdk_annotation_laser_pointer_start(IN TSDK_UINT32 conf_handle, IN TSDK_E_COMPONENT_ID component_id, 
    IN TSDK_S_ANNOTATION_LASER_POINTER_INFO* laser_pointer_info);

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄为0时用于文档预览。
[in] component_id	是	TSDK_E_COMPONENT_ID	组件ID。
[in] laser_pointer_info	是	TSDK_S_ANNOTATION_LASER_POINTER_INFO*	激光点信息。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_annotation_laser_pointer_moveto

接口描述

移动激光点。

注意事项

用于PC，移动设备不支持此功能。

方法定义

TSDK_API TSDK_RESULT tsdk_annotation_laser_pointer_moveto(IN TSDK_UINT32 conf_handle, IN TSDK_E_COMPONENT_ID component_id, IN TSDK_S_POINT *point);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄为0时用于文档预览。
[in] component_id	是	TSDK_E_COMPONENT_ID	组件ID。
[in] point	是	TSDK_S_POINT*	移动到的点（激光点的中心坐标），以TWIPS为单位，且该值必须是相对于页面左上角并且无缩放情况下的值，向下向右为正。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_annotation_laser_pointer_stop

接口描述

结束激光点。

注意事项

只能结束自己的激光点，移动设备不支持此功能。

方法定义

TSDK_API TSDK_RESULT tsdk_annotation_laser_pointer_stop(IN TSDK_UINT32 conf_handle, IN TSDK_E_COMPONENT_ID component_id);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[in] component_id	是	TSDK_S_ANNOTATION_TEXT_INFO	组件ID，目前标注支持文档共享和白板。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_annotation_text_create

接口描述

创建文字标注。

注意事项

用于PC，移动设备不支持此功能。

方法定义

 TSDK_API TSDK_RESULT tsdk_annotation_text_create(IN TSDK_UINT32 conf_handle, IN TSDK_E_COMPONENT_ID component_id, IN TSDK_S_DOC_PAGE_BASE_INFO* page_info, IN TSDK_S_ANNOTATION_TEXT_INFO *text_info, OUT TSDK_UINT32* annotation_id);

									 

参数描述

参数	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会议句柄为0时，用于文档预览。
[in] component_id	是	TSDK_E_COMPONENT_ID	组件ID。
[in] page_info	是	TSDK_S_DOC_PAGE_BASE_INFO*	页面信息。
[in] text_info	是	TSDK_S_ANNOTATION_TEXT_INFO*	文字标注的信息。
[out] annotation_id	是	TSDK_UINT32*	创建成功后通过该参数返回创建成功的标注的ID，如果该参数为NULL则不返回。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_annotation_text_update

接口描述

更新文字标注。

注意事项

用于PC，移动设备不支持此功能。

方法定义

TSDK_API TSDK_RESULT tsdk_annotation_text_update(IN TSDK_UINT32 conf_handle, IN TSDK_E_COMPONENT_ID component_id, IN TSDK_S_DOC_PAGE_BASE_INFO* page_info, IN TSDK_UINT32 annotation_id,
    IN TSDK_S_ANNOTATION_TEXT_INFO *text_info, IN TSDK_BOOL is_redraw);

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会议句柄为0时，用于文档预览。
[in] component_id	是	TSDK_E_COMPONENT_ID	组件ID。
[in] page_info	是	TSDK_S_DOC_PAGE_BASE_INFO*	页面信息。
[in] annotation_id	是	TSDK_UINT32	要更新的文字标注的id。
[in] text_info	是	TSDK_S_ANNOTATION_TEXT_INFO*	文字标注的信息。
[in] is_redraw	是	TSDK_BOOL	更新成功后是否立刻重绘。 0：不重绘 1：重绘

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_annotation_edit_start

接口描述

开始编辑标注。

注意事项

用于PC，移动设备不支持此功能。

方法定义

TSDK_API TSDK_RESULT tsdk_annotation_edit_start(IN TSDK_UINT32 conf_handle, IN TSDK_E_COMPONENT_ID component_id, IN TSDK_S_DOC_PAGE_BASE_INFO* page_info, IN TSDK_UINT32* annotation_id_list, IN TSDK_UINT32 count,
    IN TSDK_UINT32 ref_annotation_id, IN TSDK_E_ANNOTATION_HIT_TEST_CODE hit_test_code, IN TSDK_S_POINT *start_point);

参数描述

参数	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会议句柄为0时，用于文档预览。
[in] component_id	是	TSDK_E_COMPONENT_ID	组件ID。
[in] page_info	是	TSDK_S_DOC_PAGE_BASE_INFO*	页面信息。
[in] annotation_id_list	是	TSDK_UINT32*	要编辑的标注id数组。
[in] count	是	TSDK_UINT32	annotids数组元素的个数。
[in] ref_annotation_id	是	TSDK_UINT32	多个标注一起编辑时用到的，表示当时鼠标落点所在的标注ID。
[in] hit_test_code	是	TSDK_E_ANNOTATION_HIT_TEST_CODE	编辑类型。
[in] start_point	是	TSDK_S_POINT*	编辑开始的点，以TWIPS为单位，且该值必须是相对于页面左上角并且无缩放情况下的值，向下向右为正。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_annotation_text_get_info

接口描述

获取一个文字标注的信息。

注意事项

用于PC，移动设备不支持此功能。

方法定义

TSDK_API TSDK_RESULT tsdk_annotation_text_get_info(IN TSDK_UINT32 conf_handle, IN TSDK_E_COMPONENT_ID component_id, IN TSDK_S_DOC_PAGE_BASE_INFO* page_info, IN TSDK_UINT32 annotation_id, OUT TSDK_S_ANNOTATION_TEXT_INFO *text_info);

									 

参数描述

参数	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会议句柄为0时，用于文档预览。
[in] component_id	是	TSDK_E_COMPONENT_ID	组件ID。
[in] page_info	是	TSDK_S_DOC_PAGE_BASE_INFO*	页面信息。
[in] annotation_id	是	TSDK_UINT32	要更新的文字标注的id。
[out] text_info	是	TSDK_S_ANNOTATION_TEXT_INFO*	文字标注的信息。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_annotation_edit_update

接口描述

编辑标注过程中的数据更新。

注意事项

用于PC，移动设备不支持此功能。

方法定义

TSDK_API TSDK_RESULT tsdk_annotation_edit_update(IN TSDK_UINT32 conf_handle, IN TSDK_E_COMPONENT_ID component_id, IN TSDK_S_POINT *current_point);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[in] component_id	是	TSDK_E_COMPONENT_ID	组件ID，目前标注支持文档共享和白板。
[in] current_point	是	TSDK_S_POINT*	移动到的点，以TWIPS为单位，且该值必须是相对于页面左上角并且无缩放情况下的值，向下向右为正。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_annotation_edit_done

接口描述

标注编辑完成。

注意事项

用于PC，移动设备不支持此功能。

方法定义

TSDK_API TSDK_RESULT tsdk_annotation_edit_done(IN TSDK_UINT32 conf_handle, IN TSDK_E_COMPONENT_ID component_id, IN TSDK_BOOL is_cancel);

									 

参数描述

参数名

是否必须

类型

描述

[in] conf_handle

是

TSDK_UINT32

会控句柄。

[in] component_id

是

TSDK_E_COMPONENT_ID

组件ID，目前标注支持文档共享和白板。

[in] is_cancel

是

TSDK_BOOL

是否取消操作。

0：否
1：是

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_annotation_hit_test_point

接口描述

测试一个点是否落在标注上。

注意事项

用于PC，移动设备不支持此功能。

方法定义

TSDK_API TSDK_RESULT tsdk_annotation_hit_test_point(IN TSDK_UINT32 conf_handle, IN TSDK_S_ANNOTATION_HIT_TEST_POINT_INFO* hit_test_point_info,
    OUT TSDK_UINT32* select_annotation_id, OUT TSDK_E_ANNOTATION_HIT_TEST_CODE* hit_test_code, OUT TSDK_UINT32* annotation_type);

参数描述

参数	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[in] hit_test_point_info	是	TSDK_S_ANNOTATION_HIT_TEST_POINT_INFO*	矩形标注信息集。
[out] select_annotation_id	是	TSDK_UINT32*	如果要测试的点选中了某个标注，通过该值返回。
[out] hit_test_code	是	TSDK_E_ANNOTATION_HIT_TEST_CODE*	测试结果。
[out] annotation_type	是	TSDK_UINT32*	点中的标注的标注类型通过该参数返回。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_annotation_hit_test_rect

接口描述

测试一个矩形框包括的标注。

注意事项

无。

方法定义

TSDK_API TSDK_RESULT tsdk_annotation_hit_test_rect(IN TSDK_UINT32 conf_handle, IN TSDK_S_ANNOTATION_HIT_TEST_RECT_INFO* hit_test_rect_info, 
    OUT TSDK_UINT32** annotation_id_list, OUT TSDK_UINT32 *count);

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[in] hit_test_rect_info	是	TSDK_S_ANNOTATION_HIT_TEST_RECT_INFO*	矩形标注信息集。
[out] annotation_id_list	是	TSDK_UINT32**	通过该参数返回被选中的标注的数组指针，应用层不能释放该内存。
[out] count	是	TSDK_UINT32*	通过该参数返回选中标注数组中的元素个数。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_annotation_hit_test_line

接口描述

测试一条直线包括的标注。

注意事项

无。

方法定义

TSDK_API TSDK_RESULT tsdk_annotation_hit_test_line(IN TSDK_UINT32 conf_handle, IN TSDK_S_ANNOTATION_HIT_TEST_LINE_INFO* hit_test_line_info, 
    OUT TSDK_UINT32** annotation_id_list, OUT TSDK_UINT32 *count);

参数描述

参数	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[in] hit_test_line_info	是	TSDK_S_ANNOTATION_HIT_TEST_LINE_INFO*	直线标注信息集。
[out] annotation_id_list	是	TSDK_UINT32**	通过该参数返回被选中的标注的数组指针，应用层不能释放该内存。
[out] count	是	TSDK_UINT32*	通过该参数返回选中标注数组中的元素个数。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_annotation_set_select

接口描述

设置标注的选中状态。

注意事项

用于PC，移动设备不支持此功能。

方法定义

TSDK_API TSDK_RESULT tsdk_annotation_set_select(IN TSDK_UINT32 conf_handle, IN TSDK_S_ANNOTATION_SELECT_INFO* select_info, IN TSDK_BOOL is_redraw);

									 

参数描述

参数

是否必须

类型

描述

[in] conf_handle

是

TSDK_UINT32

会控句柄。

[in] select_info

是

TSDK_S_ANNOTATION_SELECT_INFO*

选中标注相关信息。

[in] is_redraw

是

TSDK_BOOL

设置选中状态后是否立刻重绘。

1：是
0：否

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_annotation_delete_annotation

接口描述

删除标注。

注意事项

无。

方法定义

TSDK_API TSDK_RESULT tsdk_annotation_delete_annotation(IN TSDK_UINT32 conf_handle, IN TSDK_S_ANNOTATION_DELETE_INFO* delete_info);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[in] delete_info	是	TSDK_S_ANNOTATION_DELETE_INFO*	删除标注的相关信息。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_annotation_get_annotation_info

接口描述

获取指定标注的信息。

注意事项

用于PC，移动设备不支持此功能。

方法定义

TSDK_API TSDK_RESULT tsdk_annotation_get_annotation_info(IN TSDK_UINT32 conf_handle, IN TSDK_E_COMPONENT_ID component_id, IN TSDK_S_DOC_PAGE_BASE_INFO* page_info,
    IN TSDK_UINT32 annotation_id, OUT TSDK_S_ANNOTATION_BASE_INFO* annotation_base_info);

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[in] component_id	是	TSDK_E_COMPONENT_ID	组件ID。
[in] page_info	是	TSDK_S_DOC_PAGE_BASE_INFO*	页面信息。
[in] annotation_id	是	TSDK_UINT32	标注ID。
[out] annotation_base_info	是	TSDK_S_ANNOTATION_BASE_INFO*	标注信息结构体指针，用于保存获取到的标注信息，该参数不能为NULL。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_annotation_set_pen

接口描述

设置画笔属性。

注意事项

无。

方法定义

TSDK_API TSDK_RESULT tsdk_annotation_set_pen(IN TSDK_UINT32 conf_handle, IN TSDK_E_COMPONENT_ID component_id, IN TSDK_E_ANNOTATION_PEN_TYPE pen_type,
    IN TSDK_S_ANNOTATION_PEN_INFO *new_pen_info, OUT TSDK_S_ANNOTATION_PEN_INFO *old_pen_info);

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[in] component_id	是	TSDK_E_COMPONENT_ID	组件ID，目前标注支持文档共享和白板。
[in] pen_type	是	TSDK_E_ANNOTATION_PEN_TYPE	要设置的笔的类型，普通笔或高亮笔。
[in] new_pen_info	是	TSDK_S_ANNOTATION_PEN_INFO*	要设置的画笔的属性。
[out] old_pen_info	是	TSDK_S_ANNOTATION_PEN_INFO*	通过该参数返回原来的画笔的属性，如果该参数为NULL则不返回。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_annotation_set_brush

接口描述

设置画刷属性。

注意事项

无。

方法定义

TSDK_API TSDK_RESULT tsdk_annotation_set_brush(IN TSDK_UINT32 conf_handle, IN TSDK_E_COMPONENT_ID component_id,
    IN TSDK_S_ANNOTATION_BRUSH_INFO *new_brush_info, OUT TSDK_S_ANNOTATION_BRUSH_INFO* old_brush_info);

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[in] component_id	是	TSDK_E_COMPONENT_ID	组件ID，目前标注支持文档共享和白板。
[in] new_brush_info	是	TSDK_S_ANNOTATION_BRUSH_INFO*	要设置的画刷的属性。
[out] old_brush_info	是	TSDK_S_ANNOTATION_BRUSH_INFO*	通过该参数返回原来的画刷的属性，如果该参数为NULL则不返回。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_set_current_sharing_component

接口描述

设置当前共享的组件。

注意事项

无。

方法定义

TSDK_API TSDK_RESULT tsdk_set_current_sharing_component(IN TSDK_UINT32 conf_handle, TSDK_E_COMPONENT_ID component_id);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[in]component_id	是	TSDK_E_COMPONENT_ID	组件ID。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_doc_share_set_zoom_mode

接口描述

设置文档共享模块的缩放模式。

注意事项

无。

方法定义

TSDK_API TSDK_RESULT tsdk_doc_share_set_zoom_mode(IN TSDK_UINT32 conf_handle, IN TSDK_E_COMPONENT_ID component_id, IN TSDK_UINT32 document_id, IN TSDK_E_DOC_SHARE_ZOOM_MODE zoom_mode, IN TSDK_UINT32 zoom_percent, IN TSDK_BOOL is_sync, IN TSDK_BOOL is_redraw);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄。
[in] component_id	是	TSDK_E_COMPONENT_ID	组件id。
[in] document_id	是	TSDK_UINT32	文档id。
[in] zoom_mode	是	TSDK_E_DOC_SHARE_ZOOM_MODE	缩放模式。
[in] zoom_percent	是	TSDK_UINT32	缩放百分比，zoom_mode取值为TSDK_E_DOC_SHARE_ZOOM_PERCENT有效。
[in] is_sync	是	TSDK_BOOL	是否同步设置。 true 同步 false 非同步
[in] is_redraw	是	TSDK_BOOL	是否立刻重绘。 true 重绘 false 不重绘

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_app_share_attach_render

接口描述

绑定AS共享显示窗口。

注意事项

无。

方法定义

TSDK_API TSDK_RESULT tsdk_app_share_attach_render(IN TSDK_UINT32 conf_handle, TSDK_UPTR render_handle);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄
[in] render_handle	是	TSDK_UPTR	窗口句柄

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_app_share_detach_render

接口描述

解绑AS共享显示窗口。

注意事项

无。

方法定义

TSDK_API TSDK_RESULT tsdk_app_share_detach_render(IN TSDK_UINT32 conf_handle);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_app_share_set_render_view_size

接口描述

设置AS共享显示大小。

注意事项

无。

方法定义

TSDK_API TSDK_RESULT tsdk_app_share_set_render_view_size(IN TSDK_UINT32 conf_handle, IN TSDK_S_SIZE *render_view_size);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄
[in] render_view_size	是	TSDK_S_SIZE *	窗口大小

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

tsdk_get_share_statistic_info

接口描述

获取共享统计信息。

注意事项

无。

方法定义

TSDK_API TSDK_RESULT tsdk_get_share_statistic_info(IN TSDK_UINT32 conf_handle, OUT TSDK_S_SHARE_STATISTIC_INFO* share_statistic_info);

									 

参数描述

参数名	是否必须	类型	描述
[in] conf_handle	是	TSDK_UINT32	会控句柄
[out] share_statistic_info	是	TSDK_S_SHARE_STATISTIC_INFO*	共享统计信息

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

无。

入门使用

会议

会议管理

会议控制

数据会议

tsdk_book_conference

tsdk_query_conference_list

tsdk_query_conference_detail

tsdk_join_conference

tsdk_accept_conference

tsdk_reject_conference

tsdk_leave_conference

tsdk_end_conference

tsdk_upgrade_conference

tsdk_mute_conference

tsdk_add_attendee

tsdk_redial_attendee

tsdk_hang_up_attendee

tsdk_remove_attendee

tsdk_mute_attendee

tsdk_set_handup

tsdk_set_video_mode

tsdk_watch_attendee

tsdk_broadcast_attendee

tsdk_request_chairman

tsdk_release_chairman

tsdk_postpone_conference

tsdk_join_data_conference

tsdk_p2p_transfer_to_conference

tsdk_join_conference_by_anonymous

tsdk_set_record_broadcast

tsdk_set_live_broadcast

tsdk_set_presenter

tsdk_request_presenter

tsdk_app_share_set_owner

tsdk_app_share_start

tsdk_app_share_stop

tsdk_app_share_get_screen_data

tsdk_doc_share_open_document

tsdk_doc_share_close_document

tsdk_doc_share_set_current_page

tsdk_doc_share_set_canvas_size

tsdk_doc_share_get_surface_bmp

tsdk_doc_share_get_syn_document_info

tsdk_doc_share_set_background_color

tsdk_doc_share_set_display_mode

tsdk_send_chat_msg_in_conference

tsdk_whiteboard_new_document

tsdk_whiteboard_delete_document

tsdk_whiteboard_new_page

tsdk_whiteboard_delete_page

tsdk_annotation_create_start

tsdk_annotation_create_update

tsdk_annotation_create_done

tsdk_annotation_select_start

tsdk_annotation_select_update

tsdk_annotation_select_done

tsdk_annotation_laser_pointer_start

tsdk_annotation_laser_pointer_moveto

tsdk_annotation_laser_pointer_stop

tsdk_annotation_text_create

tsdk_annotation_text_update

tsdk_annotation_edit_start

tsdk_annotation_text_get_info

tsdk_annotation_edit_update

tsdk_annotation_edit_done

tsdk_annotation_hit_test_point

tsdk_annotation_hit_test_rect

tsdk_annotation_hit_test_line

tsdk_annotation_set_select

tsdk_annotation_delete_annotation

tsdk_annotation_get_annotation_info

tsdk_annotation_set_pen

tsdk_annotation_set_brush

tsdk_set_current_sharing_component

tsdk_doc_share_set_zoom_mode

tsdk_app_share_attach_render

tsdk_app_share_detach_render

tsdk_app_share_set_render_view_size

tsdk_get_share_statistic_info