黄h片网址在线观看,五月婷婷网址,一级一级一级毛片免费毛片,欧美一级视频免费观看

智慧服務(wù)，成就美好體驗(yàn) 項(xiàng)目咨詢

主頁(yè) > 服務(wù)與支持 > 開發(fā)平臺(tái) > 客戶端SDK參考 > Windows Native SDK > 接口參考 會(huì)議

入門使用

會(huì)議

更新時(shí)間：2019-12-10

會(huì)議管理

接口名稱

接口描述

tsdk_book_conference

預(yù)約會(huì)議。

tsdk_query_conference_list

獲取會(huì)議列表。

tsdk_query_conference_detail

獲取會(huì)議詳細(xì)信息。

會(huì)議控制

接口名稱

接口描述

tsdk_join_conference

主動(dòng)加入會(huì)議。

tsdk_accept_conference

接聽會(huì)議來電。

tsdk_reject_conference

拒絕會(huì)議來電。

tsdk_leave_conference

離開會(huì)議。

tsdk_end_conference

結(jié)束會(huì)議。

tsdk_upgrade_conference

升級(jí)會(huì)議。

tsdk_mute_conference

閉音會(huì)議。

tsdk_add_attendee

添加與會(huì)者。

tsdk_redial_attendee

重?fù)芘c會(huì)者。

tsdk_hang_up_attendee

掛斷與會(huì)者。

tsdk_remove_attendee

刪除與會(huì)者。

tsdk_mute_attendee

閉音與會(huì)者。

tsdk_set_handup

設(shè)置或取消舉手。

tsdk_set_video_mode

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

tsdk_watch_attendee

觀看指定與會(huì)者。

tsdk_broadcast_attendee

廣播或取消廣播與會(huì)者。

tsdk_request_chairman

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

tsdk_release_chairman

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

tsdk_postpone_conference

延長(zhǎng)會(huì)議。

tsdk_join_data_conference

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

tsdk_p2p_transfer_to_conference

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

tsdk_join_conference_by_anonymous

匿名方式加入會(huì)議。

tsdk_set_record_broadcast

設(shè)置會(huì)議錄播。

tsdk_set_live_broadcast

設(shè)置會(huì)議直播。

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

接口名稱

接口描述

tsdk_set_presenter

設(shè)置主講人。

tsdk_request_chairman

申請(qǐng)主講人。

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)閉一個(gè)文檔。

tsdk_doc_share_set_current_page

設(shè)置當(dāng)前頁(yè)面。

tsdk_doc_share_set_canvas_size

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

tsdk_doc_share_get_surface_bmp

獲取當(dāng)前頁(yè)面圖像。

tsdk_doc_share_get_syn_document_info

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

tsdk_doc_share_set_background_color

設(shè)置背景顏色。

tsdk_doc_share_set_display_mode

設(shè)置顯示模式。

tsdk_send_chat_msg_in_conference

發(fā)送即時(shí)消息。

tsdk_whiteboard_new_document

新建白板文檔。

tsdk_whiteboard_delete_document

刪除白板文檔。

tsdk_whiteboard_new_page

新建白板頁(yè)。

tsdk_whiteboard_delete_page

刪除指定頁(yè)面。

tsdk_annotation_create_start

開始創(chuàng)建一個(gè)標(biāo)注。

tsdk_annotation_create_update

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

tsdk_annotation_create_done

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

tsdk_annotation_select_start

開啟鼠標(biāo)選擇功能。

tsdk_annotation_select_update

更新鼠標(biāo)選擇功能。

tsdk_annotation_select_done

結(jié)束鼠標(biāo)選擇。

tsdk_annotation_laser_pointer_start

開始激光點(diǎn)。

tsdk_annotation_laser_pointer_moveto

移動(dòng)激光點(diǎn)。

tsdk_annotation_laser_pointer_stop

結(jié)束激光點(diǎn)。

tsdk_annotation_text_create

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

tsdk_annotation_text_update

更新文字標(biāo)注。

tsdk_annotation_edit_start

開始編輯標(biāo)注。

tsdk_annotation_text_get_info

獲取一個(gè)文字標(biāo)注的信息。

tsdk_annotation_edit_update

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

tsdk_annotation_edit_done

標(biāo)注編輯完成。

tsdk_annotation_hit_test_point

測(cè)試點(diǎn)是否落在標(biāo)注上。

tsdk_annotation_hit_test_rect

測(cè)試矩形框包括的標(biāo)注。

tsdk_annotation_hit_test_line

測(cè)試直線包括的標(biāo)注。

tsdk_annotation_set_select

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

tsdk_annotation_delete_annotation

刪除標(biāo)注。

tsdk_annotation_get_annotation_info

獲取指定標(biāo)注的信息。

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)計(jì)信息。

tsdk_book_conference

接口描述

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

前提條件
  1. 鑒權(quán)登錄成功。
  2. 會(huì)議環(huán)境參數(shù)已設(shè)置。

注意事項(xiàng)

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

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

方法定義

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ù)約會(huì)議信息。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼，取值參考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)用本接口，可以獲取用戶會(huì)議列表，包括用戶自己創(chuàng)建的會(huì)議，以及待參加的會(huì)議。

前提條件

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

注意事項(xiàng)

對(duì)應(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*

獲取會(huì)議列表信息請(qǐng)求結(jié)構(gòu)。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

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)用此接口可獲取指定會(huì)議的詳細(xì)信息。

前提條件

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

注意事項(xiàng)

對(duì)應(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 *

獲取會(huì)議詳細(xì)信息請(qǐng)求結(jié)構(gòu)。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

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)用此接口主動(dòng)加入會(huì)議。

注意事項(xiàng)

對(duì)應(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

入會(huì)參數(shù)。

[in] join_number

是

TSDK_CHAR *

入會(huì)號(hào)碼。

[in] is_video_join

是

TSDK_BOOL

是否視頻接入會(huì)議。

[out] call_id

是

TSDK_UINT32

會(huì)議對(duì)應(yīng)的呼叫ID，在使用SIP終端號(hào)碼入會(huì)時(shí)有效。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

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

接口描述

接聽會(huì)議來電。

注意事項(xiàng)

無。

方法定義

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

會(huì)控句柄。

[in] join_video_conf

是

TSDK_BOOL

是否接入視頻會(huì)議。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

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

接口描述

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

注意事項(xiàng)

無。

方法定義

TSDK_API TSDK_RESULT tsdk_reject_conference(IN TSDK_UINT32 conf_handle)
 

參數(shù)描述

參數(shù)名

是否必須

類型

描述

[in] conf_handle

是

TSDK_UINT32

會(huì)控句柄。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

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

接口描述

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

注意事項(xiàng)

對(duì)應(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

會(huì)控句柄。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

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

接口描述

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

注意事項(xiàng)

回調(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

會(huì)控句柄。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

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

接口描述

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

注意事項(xiàng)

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

對(duì)應(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

會(huì)控句柄。

[in] upgrade_param

是

TSDK_S_CONF_UPGRADE_PARAM*

會(huì)議升級(jí)參數(shù)(可選，當(dāng)前可填寫為空)。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

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è)置或取消閉音會(huì)場(chǎng)。

注意事項(xiàng)

  • 設(shè)置會(huì)議閉音后，除主席外，其他所有與會(huì)者均不可說（只可聽）。
  • 前提條件：與會(huì)者通過主席身份加入會(huì)議。
  • 對(duì)應(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

會(huì)控句柄。

[in] is_mute

是

TSDK_BOOL

是否閉音。

  • TSDK_TURE：閉音
  • TSDK_FALSE：取消閉音

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

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

接口描述

會(huì)議主席添加新的與會(huì)者加入會(huì)議。

注意事項(xiàng)

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

對(duì)應(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

會(huì)控句柄。

[in] add_attendees_info

是

TSDK_S_ADD_ATTENDEES_INFO*

添加與會(huì)者信息。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

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

接口描述

重?fù)芘c會(huì)者。

注意事項(xiàng)

無。

方法定義

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

參數(shù)描述

參數(shù)名

是否必須

類型

描述

[in] conf_handle

是

TSDK_UINT32

會(huì)控句柄。

[in] attendee

是

TSDK_CHAR*

與會(huì)者號(hào)碼。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

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

接口描述

掛斷與會(huì)者。

注意事項(xiàng)

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

對(duì)應(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

會(huì)控句柄。

[in] attendee

是

TSDK_CHAR*

與會(huì)者號(hào)碼。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

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

接口描述

刪除與會(huì)者，包括踢出正在會(huì)議中的與會(huì)者、移除已離會(huì)的與會(huì)者和取消正在邀請(qǐng)的與會(huì)者。

注意事項(xiàng)

對(duì)應(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

會(huì)控句柄。

[in] attendee

是

TSDK_CHAR*

與會(huì)者號(hào)碼。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

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è)置與會(huì)者閉音。設(shè)置閉音后，該與會(huì)者不可說（只可聽）。

注意事項(xiàng)

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

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

對(duì)應(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

會(huì)控句柄。

[in] attendee

是

TSDK_CHAR *

與會(huì)者號(hào)碼。

[in] is_mute

是

TSDK_BOOL

是否閉音。

  • TSDK_TURE：閉音
  • TSDK_FALSE：取消閉音

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

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

接口描述

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

注意事項(xiàng)

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

對(duì)應(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

會(huì)控句柄。

[in] is_handup

是

TSDK_BOOL

是否舉手。

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

[in] attendee

是

TSDK_CHAR *

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

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

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è)置會(huì)議視頻模式。

注意事項(xiàng)

對(duì)應(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

會(huì)控句柄。

[in] mode

是

TSDK_E_CONF_VIDEO_MODE

會(huì)議視頻模式。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

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

接口描述

當(dāng)主席廣播會(huì)場(chǎng)時(shí)，主席側(cè)可以選看會(huì)場(chǎng)，被廣播的與會(huì)者側(cè)以及其他與會(huì)者側(cè)都不可以選看會(huì)場(chǎng)。

注意事項(xiàng)

前提條件：主席和與會(huì)者均已在會(huì)議中，且當(dāng)前會(huì)議模式為“自由模式”。

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

對(duì)應(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

會(huì)控句柄。

[in] watch_attendee_info

是

TSDK_S_WATCH_ATTENDEES_INFO*

選看與會(huì)者畫面參數(shù)信息。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

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

接口描述

廣播或取消廣播指定與會(huì)者（會(huì)場(chǎng)）。

注意事項(xiàng)

前提條件：主席和與會(huì)者均已在會(huì)議中，且當(dāng)前會(huì)議模式為“廣播模式”。

對(duì)應(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

會(huì)控句柄。

[in] attendee

是

TSDK_CHAR*

與會(huì)者號(hào)碼。

[in] is_roadcast

是

TSDK_BOOL

廣播或是取消廣播。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

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

接口描述

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

注意事項(xiàng)

對(duì)應(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

會(huì)控句柄。

[in] password

是

TSDK_CHAR*

主席密碼，On-premise VC會(huì)議和Hosted VC會(huì)議需要填寫。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

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)限。

注意事項(xiàng)

對(duì)應(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

會(huì)控句柄。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

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

接口描述

延長(zhǎng)會(huì)議。

注意事項(xiàng)

對(duì)應(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

會(huì)控句柄。

[in] time

是

TSDK_UINT16

延長(zhǎng)時(shí)間，單位：分鐘。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

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ù)會(huì)議 。

注意事項(xiàng)

對(duì)應(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

會(huì)控句柄。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

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)多方會(huì)議。

注意事項(xiàng)

無。

方法定義

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

點(diǎn)對(duì)點(diǎn)通話呼叫id。

[in] book_conf_info

是

TSDK_S_BOOK_CONF_INFO *

預(yù)約會(huì)議信息。

返回值

類型

描述

TSDK_RESULT

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

接口描述

匿名方式加入會(huì)議。

注意事項(xiàng)

無。

方法定義

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 *

匿名入會(huì)參數(shù)。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

// 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è)置會(huì)議錄播。

注意事項(xiàng)

對(duì)應(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

會(huì)控句柄。

[in] record_broadcast

是

TSDK_E_CONF_RECORD_STATUS

會(huì)議錄播狀態(tài)。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_set_live_broadcast

接口描述

設(shè)置會(huì)議直播。

注意事項(xiàng)

對(duì)應(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

會(huì)控句柄。

[in] live_broadcast

是

TSDK_E_CONF_RECORD_STATUS

會(huì)議直播狀態(tài)。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_set_presenter

接口描述

設(shè)置主講人。

注意事項(xiàng)

無。

方法定義

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

參數(shù)描述

參數(shù)名

是否必須

類型

描述

[in] conf_handle

是

TSDK_UINT32

會(huì)控句柄。

[in] const attendee

是

TSDK_CHAR*

與會(huì)者號(hào)碼。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

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

接口描述

申請(qǐng)主講人。

注意事項(xiàng)

無。

方法定義

TSDK_API TSDK_RESULT tsdk_request_presenter(IN TSDK_UINT32 conf_handle);
 

參數(shù)描述

參數(shù)名

是否必須

類型

描述

[in] conf_handle

是

TSDK_UINT32

會(huì)控句柄。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

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è)置屏幕共享的擁有者。

注意事項(xiàng)

無。

方法定義

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

會(huì)控句柄。

[in] attendee

是

TSDK_CHAR*

與會(huì)者號(hào)碼。

[in] action

是

TSDK_E_CONF_AS_ACTION_TYPE

設(shè)置動(dòng)作, 參考TSDK_E_CONF_AS_ACTION_TYPE。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

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)用程序共享。

注意事項(xià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

會(huì)控句柄。

[in] share_type

是

TSDK_E_CONF_APP_SHARE_TYPE

應(yīng)用共享類型。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

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)用程序共享。

注意事項(xiàng)

無。

方法定義

TSDK_API TSDK_RESULT tsdk_app_share_stop(IN TSDK_UINT32 conf_handle);
 

參數(shù)描述

參數(shù)名

是否必須

類型

描述

[in] conf_handle

是

TSDK_UINT32

會(huì)控句柄。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

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ù)。

注意事項(xiàng)

無。

方法定義

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

會(huì)控句柄。

[out] screen_data

是

TSDK_S_CONF_AS_SCREEN_DATA*

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

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

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

接口描述

打開共享文檔。

注意事項(xiàng)

用于PC，移動(dòng)設(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

會(huì)控句柄。

[in] file_name

是

TSDK_CHAR*

要打開的共享文檔的全路徑(utf8編碼字符串)，不能為NULL。

[in] option

是

TSDK_E_DOC_SHARE_OPTION

打開文檔選項(xiàng)。

  • TSDK_E_DOC_SHARE_QUALITY 質(zhì)量?jī)?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)錯(cuò)誤碼。

代碼示例

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)閉一個(gè)文檔。

注意事項(xiàng)

用于PC，移動(dòng)設(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

會(huì)控句柄。

[in] document_id

是

TSDK_UINT32

文檔ID。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

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è)置當(dāng)前顯示的頁(yè)面。

注意事項(xiàng)

無。

方法定義

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

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

[in] page_info

是

TSDK_S_DOC_PAGE_BASE_INFO*

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

[in] is_sync

是

TSDK_BOOL

是否同步設(shè)置。

  • TRUE同步
  • FALSE非同步

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

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ū)域的大小。

注意事項(xiàng)

無。

方法定義

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

會(huì)議句柄, 為0時(shí)，用于文檔預(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)錯(cuò)誤碼。

代碼示例

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

接口描述

獲取渲染好的當(dāng)前頁(yè)面圖像。

注意事項(xiàng)

無。

方法定義

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

會(huì)議句柄為0時(shí)，用于文檔預(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)錯(cuò)誤碼。

代碼示例

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ù)器上的當(dāng)前信息。

注意事項(xiàng)

無。

方法定義

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

會(huì)議句柄為0時(shí)，用于文檔預(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)錯(cuò)誤碼。

代碼示例

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è)置文檔共享模塊畫布的背景色。

注意事項(xiàng)

用于PC，移動(dòng)設(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

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

[in] component_id

是

TSDK_E_COMPONENT_ID

組件ID，TSDK_E_COMPONENT_DS表示共享文檔。

[in] background_color

是

TSDK_UINT32

背景顏色。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

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è)置文檔共享模塊的顯示模式。

注意事項(xiàng)

用于PC，移動(dòng)設(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

會(huì)議句柄為0時(shí)，用于文檔預(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)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_send_chat_msg_in_conference

接口描述

會(huì)議中發(fā)送即時(shí)消息。

注意事項(xiàng)

無。

方法定義

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

必選

會(huì)控句柄。

[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)錯(cuò)誤碼。

代碼示例

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

接口描述

新建一個(gè)空的白板文檔。

注意事項(xiàng)

用于PC，移動(dòng)設(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

會(huì)控句柄。

[out] document_id

是

TSDK_UINT32*

白板文檔ID。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_whiteboard_delete_document

接口描述

刪除白板文檔。

注意事項(xiàng)

用于PC，移動(dòng)設(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

會(huì)控句柄。

[in] document_id

是

TSDK_UINT32

白板文檔ID。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_whiteboard_new_page

接口描述

在指定的白板文檔中新建白板頁(yè)。

注意事項(xiàng)

用于PC，移動(dòng)設(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

會(huì)控句柄。

[in] document_id

是

TSDK_UINT32

白板文檔ID。

[in] width

是

TSDK_UINT32

要?jiǎng)?chuàng)建的頁(yè)面的寬度，以TWIPS為單位。

[in] height

是

TSDK_UINT32

要?jiǎng)?chuàng)建的頁(yè)面的高度，以TWIPS為單位。

[out] page_id

是

TSDK_UINT32*

指定白板頁(yè)面的ID。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_whiteboard_delete_page

接口描述

刪除指定白板文檔中的指定頁(yè)面。

注意事項(xiàng)

用于PC，移動(dòng)設(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

會(huì)控句柄。

[in] document_id

是

TSDK_UINT32

白板文檔ID。

[in] page_id

是

TSDK_UINT32

指定白板頁(yè)面的ID。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_annotation_create_start

接口描述

開始創(chuàng)建一個(gè)標(biāo)注。

注意事項(xià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

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

[in]component_id

是

TSDK_E_COMPONENT_ID

組件ID。

[in] page_info

是

TSDK_S_DOC_PAGE_BASE_INFO*

頁(yè)面信息。

[in] main_type

是

TSDK_E_ANNOTATION_MAIN_TYPE

標(biāo)注主類型，這里暫時(shí)只有DS_ANNOT_TYPE_DRAWING和DS_ANNOT_TYPE_CUSTOMER兩種。

[in] sub_type

是

TSDK_UINT32

標(biāo)注子類型，包括DRAWING的子類型和通過conf_annotation_reg_customer_type注冊(cè)的類型。

[in] point

是

TSDK_S_POINT*

創(chuàng)建標(biāo)注的起點(diǎn)，一般是鼠標(biāo)按下的點(diǎn)或圖片標(biāo)注的左上角，以TWIPS為單位，且該值必須是相對(duì)于頁(yè)面左上角并且無縮放情況下的值，向下向右為正。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_annotation_create_update

接口描述

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

注意事項(xiàng)

用于PC，移動(dòng)設(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

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

[in] component_id

是

TSDK_E_COMPONENT_ID

組件ID，TSDK_E_COMPONENT_DS表示共享文檔。

[in] main_type

是

TSDK_E_ANNOTATION_MAIN_TYPE

標(biāo)注主類型，這里暫時(shí)只有TSDK_E_ANNOTATION_DRAWING。

[in] data

是

TSDK_VOID*

更新數(shù)據(jù)，對(duì)于DS_ANNOT_TYPE_DRAWING類的標(biāo)注，數(shù)據(jù)類型為CreateDrawingData*。

對(duì)于DS_ANNOT_TYPE_CUSTOMER類的標(biāo)注，數(shù)據(jù)類型為CreateCustomerData*。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_annotation_create_done

接口描述

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

注意事項(xiàng)

無。

方法定義

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

會(huì)控句柄為0時(shí)，用于文檔預(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)建則該標(biāo)注被添加到創(chuàng)建的頁(yè)面上，取消創(chuàng)建則會(huì)刪除該標(biāo)注

[out] annotation_id

是

TSDK_UINT32*

創(chuàng)建完成后通過該參數(shù)返回該標(biāo)注的ID，如果為NULL則不返回。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_annotation_select_start

接口描述

開啟鼠標(biāo)選擇功能。

注意事項(xiàng)

用于PC，移動(dòng)設(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

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

[in] component_id

是

TSDK_E_COMPONENT_ID

組件ID。

[in] page_info

是

TSDK_S_DOC_PAGE_BASE_INFO*

頁(yè)面信息。

[in] point

是

TSDK_S_POINT*

創(chuàng)建標(biāo)注的起點(diǎn)，一般是鼠標(biāo)按下的點(diǎn)或圖片標(biāo)注的左上角，以TWIPS為單位，且該值必須是相對(duì)于頁(yè)面左上角并且無縮放情況下的值，向下向右為正。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_annotation_select_update

接口描述

更新鼠標(biāo)選擇功能。

注意事項(xiàng)

用于PC，移動(dòng)設(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

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

[in] component_id

是

TSDK_E_COMPONENT_ID

組件ID。

[in] point

是

TSDK_S_POINT*

當(dāng)前點(diǎn)。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_annotation_select_done

接口描述

結(jié)束鼠標(biāo)選擇。

注意事項(xiàng)

用于PC，移動(dòng)設(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

會(huì)控句柄為0時(shí)用于文檔預(yù)覽。

[in] component_id

是

TSDK_E_COMPONENT_ID

組件ID。

[in] point

是

TSDK_S_POINT*

結(jié)束點(diǎn)。

[in] select_mode

是

TSDK_E_ANNOTATION_SELECT_MODE

選擇模式

[in] attendee

是

TSDK_CHAR*

選擇的用戶ID。

[out] annotation_id_list

是

TSDK_UINT32**

被選擇的標(biāo)注列表

[out] count

是

TSDK_UINT32*

通過該參數(shù)返回選中標(biāo)注數(shù)組中的元素個(gè)數(shù)。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_annotation_laser_pointer_start

接口描述

開始激光點(diǎn)。

注意事項(xiàng)

用于PC，移動(dòng)設(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

會(huì)控句柄為0時(shí)用于文檔預(yù)覽。

[in] component_id

是

TSDK_E_COMPONENT_ID

組件ID。

[in] laser_pointer_info

是

TSDK_S_ANNOTATION_LASER_POINTER_INFO*

激光點(diǎn)信息。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_annotation_laser_pointer_moveto

接口描述

移動(dòng)激光點(diǎn)。

注意事項(xiàng)

用于PC，移動(dòng)設(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

會(huì)控句柄為0時(shí)用于文檔預(yù)覽。

[in] component_id

是

TSDK_E_COMPONENT_ID

組件ID。

[in] point

是

TSDK_S_POINT*

移動(dòng)到的點(diǎn)（激光點(diǎn)的中心坐標(biāo)），以TWIPS為單位，且該值必須是相對(duì)于頁(yè)面左上角并且無縮放情況下的值，向下向右為正。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_annotation_laser_pointer_stop

接口描述

結(jié)束激光點(diǎn)。

注意事項(xiàng)

只能結(jié)束自己的激光點(diǎn)，移動(dòng)設(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

會(huì)控句柄。

[in] component_id

是

TSDK_S_ANNOTATION_TEXT_INFO

組件ID，目前標(biāo)注支持文檔共享和白板。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_annotation_text_create

接口描述

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

注意事項(xiàng)

用于PC，移動(dòng)設(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

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

[in] component_id

是

TSDK_E_COMPONENT_ID

組件ID。

[in] page_info

是

TSDK_S_DOC_PAGE_BASE_INFO*

頁(yè)面信息。

[in] text_info

是

TSDK_S_ANNOTATION_TEXT_INFO*

文字標(biāo)注的信息。

[out] annotation_id

是

TSDK_UINT32*

創(chuàng)建成功后通過該參數(shù)返回創(chuàng)建成功的標(biāo)注的ID，如果該參數(shù)為NULL則不返回。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_annotation_text_update

接口描述

更新文字標(biāo)注。

注意事項(xiàng)

用于PC，移動(dòng)設(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

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

[in] component_id

是

TSDK_E_COMPONENT_ID

組件ID。

[in] page_info

是

TSDK_S_DOC_PAGE_BASE_INFO*

頁(yè)面信息。

[in] annotation_id

是

TSDK_UINT32

要更新的文字標(biāo)注的id。

[in] text_info

是

TSDK_S_ANNOTATION_TEXT_INFO*

文字標(biāo)注的信息。

[in] is_redraw

是

TSDK_BOOL

更新成功后是否立刻重繪。

  • 0：不重繪
  • 1：重繪

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_annotation_edit_start

接口描述

開始編輯標(biāo)注。

注意事項(xiàng)

用于PC，移動(dòng)設(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

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

[in] component_id

是

TSDK_E_COMPONENT_ID

組件ID。

[in] page_info

是

TSDK_S_DOC_PAGE_BASE_INFO*

頁(yè)面信息。

[in] annotation_id_list

是

TSDK_UINT32*

要編輯的標(biāo)注id數(shù)組。

[in] count

是

TSDK_UINT32

annotids數(shù)組元素的個(gè)數(shù)。

[in] ref_annotation_id

是

TSDK_UINT32

多個(gè)標(biāo)注一起編輯時(shí)用到的，表示當(dāng)時(shí)鼠標(biāo)落點(diǎn)所在的標(biāo)注ID。

[in] hit_test_code

是

TSDK_E_ANNOTATION_HIT_TEST_CODE

編輯類型。

[in] start_point

是

TSDK_S_POINT*

編輯開始的點(diǎn)，以TWIPS為單位，且該值必須是相對(duì)于頁(yè)面左上角并且無縮放情況下的值，向下向右為正。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_annotation_text_get_info

接口描述

獲取一個(gè)文字標(biāo)注的信息。

注意事項(xiàng)

用于PC，移動(dòng)設(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

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

[in] component_id

是

TSDK_E_COMPONENT_ID

組件ID。

[in] page_info

是

TSDK_S_DOC_PAGE_BASE_INFO*

頁(yè)面信息。

[in] annotation_id

是

TSDK_UINT32

要更新的文字標(biāo)注的id。

[out] text_info

是

TSDK_S_ANNOTATION_TEXT_INFO*

文字標(biāo)注的信息。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_annotation_edit_update

接口描述

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

注意事項(xiàng)

用于PC，移動(dòng)設(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

會(huì)控句柄。

[in] component_id

是

TSDK_E_COMPONENT_ID

組件ID，目前標(biāo)注支持文檔共享和白板。

[in] current_point

是

TSDK_S_POINT*

移動(dòng)到的點(diǎn)，以TWIPS為單位，且該值必須是相對(duì)于頁(yè)面左上角并且無縮放情況下的值，向下向右為正。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_annotation_edit_done

接口描述

標(biāo)注編輯完成。

注意事項(xiàng)

用于PC，移動(dòng)設(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

會(huì)控句柄。

[in] component_id

是

TSDK_E_COMPONENT_ID

組件ID，目前標(biāo)注支持文檔共享和白板。

[in] is_cancel

是

TSDK_BOOL

是否取消操作。

  • 0：否
  • 1：是

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_annotation_hit_test_point

接口描述

測(cè)試一個(gè)點(diǎn)是否落在標(biāo)注上。

注意事項(xiàng)

用于PC，移動(dòng)設(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

會(huì)控句柄。

[in] hit_test_point_info

是

TSDK_S_ANNOTATION_HIT_TEST_POINT_INFO*

矩形標(biāo)注信息集。

[out] select_annotation_id

是

TSDK_UINT32*

如果要測(cè)試的點(diǎn)選中了某個(gè)標(biāo)注，通過該值返回。

[out] hit_test_code

是

TSDK_E_ANNOTATION_HIT_TEST_CODE*

測(cè)試結(jié)果。

[out] annotation_type

是

TSDK_UINT32*

點(diǎn)中的標(biāo)注的標(biāo)注類型通過該參數(shù)返回。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_annotation_hit_test_rect

接口描述

測(cè)試一個(gè)矩形框包括的標(biāo)注。

注意事項(xiàng)

無。

方法定義

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

會(huì)控句柄。

[in] hit_test_rect_info

是

TSDK_S_ANNOTATION_HIT_TEST_RECT_INFO*

矩形標(biāo)注信息集。

[out] annotation_id_list

是

TSDK_UINT32**

通過該參數(shù)返回被選中的標(biāo)注的數(shù)組指針，應(yīng)用層不能釋放該內(nèi)存。

[out] count

是

TSDK_UINT32*

通過該參數(shù)返回選中標(biāo)注數(shù)組中的元素個(gè)數(shù)。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_annotation_hit_test_line

接口描述

測(cè)試一條直線包括的標(biāo)注。

注意事項(xiàng)

無。

方法定義

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

會(huì)控句柄。

[in] hit_test_line_info

是

TSDK_S_ANNOTATION_HIT_TEST_LINE_INFO*

直線標(biāo)注信息集。

[out] annotation_id_list

是

TSDK_UINT32**

通過該參數(shù)返回被選中的標(biāo)注的數(shù)組指針，應(yīng)用層不能釋放該內(nèi)存。

[out] count

是

TSDK_UINT32*

通過該參數(shù)返回選中標(biāo)注數(shù)組中的元素個(gè)數(shù)。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_annotation_set_select

接口描述

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

注意事項(xiàng)

用于PC，移動(dòng)設(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

會(huì)控句柄。

[in] select_info

是

TSDK_S_ANNOTATION_SELECT_INFO*

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

[in] is_redraw

是

TSDK_BOOL

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

  • 1：是
  • 0：否

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_annotation_delete_annotation

接口描述

刪除標(biāo)注。

注意事項(xiàng)

無。

方法定義

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

會(huì)控句柄。

[in] delete_info

是

TSDK_S_ANNOTATION_DELETE_INFO*

刪除標(biāo)注的相關(guān)信息。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_annotation_get_annotation_info

接口描述

獲取指定標(biāo)注的信息。

注意事項(xiàng)

用于PC，移動(dòng)設(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

會(huì)控句柄。

[in] component_id

是

TSDK_E_COMPONENT_ID

組件ID。

[in] page_info

是

TSDK_S_DOC_PAGE_BASE_INFO*

頁(yè)面信息。

[in] annotation_id

是

TSDK_UINT32

標(biāo)注ID。

[out] annotation_base_info

是

TSDK_S_ANNOTATION_BASE_INFO*

標(biāo)注信息結(jié)構(gòu)體指針，用于保存獲取到的標(biāo)注信息，該參數(shù)不能為NULL。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_annotation_set_pen

接口描述

設(shè)置畫筆屬性。

注意事項(xiàng)

無。

方法定義

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

會(huì)控句柄。

[in] component_id

是

TSDK_E_COMPONENT_ID

組件ID，目前標(biāo)注支持文檔共享和白板。

[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)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_annotation_set_brush

接口描述

設(shè)置畫刷屬性。

注意事項(xiàng)

無。

方法定義

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

會(huì)控句柄。

[in] component_id

是

TSDK_E_COMPONENT_ID

組件ID，目前標(biāo)注支持文檔共享和白板。

[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)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_set_current_sharing_component

接口描述

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

注意事項(xiàng)

無。

方法定義

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

會(huì)控句柄。

[in]component_id

是

TSDK_E_COMPONENT_ID

組件ID。

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_doc_share_set_zoom_mode

接口描述

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

注意事項(xiàng)

無。

方法定義

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

會(huì)控句柄。

[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)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_app_share_attach_render

接口描述

綁定AS共享顯示窗口。

注意事項(xiàng)

無。

方法定義

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

會(huì)控句柄

[in] render_handle

是

TSDK_UPTR

窗口句柄

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_app_share_detach_render

接口描述

解綁AS共享顯示窗口。

注意事項(xiàng)

無。

方法定義

TSDK_API TSDK_RESULT tsdk_app_share_detach_render(IN TSDK_UINT32 conf_handle);
 

參數(shù)描述

參數(shù)名

是否必須

類型

描述

[in] conf_handle

是

TSDK_UINT32

會(huì)控句柄

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_app_share_set_render_view_size

接口描述

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

注意事項(xiàng)

無。

方法定義

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

會(huì)控句柄

[in] render_view_size

是

TSDK_S_SIZE *

窗口大小

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

無。
 

tsdk_get_share_statistic_info

接口描述

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

注意事項(xià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

會(huì)控句柄

[out] share_statistic_info

是

TSDK_S_SHARE_STATISTIC_INFO*

共享統(tǒng)計(jì)信息

返回值

類型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS，失敗返回相應(yīng)錯(cuò)誤碼。

代碼示例

無。