主頁(yè) > 服務(wù)與支持 > 開(kāi)發(fā)平臺(tái) > 客戶端SDK參考 > iOS Native SDK > 附錄 結(jié)構(gòu)體定義
更新時(shí)間：2019-12-10
|
業(yè)務(wù)類別 |
數(shù)據(jù)結(jié)構(gòu) |
|---|---|
|
組件初始化與配置 |
|
|
登錄和注銷
|
|
|
音視頻通話
|
|
|
會(huì)議 |
|
|
TSDK_S_CONF_DATACONF_PARAMS(數(shù)據(jù)會(huì)議入會(huì)參數(shù)) |
|
|
TSDK_S_ANNOTATION_HIT_TEST_POINT_INFO(標(biāo)注點(diǎn)測(cè)試信息) |
|
|
TSDK_S_ANNOTATION_CUSTOMER_DATA(創(chuàng)建Customer標(biāo)注時(shí)傳入的數(shù)據(jù)結(jié)構(gòu)) |
|
|
通訊錄 |
|
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
client_type |
終端類型 |
|
|
product_name |
TSDK_CHAR[] |
產(chǎn)品信息，如："SoftClient on Desktop" |
|
device_sn |
TSDK_CHAR[] |
設(shè)備sn號(hào)，可選參數(shù) |
|
support_audio_and_video_call |
TSDK_BOOL |
是否支持音視頻呼叫 |
|
support_audio_and_video_conf |
TSDK_BOOL |
是否支持音視頻會(huì)議 |
|
support_data_conf |
TSDK_BOOL |
是否支持?jǐn)?shù)據(jù)會(huì)議 |
|
support_ctd |
TSDK_BOOL |
是否支持點(diǎn)擊呼叫 |
|
support_im |
TSDK_BOOL |
是否支持即時(shí)消息(暫不支持，預(yù)留) |
|
support_rich_media_message |
TSDK_BOOL |
是否支持富媒體消息 |
|
support_enterprise_address_book |
TSDK_BOOL |
是否支持企業(yè)通訊錄 |
|
support_svc_conf_caps |
TSDK_BOOL |
是否支持SVC(多流)會(huì)議能力 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
level |
日志級(jí)別 |
|
|
max_size_kb |
TSDK_INT32 |
每個(gè)日志文件的最大值，單位: KB，最大10*1024 KB |
|
file_count |
TSDK_INT32 |
日志文件個(gè)數(shù)，最大值為所能取到的最大值，建議為4 |
|
path |
TSDK_CHAR[] |
日志存放路徑 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
ca_cert_path |
TSDK_CHAR[] |
ca根證書(shū)存儲(chǔ)路徑 |
|
client_cert_path |
TSDK_CHAR[] |
客戶端證書(shū)存儲(chǔ)路徑 |
|
client_key_path |
TSDK_CHAR[] |
客戶端私鑰存儲(chǔ)路徑 |
|
client_privkey_pwd |
TSDK_CHAR[] |
客戶端私鑰密碼 |
|
verify_mode |
認(rèn)證模式 |
|
|
verify_server_mode |
校驗(yàn)服務(wù)器模式 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
user_name |
TSDK_CHAR[] |
帳戶用戶名 |
|
password |
TSDK_CHAR[] |
帳戶密碼 |
|
proxy_uri |
TSDK_CHAR[] |
服務(wù)器地址 |
|
proxy_port |
TSDK_UINT16 |
代理服務(wù)器端口號(hào) |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
sip_transport_mode |
信令傳輸模式，默認(rèn)值為TSDK_E_SIP_TRANSPORT_UDP |
|
|
media_srtp_mode |
媒體SRTP模式，默認(rèn)值為TSDK_E_MEDIA_SRTP_MODE_DISABLE |
|
|
security_tunnel_mode |
安全隧道使用模式 |
|
|
is_apply_config_priority |
TSDK_BOOL |
是否使用應(yīng)用程序配置，默認(rèn)使用鑒權(quán)過(guò)程下發(fā)的業(yè)務(wù)配置或系統(tǒng)默認(rèn)配置。 |
|
變量名 |
類型 |
描述 |
|---|---|---|
|
sip_server_udp_port |
TSDK_UINT16 |
SIP服務(wù)器的UDP端口，在is_apply_config_priority為TRUE時(shí)有效。 |
|
sip_server_tls_port |
TSDK_UINT16 |
SIP服務(wù)器的TLS端口，在is_apply_config_priority為TRUE時(shí)有效。 |
|
sip_server_tcp_port |
TSDK_UINT16 |
SIP服務(wù)器的TCP端口，在is_apply_config_priority為TRUE時(shí)有效。 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
icon_file_path |
TSDK_CHAR[] |
頭像文件保存路徑 |
|
dept_file_path |
TSDK_CHAR[] |
部門查詢結(jié)果文件保存路徑 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
dpi_x |
TSDK_UINT32 |
設(shè)備橫向Dpi |
|
dpi_y |
TSDK_UINT32 |
設(shè)備縱向Dpi |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
ip_address |
TSDK_CHAR[] |
本地ip地址 |
|
is_try_resume |
TSDK_BOOL |
是否嘗試恢復(fù)登錄和正在進(jìn)行的會(huì)議，若為TRUE，SDK將以嘗試以最大的能力去恢復(fù)登錄和正在進(jìn)行的會(huì)議 |
|
變量名 |
類型 |
描述 |
|---|---|---|
|
push_operation |
Push操作類型 |
|
|
enable_no_push_by_time |
TSDK_BOOL |
是否開(kāi)啟時(shí)段免打擾(根據(jù)時(shí)間段屏蔽Push)，默認(rèn)為False，不開(kāi)啟 |
|
no_push_start_time |
TSDK_CHAR[] |
免打擾開(kāi)始時(shí)間，格式為00:00的24小時(shí)制的UTC時(shí)間字符串，如:"13:00" |
|
no_push_end_time |
TSDK_CHAR[] |
免打擾結(jié)束時(shí)間，格式為00:00的24小時(shí)制的UTC時(shí)間字符串，如:"14:00" |
|
變量名 |
類型 |
描述 |
|---|---|---|
|
app_id |
TSDK_UINT32 |
應(yīng)用ID |
|
language |
語(yǔ)言類型 |
|
|
push_token |
TSDK_CHAR[] |
Push Token |
|
push_class_name |
TSDK_CHAR[] |
Android App啟動(dòng)的第一個(gè)activity類路徑 |
|
heart_beat_time |
TSDK_UINT32 |
安卓后臺(tái)進(jìn)程心跳超時(shí)時(shí)長(zhǎng) |
|
變量名 |
類型 |
描述 |
|---|---|---|
|
app_id |
TSDK_UINT32 |
應(yīng)用ID |
|
language |
語(yǔ)言類型 |
|
|
apns_env_type |
蘋果推送服務(wù)器環(huán)境類型 |
|
|
apns_cret_type |
蘋果推送服務(wù)證書(shū)類型 |
|
|
device_token |
TSDK_CHAR[] |
設(shè)備Push Token |
|
voip_token |
TSDK_CHAR[] |
Voip業(yè)務(wù)Push Token |
|
push_im_active |
TSDK_CHAR[] |
IM通知欄或者透?jìng)鱝ction |
|
push_voip_active |
TSDK_CHAR[] |
VOIP后臺(tái)來(lái)電 action |
|
變量名 |
類型 |
描述 |
|---|---|---|
|
encode_level |
編碼能力級(jí)別 |
|
|
decode_level |
解碼能力級(jí)別 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
user_id |
TSDK_UINT32 |
用戶id，需要APP生成 |
|
auth_type |
鑒權(quán)類型 |
|
|
user_name |
TSDK_CHAR[] |
帳戶用戶名，鑒權(quán)類型為TSDK_E_AUTH_NORMAL時(shí)填寫 |
|
password |
TSDK_CHAR[] |
帳戶密碼，鑒權(quán)類型為TSDK_E_AUTH_NORMAL時(shí)填寫 |
|
user_ticket |
TSDK_CHAR* |
Ticket值，鑒權(quán)類型為TSDK_E_AUTH_TICKET時(shí)填寫, 最大64K字節(jié) |
|
server_type |
服務(wù)器類型，當(dāng)前僅支持TSDK_E_SERVER_TYPE_PORTAL |
|
|
server_version |
TSDK_CHAR[] |
服務(wù)器版本 |
|
server_addr |
TSDK_CHAR[] |
服務(wù)器地址 |
|
server_port |
TSDK_UINT16 |
服務(wù)器端口號(hào) |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
e_server_uri |
TSDK_CHAR[] |
eServer服務(wù)器(IM業(yè)務(wù)服務(wù)器)地址 |
|
maa_server_uri |
TSDK_CHAR[] |
MAA服務(wù)器地址 |
|
push_server_uri |
TSDK_CHAR[] |
Push服務(wù)器地址 |
|
account |
TSDK_CHAR[] |
帳號(hào) |
|
password |
TSDK_CHAR[] |
密碼 |
|
token |
TSDK_CHAR[] |
U-Portal token鑒權(quán) |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
server_addr |
TSDK_CHAR |
服務(wù)器地址 |
|
server_port |
TSDK_UINT16 |
服務(wù)器端口號(hào) |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
server_addr_info_num |
TSDK_UINT32 |
服務(wù)器數(shù)量 |
|
server_addr_info |
TSDK_S_SERVER_ADDR_INFO* |
服務(wù)器地址信息 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
firewall_mode |
防火墻模式，外網(wǎng)接入時(shí)必選 |
|
|
stg |
stg服務(wù)器信息，外網(wǎng)接入時(shí)必選 |
|
|
sip_stg |
sip stg服務(wù)器信息，外網(wǎng)接入時(shí)必選 |
|
|
e_server_stg |
通過(guò)STG接入的內(nèi)網(wǎng)eServer地址，外網(wǎng)接入時(shí)必選 |
|
|
maa_stg |
通過(guò)STG接入的內(nèi)網(wǎng)MAA地址，外網(wǎng)接入時(shí)必選 |
|
|
ms_stg |
通過(guò)STG接入的內(nèi)網(wǎng)MS地址，外網(wǎng)接入時(shí)必選 |
|
|
svn |
SVN代理服務(wù)器地址 |
|
|
https_proxy |
HTTPS反向代理地址 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
account |
TSDK_CHAR |
帳號(hào) |
|
number |
TSDK_CHAR |
voip 注冊(cè)號(hào)碼 |
|
terminal |
TSDK_CHAR |
terminal 號(hào)碼(短號(hào)) |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
conf_env_type |
會(huì)議組網(wǎng)類型 |
|
|
left_days_of_password |
TSDK_UINT32 |
登錄密碼剩余有效期天數(shù) |
|
is_first_login |
TSDK_BOOL |
是否首次登錄 |
|
is_free_user |
TSDK_BOOL |
是否免費(fèi)用戶 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
account |
TSDK_CHAR |
帳號(hào) |
|
region_id |
TSDK_INT32 |
區(qū)域ID |
|
last_login_addr |
TSDK_CHAR |
上一次登錄的地址 |
|
last_login_time |
TSDK_CHAR |
上一次登錄的時(shí)間 |
|
um_server_login_token |
TSDK_CHAR |
UM服務(wù)器(富媒體服務(wù)器)登錄Token |
|
terminal_login_info_list |
同時(shí)登錄的終端信息列表(暫不支持，預(yù)留) |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
login_time |
TSDK_INT64 |
登錄時(shí)間 |
|
client_type |
客戶端類型 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
reason_code |
TSDK_INT32 |
原因碼 |
|
reason_description |
TSDK_CHAR |
原因描述 |
|
residual_retry_times |
TSDK_INT32 |
登錄重試剩余次數(shù)，IM登錄失敗時(shí)有效 |
|
lock_interval |
TSDK_INT32 |
帳號(hào)被鎖定剩余時(shí)間（單位：分鐘），IM登錄失敗時(shí)原因 reason取值為 TSDK_E_IM_ERR_XXX 時(shí)有效 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
old_password |
TSDK_CHAR |
舊密碼 |
|
new_password |
TSDK_CHAR |
新密碼 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
call_id |
TSDK_UINT32 |
呼叫id |
|
is_caller |
TSDK_BOOL |
是否為主叫 |
|
is_video_call |
TSDK_BOOL |
是否為視頻呼叫 |
|
peer_number |
TSDK_CHAR[] |
對(duì)端號(hào)碼 |
|
peer_display_name |
TSDK_CHAR[] |
對(duì)端名稱 |
|
call_state |
呼叫狀態(tài) |
|
|
is_auto_answer |
TSDK_BOOL |
是否為自動(dòng)應(yīng)答 |
|
is_focus |
TSDK_BOOL |
是否帶isfoucs標(biāo)識(shí) |
|
conf_id |
TSDK_CHAR[] |
會(huì)議id |
|
reason_code |
TSDK_UINT32 |
原因碼 |
|
reason_description |
TSDK_CHAR[] |
原因描述 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
coordinate_x |
TSDK_INT32 |
X 軸 |
|
coordinate_y |
TSDK_INT32 |
Y 軸 |
|
coordinate_w |
TSDK_INT32 |
寬 |
|
coordinate_h |
TSDK_INT32 |
高 |
|
coordinate_z |
TSDK_INT32 |
Z軸 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
video_wnd_type |
視頻窗口類型 |
|
|
coordinate |
坐標(biāo)信息 |
|
|
render |
TSDK_UPTR |
窗口句柄 |
|
index |
TSDK_INT32 |
窗口序號(hào) |
|
session_id |
TSDK_UINT32 |
本地預(yù)覽session值 |
|
ref_count |
TSDK_UINT32 |
使用引用計(jì)數(shù) |
|
display_mode |
顯示模式 |
|
|
start_image_file_path |
TSDK_CHAR[] |
視頻顯示初始圖像，必須為jpeg圖像，且長(zhǎng)寬都是8的倍數(shù) |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
operation |
TSDK_UINT32 |
操作動(dòng)作，取值:TSDK_E_VIDEO_CTRL_OPERATION_ACT，可以使用邏輯運(yùn)算符"|"連接，open|start，close|stop |
|
object |
TSDK_UINT32 |
視頻控制對(duì)象，取值: TSDK_E_VIDEO_CTRL_OBJ，可以使用邏輯運(yùn)算符"|"連接 |
|
is_sync |
TSDK_BOOL |
是否使用同步執(zhí)行,ios8.3使用異步，否則在切后臺(tái)時(shí)調(diào)用該接口會(huì)被系統(tǒng)迅速掛起導(dǎo)致崩潰卡死 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
index |
TSDK_UINT32 |
設(shè)備索引 |
|
device_name |
TSDK_CHAR[] |
設(shè)備名稱 |
|
camera_orient |
TSDK_UINT32 |
攝像頭角度,僅移動(dòng)平臺(tái)攝像頭設(shè)備有值 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
choice |
TSDK_UINT32 |
視頻橫豎屏情況 1：豎屏；2：橫屏；3：反向橫屏 |
|
portrait |
TSDK_UINT32 |
豎屏視頻捕獲（逆時(shí)針旋轉(zhuǎn)）角度 0：0度；1：90度；2：180度；3：270度 |
|
landscape |
TSDK_UINT32 |
橫屏視頻捕獲（逆時(shí)針旋轉(zhuǎn)）角度 0：0度；1：90度；2：180度；3：270度 |
|
seascape |
TSDK_UINT32 |
反向橫屏視頻捕獲（逆時(shí)針旋轉(zhuǎn)）角度 0：0度；1：90度；2：180度；3：270度 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
render_type |
窗口類型枚舉值 |
|
|
display_type |
窗口顯示模式 0:拉伸模式 1:(不拉伸)黑邊模式 2:(不拉伸)裁剪模式 3:(需保證窗口尺寸 >= 圖像尺寸)按原始分辨率顯示 |
|
|
mirror_type |
窗口鏡像模式 0:不做鏡像(默認(rèn)值) 1:垂直鏡像(X軸鏡像)(目前未支持) 2:水平鏡像(Y軸鏡像) |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
account |
TSDK_CHAR[] |
帳號(hào) |
|
number |
TSDK_CHAR[] |
voip 注冊(cè)號(hào)碼 |
|
terminal |
TSDK_CHAR[] |
terminal 號(hào)碼(短號(hào)) |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
call_id |
TSDK_UINT32 |
呼叫ID |
|
is_fouces |
TSDK_BOOL |
是否帶isfoucs標(biāo)識(shí)，移動(dòng)會(huì)議場(chǎng)景使用 |
|
orient_type |
移動(dòng)視頻橫豎屏情況 |
|
|
local_addr |
TSDK_INT8[] |
本地地址 |
|
remote_addr |
TSDK_INT8[] |
移動(dòng)上報(bào)遠(yuǎn)端地址 |
|
reinvite_type |
主被叫控業(yè)務(wù)中Reinvite消息指示的事件類型 |
|
|
audio_send_mode |
音頻媒體方向 |
|
|
video_send_mode |
視頻媒體方向 |
|
|
data_send_mode |
輔流媒體方向 |
|
|
is_low_bw_switch_to_audio |
TSDK_BOOL |
是否是由低帶寬造成的視頻切換到音頻 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
call_id |
TSDK_UINT32 |
呼叫ID |
|
media_type |
媒體類型1 : 音頻。 2 : 視頻。 3 : 輔流 |
|
|
codec_type |
TSDK_UINT32 |
編解碼器類型 1 : 編碼器。2 : 解碼器 |
|
codec_name |
TSDK_CHAR[] |
編解碼名稱 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
audio_anr |
TSDK_UINT32 |
音頻配置:噪音抑制，[0,4] 0：關(guān)閉 1-4：數(shù)值越大，噪音抑制強(qiáng)度越大 默認(rèn)2 |
|
audio_aec |
TSDK_BOOL |
音頻配置:回聲消除，0關(guān)閉 1開(kāi)啟，默認(rèn)開(kāi)啟，建議開(kāi)啟 |
|
audio_agc |
TSDK_BOOL |
音頻配置:自動(dòng)增益，0關(guān)閉 1開(kāi)啟，默認(rèn)開(kāi)啟，建議開(kāi)啟 |
|
video_arq |
TSDK_BOOL |
視頻配置:是否開(kāi)啟丟包重傳，0關(guān)閉 1開(kāi)啟，默認(rèn)開(kāi)啟 |
|
video_tactic |
TSDK_UINT32 |
視頻配置:策略 0 圖像質(zhì)量?jī)?yōu)先 1 流暢優(yōu)先，默認(rèn)圖像質(zhì)量?jī)?yōu)先 |
|
video_avg_bit_rate |
TSDK_UINT32 |
視頻配置:平均碼率，單位:bps，取值[min_bit_rate, max_bit_rate]，默認(rèn)值4096 |
|
video_min_bit_rate |
TSDK_UINT32 |
視頻配置:最小碼率(可選)，單位:bps，取值[10, avg_bit_rate]，默認(rèn)值10 |
|
video_max_bit_rate |
TSDK_UINT32 |
視頻配置:最大碼率(可選)，單位:bps，取值[avg_bit_rate, 30000]，默認(rèn)值30000 |
|
video_max_bandwidth |
TSDK_UINT32 |
視頻配置:最大帶寬，單位:kbps，取值[64, 2048]，默認(rèn)值1920 |
|
video_frame_size |
TSDK_UINT32 |
視頻配置:編碼分辨率，取值TSDK_E_VIDEO_FRAME_SIZE |
|
video_frame_rate |
TSDK_UINT32 |
視頻配置:幀率，單位:fps，取值[1, 30]，默認(rèn)值30 |
|
video_min_frame_rate |
TSDK_UINT32 |
視頻配置:最小幀率，單位:fps，取值[1, FrameRate]，默認(rèn)值15 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
render |
TSDK_UPTR |
窗口句柄 |
|
label |
TSDK_UINT32 |
SVC Label |
|
width |
TSDK_UINT32 |
分辨率:寬 |
|
height |
TSDK_UINT32 |
分辨率:高 |
|
max_bandwidth |
TSDK_UINT32 |
多流接收方向每一路流的最大帶寬 |
|
is_sharpness |
TSDK_BOOL |
是否使用銳化模式 |
|
is_sync |
TSDK_BOOL |
是否使用同步執(zhí)行，ios 平臺(tái)應(yīng)用切后臺(tái)時(shí)使用，默認(rèn) TSDK_FALSE |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
nego_bandwidth |
TSDK_INT32 |
會(huì)話協(xié)商出的帶寬 |
|
nego_audio_codec |
TSDK_CHAR |
會(huì)話協(xié)商出的所支持的音頻編解碼列表 |
|
nego_video_codec |
TSDK_CHAR |
會(huì)話協(xié)商出的所支持的視頻編解碼列表 |
|
effective_bitrate |
TSDK_UINT32 |
有效帶寬（組件探測(cè)出的下行方向總tmmbr） |
|
audio_stream_info |
TSDK_S_AUDIO_STREAM_INFO |
音頻流信息 |
|
video_stream_info |
TSDK_S_VIDEO_STREAM_INFO |
單流視頻流信息 |
|
is_svc_conf |
TSDK_INT32 |
是否多流視頻會(huì)議 |
|
svc_stream_count |
TSDK_INT32 |
多流視頻流信息數(shù) |
|
svc_stream_info |
TSDK_S_VIDEO_STREAM_INFO |
多流視頻流信息 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
is_srtp |
TSDK_BOOL |
是否啟用SRTP， 取值: 0 RTP, 1 SRTP |
|
encode_protocol |
TSDK_CHAR |
編碼協(xié)議描述 |
|
send_bit_rate |
TSDK_UINT32 |
發(fā)送比特率(kbps) |
|
send_loss_fraction |
TSDK_FLOAT |
發(fā)送方丟包率(%) |
|
send_delay |
TSDK_FLOAT |
發(fā)送方平均時(shí)延(ms) |
|
send_jitter |
TSDK_FLOAT |
發(fā)送方平均抖動(dòng)(ms) |
|
decode_protocol |
TSDK_CHAR |
解碼協(xié)議名 |
|
recv_bit_rate |
TSDK_UINT32 |
接收比特率(kbps) |
|
recv_loss_fraction |
TSDK_FLOAT |
接收方丟包率(%) |
|
recv_delay |
TSDK_FLOAT |
接收方平均時(shí)延(ms) |
|
recv_jitter |
TSDK_FLOAT |
接收方平均抖動(dòng)(ms) |
|
recv_average_mos |
TSDK_FLOAT |
接收方向MOS分平均值,用浮點(diǎn)數(shù)表示:取值范圍[0, 5], 0表示該參數(shù)無(wú)效 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
is_srtp |
TSDK_BOOL |
是否啟用SRTP， 取值: 0 RTP, 1 SRTP |
|
bandwidth |
TSDK_UINT32 |
有效帶寬 |
|
encode_protocol |
TSDK_CHAR |
編碼協(xié)議描述 |
|
send_bit_rate |
TSDK_UINT32 |
發(fā)送比特率(kbps) |
|
send_frame_size |
TSDK_CHAR |
發(fā)送(編碼)圖像分辨率描述 |
|
send_frame_rate |
TSDK_UINT32 |
發(fā)送(編碼)視頻幀率 |
|
send_loss_fraction |
TSDK_FLOAT |
發(fā)送方丟包率(%) |
|
send_delay |
TSDK_FLOAT |
發(fā)送方平均時(shí)延(ms) |
|
send_jitter |
TSDK_FLOAT |
發(fā)送方平均抖動(dòng)(ms) |
|
decode_protocol |
TSDK_CHAR |
解碼協(xié)議名 |
|
recv_bit_rate |
TSDK_UINT32 |
接收比特率(kbps) |
|
recv_frame_size |
TSDK_CHAR |
接收(解碼)圖像分辨率描述 |
|
recv_frame_rate |
TSDK_UINT32 |
接收(解碼)視頻幀率 |
|
recv_loss_fraction |
TSDK_FLOAT |
接收方丟包率(%) |
|
recv_delay |
TSDK_FLOAT |
接收方平均時(shí)延(ms) |
|
recv_jitter |
TSDK_FLOAT |
接收方平均抖動(dòng)(ms) |
|
recv_ssrc_label |
TSDK_UINT32 |
接收方對(duì)應(yīng)的ssrc label, 多流時(shí)有效 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
size |
TSDK_UINT32 |
會(huì)議方數(shù) |
|
subject |
TSDK_CHAR[] |
會(huì)議主題 |
|
group_uri |
TSDK_CHAR[] |
可選，群組uri |
|
start_time |
TSDK_CHAR[] |
可選，會(huì)議開(kāi)始時(shí)間，格式：YYYY-MM-DD HH:MM，立即會(huì)議時(shí)無(wú)需填寫 |
|
duration |
TSDK_UINT32 |
可選，會(huì)議持續(xù)時(shí)長(zhǎng)，單位: 分鐘，默認(rèn)60分鐘 |
|
conf_type |
會(huì)議類型 |
|
|
conf_media_type |
媒體類型 |
|
|
is_hd_conf |
TSDK_BOOL |
可選，是否高清視頻會(huì)議 |
|
is_multi_stream_conf |
TSDK_BOOL |
可選，是否為多流視頻會(huì)議，預(yù)留 |
|
is_auto_record |
TSDK_BOOL |
可選，會(huì)議是否自動(dòng)啟動(dòng)錄制，預(yù)留 |
|
is_auto_prolong |
TSDK_BOOL |
可選，是否自動(dòng)延長(zhǎng)會(huì)議 |
|
is_auto_invite |
TSDK_BOOL |
可選，預(yù)約會(huì)議到時(shí)間之后是否自動(dòng)拉起 |
|
is_auto_mute |
TSDK_BOOL |
可選，非主席在入會(huì)后是否自動(dòng)閉音 |
|
welcome_prompt |
可選，入會(huì)提示音類型 |
|
|
enter_prompt |
可選，有成員入會(huì)提示音類型 |
|
|
leave_prompt |
可選，有成員離會(huì)提示音類型 |
|
|
reminder |
可選，會(huì)議提醒方式 |
|
|
language |
可選，會(huì)議的默認(rèn)語(yǔ)言 |
|
|
conf_encrypt_mode |
可選，會(huì)議媒體加密模式 |
|
|
record_mode |
可選，會(huì)議媒體錄制模式 |
|
|
attendee_num |
TSDK_UINT32 |
與會(huì)者數(shù)量 |
|
attendee_list |
與會(huì)者列表 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
size |
TSDK_UINT32 |
會(huì)議方數(shù) |
|
conf_id |
TSDK_CHAR[] |
會(huì)議id |
|
subject |
TSDK_CHAR[] |
會(huì)議主題 |
|
access_number |
TSDK_CHAR[] |
會(huì)議接入碼 |
|
chairman_pwd |
TSDK_CHAR[] |
主席密碼，在EC會(huì)議下，查詢會(huì)議列表時(shí)不能獲取，需要通過(guò)查詢會(huì)議詳情獲取 |
|
guest_pwd |
TSDK_CHAR[] |
來(lái)賓密碼，在EC會(huì)議下，查詢會(huì)議列表時(shí)不能獲取，需要通過(guò)查詢會(huì)議詳情獲取 |
|
start_time |
TSDK_CHAR[] |
會(huì)議開(kāi)始時(shí)間 |
|
end_time |
TSDK_CHAR[] |
會(huì)議結(jié)束時(shí)間 |
|
conf_media_type |
媒體類型 |
|
|
is_hd_conf |
TSDK_BOOL |
是否高清視頻會(huì)議 |
|
conf_state |
會(huì)議狀態(tài) |
|
|
record_mode |
會(huì)議媒體錄制模式 |
|
|
scheduser_account |
TSDK_CHAR[] |
預(yù)訂者帳號(hào) |
|
scheduser_name |
TSDK_CHAR[] |
預(yù)訂者姓名 |
|
token |
TSDK_CHAR[] |
會(huì)控token 僅入駐式融合會(huì)議有效 |
|
chair_join_uri |
TSDK_CHAR[] |
主持人加入會(huì)議uri鏈接 |
|
guest_join_uri |
TSDK_CHAR[] |
來(lái)賓加入會(huì)議uri鏈接 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
participant_id |
TSDK_CHAR[] |
與會(huì)者唯一標(biāo)識(shí) |
|
data_user_id |
TSDK_UINT32 |
與會(huì)者在數(shù)據(jù)會(huì)議中的用戶ID |
|
state |
用戶狀態(tài) |
|
|
is_self |
TSDK_BOOL |
是否自己 |
|
is_mute |
TSDK_BOOL |
是否閉音 |
|
is_handup |
TSDK_BOOL |
是否舉手 |
|
is_broadcast |
TSDK_BOOL |
是否被廣播 |
|
is_video |
TSDK_BOOL |
是否視頻方式加入會(huì)議 |
|
is_join_dataconf |
TSDK_BOOL |
是否已加入數(shù)據(jù)會(huì)議 |
|
is_present |
TSDK_BOOL |
是否主講人 |
|
has_camera |
TSDK_BOOL |
是否有攝像頭 |
|
is_only_in_data_conf |
TSDK_BOOL |
是否僅在數(shù)據(jù)會(huì)議中 |
|
is_anonymous |
TSDK_BOOL |
是否匿名用戶(匿名方式加入會(huì)議) |
|
is_share_owner |
TSDK_BOOL |
是否共享的擁有者 |
|
is_be_watching |
TSDK_BOOL |
是否被本地觀看狀態(tài)，SVC會(huì)議下有效 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
base_info |
與會(huì)者基礎(chǔ)信息 |
|
|
status_info |
與會(huì)者狀態(tài)信息 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
operation_type |
會(huì)控操作類型 |
|
|
reason_code |
TSDK_INT32 |
操作失敗原因碼 |
|
description |
TSDK_CHAR[] |
操作失敗原因描述 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
conf_right |
會(huì)議權(quán)限 |
|
|
is_include_end |
TSDK_BOOL |
是否包含已結(jié)束的會(huì)議 |
|
page_index |
TSDK_UINT32 |
指定返回的會(huì)議列表頁(yè)頁(yè)面索引, 索引取值從1開(kāi)始 |
|
page_size |
TSDK_UINT32 |
指定每頁(yè)返回的會(huì)議記錄數(shù)，每頁(yè)最多返回400個(gè) |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
total_count |
TSDK_UINT32 |
會(huì)議總個(gè)數(shù) |
|
current_count |
TSDK_UINT32 |
當(dāng)前返回會(huì)議個(gè)數(shù) |
|
conf_info_list |
當(dāng)前返回會(huì)議列表 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
conf_id |
TSDK_CHAR[] |
會(huì)議id |
|
page_index |
TSDK_UINT32 |
指定返回的與會(huì)者列表頁(yè)的頁(yè)面索引, 索引取值從1開(kāi)始 |
|
page_size |
TSDK_UINT32 |
指定每頁(yè)返回與會(huì)者的記錄數(shù),每頁(yè)最多返回400個(gè) |
|
sub_conf_id |
TSDK_CHAR[ |
周期會(huì)議子會(huì)議id(預(yù)留，暫不支持) |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
conf_info |
會(huì)議信息 |
|
|
attendee_num |
TSDK_UINT32 |
與會(huì)者數(shù)量 |
|
attendee_list |
與會(huì)者列表 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
call_id |
TSDK_UINT32 |
呼叫ID，軟終端號(hào)碼入會(huì)時(shí)有效 |
|
conf_media_type |
媒體類型 |
|
|
is_hd_conf |
TSDK_BOOL |
是否高清視頻會(huì)議 |
|
conf_env_type |
會(huì)議組網(wǎng)類型 |
|
|
is_svc_conf |
TSDK_BOOL |
是否多流會(huì)議 |
|
svc_label_count |
TSDK_INT8 |
多流Label有效個(gè)數(shù) |
|
svc_label |
TSDK_UINT32[TSDK_D_MAX_SVC_LABEL_NUM] |
多流Label對(duì)應(yīng)的ssrc值 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
size |
TSDK_UINT32 |
會(huì)議方數(shù) |
|
conf_id |
TSDK_CHAR[] |
會(huì)議id |
|
subject |
TSDK_CHAR[] |
會(huì)議主題 |
|
group_uri |
TSDK_CHAR[] |
群組uri |
|
conf_media_type |
媒體類型 |
|
|
is_hd_conf |
TSDK_BOOL |
是否高清視頻會(huì)議 |
|
conf_state |
會(huì)議狀態(tài) |
|
|
scheduser_account |
TSDK_CHAR[] |
預(yù)訂者帳號(hào) |
|
scheduser_name |
TSDK_CHAR[] |
預(yù)訂者姓名 |
|
is_record |
TSDK_BOOL |
會(huì)場(chǎng)是否為錄播狀態(tài) |
|
is_lock |
TSDK_BOOL |
會(huì)場(chǎng)是否為鎖定狀態(tài) |
|
is_all_mute |
TSDK_BOOL |
會(huì)場(chǎng)是否為靜音狀態(tài) |
|
update_type |
成員更新方式 |
|
|
attendee_num |
TSDK_UINT32 |
與會(huì)者數(shù)量 |
|
attendee_list |
與會(huì)者列表 |
|
|
is_live_broadcast |
TSDK_BOOL |
會(huì)場(chǎng)是否為直播狀態(tài) |
|
is_support_live_broadcast |
TSDK_BOOL |
是否支持直播 |
|
is_support_record_broadcast |
TSDK_BOOL |
是否支持錄播 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
conf_id |
TSDK_CHAR[] |
會(huì)議id |
|
access_number |
TSDK_CHAR[] |
會(huì)議接入碼 |
|
conf_password |
TSDK_CHAR[] |
會(huì)議密碼 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
attendee_num |
TSDK_UINT32 |
與會(huì)者個(gè)數(shù) |
|
attendee_list |
與會(huì)者列表 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
watch_attendee_num |
TSDK_UINT32 |
被選看的與會(huì)者個(gè)數(shù) |
|
watch_attendee_list |
被選看的與會(huì)者信息列表 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
number |
TSDK_CHAR[] |
號(hào)碼 |
|
label |
TSDK_UINT32 |
SVC Label，SVC 會(huì)議功能時(shí)有效 |
|
width |
TSDK_UINT32 |
分辨率:寬，SVC 會(huì)議功能時(shí)有效 |
|
height |
TSDK_UINT32 |
分辨率:高，SVC 會(huì)議功能時(shí)有效 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
conf_id |
TSDK_CHAR[] |
會(huì)議id |
|
host_key |
TSDK_CHAR[] |
主持人密碼：主持人入會(huì)必須設(shè)置，其他情況不需要 |
|
crypt_key |
TSDK_CHAR[] |
會(huì)議鑒權(quán)密碼 |
|
cm_address |
TSDK_CHAR[] |
sip網(wǎng)關(guān)地址及端口 |
|
site_url |
TSDK_CHAR[] |
會(huì)議站點(diǎn)地址 |
|
site_id |
TSDK_CHAR[] |
站點(diǎn)ID |
|
server_ip |
TSDK_CHAR[] |
會(huì)議服務(wù)器地址，單個(gè)地址或URL |
|
user_id |
TSDK_CHAR[] |
用戶id |
|
user_name |
TSDK_CHAR[] |
用戶名 |
|
user_uri |
TSDK_CHAR[] |
用戶uri |
|
conf_name |
TSDK_CHAR[] |
會(huì)議名稱 |
|
access_code |
TSDK_CHAR[] |
會(huì)議接入碼 |
|
part_secure_conf_num |
TSDK_CHAR[] |
與會(huì)者安全會(huì)議號(hào) |
|
stg_server_address |
TSDK_CHAR[] |
stg服務(wù)器地址 |
|
sbc_server_address |
TSDK_CHAR[] |
sbc服務(wù)器地址 |
|
user_role |
TSDK_UINT32 |
會(huì)議成員角色 |
|
mcu_number |
TSDK_UINT32 |
MCU 號(hào) |
|
terminal_number |
TSDK_UINT32 |
Terminal 號(hào) |
|
pin_code |
TSDK_CHAR[] |
pin code 碼 |
|
participant_id |
TSDK_CHAR[] |
與會(huì)者 id |
|
short_user_name |
TSDK_CHAR[] |
用戶名稱(取user_name的前63個(gè)字節(jié)) |
|
short_conf_name |
TSDK_CHAR[] |
會(huì)議名稱(取conf_name的前63個(gè)字節(jié)) |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
speaker_num |
TSDK_UINT32 |
發(fā)言方個(gè)數(shù) |
|
speakers[] |
發(fā)言方 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
base_info |
與會(huì)者基礎(chǔ)信息 |
|
|
status_info |
與會(huì)者狀態(tài)信息 |
|
|
is_speaking |
TSDK_BOOL |
是否發(fā)言 |
|
speaking_volume |
TSDK_UINT32 |
音量 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
conf_media_type |
媒體類型 |
|
|
is_hd_conf |
TSDK_BOOL |
是否高清視頻會(huì)議 |
|
number |
TSDK_CHAR[] |
來(lái)電號(hào)碼 |
|
subject |
TSDK_CHAR[] |
會(huì)議主題 |
|
group_uri |
TSDK_CHAR[] |
群組uri |
|
conf_id |
TSDK_CHAR[] |
會(huì)議id |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
user_id |
TSDK_UINT32 |
用戶id，需要APP生成 |
|
conf_id |
TSDK_CHAR[] |
會(huì)議id |
|
conf_password |
TSDK_CHAR[] |
會(huì)議密碼 |
|
display_name |
TSDK_CHAR[] |
可選，與會(huì)者顯示名稱 |
|
server_addr |
TSDK_CHAR[] |
會(huì)議服務(wù)器地址 |
|
server_port |
TSDK_UINT16 |
服務(wù)器端口號(hào) |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
label |
TSDK_UINT32 |
SVC Label，SVC 會(huì)議功能時(shí)有效 |
|
base_info |
與會(huì)者基礎(chǔ)信息 |
|
|
status_info |
與會(huì)者狀態(tài)信息 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
watch_attendee_num |
TSDK_UINT32 |
觀看的與會(huì)者畫(huà)面信息個(gè)數(shù) |
|
watch_attendees |
TSDK_S_CONF_SVC_WATCH_ATTENDEE[TSDK_D_MAX_SVC_STREAM_NUM] |
觀看的與會(huì)者畫(huà)面信息列表 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
original_handle |
TSDK_UINT32 |
原始(before resuming)的會(huì)議句柄 |
|
join_conf_ind_info |
重新加入會(huì)議的通知信息 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
window_handle |
TSDK_VOID* |
應(yīng)用程序窗口句柄 |
|
window_title |
TSDK_UINT16* |
窗口名稱 |
|
small_icon_handle |
TSDK_VOID* |
ICON圖標(biāo)Handle |
|
is_checked |
TSDK_BOOL |
是否被選中 取值；true為被選中，false為沒(méi)有被選中 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
type |
TSDK_UINT32 |
參數(shù)類型 |
|
data_len |
TSDK_UINT32 |
參數(shù)數(shù)據(jù)長(zhǎng)度 |
|
data |
TSDK_VOID* |
參數(shù)數(shù)據(jù) |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
document_id |
TSDK_UINT32 |
文檔ID |
|
page_count |
TSDK_UINT32 |
頁(yè)數(shù) |
|
document_name |
TSDK_CHAR[] |
文檔名稱 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
component_id |
組件ID |
|
|
document_id |
TSDK_UINT32 |
文檔ID |
|
page_index |
TSDK_INT32 |
頁(yè)面索引 |
|
page_count |
TSDK_INT32 |
文檔總頁(yè)數(shù) |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
doc_page_info |
文檔頁(yè)信息，目前標(biāo)注支持文檔共享和白板 |
|
|
width |
TSDK_INT32 |
當(dāng)前頁(yè)的寬 |
|
height |
TSDK_INT32 |
當(dāng)前頁(yè)的高 |
|
org_x |
TSDK_INT32 |
服務(wù)器上的該頁(yè)起點(diǎn)X會(huì)標(biāo) |
|
org_y |
TSDK_INT32 |
服務(wù)器上的該頁(yè)起點(diǎn)Y會(huì)標(biāo) |
|
rotate_type |
服務(wù)器上的該頁(yè)旋轉(zhuǎn)類型 |
|
|
zoom_percent |
TSDK_FLOAT |
該頁(yè)的縮放比例 |
|
is_copied |
TSDK_UCHAR |
該頁(yè)是否復(fù)制的頁(yè) |
|
is_e_pen_drawn |
TSDK_UCHAR |
該頁(yè)是否被電子白板畫(huà)過(guò) |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
doc_base_info |
文檔頁(yè)信息，目前標(biāo)注支持文檔共享和白板 |
|
|
doc_del_number |
TSDK_CHAR[] |
文檔擁有者的號(hào)碼 |
|
doc_del_display_name |
TSDK_CHAR[] |
顯示的文檔名稱 |
|
doc_del_attendee |
刪除文檔的與會(huì)者的詳細(xì)信息 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
display_size |
激光點(diǎn)顯示尺寸 |
|
|
is_local |
TSDK_BOOL |
是否本地化圖片（即由客戶端固化打包，不需要經(jīng)過(guò)網(wǎng)絡(luò)傳輸）,0表示普通圖片，1表示本地化圖片 |
|
local_index |
TSDK_UINT32 |
當(dāng)is_local為1時(shí)有效，表示對(duì)應(yīng)的本地化圖片的索引，該索引用于底層向上層取數(shù)據(jù) |
|
pic_format |
is_local為0時(shí)有效，表示圖片格式 |
|
|
data |
TSDK_VOID* |
當(dāng)is_local為0時(shí)有效，存放普通圖片的數(shù)據(jù)，is_local為1時(shí)，可以為NULL |
|
data_len |
TSDK_UINT32 |
當(dāng)bLocal為0時(shí)有效，存放圖片數(shù)據(jù)的長(zhǎng)度 |
|
pic_width |
TSDK_INT32 |
當(dāng)is_local為0時(shí)有效，圖片寬 |
|
pic_high |
TSDK_INT32 |
當(dāng)is_local為0時(shí)有效，圖片高 |
|
offset |
相對(duì)于圖片左上角的偏移，TWIP為單位，用于縮放時(shí)用于計(jì)算圖片位置的參照點(diǎn) |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
bounds |
外接矩形 |
|
|
text_string |
TSDK_CHAR* |
標(biāo)注文本，utf8字符串 |
|
font |
TSDK_CHAR* |
字體名 |
|
color |
TSDK_UINT32 |
文字顏色(RGBA)，0xRRGGBBAA表示，其中AA為透明值，目前應(yīng)該全部傳FF |
|
size |
TSDK_UINT32 |
字體大小 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
left |
TSDK_INT32 |
矩形左側(cè)x坐標(biāo) |
|
top |
TSDK_INT32 |
矩形頂部y坐標(biāo) |
|
right |
TSDK_INT32 |
矩形右側(cè)x坐標(biāo) |
|
bottom |
TSDK_INT32 |
矩形下部y坐標(biāo) |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
doc_page_info |
文檔頁(yè)信息，目前標(biāo)注支持文檔共享和白板 |
|
|
point |
要判斷的點(diǎn)，以TWIPS以單位，且必須是相對(duì)于頁(yè)面原點(diǎn)無(wú)縮放的坐標(biāo) |
|
|
hit_test_mode |
測(cè)試模式 |
|
|
user_number |
TSDK_CHAR[] |
用戶號(hào)碼，當(dāng)hit_test_mode為TSDK_E_ANNOTATION_HIT_SET_OTHERS、TSDK_E_ANNOTATION_HIT_SET_SOMEONE時(shí)有效 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
doc_page_info |
文檔頁(yè)信息，目前標(biāo)注支持文檔共享和白板 |
|
|
rectangle_area |
要測(cè)試的矩形區(qū)域 |
|
|
hit_test_mode |
測(cè)試模式 |
|
|
user_number |
TSDK_CHAR[] |
用戶號(hào)碼，當(dāng)hit_test_mode為TSDK_E_ANNOTATION_HIT_SET_OTHERS、TSDK_E_ANNOTATION_HIT_SET_SOMEONE時(shí)有效 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
doc_page_info |
文檔頁(yè)信息，目前標(biāo)注支持文檔共享和白板 |
|
|
start_point |
起始點(diǎn) |
|
|
end_point |
結(jié)束點(diǎn) |
|
|
hit_test_mode |
測(cè)試模式 |
|
|
user_number |
TSDK_CHAR[] |
用戶號(hào)碼，當(dāng)hit_test_mode為TSDK_E_ANNOTATION_HIT_SET_OTHERS、TSDK_E_ANNOTATION_HIT_SET_SOMEONE時(shí)有效 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
doc_page_info |
文檔頁(yè)信息，目前標(biāo)注支持文檔共享和白板 |
|
|
annotation_id_list |
TSDK_UINT32* |
要設(shè)置的標(biāo)注元素id的數(shù)組 |
|
count |
TSDK_UINT32 |
annotation_id_list中的元素個(gè)數(shù) |
|
select_mode |
選中的模式 |
|
|
creator_number |
TSDK_CHAR[] |
用戶號(hào)碼，當(dāng)select_mode為TSDK_E_ANNOTATION_SELECT_OTHERS、TSDK_E_ANNOTATION_SELECT_SOMEONE時(shí)有效 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
doc_page_info |
文檔頁(yè)信息，目前標(biāo)注支持文檔共享和白板 |
|
|
annotation_id_list |
TSDK_UINT32* |
要設(shè)置的標(biāo)注元素id的數(shù)組 |
|
count |
TSDK_UINT32 |
annotation_id_list中的元素個(gè)數(shù) |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
bounds |
外接矩形 |
|
|
main_type |
標(biāo)注類型 |
|
|
sub_type |
TSDK_UINT32 |
標(biāo)注子類型 |
|
creator_number |
TSDK_CHAR[] |
創(chuàng)建者號(hào)碼 |
|
flag |
TSDK_UINT32 |
該子類型標(biāo)注的屬性，所有互通終端需要相同 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
style |
畫(huà)筆樣式 |
|
|
color |
TSDK_UINT32 |
顏色(RGBA)，0xRRGGBBAA表示 |
|
width |
TSDK_INT32 |
畫(huà)筆寬度 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
style |
畫(huà)刷樣式 |
|
|
color |
TSDK_UINT32 |
顏色(RGBA)，0xRRGGBBAA表示 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
chat_type |
消息類型，當(dāng)前僅支持TSDK_E_CONF_CHAT_PUBLIC |
|
|
reviciver_number |
TSDK_CHAR[] |
消息接收者號(hào)碼，當(dāng)前僅支持發(fā)送公共消息，無(wú)需填寫，預(yù)留 |
|
sender_number |
TSDK_CHAR[] |
發(fā)送者的號(hào)碼(接收消息攜帶，發(fā)送消息時(shí)無(wú)需填寫) |
|
sender_display_name |
TSDK_CHAR[] |
發(fā)送者的名稱(接收消息攜帶，發(fā)送消息時(shí)無(wú)需填寫) |
|
sender |
發(fā)送者詳細(xì)信息(接收消息攜帶，發(fā)送消息時(shí)無(wú)需填寫) |
|
|
chat_msg |
TSDK_CHAR* |
消息內(nèi)容 |
|
chat_msg_len |
TSDK_UINT32 |
消息內(nèi)容長(zhǎng)度 |
|
sender_display_name |
TSDK_CHAR[] |
發(fā)送者的名稱 |
|
time |
TSDK_LONG |
消息發(fā)送時(shí)服務(wù)器時(shí)間(接收消息攜帶，發(fā)送消息時(shí)無(wú)需填寫) |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
state |
共享狀態(tài) |
|
|
sub_state |
TSDK_UINT32 |
共享子狀態(tài)，預(yù)留字段 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
wb_base_info |
文檔基礎(chǔ)信息 |
|
|
wb_del_number |
TSDK_CHAR |
刪除白板的與會(huì)者的號(hào)碼 |
|
wb_del_display_name |
TSDK_CHAR |
刪除白板的與會(huì)者的名稱 |
|
wb_del_attendee |
刪除白板的與會(huì)者的詳細(xì)信息 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
is_local |
TSDK_BOOL |
是否本地化圖片（即由客戶端固化打包，不需要經(jīng)過(guò)網(wǎng)絡(luò)傳輸）,0表示普通圖片，1表示本地化圖片 |
|
local_index |
TSDK_UINT32 |
當(dāng)is_local為1時(shí)有效，表示對(duì)應(yīng)的本地化圖片的索引，該索引用于底層向上層取數(shù)據(jù) |
|
pic_format |
當(dāng)is_local為0時(shí)有效，表示圖片格式 |
|
|
data |
TSDK_VOID* |
當(dāng)is_local為0時(shí)有效，存放普通圖片的數(shù)據(jù)，is_local為1時(shí)，可以為NULL |
|
data_len |
TSDK_UINT32 |
當(dāng)bLocal為0時(shí)有效，存放圖片數(shù)據(jù)的長(zhǎng)度 |
|
pic_width |
TSDK_INT32 |
當(dāng)is_local為0時(shí)有效，圖片寬 |
|
pic_high |
TSDK_INT32 |
當(dāng)is_local為0時(shí)有效，圖片高 |
|
display_area |
TSDK_S_RECTANGULAR |
圖片顯示區(qū)域,當(dāng)bLocal為1時(shí)，dispRect的寬高必須與初始化資源時(shí)傳入的顯示寬高相同 |
|
offset |
TSDK_S_POINT |
相對(duì)于圖片左上角的偏移，TWIP為單位，用于縮放時(shí)用于計(jì)算圖片位置的參照點(diǎn) |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
share_status |
共享狀態(tài) |
|
|
component_id |
TSDK_UINT32 |
正在共享的組件ID，取值TSDK_E_COMPONENT_ID |
|
sharing_number |
TSDK_CHAR |
正在共享的與會(huì)者的號(hào)碼 |
|
sharing_display_name |
TSDK_CHAR |
正在共享的與會(huì)者的名稱 |
|
sharing_attendee |
正在共享的與會(huì)者的詳細(xì)信息 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
width |
TSDK_UINT32 |
虛擬顯示器的寬度 |
|
height |
TSDK_UINT32 |
虛擬顯示器的高度 |
|
bit_count |
TSDK_UINT32 |
虛擬顯示器圖像每個(gè)像素的位數(shù) |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
y_data |
TSDK_UINT8* |
圖片明亮度(Luminance)信息 |
|
cb_cr_data |
TSDK_UINT8* |
圖片色度(Chrominance)信息 |
|
y_data_size |
TSDK_UINT32 |
圖片明亮度(Luminance)信息長(zhǎng)度 |
|
cb_cr_data_size |
TSDK_UINT32 |
圖片色度(Chrominance)信息長(zhǎng)度 |
|
width |
TSDK_UINT32 |
圖片寬度(單位:ppi) |
|
height |
TSDK_UINT32 |
圖片高度(單位:ppi) |
|
orientation |
圖片方向 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
status |
TSDK_UINT32 |
狀態(tài)，不涉及：0，發(fā)送數(shù)據(jù)：1，接收數(shù)據(jù)：2 |
|
send_frame_size_width |
TSDK_UINT32 |
發(fā)送(編碼)視頻分辨率-寬 |
|
send_frame_size_height |
TSDK_UINT32 |
發(fā)送(編碼)視頻分辨率-高 |
|
send_bit_rate |
TSDK_UINT32 |
發(fā)送(編碼)碼率(bps) |
|
send_frame_rate |
TSDK_UINT32 |
發(fā)送(編碼)視頻幀率 |
|
encode_version |
TSDK_UINT32 |
編碼協(xié)議版本 |
|
send_pkt_loss |
TSDK_FLOAT |
發(fā)送方丟包率（0.xx%）；-1表示未啟用該參數(shù) |
|
send_rtt |
TSDK_UINT32 |
發(fā)送方環(huán)路時(shí)延（ms）；0表示未啟用該參數(shù)；不支持獲取平均值、最大值和最小值 |
|
send_jitter |
TSDK_UINT32 |
發(fā)送方抖動(dòng)（ms）；0表示未啟用該參數(shù)；不支持獲取平均值、最大值和最小值 |
|
recv_frame_size_width |
TSDK_UINT32 |
接收(解碼)視頻分辨率-寬 |
|
recv_frame_size_height |
TSDK_UINT32 |
接收(解碼)視頻分辨率-高 |
|
recv_bit_rate |
TSDK_UINT32 |
接收(解碼)碼率(bps) |
|
recv_frame_rate |
TSDK_UINT32 |
接收(解碼)視頻幀率 |
|
decode_version |
TSDK_UINT32 |
解碼協(xié)議版本 |
|
recv_pkt_loss |
TSDK_FLOAT |
接收方丟包率（0.xx%）；-1表示未啟用該參數(shù) |
|
recv_rtt |
TSDK_UINT32 |
接收方環(huán)路時(shí)延（ms）；0表示未啟用該參數(shù)；不支持獲取平均值、最大值和最小值 |
|
recv_jitter |
TSDK_UINT32 |
接收方抖動(dòng)（ms）；0表示未啟用該參數(shù)；不支持獲取平均值、最大值和最小值 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
search_keyword |
TSDK_CHAR[] |
搜索關(guān)鍵字 |
|
page_index |
TSDK_UINT32 |
當(dāng)前需要查找的頁(yè)數(shù) |
|
is_exact_search |
TSDK_BOOL |
是否精確查找，取值：
|
|
department_id |
TSDK_CHAR[] |
可選，部門ID，若填寫則在指定部門下查找 |
|
seq_no |
TSDK_UINT32 |
查詢序號(hào) |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
account |
TSDK_CHAR[] |
UC帳號(hào) |
|
seq_no |
TSDK_UINT32 |
查詢序號(hào) |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
staff_account |
TSDK_CHAR[] |
UC帳號(hào) |
|
person_name |
TSDK_CHAR[] |
姓名 |
|
staff_no |
TSDK_CHAR[] |
工號(hào) |
|
terminal |
TSDK_CHAR[] |
IP號(hào)碼 軟終端號(hào)碼 |
|
terminal2 |
TSDK_CHAR[] |
軟終端公網(wǎng)長(zhǎng)號(hào) |
|
department_name |
TSDK_CHAR[] |
部門名字 |
|
title |
TSDK_CHAR[] |
職務(wù) |
|
mobile |
TSDK_CHAR[] |
手機(jī)號(hào)碼 |
|
home_phone |
TSDK_CHAR[] |
家庭電話 |
|
|
TSDK_CHAR[] |
郵箱 |
|
office_phone |
TSDK_CHAR[] |
座機(jī)號(hào)碼 辦公電話 |
|
office_phone2 |
TSDK_CHAR[] |
硬終端2 |
|
office_phone3 |
TSDK_CHAR[] |
硬終端3 |
|
office_phone4 |
TSDK_CHAR[] |
硬終端4 |
|
office_phone5 |
TSDK_CHAR[] |
硬終端5 |
|
office_phone6 |
TSDK_CHAR[] |
硬終端6 |
|
other_phone |
TSDK_CHAR[] |
其他電話 |
|
other_phone2 |
TSDK_CHAR[] |
其他電話2 |
|
gender |
TSDK_CHAR[] |
性別 |
|
zip_code |
TSDK_CHAR[] |
郵編 |
|
address |
TSDK_CHAR[] |
地址 |
|
signature |
TSDK_CHAR[] |
簽名 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
page |
TSDK_UINT32 |
當(dāng)前頁(yè)碼 |
|
total_num |
TSDK_UINT32 |
聯(lián)系人總數(shù) |
|
contact_info |
聯(lián)系人信息 |
|
|
current_num |
TSDK_UINT32 |
當(dāng)前查詢結(jié)果數(shù) |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
icon_id |
TSDK_UINT32 |
系統(tǒng)頭像id |
|
icon_path |
TSDK_CHAR[] |
自定義頭像文件路徑 |
|
參數(shù)名 |
類型 |
描述 |
|---|---|---|
|
department_id |
TSDK_CHAR[] |
部門id |
|
parent_id |
TSDK_CHAR[] |
父節(jié)點(diǎn)id |
|
department_name |
TSDK_CHAR[] |
部門名稱 |
