开发者中心 - 小鱼易连

CurrentSpeakersInfo

描述: 当前讲话者，用于UI标记当前正在讲话的用户
字段:

名称	类型	必填	默认值	描述
EnergyAverage	int	是	无	能量平均值
ParticipantId	uint	是	无	与会者ID
CallUrl	string	是	无	呼叫URL
DisplayName	string	是	无	显示名称
Number	string	是	无	讲话者号码
extUserId	string	是	无	第三方登录的用户ID

实现接口:
IComparable: 用于比较对象大小

方法:

CompareTo(object obj): 比较当前对象与指定对象的大小

SDKAddCalleeSate

描述: 添加与会者状态，用户会议中拉人入会
字段:

名称	类型	必填	默认值	描述
isSucceeded	bool	是	无	是否成功
reason	string	是	无	失败原因

SDKAiCaptionInfo

描述: AI字幕信息
字段:

名称	类型	必填	默认值	描述
pid	uint	是	无	参会者id
src	string	是	string.Empty	源语言文字
target	string	是	string.Empty	翻译后的语言文字
isEnd	bool	是	false	句子是否结束
isActive	bool	是	false	是否是当前能量最高的发言者
url	string	是	""	用户callurl
dn	string	是	""	displayName用户名
srcLang	string	是	""	源文字语言
targetLang	string	是	""	翻译后文字语言

SDKAnnotationState

用途: 标注状态

枚举值:

枚举值	描述
ANNOTATION_STATE_IDLE	空闲状态
ANNOTATION_STATE_OFFERING	提供状态
ANNOTATION_STATE_SENDING	发送状态
ANNOTATION_STATE_UNKNOWN	未知状态

SDKAnnotationStateInfo

描述: 标注状态相关信息
字段:

名称	类型	必填	默认值	描述
callIndex	int	是	无	呼叫索引
annotationState	SDKAnnotationState	是	无	标注状态
url	string	是	无	URL
reason	string	是	无	原因
isStart	bool	是	无	是否开始
globalReason	string	是	无	全局原因

SDKAnnotationVideoStreamInfo

描述: 标注视频流信息
字段:

名称	类型	必填	默认值	描述
participantId	uint	是	无	与会者ID
width	ushort	是	无	宽度
height	ushort	是	无	高度
originalWidth	ushort	是	无	标注区域原始宽
originalHeight	ushort	是	无	标注区域原始高

SDKAppInfoManaged

描述: app信息
字段:

名称	类型	必填	默认值	描述
hAppMainWnd	IntPtr	是	无	主窗口句柄
appName	string	是	无	应用名称
processId	uint	是	无	进程ID
thumbnail	BitmapSource	是	无	缩略图

SDKAudioConfig

描述: 音频配置
字段:

名称	类型	必填	默认值	描述
audioQualityAnalysis	int	是	-1	音频质量诊断开关, 1打开，0关闭
forthDelay	int	是	-1	回声前向搜索范围，即往过去时间寻找回声的范围，单位毫秒
backDelay	int	是	-1	回声后向搜索范围，即往将来时间寻找回声的范围，单位毫秒
initDelay	int	是	-1	初始延时，呼叫开始时辅助采集和参考对齐
resetAE	int	是	-1	开启异常条件下重置AE，包括队列调整异常，回声检测异常
resetAEThreshold	int	是	-1	重置AE需要满足的异常参数阈值，即帧数

SDKAudioData

描述: 音频数据内容
字段:

名称	类型	必填	默认值	描述
isContent	bool	是	无	值为 true 代表使用外部内容输入，否则使用外部设备输入
formatType	SDKAudioSampleType	是	无	音频格式
samplesPerSec	UInt32	是	无	每秒采样数
numChannels	UInt32	是	无	通道数
bitsPerSample	UInt32	是	无	每样本长度（位）
containerSize	UInt32	是	无	每样本容器长度（位）
timeStamp	UInt64	是	无	相同时钟产生的时间戳（ms）
dataPtr	IntPtr	是	无	数据指针
dataLen	UInt32	是	无	数据长度

SDKAudioQuality

描述: 声音质量
字段:

名称	类型	必填	默认值	描述
echo_status	string	是	无	回声状态
clipping	string	是	无	截波（clipping）状态

SDKAudioSampleType

用途: 外部输入音频格式

枚举值:

枚举值	描述
PCM	PCM格式
FLOAT	FLOAT格式

SDKBulkRosterElement

描述: 全量ROSTER元素
字段:

名称	类型	必填	默认值	描述
participantId	uint	是	无	与会者ID
deviceType	SDKDeviceType	是	无	设备类型
callUri	string	是	无	呼叫URI
displayName	string	是	无	显示名称
Alias	string	是	无	别名
isAudioMute	bool	是	无	是否音频静音
isVideoMute	bool	是	无	是否视频静音

SDKBulkRosterInfo

描述: 全量ROSTER信息
字段:

名称	类型	必填	默认值	描述
totalEpNum	uint	是	无	总终端数
bulRosterType	SDKBulRosterType	是	无	类型
addRosterElements	SDKBulkRosterElement[]	是	无	新增元素
updateRosterElements	SDKBulkRosterElement[]	是	无	更新元素
delRosterParticipants	string[]	是	无	删除元素

SDKBulRosterType

用途: 全量ROSTER类型

枚举值:

枚举值	描述
BulkRosterTypeFull	全量数据
BulkRosterTypeIncrement	增量数据

SDKBwTestException

描述: 带宽测试异常
字段:

名称	类型	必填	默认值	描述
userId	uint	是	无	用户ID
errorCode	uint	是	无	错误码

SDKBwTestException (v3.3.1及后续版本)

描述: 带宽测试异常
字段:

名称	类型	必填	默认值	描述
userId	uint	是	无	用户ID
errorCode	uint	是	无	错误码
serverIp	string	是	无	服务器IP
serverPort	uint	是	无	服务器端口

SDKBwTestResult

描述: 带宽测试结果
字段:

名称	类型	必填	默认值	描述
detectResult	SDKDetectResult	是	无	检测结果
recvDetail	SDKDetectResultDetail[]	是	无	接收详情
sendDetail	SDKDetectResultDetail[]	是	无	发送详情

SDKCallHistoryInfo

描述: 呼叫历史记录
字段:

名称	类型	必填	默认值	描述
id	string	是	无	记录ID
numberType	string	是	无	号码类型
number	string	是	无	号码
callTime	long	是	无	呼叫时间
displayName	string	是	无	显示名称
avatar	string	是	无	头像
userProfileId	int	是	无	用户档案ID
callType	SDKCallType	是	无	呼叫类型
deviceType	int	是	无	设备类型

SDKCallMode

用途: 呼叫模式

枚举值:

枚举值	描述
AudioVideo	音视频呼叫模式
ContentOnly	仅内容模式
AudioOnly	语音呼叫模式
MonitorHideMode	监会模式（隐身入会）

SDKCallNumberType

用途: 呼入/连接的号码类型

枚举值:

枚举值	描述
Nemo	Nemo类型
CloudMeetingRoom	云会议室
Group	群组
H323	H323
BRUCE	BRUCE
TVBOX	TVBOX
APP	应用
Unknown	未知

SDKCallState

用途: 呼叫状态

枚举值:

枚举值	描述
Connected	已连接
Disconnected	已断开
Connecting	连接中
Disconnecting	断开中

SDKCallStateInfo

描述: 呼叫状态信息
字段:

名称	类型	必填	默认值	描述
callState	SDKCallState	是	无	呼叫状态
sdkError	SDKError	是	无	SDK错误
disconnectReason	string	是	""	退出会议的原因
meetingNumer	string	是	""	会议室号码
callIndex	int	是	无	当前呼叫的唯一标识
remoteAudioOnlyMode	bool	是	false	远端是否为语音模式

SDKCallType

用途: SDK呼叫类型

枚举值:

枚举值	描述
MakeCall	发起呼叫
AnswerCall	应答呼叫
DropCall	挂断呼叫

SDKCallUrlInfo

描述: 呼叫信息
字段:

名称	类型	必填	默认值	描述
deviceType	SDKDeviceType	是	无	当前设备类型
callUrl	string	是	无	呼叫URL
callId	string	是	无	呼叫ID
displayName	string	是	无	显示名称
callNumberType	SDKCallNumberType	是	无	呼入的号码类型
enablePwd	bool	是	无	是否启用密码
pwdResult	int	是	无	密码结果
deviceId	long	是	无	设备ID
dialNumber	string	是	无	拨号号码
callNumber	string	是	无	呼叫号码
number	string	是	无	号码
alias	string[]	是	无	别名
avatar	string	是	无	头像
sdkError	SDKError	是	无	SDK错误

SDKCameraOrdinal

用途: 视频输入设备序号

枚举值:

枚举值	描述
None	无
First	第一路视频流
Second	双流时的第二路(内容共享)

SDKCaptionNotify

描述: 字幕消息
字段:

名称	类型	必填	默认值	描述
action	string	是	无	操作消息动作，"push" 推送消息，"cancel"取消显示消息
content	string	是	无	消息内容
location	string	是	无	消息显示位置，top上方显示，middle中间显示，bottom底部显示
scroll	int	是	无	消息是否滚动，0 不滚动，1 滚动
fontRGB	string	是	无	字体RGB颜色
fontFamily	string	是	无	字体系列
fontSize	string	是	无	字体大小
backgroundRGB	string	是	无	背景RGB颜色
backgroundAlpha	string	是	无	背景透明度
scrollSpeed	string	是	无	滚动速度

SDKClientParam

描述: 客户端参数
字段:

名称	类型	必填	默认值	描述
localIp	string	是	无	本地IP
osVersion	string	是	无	操作系统版本
pingTimeout	uint	是	无	ping超时时间
isAutoDetect	bool	是	无	是否自动检测
duration	uint	是	无	持续时间
downloadPkgSize	ushort	是	无	下载包大小
downloadBitrate	uint	是	无	下载比特率
uploadPkgSize	ushort	是	无	上传包大小
uploadBitrate	uint	是	无	上传比特率
isUdp	bool	是	无	是否使用UDP
startBitrate	uint	是	无	起始比特率
netKey	string	是	无	网络密钥
netType	uint	是	无	网络类型
userId	ulong	是	无	用户ID
serverPort	ushort	是	无	服务器端口
serverIp	string	是	无	服务器IP
gwMacAddr	string	是	无	网关MAC地址
gwIp	string	是	无	网关IP
localPort	ushort	是	无	本地端口
signalLevel	uint	是	无	信号级别

SDKClientParam (v3.3.1及后续版本)

描述: 客户端参数
字段:

名称	类型	必填	默认值	描述
isAutoDetect	bool	是	true	是否自动检测
downloadPkgSize	ushort	是	无	下载数据包大小 byte
downloadBitrate	uint	是	无	下载速率 bps
uploadPkgSize	ushort	是	无	上传数据包大小 byte
uploadBitrate	uint	是	无	上传速率 bps
isUdp	bool	是	true	是否使用UDP
startBitrate	uint	是	无	比特率
userId	ulong	是	无	用户ID
serverPort	ushort	是	无	探测Server端口
serverIp	string	是	无	探测Server地址
gwMacAddr	string	是	无	网关MAC地址
gwIp	string	是	无	网关

SDKConfAudioMuteState

用途: 会控音频禁音状态

枚举值:

枚举值	描述
Mute	麦克风关闭
Unmute	麦克风开启
ForceMute	强制麦克风关闭
UnKown	未知(无需处理)

SDKConfDevInfo

描述: 参会设备信息
字段:

名称	类型	必填	默认值	描述
deviceId	string	是	无	设备Id
devType	int	是	无	设备类型

SDKConfig

描述: SDK配置参数
字段:

名称	类型	必填	默认值	描述
clientId	string	是	无	应用Id
clientSecret	string	是	无	秘钥
httpProxy	SDKProxy	是	无	HTTP代理
udpProxy	SDKProxy	是	无	udp转发服务器
loginServer	string	是	无	登录服务器
enableThumbVdieo360p	bool	是	true	1+N自动布局模式下，小视频窗口请求360p
maxSendVideoResolution	SDKMaxVideoResolution	是	MaxVidResUnkwon	最大视频发送分辨率
maxRecvVideoResolution	SDKMaxVideoResolution	是	MaxVidResUnkwon	最大视频接收分辨率
maxVideoFrameRate	SDKMaxVideoFrameRate	是	MaxVideoFrameRateUnknown	最大视频帧率
layoutMode	SDKLayoutMode	是	Layout_1_Plus_N	布局模式
checkAiCaption	bool	是	false	检测是否支持同传字幕

SDKConfManagmentState

描述: 会议控制状态信息
字段:

名称	类型	必填	默认值	描述
muteOperationDisabled	bool	是	无	mute operation is disabled by admin
contentOperationDisabled	bool	是	无	content operation is disabled by admin
whiteboardIsDisabled	bool	是	无	whiteboard operation is disabled by admin
audioMuteState	SDKConfAudioMuteState	是	UnKown	音频禁音状态
muteSpeakerState	SDKConfSpeakerMuteState	是	Keep	扬声器禁音状态
isChairmanMode	bool	是	无	是否是主会场模式
chairmanUri	string	是	无	主席URI
annotationDisabled	bool	是	无	标注是否禁用

SDKConfMgmtAnswerPublish

描述: 会议管理答题发布
字段:

名称	类型	必填	默认值	描述
questionnaireId	string	是	无	问卷ID
conferenceNo	string	是	无	会议号
conferenceName	string	是	无	会议名称
meetingId	string	是	无	会议ID
voteType	int	是	无	投票类型
webViewUrl	string	是	无	Web视图URL
newWebViewUrl	string	是	无	新Web视图URL

SDKConfMgmtVoteSignature

描述: 会议管理投票签名
字段:

名称	类型	必填	默认值	描述
questionnaireId	string	是	无	问卷ID
conferenceNo	string	是	无	会议号
conferenceName	string	是	无	会议名称
meetingId	string	是	无	会议ID
duration	long	是	无	持续时间
endAuto	bool	是	无	是否自动结束
supportFace	bool	是	无	是否支持人脸
supportScan	bool	是	无	是否支持扫描
faceCheckInSupport	bool	是	无	是否支持人脸签到
displayResult	bool	是	无	是否显示结果
faceType	FaceTypeEnum	是	Unknown	人脸类型
voteType	int	是	无	投票类型
url	string	是	无	URL
webViewUrl	string	是	无	Web视图URL
newWebViewUrl	string	是	无	新Web视图URL
stop	bool	是	false	是否停止
storeTime	DateTime	是	无	存储时间
storeDuration	long	是	无	存储持续时间
sourceId	string	是	无	源ID
sourceType	int	是	无	源类型
sourceName	string	是	无	源名称
shortUrl	string	是	无	短URL
endUtcTime	long	是	无	结束UTC时间

SDKConfMgmtVoteSignatureUser

描述: 会议管理投票签名用户
字段:

名称	类型	必填	默认值	描述
questionnaireId	string	是	无	问卷ID
conferenceNo	string	是	无	会议号
meetingId	string	是	无	会议ID
deviceId	string	是	无	设备ID
deviceLogo	string	是	无	设备Logo
deviceName	string	是	无	设备名称
deviceNumber	string	是	无	设备号码
answerType	string	是	无	答案类型
faceType	int	是	无	人脸类型
lifeDetection	bool	是	无	活体检测
avatar	string	是	无	头像
tag	int	是	无	标签
type	int	是	0	类型
faceId	int	是	无	人脸ID
userId	int	是	无	用户ID

SDKConfSpeakerMuteState

用途: 会控收听禁用状态

枚举值:

枚举值	描述
On	开启
Off	关闭
Keep	保持

SDKContentState

用途: 内容共享状态

枚举值:

枚举值	描述
Idle	空闲
Sending	共享中
Receiving	接收中
NoBandwidth	发送带宽不足，可以提示用户关闭共享
Error	错误

SDKCustomLayoutElement

描述: 自定义布局元素信息
字段:

名称	类型	必填	默认值	描述
participantId	UInt32	是	无	与会者ID
width	UInt32	是	无	宽度
height	UInt32	是	无	高度
priority	SDKLayoutPriority	是	无	优先级
quality	SDKVideoQuality	是	无	视频质量

SDKCustomLayoutInfo

描述: 自定义布局信息
字段:

名称	类型	必填	默认值	描述
layoutMode	SDKLayoutMode	是	无	布局模式
layoutElements	SDKCustomLayoutElement[]	是	无	布局元素

SDKDetectResult

描述: 检测结果
字段:

名称	类型	必填	默认值	描述
sendQualityLevel	uint	是	无	发送质量级别
recvQualityLevel	uint	是	无	接收质量级别
userId	ulong	是	无	用户ID
networkId	string	是	无	网络ID
endpointId	uint	是	无	端点ID
runningTime	ulong	是	无	运行时间
remoteIp	string	是	无	远程IP
isAutoTest	bool	是	无	是否自动测试
serverIp	string	是	无	服务器IP
serverPort	uint	是	无	服务器端口

SDKDetectResultDetail

描述: 检测结果详情
字段:

名称	类型	必填	默认值	描述
setBandwidth	uint	是	无	设置带宽
bandwidth	uint	是	无	带宽
lostRate	uint	是	无	丢包率
jitter	uint	是	无	抖动
rtt	uint	是	无	往返时间
missorder	uint	是	无	乱序
pktNum	uint	是	无	包数量

SDKDeviceEvent

用途: 媒体设备事件

枚举值:

枚举值	描述
Added	设备插入
Removed	设备拔出
Lost	设备丢失
eDefaultDevChanged	默认设备变更
eChooseDevFailed	选择设备失败
eChooseDevSucceed	选择设备成功

SDKDeviceEventParam

描述: 设备事件参数
字段:

名称	类型	必填	默认值	描述
devType	SDKMediaDevType	是	无	设备类型
evt	SDKDeviceEvent	是	无	事件
cameraOrdinal	SDKCameraOrdinal	是	无	相机序号
devId	string	是	无	设备ID

SDKDeviceType

用途: 设备类型

枚举值:

枚举值	描述
DT_SOFT	软终端
DT_HARD	硬终端
DT_BROWSER	浏览器
DT_TEL	电话
DT_RECORD	录制
DT_DESKTOP	桌面
DT_H323GW	H323网关
DT_BRUCE	BRUCE
DT_TVBOX	TVBOX
DT_CONFNO	会议号
DT_SHUTTLE	穿梭
DT_UNKNOWN	未知

SDKDisplay

描述: 显示信息
字段:

名称	类型	必填	默认值	描述
remoteIp	string	是	无	远程IP
size	uint	是	无	大小
rtt	uint	是	无	往返时间
sendTTL	uint	是	无	发送TTL
recvTTL	uint	是	无	接收TTL
seq	uint	是	无	序列号

SDKDrawLineResponseData

描述: 白板数据
字段:

名称	类型	必填	默认值	描述
type	int	是	无	类型
id	string	是	无	ID
seq	int	是	无	序列号
c	int	是	无	颜色
cid	string	是	无	颜色ID
p	SDKWhiteboardPoint[]	是	无	点数组

SDKError

用途: SDK错误类型

枚举值:

枚举值	描述
XYSDK940000	成功
XYSDK940001	SDK文件校验失败
XYSDK940002	token过期
XYSDK940003	refresh_token过期
XYSDK940004	接口访问未进行token验证
XYSDK940005	api网关签名异常
XYSDK940006	正在进行中(网络探测)
XYSDK940201	企业ID认证失败
XYSDK940202	未登录
XYSDK940203	登录无效的第三方用户ID
XYSDK940204	账户已停用
XYSDK940205	认证授权码不合法
XYSDK940206	认证授权码已被使用
XYSDK940207	认证授权码已过期
XYSDK940208	未知登录方式
XYSDK940209	用户名称不合法
XYSDK940210	无效账号/密码
XYSDK940301	呼叫状态错误
XYSDK940302	呼叫密码错误
XYSDK940400	输入参数不合法
XYSDK940401	输入参数异常,会议号无效
XYSDK940402	输入参数异常,无效netProtocol
XYSDK940403	输入参数异常,直播不存在/直播id错误
XYSDK940404	输入参数异常,直播不属于该企业
XYSDK940405	输入参数异常,无效的直播id
XYSDK940501	网络异常
XYSDK940502	服务器错误
XYSDK940503	SDK卡住
XYSDK940504	SDK恢复正常
XYSDK940505	内网直播网络探测超时

SDKFECCCapability

用途: 远端摄像机的转动能力

枚举值:

枚举值	描述
FECC_CAP_NONE	无能力
FECC_CAP_HORIZONTAL	水平转动
FECC_CAP_VERTICAL	垂直转动
FECC_CAP_FRONT_BACK	前后转动
FECC_CAP_ZOOM	缩放

SDKFECCCommand

用途: 远端摄像机控制

枚举值:

枚举值	描述
FECC_TURN_LEFT	连续左转
FECC_STEP_LEFT	向左步进
FECC_TURN_RIGHT	连续右转
FECC_STEP_RIGHT	向右步进
FECC_TURN_STOP	水平转动停止
TILT_CAMERA_TURN_UP	向上抬起
TILT_CAMERA_STEP_UP	向上步进
TILT_CAMERA_TURN_DOWN	向下低头
TILT_CAMERA_STEP_DOWN	向下步进
TILT_CAMERA_TURN_STOP	垂直转动停止
FECC_ZOOM_IN	放大
FECC_ZOOM_OUT	缩小
FECC_STEP_ZOOM_IN	放大步进
FECC_STEP_ZOOM_OUT	缩小步进
FECC_ZOOM_TURN_STOP	缩放停止
FECC_UNKNOWN	未知

SDKIncomingCallInfo

描述: 被叫信息
字段:

名称	类型	必填	默认值	描述
remoteNumber	string	是	无	远端号码
remoteName	string	是	无	远端名称
callIndex	int	是	无	当前呼叫唯一标识
callMode	SDKCallMode	是	无	远端呼叫模式

SDKLayoutMode

用途: 视频布局模式

枚举值:

枚举值	描述
Layout_1_Plus_N	1个大画面 + N个小画面
Layout_M_by_N	对称模式 M X N 个小画面
Layout_Multi720P	多720P模式

SDKLayoutPriority

用途: 布局优先级

枚举值:

枚举值	描述
LayoutPriorityHigh	高优先级
LayoutPriorityNormal	普通优先级
LayoutPriorityLow	低优先级
LayoutPriorityUnknown	未知优先级

SDKLicenseInfo

描述: 许可证信息
字段:

名称	类型	必填	默认值	描述
expireDate	string	是	无	失效日期, format: yyyy-mm-dd
effectiveDays	int	是	无	有效天数

SDKLocalRecordBusinessInfo

描述: 本地录制者信息
字段:

名称	类型	必填	默认值	描述
title	String	是	无	标题
speaker	String	是	无	讲话者
confNum	String	是	无	会议号

SDKLocalRecording

描述: 本地录制
字段:

名称	类型	必填	默认值	描述
id	int	是	无	数据库记录ID
fileSize	int	是	无	文件大小
sequenceId	int	是	无	序列ID
needUpload	int	是	无	是否需要上传
isLastFile	int	是	无	是否是最后一个文件
eventId	String	是	无	事件ID
title	String	是	无	标题
speaker	String	是	无	讲话者
confNumber	String	是	无	会议号
recordingId	String	是	无	录制ID
recordingFiles	String	是	无	录制文件
timeStamp	long	是	无	时间戳

SDKLocalRecordMode

用途: 本地录制模式

枚举值:

枚举值	描述
LocalRecordMode_Film	电影模式
LocalRecordMode_Resources	资源模式(暂不支持)
LocalRecordMode_LayoutMux	布局混合模式(暂不支持)

SDKLocalRecordType

用途: 本地录制类型

枚举值:

枚举值	描述
LocalRecordType_NonCall	预留位(暂不支持)
LocalRecordType_Call	会中录制，退会后自动停止录制

SDKLoginInfo

描述: 登录后的用户信息
字段:

名称	类型	必填	默认值	描述
id	long	是	无	用户ID
userNumber	string	是	无	呼叫号码
userName	string	是	无	用户名称
securityKey	string	是	无	登录唯一标识
isDetectingNetworkTopology	bool	是	无	是否正在检测网络拓扑
confDevInfo	SDKConfDevInfo	是	无	会议设备信息

SDKLoginState

用途: 登录状态

枚举值:

枚举值	描述
LoggedIn	已登录
LoggingIn	登录中
LoggingOut	登出中
LoggedOut	已登出

SDKMaxVideoFrameRate

用途: 用来指定最大的视频能力

枚举值:

枚举值	描述
MaxVideoFrameRate30	视频最大帧率 30
MaxVideoFrameRate60	视频最大帧率 60
MaxVideoFrameRateUnknown	内部默认值

SDKMaxVideoResolution

用途: 用来指定最大的视频能力

枚举值:

枚举值	描述
MaxVidRes1080p	1920x1080
MaxVidRes720p	1280x720
MaxVidRes360p	640x360
MaxVidRes180p	320x180
MaxVidResUnkwon	内部默认值

SDKMediaDevInfo

描述: 媒体设备信息
字段:

名称	类型	必填	默认值	描述
devId	string	是	无	设备ID
devName	string	是	无	设备名称
devBusLocation	string	是	无	设备总线位置
videoInputLocked	bool	是	无	视频输入锁定状态
audioDevInfo	_AudioDevInfo	是	无	音频设备信息

SDKMediaDevType

用途: 音视频设备类型

枚举值:

枚举值	描述
Camera	相机
Microphone	麦克风
Speaker	扬声器
Unknown	未知

SDKMediaFileErrorCode

用途: 媒体文件分享错误码

枚举值:

枚举值	描述
MEDIA_FILE_NO_ERROR	无错误
MEDIA_FILE_ERROR_FILE	文件错误
MEDIA_FILE_ERROR_STREAM	流错误
MEDIA_FILE_ERROR_UNKNOW	未知错误

SDKMediaFileEvent

描述: 媒体文件分享事件
字段:

名称	类型	必填	默认值	描述
eventType	SDKMediaFileEventType	是	无	事件类型
errorCode	SDKMediaFileErrorCode	是	无	错误码
position	int	是	无	位置
duration	int	是	无	持续时间
videoWidth	int	是	无	视频宽度
videoHeight	int	是	无	视频高度
aspectRatioW	int	是	无	宽高比宽度
aspectRatioH	int	是	无	宽高比高度
hasVideo	bool	是	无	是否有视频
hasAudio	bool	是	无	是否有音频

SDKMediaFileEventType

用途: 媒体文件分享事件类型

枚举值:

枚举值	描述
MEDIA_FILE_PREPARE_DONE	媒体文件准备完成
MEDIA_FILE_ERROR	媒体文件分享错误
MEDIA_FILE_START	媒体文件分享开始
MEDIA_FILE_PAUSE	媒体文件分享暂停
MEDIA_FILE_STOP	媒体文件分享停止
MEDIA_FILE_PROGRESS	媒体文件分享进行中

SDKMediaFileInfo

描述: 分享的媒体文件信息
字段:

名称	类型	必填	默认值	描述
type	SDKMediaFileType	是	无	类型
width	int	是	无	宽度
height	int	是	无	高度

SDKMediaFileType

用途: 媒体文件分享类型

枚举值:

枚举值	描述
MEDIA_FILE_TYPE_NONE	无
MEDIA_FILE_TYPE_AUDIO_ONLY	仅音频
MEDIA_FILE_TYPE_VIDEO_ONLY	仅视频
MEDIA_FILE_TYPE_AUDIO_VIDEO	音频和视频

SDKMeetingRoomInfo

描述: 和登录账号绑定的云会议室的信息
字段:

名称	类型	必填	默认值	描述
meetingRoomNumber	string	是	无	会议室号码
roomPassword	string	是	无	会议室密码

好的,我继续格式化剩余的类:

SDKMonitorInfo

描述: 显示器信息，用于桌面共享
字段:

名称	类型	必填	默认值	描述
monitorName	string	是	无	显示器名称
monitorRect	System.Drawing.Rectangle	是	无	显示器矩形区域

SDKMuteReason

用途: 被禁音原因

枚举值:

枚举值	描述
MuteByUser	用户禁音
MuteByBWLimit	带宽限制禁音
MuteByNoInput	无输入禁音
MuteByConfMgmt	会议管理禁音

SDKNetToolServerResponse

描述: 网络工具服务器响应
字段:

名称	类型	必填	默认值	描述
netTestServer	string	是	无	网络测试服务器

SDKNetToolServerResponse (v3.3.1及后续版本)

描述: 网络工具服务器响应
字段:

名称	类型	必填	默认值	描述
netTestServer	string	是	无	网络测试服务器

SDKLocalRecordCode

用途: 本地录制错误码

枚举值:

枚举值	描述
SDKLocalRecordCode_OK	成功
SDKLocalRecordCode_NotSupport	不支持本地录制
SDKLocalRecordCode_NoInCall	未在会议
SDKLocalRecordCode_NoSpace	存储空间不足
SDKLocalRecordCode_AlreadyInRecord	已经在录制中
SDKLocalRecordCode_NoWritePermission	存储目录没有写入权限
SDKLocalRecordCode_Unkonwn	未知错误

SDKNotifyRecvedCommandMetaData

描述: 通知接收命令元数据
字段:

名称	类型	必填	默认值	描述
type	int	是	无	标注类型
cid	string	是	无	线ID

SDKNotifyType

用途: 数据上报类型

枚举值:

枚举值	描述
Notify	通知
Statistics	统计
Unknown	未知

SDKPathItem

描述: 路径项
字段:

名称	类型	必填	默认值	描述
sitePathId	string	是	无	站点路径ID
provider	string	是	无	提供商
networkType	string	是	无	网络类型

SDKPathItem (v3.3.1及后续版本)

描述: 路径项
字段:

名称	类型	必填	默认值	描述
sitePathId	string	是	无	站点路径ID
provider	string	是	无	提供商
networkType	string	是	无	网络类型
netToolServer	string	是	无	网络工具服务器

SDKPingError

用途: ping错误

枚举值:

枚举值	描述
SDKPingNoError	无错误
SDKPingDnsError	DNS错误
SDKPingDstError	目标错误
SDKPingGetGWError	获取网关错误

SDKPingException

描述: ping异常
字段:

名称	类型	必填	默认值	描述
pingError	SDKPingError	是	无	ping错误

SDKPingResult

描述: ping结果
字段:

名称	类型	必填	默认值	描述
targetIp	string	是	无	目标IP
interval	int	是	无	间隔
totalPktNum	int	是	无	总包数
lostRate	double	是	无	丢包率
avrRtt	double	是	无	平均往返时间
minRtt	double	是	无	最小往返时间
maxRtt	double	是	无	最大往返时间
stdRtt	double	是	无	标准差往返时间
errorString	string	是	无	错误字符串
isPingGw	bool	是	无	是否ping网关

SDKProxy

描述: 代理服务器地址
字段:

名称	类型	必填	默认值	描述
hostAddress	string	是	无	主机地址
port	ushort	是	无	端口

SDKRecordAuthor

描述: 录制作者
字段:

名称	类型	必填	默认值	描述
authorize	bool	是	无	是否授权
recordingUrl	string	是	无	录制URL

SDKRecordingStateManaged

用途: 录制状态

枚举值:

枚举值	描述
RECORDING_STATE_IDLE	空闲状态
RECORDING_STATE_STARTING	开始状态
RECORDING_STATE_ACTING	活动状态
RECORDING_STATE_STOPING	停止状态
RECORDING_STATE_INACT	非活动状态

SDKRecordLayout

描述: 录制布局
字段:

名称	类型	必填	默认值	描述
canvasAspectWidth	int	是	无	画布宽高比宽度
canvasAspectHeight	int	是	无	画布宽高比高度
elements	SDKRecordLayoutElement[]	是	无	窗口列表

SDKRecordLayoutElement

描述: 录制布局元素
字段:

名称	类型	必填	默认值	描述
sourceInfo	SDKVideoSourceInfo	是	无	视频源信息
displayName	String	是	无	显示名称
isVideoReceived	bool	是	无	是否视频接收
isAudioMute	bool	是	无	是否音频静音
left	float	是	无	左边距
top	float	是	无	上边距
width	float	是	无	宽度
height	float	是	无	高度
active	bool	是	无	当前活跃

SDKRecordStateChangedManaged

描述: 录制状态变化
字段:

名称	类型	必填	默认值	描述
remoteUri	string	是	无	远程URI
state	SDKRecordingStateManaged	是	无	录制状态
reason	string	是	无	原因
isRecorded	bool	是	无	是否已录制

SDKRecordStateNotifyInfo

描述: SDK录制通知信息
字段:

名称	类型	必填	默认值	描述
callIndex	int	是	无	呼叫索引
isStart	bool	是	无	是否已启动录制
uri	string	是	无	URI
callUri	string	是	无	呼叫URI
status	string	是	无	状态

SDKReminderInfo

描述: 提醒信息
字段:

名称	类型	必填	默认值	描述
remotename	string	是	无	远程名称
reminderType	string	是	无	提醒类型
extUserId	string	是	无	外部用户ID

SDKRosterElement

描述: ROSTER元素信息
字段:

名称	类型	必填	默认值	描述
participantId	UInt32	是	无	与会者ID
feccOri	UInt32	是	无	远端摄像头的转动能力
deviceAlias	string	是	无	与会者呼叫号码
deviceName	string	是	无	与会者显示名称
deviceId	string	是	无	calluri
deviceType	SDKDeviceType	是	无	远端设备类型
extUserId	string	是	无	第三方用户ID
videoMuteReason	SDKMuteReason	是	无	视频禁音原因
isTelephone	bool	是	无	是否是电话
isObserver	bool	是	无	是否是观察者
isAudioOnly	bool	是	无	是否是语音模式
isAudioMute	bool	是	无	是否音频静音
isVideoMute	bool	是	无	是否视频静音
isForceFullScreen	bool	是	无	是否强制全屏
isRequested	bool	是	无	是否是requestRoster请求结果返回的

SDKRosterInfo

描述: ROSTER信息
字段:

名称	类型	必填	默认值	描述
contentSenderPid	UInt32	是	无	内容发送者ID
activeSpeakerPid	UInt32	是	无	活跃讲话者ID
recvingVideoContent	bool	是	无	是否接收视频内容
recvingPictureContent	bool	是	无	是否接收图片内容
hasOtherParticipants	bool	是	无	是否有其他参与者
totalParticipants	uint	是	无	总参与者数
elementsMap	Dictionary	是	无	元素映射

SDKRotationType

用途: 本地视频画面翻转

枚举值:

枚举值	描述
Rotation0	0度旋转
Rotation90	90度旋转
Rotation180	180度旋转
Rotation270	270度旋转

SDKRotationType (重复定义)

用途: 本地视频画面翻转

枚举值:

枚举值	描述
Rotation0	0度旋转
Rotation90	90度旋转
Rotation180	180度旋转
Rotation270	270度旋转

SDKRouteItem

描述: 路由项
字段:

名称	类型	必填	默认值	描述
displayName	string	是	无	显示名称
currentSitePathId	string	是	无	当前站点路径ID
locationOfSiteCode	string	是	无	站点代码位置

SDKRouteOptionsResponse

描述: 路由选项响应
字段:

名称	类型	必填	默认值	描述
currentSitePathId	string	是	无	当前站点路径ID
siteList	List	是	无	站点列表

SDKShareState

用途: 内容共享状态

枚举值:

枚举值	描述
Idle	空闲
Sending	共享中
Receiving	接收中
NoBandwidth	发送带宽不足，可以提示用户关闭共享
Error	错误

SDKSignResponse

描述: 签名响应
字段:

名称	类型	必填	默认值	描述
status	string	是	无	状态
data	string	是	无	数据

SDKSiteItem

描述: 站点项
字段:

名称	类型	必填	默认值	描述
displayName	string	是	无	显示名称
enterpriseId	string	是	无	企业ID
enterpriseOfSiteCode	string	是	无	站点代码企业
locationOfSiteCode	string	是	无	站点代码位置
sublocationOfSiteCode	string	是	无	站点代码子位置
pathList	List	是	无	路径列表
currentSitePathId	string	是	无	当前站点路径ID

SDKStateInfo

描述: 状态信息
字段:

名称	类型	必填	默认值	描述
isSend	bool	是	无	是否发送
endpointId	uint	是	无	端点ID
detailResult	SDKDetectResultDetail	是	无	详细结果

SDKStatistics

描述: 呼叫中统计信息
字段:

名称	类型	必填	默认值	描述
people	MediaInfo	是	无	与会者媒体信息
content	MediaInfo	是	无	内容共享媒体信息
networkInfo	NetworkInfo	是	无	网络状况信息

SDKTracerouteResult

描述: 路由跟踪结果
字段:

名称	类型	必填	默认值	描述
targetIp	string	是	无	目标IP
maxHop	int	是	无	最大跳数
hopVector	SDKTracertRecoder[][]	是	无	跳数向量

SDKTracertRecoder

描述: 路由跟踪记录
字段:

名称	类型	必填	默认值	描述
hopIp	string	是	无	跳数IP
time	string	是	无	时间

SDKVideoData

描述: 视频数据内容
字段:

名称	类型	必填	默认值	描述
isContent	bool	是	无	是否为内容
width	UInt32	是	无	宽度
height	UInt32	是	无	高度
stride	UInt32	是	无	行扫字节数
format	SDKVideoType	是	无	视频格式
timeStamp	UInt64	是	无	时间戳
dataPtr	IntPtr	是	无	数据指针

SDKVideoQuality

用途: 请求视频质量

枚举值:

枚举值	描述
VideoQualityHigh	高质量
VideoQualityNormal	普通质量
VideoQualityBase	基础质量
VideoQualityUnknown	未知质量

SDKVideoResolution

用途: 视频分辨率

枚举值:

枚举值	描述
VideoResolution90P	90P(暂不支持)
VideoResolution180P	180P 有效帧率:15fps
VideoResolution360P	360P 有效帧率:15fps\|30fps
VideoResolution720P	720P 有效帧率:15fps\|30fps
VideoResolution1080P	1080P 有效帧率:15fps\|30fps\|60fps
VideoResolution4K	4k 有效帧率:30fps
VideoResolutionUnknown	未知分辨率

SDKVideoSourceInfo

描述: 视频源信息
字段:

名称	类型	必填	默认值	描述
sourceId	String	是	无	源ID
channelId	int	是	无	通道ID
bLocalVideoSource	bool	是	无	是否本地视频源
bContent	bool	是	无	是否为共享

SDKVideoState

用途: 视频流状态

枚举值:

枚举值	描述
Observing	观察中
VideoMute	视频静音
Requesting	请求中
NoBandwidth	无带宽
NoDecoder	无解码器
Received	已接收
Telephone	电话
AudioOnly	仅音频
NoCpuResource	无CPU资源
Idle	空闲

SDKVideoStreamInfo

描述: 呼叫中的远端的视频流信息
字段:

名称	类型	必填	默认值	描述
videoState	SDKVideoState	是	无	视频状态
videoSourceId	string	是	无	视频源ID
displayName	string	是	无	显示名称
userNumber	string	是	无	呼叫号码
extUserId	string	是	无	三方ID
participantId	uint	是	无	与会者ID
audioMute	bool	是	无	是否音频静音
isContent	bool	是	无	是否为内容
feccOri	uint	是	无	远端摄像头的转动能力
receiveAudioOnly	bool	是	false	标识远端是否主动改变语音模式
remoteID	string	是	无	远程ID
remoteType	SDKDeviceType	是	无	远程类型
videoHeight	uint	是	无	视频高度
videoWidth	uint	是	无	视频宽度

SDKVideoType

用途: 外部输入视频格式

枚举值:

枚举值	描述
YUY2	YUY2格式
NV12	NV12格式

SDKWhiteboardStateInfoManaged

描述: 白板状态
字段:

名称	类型	必填	默认值	描述
callIndex	int	是	无	呼叫索引
data	string	是	无	数据
reason	string	是	无	原因

SDKWSConnectionStatus

描述: 白板与服务端连接状态
字段:

名称	类型	必填	默认值	描述
IsConnected	bool	是	无	是否已连接
ErrorCode	int	是	无	错误码
LocalIP	string	是	无	本地IP

2025-04-24 14:58:41

导出PDF文档