接口參考_湖南軒利_為用戶提供一站式的云服務(wù)及音視頻整體解決方案

會議管理

接口名稱	接口描述
tsdk_book_conference	預(yù)約會議。
tsdk_query_conference_list	獲取會議列表。
tsdk_query_conference_detail	獲取會議詳細信息。

會議控制

接口名稱	接口描述
tsdk_join_conference	主動加入會議。
tsdk_accept_conference	接聽會議來電。
tsdk_reject_conference	拒絕會議來電。
tsdk_leave_conference	離開會議。
tsdk_end_conference	結(jié)束會議。
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	設(shè)置或取消舉手。
tsdk_set_video_mode	設(shè)置視頻會議模式。
tsdk_watch_attendee	觀看指定與會者。
tsdk_broadcast_attendee	廣播或取消廣播與會者。
tsdk_request_chairman	申請主席權(quán)限。
tsdk_release_chairman	釋放主席權(quán)限。
tsdk_postpone_conference	延長會議。
tsdk_join_data_conference	加入數(shù)據(jù)會議。
tsdk_p2p_transfer_to_conference	兩方通話轉(zhuǎn)多方會議。
tsdk_join_conference_by_anonymous	匿名方式加入會議。
tsdk_set_record_broadcast	設(shè)置會議錄播。
tsdk_set_live_broadcast	設(shè)置會議直播。

數(shù)據(jù)會議

接口名稱	接口描述
tsdk_set_presenter	設(shè)置主講人。
tsdk_request_chairman	申請主講人。
tsdk_app_share_set_owner	設(shè)置屏幕共享的擁有者。
tsdk_app_share_start	開始共享。
tsdk_app_share_stop	停止共享。
tsdk_app_share_get_screen_data	獲取屏幕數(shù)據(jù)。
tsdk_doc_share_open_document	打開共享文檔。
tsdk_doc_share_close_document	關(guān)閉一個文檔。
tsdk_doc_share_set_current_page	設(shè)置當前頁面。
tsdk_doc_share_set_canvas_size	設(shè)置顯示區(qū)域的大小。
tsdk_doc_share_get_surface_bmp	獲取當前頁面圖像。
tsdk_doc_share_get_syn_document_info	獲取服務(wù)器上的當前信息。
tsdk_doc_share_set_background_color	設(shè)置背景顏色。
tsdk_doc_share_set_display_mode	設(shè)置顯示模式。
tsdk_send_chat_msg_in_conference	發(fā)送即時消息。
tsdk_whiteboard_new_document	新建白板文檔。
tsdk_whiteboard_delete_document	刪除白板文檔。
tsdk_whiteboard_new_page	新建白板頁。
tsdk_whiteboard_delete_page	刪除指定頁面。
tsdk_annotation_create_start	開始創(chuàng)建一個標注。
tsdk_annotation_create_update	標注創(chuàng)建過程中更新數(shù)據(jù)。
tsdk_annotation_create_done	標注創(chuàng)建結(jié)束。
tsdk_annotation_select_start	開啟鼠標選擇功能。
tsdk_annotation_select_update	更新鼠標選擇功能。
tsdk_annotation_select_done	結(jié)束鼠標選擇。
tsdk_annotation_laser_pointer_start	開始激光點。
tsdk_annotation_laser_pointer_moveto	移動激光點。
tsdk_annotation_laser_pointer_stop	結(jié)束激光點。
tsdk_annotation_text_create	創(chuàng)建文字標注。
tsdk_annotation_text_update	更新文字標注。
tsdk_annotation_edit_start	開始編輯標注。
tsdk_annotation_text_get_info	獲取一個文字標注的信息。
tsdk_annotation_edit_update	編輯標注過程中的數(shù)據(jù)更新。
tsdk_annotation_edit_done	標注編輯完成。
tsdk_annotation_hit_test_point	測試點是否落在標注上。
tsdk_annotation_hit_test_rect	測試矩形框包括的標注。
tsdk_annotation_hit_test_line	測試直線包括的標注。
tsdk_annotation_set_select	設(shè)置標注的選中狀態(tài)。
tsdk_annotation_delete_annotation	刪除標注。
tsdk_annotation_get_annotation_info	獲取指定標注的信息。
tsdk_annotation_set_pen	設(shè)置畫筆屬性。
tsdk_annotation_set_brush	設(shè)置畫刷屬性。
tsdk_set_current_sharing_component	設(shè)置共享組件。
tsdk_doc_share_set_zoom_mode	設(shè)置文檔共享的縮放模式。
tsdk_app_share_attach_render	綁定AS共享顯示窗口。
tsdk_app_share_detach_render	解綁AS共享顯示窗口。
tsdk_app_share_set_render_view_size	設(shè)置AS共享顯示大小。
tsdk_get_share_statistic_info	獲取共享統(tǒng)計信息。

tsdk_book_conference

接口描述

預(yù)約會議（延時召開或立即召開）。

前提條件

鑒權(quán)登錄成功。
會議環(huán)境參數(shù)已設(shè)置。

注意事項

當實際與會者數(shù)目多于設(shè)置的方數(shù)時服務(wù)會自動擴大會議方數(shù)，當填寫方數(shù)小于3時，服務(wù)器默認會議方數(shù)為3。
會議開始時間如果沒有指定，則表示會議馬上開始。
服務(wù)器默認時間為UTC時間，在預(yù)約時需將預(yù)約時間轉(zhuǎn)換為UTC時間。

如果創(chuàng)建的是立即會議，會議創(chuàng)建成功后，SDK會自動加入會議.

方法定義

TSDK_API TSDK_RESULT tsdk_book_conference(IN TSDK_S_BOOK_CONF_INFO *book_conf_info) 

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] book_conf_info	是	TSDK_S_BOOK_CONF_INFO*	預(yù)約會議信息。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼，取值參考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

接口描述

用戶調(diào)用本接口，可以獲取用戶會議列表，包括用戶自己創(chuàng)建的會議，以及待參加的會議。

前提條件

鑒權(quán)登錄成功。
會議環(huán)境參數(shù)已設(shè)置。

注意事項

對應(yīng)的回調(diào)事件為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)

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] query_req	是	TSDK_S_QUERY_CONF_LIST_REQ*	獲取會議列表信息請求結(jié)構(gòu)。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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

接口描述

調(diào)用此接口可獲取指定會議的詳細信息。

前提條件

鑒權(quán)登錄成功。
會議環(huán)境參數(shù)已設(shè)置。

注意事項

對應(yīng)的回調(diào)事件為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) 

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] query_req	是	TSDK_S_QUERY_CONF_DETAIL_REQ *	獲取會議詳細信息請求結(jié)構(gòu)。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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

接口描述

調(diào)用此接口主動加入會議。

注意事項

對應(yīng)的回調(diào)事件為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);

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_join_param	是	TSDK_S_CONF_JOIN_PARAM	入會參數(shù)。
[in] join_number	是	TSDK_CHAR *	入會號碼。
[in] is_video_join	是	TSDK_BOOL	是否視頻接入會議。
[out] call_id	是	TSDK_UINT32	會議對應(yīng)的呼叫ID，在使用SIP終端號碼入會時有效。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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) 

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。
[in] join_video_conf	是	TSDK_BOOL	是否接入視頻會議。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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

接口描述

收到邀請加入會議的請求時，通過調(diào)用此接口拒絕會議來電邀請。

注意事項

無。

方法定義

TSDK_API TSDK_RESULT tsdk_reject_conference(IN TSDK_UINT32 conf_handle)

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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

接口描述

與會者可以通過調(diào)用本接口，在會議中主動退出會議。

注意事項

對應(yīng)的最終結(jié)果事件通知為TSDK_E_CONF_EVT_INFO_AND_STATUS_UPDATE。

方法定義

TSDK_API TSDK_RESULT tsdk_leave_conference(IN TSDK_UINT32 conf_handle) 

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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

接口描述

會議主席可以通過調(diào)用本接口結(jié)束正在召開的會議。

注意事項

回調(diào)事件：TSDK_E_CONF_EVT_CONF_END_IND。

方法定義

TSDK_API TSDK_RESULT tsdk_end_conference  ( IN TSDK_UINT32  conf_handle ) 

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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

接口描述

本接口用于升級會議模式，包括語音會議升級為數(shù)據(jù)會議、視頻會議升級為數(shù)據(jù)會議。

注意事項

前提條件：已創(chuàng)建待升級的會議。

對應(yīng)的結(jié)果事件通知為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);

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。
[in] upgrade_param	是	TSDK_S_CONF_UPGRADE_PARAM*	會議升級參數(shù)(可選，當前可填寫為空)。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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

接口描述

設(shè)置或取消閉音會場。

注意事項

設(shè)置會議閉音后，除主席外，其他所有與會者均不可說（只可聽）。
前提條件：與會者通過主席身份加入會議。
對應(yīng)的結(jié)果事件通知為TSDK_E_CONF_EVT_CONFCTRL_OPERATION_RESULT。

方法定義

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

									 

參數(shù)描述

參數(shù)名

是否必須

類型

描述

[in] conf_handle

是

TSDK_UINT32

會控句柄。

[in] is_mute

是

TSDK_BOOL

是否閉音。

TSDK_TURE：閉音
TSDK_FALSE：取消閉音

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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

接口描述

會議主席添加新的與會者加入會議。

注意事項

前提條件：與會者通過主席身份加入會議。

對應(yīng)的結(jié)果事件通知為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);

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。
[in] add_attendees_info	是	TSDK_S_ADD_ATTENDEES_INFO*	添加與會者信息。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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);

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。
[in] attendee	是	TSDK_CHAR*	與會者號碼。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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

接口描述

掛斷與會者。

注意事項

前提條件：與會者通過主席身份加入會議。

對應(yīng)的結(jié)果事件通知為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);

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。
[in] attendee	是	TSDK_CHAR*	與會者號碼。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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

接口描述

刪除與會者，包括踢出正在會議中的與會者、移除已離會的與會者和取消正在邀請的與會者。

注意事項

對應(yīng)的結(jié)果事件通知為TSDK_E_CONF_EVT_CONFCTRL_OPERATION_RESULT。

方法定義

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

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。
[in] attendee	是	TSDK_CHAR*	與會者號碼。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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

接口描述

設(shè)置與會者閉音。設(shè)置閉音后，該與會者不可說（只可聽）。

注意事項

前提條件：主席和與會者均已在會議中。

主席可對所有與會者設(shè)置或取消閉音，普通與會者只可對自己設(shè)置或取消閉音，被設(shè)置閉音時，與會者可聽不可說。

對應(yīng)的結(jié)果事件通知為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);

									 

參數(shù)描述

參數(shù)名

是否必須

類型

描述

[in] conf_handle

是

TSDK_UINT32

會控句柄。

[in] attendee

是

TSDK_CHAR *

與會者號碼。

[in] is_mute

是

TSDK_BOOL

是否閉音。

TSDK_TURE：閉音
TSDK_FALSE：取消閉音

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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

接口描述

會議中，普通與會者可以調(diào)用本接口設(shè)置或取消自己的舉手，會議主席可以調(diào)用本接口取消其他與會者的舉手。

注意事項

前提條件：主席和與會者均已在會議中。

對應(yīng)的結(jié)果事件通知為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)

									 

參數(shù)描述

參數(shù)名

是否必須

類型

描述

[in] conf_handle

是

TSDK_UINT32

會控句柄。

[in] is_handup

是

TSDK_BOOL

是否舉手。

TSDK_TURE：設(shè)置舉手
TSDK_FALSE：取消舉手

[in] attendee

是

TSDK_CHAR *

與會者號碼（若設(shè)置自己，則無需填寫）。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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

接口描述

設(shè)置會議視頻模式。

注意事項

對應(yīng)的結(jié)果事件通知為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)

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。
[in] mode	是	TSDK_E_CONF_VIDEO_MODE	會議視頻模式。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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

接口描述

當主席廣播會場時，主席側(cè)可以選看會場，被廣播的與會者側(cè)以及其他與會者側(cè)都不可以選看會場。

注意事項

前提條件：主席和與會者均已在會議中，且當前會議模式為“自由模式”。

建議應(yīng)用程序UI在主席廣播會場時，屏蔽選看入口。

對應(yīng)的結(jié)果事件通知為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);

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。
[in] watch_attendee_info	是	TSDK_S_WATCH_ATTENDEES_INFO*	選看與會者畫面參數(shù)信息。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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

接口描述

廣播或取消廣播指定與會者（會場）。

注意事項

前提條件：主席和與會者均已在會議中，且當前會議模式為“廣播模式”。

對應(yīng)的結(jié)果事件通知為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)

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。
[in] attendee	是	TSDK_CHAR*	與會者號碼。
[in] is_roadcast	是	TSDK_BOOL	廣播或是取消廣播。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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

接口描述

申請主席權(quán)限。

注意事項

對應(yīng)的結(jié)果事件通知為TSDK_E_CONF_EVT_CONFCTRL_OPERATION_RESULT。

方法定義

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

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。
[in] password	是	TSDK_CHAR*	主席密碼，On-premise VC會議和Hosted VC會議需要填寫。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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

接口描述

釋放主席權(quán)限。

注意事項

對應(yīng)的結(jié)果事件通知為TSDK_E_CONF_EVT_CONFCTRL_OPERATION_RESULT。

方法定義

TSDK_API TSDK_RESULT tsdk_release_chairman(IN TSDK_UINT32 conf_handle)

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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

接口描述

延長會議。

注意事項

對應(yīng)的結(jié)果事件通知為TSDK_E_CONF_EVT_CONFCTRL_OPERATION_RESULT。

方法定義

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

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。
[in] time	是	TSDK_UINT16	延長時間，單位：分鐘。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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

接口描述

加入數(shù)據(jù)會議。

注意事項

對應(yīng)的結(jié)果事件通知為TSDK_E_CONF_EVT_JOIN_DATA_CONF_RESULT。

方法定義

TSDK_API TSDK_RESULT tsdk_join_data_conference(IN TSDK_UINT32 conf_handle)

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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

接口描述

兩方通話轉(zhuǎn)多方會議。

注意事項

無。

方法定義

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

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] call_id	是	TSDK_UINT32	點對點通話呼叫id。
[in] book_conf_info	是	TSDK_S_BOOK_CONF_INFO *	預(yù)約會議信息。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼，取值參考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);

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_join_param	是	TSDK_S_CONF_ANONYMOUS_JOIN_PARAM *	匿名入會參數(shù)。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

// 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

接口描述

設(shè)置會議錄播。

注意事項

對應(yīng)的結(jié)果事件通知為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);

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。
[in] record_broadcast	是	TSDK_E_CONF_RECORD_STATUS	會議錄播狀態(tài)。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

tsdk_set_live_broadcast

接口描述

設(shè)置會議直播。

注意事項

對應(yīng)的結(jié)果事件通知為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);

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。
[in] live_broadcast	是	TSDK_E_CONF_RECORD_STATUS	會議直播狀態(tài)。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

tsdk_set_presenter

接口描述

設(shè)置主講人。

注意事項

無。

方法定義

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

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。
[in] const attendee	是	TSDK_CHAR*	與會者號碼。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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);

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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

接口描述

設(shè)置屏幕共享的擁有者。

注意事項

無。

方法定義

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);

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。
[in] attendee	是	TSDK_CHAR*	與會者號碼。
[in] action	是	TSDK_E_CONF_AS_ACTION_TYPE	設(shè)置動作, 參考TSDK_E_CONF_AS_ACTION_TYPE。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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

接口描述

開始桌面共享或應(yīng)用程序共享。

注意事項

無。

方法定義

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

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。
[in] share_type	是	TSDK_E_CONF_APP_SHARE_TYPE	應(yīng)用共享類型。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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

接口描述

停止桌面共享或應(yīng)用程序共享。

注意事項

無。

方法定義

TSDK_API TSDK_RESULT tsdk_app_share_stop(IN TSDK_UINT32 conf_handle);

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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

接口描述

獲取屏幕數(shù)據(jù)。

注意事項

無。

方法定義

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

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。
[out] screen_data	是	TSDK_S_CONF_AS_SCREEN_DATA*	屏幕數(shù)據(jù)。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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，移動設(shè)備不支持此功能。

方法定義

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);

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。
[in] file_name	是	TSDK_CHAR*	要打開的共享文檔的全路徑(utf8編碼字符串)，不能為NULL。
[in] option	是	TSDK_E_DOC_SHARE_OPTION	打開文檔選項。 TSDK_E_DOC_SHARE_QUALITY 質(zhì)量優(yōu)先，優(yōu)先采用EMF格式 TSDK_E_DOC_SHARE_SIZE 帶寬優(yōu)先，優(yōu)先采用JPG格式
[out] document_id	是	TSDK_UINT32*	文檔ID。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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

接口描述

關(guān)閉一個文檔。

注意事項

用于PC，移動設(shè)備不支持此功能。

方法定義

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

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。
[in] document_id	是	TSDK_UINT32	文檔ID。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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

接口描述

設(shè)置當前顯示的頁面。

注意事項

無。

方法定義

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);

									 

參數(shù)描述

參數(shù)

是否必須

類型

描述

[in] conf_handle

是

TSDK_UINT32

會控句柄，為0時用于文檔預(yù)覽。

[in] page_info

是

TSDK_S_DOC_PAGE_BASE_INFO*

頁面信息，參考結(jié)構(gòu)體TSDK_S_DOC_PAGE_BASE_INFO。

[in] is_sync

是

TSDK_BOOL

是否同步設(shè)置。

TRUE同步
FALSE非同步

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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

接口描述

設(shè)置顯示區(qū)域的大小。

注意事項

無。

方法定義

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);

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會議句柄, 為0時，用于文檔預(yù)覽。
[in] component_id	是	TSDK_E_COMPONENT_ID	組件ID，TSDK_E_COMPONENT_DS表示共享文檔。
[in] size	是	TSDK_S_SIZE *	顯示區(qū)域的寬高，以TWIPS為單位。
[in] is_redraw	是	TSDK_BOOL	是否立刻重繪。 TRUE重繪 FALSE不重繪

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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);

參數(shù)描述

參數(shù)	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會議句柄為0時，用于文檔預(yù)覽。
[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，失敗返回相應(yīng)錯誤碼。

代碼示例

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

接口描述

獲取服務(wù)器上的當前信息。

注意事項

無。

方法定義

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);

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會議句柄為0時，用于文檔預(yù)覽。
[in] component_id	是	TSDK_E_COMPONENT_ID	組件ID，TSDK_E_COMPONENT_DS表示共享文檔。
[out] info	是	TSDK_S_DOC_PAGE_DETAIL_INFO*	文檔同步信息

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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

接口描述

設(shè)置文檔共享模塊畫布的背景色。

注意事項

用于PC，移動設(shè)備不支持此功能。

方法定義

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);

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會議句柄為0時，用于文檔預(yù)覽。
[in] component_id	是	TSDK_E_COMPONENT_ID	組件ID，TSDK_E_COMPONENT_DS表示共享文檔。
[in] background_color	是	TSDK_UINT32	背景顏色。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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

接口描述

設(shè)置文檔共享模塊的顯示模式。

注意事項

用于PC，移動設(shè)備不支持此功能。

方法定義

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);

參數(shù)描述

參數(shù)名

是否必須

類型

描述

[in] conf_handle

是

TSDK_UINT32

會議句柄為0時，用于文檔預(yù)覽。

[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，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

tsdk_send_chat_msg_in_conference

接口描述

會議中發(fā)送即時消息。

注意事項

無。

方法定義

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);

									 

參數(shù)描述

參數(shù)	是否必須	類型	可選/必選	描述
[in] conf_handle	是	TSDK_UINT32	必選	會控句柄。
[in] chat_msg_info	是	TSDK_S_CONF_CHAT_MSG_INFO*	必選	聊天相關(guān)信息，參考結(jié)構(gòu)體TSDK_S_CONF_CHAT_MSG_INFO。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

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，移動設(shè)備不支持此功能。

方法定義

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

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。
[out] document_id	是	TSDK_UINT32*	白板文檔ID。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

tsdk_whiteboard_delete_document

接口描述

刪除白板文檔。

注意事項

用于PC，移動設(shè)備不支持此功能。

方法定義

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

									 

參數(shù)描述

參數(shù)	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。
[in] document_id	是	TSDK_UINT32	白板文檔ID。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

tsdk_whiteboard_new_page

接口描述

在指定的白板文檔中新建白板頁。

注意事項

用于PC，移動設(shè)備不支持此功能。

方法定義

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);

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。
[in] document_id	是	TSDK_UINT32	白板文檔ID。
[in] width	是	TSDK_UINT32	要創(chuàng)建的頁面的寬度，以TWIPS為單位。
[in] height	是	TSDK_UINT32	要創(chuàng)建的頁面的高度，以TWIPS為單位。
[out] page_id	是	TSDK_UINT32*	指定白板頁面的ID。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

tsdk_whiteboard_delete_page

接口描述

刪除指定白板文檔中的指定頁面。

注意事項

用于PC，移動設(shè)備不支持此功能。

方法定義

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

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。
[in] document_id	是	TSDK_UINT32	白板文檔ID。
[in] page_id	是	TSDK_UINT32	指定白板頁面的ID。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

tsdk_annotation_create_start

接口描述

開始創(chuàng)建一個標注。

注意事項

無。

方法定義

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);

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄為0時，用于文檔預(yù)覽。
[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*	創(chuàng)建標注的起點，一般是鼠標按下的點或圖片標注的左上角，以TWIPS為單位，且該值必須是相對于頁面左上角并且無縮放情況下的值，向下向右為正。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

tsdk_annotation_create_update

接口描述

標注創(chuàng)建過程中更新數(shù)據(jù)。

注意事項

用于PC，移動設(shè)備不支持此功能。

方法定義

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

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄為0時，用于文檔預(yù)覽。
[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*	更新數(shù)據(jù)，對于DS_ANNOT_TYPE_DRAWING類的標注，數(shù)據(jù)類型為CreateDrawingData。對于DS_ANNOT_TYPE_CUSTOMER類的標注，數(shù)據(jù)類型為CreateCustomerData。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

tsdk_annotation_create_done

接口描述

標注創(chuàng)建結(jié)束。

注意事項

無。

方法定義

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);

參數(shù)描述

參數(shù)	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄為0時，用于文檔預(yù)覽。
[in] component_id	是	TSDK_E_COMPONENT_ID	組件ID。
[in] is_cancel	是	TSDK_BOOL	是取消創(chuàng)建還是創(chuàng)建完成。 0：完成創(chuàng)建 1：取消創(chuàng)建，完成創(chuàng)建則該標注被添加到創(chuàng)建的頁面上，取消創(chuàng)建則會刪除該標注
[out] annotation_id	是	TSDK_UINT32*	創(chuàng)建完成后通過該參數(shù)返回該標注的ID，如果為NULL則不返回。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

tsdk_annotation_select_start

接口描述

開啟鼠標選擇功能。

注意事項

用于PC，移動設(shè)備不支持此功能。

方法定義

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);

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄為0時，用于文檔預(yù)覽。
[in] component_id	是	TSDK_E_COMPONENT_ID	組件ID。
[in] page_info	是	TSDK_S_DOC_PAGE_BASE_INFO*	頁面信息。
[in] point	是	TSDK_S_POINT*	創(chuàng)建標注的起點，一般是鼠標按下的點或圖片標注的左上角，以TWIPS為單位，且該值必須是相對于頁面左上角并且無縮放情況下的值，向下向右為正。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

tsdk_annotation_select_update

接口描述

更新鼠標選擇功能。

注意事項

用于PC，移動設(shè)備不支持此功能。

方法定義

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

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄為0時，用于文檔預(yù)覽。
[in] component_id	是	TSDK_E_COMPONENT_ID	組件ID。
[in] point	是	TSDK_S_POINT*	當前點。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

tsdk_annotation_select_done

接口描述

結(jié)束鼠標選擇。

注意事項

用于PC，移動設(shè)備不支持此功能。

方法定義

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);

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄為0時用于文檔預(yù)覽。
[in] component_id	是	TSDK_E_COMPONENT_ID	組件ID。
[in] point	是	TSDK_S_POINT*	結(jié)束點。
[in] select_mode	是	TSDK_E_ANNOTATION_SELECT_MODE	選擇模式
[in] attendee	是	TSDK_CHAR*	選擇的用戶ID。
[out] annotation_id_list	是	TSDK_UINT32**	被選擇的標注列表
[out] count	是	TSDK_UINT32*	通過該參數(shù)返回選中標注數(shù)組中的元素個數(shù)。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

tsdk_annotation_laser_pointer_start

接口描述

開始激光點。

注意事項

用于PC，移動設(shè)備不支持此功能。

方法定義

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);

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄為0時用于文檔預(yù)覽。
[in] component_id	是	TSDK_E_COMPONENT_ID	組件ID。
[in] laser_pointer_info	是	TSDK_S_ANNOTATION_LASER_POINTER_INFO*	激光點信息。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

tsdk_annotation_laser_pointer_moveto

接口描述

移動激光點。

注意事項

用于PC，移動設(shè)備不支持此功能。

方法定義

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);

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄為0時用于文檔預(yù)覽。
[in] component_id	是	TSDK_E_COMPONENT_ID	組件ID。
[in] point	是	TSDK_S_POINT*	移動到的點（激光點的中心坐標），以TWIPS為單位，且該值必須是相對于頁面左上角并且無縮放情況下的值，向下向右為正。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

tsdk_annotation_laser_pointer_stop

接口描述

結(jié)束激光點。

注意事項

只能結(jié)束自己的激光點，移動設(shè)備不支持此功能。

方法定義

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

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。
[in] component_id	是	TSDK_S_ANNOTATION_TEXT_INFO	組件ID，目前標注支持文檔共享和白板。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

tsdk_annotation_text_create

接口描述

創(chuàng)建文字標注。

注意事項

用于PC，移動設(shè)備不支持此功能。

方法定義

 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);

									 

參數(shù)描述

參數(shù)	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會議句柄為0時，用于文檔預(yù)覽。
[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*	創(chuàng)建成功后通過該參數(shù)返回創(chuàng)建成功的標注的ID，如果該參數(shù)為NULL則不返回。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

tsdk_annotation_text_update

接口描述

更新文字標注。

注意事項

用于PC，移動設(shè)備不支持此功能。

方法定義

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);

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會議句柄為0時，用于文檔預(yù)覽。
[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，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

tsdk_annotation_edit_start

接口描述

開始編輯標注。

注意事項

用于PC，移動設(shè)備不支持此功能。

方法定義

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);

參數(shù)描述

參數(shù)	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會議句柄為0時，用于文檔預(yù)覽。
[in] component_id	是	TSDK_E_COMPONENT_ID	組件ID。
[in] page_info	是	TSDK_S_DOC_PAGE_BASE_INFO*	頁面信息。
[in] annotation_id_list	是	TSDK_UINT32*	要編輯的標注id數(shù)組。
[in] count	是	TSDK_UINT32	annotids數(shù)組元素的個數(shù)。
[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，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

tsdk_annotation_text_get_info

接口描述

獲取一個文字標注的信息。

注意事項

用于PC，移動設(shè)備不支持此功能。

方法定義

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);

									 

參數(shù)描述

參數(shù)	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會議句柄為0時，用于文檔預(yù)覽。
[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，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

tsdk_annotation_edit_update

接口描述

編輯標注過程中的數(shù)據(jù)更新。

注意事項

用于PC，移動設(shè)備不支持此功能。

方法定義

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);

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。
[in] component_id	是	TSDK_E_COMPONENT_ID	組件ID，目前標注支持文檔共享和白板。
[in] current_point	是	TSDK_S_POINT*	移動到的點，以TWIPS為單位，且該值必須是相對于頁面左上角并且無縮放情況下的值，向下向右為正。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

tsdk_annotation_edit_done

接口描述

標注編輯完成。

注意事項

用于PC，移動設(shè)備不支持此功能。

方法定義

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);

									 

參數(shù)描述

參數(shù)名

是否必須

類型

描述

[in] conf_handle

是

TSDK_UINT32

會控句柄。

[in] component_id

是

TSDK_E_COMPONENT_ID

組件ID，目前標注支持文檔共享和白板。

[in] is_cancel

是

TSDK_BOOL

是否取消操作。

0：否
1：是

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

tsdk_annotation_hit_test_point

接口描述

測試一個點是否落在標注上。

注意事項

用于PC，移動設(shè)備不支持此功能。

方法定義

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);

參數(shù)描述

參數(shù)	是否必須	類型	描述
[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*	測試結(jié)果。
[out] annotation_type	是	TSDK_UINT32*	點中的標注的標注類型通過該參數(shù)返回。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

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);

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。
[in] hit_test_rect_info	是	TSDK_S_ANNOTATION_HIT_TEST_RECT_INFO*	矩形標注信息集。
[out] annotation_id_list	是	TSDK_UINT32**	通過該參數(shù)返回被選中的標注的數(shù)組指針，應(yīng)用層不能釋放該內(nèi)存。
[out] count	是	TSDK_UINT32*	通過該參數(shù)返回選中標注數(shù)組中的元素個數(shù)。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

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);

參數(shù)描述

參數(shù)	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。
[in] hit_test_line_info	是	TSDK_S_ANNOTATION_HIT_TEST_LINE_INFO*	直線標注信息集。
[out] annotation_id_list	是	TSDK_UINT32**	通過該參數(shù)返回被選中的標注的數(shù)組指針，應(yīng)用層不能釋放該內(nèi)存。
[out] count	是	TSDK_UINT32*	通過該參數(shù)返回選中標注數(shù)組中的元素個數(shù)。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

tsdk_annotation_set_select

接口描述

設(shè)置標注的選中狀態(tài)。

注意事項

用于PC，移動設(shè)備不支持此功能。

方法定義

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);

									 

參數(shù)描述

參數(shù)

是否必須

類型

描述

[in] conf_handle

是

TSDK_UINT32

會控句柄。

[in] select_info

是

TSDK_S_ANNOTATION_SELECT_INFO*

選中標注相關(guān)信息。

[in] is_redraw

是

TSDK_BOOL

設(shè)置選中狀態(tài)后是否立刻重繪。

1：是
0：否

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

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);

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。
[in] delete_info	是	TSDK_S_ANNOTATION_DELETE_INFO*	刪除標注的相關(guān)信息。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

tsdk_annotation_get_annotation_info

接口描述

獲取指定標注的信息。

注意事項

用于PC，移動設(shè)備不支持此功能。

方法定義

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);

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[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*	標注信息結(jié)構(gòu)體指針，用于保存獲取到的標注信息，該參數(shù)不能為NULL。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

tsdk_annotation_set_pen

接口描述

設(shè)置畫筆屬性。

注意事項

無。

方法定義

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);

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。
[in] component_id	是	TSDK_E_COMPONENT_ID	組件ID，目前標注支持文檔共享和白板。
[in] pen_type	是	TSDK_E_ANNOTATION_PEN_TYPE	要設(shè)置的筆的類型，普通筆或高亮筆。
[in] new_pen_info	是	TSDK_S_ANNOTATION_PEN_INFO*	要設(shè)置的畫筆的屬性。
[out] old_pen_info	是	TSDK_S_ANNOTATION_PEN_INFO*	通過該參數(shù)返回原來的畫筆的屬性，如果該參數(shù)為NULL則不返回。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

tsdk_annotation_set_brush

接口描述

設(shè)置畫刷屬性。

注意事項

無。

方法定義

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);

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。
[in] component_id	是	TSDK_E_COMPONENT_ID	組件ID，目前標注支持文檔共享和白板。
[in] new_brush_info	是	TSDK_S_ANNOTATION_BRUSH_INFO*	要設(shè)置的畫刷的屬性。
[out] old_brush_info	是	TSDK_S_ANNOTATION_BRUSH_INFO*	通過該參數(shù)返回原來的畫刷的屬性，如果該參數(shù)為NULL則不返回。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

tsdk_set_current_sharing_component

接口描述

設(shè)置當前共享的組件。

注意事項

無。

方法定義

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

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄。
[in]component_id	是	TSDK_E_COMPONENT_ID	組件ID。

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

tsdk_doc_share_set_zoom_mode

接口描述

設(shè)置文檔共享模塊的縮放模式。

注意事項

無。

方法定義

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);

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[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	是否同步設(shè)置。 true 同步 false 非同步
[in] is_redraw	是	TSDK_BOOL	是否立刻重繪。 true 重繪 false 不重繪

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

tsdk_app_share_attach_render

接口描述

綁定AS共享顯示窗口。

注意事項

無。

方法定義

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

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄
[in] render_handle	是	TSDK_UPTR	窗口句柄

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

tsdk_app_share_detach_render

接口描述

解綁AS共享顯示窗口。

注意事項

無。

方法定義

TSDK_API TSDK_RESULT tsdk_app_share_detach_render(IN TSDK_UINT32 conf_handle);

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

tsdk_app_share_set_render_view_size

接口描述

設(shè)置AS共享顯示大小。

注意事項

無。

方法定義

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

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄
[in] render_view_size	是	TSDK_S_SIZE *	窗口大小

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

tsdk_get_share_statistic_info

接口描述

獲取共享統(tǒng)計信息。

注意事項

無。

方法定義

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

									 

參數(shù)描述

參數(shù)名	是否必須	類型	描述
[in] conf_handle	是	TSDK_UINT32	會控句柄
[out] share_statistic_info	是	TSDK_S_SHARE_STATISTIC_INFO*	共享統(tǒng)計信息

返回值

類型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯誤碼。

代碼示例

無。

暖暖视频免费观**,国产免费美女被艹视频,毛片一级毛片,不卡三级

入門使用

會議

會議管理

會議控制

數(shù)據(jù)會議

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