Struct

音频码率，单位为 kbps，默认为 48 kbps. 该配置推流前后设置均可生效

音频编码声道，控制编码器编码的声道数。默认为 Mono 单声道。仅在推流前设置生效。

编码 ID，默认为 ZegoAudioCodecIDDefault。仅在推流前设置生效。

采样率

音频声道，默认为 Mono 单声道

CDN 的 URL

URL 的鉴权参数。若需要使用请联系 ZEGO 技术支持，否则可以忽略此参数（可以留空或设置为空字符串）。

URL 支持的协议，可选值为 "tcp" 和 "quic"，若要使用多个，用英文的逗号分割，按顺序尝试。若需要使用请联系 ZEGO 技术支持，否则可以忽略此参数（可以留空或设置为空字符串）。

QUIC 版本。如果 [protocol] 有 QUIC 协议，需要填写该信息。如果有多个版本号，用英文的逗号分割。若需要使用请联系 ZEGO 技术支持，否则可以忽略此参数（可以留空或设置为空字符串）。

自定义使用的 httpdns 服务。目前仅支持拉流时使用该功能。

QUIC 建立链接模式，若为1 则会优先使用quic 0 rtt 去建立链接，否则正常建立链接。如果 [protocol] 有 QUIC 协议，此值生效。

URL 的自定义参数。若需要使用请联系 ZEGO 技术支持，否则可以忽略此参数（可以留空或设置为空字符串）。

View 对象

视图模式，默认为 ZegoViewModeAspectFit

设备 ID

设备名称

美白强度参数，取值范围[0,100]，默认 50。

红润强度参数，取值范围[0,100]，默认 50。

磨皮强度参数，取值范围[0,100]，默认 50。

锐化强度参数，取值范围[0,100]，默认 50。

进阶功能配置，未设置时默认不使用任何特殊功能，如需使用，请联系 ZEGO 技术支持。

ZEGO 为开发者签发的应用 ID，请从 ZEGO 管理控制台 https://console-express.zego.im 申请。appID 取值范围 0~4294967295。

房间场景，SDK 会针对指定的场景的做一些音视频配置优化以达成在此场景下最优的效果。指定场景后，开发者可以使用 [setRoomScenario] 来实现在不销毁引擎 [destroyEngine] 的前提下切换其他场景。指定场景后，开发者可以调用其他 API 来继续调整音视频配置。各个场景之间的差异以及如何选择合适的场景请参考 https://doc-zh.zego.im/article/16316

用于自定义日志文件的存储路径。

用于自定义日志文件大小上限。

日志文件个数。默认是 3 个。取值范围是 [3, 20]

用于指定多媒体资源的加载类型。

开始播放的进度。

文件资源的路径。本地资源路径或网络资源的 URL，不能传入 nil 或 ""。Android 可通过 Uri 方式进行传参。

从版权音乐模块获取的资源 ID。

在线资源缓存路径，utf8 编码格式。

在线资源最大的缓存待使用长度，单位 byte，最小设置 10M(10 * 1024 * 1024)，默认0-不做限制，尝试缓存整个文件。

是否进行上行测速

单位 kbps。用于确定网络上行环境是否适合推送指定码率的数据，建议用推流的码率来测试。

是否进行下行测速

单位 kbps。用于确定网络下行环境是否适合拉取指定码率的数据，建议用推流的码率来测试。

连接服务器耗时，单位毫秒。测速过程中如果网络连接断开会自动发起重连，此变量会相应更新。

rtt，单位毫秒

丢包率，单位为百分比，0.0 ~ 1.0

网络质量，优良中差

当前 App 的 CPU 使用率，取值范围 [0, 1]

当前系统的 CPU 使用率，取值范围 [0, 1]

当前 App 的运行内存使用率，取值范围 [0, 1]

当前系统的运行内存使用率，取值范围 [0, 1]

当前 App 的运行内存使用量，单位为 MB

视频接收帧率，单位为 f/s

视频抗抖动帧率，单位为 f/s （1.17.0 及以上版本支持）

视频解码帧率，单位为 f/s

视频渲染帧率，单位为 f/s

视频码率，单位为 kbps

视频卡顿率，单位为（卡顿次数/每10秒）（1.17.0 及以上版本支持）

音频接收帧率，单位为 f/s

音频抗抖动帧率，单位为 f/s （1.17.0 及以上版本支持）

音频解码帧率，单位为 f/s

音频渲染帧率，单位为 f/s

音频码率，单位为 kbps

音频卡顿率，单位为（卡顿次数/每10秒） （1.17.0 及以上版本支持）

音频 MOS (平均主观意见分) 评估方法对拉流音频的质量评分，取值范围 [-1, 5]，其中 -1 表示未知，[0, 5] 表示有效的评分，分数越高，音频质量越好。评分对应的主观感受请查阅 https://doc-zh.zego.im/article/1074#4_4 （2.16.0 及以上版本支持）

服务端至本端的延迟，单位为毫秒

丢包率，单位为百分比，0.0 ~ 1.0

端到端延迟，单位为毫秒

端到端丢包率，单位为百分比，0.0 ~ 1.0

拉流质量级别

本端接收到数据后到播放的延迟，单位为毫秒

是否开启硬件解码

视频编码格式 （1.17.0 及以上版本支持）

已接收的总字节数，包括音频、视频和 SEI 等

已接收的音频字节数

已接收的视频字节数

累计音频卡顿次数 （2.9.0 及以上版本支持）

累计音频卡顿时长，单位为毫秒 （2.9.0 及以上版本支持）

累计音频卡顿率，单位为百分比，0.0 ~ 100.0 （2.9.0 及以上版本支持）

累计音频解码时长，单位为毫秒 （2.9.0 及以上版本支持）

累计视频卡顿次数 （2.9.0 及以上版本支持）

累计视频卡顿时长，单位为毫秒 （2.9.0 及以上版本支持）

累计视频卡顿率，单位为百分比，0.0 ~ 1.0 （2.9.0 及以上版本支持）

累计视频解码时长，单位为毫秒 （2.9.0 及以上版本支持）

禁用视频, （3.13.0 及以上版本支持）

禁用音频, （3.13.0 及以上版本支持）

拉流资源策略模式。

拉流的 CDN 配置，若设置后，则按照 URL 拉流而不是按照 streamID 拉流，此后 streamID 仅作为 SDK 内部回调的标识。

房间 ID。仅在多房间模式下需要填写，即指明这条流需要跟哪个房间绑定。单房间模式下此参数将被忽略。

该流的视频编码类型，若需要使用请联系 ZEGO 技术支持，否则可以忽略此参数。

源流的资源类型，若需要使用请联系 ZEGO 技术支持，否则可以忽略此参数。

预配置的编解码器模板，若需要使用请联系 ZEGO 技术支持，否则可以忽略此参数。

拉流资源切换策略模式，默认为 ZegoStreamResourceSwitchModeDefault

下麦时切换的拉流资源类型，默认为 ZegoStreamResourceTypeDefault。只有用户设置 [resourceMode] 为 ZegoStreamResourceModeDefaut 时，且 [resourceSwitchMode] 为 ZegoStreamResourceSwitchModeDefault 或者 ZegoStreamResourceSwitchModeSwitchToRTC，该设置生效。

视频采集帧率，单位为 f/s

视频编码帧率，单位为 f/s

视频发送帧率，单位为 f/s

视频码率，单位为 kbps

音频采集帧率，单位为 f/s

音频发送帧率，单位为 f/s

音频码率，单位为 kbps

本端至服务端的延迟，单位为毫秒

丢包率，单位为百分比，0.0 ~ 1.0

推流质量级别

是否开启硬件编码

已发送的总字节数，包括音频、视频和SEI等

已发送的音频字节数

已发送的视频字节数

房间 ID, 单房间模式可不传，多房间模式时必须传对应房间的 ID

推流时是否同步网络时间，1-同步 0-不同步。且必须与 setStreamAlignmentProperty配合使用。用于在混流服务或拉流端对多条流进行对齐，比如 KTV 的合唱场景。

推流时，审查流的模式。默认不审查。如需要使用此功能，需要联系ZEGO技术支持。

审查标记，使用此功能需要联系 ZEGO 技术支持

矩形左上角在坐标系 X 轴上的值

矩形左上角在坐标系 Y 轴上的值

矩形宽度

矩形高度

房间大小（百分比），取值范围 [0.0, 100.0]，用于控制产生混响模拟的 “房间” 的大小，房间越大，混响越强

余响（百分比），取值范围 [0.0, 100.0]，用于控制混响的拖尾长度

混响阻尼（百分比），取值范围 [0.0, 100.0]，控制混响的衰减程度，阻尼越大，衰减越大

只有湿信号。设置只输出混响声音，不叠加原始输入声音，默认是false。

湿信号增益(dB)，取值范围 [-20.0, 10.0]

干信号增益(dB)，取值范围 [-20.0, 10.0]

低频衰减，默认为不衰减（100%）

高频衰减，默认为不衰减（100%）

初始延迟时间(ms)。取值范围[0, 200]

立体声宽度（百分比），默认值为 0%

输入音频信号的增益，取值范围 [0.0, 1.0]

输出音频信号的增益，取值范围 [0.0, 1.0]

回声数量，取值范围 [0, 7]

回声信号分别的延时，单位为毫秒，取值范围 [0, 5000] ms

回声信号分别的衰减系数，取值范围 [0.0, 1.0]

矩形左上角在坐标系 X 轴上的值

矩形左上角在坐标系 Y 轴上的值

矩形宽度

矩形高度

ROI 强度，当前支持的取值范围是 [0, 4]，0 为无效果，4 为最强。

房间最大用户数量，传 0 视为不限制，默认无限制

是否开启用户进出房间回调通知 [onRoomUserUpdate]，默认关闭。若开发者需要使用 ZEGO 房间用户广播通知，请确保每个登录的用户都将此标记设置为true

由开发者业务服务器下发的 token，用以保证安全性，生成规则请参考 使用 Token 鉴权，默认为空字符串，即不鉴权。2.17.0 及以上版本如果调用 [createEngine] 接口创建引擎时未传入appSign，或者appSign为空，则登录房间时必须设置此参数用于鉴权。

房间附加消息的键

房间附加消息的值

更新房间附加消息的用户。请勿在此字段填写用户敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

房间附加消息的更新时间，UNIX 时间戳，单位为毫秒

屏幕共享时是否采集视频。默认为 true。

屏幕共享时是否采集音频。默认为 true。

设置屏幕录制时 Microphone 音频音量。范围为 0 ~ 200，默认为 100。(仅适用 iOS 平台)

设置屏幕录制时 Application 音频音量。范围为 0 ~ 200，默认为 100。(适用于 iOS 和 Android 平台)

设置屏幕录制时音频采集参数。(仅适用 Android 平台)

设置屏幕录制时裁剪矩形，裁剪矩形必须被原始数据的矩形包含，单位为像素。（仅适用 iOS/Android 平台）

设置屏幕录制时采集画面的朝向，将会对采集画面做固定朝向。（仅适用 iOS/Android 平台）

设置是否屏蔽扩展进程的麦克风的声音，默认为 false。(仅适用于 iOS 平台)

声浪的监控时间周期，单位为毫秒，取值范围 [100, 3000]。默认 100 ms。

设置声浪回调是否包含 VAD 检测结果。

音浪值

StreamID 对应的流是否包含声音，0: 表示噪声，1: 表示正常声音；调用 [startSoundLevelMonitor] 时设置的 ZegoSoundLevelConfig 配置中的 enableVAD 参数设为 true 后此值才有效。

用户对象实例。请勿在此字段填写用户敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

流附加信息

CDN 推流的 URL

转推状态

转推状态变更的原因

状态发生的时间，UNIX 时间戳，单位为毫秒

用户名，最大长度不超过 256 字节的utf8编码字符串。请勿在此字段填写用户敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

采集分辨率宽度，控制摄像头图像采集的宽度。SDK 要求设置此成员为偶数。仅摄像头启动前且没有使用自定义视频采集时，设置有效。出于性能考虑，SDK 在采集摄像头画面后、渲染预览画面之前，就将视频帧缩放为编码分辨率，因此预览画面的分辨率是编码分辨率，如果您需要预览画面的分辨率为此值，请先调用 [setCapturePipelineScaleMode] 将采集缩放模式改为 [Post]

采集分辨率高度，控制摄像头图像采集的高度。SDK 要求设置此成员为偶数。仅摄像头启动前且没有使用自定义视频采集时，设置有效。出于性能考虑，SDK 在采集摄像头画面后、渲染预览画面之前，就将视频帧缩放为编码分辨率，因此预览画面的分辨率是编码分辨率，如果您需要预览画面的分辨率为此值，请先调用 [setCapturePipelineScaleMode] 将采集缩放模式改为 [Post]

编码分辨率宽度，控制编码器编码推流的图像宽度。SDK 要求设置此成员为偶数。推流前后设置均可生效

编码分辨率高度，控制编码器编码推流的图像高度。SDK 要求设置此成员为偶数。推流前后设置均可生效

帧率，控制摄像头采集帧率以及编码器编码帧率的大小。推流端设置60帧，拉流端生效需联系技术支持

码率，单位为 kbps。推流前后设置均可生效。SDK 会根据开发者选择的场景，自动设置适配该场景的码率。若开发者手动设置的码率超出合理范围，SDK会自动按照合理区间处理码率。如因业务需要配置高码率，请联系 ZEGO 商务。

要使用的编码器，默认为 default。仅在推流前设置生效

视频关键帧间隔，单位秒。

音调参数，取值范围 [-12.0, 12.0]，数值越大声音越尖，设为 0.0 即关闭变声器。注意在 2.18.0 及更老版本上，取值范围为 [-8.0, 8.0]。