Struct

精确搜索的超时时间;如果不设置, SDK 内部默认是设置 5000 毫秒,有效值区间 [2000, 10000],单位ms

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

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

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

播放次数，当设为 0 时则无限循环播放，直到用户调用 [stop]，默认为 1 即仅播放一次。

是否将音效混入推流中，默认 false。

采样率

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

自动混流任务 ID，一个房间内需要保证混流任务 ID 的唯一性。

自动混流任务的房间 ID。

自动混流任务的音频配置，可配置音频码率、音频声道，编码 ID、多路音频流混音模式。

自动混流任务的输出流列表，列表中为 URL 或者流 ID，若为 URL 格式 目前只支持 RTMP URL 格式：rtmp://xxxxxxxx。

是否开启自动混流的声浪回调通知，开启后拉混流时可通过 [onAutoMixerSoundLevelUpdate] 回调收到每条单流的声浪信息。

混流对齐模式。

消息内容

消息 ID

消息的发送时间，UNIX 时间戳，单位为毫秒

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

美颜磨皮的采样步长，取值范围[0,1]，默认 0.2

美颜美白的亮度参数，值越大亮度越亮，取值范围[0,1]，默认 0.5

美颜锐化参数，值越大锐化越强，取值范围[0,1]，默认 0.1

消息内容

消息 ID

消息的发送时间，UNIX 时间戳，单位为毫秒

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

CDN 的 URL

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

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

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

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

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

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

View 对象

视图模式，默认为 ZegoViewModeAspectFit

背景颜色，格式为 0xRRGGBB，默认为黑色即 0x000000

用户对象实例，配置用户 ID、用户名。 注意此处设置的用户 ID 需要与登录房间时设置的用户 ID 保持一致，否则会出现请求版权音乐后台服务失败的情况。

歌曲 ID。

计费模式。

版权方。

房间 ID, 单房间模式可不传，多房间模式时必须传对应房间的 ID。指明在哪个房间进行点歌/点伴奏/点高潮片段。

房主 ID, 当计费模式为按房主计费时必传。指明按哪个房主进行点歌/点伴奏/高潮片段

场景 ID, 指明实际业务，详情可咨询 ZEGO 技术支持。

歌曲 ID。

计费模式。参考 [ZegoCopyrightedMusicBillingMode] 的值。

版权方。参考 [ZegoCopyrightedMusicVendorID] 的值。

房间 ID, 单房间模式可不传，多房间模式时必须传对应房间的 ID。指明在哪个房间进行点歌/点伴奏/点高潮片段。

房主 ID, 当计费模式为按房主计费时必传。指明按哪个房主进行点歌/点伴奏/高潮片段

场景 ID, 指明实际业务，详情可咨询 ZEGO 技术支持。

版权音乐资源类型。参考 [ZegoCopyrightedMusicResourceType] 的值。

音频采集源类型

自定义视频采集视频帧数据类型

自定义视频前处理帧数据类型。默认值为 [Unknown]。

自定义视频渲染视频帧数据类型

自定义视频渲染视频帧数据格式。当 bufferType 设置为 [EncodedData] 时，此成员无效

是否在自定义视频渲染的同时，引擎也渲染，默认为 [false]。当 bufferType 设置为 [EncodedData] 时，此成员无效

录制文件保存路径，绝对路径，需要包含文件名, 文件名需指明后缀，目前支持 .mp4/.flv/.aac 格式文件。若多次录制为同一个路径，会覆盖同名的文件。最大长度应小于 1024 字节。

录制文件媒体类型

当前录制时长, 单位为毫秒

当前录制文件大小, 单位为字节

当前录制文件的质量信息

设备 ID

设备名称

日志配置，未设置时使用默认配置(详见 [ZegoLogConfig])。

进阶功能配置，未设置时默认不使用任何特殊功能，如需使用，请联系 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]

本地日志等级。该参数仅对 Web 端有效。本地 log 级别,等级越高,打印日志越少。可取值：'debug' | 'info' | 'warn' | 'error' | 'report' | 'disable'。

音频码率，单位为 kbps，默认为 48 kbps，开始混流任务后不能修改

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

编码 ID，默认为 ZegoAudioCodecIDDefault

多路音频流混音模式。若 [ZegoAudioMixMode] 选择为 [Focused]，SDK 将会选择 4 路已设置 [isAudioFocus] 的输入流作为焦点语音突出，若未选择或选择少于 4 路，则会自动补齐 4 路。在 web 平台，此属性不生效。

图片路径，不为空显示图片，否则显示视频。支持 JPG 和 PNG 格式。支持 2 种使用方式：1. URI：将图片提供给 ZEGO 技术支持进行配置，配置完成后会提供图片 URI，例如：preset-id://xxx.jpg。2. URL：仅支持 HTTP 协议。

图片显示模式。0：默认值。当 url 不为空时，覆盖视频内容，显示图片。1：根据摄像头状态，判断是否显示图片。摄像头关闭，显示图片。摄像头打开，显示视频内容（无需手动清空 url 参数）。2：根据输入流是否有视频数据，判断是否显示图片。输入流连续3秒无视频数据时，显示图片。判断无视频数据时长默认为3秒，若需额外配置请联系 ZEGO 技术支持。输入流有视频数据时，显示视频内容。

混流内容类型

流的布局。当混入的流为音频流时（即 ContentType 参数设置为音频混流类型），开发者无需对该字段赋值，使用 SDK 默认的即可。

当混流任务开启了声浪回调时，需要为每条输入流指定唯一的 soundLevelID

输入流音量, 有效范围 [0, 200], 默认是 100。在 web 平台，此属性不生效。

当前输入流是否开启焦点语音，开启了会突出此路流的声音。在 web 平台，此属性不生效。

声音的朝向。有效的朝向是 [0, 360]。-1 表示关闭该功能。默认是 -1。在 web 平台，此属性不生效。

文字水印。

视频画面渲染模式。

用户图片信息。

视频画面圆角半径，单位 px。

设置高级配置。请联系 ZEGO 技术支持。在 web 平台，此属性不生效。

混流输出目标，URL 或者流 ID，若为 URL 格式 目前只支持 RTMP URL 格式：rtmp://xxxxxxxx, 且不能传入两个相同的混流输出的地址。

混流输出视频设置。在 web 平台，此属性不生效。

指定输出流的房间信息。

指定输出流的房间ID。需要保证开始混流时房间已存在。

指定输出流的用户ID。虚拟用户id,仅用于流新增通知，不会触发 [onRoomUserUpdate]。不建议使用与房间内实际用户相同的 userID，避免与 SDK 的流新增行为产生冲突。

混流输出视频编码格式，支持 H.264, H.265 编码。

混流输出视频码率，单位为 kbps。默认值为 [ZegoMixerVideoConfig] 中配置的 bitrate。

混流输出视频编码规格。默认值为 [ZegoEncodeProfileDefault]。

混流输出视频编码延时，有效值范围 [0, 2000], 单位毫秒。默认值为 0。

开启高清低码，默认值为 false

混流任务 ID

混流音频配置

混流视频配置

混流任务输入流列表

混流任务输出流列表

混流水印

混流背景色，颜色值对应 RGBA 为 0xRRGGBBAA，目前不支持设置背景色的透明度，0xRRGGBBAA 中的 AA 为 00 即可。例如：选取 RGB 为 #87CEFA 作为背景色，此参数传 0x87CEFA00。

混流背景图 URL

是否开启混流的声浪回调通知，开启后拉混流时可通过 [onMixerSoundLevelUpdate] 回调收到每条单流的声浪信息

混流对齐模式

用户自定义数据，长度不超过 1000 字节，设置后拉流方可通过监听 [onPlayerRecvSEI] 的回调获取 SEI 内容。

用户自定义数据长度，不超过 1000。注意 SDK 只读取长度为 userDataLength 的数据，如果 userDataLength 大于 userData 实际长度，则 SDK 按照 userData 实际长度读取数据

设置高级配置，如可用于指定视频编码等功能。如需使用，联系 ZEGO 技术支持。

设置混流服务器拉流缓存自适应调整的区间范围下限。在实时合唱 KTV 场景下，推流端网络轻微波动可能会导致混流的卡顿，此时观众拉混流的时候，会有比较高概率出现卡顿的问题。通过调节混流服务器拉流缓存自适应调整的区间范围下限，可优化观众端拉混流出现的卡顿问题，但会增大延迟。默认不设置，即服务端使用自身配置值。只会对新的输入流设置生效，对于已经开始混流的输入流不生效。

设置混流图片检查模式。

视频分辨率宽

视频分辨率高

视频帧率，开始混流任务后不能修改

视频码率，单位为 kbps

视频质量，视频码率控制模式参数设置为恒定质量时此设置值有效，有效值范围 [0,51]，默认值是 23。若想视频质量好点，在 23 的基础上降低质量值测试调整。若想文件大小小一点，在 23 的基础上升高质量值测试调整。以 x 值下的文件大小为例， x + 6 值下的文件大小是 x 值下文件大小的一半，x - 6 值下的文件大小是 x 值下文件大小的两倍。在 web 平台，此属性不生效。

视频码率控制模式。在 web 平台，此属性不生效。

已缓存的可播放时长, 单位 ms

已缓存的可播放大小, 单位 byte

同步后的网络时间戳，0表示尚未同步

最大误差

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

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

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

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

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

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

视频抗抖动帧率，单位为 f/s （1.17.0 及以上版本支持）。WebGL没有该信息。

视频解码帧率，单位为 f/s。WebGL没有该信息。

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

视频码率，单位为 kbps

视频卡顿率，单位为（卡顿次数/每10秒）（1.17.0 及以上版本支持）。WebGL没有该信息。

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

音频抗抖动帧率，单位为 f/s （1.17.0 及以上版本支持）。WebGL没有该信息。

音频解码帧率，单位为 f/s。WebGL没有该信息。

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

音频码率，单位为 kbps

音频卡顿率，单位为（卡顿次数/每10秒） （1.17.0 及以上版本支持）。WebGL没有该信息。

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

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

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

端到端延迟，单位为毫秒

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

拉流质量级别

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

是否开启硬件解码。WebGL没有该信息。

视频编码格式 （1.17.0 及以上版本支持）。WebGL没有该信息。

已接收的总字节数，包括音频、视频和 SEI 等。WebGL没有该信息。

已接收的音频字节数。WebGL没有该信息。

已接收的视频字节数。WebGL没有该信息。

拉流资源策略模式。

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

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

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

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

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

拉流资源切换策略模式，默认为 ZegoStreamResourceSwitchModeDefault。WebGL不支持设置。

下麦时切换的拉流资源类型，默认为 ZegoStreamResourceTypeDefault。当用户设置[resourceSwitchMode]为ZegoStreamResourceSwitchModeDefault或者ZegoStreamResourceSwitchModeSwitchToRTC，该设置生效。WebGL不支持设置。

是否开启流的自适应切换，1 表示开启，0 表示关闭。仅 [resourceMode] 为 ZegoStreamResourceModeOnlyL3 时有效。若需要使用请联系 ZEGO 技术支持，否则可以忽略此参数。

流的自适应转码模板ID列表，若需要使用请联系 ZEGO 技术支持，否则可以忽略此参数。

视频采集帧率，单位为 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 技术支持

编解码能力协商模式。默认不参考能力协商结果。如需要使用此功能，需要联系ZEGO技术支持。

流标题，长度不超过 255 字节的utf8编码字符串。

矩形左上角在坐标系 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]

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

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

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

能力协商使能掩码标记位，参考 [ZegoRoomCapabilityNegotiationTypesBitMask] 枚举；当转换为二进制时，0b01 即 1 << 0 表示开启房间内全员协商, 0b10 即 1 << 1 表示开启麦上用户协商。掩码可组合以使不同的协商方式同时开启。

房间附加消息的键

房间附加消息的值

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

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

SEI 类型

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

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

音浪值

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

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

流附加信息

CDN 推流的 URL

转推状态

转推状态变更的原因

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

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

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

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

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

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

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

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

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

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

360p, 15fps, 600kbps

视频帧的格式

每个平面上单行像素的字节数（此参数为 int 数组，数组长度为4，BGRA 只需考虑 strides[0]，I420 需考虑 strides[0,1,2]）

视频帧的画面宽。自定义视频采集时，满足32位对齐的视频帧可获得获取最大性能，以 BGRA 为例，即期望 width * 4 是 32 的整数倍。

视频帧的画面高

视频帧的旋转角度，SDK 以顺时针方向旋转

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

水印图片路径。支持本地文件绝对路径 (file://xxx)。 格式支持 png、jpg。最大长度要小于 512 字节。

水印图片的大小方位