更新時間:2019-12-10
業(yè)務(wù)類別 |
數(shù)據(jù)結(jié)構(gòu) |
---|---|
組件初始化與配置 |
|
登錄和注銷 |
|
音視頻呼叫 |
|
會議 |
|
通訊錄 |
|
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
clientType |
終端類型。 |
Y |
Y |
|
productName |
String |
產(chǎn)品名信息,最大長度255字節(jié)。 |
Y |
Y |
deviceSn |
String |
設(shè)備SN號,可選參數(shù),最大長度127字節(jié)。 |
Y |
Y |
supportAudioAndVideoCall |
int |
是否支持音視頻呼叫。 |
Y |
Y |
supportAudioAndVideoConf |
int |
是否支持音視頻會議。 |
Y |
Y |
supportDataConf |
int |
是否支持數(shù)據(jù)會議。 |
Y |
Y |
supportCtd |
int |
是否支持點擊呼叫。 |
Y |
Y |
supportIm |
int |
是否支持即時消息。 |
Y |
Y |
supportRichMediaMessage |
int |
是否支持富媒體消息。 |
Y |
Y |
supportEnterpriseAddressBook |
int |
是否支持企業(yè)通訊錄。 |
Y |
Y |
supportSvcConfCaps |
int |
是否支持SVC多流會議。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
level |
日志級別。 |
Y |
Y |
|
maxZizeKb |
int |
每個日志文件的最大值。單位: KB,最大10*1024 KB。 |
Y |
Y |
fileCount |
int |
日志文件個數(shù),最大值為所能取到的最大值,建議為4 |
Y |
Y |
path |
String |
日志存放路徑,最大255字節(jié)。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
caCertPath |
String |
CA根證書存儲路徑,最大長度511字節(jié)。 |
Y |
Y |
clientCertPath |
String |
客戶端證書存儲路徑,最大長度511字節(jié)。 |
Y |
Y |
clientKeyPath |
String |
客戶端私鑰存儲路徑,最大長度511字節(jié)。 |
Y |
Y |
clientPrivkeyPwd |
String |
客戶端私鑰密碼,最大長度127字節(jié)。 |
Y |
Y |
verifyMode |
認證模式。 |
Y |
Y |
|
verifyServerMode |
校驗服務(wù)器模式。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
userName |
String |
帳戶用戶名。最大長度127字節(jié)。 |
Y |
Y |
password |
String |
帳戶密碼。最大長度127字節(jié)。 |
Y |
Y |
proxyUri |
String |
服務(wù)器地址。最大長度255字節(jié)。 |
Y |
Y |
proxyPort |
int |
代理服務(wù)器端口號。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
mediaSrtpMode |
int |
安全隧道使用模式。 |
Y |
Y |
sipTransportMode |
信令傳輸模式。默認值為TSDK_E_SIP_TRANSPORT_UDP。 |
Y |
Y |
|
mediaSrtpMode |
媒體SRTP模式。默認值為TSDK_E_MEDIA_SRTP_MODE_DISABLE。 |
Y |
Y |
|
isApplyConfigPriority |
int |
是否使用應(yīng)用程序配置。默認使用鑒權(quán)過程下發(fā)的業(yè)務(wù)配置或系統(tǒng)默認配置。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
isTryResume |
int |
是否嘗試恢復(fù)登錄和正在進行的會議,若為1,SDK將以嘗試以最大的能力去恢復(fù)登錄和正在進行的會議 |
Y |
Y |
ipAddress |
String |
本地IP地址,最長255字節(jié)。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
iconFilePath |
String |
頭像文件保存路徑。最大長度2047字節(jié)。 |
Y |
Y |
deptFilePath |
String |
部門查詢結(jié)果文件保存路徑。最大長度2047字節(jié)。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
dpiX |
long |
設(shè)備橫向DPI。 |
Y |
Y |
dpiY |
long |
設(shè)備縱向DPI。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
result |
long |
結(jié)果。 |
Y |
Y |
reasonDescription |
String |
原因描述。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
sipServerUdpPort |
int |
SIP服務(wù)器的UDP端口。在isApplyConfigPriority為TRUE時有效。 |
Y |
Y |
sipServerTlsPort |
int |
SIP服務(wù)器的TLS端口。在isApplyConfigPriority為TRUE時有效。 |
Y |
Y |
sipServerTcpPort |
int |
SIP服務(wù)器的TCP端口。在isApplyConfigPriority為TRUE時有效。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
userId |
long |
用戶ID,需要APP生成。 |
Y |
Y |
authType |
鑒權(quán)類型。 |
Y |
Y |
|
userName |
String |
帳戶用戶名。鑒權(quán)類型為TSDK_E_AUTH_NORMAL時填寫,最大長度127字節(jié)。 |
Y |
Y |
password |
String |
帳戶密碼。鑒權(quán)類型為TSDK_E_AUTH_NORMAL時填寫,最大長度127字節(jié)。 |
Y |
Y |
userTicket |
String |
Ticket值。鑒權(quán)類型為TSDK_E_AUTH_TICKET時填寫,最大64K字節(jié)。 |
Y |
Y |
serverType |
服務(wù)器類型。當前僅支持TSDK_E_SERVER_TYPE_PORTAL |
Y |
Y |
|
serverVersion |
String |
服務(wù)器版本。最大長度127字節(jié)。 |
Y |
Y |
serverAddr |
String |
服務(wù)器地址。最大長度255字節(jié)。 |
Y |
Y |
serverPort |
int |
服務(wù)器端口號。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
eServerUri |
String |
eServer服務(wù)器(IM業(yè)務(wù)服務(wù)器)地址,最大長度255字節(jié)。 |
Y |
Y |
maaServerUri |
String |
MAA服務(wù)器地址,最大長度255字節(jié)。 |
Y |
Y |
pushServerUri |
String |
Push服務(wù)器地址(用于Android),最大長度255字節(jié)。 |
Y |
Y |
account |
String |
帳號。最大長度127字節(jié)。 |
Y |
Y |
password |
String |
密碼。最大長度127字節(jié)。 |
Y |
Y |
token |
String |
U-Portal token鑒權(quán)。最大長度127字節(jié)。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
account |
String |
帳號。最大長度127字節(jié)。 |
Y |
Y |
number |
String |
VoIP注冊號碼。最大長度127字節(jié)。 |
Y |
Y |
terminal |
String |
terminal號碼(短號)。最大長度127字節(jié)。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
confEnvType |
會議組網(wǎng)類型。 |
Y |
Y |
|
leftDaysOfPassword |
long |
登錄密碼剩余有效期天數(shù)。 |
Y |
Y |
isFirstLogin |
int |
是否首次登錄。 |
Y |
Y |
isFreeUser |
int |
是否免費用戶。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
eServerStg |
通過STG接入的內(nèi)網(wǎng)eServer地址。外網(wǎng)接入時必選。 |
Y |
Y |
|
svn |
SVN代理服務(wù)器地址。 |
Y |
Y |
|
firewallMode |
int |
防火墻模式。外網(wǎng)接入時必選。 |
Y |
Y |
maaStg |
通過STG接入的內(nèi)網(wǎng)MAA地址。外網(wǎng)接入時必選。 |
Y |
Y |
|
msStg |
通過STG接入的內(nèi)網(wǎng)MS地址。外網(wǎng)接入時必選。 |
Y |
Y |
|
httpsProxy |
HTTPS反向代理地址。 |
Y |
Y |
|
stg |
STG服務(wù)器信息。外網(wǎng)接入時必選。 |
Y |
Y |
|
sipStg |
SIP STG服務(wù)器信息。外網(wǎng)接入時必選。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
serverAddrInfoNum |
long |
服務(wù)器數(shù)量。 |
Y |
Y |
serverAddrInfo |
List<TsdkServerAddrInfo> |
服務(wù)器地址信息。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
serverPort |
int |
服務(wù)器端口號。 |
Y |
Y |
serverAddr |
String |
服務(wù)器地址。最大長度255字節(jié)。 |
Y |
Y |
參數(shù)名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
reasonCode |
int |
原因碼。 |
Y |
Y |
reasonDescription |
String |
原因描述。最大長度1023字節(jié)。 |
Y |
Y |
residualRetryTimes |
int |
登錄重試剩余次數(shù)。IM登錄失敗時有效。 |
Y |
Y |
lockInterval |
int |
帳號被鎖定剩余時間(單位:分鐘)。IM登錄失敗時原因,reason取值為 TSDK_E_IM_ERR_XXX 時有效。 |
Y |
Y |
參數(shù)名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
loginTime |
long |
登錄時間。 |
Y |
Y |
clientType |
客戶端類型。 |
Y |
Y |
參數(shù)名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
account |
String |
帳號。最大長度127字節(jié)。 |
Y |
Y |
regionId |
int |
區(qū)域ID。 |
Y |
Y |
lastLoginAddr |
String |
上一次登錄的地址。最大長度255字節(jié)。 |
Y |
Y |
lastLoginTime |
String |
上一次登錄的時間。最大長度31字節(jié)。 |
Y |
Y |
umServerLoginToken |
String |
UM服務(wù)器(富媒體服務(wù)器)登錄Token,最大長度127字節(jié)。 |
Y |
Y |
terminalLoginInfoList |
List<TsdkImTerminalLoginInfo> |
同時登錄的終端信息列表(暫不支持,預(yù)留)。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
callId |
long |
呼叫ID。 |
Y |
Y |
isCaller |
int |
是否為主叫。 |
Y |
Y |
isVideoCall |
int |
是否為視頻呼叫。 |
Y |
Y |
peerNumber |
String |
對端號碼。最長127字節(jié)。 |
Y |
Y |
peerDisplayName |
String |
對端名稱。最長255字節(jié)。 |
Y |
Y |
callState |
呼叫狀態(tài)。 |
Y |
Y |
|
isAutoAnswer |
int |
是否為自動應(yīng)答。 |
Y |
Y |
isFocus |
int |
是否帶isfoucs標識。 |
Y |
Y |
confId |
String |
會議id,最長15字節(jié)。 |
Y |
Y |
reasonCode |
int |
原因碼。 |
Y |
Y |
reasonDescription |
String |
原因描述。最長1023字節(jié)。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
viewType |
view刷新媒體類型。 |
Y |
Y |
|
event |
view刷新事件。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
coordinateX |
int |
X 軸 |
Y |
Y |
coordinateY |
int |
Y 軸 |
Y |
Y |
coordinateW |
int |
寬 |
Y |
Y |
coordinateH |
int |
高 |
Y |
Y |
coordinateZ |
int |
Z 軸 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
videoWndType |
視頻窗口類型。 |
Y |
Y |
|
coordinate |
坐標信息。 |
Y |
Y |
|
render |
long |
窗口句柄。 |
Y |
Y |
index |
int |
窗口序號。 |
Y |
Y |
sessionId |
long |
本地預(yù)覽session值。 |
Y |
Y |
refCount |
long |
使用引用計數(shù)。 |
Y |
Y |
displayMode |
顯示模式。 |
Y |
Y |
|
startImageFilePath |
String |
視頻顯示初始圖像,必須為jpeg圖像,且長寬都是8的倍數(shù),最大長度2047字節(jié)。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
operation |
long |
操作動作。取值:TsdkVideoCtrlOperationAct,可以使用邏輯運算符"|"連接,open|start,close|stop。 |
Y |
Y |
object |
long |
視頻控制對象。取值: TsdkVideoCtrlObj,可以使用邏輯運算符"|"連接。 |
Y |
Y |
isSync |
int |
是否使用同步執(zhí)行。ios8.3使用異步,否則在切后臺時調(diào)用該接口會被系統(tǒng)迅速掛起導(dǎo)致崩潰卡死。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
index |
long |
設(shè)備索引。 |
Y |
Y |
deviceName |
String |
設(shè)備名稱。最大長度255字節(jié)。 |
Y |
Y |
cameraOrient |
long |
攝像頭角度。僅移動平臺攝像頭設(shè)備有值。 |
Y |
Y |
deviceId |
long |
設(shè)備ID。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
renderType |
窗口類型枚舉值。 |
Y |
Y |
|
displayType |
窗口顯示模式。0:拉伸模式 1:(不拉伸)黑邊模式 2:(不拉伸)裁剪模式 3:(需保證窗口尺寸 >= 圖像尺寸)按原始分辨率顯示。 |
Y |
Y |
|
mirrorType |
窗口鏡像模式。0:不做鏡像(默認值) 1:垂直鏡像(X軸鏡像)(目前未支持) 2:水平鏡像(Y軸鏡像)。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
choice |
long |
視頻橫豎屏情況 1:豎屏;2:橫屏;3:反向橫屏。 |
Y |
Y |
portrait |
long |
豎屏視頻捕獲(逆時針旋轉(zhuǎn))角度 0:0度;1:90度;2:180度;3:270度。 |
Y |
Y |
landscape |
long |
橫屏視頻捕獲(逆時針旋轉(zhuǎn))角度 0:0度;1:90度;2:180度;3:270度。 |
Y |
Y |
seascape |
long |
反向橫屏視頻捕獲(逆時針旋轉(zhuǎn))角度 0:0度;1:90度;2:180度;3:270度。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
callId |
long |
呼叫ID。 |
Y |
Y |
isFouces |
int |
是否帶isfoucs標識,移動會議場景使用。 |
Y |
Y |
orientType |
移動視頻橫豎屏情況。 |
Y |
Y |
|
localAddr |
String |
本地地址。 |
Y |
Y |
remoteAddr |
String |
移動上報遠端地址。 |
Y |
Y |
reinviteType |
主被叫控業(yè)務(wù)中Reinvite消息指示的事件類型。 |
Y |
Y |
|
audioSendMode |
音頻媒體方向。 |
Y |
Y |
|
videoSendMode |
視頻媒體方向。 |
Y |
Y |
|
dataSendMode |
輔流媒體方向。 |
Y |
Y |
|
isLowBwSwitchToAudio |
int |
是否是由低帶寬造成的視頻切換到音頻。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
callId |
long |
呼叫ID。 |
Y |
Y |
mediaType |
媒體類型1 : 音頻。 2 : 視頻。 3 : 輔流 |
Y |
Y |
|
codecType |
long |
編解碼器類型 1 : 編碼器。2 : 解碼器。 |
Y |
Y |
codecName |
String |
編解碼名稱,最大長度255字節(jié)。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
label |
long |
SVC Label。 |
Y |
Y |
render |
long |
窗口句柄。 |
Y |
Y |
width |
long |
分辨率:寬。 |
Y |
Y |
height |
long |
分辨率:高。 |
Y |
Y |
isSharpness |
int |
是否使用銳化模式。 |
Y |
Y |
isSync |
int |
是否使用同步執(zhí)行,默認為0。 |
Y |
Y |
maxBandwidth |
long |
多流接收方向每一路流的最大帶寬。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
isSrtp |
int |
是否啟用SRTP, 取值: 0 RTP, 1 SRTP。 |
Y |
Y |
encodeProtocol |
String |
編碼協(xié)議描述。 |
Y |
Y |
sendBitRate |
long |
發(fā)送比特率(kbps)。 |
Y |
Y |
sendLossFraction |
float |
發(fā)送方丟包率(%)。 |
Y |
Y |
sendDelay |
float |
發(fā)送方平均時延(ms)。 |
Y |
Y |
sendJitter |
float |
發(fā)送方平均抖動(ms)。 |
Y |
Y |
decodeProtocol |
String |
解碼協(xié)議名。 |
Y |
Y |
recvBitRate |
long |
接收比特率(kbps)。 |
Y |
Y |
recvLossFraction |
float |
接收方丟包率(%)。 |
Y |
Y |
recvDelay |
float |
接收方平均時延(ms)。 |
Y |
Y |
recvJitter |
float |
接收方平均抖動(ms)。 |
Y |
Y |
recvAverageMos |
float |
接收方向MOS分平均值,用浮點數(shù)表示:取值范圍[0, 5], 0表示該參數(shù)無效。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
isSrtp |
int |
是否啟用SRTP, 取值: 0 RTP, 1 SRTP。 |
Y |
Y |
bandwidth |
long |
有效帶寬 |
Y |
Y |
encodeProtocol |
String |
編碼協(xié)議描述。 |
Y |
Y |
sendBitRate |
long |
發(fā)送比特率(kbps)。 |
Y |
Y |
sendFrameSize |
String |
發(fā)送(編碼)圖像分辨率描述 |
Y |
Y |
sendFrameRate |
long |
發(fā)送(編碼)視頻幀率 |
Y |
Y |
sendLossFraction |
float |
發(fā)送方丟包率(%)。 |
Y |
Y |
sendDelay |
float |
發(fā)送方平均時延(ms)。 |
Y |
Y |
sendJitter |
float |
發(fā)送方平均抖動(ms)。 |
Y |
Y |
decodeProtocol |
String |
解碼協(xié)議名。 |
Y |
Y |
recvBitRate |
long |
接收比特率(kbps)。 |
Y |
Y |
recvFrameSize |
String |
接收(解碼)圖像分辨率描述 |
Y |
Y |
recvFrameRate |
long |
接收(解碼)視頻幀率 |
Y |
Y |
recvLossFraction |
float |
接收方丟包率(%)。 |
Y |
Y |
recvDelay |
float |
接收方平均時延(ms)。 |
Y |
Y |
recvJitter |
float |
接收方平均抖動(ms)。 |
Y |
Y |
recvSsrcLabel |
long |
接收方對應(yīng)的ssrc label, 多流時有效。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
effectiveBitrate |
long |
有效帶寬(組件探測出的下行方向總tmmbr)。 |
Y |
Y |
audioStreamInfo |
TsdkAudioStreamInfo |
音頻流信息。 |
Y |
Y |
videoStreamInfo |
TsdkVideoStreamInfo |
單流視頻流信息。 |
Y |
Y |
isSvcConf |
int |
是否多流視頻會議。 |
Y |
Y |
svcStreamCount |
int |
多流視頻流信息數(shù)。 |
Y |
Y |
svcStreamInfo |
List<TsdkVideoStreamInfo> |
多流視頻流信息。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
number |
String |
號碼,最大長度127字節(jié)。 |
Y |
Y |
displayName |
String |
可選,與會者顯示名稱,最大長度127字節(jié)。 |
Y |
Y |
accountId |
String |
可選,用戶帳號,預(yù)約會議時若不填寫,則該用戶無法查詢到,最大長度127字節(jié)。 |
Y |
Y |
|
String |
可選,電子郵箱地址,最大長度95字節(jié)。 |
Y |
Y |
sms |
String |
可選,短信通知手機號碼,最大長度127字節(jié)。 |
Y |
Y |
role |
會議成員角色。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
size |
long |
會議方數(shù)。 |
Y |
Y |
subject |
String |
會議主題,最大長度385字節(jié)。 |
Y |
Y |
groupUri |
String |
可選,群組Uri,最大長度127字節(jié)。 |
Y |
Y |
startTime |
String |
可選,會議開始時間,格式:YYYY-MM-DD HH:MM,立即會議時無需填寫,最大長度31字節(jié)。 |
Y |
Y |
duration |
long |
可選,會議持續(xù)時長,單位: 分鐘,默認60分鐘。 |
Y |
Y |
confType |
會議類型。 |
Y |
Y |
|
confMediaType |
媒體類型。 |
Y |
Y |
|
isHdConf |
int |
可選,是否高清視頻會議。 |
Y |
Y |
isMultiStreamConf |
int |
可選,是否為多流視頻會議,預(yù)留。 |
Y |
Y |
isAutoRecord |
int |
可選,會議是否自動啟動錄制,預(yù)留。 |
Y |
Y |
isAutoProlong |
int |
可選,是否自動延長會議。 |
Y |
Y |
isAutoMute |
int |
可選,非主席在入會后是否自動閉音。 |
Y |
Y |
welcomePrompt |
可選,入會提示音類型。 |
Y |
Y |
|
enterPrompt |
可選,有成員入會提示音類型。 |
Y |
Y |
|
leavePrompt |
可選,有成員離會提示音類型。 |
Y |
Y |
|
reminder |
可選,會議提醒方式。 |
Y |
Y |
|
language |
可選,會議的默認語言。 |
Y |
Y |
|
confEncryptMode |
可選,會議媒體加密模式。 |
Y |
Y |
|
attendeeNum |
long |
與會者數(shù)量。 |
Y |
Y |
attendeeList |
List<TsdkAttendeeBaseInfo> |
與會者列表。 |
Y |
Y |
recordMode |
錄制模式。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
confMediaType |
媒體類型。 |
Y |
Y |
|
isHdConf |
int |
是否高清視頻會議。 |
Y |
Y |
number |
String |
來電號碼,最大長度127字節(jié)。 |
Y |
Y |
subject |
String |
會議主題,最大長度385字節(jié)。 |
Y |
Y |
groupUri |
String |
群組uri,最大長度127字節(jié)。 |
Y |
Y |
confId |
String |
會議id,最大長度15字節(jié)。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
size |
long |
會議方數(shù)。 |
Y |
Y |
confId |
String |
會議ID,最大長度15字節(jié)。 |
Y |
Y |
subject |
String |
會議主題,最大長度385字節(jié)。 |
Y |
Y |
accessNumber |
String |
會議接入碼,最大長度63字節(jié)。 |
Y |
Y |
chairmanPwd |
String |
主席密碼,在EC會議下,查詢會議列表時不能獲取,需要通過查詢會議詳情獲取,最大長度191字節(jié)。 |
Y |
Y |
guestPwd |
String |
來賓密碼,在EC會議下,查詢會議列表時不能獲取,需要通過查詢會議詳情獲取,最大長度191字節(jié)。 |
Y |
Y |
startTime |
String |
會議開始時間,最大長度31字節(jié)。 |
Y |
Y |
endTime |
String |
會議結(jié)束時間,最大長度31字節(jié)。 |
Y |
Y |
confMediaType |
媒體類型。 |
Y |
Y |
|
isHdConf |
int |
是否高清視頻會議。 |
Y |
Y |
confState |
會議狀態(tài)。 |
Y |
Y |
|
scheduserAccount |
String |
預(yù)訂者帳號,最大長度127字節(jié)。 |
Y |
Y |
scheduserName |
String |
預(yù)訂者姓名,最大長度255字節(jié)。 |
Y |
Y |
token |
String |
會控token僅入駐式融合會議有效,最大長度127字節(jié)。 |
Y |
Y |
chairJoinUri |
String |
主持人加入會議uri鏈接,最大長度255字節(jié)。 |
Y |
Y |
guestJoinUri |
String |
來賓加入會議uri鏈接,最大長度255字節(jié)。 |
Y |
Y |
recordMode |
會議媒體錄制模式。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
participantId |
String |
與會者唯一標識,最大長度127字節(jié)。 |
Y |
Y |
dataUserId |
long |
與會者在數(shù)據(jù)會議中的用戶ID。 |
Y |
Y |
state |
用戶狀態(tài)。 |
Y |
Y |
|
isSelf |
int |
是否自己。 |
Y |
Y |
isMute |
int |
是否閉音。 |
Y |
Y |
isHandup |
int |
是否舉手。 |
Y |
Y |
isBroadcast |
int |
是否被廣播。 |
Y |
Y |
isVideo |
int |
是否視頻方式加入會議 |
Y |
Y |
isJoinDataconf |
int |
是否已加入數(shù)據(jù)會議。 |
Y |
Y |
isPresent |
int |
是否主講人。 |
Y |
Y |
hasCamera |
int |
是否有攝像頭。 |
Y |
Y |
isOnlyInDataConf |
int |
是否僅在數(shù)據(jù)會議中(通過獨立的數(shù)據(jù)會議客戶端加入會議)。 |
Y |
Y |
isAnonymous |
int |
是否匿名用戶(匿名方式加入會議)。 |
Y |
Y |
isBeWatching |
int |
是否被本地觀看狀態(tài),SVC會議下有效 。 |
Y |
Y |
isShareOwner |
int |
是否共享的擁有者。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
baseInfo |
與會者基礎(chǔ)信息。 |
Y |
Y |
|
statusInfo |
與會者狀態(tài)信息。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
attendeeList |
List<TsdkAttendeeBaseInfo> |
與會者列表。 |
Y |
Y |
attendeeNum |
long |
與會者個數(shù)。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
number |
String |
號碼,最大長度127字節(jié)。 |
Y |
Y |
label |
long |
SVC Label,SVC 會議功能時有效。 |
Y |
Y |
width |
long |
分辨率:寬,SVC 會議功能時有效。 |
Y |
Y |
height |
long |
分辨率:高,SVC 會議功能時有效。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
watchAttendeeList |
List<TsdkWatchAttendees> |
被選看的與會者信息列表。 |
Y |
Y |
watchAttendeeNum |
long |
被選看的與會者個數(shù)。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
groupUri |
String |
可選,群組ID,最大長度127字節(jié)。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
operationType |
會控操作類型。 |
Y |
Y |
|
reasonCode |
int |
操作失敗原因碼。 |
Y |
Y |
description |
String |
操作失敗原因描述,最大長度1023字節(jié)。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
confRight |
會議權(quán)限。 |
Y |
Y |
|
isIncludeEnd |
int |
是否包含已結(jié)束的會議。 |
Y |
Y |
pageIndex |
long |
指定返回的會議列表頁頁面索引, 索引取值從1開始。 |
Y |
Y |
pageSize |
long |
指定每頁返回的會議記錄數(shù),每頁最多返回400個。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
totalCount |
long |
會議總個數(shù)。 |
Y |
Y |
currentCount |
long |
當前返回會議個數(shù)。 |
Y |
Y |
confInfoList |
List<TsdkConfBaseInfo> |
當前返回會議列表。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
pageIndex |
long |
指定返回的與會者列表頁的頁面索引, 索引取值從1開始。 |
Y |
Y |
confId |
String |
會議id,最大長度15字節(jié)。 |
Y |
Y |
pageSize |
long |
指定每頁返回與會者的記錄數(shù),每頁最多返回400個。 |
Y |
Y |
subConfId |
String |
周期會議子會議ID(預(yù)留,暫不支持),最大長度15字節(jié)。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
confInfo |
會議信息。 |
Y |
Y |
|
attendeeNum |
long |
與會者數(shù)量。 |
Y |
Y |
attendeeList |
List<TsdkAttendeeBaseInfo> |
與會者列表。 |
Y |
Y |
變量 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
callId |
long |
呼叫ID,軟終端號碼入會時有效。 |
Y |
Y |
confEnvType |
會議組網(wǎng)類型。 |
Y |
Y |
|
confMediaType |
媒體類型。 |
Y |
Y |
|
isHdConf |
int |
是否高清視頻會議。 |
Y |
Y |
isSvcConf |
int |
是否多流會議。 |
Y |
Y |
svcLabelCount |
int |
多流Label有效個數(shù)。 |
Y |
Y |
svcLabel |
List<Long> |
多流Label對應(yīng)的ssrc數(shù)組。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
size |
long |
會議方數(shù)。 |
Y |
Y |
confId |
String |
會議ID,最大長度15字節(jié)。 |
Y |
Y |
subject |
String |
會議主題,最大長度385字節(jié)。 |
Y |
Y |
groupUri |
String |
群組Uri,最大長度127字節(jié)。 |
Y |
Y |
confMediaType |
媒體類型。 |
Y |
Y |
|
isHdConf |
int |
是否高清視頻會議。 |
Y |
Y |
confState |
會議狀態(tài)。 |
Y |
Y |
|
scheduserAccount |
String |
預(yù)訂者帳號,最大長度127字節(jié)。 |
Y |
Y |
scheduserName |
String |
預(yù)訂者姓名,最大長度255字節(jié)。 |
Y |
Y |
isRecord |
int |
會場是否為錄音狀態(tài)。 |
Y |
Y |
isLock |
int |
會場是否為鎖定狀態(tài)。 |
Y |
Y |
isAllMute |
int |
會場是否為靜音狀態(tài)。 |
Y |
Y |
updateType |
成員更新方式。 |
Y |
Y |
|
attendeeNum |
long |
與會者數(shù)量。 |
Y |
Y |
attendeeList |
List<TsdkAttendee> |
與會者列表。 |
Y |
Y |
isLiveBroadcast |
int |
會場是否直播狀態(tài)。 |
Y |
Y |
isSupportLiveBroadcast |
int |
會場是否支持直播。 |
Y |
Y |
isSupportRecordBroadcast |
int |
會場是否支持錄播。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
confPassword |
String |
會議密碼,最大長度15字節(jié)。 |
Y |
Y |
confId |
String |
會議ID,最大長度63字節(jié)。 |
Y |
Y |
accessNumber |
String |
會議接入碼,最大長度191字節(jié)。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
baseInfo |
與會者基礎(chǔ)信息。 |
Y |
Y |
|
statusInfo |
與會者狀態(tài)信息。 |
Y |
Y |
|
isSpeaking |
int |
是否發(fā)言。 |
Y |
Y |
speakingVolume |
long |
音量。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
speakerNum |
long |
發(fā)言方個數(shù)。 |
Y |
Y |
speakers |
List<TsdkConfSpeaker> |
發(fā)言方。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
confId |
String |
會議ID,最大長度15字節(jié)。 |
Y |
Y |
hostKey |
String |
主持人密碼:主持人入會必須設(shè)置,其他情況不需要,最大長度63字節(jié)。 |
Y |
Y |
cryptKey |
String |
會議鑒權(quán)密碼,最大長度63字節(jié)。 |
Y |
Y |
cmAddress |
String |
SIP網(wǎng)關(guān)地址及端口,最大長度255字節(jié)。 |
Y |
Y |
siteUrl |
String |
會議站點地址,最大長度255字節(jié) |
Y |
Y |
siteId |
String |
站點ID,最大長度255字節(jié)。 |
Y |
Y |
serverIp |
String |
會議服務(wù)器地址,單個地址或URL,最大長度255字節(jié)。 |
Y |
Y |
userId |
String |
用戶ID,最大長度127字節(jié)。 |
Y |
Y |
userName |
String |
用戶名,最大長度255字節(jié)。 |
Y |
Y |
userUri |
String |
用戶Uri,最大長度255字節(jié)。 |
Y |
Y |
confName |
String |
會議名稱,最大長度385字節(jié)。 |
Y |
Y |
accessCode |
String |
會議接入碼,最大長度63字節(jié)。 |
Y |
Y |
partSecureConfNum |
String |
與會者安全會議號,最大長度127字節(jié)。 |
Y |
Y |
stgServerAddress |
String |
STG服務(wù)器地址,最大長度255字節(jié)。 |
Y |
Y |
sbcServerAddress |
String |
SBC服務(wù)器地址,最大長度255字節(jié) |
Y |
Y |
userRole |
long |
會議成員角色。 |
Y |
Y |
mcuNumber |
long |
MCU號。 |
Y |
Y |
terminalNumber |
long |
Terminal號。 |
Y |
Y |
pinCode |
String |
PIN CODE碼,最大長度127字節(jié)。 |
Y |
Y |
participantId |
String |
與會者ID,最大長度127字節(jié)。 |
Y |
Y |
shortUserName |
String |
用戶名稱(取user_name的前63個字節(jié)),最大長度63字節(jié)。 |
Y |
Y |
shortConfName |
String |
會議名稱(取conf_name的前63個字節(jié)),最大長度63字節(jié)。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
subState |
int |
共享狀態(tài)。 |
Y |
Y |
state |
int |
共享子狀態(tài)。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
sender |
發(fā)送者詳細信息(接收消息攜帶,發(fā)送消息時無需填寫)。 |
Y |
Y |
|
chatType |
int |
消息類型,當前僅支持TSDK_E_CONF_CHAT_PUBLIC。 |
Y |
Y |
chatMsgLen |
long |
消息內(nèi)容長度。 |
Y |
Y |
senderDisplayName |
String |
發(fā)送者的名稱,最大長度255字節(jié)。 |
Y |
Y |
reviciverNumber |
String |
消息接收者號碼,當前僅支持發(fā)送公共消息,無需填寫,預(yù)留,最大長度127字節(jié)。 |
Y |
Y |
time |
long |
消息發(fā)送時服務(wù)器時間(接收消息攜帶,發(fā)送消息時無需填寫)。 |
Y |
Y |
senderNumber |
String |
發(fā)送者的號碼(接收消息攜帶,發(fā)送消息時無需填寫),最大長度127字節(jié)。 |
Y |
Y |
chatMsg |
String |
消息內(nèi)容。 |
Y |
Y |
參數(shù)名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
confPassword |
String |
會議密碼,最大長度191字節(jié)。 |
Y |
Y |
displayName |
String |
可選,與會者顯示名稱,最大長度255字節(jié)。 |
Y |
Y |
confId |
String |
會議ID,最大長度15字節(jié)。 |
Y |
Y |
serverPort |
int |
服務(wù)器端口號。 |
Y |
Y |
userId |
long |
用戶ID,需要APP生成 。 |
Y |
Y |
serverAddr |
String |
會議服務(wù)器地址,最大長度255字節(jié)。 |
Y |
Y |
參數(shù)名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
pageCount |
long |
文檔頁數(shù)。 |
Y |
Y |
documentName |
String |
文檔名,最大長度2047字節(jié)。 |
Y |
Y |
documentId |
long |
文檔ID。 |
Y |
Y |
參數(shù)名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
docBaseInfo |
文檔基礎(chǔ)信息。 |
Y |
Y |
|
docDelNumber |
String |
刪除文檔的與會者的號碼,最大長度127字節(jié)。 |
Y |
Y |
docDelAttendee |
刪除文檔的與會者的詳細信息。 |
Y |
Y |
|
docDelDisplayName |
String |
刪除文檔的與會者的名稱,最大長度255字節(jié)。 |
Y |
Y |
參數(shù)名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
wbDelDisplayName |
String |
刪除白板的與會者的名稱,最大長度255字節(jié)。 |
Y |
Y |
wbBaseInfo |
文檔基礎(chǔ)信息。 |
Y |
Y |
|
wbDelAttendee |
刪除白板的與會者的詳細信息。 |
Y |
Y |
|
wbDelNumber |
String |
刪除白板的與會者的號碼,最大長度127字節(jié)。 |
Y |
Y |
參數(shù)名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
width |
int |
虛擬顯示器的寬度。 |
Y |
Y |
bitCount |
int |
虛擬顯示器圖像每個像素的位數(shù)。 |
Y |
Y |
height |
int |
虛擬顯示器的高度。 |
Y |
Y |
參數(shù)名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
cbCrData |
int |
圖片色度(Chrominance)信息。 |
Y |
Y |
orientation |
圖片方向。 |
Y |
Y |
|
height |
int |
圖片高度(單位:ppi)。 |
Y |
Y |
width |
int |
圖片寬度(單位:ppi)。 |
Y |
Y |
cbCrDataSize |
int |
圖片色度(Chrominance)信息長度 |
Y |
Y |
yData |
int |
圖片明亮度(Luminance)信息 |
Y |
Y |
yDataSize |
int |
圖片明亮度(Luminance)信息長度 |
Y |
Y |
參數(shù)名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
label |
int |
SVC Label,SVC 會議功能時有效。 |
Y |
Y |
baseInfo |
與會者基礎(chǔ)信息。 |
Y |
Y |
|
statusInfo |
與會者狀態(tài)信息。 |
Y |
Y |
參數(shù)名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
watchAttendeeNum |
long |
觀看的與會者畫面信息個數(shù)。 |
Y |
Y |
watchAttendees |
List<TsdkConfSvcWatchAttendee> |
觀看的與會者畫面信息列表。 |
Y |
Y |
參數(shù)名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
status |
long |
狀態(tài),不涉及:0,發(fā)送數(shù)據(jù):1,接收數(shù)據(jù):2 。 |
Y |
Y |
sendFrameSizeWidth |
long |
發(fā)送(編碼)視頻分辨率-寬。 |
Y |
Y |
sendFrameSizeHeight |
long |
發(fā)送(編碼)視頻分辨率-高。 |
Y |
Y |
sendBitRate |
long |
發(fā)送(編碼)碼率(bps)。 |
Y |
Y |
sendFrameRate |
long |
發(fā)送(編碼)視頻幀率 |
Y |
Y |
encodeVersion |
long |
編碼協(xié)議版本 |
Y |
Y |
sendPktLoss |
float |
發(fā)送方丟包率(0.xx%);-1表示未啟用該參數(shù) |
Y |
Y |
sendRtt |
long |
發(fā)送方環(huán)路時延(ms);0表示未啟用該參數(shù);不支持獲取平均值、最大值和最小值。 |
Y |
Y |
sendJitter |
long |
發(fā)送方抖動(ms);0表示未啟用該參數(shù);不支持獲取平均值、最大值和最小值 |
Y |
Y |
recvFrameSizeWidth |
long |
接收(解碼)視頻分辨率-寬 |
Y |
Y |
recvFrameSizeHeight |
long |
接收(解碼)視頻分辨率-高 |
Y |
Y |
recvBitRate |
long |
接收(解碼)碼率(bps) |
Y |
Y |
recvFrameRate |
long |
接收(解碼)視頻幀率 |
Y |
Y |
decodeVersion |
long |
解碼協(xié)議版本 |
Y |
Y |
recvPktLoss |
float |
接收方丟包率(0.xx%);-1表示未啟用該參數(shù) |
Y |
Y |
recvRtt |
long |
接收方環(huán)路時延(ms);0表示未啟用該參數(shù);不支持獲取平均值、最大值和最小值 |
Y |
Y |
recvJitter |
long |
接收方抖動(ms);0表示未啟用該參數(shù);不支持獲取平均值、最大值和最小值 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
smallIconPath |
String |
小頭像路徑+文件名,最大長度2047字節(jié)。 |
Y |
Y |
mediumIconPath |
String |
中頭像路徑+文件名,最大長度2047字節(jié)。 |
Y |
Y |
largeIconPath |
String |
大頭像路徑+文件名,最大長度2047字節(jié)。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
searchKeyword |
String |
搜索關(guān)鍵字,最大長度127字節(jié)。 |
Y |
Y |
pageIndex |
long |
當前需要查找的頁數(shù). |
Y |
Y |
isExactSearch |
int |
是否精確查找,取值:0:模糊;1:精確;精確查詢,若匹配到多條,則返回對應(yīng)的第一個值。 |
Y |
Y |
departmentId |
String |
可選,部門ID,若填寫則在指定部門下查找,最大長度15字節(jié)。 |
Y |
Y |
seqNo |
long |
查詢序號。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
account |
String |
UC帳號,最大長度127字節(jié)。 |
Y |
Y |
seqNo |
long |
搜索序號。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
iconId |
long |
系統(tǒng)頭像ID。 |
Y |
Y |
iconPath |
String |
自定義頭像文件路徑,最大長度2047字節(jié)。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
staffAccount |
String |
UC帳號,最大長度127字節(jié)。 |
Y |
Y |
personName |
String |
姓名,最大長度255字節(jié)。 |
Y |
Y |
staffNo |
String |
工號,最大長度127字節(jié)。 |
Y |
Y |
terminal |
String |
IP號碼,軟終端號碼,最大長度127字節(jié)。 |
Y |
Y |
terminal2 |
String |
軟終端公網(wǎng)長號,最大長度127字節(jié)。 |
Y |
Y |
departmentName |
String |
部門名字,最大長度511字節(jié)。 |
Y |
Y |
title |
String |
職務(wù),最大長度127字節(jié)。 |
Y |
Y |
mobile |
String |
手機號碼,最大長度127字節(jié)。 |
Y |
Y |
homePhone |
String |
家庭電話,最大長度127字節(jié)。 |
Y |
Y |
|
String |
郵箱,最大長度95字節(jié)。 |
Y |
Y |
officePhone |
String |
座機號碼 辦公電話,最大長度127字節(jié)。 |
Y |
Y |
officePhone2 |
String |
硬終端2,最大長度127字節(jié)。 |
Y |
Y |
officePhone3 |
String |
硬終端3,最大長度127字節(jié)。 |
Y |
Y |
officePhone4 |
String |
硬終端4,最大長度127字節(jié)。 |
Y |
Y |
officePhone5 |
String |
硬終端5,最大長度127字節(jié)。 |
Y |
Y |
officePhone6 |
String |
硬終端6,最大長度127字節(jié)。 |
Y |
Y |
otherPhone |
String |
其他電話,最大長度127字節(jié)。 |
Y |
Y |
otherPhone2 |
String |
其他電話2,最大長度127字節(jié)。 |
Y |
Y |
gender |
String |
性別,最大長度7字節(jié)。 |
Y |
Y |
zipCode |
String |
郵編,最大長度31字節(jié)。 |
Y |
Y |
address |
String |
地址,最大長度255字節(jié)。 |
Y |
Y |
signature |
String |
簽名,最大長度255字節(jié)。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
page |
long |
當前頁碼。 |
Y |
Y |
totalNum |
long |
聯(lián)系人總數(shù)。 |
Y |
Y |
currentNum |
long |
當前查詢結(jié)果數(shù)。 |
Y |
Y |
contactInfo |
List<TsdkContactsInfo> |
聯(lián)系人信息。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
departmentId |
String |
部門ID,最大長度15字節(jié)。 |
Y |
Y |
parentId |
String |
父節(jié)點ID,最大長度15字節(jié)。 |
Y |
Y |
departmentName |
String |
部門名稱,最大長度511字節(jié)。 |
Y |
Y |
變量名 |
類型 |
描述 |
Getter |
Setter |
---|---|---|---|---|
departmentId |
String |
查詢的部門ID,最大長度15字節(jié)。 |
Y |
Y |
itemNum |
long |
查詢到的下一級部門條目總數(shù)。 |
Y |
Y |
departmentInfo |
List<TsdkDepartmentInfo> |
查詢的部門信息。 |
Y |
Y |