跳转到主要内容

结构体类型

SEAMeetingParam

会议参数 该参数是创建房间与更新房间时的必传参数。
属性名称描述
roomId【字段含义】房间标识
【推荐取值】云端生成
【特别说明】创建房间时无需设置该字段,更新房间信息时,该字段为必传项。
roomNo【字段含义】房间号码
【推荐取值】云端生成
【特别说明】创建和更新房间信息时无需设置改字段。
title【字段含义】会议标题
【推荐取值】创建房间时,该字段为必传项。
【特别说明】可用于列表等会议显示标题使用,使用 UTF-8 编码。
content【字段含义】会议说明
【特别说明】可用于列表等会议显示说明使用,使用 UTF-8 编码。
password【字段含义】会议密码
【特别说明】创建房间时,如果设置了参会密码,用户加入会议时同样需要匹配密码才可以正确加入会议。
meetingType【字段含义】会议类型
【推荐取值】默认值:SEAMeetingTypeInitiate
beginTime【字段含义】会议开始时间
【推荐取值】当会议类型为预约会议时,为必传项。
【特别说明】开始时间 unix 时间戳
endTime【字段含义】会议结束时间
【推荐取值】当会议类型为预约会议时,为必传项。
【特别说明】结束时间 unix 时间戳
entryMutePolicy【字段含义】入会静音状态
【推荐取值】默认值:SEAMeetingMuteState3
watermarkDisabled【字段含义】房间水印禁用状态
【推荐取值】默认值:YES
screenshotDisabled【字段含义】房间截屏禁用状态
【推荐取值】默认值:NO
chatDisabled【字段含义】房间聊天禁用状态
【推荐取值】默认值:NO
waitingRoomDisabled【字段含义】等候室是否禁用
【推荐取值】默认值:YES
extendInfo【字段含义】扩展信息

SEAMeetingEnterParam

加入会议参数 该参数是创建房间与更新房间时的必传参数。
属性名称描述
roomNo【字段含义】会议号码
【推荐取值】一般为 9 位数字
【特别说明】入会时,可以选择会议号码会议标识任意一个进行加会操作。
meetingId【字段含义】会议标识
【推荐取值】一般为加密字符串
【特别说明】入会时,可以选择会议号码会议标识任意一个进行加会操作。
password【字段含义】会议密码
【特别说明】如果创建房间时设置了参会密码,加入会议时需要同样的匹配密码才可以正确加入会议。
nickname【字段含义】参会昵称
【推荐取值】该字段将作为会议中展示信息,使用 UTF-8 编码。
avatar【字段含义】参会头像
【推荐取值】该字段将作为会议中展示信息,使用 UTF-8 编码。
extendInfo【字段含义】扩展信息

SEAUserModel

用户数据
属性名称描述
userId【字段含义】用户标识
【特别说明】此字段为用户的全局唯一标识。
name【字段含义】用户名称
【特别说明】作为用户昵称使用,使用 UTF-8 编码。
micState【字段含义】麦克风状态,请参见 SEADeviceState 中的相关说明。
cameraState【字段含义】摄像头状态,请参见 SEADeviceState 中的相关说明。
shareType【字段含义】共享状态,请参见 SEAShareType 中的相关说明。
extend【字段含义】扩展属性
【特别说明】用户的扩展数据属性,请参见 SEAUserExtend 中的相关说明。

SEAUserExtend

用户扩展数据
属性名称描述
role【字段含义】参会角色
【特别说明】标识着用户的会中角色,请参见 SEAUserRole 中的相关说明。
avatar【字段含义】参会头像
【特别说明】该参数由用户在加入房间接口中设置,使用 UTF-8 编码。
isKickout【字段含义】是否被踢出
chatDisabled【字段含义】聊天能力禁用状态,YES-禁用 NO-不禁用
drawDisabled【字段含义】涂鸦能力禁用状态,YES-禁用 NO-不禁用
extend【字段含义】扩展信息

SEARoomModel

房间数据
属性名称描述
extend【字段含义】扩展属性
【特别说明】房间的扩展数据属性,请参见 SEARoomExtend 中的相关说明。

SEARoomExtend

房间扩展数据
属性名称描述
meetingId【字段含义】会议标识
roomNo【字段含义】房间号码
title【字段含义】会议标题
content【字段含义】会议说明
meetingType【字段含义】会议类型
【特别说明】标识会议类型,请参见 SEAMeetingType 中的相关说明。
beginTime【字段含义】开始时间
endTime【字段含义】结束时间
entryMutePolicy【字段含义】入会静音状态
【特别说明】当前会议参会静音状态,请参见 SEAMeetingMuteState 中的相关说明。
watermarkDisabled【字段含义】房间水印禁用状态,YES-禁用 NO-不禁用
screenshotDisabled【字段含义】房间截屏禁用状态,YES-禁用 NO-不禁用
chatDisabled【字段含义】聊天能力禁用状态,YES-禁用 NO-不禁用
micDisabled【字段含义】麦克风禁用状态,YES-禁用 NO-不禁用
cameraDisabled【字段含义】摄像头禁用状态,YES-禁用 NO-不禁用
selfUnmuteMicDisabled【字段含义】是否禁止自我解除麦克风状态,YES-禁止 NO-不禁止
selfUnmuteCameraDisabled【字段含义】是否禁止自我解除摄像头状态,YES-禁止 NO-不禁止
shareDisabled【字段含义】共享能力禁用状态,YES-禁用 NO-不禁用
waitingRoomDisabled【字段含义】等候室禁用状态,YES-禁用 NO-不禁用
parentMid【字段含义】上级会议标识
enterBeforeHostDisabled【字段含义】是否禁止在主持人之前入会,YES-禁止 NO-不禁止
locked【字段含义】会议锁定状态,YES-开启 NO-关闭
shareType【字段含义】共享类型
【特别说明】标识当前会议共享类型,请参见 SEAShareType 中的相关说明。
shareUid【字段含义】共享者标识
【特别说明】标识当前会议正在共享者的用户标识
creator【字段含义】创建者的用户标识
hostUid【字段含义】主持人的用户标识
unionHosts【字段含义】会议联席主持人用户标识列表
extend【字段含义】扩展信息

SEAUserInfo

用户信息
属性名称描述
userId【字段含义】用户标识
deviceId【字段含义】设备标识
deviceType【字段含义】设备类型
【特别说明】标识当前设备类型,请参见 SEADeviceType 中的相关说明。
expAt【字段含义】过期时间

SEASectionModel

数据分页对象
属性名称描述
currentPage【字段含义】当前页码
pageCount【字段含义】总页数
perPage【字段含义】每页数据条数
totalCount【字段含义】总数据条数

SEAMeetingCreateModel

创建房间响应对象
属性名称描述
meetingId【字段含义】会议标识
roomNo【字段含义】房间号码

SEAChatModel

聊天消息对象
属性名称描述
messageId【字段含义】消息标识
meetingId【字段含义】会议标识
message【字段含义】消息内容
messageType【字段含义】消息类型,详情参考:SEAMessageType
senderId【字段含义】发送者标识
senderName【字段含义】发送者昵称
createdAt【字段含义】创建时间

SEAChatListModel

聊天消息列表对象
属性名称描述
meta【字段含义】数据分页对象,详情参考:SEASectionModel
listData【字段含义】聊天消息对象列表,详情参考:SEAChatModel

SEAMeetingModel

会议信息对象,以下简单罗列部分属性,详情请参看 SDK 提供的头文件。
属性名称描述
meetingId【字段含义】会议标识
roomNo【字段含义】会议号码
title【字段含义】会议标题
content【字段含义】会议说明
conferee【字段含义】受邀成员标识列表
creator【字段含义】创建者标识

SEAMeetingListModel

会议列表对象
属性名称描述
meta【字段含义】数据分页对象,详情参考:SEASectionModel
listData【字段含义】会议信息对象列表,详情参考:SEAMeetingModel

SEAMemberModel

参会成员对象
属性名称描述
recordId【字段含义】记录标识
userId【字段含义】用户标识
nickname【字段含义】用户昵称
enterAt【字段含义】加入时间
exitAt【字段含义】离开时间

SEAMemberListModel

参会成员列表对象
属性名称描述
meta【字段含义】数据分页对象,详情参考:SEASectionModel
listData【字段含义】参会成员对象列表,详情参考:SEAMemberModel

SEAStreamAudioModel

流媒体音频数据
属性名称描述
userId【字段含义】用户标识
power【字段含义】音频功率
db【字段含义】音频分贝值

SEAStreamSendModel

流媒体发送状态数据
属性名称描述
buffer【字段含义】上传缓冲包数
delay【字段含义】上传延迟
overflow【字段含义】溢出缓冲包数
speed【字段含义】上传速率
【特别说明】单位为 kps
status【字段含义】上传状态
loss_r【字段含义】补偿前丢包率
loss_c【字段含义】补偿后丢包率

SEAStreamReceiveModel

流媒体接收状态数据
属性名称描述
userId【字段含义】用户标识
recv【字段含义】接收包数
comp【字段含义】补偿包数
losf【字段含义】总丢包数
lrl【字段含义】端到端丢包率
lrd【字段含义】服务器到端丢包率
audio【字段含义】音频包数
video【字段含义】视频包数

SEAAgentModel

邀请设备对象
属性名称描述
deviceId【字段含义】设备ID
name【字段含义】设备名称
type【字段含义】设备类型,请参见 SEAAgentType 中的相关说明。
status【字段含义】设备状态,请参见 SEAAgentStatus 中的相关说明。
contact【字段含义】设备标识
remark【字段含义】设备备注
connectParams【字段含义】连接参数

SEAAgentListModel

邀请设备列表对象
属性名称描述
meta【字段含义】数据分页对象,详情参考:SEASectionModel
listData【字段含义】设备对象列表,详情参考:SEAAgentModel

SEAInviteModel

邀请对象
属性名称描述
contact【字段含义】设备标识
type【字段含义】设备类型,详情参考:SEAAgentType

SEAConfereeModel

小组会议参会成员对象
属性名称描述
userId【字段含义】用户标识
nickname【字段含义】用户昵称

SEALayoutDataModel

布局数据对象
属性名称描述
layout【字段含义】布局类型,默认 auto
isPolling【字段含义】是否轮询,默认 NO
watermark【字段含义】布局水印,详情参考:SEALayoutWatermarkModel
label【字段含义】布局标签,详情参考:SEALayoutLabelModel
viewLists【字段含义】布局视图列表,即:逻辑块, 包含宫格与用户
【特别说明】布局视图列表,请参见 SEALayoutViewListModel 中的相关说明。

SEALayoutWatermarkModel

布局水印对象
属性名称描述
type【字段含义】水印类型,默认 1;1-无,2-单排,3-多排
size【字段含义】字体大小,为0时,表示默认值
color【字段含义】字体颜色,为空时,表示默认值
olColor【字段含义】轮廓颜色,为空时,表示默认值
olWidth【字段含义】轮廓线宽,为0时,表示默认值

SEALayoutLabelModel

布局标签对象
属性名称描述
type【字段含义】标签类型,默认 LT;字母或组合:L-左,R-右,T-上,B-下
size【字段含义】字体大小,为0时,表示默认值
color【字段含义】字体颜色,为空时,表示默认值
bgColor【字段含义】背景颜色,为空时,表示默认值

SEALayoutViewListModel

布局视图列表对象,即:逻辑块, 包含宫格与用户
属性名称描述
itemLists【字段含义】视图列表单元格
【特别说明】单元格列表,请参见 SEALayoutViewListCellModel 中的相关说明。
userIds【字段含义】成员标识列表

SEALayoutViewListCellModel

布局视图列表单元格对象
属性名称描述
index【字段含义】格子序号
【特别说明】排序规则按HTML中标签的顺序,默认 0
bindShare【字段含义】是否优先绑定频道内的共享流,默认 NO
label【字段含义】单元格标签,详情参考:SEALayoutLabelModel

SEACloudRecordParam

云录制参数 该参数是开启云录制时的必传参数。
属性名称描述
recordType【字段含义】录制类型
【推荐取值】默认:SEARecordTypeVideo
title【字段含义】录制文件标题
layoutData【字段含义】录制布局
【推荐取值】详情可参考:SEALayoutDataModel

SEACloudRecordDetailsModel

云录制详情对象
属性名称描述
taskId【字段含义】任务标识
meetingId【字段含义】会议标识
roomNo【字段含义】会议号码
title【字段含义】录制文件标题
opUid【字段含义】操作人标识
opName【字段含义】操作人名称
recordStatus【字段含义】云录制状态,详情参考:SEARecordStatus
videoKey【字段含义】视频地址
videoSize【字段含义】视频大小
tags【字段含义】录制标签
errorDesc【字段含义】错误描述
createdAt【字段含义】创建时间
updatedAt【字段含义】更新时间

SEACloudRecordConfigModel

云录制配置对象
属性名称描述
layout【字段含义】布局类型
watermarkType【字段含义】水印类型,1-无,2-单排,3-多排
labelType【字段含义】标签类型,字母或组合:L-左,R-右,T-上,B-下
createdAt【字段含义】创建时间
updatedAt【字段含义】更新时间

SEAMeetingRemindModel

会议即将开始提醒对象
属性名称描述
meetingId【字段含义】会议标识
roomNo【字段含义】房间号码
title【字段含义】会议标题
creatorName【字段含义】创建者昵称
planTime【字段含义】预约时间
planDuration【字段含义】预约时长,单位:分钟

SEAMediaConfig

流媒体配置参数
属性必填属性说明
int aec回声消除AEC,默认 12
int agc自动增益控制AGC,默认 16000
int audioSampe音频采样率,默认 48000
SEACodecType audioEncode音频编码格式,默认 AAC
SEAAudioRoute audioRoute音频路由,默认 SEAAudioRouteReceiver
int videoWidth分辨率宽,默认 480
int videoHeight分辨率高,默认 640
BOOL videoMirror视频镜像,默认 YES
int fps视频帧率,默认 25
int bitrate视频码率,默认 0.9*1024,单位kbps

SEANetworkQosParam

网络质量控制参数
属性必填属性说明
int secondGear接收自适应延迟二档位,默认 500
int thirdGear接收自适应延迟三档位,默认 1200
float onAudioCycle获取云端音频数据信息周期,默认 500毫秒
BOOL isHardwarede开启硬件解码 YES开启 NO关闭,默认 YES
BOOL isNetworkAdaptive开启网络自适应延迟 YES开启 NO关闭,默认 YES
BOOL isBitrateAdaptive开启码率自适应 YES开启 NO关闭,默认 YES
SEANetworkQosShakeLevel shakeLevel网络延时抗抖动等级,默认 SEANetworkQosShakeLevelMedium

SEADebugParam

调试模式参数
属性必填属性说明
NSString *debugHost远程调试地址
BOOL enableSaveVideo保存视频流,默认 NO
BOOL enableSaveAudioCapture保存采集音频流,默认 NO
BOOL enableSaveAudioReceive保存远程音频流,默认 NO

SEAWaitingRoomMemberModel

等候室成员对象
属性名称描述
userId【字段含义】用户标识
nickname【字段含义】用户昵称
enterAt【字段含义】加入时间

SEAWaitingRoomMemberListModel

等候室成员列表对象
属性名称描述
listData【字段含义】等候室成员对象列表,详情参考:SEAWaitingRoomMemberModel

SEARoomSubMeetingModel

小组会议对象
属性名称描述
groupId【字段含义】小组标识
meetingId【字段含义】小组会议标识
parentMid【字段含义】主会议标识
title【字段含义】小组会议名称
meetingStatus【字段含义】小组会议状态,详情参考:SEAMeetingStatus
conferee【字段含义】小组会议参会成员列表,详情参考:SEAConfereeModel

SEARoomSubMeetingListModel

小组会议列表对象
属性名称描述
listData【字段含义】小组会议对象列表,详情参考:SEARoomSubMeetingModel

SEAOnlineMemberModel

在线成员对象
属性名称描述
userId【字段含义】用户标识
nickname【字段含义】用户昵称
deviceType【字段含义】设备类型,详情参考:SEADeviceType
joinAt【字段含义】加入时间

SEAOnlineMemberListModel

在线成员列表对象
属性名称描述
meta【字段含义】数据分页对象,详情参考:SEASectionModel
listData【字段含义】在线成员对象列表,详情参考:SEAOnlineMemberModel

枚举类型

SEADeviceType

设备类型
枚举类型枚举值描述
SEADeviceTypeUnknown0未知类型设备
SEADeviceTypeWindows1Windows
SEADeviceTypeAndroid2Android
SEADeviceTypeIOS3iOS
SEADeviceTypeLinux4Linux
SEADeviceTypeMacOS5MacOS
SEADeviceTypeWebRTC6WebRTC
SEADeviceTypeWeChat7微信小程序

SEACodecType

编码类型
枚举名枚举值说明
SEACodecTypeH2640未知类型
SEACodecTypeH2640x1bH264
SEACodecTypeH2650x24H265
SEACodecTypeAAC0x0fAAC
SEACodecTypeOPUS0x5355504fOPUS

SEANetworkQosShakeLevel

网络延时抗抖动等级
常量枚举值说明
SEANetworkQosShakeLevelUltraShort0超短(0) 单向延迟120ms左右 这种模式下没有丢包补偿机制 并且编码关闭了B帧 一般不建议实际使用
SEANetworkQosShakeLevelShort1短(1) 单向延迟200ms左右 单次丢包补偿 B帧为1 双向对讲环境下可以使用
SEANetworkQosShakeLevelMedium2中(2) 单向延迟350ms左右 两次丢包补偿 B帧为1 双向对讲环境下推荐使用
SEANetworkQosShakeLevelLong3长(3) 单向延迟600ms左右 三次丢包补偿 B帧为3 这种模式仅用于单向收看 双向对讲环境下不建议使用 该参数无法动态设置

SEAAudioRoute

音频路由类型
枚举类型枚举值描述
SEAAudioRouteUnknown0未知类型路由
SEAAudioRouteSpeaker1扬声器
SEAAudioRouteReceiver2听筒
SEAAudioRouteBluetooth3蓝牙耳机
SEAAudioRouteHeadset4有线耳机

SEAVideoStreamType

视频流类型
枚举类型枚举值描述
SEAVideoStreamTypeBig1高清大画面,一般用来传输摄像头的视频数据
SEAVideoStreamTypeSmall2低清小画面,小画面和大画面的内容相同,但是分辨率和码率都比大画面低,因此清晰度也更低
SEAVideoStreamTypeScreen3屏幕共享流

SEAScreenRecordStatus

屏幕采集状态
枚举类型枚举值描述
SEAScreenRecordStatusNormal1000默认状态
SEAScreenRecordStatusError-1连接错误
SEAScreenRecordStatusStop0录制停止
SEAScreenRecordStatusStart1录制开始

SEAUserRole

用户角色
枚举类型枚举值描述
SEAUserRoleNormal0普通成员
SEAUserRoleHost1主持人
SEAUserRoleUnionHost2联席主持人

SEAMeetingType

会议类型
枚举类型枚举值描述
SEAMeetingTypeInitiate1即时会议
SEAMeetingTypeSchedule2预约会议

SEAMeetingMode

会议模式
枚举类型枚举值描述
SEAMeetingModeNormal1常规会议模式
SEAMeetingModeMixture2合成会议模式
SEAMeetingModeVoice3语音会议模式
SEAMeetingModeTraining4培训会议模式
SEAMeetingModeGroups5小组会议模式

SEAMeetingStatus

会议状态
枚举类型枚举值描述
SEAMeetingStatusNotStart1未开始
SEAMeetingStatusIng2进行中
SEAMeetingStatusEnded3已结束

SEAMeetingAttendType

参会类型
枚举类型枚举值描述
SEAMeetingAttendTypeNormal1无限制
SEAMeetingAttendTypePassword2密码参会
SEAMeetingAttendTypeInitiate3仅邀请人员参会

SEAMeetingMuteState

会议静音状态
枚举类型枚举值描述
SEAMeetingMuteState11开启入会静音(所有人入会默认静音)
SEAMeetingMuteState22关闭入会静音(跟随客户端初始音频状态)
SEAMeetingMuteState33超6人静音(超过6人后入会静音)

SEADeviceState

设备状态
枚举类型枚举值描述
SEADeviceStateOpen1开启状态
SEADeviceStateClosed2关闭状态

SEAShareType

共享类型
枚举类型枚举值描述
SEAShareTypeNormal0默认类型
SEAShareTypeScreen1共享屏幕
SEAShareTypeDrawing2共享画板

SEAMessageType

消息类型
枚举类型枚举值描述
SEAMessageTypeText1文本消息
SEAMessageTypeFile2文件消息
SEAMessageTypePicture3图片消息
SEAMessageTypeVoice4语音消息
SEAMessageTypeCustom5自定义消息

SEAHandupType

举手申请类型
枚举类型枚举值描述
SEAHandupTypeMic1麦克风
SEAHandupTypeCamera2摄像头
SEAHandupTypeChat3聊天
SEAHandupTypeShare4共享
SEAHandupTypeDraw5涂鸦

SEALeaveReason

离开原因
枚举类型枚举值描述
SEALeaveReasonNormal1主动离开
SEALeaveReasonKickout2被踢离开
SEALeaveReasonReplaced3被顶号
SEALeaveReasonTimeout4心跳超时离开
SEALeaveReasonDestroy5频道销毁离开

SEAChangeReason

音视频状态更改原因
枚举类型枚举值描述
SEAChangeReasonBySelf0自己操作
SEAChangeReasonByAdmin1主持人或联席主持人操作

SEADownBitrateAdaptiveState

下行码率自适应状态
枚举类型枚举值描述
SEADownBitrateAdaptiveStateNormal0正常
SEADownBitrateAdaptiveStatePoor-1较差
SEADownBitrateAdaptiveStateBad-2很差
SEADownBitrateAdaptiveStateVeryBad-3极差
SEADownBitrateAdaptiveStateLose-4链路离线

SEAUploadBitrateAdaptiveState

上行码率自适应状态
枚举类型枚举值描述
SEAUploadBitrateAdaptiveStateStart1000码率自适应开始工作
SEAUploadBitrateAdaptiveStateNormal0码率恢复到最初设置
SEAUploadBitrateAdaptiveStateHalf-1码率变为原来的一半
SEAUploadBitrateAdaptiveStateQuarter-2码率变为原来的四分之一
SEAUploadBitrateAdaptiveStateVeryBad-3当前网络环境极差

SEADownLossLevelState

下行平均丢包档位
枚举类型枚举值描述
SEADownLossLevelStateInvalid-1无效
SEADownLossLevelStateNormal0正常
SEADownLossLevelStatePoor1较差
SEADownLossLevelStateBad2很差
SEADownLossLevelStateVeryBad3极差

SEAImDisconnectReason

即时通讯断开原因
枚举类型枚举值描述
SEAImDisconnectReasonError-1发生错误
SEAImDisconnectReasonNormal1主动离开
SEAImDisconnectReasonKickout2被踢离开
SEAImDisconnectReasonTimeout4心跳超时离开

SEAAgentType

邀请设备类型
枚举类型枚举值描述
SEAAgentTypeSIP2SIP
SEAAgentTypeH3233H323
SEAAgentTypeGB281814GB28181
SEAAgentTypeRTSP5RTSP拉流
SEAAgentTypeRTMP6RTMP拉流
SEAAgentTypeFile7文件播放
SEAAgentTypeTencent8腾讯会议
SEAAgentTypeAI9AI

SEAAgentStatus

邀请设备状态
枚举类型枚举值描述
SEAAgentStatusUnknown0未知
SEAAgentStatusOnline1在线
SEAAgentStatusOffline2离线

SEARecordType

录制类型
枚举类型枚举值描述
SEARecordTypeVideo1录像模式
SEARecordTypeMixture2合流模式
SEARecordTypeAll3混合模式

SEARecordStatus

录制状态
枚举类型枚举值描述
SEARecordStatusNotStart0未开始
SEARecordStatusIng1进行中
SEARecordStatusNotEnded2未结束
SEARecordStatusError3异常结束
SEARecordStatusEnded4正常结束

SEACallRole

通话角色
枚举类型枚举值描述
SEACallRoleNone0未知类型
SEACallRoleCall1主叫(邀请方)
SEACallRoleCalled2被叫(被邀请方)

SEACallStatus

通话状态
枚举类型枚举值描述
SEACallStatusNone0未知
SEACallStatusAccept1接听
SEACallStatusReject2拒绝
SEACallStatusBusy3忙线