跳转到主要内容
本页整理 SDK 对外公开的类型。字段名一律给 Swift 侧的属性名。

请求参数

MeetingCreateReq

创建 / 修改会议的参数。构造:

MeetingEnterReq

进入会议的参数。构造:

PageParam

ResourceListReq

ResourceCreateReq

布局与录制参数

McuStartReq、LayoutData、Watermark、Tag、Cell、DivList、Attachment 都提供了构造器,可选参数带默认值;它们同时是 Codable 的,也可以用 JSONDecoder 从后端下发的 JSON 解出来。字段与 JSON 键的对照表见 录制与合屏布局。

会议与成员信息

RoomInfo

当前会议的房间信息,由 getRoomInfo() 返回。

MeetingUserInfo

会中成员信息,由 getUserInfo(_:) / getUsersInfo() / getUsersInfoList() 返回。

MeetingInfo

会议详情,由 detailRoom(...)、attendeeRoom(...)、attendedRoom(...) 返回。 entryMutePolicy、content 自 1.5.0 起提供。为 nil 表示后端没给,修改会议时不要拿默认值回填,以免冲掉后端已有的设置。

ParticipantInfo

参会记录,由 roomParticipant(...) 返回。

OnlineMemberInfo

在线人员,由 adminListOnlineMember(...) 返回:userId、nickname、deviceType、joinAt。

NoEnterUserInfo

未入会人员,由 meetNotEnter() 返回:id、nickname、mobile、avatar、role、relUid。

WaitingRoomUserInfo

等候室成员,由 adminWaitingRoomUsers() 返回:userId、name、avatar、at。

SubMeetingInfo / SubMeetingUser

小组信息,由 adminSubMeetingList(...) 返回。

AgentInfo

可邀请设备,由 agentList(...) 返回。 connParams、connSubjects 与公开构造器 AgentInfo(id:name:type:status:contact:remark:connParams:)(remark、connParams 有默认值)自 1.5.0 起提供。 GB28181 设备要按「设备编号:通道编号」邀请,直接传 contact 会被后端拒绝。SDK 只解析通道表、不替你展开,通常每个通道列一行:
除 type 外,其余字段缺失时按空值解码,单台设备的脏数据不会让整页列表解码失败。

ResourceInfo

资源,由 resourcesList(...) 返回。

SignInfo / SignDetailInfo

签到活动与签到明细。

McuRecordConfig / McuRecordDetail

MeetingToken

登录 token 解析后的内容。你通常不需要用到它 —— token 由业务后端签发,直接传给 login(token:) 即可。如果需要在客户端提前判断 token 是否过期,可以:

分页

PageResult

MetaRes:totalCount、pageCount、currentPage、perPage。

事件数据类型

连接与成员

房间状态

消息

主持人指令与举手

等候室与分组讨论

签到、点名与外设

会议外消息

业务事件(呼叫、提醒、等候室放行、小组求助)的数据都由 base 和 content 两部分组成;连接与原始消息事件直接带字段。

枚举

TrackDesc

Role

MicState / CameraState

ShareType

HandupType

UserHandupStep

ChatMsgType

MeetingType

MeetingMode

MeetingStatus

AttendType

EndType

EntryMutePolicy

MeetingStreamVendor

ook 已随服务端退役(2026-08),仅为兼容存量环境保留,新接入不要使用。 不确定该填哪一个时不要传,让服务端按部署配置决定。

UserType

McuTaskType

McuTaskStatus

取值与服务端 task_status 一致。1.4.0 及以前的原始值有误(exception = 2、normal = 3),1.4.1 起改正,见 更新日志。

LayoutType

AgentType

AgentStatus

取值与服务端一致,后端下发其它取值时解码为 .unknown。1.4.1 及以前的定义有误(idle = 1 空闲、busy = 2 忙碌、offline = 3 离线),后端下发 status = 0 时整页设备列表解码失败,1.5.0 起改正:
  • idle、busy 保留为已废弃的别名,分别等于 .online、.offline,旧代码仍能编译
  • offline 的原始值从 3 变为 2:按 rawValue 做数值比较或持久化过原始值的代码需要检查

PresignedPutObjectType


来自 SRTC 的类型

以下类型定义在底层 SRTC 模块,使用时需要 import SRTC:LogLevel、CameraPreset、MicPreset、ScreenPreset、DeviceInfo、DisconnectReason、ImDisconnectReason、AnyCodable、SRTCVideoView、SRTCVideoRenderer、ScreenCaptureSources、DisplaySource、WindowSource、LocalCameraTrack、LocalScreenTrack、RemoteVideoTrack、Track、SRTCBroadcastPicker。 NativeVideoView 是 SMeeting 为渲染视图定义的别名,实际类型是 SRTCVideoRenderer。

音频路由(iOS)

为什么可切换的只有两态,见 音频路由。

通话质量

字段的取值范围与用法见 SRTC · 通话质量与活跃说话人。

收流状态

由 meeting(_:didChangeReceiveStreamStatus:) 带出,按轨道判定某一路视频是否还在出帧,与整条链路的质量档位是两回事,见 事件参考。

相关页面