开发者中心 - 小鱼易连

Settings

描述：SDK初始化对象

字段：

名称	类型	必填	默认值	描述
extID	String	是	无	企业ID，管理平台获取
clientId	String	否	无	ClientId，注册SDK应用获取
clientSecret	String	否	无	ClientSecret，注册SDK应用获取
isDebug	boolean	否	false	调试模式
privateCloudAddress	String	否	无	服务器地址, 公有云环境默认sdkapi.xylink.com，如果非鉴权使用需要设置cloud.xylink.com，私有云需要设置对应的服务器地址
privateHttpsPort	String	否	无	服务器端口号，默认443
logFilePath	String	否	无	日志文件输出路径
logFileName	String	否	无	日志文件命名
enableLog	boolean	否	true	是否输出日志
logFileNum	int	否	10	日志文件数量，0-10之间
enableAudioPeakMeter	boolean	否	false	音频旁路
defaultCameraId	int	否	1	默认摄像头id
uiNeedSpeakers	boolean	否	fasle	会中三位发言者
enableFaceRecognize	boolean	否	false	人脸识别
enableVirtualBg	boolean	否	false	虚拟背景
enableAiCaption	boolean	否	false	字幕
defaultSpeakerDevice	int	否	0	默认音频输出设备
SocksProxyIp	String	否	无	代理ip
SocksProxyPort	String	否	无	代理端口
SocksProxyUserName	String	否	无	代理账户
SocksProxyPassword	String	否	无	代理账户密码
enableAudioDump	boolean	否	false	开启音频Dump
enableVideoDump	boolean	否	false	开启视频Dump
enablePutAudioRaw	boolean	否	false	下发音频源数据
enablePutVideoRaw	boolean	否	false	下发视频源数据

LoginResponseData

描述：登录对象

字段：

名称	类型	必填	默认值	描述
userId	long	是	无	用户ID
deviceId	long	是	无	用户设备ID
callNumber	String	是	无	用户呼叫号码
cellPhone	String	是	无	手机号
deviceUri	String	是	无	用户callUri
deviceDisplayName	String	是	无	用户设备名称
tokenInfo	TokenInfo	否	无	token信息

TokenInfo

描述：token信息对象

字段：

名称	类型	必填	默认值	描述
accessToken	String	是	无	鉴权token参数
refreshToken	String	是	无	刷新token参数
expires	long	是	无	过期时间

CallState

描述：会议状态

enum CallState {
     CONNECTING, //会议链接中
     CONNECTED,   //会议链接成功
     WAITING,     //等候室模式
     DISCONNECTED //会议断开
}

VideoInfo

描述：参会者请流信息

字段：

名称	类型	必填	默认值	描述
dataSourceID	String	是	无	视频流id
remoteName	String	是	无	参会者昵称
participantId	long	是	无	参会者会中唯一id
remoteID	String	是	无	参会者callUri
isContent	boolean	是	无	是否为共享流
isVideoMute	boolean	是	无	视频关闭
isAudioMute	boolean	是	无	音频关闭
isAudioOnly	boolean	是	无	语音模式
isActiveSpeaker	boolean	是	无	激活的发言者
layoutVideoState	String	是	无	视频流状态 kLayoutStateMute：视频流关闭 kLayoutStateRequesting：视频流请求中 kLayoutStateIdle：视频流暂停 kLayoutStateNoDecoder：解码失败，视频播放异常 kLayoutStateNoBandwidth：带宽不足，视频播放异常 kLayoutStateReceived：视频接收成功 kLayoutStateTelephone：pstn
videoMuteReason	String	是	无	视频流关闭原因 MuteByUser：用户关闭视频 MuteByBWLimit：带宽不足，视频关闭 MuteByPhoneCall：收到系统来电，视频关闭
remoteAlias	String	是	无	参会者别名
videoWidth	int	是	无	视频流宽度
videoHeight	int	是	无	视频流高度
oriWidth	int	是	无	视频流原始宽度
oriHeight	int	是	无	视频流原始高度
extUserId	String	是	无	参会者三方用户id
feccOri	int	是	无	硬件参会者摄像头属性

RosterWrapper

描述：参会者信息

字段：

名称	类型	必填	默认值	描述
participantsNum	int	是	无	-
participantsPeopleNum	int	是	无	参会者人数，不包含自己
contentTotalNum	int	是	无	会中共享数量
rosters	List<Roster>	是	无	参会者信息集合
contentRoster	List<Roster>	是	无	共享信息集合

Roster

描述：参会者信息对象

字段：

名称	类型	必填	默认值	描述
participantId	int	是	无	参会者会中唯一id
deviceId	String	是	无	参会者callUri
deviceName	String	是	无	参会者昵称
isContent	boolean	是	无	是否共享路
isAnnotationEnable	boolean	是	无	是否允许标注
extUserId	String	是	无	三方用户id

ConfMgmtState

描述：会控信息

字段：

名称	类型	必填	默认值	描述
callIndex	int	是	无	会议callIndex
operation	String	是	无	"mute" 执行静音操作，"unmute" 执行取消静音操作
confRole	int	是	无	0:主席，1：发言人，2:普通参会者
muteIsDisabled	boolean	是	无	isMuteIsDisabled true 强制静音，false 非强制静音。强制静音模式时可举手发言、取消举手、结束发言
feccIsDisabled	boolean	是	无	fecc可用/禁用
contentIsDisabled	boolean	是	无	content可用/禁用
recordIsDisabled	boolean	是	无	录制可用/禁用
whiteboardIsDisabled	boolean	是	无	白板可用/禁用
pictureIsDisabled	boolean	是	无	共享图片可用/禁用
annotationIsDisabled	boolean	是	无	标注可用/禁用
chairmanUri	String	是	无	主会场模式主会场参会者callUri
uriReason	String	是	无	主会场参会者异常错误码
isMuteSpeaker	boolean	是	无	是否禁止收听
reName	String	是	无	会中改名

ConfRecordState

描述：录制信息

字段：

名称	类型	必填	默认值	描述
callIndex	int	是	无	会议callIndex
callUri	String	是	无	录制发起人callUri
isRecordingOwner	boolean	是	无	自己是否为录制发起人
displayName	String	是	无	录制发起人昵称
state	RecordingState	是	无	录制状态
reason	String	是	无	录制异常错误码

AudioMeter

描述：参会者音频能量信息

字段：

名称	类型	必填	默认值	描述
participantId	long	是	无	参会者会中唯一id
energy	int	是	无	音频能量值

RecordingState

描述：录制状态

public enum RecordingState {
    RECORDING_STATE_IDLE, //录制停止
    RECORDING_STATE_STARTING, //录制开启中
    RECORDING_STATE_ACTING, //录制开始
    RECORDING_STATE_STOPING, //录制结束中
    RECORDING_STATE_INACT, //
    RECORDING_STATE_PAUSED //录制暂停
}

NemoDualState

描述：共享状态

public enum NemoDualState {
    NEMO_DUAL_STAT_IDLE,  //共享停止
    NEMO_DUAL_STATE_RECEIVING, //共享接收中
    NEMO_DUAL_STATE_UNKNOWN, //未知原因，共享中断
    NEMO_DUAL_STATE_NOBANDWIDTH //带宽不足，共享中断
}

AIParam

描述：人脸识别信息

字段：

名称	类型	必填	默认值	描述
participantId	long	是	无	参会者会中唯一id
type	int	是	无	0: 人脸检测， 1：人脸跟踪， 2: 电子铭牌信息
seq	int	是	无	消息序列号
callUri	String	是	无	参会者callUri
positionVec	List<FacePosition>	是	无	人脸坐标信息

FacePosition

描述：人脸坐标信息

字段：

名称	类型	必填	默认值	描述
faceId	long	是	无	人脸id
left	float	是	无	left坐标
top	float	是	无	top坐标
right	float	是	无	right坐标
bottom	float	是	无	bottom坐标

备注：

提示

换算方式：

double dstLeft= (当前layoutcell.mWidth * FaceAreaPostion.left) / 10000.0;

double dstRight = (当前layoutcell.mWidth * FaceAreaPostion.right) / 10000.0;

double dstTop = (当前layoutcell.mHeight * FaceAreaPostion.top) / 10000.0;

double dstBottom = (当前layoutcell.mHeight * FaceAreaPostion.bottom) / 10000.0;

AICaptionInfo

描述：字幕信息

字段：

名称	类型	必填	默认值	描述
pid	long	是	无	参会者会中唯一id
src	String	是	无	源语言
target	String	是	无	翻译的语言
isEnd	boolean	是	无	是否翻译结束
dn	String	是	无	发言人昵称
srcLang	String	是	无	源语言语言类型zh/en
targetLang	String	是	无	翻译后语言类型
seTime	long	是	无	-
endTime	long	是	无	结束时间
startTime	long	是	无	起始时间
isActive	boolean	是	无	-
url	String	是	无	参会者callUri
meetingId	String	是	无	会议id

CallInviteInfo

描述：来电信息

字段：

名称	类型	必填	默认值	描述
callIndex	int	是	无	会议callIndex
remoteName	String	是	无	来电方昵称
remoteUri	String	是	无	来电方callUri
remoteDeviceType	String	是	无	来电方设备类型
callerNumber	String	是	无	来电方号码
callMode	CallMode	是	无	来电方会议类型
displayNum	String	是	无	来电方显示号码
groupvc	String	是	无	群组号码

CallMode

描述：会议模式

public enum CallMode {
    CallMode_AudioVideo, //视频模式
    CallMode_AudioOnly, //语音模式
    CallMode_Observer,
    CallMode_Observed,
    CallMode_ContentOnly,
    CallMode_Tel;
}

Speaker

描述：会中发言者

字段：

名称	类型	必填	默认值	描述
callUri	String	是	无	参会者callUri
energyAverage	int	是	无	能量值
participantId	long	是	无	参会者会中唯一id
extUserId	String	是	无	三方用户id

VideoStreamInfo

描述：参会者视频流信息

字段：

名称	类型	必填	默认值	描述
participantId	int	是	无	参会者会中唯一id
width	int	是	无	视频宽度
height	int	是	无	视频高度
originalWidth	int	是	无	视频原始宽度
originalHeight	int	是	否	视频原始高度

InOutMeetingInfo

描述：出入会参会者信息

字段：

名称	类型	必填	默认值	描述
extUserId	String	是	无	三方用户id
name	String	是	无	参会者昵称
type	String	是	无	类型 in：假如会议，out：离开会议

BulkRosterWrapper

描述：全量参会者信息

字段：

名称	类型	必填	默认值	描述
rosterType	int	是	无	0：全量信息，1：增量信息
sessionId	int	是	无	1：people，0：content
totalEpNum	int	是	无	会中参会者总数
addRosters	List<BulkRoster>	是	无	参会者增量信息，如果rosterType为0则为当前会中全量信息，否则为增量信息
changeRosters	List<BulkRoster>	是	无	参会者变更信息，rosterType为1下下发
deleteRosters	List	是	无	参会者移除信息，rosterType为1下下发

BulkRoster

描述：参会者信息

字段：

名称	类型	必填	默认值	描述
participantId	long	是	无	参会者会中唯一id
deviceId	String	是	无	参会者callUri
deviceName	String	是	无	参会者昵称
deviceAlias	String	是	无	参会者别名
deviceType	String	是	无	参会者设备类型
isAudioMute	boolean	是	无	音频静音
isVideoMute	boolean	是	无	视频关闭
onHold	boolean	是	无	等待模式

FECCCommand

描述：fecc遥控指令

public enum FECCCommand {
    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;
}

BeautyType

描述：美颜特效类型

public @interface BeautyType {
    String NONE = "BeautyNone"; //无
    String DERMABRASION = "Smooth"; //磨皮
    String WHITENING = "Whiten";//美白
    String RUDDY = "Blush";//红润
}

FilterType

描述：滤镜特效类型

public @interface FilterType {
    String NONE = "FilterNone"; //无
    String LACONIC = "Concise"; //简洁
    String NATURAL = "Natural"; //自然
    String EXQUISITE = "Exquisite"; //精致
    String PEACEFUL = "Peaceful"; //宁静
    String SOFT = "Soft"; //柔和
    String LIGHT_LUXURY = "LightLuxury"; //轻奢
    String YOUTH = "Youth"; //青春
    String AFTER_RAIN = "Rain"; //雨后
    String CAMPUS = "Campus"; //校园
    String ENTHUSIASM = "Warmth";//热情
    String FRESH = "Refreshing"; //清新
    String GALAXY = "Galaxy"; //银河
    String CLEAR = "Pure"; //清澈
    String MORNING = "Dawn"; //清晨
    String DREAM = "Dream"; //梦幻
    String HIGHLIGHT = "Highlight"; //高光
    String ELEGANT = "Elegant"; //典雅
    String REPLACEMENT = "Nostalgia"; //怀旧
    String DARK_TONE = "Dark"; //暗调
    String OLD_FILM = "Retro"; //老电影
}

VoteStartResponse

描述：会控事件开始信息

字段：

名称	类型	必填	默认值	描述
endAuto	boolean	是	无	会控事件是否自动结束
duration	int	是	无	倒计时时长单位：秒
conferenceName	String	是	无	会议室名称
voteType	int	是	无	会控事件类型 2：签到，3：答题
questionnaireId	String	是	无	会控事件id
meetingId	String	是	无	会议id
conferenceNo	String	是	无	会议号码
processType				答题web所需参数

VoteStopResponse

描述：会控事件结束信息

字段：

名称	类型	必填	默认值	描述
endUtcTime	long	是	无	会控事件结束时间单位：毫秒
voteType	int	是	无	会控事件类型 2：签到，3：答题
questionnaireId	String	是	无	会控事件id
meetingId	String	是	无	会议id
conferenceNo	String	是	无	会议号码

SignResultResponse

描述：会控签到结束信息

字段：

名称

类型

必填

默认值

描述

status

String

是

无

签到结果，参考：

String SUCCESS = "SUCCESS"; // 系统发生未知错误

String UNKNOWN_ERROR = "UNKNOWN_ERROR"; // 系统发生未知错误

String INVALID_INPUT = "INVALID_INPUT"; // 签到参数有误，请稍后重试

String INVALID_USER_ID = "INVALID_USER_ID"; // 无效的用户ID，请您重新登录小鱼易连客户端进行签到

String INVALID_ENTERPRISE_ID = "INVALID_ENTERPRISE_ID"; // ？？？这个是啥情况下会出现？？？

String INVALID_CONFERENCE_NO = "INVALID_CONFERENCE_NO"; // 无效的云会议号码，请稍后重试

String INVALID_MEETING_ID = "INVALID_MEETING_ID";// 无效的会议ID，请稍后重试

String SERVER_EXCEPTION = "SERVER_EXCEPTION";// 服务器内部错误，请稍后重试

String VOTE_NOT_FOUND = "VOTE_NOT_FOUND";// 无效的签到，请稍后重试

String VOTE_EXPIRED = "VOTE_EXPIRED";// 签到已结束，请在主持人下次发起时再进行签到

String VOTE_DELETED = "VOTE_DELETED";// 签到已删除，请稍后重试

String VOTE_INVALID = "VOTE_INVALID";// 无效的签到，请稍后重试

String VOTE_REPEAT = "VOTE_REPEAT";// 您已重复签到

data

String

是

无

PublishStartResponse

描述：会控展示答题结果事件开始信息

字段：

名称	类型	必填	默认值	描述
voteType	int	是	无	会控事件类型 2：签到，3：答题
publishTimestamp	long	是	无	展示答题结果时间单位：毫秒
questionnaireId	String	是	无	会控事件id
meetingId	String	是	无	会议id
conferenceNo	String	是	无	会议号码

PublishStopResponse

描述：会控展示答题结果事件结束信息

字段：

名称	类型	必填	默认值	描述
meetingId	String	是	无	会议id

FaceInfo

描述：人脸信息

字段：

名称	类型	必填	默认值	描述
faceId	long	是	无	人脸id
name	String	是	无	昵称
position	String	是	无	职称

NewStatisticsInfo

描述：会中媒体统计信息，可参考：数据统计

字段：

名称	类型	必填	默认值	描述
people	Map>>	是	无	会中参会者统计信息
content	Map>>	是	无	会中共享流统计信息
networkInfo	Map	是	无	会中网络信息

SitePathInfo

描述：环境线路配置信息

字段：

名称	类型	必填	默认值	描述
currentSitePathId	String	是	无	当前选择线路id
sitePaths	List	是	无	所有线路信息

SitePath

描述：线路信息

字段：

名称	类型	必填	默认值	描述
displayName	String	是	无	线路名称
sitePathType	int	是	无	0 公有、1 私有
sitePathId	String	是	无	线路ID
networkType	int	是	无	0 内网、 1 外网
netToolServer	String	是	无	线路地址

2025-05-12 14:37:02

导出PDF文档