智慧服务,成就美好体验 项目咨询

主页 > 服务与支持 > 开发平台 > 客户端SDK参考 > Android Native SDK > 附录 数据结构

入门使用

数据结构

更新时间:2019-12-10

表1 数据结构索引

业务类别

数据结构

组件初始化与配置

TsdkAppInfoParam(应用程序信息参数)

TsdkLogParam(日志参数)

TsdkTlsParam(TLS参数)

TsdkProxyParam(代理信息)

TsdkServiceSecurityParam(业务安全配置参数)

TsdkLocalAddress(本地ip地址)

TsdkAppFilePathInfo(应用程序文件路径信息)

TsdkDeviceDpiInfo(设备DPI信息)

TsdkCommonResult(操作结果)

TsdkNetworkInfoParam(网络信息参数)

TsdkConfCtrlParam(会议控制参数)

TsdkAvcCapsLevelInfo(AVC视频能力级别信息)

TsdkDisplayLocalInfo(会议中显示的本端信息)

登录和注销

TsdkLoginParam(登录信息参数)

TsdkImLoginParam(IM帐号登录参数)

TsdkVoipAccountInfo(VoIP帐号信息)

TsdkLoginSuccessInfo(登录成功信息)

TsdkSecurityTunnelInfo(安全隧道信息)

TsdkServerAddrInfoList(服务器地址信息列表)

TsdkServerAddrInfo(服务器地址信息)

TsdkLoginFailedInfo(登录失败信息)

TsdkImTerminalLoginInfo(IM终端登录信息)

TsdkImAccountInfo(IM帐号信息(登录成功时返回))

TsdkForceLogoutInfo(帐号被强制登出信息)

TsdkModifyPasswordParam(修改密码参数)

音视频呼叫

TsdkCallInfo(呼叫信息)

TsdkVideoViewRefresh(视频视图刷新信息)

TsdkCoordinateInfo(坐标信息)

TsdkVideoWndInfo(视频窗口信息)

TsdkVideoCtrlInfo(视频控制信息)

TsdkDeviceInfo(设备信息)

TsdkVideoOrient(视频横竖屏状态)

TsdkVideoRenderInfo(视频显示窗口属性)

TsdkSessionModified(会话修改完成结果信息)

TsdkSessionCodec(会话正在使用的编解码器信息)

TsdkSvcVideoWndInfo(SVC视频窗口信息)

TsdkAudioStreamInfo(音频流信息)

TsdkVideoStreamInfo(视频流信息)

TsdkCallStatisticInfo(呼叫信息统计)

会议

TsdkAttendeeBaseInfo(与会者基础信息类)

TsdkBookConfInfo(预约会议信息类)

TsdkConfIncomingInfo(会议来电信息类)

TsdkConfBaseInfo(会议基础信息类)

TsdkAttendeeStatusInfo(与会者状态信息类)

TsdkAttendee(与会者信息类)

TsdkAddAttendeesInfo(添加与会者信息)

TsdkWatchAttendees(选看与会者信息类)

TsdkWatchAttendeesInfo(选看与会者画面参数信息)

TsdkConfUpgradeParam(会议升级描述参数类)

TsdkConfOperationResult(会议控制操作结果类)

TsdkQueryConfListReq(查询会议列表类)

TsdkConfListInfo(会议列表信息类)

TsdkQueryConfDetailReq(会议详细信息类)

TsdkConfDetailInfo(会议详情类)

TsdkJoinConfIndInfo(加入会议通知信息类)

TsdkConfStatusInfo(会议状态信息类)

TsdkConfJoinParam(入会参数类)

TsdkConfSpeaker(会议发言方信息类)

TsdkConfSpeakerInfo(发言方通知信息类)

TsdkConfDataconfParams(数据会议入会参数类)

TsdkConfAsStateInfo(共享状态信息类)

TsdkConfChatMsgInfo(会议聊天信息类)

TsdkConfAnonymousJoinParam(匿名入会参数)

TsdkDocBaseInfo(文档基础信息类)

TsdkDocShareDelDocInfo(文档删除信息类)

TsdkWbDelDocInfo(白板删除信息类)

TsdkConfAsVirtualViewInfo(虚拟显示器信息)

TsdkConfAsViewDataInfo(共享的图片数据信息)

TsdkConfSvcWatchAttendee(正在观看的与会者画面信息)

TsdkConfSvcWatchInfo(SVC(多流)会议下正在观看画面信息)

TsdkShareStatisticInfo(共享统计信息)

TsdkResumeConfIndInfo(会议恢复信息)

通讯录

TsdkIconInfo(自定义头像参数)

TsdkSearchContactsParam(联系人搜索参数)

TsdkGetIconParam(头像获取参数)

TsdkGetIconResult(头像查询结果)

TsdkContactsInfo(联系人详细信息)

TsdkSearchContactsResult(联系人搜索结果)

TsdkDepartmentInfo(部门信息类)

TsdkSearchDepartmentResult(搜索部门的返回结果类)

组件初始化与配置

表2 TsdkAppInfoParam(应用程序信息参数)

变量名

类型

描述

Getter

Setter

clientType

TsdkClientType

终端类型。

Y

Y

productName

String

产品名信息,最大长度255字节。

Y

Y

deviceSn

String

设备SN号,可选参数,最大长度127字节。

Y

Y

supportAudioAndVideoCall

int

是否支持音视频呼叫。

Y

Y

supportAudioAndVideoConf

int

是否支持音视频会议。

Y

Y

supportDataConf

int

是否支持数据会议。

Y

Y

supportCtd

int

是否支持点击呼叫。

Y

Y

supportIm

int

是否支持即时消息。

Y

Y

supportRichMediaMessage

int

是否支持富媒体消息。

Y

Y

supportEnterpriseAddressBook

int

是否支持企业通讯录。

Y

Y

supportSvcConfCaps

int

是否支持SVC多流会议。

Y

Y

表3 TsdkLogParam(日志参数)

变量名

类型

描述

Getter

Setter

level

TsdkLogLevel

日志级别。

Y

Y

maxZizeKb

int

每个日志文件的最大值。单位: KB,最大10*1024 KB。

Y

Y

fileCount

int

日志文件个数,最大值为所能取到的最大值,建议为4

Y

Y

path

String

日志存放路径,最大255字节。

Y

Y

表4 TsdkTlsParam(TLS参数)

变量名

类型

描述

Getter

Setter

caCertPath

String

CA根证书存储路径,最大长度511字节。

Y

Y

clientCertPath

String

客户端证书存储路径,最大长度511字节。

Y

Y

clientKeyPath

String

客户端私钥存储路径,最大长度511字节。

Y

Y

clientPrivkeyPwd

String

客户端私钥密码,最大长度127字节。

Y

Y

verifyMode

TsdkVerifyMode

认证模式。

Y

Y

verifyServerMode

TsdkVerifyServerMode

校验服务器模式。

Y

Y

表5 TsdkProxyParam(代理信息)

变量名

类型

描述

Getter

Setter

userName

String

帐户用户名。最大长度127字节。

Y

Y

password

String

帐户密码。最大长度127字节。

Y

Y

proxyUri

String

服务器地址。最大长度255字节。

Y

Y

proxyPort

int

代理服务器端口号。

Y

Y

表6 TsdkServiceSecurityParam(业务安全配置参数)

变量名

类型

描述

Getter

Setter

mediaSrtpMode

int

安全隧道使用模式。

Y

Y

sipTransportMode

TsdkSipTransportMode

信令传输模式。默认值为TSDK_E_SIP_TRANSPORT_UDP。

Y

Y

mediaSrtpMode

TsdkMediaSrtpMode

媒体SRTP模式。默认值为TSDK_E_MEDIA_SRTP_MODE_DISABLE。

Y

Y

isApplyConfigPriority

int

是否使用应用程序配置。默认使用鉴权过程下发的业务配置或系统默认配置。

Y

Y

表7 TsdkLocalAddress(本地ip地址)

变量名

类型

描述

Getter

Setter

isTryResume

int

是否尝试恢复登录和正在进行的会议,若为1,SDK将以尝试以最大的能力去恢复登录和正在进行的会议

Y

Y

ipAddress

String

本地IP地址,最长255字节。

Y

Y

表8 TsdkAppFilePathInfo(应用程序文件路径信息)

变量名

类型

描述

Getter

Setter

iconFilePath

String

头像文件保存路径。最大长度2047字节。

Y

Y

deptFilePath

String

部门查询结果文件保存路径。最大长度2047字节。

Y

Y

表9 TsdkDeviceDpiInfo(设备DPI信息)

变量名

类型

描述

Getter

Setter

dpiX

long

设备横向DPI。

Y

Y

dpiY

long

设备纵向DPI。

Y

Y

表10 TsdkCommonResult(操作结果)

变量名

类型

描述

Getter

Setter

result

long

结果。

Y

Y

reasonDescription

String

原因描述。

Y

Y

表11 TsdkNetworkInfoParam(网络信息参数)

变量名

类型

描述

Getter

Setter

sipServerUdpPort

int

SIP服务器的UDP端口。在isApplyConfigPriority为TRUE时有效。

Y

Y

sipServerTlsPort

int

SIP服务器的TLS端口。在isApplyConfigPriority为TRUE时有效。

Y

Y

sipServerTcpPort

int

SIP服务器的TCP端口。在isApplyConfigPriority为TRUE时有效。

Y

Y

表12 TsdkConfCtrlParam(会议控制参数)

变量名

类型

描述

Getter

Setter

protocol

TsdkConfCtrlProtocol

会议控制协议。

Y

Y

表13 TsdkAvcCapsLevelInfo(AVC视频能力级别信息)

变量名

类型

描述

Getter

Setter

encodeLevel

TsdkAvcCapsLevel

编码能力级别

Y

Y

decodeLevel

TsdkAvcCapsLevel

解码能力级别

Y

Y

表14 TsdkDisplayLocalInfo(会议中显示的本端信息)

变量名

类型

描述

Getter

Setter

displayName

String

显示名

Y

Y

登录和注销

表15 TsdkLoginParam(登录信息参数)

变量名

类型

描述

Getter

Setter

userId

long

用户ID,需要APP生成。

Y

Y

authType

TsdkAuthType

鉴权类型。

Y

Y

userName

String

帐户用户名。鉴权类型为TSDK_E_AUTH_NORMAL时填写,最大长度127字节。

Y

Y

password

String

帐户密码。鉴权类型为TSDK_E_AUTH_NORMAL时填写,最大长度127字节。

Y

Y

userTicket

String

Ticket值。鉴权类型为TSDK_E_AUTH_TICKET时填写,最大64K字节。

Y

Y

serverType

TsdkServerType

服务器类型。当前仅支持TSDK_E_SERVER_TYPE_PORTAL

Y

Y

serverVersion

String

服务器版本。最大长度127字节。

Y

Y

serverAddr

String

服务器地址。最大长度255字节。

Y

Y

serverPort

int

服务器端口号。

Y

Y

表16 TsdkImLoginParam(IM帐号登录参数)

变量名

类型

描述

Getter

Setter

eServerUri

String

eServer服务器(IM业务服务器)地址,最大长度255字节。

Y

Y

maaServerUri

String

MAA服务器地址,最大长度255字节。

Y

Y

pushServerUri

String

Push服务器地址(用于Android),最大长度255字节。

Y

Y

account

String

帐号。最大长度127字节。

Y

Y

password

String

密码。最大长度127字节。

Y

Y

token

String

U-Portal token鉴权。最大长度127字节。

Y

Y

表17 TsdkVoipAccountInfo(VoIP帐号信息)

变量名

类型

描述

Getter

Setter

account

String

帐号。最大长度127字节。

Y

Y

number

String

VoIP注册号码。最大长度127字节。

Y

Y

terminal

String

terminal号码(短号)。最大长度127字节。

Y

Y

表18 TsdkLoginSuccessInfo(登录成功信息)

变量名

类型

描述

Getter

Setter

confEnvType

TsdkConfEnvType

会议组网类型。

Y

Y

leftDaysOfPassword

long

登录密码剩余有效期天数。

Y

Y

isFirstLogin

int

是否首次登录。

Y

Y

isFreeUser

int

是否免费用户。

Y

Y

表19 TsdkSecurityTunnelInfo(安全隧道信息)

变量名

类型

描述

Getter

Setter

eServerStg

TsdkServerAddrInfoList

通过STG接入的内网eServer地址。外网接入时必选。

Y

Y

svn

TsdkServerAddrInfoList

SVN代理服务器地址。

Y

Y

firewallMode

int

防火墙模式。外网接入时必选。

Y

Y

maaStg

TsdkServerAddrInfoList

通过STG接入的内网MAA地址。外网接入时必选。

Y

Y

msStg

TsdkServerAddrInfoList

通过STG接入的内网MS地址。外网接入时必选。

Y

Y

httpsProxy

TsdkServerAddrInfoList

HTTPS反向代理地址。

Y

Y

stg

TsdkServerAddrInfoList

STG服务器信息。外网接入时必选。

Y

Y

sipStg

TsdkServerAddrInfoList

SIP STG服务器信息。外网接入时必选。

Y

Y

表20 TsdkServerAddrInfoList(服务器地址信息列表)

变量名

类型

描述

Getter

Setter

serverAddrInfoNum

long

服务器数量。

Y

Y

serverAddrInfo

List<TsdkServerAddrInfo>

服务器地址信息。

Y

Y

表21 TsdkServerAddrInfo(服务器地址信息)

变量名

类型

描述

Getter

Setter

serverPort

int

服务器端口号。

Y

Y

serverAddr

String

服务器地址。最大长度255字节。

Y

Y

表22 TsdkLoginFailedInfo(登录失败信息)

参数名

类型

描述

Getter

Setter

reasonCode

int

原因码。

Y

Y

reasonDescription

String

原因描述。最大长度1023字节。

Y

Y

residualRetryTimes

int

登录重试剩余次数。IM登录失败时有效。

Y

Y

lockInterval

int

帐号被锁定剩余时间(单位:分钟)。IM登录失败时原因,reason取值为 TSDK_E_IM_ERR_XXX 时有效。

Y

Y

表23 TsdkImTerminalLoginInfo(IM终端登录信息)

参数名

类型

描述

Getter

Setter

loginTime

long

登录时间。

Y

Y

clientType

TsdkClientType

客户端类型。

Y

Y

表24 TsdkImAccountInfo(IM帐号信息(登录成功时返回))

参数名

类型

描述

Getter

Setter

account

String

帐号。最大长度127字节。

Y

Y

regionId

int

区域ID。

Y

Y

lastLoginAddr

String

上一次登录的地址。最大长度255字节。

Y

Y

lastLoginTime

String

上一次登录的时间。最大长度31字节。

Y

Y

umServerLoginToken

String

UM服务器(富媒体服务器)登录Token,最大长度127字节。

Y

Y

terminalLoginInfoList

List<TsdkImTerminalLoginInfo>

同时登录的终端信息列表(暂不支持,预留)。

Y

Y

表25 TsdkForceLogoutInfo(帐号被强制登出信息)

参数名

类型

描述

Getter

Setter

reason

TsdkForceLogoutReason

帐号被强制登出原因。

Y

Y

表26 TsdkModifyPasswordParam(修改密码参数)

参数名

类型

描述

Getter

Setter

newPassword

String

新密码。最大长度127字节。

Y

Y

oldPassword

String

旧密码。最大长度127字节。

Y

Y

音视频呼叫

表27 TsdkCallInfo(呼叫信息)

变量名

类型

描述

Getter

Setter

callId

long

呼叫ID。

Y

Y

isCaller

int

是否为主叫。

Y

Y

isVideoCall

int

是否为视频呼叫。

Y

Y

peerNumber

String

对端号码。最长127字节。

Y

Y

peerDisplayName

String

对端名称。最长255字节。

Y

Y

callState

TsdkCallState

呼叫状态。

Y

Y

isAutoAnswer

int

是否为自动应答。

Y

Y

isFocus

int

是否带isfoucs标识。

Y

Y

confId

String

会议id,最长15字节。

Y

Y

reasonCode

int

原因码。

Y

Y

reasonDescription

String

原因描述。最长1023字节。

Y

Y

表28 TsdkVideoViewRefresh(视频视图刷新信息)

变量名

类型

描述

Getter

Setter

viewType

TsdkVideoViewType

view刷新媒体类型。

Y

Y

event

TsdkVideoViewRefreshEvent

view刷新事件。

Y

Y

表29 TsdkCoordinateInfo(坐标信息)

变量名

类型

描述

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

表30 TsdkVideoWndInfo(视频窗口信息)

变量名

类型

描述

Getter

Setter

videoWndType

TsdkVideoWndType

视频窗口类型。

Y

Y

coordinate

TsdkCoordinateInfo

坐标信息。

Y

Y

render

long

窗口句柄。

Y

Y

index

int

窗口序号。

Y

Y

sessionId

long

本地预览session值。

Y

Y

refCount

long

使用引用计数。

Y

Y

displayMode

TsdkVideoWndDisplayMode

显示模式。

Y

Y

startImageFilePath

String

视频显示初始图像,必须为jpeg图像,且长宽都是8的倍数,最大长度2047字节。

Y

Y

表31 TsdkVideoCtrlInfo(视频控制信息)

变量名

类型

描述

Getter

Setter

operation

long

操作动作。取值:TsdkVideoCtrlOperationAct,可以使用逻辑运算符"|"连接,open|start,close|stop。

Y

Y

object

long

视频控制对象。取值: TsdkVideoCtrlObj,可以使用逻辑运算符"|"连接。

Y

Y

isSync

int

是否使用同步执行。ios8.3使用异步,否则在切后台时调用该接口会被系统迅速挂起导致崩溃卡死。

Y

Y

表32 TsdkDeviceInfo(设备信息)

变量名

类型

描述

Getter

Setter

index

long

设备索引。

Y

Y

deviceName

String

设备名称。最大长度255字节。

Y

Y

cameraOrient

long

摄像头角度。仅移动平台摄像头设备有值。

Y

Y

deviceId

long

设备ID。

Y

Y

表33 TsdkVideoRenderInfo(视频显示窗口属性)

变量名

类型

描述

Getter

Setter

renderType

TsdkVideoWndType

窗口类型枚举值。

Y

Y

displayType

TsdkVideoWndDisplayMode

窗口显示模式。0:拉伸模式 1:(不拉伸)黑边模式 2:(不拉伸)裁剪模式 3:(需保证窗口尺寸 >= 图像尺寸)按原始分辨率显示。

Y

Y

mirrorType

TsdkVideoWndMirrorType

窗口镜像模式。0:不做镜像(默认值) 1:垂直镜像(X轴镜像)(目前未支持) 2:水平镜像(Y轴镜像)。

Y

Y

表34 TsdkVideoOrient(视频横竖屏状态)

变量名

类型

描述

Getter

Setter

choice

long

视频横竖屏情况 1:竖屏;2:横屏;3:反向横屏。

Y

Y

portrait

long

竖屏视频捕获(逆时针旋转)角度 0:0度;1:90度;2:180度;3:270度。

Y

Y

landscape

long

横屏视频捕获(逆时针旋转)角度 0:0度;1:90度;2:180度;3:270度。

Y

Y

seascape

long

反向横屏视频捕获(逆时针旋转)角度 0:0度;1:90度;2:180度;3:270度。

Y

Y

表35 TsdkSessionModified(会话修改完成结果信息)

变量名

类型

描述

Getter

Setter

callId

long

呼叫ID。

Y

Y

isFouces

int

是否带isfoucs标识,移动会议场景使用。

Y

Y

orientType

TsdkVideoOrientation

移动视频横竖屏情况。

Y

Y

localAddr

String

本地地址。

Y

Y

remoteAddr

String

移动上报远端地址。

Y

Y

reinviteType

TsdkReinviteType

主被叫控业务中Reinvite消息指示的事件类型。

Y

Y

audioSendMode

TsdkMediaSendMode

音频媒体方向。

Y

Y

videoSendMode

TsdkMediaSendMode

视频媒体方向。

Y

Y

dataSendMode

TsdkMediaSendMode

辅流媒体方向。

Y

Y

isLowBwSwitchToAudio

int

是否是由低带宽造成的视频切换到音频。

Y

Y

表36 TsdkSessionCodec(会话正在使用的编解码器信息)

变量名

类型

描述

Getter

Setter

callId

long

呼叫ID。

Y

Y

mediaType

TsdkMediaType

媒体类型1 : 音频。 2 : 视频。 3 : 辅流

Y

Y

codecType

long

编解码器类型 1 : 编码器。2 : 解码器。

Y

Y

codecName

String

编解码名称,最大长度255字节。

Y

Y

表37 TsdkSvcVideoWndInfo(SVC视频窗口信息)

变量名

类型

描述

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

是否使用同步执行,默认为0。

Y

Y

maxBandwidth

long

多流接收方向每一路流的最大带宽。

Y

Y

表38 TsdkAudioStreamInfo(音频流信息)

变量名

类型

描述

Getter

Setter

isSrtp

int

是否启用SRTP, 取值: 0 RTP, 1 SRTP。

Y

Y

encodeProtocol

String

编码协议描述。

Y

Y

sendBitRate

long

发送比特率(kbps)。

Y

Y

sendLossFraction

float

发送方丢包率(%)。

Y

Y

sendDelay

float

发送方平均时延(ms)。

Y

Y

sendJitter

float

发送方平均抖动(ms)。

Y

Y

decodeProtocol

String

解码协议名。

Y

Y

recvBitRate

long

接收比特率(kbps)。

Y

Y

recvLossFraction

float

接收方丢包率(%)。

Y

Y

recvDelay

float

接收方平均时延(ms)。

Y

Y

recvJitter

float

接收方平均抖动(ms)。

Y

Y

recvAverageMos

float

接收方向MOS分平均值,用浮点数表示:取值范围[0, 5], 0表示该参数无效。

Y

Y

表39 TsdkVideoStreamInfo(视频流信息)

变量名

类型

描述

Getter

Setter

isSrtp

int

是否启用SRTP, 取值: 0 RTP, 1 SRTP。

Y

Y

bandwidth

long

有效带宽

Y

Y

encodeProtocol

String

编码协议描述。

Y

Y

sendBitRate

long

发送比特率(kbps)。

Y

Y

sendFrameSize

String

发送(编码)图像分辨率描述

Y

Y

sendFrameRate

long

发送(编码)视频帧率

Y

Y

sendLossFraction

float

发送方丢包率(%)。

Y

Y

sendDelay

float

发送方平均时延(ms)。

Y

Y

sendJitter

float

发送方平均抖动(ms)。

Y

Y

decodeProtocol

String

解码协议名。

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

接收方对应的ssrc label, 多流时有效。

Y

Y

表40 TsdkCallStatisticInfo(呼叫信息统计)

变量名

类型

描述

Getter

Setter

effectiveBitrate

long

有效带宽(组件探测出的下行方向总tmmbr)。

Y

Y

audioStreamInfo

TsdkAudioStreamInfo

音频流信息。

Y

Y

videoStreamInfo

TsdkVideoStreamInfo

单流视频流信息。

Y

Y

isSvcConf

int

是否多流视频会议。

Y

Y

svcStreamCount

int

多流视频流信息数。

Y

Y

svcStreamInfo

List<TsdkVideoStreamInfo>

多流视频流信息。

Y

Y

会议

表41 TsdkAttendeeBaseInfo(与会者基础信息类)

变量名

类型

描述

Getter

Setter

number

String

号码,最大长度127字节。

Y

Y

displayName

String

可选,与会者显示名称,最大长度127字节。

Y

Y

accountId

String

可选,用户帐号,预约会议时若不填写,则该用户无法查询到,最大长度127字节。

Y

Y

email

String

可选,电子邮箱地址,最大长度95字节。

Y

Y

sms

String

可选,短信通知手机号码,最大长度127字节。

Y

Y

role

TsdkConfRole

会议成员角色。

Y

Y

表42 TsdkBookConfInfo(预约会议信息类)

变量名

类型

描述

Getter

Setter

size

long

会议方数。

Y

Y

subject

String

会议主题,最大长度385字节。

Y

Y

groupUri

String

可选,群组Uri,最大长度127字节。

Y

Y

startTime

String

可选,会议开始时间,格式:YYYY-MM-DD HH:MM,立即会议时无需填写,最大长度31字节。

Y

Y

duration

long

可选,会议持续时长,单位: 分钟,默认60分钟。

Y

Y

confType

TsdkConfType

会议类型。

Y

Y

confMediaType

TsdkConfMediaType

媒体类型。

Y

Y

isHdConf

int

可选,是否高清视频会议。

Y

Y

isMultiStreamConf

int

可选,是否为多流视频会议,预留。

Y

Y

isAutoRecord

int

可选,会议是否自动启动录制,预留。

Y

Y

isAutoProlong

int

可选,是否自动延长会议。

Y

Y

isAutoMute

int

可选,非主席在入会后是否自动闭音。

Y

Y

welcomePrompt

TsdkConfWarningTone

可选,入会提示音类型。

Y

Y

enterPrompt

TsdkConfWarningTone

可选,有成员入会提示音类型。

Y

Y

leavePrompt

TsdkConfWarningTone

可选,有成员离会提示音类型。

Y

Y

reminder

TsdkConfReminderType

可选,会议提醒方式。

Y

Y

language

TsdkConfLanguage

可选,会议的默认语言。

Y

Y

confEncryptMode

TsdkConfMediaEncryptMode

可选,会议媒体加密模式。

Y

Y

attendeeNum

long

与会者数量。

Y

Y

attendeeList

List<TsdkAttendeeBaseInfo>

与会者列表。

Y

Y

recordMode

TsdkConfRecordMode

录制模式。

Y

Y

表43 TsdkConfIncomingInfo(会议来电信息类)

变量名

类型

描述

Getter

Setter

confMediaType

TsdkConfMediaType

媒体类型。

Y

Y

isHdConf

int

是否高清视频会议。

Y

Y

number

String

来电号码,最大长度127字节。

Y

Y

subject

String

会议主题,最大长度385字节。

Y

Y

groupUri

String

群组uri,最大长度127字节。

Y

Y

confId

String

会议id,最大长度15字节。

Y

Y

表44 TsdkConfBaseInfo(会议基础信息类)

变量名

类型

描述

Getter

Setter

size

long

会议方数。

Y

Y

confId

String

会议ID,最大长度15字节。

Y

Y

subject

String

会议主题,最大长度385字节。

Y

Y

accessNumber

String

会议接入码,最大长度63字节。

Y

Y

chairmanPwd

String

主席密码,在EC会议下,查询会议列表时不能获取,需要通过查询会议详情获取,最大长度191字节。

Y

Y

guestPwd

String

来宾密码,在EC会议下,查询会议列表时不能获取,需要通过查询会议详情获取,最大长度191字节。

Y

Y

startTime

String

会议开始时间,最大长度31字节。

Y

Y

endTime

String

会议结束时间,最大长度31字节。

Y

Y

confMediaType

TsdkConfMediaType

媒体类型。

Y

Y

isHdConf

int

是否高清视频会议。

Y

Y

confState

TsdkConfState

会议状态。

Y

Y

scheduserAccount

String

预订者帐号,最大长度127字节。

Y

Y

scheduserName

String

预订者姓名,最大长度255字节。

Y

Y

token

String

会控token仅入驻式融合会议有效,最大长度127字节。

Y

Y

chairJoinUri

String

主持人加入会议uri链接,最大长度255字节。

Y

Y

guestJoinUri

String

来宾加入会议uri链接,最大长度255字节。

Y

Y

recordMode

TsdkConfRecordMode

会议媒体录制模式。

Y

Y

表45 TsdkAttendeeStatusInfo(与会者状态信息类)

变量名

类型

描述

Getter

Setter

participantId

String

与会者唯一标识,最大长度127字节。

Y

Y

dataUserId

long

与会者在数据会议中的用户ID。

Y

Y

state

TsdkConfParticipantStatus

用户状态。

Y

Y

isSelf

int

是否自己。

Y

Y

isMute

int

是否闭音。

Y

Y

isHandup

int

是否举手。

Y

Y

isBroadcast

int

是否被广播。

Y

Y

isVideo

int

是否视频方式加入会议

Y

Y

isJoinDataconf

int

是否已加入数据会议。

Y

Y

isPresent

int

是否主讲人。

Y

Y

hasCamera

int

是否有摄像头。

Y

Y

isOnlyInDataConf

int

是否仅在数据会议中(通过独立的数据会议客户端加入会议)。

Y

Y

isAnonymous

int

是否匿名用户(匿名方式加入会议)。

Y

Y

isBeWatching

int

是否被本地观看状态,SVC会议下有效 。

Y

Y

isShareOwner

int

是否共享的拥有者。

Y

Y

表46 TsdkAttendee(与会者信息类)

变量名

类型

描述

Getter

Setter

baseInfo

TsdkAttendeeBaseInfo

与会者基础信息。

Y

Y

statusInfo

TsdkAttendeeStatusInfo

与会者状态信息。

Y

Y

表47 TsdkAddAttendeesInfo(添加与会者信息)

变量名

类型

描述

Getter

Setter

attendeeList

List<TsdkAttendeeBaseInfo>

与会者列表。

Y

Y

attendeeNum

long

与会者个数。

Y

Y

表48 TsdkWatchAttendees(选看与会者信息类)

变量名

类型

描述

Getter

Setter

number

String

号码,最大长度127字节。

Y

Y

label

long

SVC Label,SVC 会议功能时有效。

Y

Y

width

long

分辨率:宽,SVC 会议功能时有效。

Y

Y

height

long

分辨率:高,SVC 会议功能时有效。

Y

Y

表49 TsdkWatchAttendeesInfo(选看与会者画面参数信息)

变量名

类型

描述

Getter

Setter

watchAttendeeList

List<TsdkWatchAttendees>

被选看的与会者信息列表。

Y

Y

watchAttendeeNum

long

被选看的与会者个数。

Y

Y

表50 TsdkConfUpgradeParam(会议升级描述参数类)

变量名

类型

描述

Getter

Setter

groupUri

String

可选,群组ID,最大长度127字节。

Y

Y

表51 TsdkConfOperationResult(会议控制操作结果类)

变量名

类型

描述

Getter

Setter

operationType

TsdkConfOperationType

会控操作类型。

Y

Y

reasonCode

int

操作失败原因码。

Y

Y

description

String

操作失败原因描述,最大长度1023字节。

Y

Y

表52 TsdkQueryConfListReq(查询会议列表类)

变量名

类型

描述

Getter

Setter

confRight

TsdkConfRight

会议权限。

Y

Y

isIncludeEnd

int

是否包含已结束的会议。

Y

Y

pageIndex

long

指定返回的会议列表页页面索引, 索引取值从1开始。

Y

Y

pageSize

long

指定每页返回的会议记录数,每页最多返回400个。

Y

Y

表53 TsdkConfListInfo(会议列表信息类)

变量名

类型

描述

Getter

Setter

totalCount

long

会议总个数。

Y

Y

currentCount

long

当前返回会议个数。

Y

Y

confInfoList

List<TsdkConfBaseInfo>

当前返回会议列表。

Y

Y

表54 TsdkQueryConfDetailReq(会议详细信息类)

变量名

类型

描述

Getter

Setter

pageIndex

long

指定返回的与会者列表页的页面索引, 索引取值从1开始。

Y

Y

confId

String

会议id,最大长度15字节。

Y

Y

pageSize

long

指定每页返回与会者的记录数,每页最多返回400个。

Y

Y

subConfId

String

周期会议子会议ID(预留,暂不支持),最大长度15字节。

Y

Y

表55 TsdkConfDetailInfo(会议详情类)

变量名

类型

描述

Getter

Setter

confInfo

TsdkConfBaseInfo

会议信息。

Y

Y

attendeeNum

long

与会者数量。

Y

Y

attendeeList

List<TsdkAttendeeBaseInfo>

与会者列表。

Y

Y

表56 TsdkJoinConfIndInfo(加入会议通知信息类)

变量

类型

描述

Getter

Setter

callId

long

呼叫ID,软终端号码入会时有效。

Y

Y

confEnvType

TsdkConfEnvType

会议组网类型。

Y

Y

confMediaType

TsdkConfMediaType

媒体类型。

Y

Y

isHdConf

int

是否高清视频会议。

Y

Y

isSvcConf

int

是否多流会议。

Y

Y

svcLabelCount

int

多流Label有效个数。

Y

Y

svcLabel

List<Long>

多流Label对应的ssrc数组。

Y

Y

表57 TsdkConfStatusInfo(会议状态信息类)

变量名

类型

描述

Getter

Setter

size

long

会议方数。

Y

Y

confId

String

会议ID,最大长度15字节。

Y

Y

subject

String

会议主题,最大长度385字节。

Y

Y

groupUri

String

群组Uri,最大长度127字节。

Y

Y

confMediaType

TsdkConfMediaType

媒体类型。

Y

Y

isHdConf

int

是否高清视频会议。

Y

Y

confState

TsdkConfState

会议状态。

Y

Y

scheduserAccount

String

预订者帐号,最大长度127字节。

Y

Y

scheduserName

String

预订者姓名,最大长度255字节。

Y

Y

isRecord

int

会场是否为录音状态。

Y

Y

isLock

int

会场是否为锁定状态。

Y

Y

isAllMute

int

会场是否为静音状态。

Y

Y

updateType

TsdkConfAttendeeUpdateType

成员更新方式。

Y

Y

attendeeNum

long

与会者数量。

Y

Y

attendeeList

List<TsdkAttendee>

与会者列表。

Y

Y

isLiveBroadcast

int

会场是否直播状态。

Y

Y

isSupportLiveBroadcast

int

会场是否支持直播。

Y

Y

isSupportRecordBroadcast

int

会场是否支持录播。

Y

Y

表58 TsdkConfJoinParam(入会参数类)

变量名

类型

描述

Getter

Setter

confPassword

String

会议密码,最大长度15字节。

Y

Y

confId

String

会议ID,最大长度63字节。

Y

Y

accessNumber

String

会议接入码,最大长度191字节。

Y

Y

表59 TsdkConfSpeaker(会议发言方信息类)

变量名

类型

描述

Getter

Setter

baseInfo

TsdkAttendeeBaseInfo

与会者基础信息。

Y

Y

statusInfo

TsdkAttendeeStatusInfo

与会者状态信息。

Y

Y

isSpeaking

int

是否发言。

Y

Y

speakingVolume

long

音量。

Y

Y

表60 TsdkConfSpeakerInfo(发言方通知信息类)

变量名

类型

描述

Getter

Setter

speakerNum

long

发言方个数。

Y

Y

speakers

List<TsdkConfSpeaker>

发言方。

Y

Y

表61 TsdkConfDataconfParams(数据会议入会参数类)

变量名

类型

描述

Getter

Setter

confId

String

会议ID,最大长度15字节。

Y

Y

hostKey

String

主持人密码:主持人入会必须设置,其他情况不需要,最大长度63字节。

Y

Y

cryptKey

String

会议鉴权密码,最大长度63字节。

Y

Y

cmAddress

String

SIP网关地址及端口,最大长度255字节。

Y

Y

siteUrl

String

会议站点地址,最大长度255字节

Y

Y

siteId

String

站点ID,最大长度255字节。

Y

Y

serverIp

String

会议服务器地址,单个地址或URL,最大长度255字节。

Y

Y

userId

String

用户ID,最大长度127字节。

Y

Y

userName

String

用户名,最大长度255字节。

Y

Y

userUri

String

用户Uri,最大长度255字节。

Y

Y

confName

String

会议名称,最大长度385字节。

Y

Y

accessCode

String

会议接入码,最大长度63字节。

Y

Y

partSecureConfNum

String

与会者安全会议号,最大长度127字节。

Y

Y

stgServerAddress

String

STG服务器地址,最大长度255字节。

Y

Y

sbcServerAddress

String

SBC服务器地址,最大长度255字节

Y

Y

userRole

long

会议成员角色。

Y

Y

mcuNumber

long

MCU号。

Y

Y

terminalNumber

long

Terminal号。

Y

Y

pinCode

String

PIN CODE码,最大长度127字节。

Y

Y

participantId

String

与会者ID,最大长度127字节。

Y

Y

shortUserName

String

用户名称(取user_name的前63个字节),最大长度63字节。

Y

Y

shortConfName

String

会议名称(取conf_name的前63个字节),最大长度63字节。

Y

Y

表62 TsdkConfAsStateInfo(共享状态信息类)

变量名

类型

描述

Getter

Setter

subState

int

共享状态。

Y

Y

state

int

共享子状态。

Y

Y

表63 TsdkConfChatMsgInfo(会议聊天信息类)

变量名

类型

描述

Getter

Setter

sender

TsdkAttendee

发送者详细信息(接收消息携带,发送消息时无需填写)。

Y

Y

chatType

int

消息类型,当前仅支持TSDK_E_CONF_CHAT_PUBLIC。

Y

Y

chatMsgLen

long

消息内容长度。

Y

Y

senderDisplayName

String

发送者的名称,最大长度255字节。

Y

Y

reviciverNumber

String

消息接收者号码,当前仅支持发送公共消息,无需填写,预留,最大长度127字节。

Y

Y

time

long

消息发送时服务器时间(接收消息携带,发送消息时无需填写)。

Y

Y

senderNumber

String

发送者的号码(接收消息携带,发送消息时无需填写),最大长度127字节。

Y

Y

chatMsg

String

消息内容。

Y

Y

表64 TsdkConfAnonymousJoinParam(匿名入会参数)

参数名

类型

描述

Getter

Setter

confPassword

String

会议密码,最大长度191字节。

Y

Y

displayName

String

可选,与会者显示名称,最大长度255字节。

Y

Y

confId

String

会议ID,最大长度15字节。

Y

Y

serverPort

int

服务器端口号。

Y

Y

userId

long

用户ID,需要APP生成 。

Y

Y

serverAddr

String

会议服务器地址,最大长度255字节。

Y

Y

表65 TsdkDocBaseInfo(文档基础信息类)

参数名

类型

描述

Getter

Setter

pageCount

long

文档页数。

Y

Y

documentName

String

文档名,最大长度2047字节。

Y

Y

documentId

long

文档ID。

Y

Y

表66 TsdkDocShareDelDocInfo(文档删除信息类)

参数名

类型

描述

Getter

Setter

docBaseInfo

TsdkDocBaseInfo

文档基础信息。

Y

Y

docDelNumber

String

删除文档的与会者的号码,最大长度127字节。

Y

Y

docDelAttendee

TsdkAttendee

删除文档的与会者的详细信息。

Y

Y

docDelDisplayName

String

删除文档的与会者的名称,最大长度255字节。

Y

Y

表67 TsdkWbDelDocInfo(白板删除信息类)

参数名

类型

描述

Getter

Setter

wbDelDisplayName

String

删除白板的与会者的名称,最大长度255字节。

Y

Y

wbBaseInfo

TsdkDocBaseInfo

文档基础信息。

Y

Y

wbDelAttendee

TsdkAttendee

删除白板的与会者的详细信息。

Y

Y

wbDelNumber

String

删除白板的与会者的号码,最大长度127字节。

Y

Y

表68 TsdkConfAsVirtualViewInfo(虚拟显示器信息)

参数名

类型

描述

Getter

Setter

width

int

虚拟显示器的宽度。

Y

Y

bitCount

int

虚拟显示器图像每个像素的位数。

Y

Y

height

int

虚拟显示器的高度。

Y

Y

表69 TsdkConfAsViewDataInfo(共享的图片数据信息)

参数名

类型

描述

Getter

Setter

cbCrData

int

图片色度(Chrominance)信息。

Y

Y

orientation

TsdkImageOrientation

图片方向。

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

表70 TsdkConfSvcWatchAttendee(正在观看的与会者画面信息)

参数名

类型

描述

Getter

Setter

label

int

SVC Label,SVC 会议功能时有效。

Y

Y

baseInfo

TsdkAttendeeBaseInfo

与会者基础信息。

Y

Y

statusInfo

TsdkAttendeeStatusInfo

与会者状态信息。

Y

Y

表71 TsdkConfSvcWatchInfo(SVC(多流)会议下正在观看画面信息)

参数名

类型

描述

Getter

Setter

watchAttendeeNum

long

观看的与会者画面信息个数。

Y

Y

watchAttendees

List<TsdkConfSvcWatchAttendee>

观看的与会者画面信息列表。

Y

Y

表72 TsdkShareStatisticInfo(共享统计信息)

参数名

类型

描述

Getter

Setter

status

long

状态,不涉及:0,发送数据:1,接收数据:2 。

Y

Y

sendFrameSizeWidth

long

发送(编码)视频分辨率-宽。

Y

Y

sendFrameSizeHeight

long

发送(编码)视频分辨率-高。

Y

Y

sendBitRate

long

发送(编码)码率(bps)。

Y

Y

sendFrameRate

long

发送(编码)视频帧率

Y

Y

encodeVersion

long

编码协议版本

Y

Y

sendPktLoss

float

发送方丢包率(0.xx%);-1表示未启用该参数

Y

Y

sendRtt

long

发送方环路时延(ms);0表示未启用该参数;不支持获取平均值、最大值和最小值。

Y

Y

sendJitter

long

发送方抖动(ms);0表示未启用该参数;不支持获取平均值、最大值和最小值

Y

Y

recvFrameSizeWidth

long

接收(解码)视频分辨率-宽

Y

Y

recvFrameSizeHeight

long

接收(解码)视频分辨率-高

Y

Y

recvBitRate

long

接收(解码)码率(bps)

Y

Y

recvFrameRate

long

接收(解码)视频帧率

Y

Y

decodeVersion

long

解码协议版本

Y

Y

recvPktLoss

float

接收方丢包率(0.xx%);-1表示未启用该参数

Y

Y

recvRtt

long

接收方环路时延(ms);0表示未启用该参数;不支持获取平均值、最大值和最小值

Y

Y

recvJitter

long

接收方抖动(ms);0表示未启用该参数;不支持获取平均值、最大值和最小值

Y

Y

表73 TsdkResumeConfIndInfo(会议恢复信息)

参数名

类型

描述

Getter

Setter

originalHandle

long

原始(before resuming)的会议句柄。

Y

Y

joinConfIndInfo

TsdkJoinConfIndInfo

重新加入会议的通知信息。

Y

Y

通讯录

表74 TsdkIconInfo(自定义头像参数)

变量名

类型

描述

Getter

Setter

smallIconPath

String

小头像路径+文件名,最大长度2047字节。

Y

Y

mediumIconPath

String

中头像路径+文件名,最大长度2047字节。

Y

Y

largeIconPath

String

大头像路径+文件名,最大长度2047字节。

Y

Y

表75 TsdkSearchContactsParam(联系人搜索参数)

变量名

类型

描述

Getter

Setter

searchKeyword

String

搜索关键字,最大长度127字节。

Y

Y

pageIndex

long

当前需要查找的页数.

Y

Y

isExactSearch

int

是否精确查找,取值:0:模糊;1:精确;精确查询,若匹配到多条,则返回对应的第一个值。

Y

Y

departmentId

String

可选,部门ID,若填写则在指定部门下查找,最大长度15字节。

Y

Y

seqNo

long

查询序号。

Y

Y

表76 TsdkGetIconParam(头像获取参数)

变量名

类型

描述

Getter

Setter

account

String

UC帐号,最大长度127字节。

Y

Y

seqNo

long

搜索序号。

Y

Y

表77 TsdkGetIconResult(头像查询结果)

变量名

类型

描述

Getter

Setter

iconId

long

系统头像ID。

Y

Y

iconPath

String

自定义头像文件路径,最大长度2047字节。

Y

Y

表78 TsdkContactsInfo(联系人详细信息)

变量名

类型

描述

Getter

Setter

staffAccount

String

UC帐号,最大长度127字节。

Y

Y

personName

String

姓名,最大长度255字节。

Y

Y

staffNo

String

工号,最大长度127字节。

Y

Y

terminal

String

IP号码,软终端号码,最大长度127字节。

Y

Y

terminal2

String

软终端公网长号,最大长度127字节。

Y

Y

departmentName

String

部门名字,最大长度511字节。

Y

Y

title

String

职务,最大长度127字节。

Y

Y

mobile

String

手机号码,最大长度127字节。

Y

Y

homePhone

String

家庭电话,最大长度127字节。

Y

Y

email

String

邮箱,最大长度95字节。

Y

Y

officePhone

String

座机号码 办公电话,最大长度127字节。

Y

Y

officePhone2

String

硬终端2,最大长度127字节。

Y

Y

officePhone3

String

硬终端3,最大长度127字节。

Y

Y

officePhone4

String

硬终端4,最大长度127字节。

Y

Y

officePhone5

String

硬终端5,最大长度127字节。

Y

Y

officePhone6

String

硬终端6,最大长度127字节。

Y

Y

otherPhone

String

其他电话,最大长度127字节。

Y

Y

otherPhone2

String

其他电话2,最大长度127字节。

Y

Y

gender

String

性别,最大长度7字节。

Y

Y

zipCode

String

邮编,最大长度31字节。

Y

Y

address

String

地址,最大长度255字节。

Y

Y

signature

String

签名,最大长度255字节。

Y

Y

表79 TsdkSearchContactsResult(联系人搜索结果)

变量名

类型

描述

Getter

Setter

page

long

当前页码。

Y

Y

totalNum

long

联系人总数。

Y

Y

currentNum

long

当前查询结果数。

Y

Y

contactInfo

List<TsdkContactsInfo>

联系人信息。

Y

Y

表80 TsdkDepartmentInfo(部门信息类)

变量名

类型

描述

Getter

Setter

departmentId

String

部门ID,最大长度15字节。

Y

Y

parentId

String

父节点ID,最大长度15字节。

Y

Y

departmentName

String

部门名称,最大长度511字节。

Y

Y

表81 TsdkSearchDepartmentResult(搜索部门的返回结果类)

变量名

类型

描述

Getter

Setter

departmentId

String

查询的部门ID,最大长度15字节。

Y

Y

itemNum

long

查询到的下一级部门条目总数。

Y

Y

departmentInfo

List<TsdkDepartmentInfo>

查询的部门信息。

Y

Y