Struct
ZegoAccurateSeekConfig
精准seek的配置
Declared in ZegoDefine.cs
属性
timeout
方法
ZegoAccurateSeekConfig
ZegoAudioConfig
推流音频配置
详情
配置推流的音频码率、声道数、音频编码
Declared in ZegoDefine.cs
属性
bitrate
channel
codecID
方法
ZegoAudioConfig
public void ZegoAudioConfig:this(ZegoAudioConfigPreset.StandardQuality)ZegoDefine.csZegoAudioConfig
public void ZegoAudioConfig(ZegoAudioConfigPreset presetType)ZegoDefine.csZegoAudioEffectPlayConfig
音效播放器播放配置
Declared in ZegoDefine.cs
属性
playCount
isPublishOut
ZegoAudioFrameParam
音频帧的参数对象
详情
包括音频帧的采样率、声道数
Declared in ZegoDefine.cs
属性
sampleRate
channel
ZegoAudioSourceMixConfig
音频输入源混音配置
详情
用于在设置音频输入源的同时,配置是否将媒体播放器、音效播放器和系统声音等混入推流中。
Declared in ZegoDefine.cs
属性
mediaPlayerIndexList
audioEffectPlayerIndexList
enableMixSystemPlayout
enableMixEnginePlayout
方法
ZegoAudioSourceMixConfig
ZegoAutoMixerTask
自动混流任务对象
详情
调用 [StartAutoMixerTask] 函数向 ZEGO RTC 服务器发起自动混流任务时,需要通过该参数配置自动混流任务,包括任务 ID、房间 ID、音频配置、输出流列表、是否开启声浪回调通知。
- 业务场景:当向 ZEGO RTC 服务器发起自动混流任务时,需要这个配置。
- 注意事项:作为调用 [StartAutoMixerTask] 函数时传入的参数。
Declared in ZegoDefine.cs
属性
taskID
public string taskID自动混流任务 ID,一个房间内需要保证混流任务 ID 的唯一性。
- 业务场景:当发起自动混流任务时,需要配置该参数。
- 是否必填:是。
- 建议值:根据需求设置。
- 取值范围:长度不超过 256 字节的字符串。
- 注意事项:一个房间内只能存在一个混流任务 ID,即保证混流任务 ID 的唯一性,建议混流任务 ID 与房间 ID 关联,可直接使用房间 ID 作为混流任务 ID。不可以包含 URL 关键字,例如 'http', '?' 等,否则推拉流会失败。仅支持数字,英文字符 和 '~', '!', '@', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', '’', ',', '.', '<', '>', '/', '\'。
roomID
public string roomID自动混流任务的房间 ID。
- 业务场景:当发起自动混流任务时,需要配置该参数。
- 是否必填:是。
- 建议值:根据需求设置。
- 取值范围:长度不超过 128 字节的字符串。
- 注意事项:仅支持数字,英文字符 和 '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', '’', ',', '.', '<', '>', '\'。如果需要与 Web SDK 互通,请不要使用 '%'。
audioConfig
public ZegoMixerAudioConfig audioConfig自动混流任务的音频配置,可配置音频码率、音频声道,编码 ID、多路音频流混音模式。
- 业务场景:如果对自动混流任务的音频有特殊需求,比如需要调整音频码率,可根据需要调整该参数,否则不用配置。
- 是否必填:否。
- 默认值:默认音频码率为 "48 kbps", 默认音频声道为 "ZEGO_AUDIO_CHANNEL_MONO", 默认编码 ID 为 "ZEGO_AUDIO_CODEC_ID_DEFAULT",默认多路音频流混音模式为 "ZEGO_AUDIO_MIX_MODE_RAW"。
- 建议值:根据需求设置。
outputList
public List<ZegoMixerOutput> outputList自动混流任务的输出流列表,列表中为 URL 或者流 ID,若为 URL 格式 目前只支持 RTMP URL 格式:rtmp://xxxxxxxx。
- 业务场景:当发起自动混流任务时,需要配置该参数指明混流输出目标。Mix stream output target
- 是否必填:是。
enableSoundLevel
public bool enableSoundLevel是否开启自动混流的声浪回调通知,开启后拉混流时可通过 [onAutoMixerSoundLevelUpdate] 回调收到每条单流的声浪信息。
- 业务场景:当发起自动混流任务时,如果需要回调流的声浪信息,需要配置该参数。
- 是否必填:否。
- 默认值:"false"。
- 建议值:根据需求设置。
streamAlignmentMode
方法
ZegoAutoMixerTask
ZegoBarrageMessageInfo
房间弹幕消息
详情
收到的房间弹幕消息对象,包括消息内容、消息 ID、发送人、发送时间
Declared in ZegoDefine.cs
属性
message
messageID
sendTime
fromUser
ZegoBeautifyOption
美颜配置选项
详情
配置美颜的磨皮、美白、锐化参数
Declared in ZegoDefine.cs
属性
polishStep
whitenFactor
sharpenFactor
ZegoBroadcastMessageInfo
房间广播消息
详情
收到的房间广播消息对象,包括消息内容、消息 ID、发送人、发送时间
Declared in ZegoDefine.cs
属性
message
messageID
sendTime
fromUser
ZegoCDNConfig
CDN 配置对象
详情
包括 CDN 的 URL 以及鉴权参数字符串
Declared in ZegoDefine.cs
属性
url
authParam
protocol
public string protocolURL 支持的协议,可选值为 "tcp" 和 "quic",若要使用多个,用英文的逗号分割,按顺序尝试。若需要使用请联系 ZEGO 技术支持,否则可以忽略此参数(可以留空或设置为空字符串)。
quicVersion
public string quicVersionQUIC 版本。如果 [protocol] 有 QUIC 协议,需要填写该信息。如果有多个版本号,用英文的逗号分割。若需要使用请联系 ZEGO 技术支持,否则可以忽略此参数(可以留空或设置为空字符串)。
httpdns
quicConnectMode
public int quicConnectModeQUIC 建立链接模式,若为1 则会优先使用quic 0 rtt 去建立链接,否则正常建立链接。如果 [protocol] 有 QUIC 协议,此值生效。
customParams
方法
ZegoCDNConfig
ZegoCanvas
视图对象
详情
配置 View 对象、视图模式、视图背景颜色
Declared in ZegoDefine.cs
属性
view
viewMode
backgroundColor
ZegoColorEnhancementParams
色彩增强参数。
Declared in ZegoDefine.cs
属性
intensity
skinToneProtectionLevel
lipColorProtectionLevel
方法
ZegoColorEnhancementParams
ZegoCopyrightedMusicConfig
版权音乐配置
Declared in ZegoDefine.cs
属性
user
public ZegoUser user用户对象实例,配置用户 ID、用户名。 注意此处设置的用户 ID 需要与登录房间时设置的用户 ID 保持一致,否则会出现请求版权音乐后台服务失败的情况。
ZegoCopyrightedMusicGetLyricConfig
获取歌词的配置。
Declared in ZegoDefine.cs
属性
songID
vendorID
方法
ZegoCopyrightedMusicGetLyricConfig
public void ZegoCopyrightedMusicGetLyricConfig()ZegoDefine.csZegoCopyrightedMusicGetSharedConfig
获取分享资源的配置。
Declared in ZegoDefine.cs
属性
songID
vendorID
roomID
mode
public ZegoCopyrightedMusicBillingMode mode版权音乐计费模式。 仅当在 Web 端使用并且使用的版权商 vendorID 值为 ZegoCopyrightedMusicVendor1 时必传。
masterID
ZegoCopyrightedMusicGetSharedConfigV2
获取分享资源的配置。
Declared in ZegoDefine.cs
属性
songID
vendorID
roomID
resourceType
mode
masterID
ZegoCopyrightedMusicQueryCacheConfig
查询缓存的配置。
Declared in ZegoDefine.cs
属性
songID
resourceType
resourceQualityType
vendorID
方法
ZegoCopyrightedMusicQueryCacheConfig
public void ZegoCopyrightedMusicQueryCacheConfig()ZegoDefine.csZegoCopyrightedMusicQueryCacheConfigV2
查询缓存的配置。
Declared in ZegoDefine.cs
属性
songID
resourceType
resourceQualityType
public int resourceQualityType版权音乐资源音质类型。参考 [ZegoCopyrightedMusicResourceQualityType] 的值。
vendorID
方法
ZegoCopyrightedMusicQueryCacheConfigV2
public void ZegoCopyrightedMusicQueryCacheConfigV2()ZegoDefine.csZegoCopyrightedMusicRequestConfig
获取资源的配置。
Declared in ZegoDefine.cs
属性
songID
mode
vendorID
roomID
masterID
sceneID
ZegoCopyrightedMusicRequestConfigV2
获取资源的配置。
Declared in ZegoDefine.cs
属性
songID
mode
vendorID
roomID
masterID
sceneID
resourceType
方法
ZegoCopyrightedMusicRequestConfigV2
public void ZegoCopyrightedMusicRequestConfigV2()ZegoDefine.csZegoCustomAudioConfig
自定义音频配置
Declared in ZegoDefine.cs
属性
sourceType
ZegoCustomVideoCaptureConfig
自定义视频采集配置
详情
自定义视频采集,即由开发者负责采集视频数据,并将采集到的视频数据发送给 SDK 进行视频数据的编码与推送到 ZEGO RTC 服务器。该功能一般为使用第三方美颜功能或游戏录屏直播的开发者使用。 当需要使用自定义采集功能时需要将该类的实例作为参数设置给 [enableCustomVideoCapture] 函数。 由于使用自定义视频采集时,SDK 将不再启动摄像头去采集视频数据,开发者需自行对视频采集源进行视频数据的采集。
Declared in ZegoDefine.cs
属性
bufferType
ZegoCustomVideoProcessConfig
自定义视频前处理配置
Declared in ZegoDefine.cs
属性
bufferType
ZegoCustomVideoRenderConfig
自定义视频渲染配置
详情
当需要使用自定义渲染功能时需要将该类的实例作为参数设置给 [enableCustomVideoRender] 函数。
Declared in ZegoDefine.cs
属性
bufferType
frameFormatSeries
public ZegoVideoFrameFormatSeries frameFormatSeries自定义视频渲染视频帧数据格式。当 bufferType 设置为 [EncodedData] 时,此成员无效
enableEngineRender
public bool enableEngineRender是否在自定义视频渲染的同时,引擎也渲染,默认为 [false]。当 bufferType 设置为 [EncodedData] 时,此成员无效
ZegoDataRecordConfig
录制配置
Declared in ZegoDefine.cs
属性
filePath
public string filePath录制文件保存路径,绝对路径,需要包含文件名, 文件名需指明后缀,目前支持 .mp4/.flv/.aac 格式文件。若多次录制为同一个路径,会覆盖同名的文件。最大长度应小于 1024 字节。
recordType
方法
ZegoDataRecordConfig
ZegoDataRecordProgress
文件录制进度
Declared in ZegoDefine.cs
属性
duration
currentFileSize
quality
ZegoDeviceInfo
设备信息
详情
包括设备的 ID 与名称
Declared in ZegoDefine.cs
属性
deviceID
deviceName
deviceExtraInfo
public string deviceExtraInfo设备附加信息, 格式:key="value" key2="value2"..., 以换行符 分隔键值对,以等号=分隔key和"value", value的前后还有双引号
ZegoEffectsBeautyParam
美颜配置参数
详情
配置美颜的美白、红润、磨皮、锐化参数。
Declared in ZegoDefine.cs
属性
whitenIntensity
rosyIntensity
smoothIntensity
sharpenIntensity
方法
ZegoEffectsBeautyParam
ZegoEngineConfig
引擎进阶配置
Declared in ZegoDefine.cs
属性
logConfig
public ZegoLogConfig logConfig日志配置,未设置时使用默认配置(详见 [ZegoLogConfig])。
advancedConfig
public Dictionary<string, string> advancedConfig进阶功能配置,未设置时默认不使用任何特殊功能,如需使用,请联系 ZEGO 技术支持。
ZegoEngineProfile
创建引擎的配置
详情
创建引擎的配置
Declared in ZegoDefine.cs
属性
appID
public uint appIDZEGO 为开发者签发的应用 ID,请从 ZEGO 管理控制台 https://console-express.zego.im 申请。appID 取值范围 0~4294967295。
appSign
public string appSign- 取值范围:'0' ~ '9', 'a' ~ 'z'。例:"9dc9a25bh2f2137446897071c8c033fa33b91c3dd2a85e0c000ae82c0dad3"。2.17.0 及以上版本 appSign 允许传空或者不传。如果传空或者不传,则必须在调用 [loginRoom] 接口登录房间时将 token 填入 [ZegoRoomConfig] 参数中,用于鉴权。token 的生成方式请参考 使用 Token 鉴权 。
scenario
public ZegoScenario scenario房间场景,SDK 会针对指定的场景的做一些音视频配置优化以达成在此场景下最优的效果。指定场景后,开发者可以使用 [setRoomScenario] 来实现在不销毁引擎 [destroyEngine] 的前提下切换其他场景。指定场景后,开发者可以调用其他 API 来继续调整音视频配置。各个场景之间的差异以及如何选择合适的场景请参考 https://doc-zh.zego.im/article/16316
callbackInMainThread
方法
ZegoEngineProfile
ZegoFontStyle
字体风格。
详情
字体风格配置,可用于配置字体类型、字体大小、字体颜色、字体透明度。
- 业务场景:手动混流场景时,设置文字水印,比如多人连麦直播。
Declared in ZegoDefine.cs
属性
type
size
color
transparency
border
borderColor
方法
ZegoFontStyle
ZegoImageBuffer
图像数据内容
Declared in ZegoDefine.cs
属性
buffer
length
width
height
ZegoLabelInfo
文本信息。
详情
文本信息配置,可用于配置文本内容、文本位置、文本风格。
- 业务场景:手动混流场景时,设置文字水印,比如多人连麦直播。
Declared in ZegoDefine.cs
属性
text
left
top
font
方法
ZegoLabelInfo
ZegoLogConfig
日志配置
详情
调用 [setLogConfig] 自定义日志配置时,需要通过该参数配置。
- 业务场景:当需要自定义日志存储路径或日志文件大小上限时,需要这个配置。
- 注意事项:无。
Declared in ZegoDefine.cs
属性
logPath
public string logPath用于自定义日志文件的存储路径。
- 业务场景:当需要自定义日志存储路径时,需要这个配置。
- 是否必填:否。
- 默认值:各平台的默认路径有所不同,具体参考官网文档 https://doc-zh.zego.im/faq/express_sdkLog
- 注意事项:开发者需要确保对该路径下文件的读写权限。
logSize
public ulong logSize用于自定义日志文件大小上限。
- 业务场景:当需要自定义日志文件大小上限时,需要这个配置。
- 是否必填:否。
- 默认值:5MB (5 * 1024 * 1024 Bytes)。
- 取值范围:最小1MB (1 * 1024 * 1024 Bytes),最大100M (100 * 1024 * 1024 Bytes),0表示不需要写日志。
- 注意事项:日志文件大小上限越大,承载的日志信息越多,但是日志上传时间也会更长。
logCount
logLevel
public string logLevel本地日志等级。该参数仅对 Web 端有效。本地 log 级别,等级越高,打印日志越少。可取值:'debug' | 'info' | 'warn' | 'error' | 'report' | 'disable'。
方法
ZegoLogConfig
ZegoMediaPlayerResource
用于指定播放器的多媒体资源。
详情
用于在加载多媒体资源时,配置加载参数。
Declared in ZegoDefine.cs
属性
loadType
startPosition
filePath
memory
memoryLength
resourceID
onlineResourceCachePath
maxCachePendingLength
public long maxCachePendingLength在线资源最大的缓存待使用长度,单位 byte,最小设置 10M(10 * 1024 * 1024),默认0-不做限制,尝试缓存整个文件。
方法
ZegoMediaPlayerResource
ZegoMixerAudioConfig
混流音频配置
详情
配置混流任务的音频码率、声道数、音频编码
Declared in ZegoDefine.cs
属性
bitrate
channel
codecID
mixMode
public ZegoAudioMixMode mixMode多路音频流混音模式。若 [ZegoAudioMixMode] 选择为 [Focused],SDK 将会选择 4 路已设置 [isAudioFocus] 的输入流作为焦点语音突出,若未选择或选择少于 4 路,则会自动补齐 4 路。在 web 平台,此属性不生效。
方法
ZegoMixerAudioConfig
ZegoMixerImageInfo
设置混流中单条输入流的图片信息。
详情
为单条输入流的内容设置图片,用于替代视频,即当使用图片时不显示视频。图片复用的 [ZegoMixerInput] 中的 layout 布局。
- 业务场景:开发者在视频连麦过程中,需要暂时关闭摄像头显示图像,或音频连麦时,显示图片等。
- 支持版本:2.19.0 及以上。
- 使用限制:图片大小限制在 1M 以内。
Declared in ZegoDefine.cs
属性
url
public string url图片路径,不为空显示图片,否则显示视频。支持 JPG 和 PNG 格式。支持 2 种使用方式:1. URI:将图片提供给 ZEGO 技术支持进行配置,配置完成后会提供图片 URI,例如:preset-id://xxx.jpg。2. URL:仅支持 HTTP 协议。
displayMode
public int displayMode图片显示模式。0:默认值。当 url 不为空时,覆盖视频内容,显示图片。1:根据摄像头状态,判断是否显示图片。摄像头关闭,显示图片。摄像头打开,显示视频内容(无需手动清空 url 参数)。2:根据输入流是否有视频数据,判断是否显示图片。输入流连续3秒无视频数据时,显示图片。判断无视频数据时长默认为3秒,若需额外配置请联系 ZEGO 技术支持。输入流有视频数据时,显示视频内容。
方法
ZegoMixerImageInfo
ZegoMixerImageInfo
public void ZegoMixerImageInfo(string url, int displayMode)ZegoDefine.csZegoMixerInput
混流输入
详情
配置混流输入的流 ID、输入类型、流的布局
Declared in ZegoDefine.cs
属性
streamID
contentType
layout
soundLevelID
volume
isAudioFocus
audioDirection
label
renderMode
imageInfo
cornerRadius
advancedConfig
方法
ZegoMixerInput
public void ZegoMixerInput(string streamID, ZegoMixerInputContentType contentType, ZegoRect layout)ZegoDefine.csZegoMixerInput
public void ZegoMixerInput(string streamID, ZegoMixerInputContentType contentType, ZegoRect layout, uint soundLevelID)ZegoDefine.csZegoMixerOutput
混流输出对象,目前一个混流任务最多只支持 4 路不同分辨率的视频流。
详情
配置混流输出的目标 URL 或流 ID
Declared in ZegoDefine.cs
属性
target
public string target混流输出目标,URL 或者流 ID,若为 URL 格式 目前只支持 RTMP URL 格式:rtmp://xxxxxxxx, 且不能传入两个相同的混流输出的地址。
videoConfig
targetRoom
方法
ZegoMixerOutput
ZegoMixerOutputRoomInfo
混流中输出流的房间信息。
详情
为单条输出流设置房间信息;能将混流输出流增加到指定房间,让房间内的用户接收到房间内流增加的通知。
- 业务场景:手动混流场景,比如多人连麦直播。
- 支持版本:3.18.0 及以上。
- 使用限制:不支持混流过程中动态更新。
Declared in ZegoDefine.cs
属性
roomID
userID
public string userID指定输出流的用户ID。虚拟用户id,仅用于流新增通知,不会触发 [onRoomUserUpdate]。不建议使用与房间内实际用户相同的 userID,避免与 SDK 的流新增行为产生冲突。
方法
ZegoMixerOutputRoomInfo
public void ZegoMixerOutputRoomInfo(String roomID, String userID)ZegoDefine.csZegoMixerOutputVideoConfig
混流输出视频配置。
详情
配置混流输出的视频参数,编码格式、码率。
- 业务场景:手动混流场景,比如多人连麦直播。
Declared in ZegoDefine.cs
属性
videoCodecID
bitrate
encodeProfile
encodeLatency
enableLowBitrateHD
方法
ZegoMixerOutputVideoConfig
ZegoMixerTask
混流任务对象
详情
本类为混流任务的配置类,当向 ZEGO RTC 服务器发起混流任务的请求时,需要这个混流任务的配置。 本类即描述这次混流任务的详细配置信息。
Declared in ZegoDefine.cs
属性
taskID
audioConfig
videoConfig
inputList
outputList
watermark
backgroundColor
public int backgroundColor混流背景色,颜色值对应 RGBA 为 0xRRGGBBAA,目前不支持设置背景色的透明度,0xRRGGBBAA 中的 AA 为 00 即可。例如:选取 RGB 为 #87CEFA 作为背景色,此参数传 0x87CEFA00。
backgroundImageURL
enableSoundLevel
public bool enableSoundLevel是否开启混流的声浪回调通知,开启后拉混流时可通过 [onMixerSoundLevelUpdate] 回调收到每条单流的声浪信息
streamAlignmentMode
userData
userDataLength
public uint userDataLength用户自定义数据长度,不超过 1000。注意 SDK 只读取长度为 userDataLength 的数据,如果 userDataLength 大于 userData 实际长度,则 SDK 按照 userData 实际长度读取数据
advancedConfig
public Dictionary<string, string> advancedConfig设置高级配置,如可用于指定视频编码等功能。如需使用,联系 ZEGO 技术支持。
minPlayStreamBufferLength
public int minPlayStreamBufferLength设置混流服务器拉流缓存自适应调整的区间范围下限。在实时合唱 KTV 场景下,推流端网络轻微波动可能会导致混流的卡顿,此时观众拉混流的时候,会有比较高概率出现卡顿的问题。通过调节混流服务器拉流缓存自适应调整的区间范围下限,可优化观众端拉混流出现的卡顿问题,但会增大延迟。默认不设置,即服务端使用自身配置值。只会对新的输入流设置生效,对于已经开始混流的输入流不生效。
- 取值范围:[0,10000],超过最大值混流会失败。在 web 平台,此属性不生效。
mixImageCheckMode
方法
ZegoMixerTask
ZegoMixerVideoConfig
混流视频配置
详情
配置混流任务的视频参数,帧率、码率、分辨率
Declared in ZegoDefine.cs
属性
width
height
fps
bitrate
quality
public int quality视频质量,视频码率控制模式参数设置为恒定质量时此设置值有效,有效值范围 [0,51],默认值是 23。若想视频质量好点,在 23 的基础上降低质量值测试调整。若想文件大小小一点,在 23 的基础上升高质量值测试调整。以 x 值下的文件大小为例, x + 6 值下的文件大小是 x 值下文件大小的一半,x - 6 值下的文件大小是 x 值下文件大小的两倍。在 web 平台,此属性不生效。
rateControlMode
方法
ZegoMixerVideoConfig
ZegoMixerVideoConfig
public void ZegoMixerVideoConfig(int width, int height, int fps, int bitrate)ZegoDefine.csZegoNetWorkResourceCache
媒体播放器网络缓存信息
Declared in ZegoDefine.cs
属性
time
size
ZegoNetworkTimeInfo
网络时间戳信息
Declared in ZegoDefine.cs
属性
timestamp
maxDeviation
ZegoPerformanceStatus
系统性能监控状态
Declared in ZegoDefine.cs
属性
cpuUsageApp
cpuUsageSystem
memoryUsageApp
memoryUsageSystem
memoryUsedApp
ZegoPlayStreamQuality
拉流质量对象
详情
音视频参数与网络质量等
Declared in ZegoDefine.cs
属性
videoRecvFPS
videoDejitterFPS
videoDecodeFPS
videoRenderFPS
videoKBPS
videoBreakRate
audioRecvFPS
audioDejitterFPS
audioDecodeFPS
audioRenderFPS
audioKBPS
audioBreakRate
mos
public double mos音频 MOS (平均主观意见分) 评估方法对拉流音频的质量评分,取值范围 [-1, 5],其中 -1 表示未知,[0, 5] 表示有效的评分,分数越高,音频质量越好。评分对应的主观感受请查阅 https://doc-zh.zego.im/article/1074#4_4 (2.16.0 及以上版本支持)。WebGL没有该信息。
rtt
packetLostRate
peerToPeerDelay
peerToPeerPacketLostRate
level
delay
avTimestampDiff
isHardwareDecode
videoCodecID
totalRecvBytes
audioRecvBytes
videoRecvBytes
ZegoPlayerConfig
拉流进阶配置。
详情
配置资源策略模式、CDN 配置以及其他高级配置。
Declared in ZegoDefine.cs
属性
resourceMode
cdnConfig
public ZegoCDNConfig cdnConfig拉流的 CDN 配置,若设置后,则按照 URL 拉流而不是按照 streamID 拉流,此后 streamID 仅作为 SDK 内部回调的标识。WebGL不支持设置。
roomID
videoCodecID
sourceResourceType
public ZegoResourceType sourceResourceType源流的资源类型,若需要使用请联系 ZEGO 技术支持,否则可以忽略此参数。WebGL不支持设置。
codecTemplateID
resourceSwitchMode
public ZegoStreamResourceSwitchMode resourceSwitchMode拉流资源切换策略模式,默认为 ZegoStreamResourceSwitchModeDefault。WebGL不支持设置。
resourceWhenStopPublish
public ZegoStreamResourceType resourceWhenStopPublish下麦时切换的拉流资源类型,默认为 ZegoStreamResourceTypeDefault。当用户设置[resourceSwitchMode]为ZegoStreamResourceSwitchModeDefault或者ZegoStreamResourceSwitchModeSwitchToRTC,该设置生效。WebGL不支持设置。
adaptiveSwitch
public int adaptiveSwitch是否开启流的自适应切换,1 表示开启,0 表示关闭。仅 [resourceMode] 为 ZegoStreamResourceModeOnlyL3 时有效。若需要使用请联系 ZEGO 技术支持,否则可以忽略此参数。
adaptiveTemplateIDList
public List<int> adaptiveTemplateIDList流的自适应转码模板ID列表,若需要使用请联系 ZEGO 技术支持,否则可以忽略此参数。
方法
ZegoPlayerConfig
ZegoPosition
用户位置坐标
Declared in ZegoDefine.cs
属性
coordinate
motionOrientation
cameraOrientation
方法
ZegoPosition
ZegoPositionOrientation
朝向。
Declared in ZegoDefine.cs
属性
axisForward
axisRight
axisUp
ZegoProxyInfo
代理信息。
详情
配置代理信息。
Declared in ZegoDefine.cs
属性
ip
port
hostName
userName
password
方法
ZegoProxyInfo
ZegoPublishDualStreamConfig
大小流的配置信息
Declared in ZegoDefine.cs
属性
streamType
encodeWidth
encodeHeight
fps
bitrate
ZegoPublishStreamQuality
推流质量对象
详情
音视频参数与网络质量等
Declared in ZegoDefine.cs
属性
videoCaptureFPS
videoEncodeFPS
videoSendFPS
videoKBPS
audioCaptureFPS
audioSendFPS
audioKBPS
rtt
packetLostRate
level
isHardwareEncode
videoCodecID
totalSendBytes
audioSendBytes
videoSendBytes
ZegoPublisherConfig
推流进阶配置
详情
配置房间 ID
Declared in ZegoDefine.cs
属性
roomID
forceSynchronousNetworkTime
public int forceSynchronousNetworkTime推流时是否同步网络时间,1-同步 0-不同步。且必须与 setStreamAlignmentProperty配合使用。用于在混流服务或拉流端对多条流进行对齐,比如 KTV 的合唱场景。
streamCensorshipMode
public ZegoStreamCensorshipMode streamCensorshipMode推流时,审查流的模式。默认不审查。如需要使用此功能,需要联系ZEGO技术支持。
streamCensorFlag
codecNegotiationType
public ZegoCapabilityNegotiationType codecNegotiationType编解码能力协商模式。默认不参考能力协商结果。如需要使用此功能,需要联系ZEGO技术支持。
streamTitle
方法
ZegoPublisherConfig
ZegoReceiveRangeParam
接收范围配置。
Declared in ZegoDefine.cs
属性
min
max
方法
ZegoReceiveRangeParam
ZegoRect
视图相关所使用的坐标
Declared in ZegoDefine.cs
属性
x
y
width
height
方法
ZegoRect
ZegoRect
ZegoReverbAdvancedParam
音频混响高级参数
详情
开发者可以使用 SDK 的内置预置来改变混响的参数。
Declared in ZegoDefine.cs
属性
roomSize
reverberance
damping
wetOnly
wetGain
dryGain
toneLow
toneHigh
preDelay
stereoWidth
方法
ZegoReverbAdvancedParam
ZegoReverbEchoParam
音频混响回声参数
Declared in ZegoDefine.cs
属性
inGain
outGain
numDelays
delay
decay
ZegoRoomConfig
房间进阶配置
详情
配置房间的最大用户数量、鉴权 token 等
Declared in ZegoDefine.cs
属性
maxMemberCount
isUserStatusNotify
public bool isUserStatusNotify是否开启用户进出房间回调通知 [onRoomUserUpdate],默认关闭。若开发者需要使用 ZEGO 房间用户广播通知,请确保每个登录的用户都将此标记设置为true
token
public string token由开发者业务服务器下发的 token,用以保证安全性,生成规则请参考 使用 Token 鉴权,默认为空字符串,即不鉴权。2.17.0 及以上版本如果调用 [createEngine] 接口创建引擎时未传入appSign,或者appSign为空,则登录房间时必须设置此参数用于鉴权。
capabilityNegotiationTypes
public uint capabilityNegotiationTypes能力协商使能掩码标记位,参考 [ZegoRoomCapabilityNegotiationTypesBitMask] 枚举;当转换为二进制时,0b01 即 1 << 0 表示开启房间内全员协商, 0b10 即 1 << 1 表示开启麦上用户协商。掩码可组合以使不同的协商方式同时开启。
方法
ZegoRoomConfig
ZegoRoomExtraInfo
房间附加消息
Declared in ZegoDefine.cs
属性
key
value
updateUser
updateTime
ZegoSEIConfig
SEI 配置
详情
用于设置媒体增强补充信息的相关配置。
Declared in ZegoDefine.cs
属性
type
ZegoSceneConfig
场景配置。
Declared in ZegoDefine.cs
属性
channelCount
ZegoSceneParam
场景参数。
Declared in ZegoDefine.cs
属性
user
sceneID
templateID
position
broadcastMode
token
方法
ZegoSceneParam
ZegoScenePlayerConfig
场景拉流进阶配置。
Declared in ZegoDefine.cs
属性
rangeSceneHandle
resourceMode
cdnConfig
public ZegoCDNConfig cdnConfig拉流的 CDN 配置,若设置后,则按照 URL 拉流而不是按照 streamID 拉流,此后 streamID 仅作为 SDK 内部回调的标识。
方法
ZegoScenePlayerConfig
ZegoScenePublisherConfig
场景推流进阶配置。
Declared in ZegoDefine.cs
属性
rangeSceneHandle
ZegoSceneStreamConfig
场景推拉流模式。
Declared in ZegoDefine.cs
属性
enablePlayInRange
enablePublishToWorld
方法
ZegoSceneStreamConfig
ZegoScreenCaptureConfig
屏幕采集配置参数。
Declared in ZegoDefine.cs
属性
captureVideo
captureAudio
microphoneVolume
public uint microphoneVolume设置屏幕录制时 Microphone 音频音量。范围为 0 ~ 200,默认为 100。(仅适用 iOS 平台)
applicationVolume
public uint applicationVolume设置屏幕录制时 Application 音频音量。范围为 0 ~ 200,默认为 100。(适用于 iOS 和 Android 平台)
audioParam
方法
ZegoScreenCaptureConfig
ZegoScreenCaptureSourceInfo
屏幕采集源信息。
Declared in ZegoDefine.cs
属性
sourceType
sourceID
sourceName
thumbnailImage
iconImage
ZegoSoundLevelConfig
启动声浪监控的配置
详情
用于 startSoundLevelMonitor 函数,其中的 enableVAD 参数用于设置声浪回调是否检测 VAD,开启后结果将从 [onCapturedSoundLevelInfoUpdate] 和 [onRemoteSoundLevelInfoUpdate] 回调中体现。
- 业务场景:开发者需要判断用户说话音量是否太小时,可开启 VAD 声音检测。
- 支持版本:2.10.0 及以上。
- 注意事项:VAD 算法有性能开销,建议按需设置。
Declared in ZegoDefine.cs
属性
millisecond
enableVAD
ZegoSoundLevelInfo
声浪信息对象
Declared in ZegoDefine.cs
属性
soundLevel
vad
public int vadStreamID 对应的流是否包含声音,0: 表示噪声,1: 表示正常声音;调用 [startSoundLevelMonitor] 时设置的 ZegoSoundLevelConfig 配置中的 enableVAD 参数设为 true 后此值才有效。
ZegoStream
音视频流对象
详情
标识一条音视频流
Declared in ZegoDefine.cs
属性
user
streamID
extraInfo
ZegoStreamRelayCDNInfo
转推 CDN 信息
详情
包括转推 CDN 的 URL、转推状态等
Declared in ZegoDefine.cs
属性
url
state
updateReason
stateTime
ZegoUser
用户对象
详情
配置用户 ID 和用户名,用于标识房间内的用户。 注意 userID 在同一个 appID 下需唯一,否则登录房间时会出现互踢的情况。 强烈建议 userID 与业务 APP 的用户 ID 一一对应,即一个 userID 与一个真实用户是固定且唯一的,而不应该是以随机的 userID 的方式传给 SDK 的方式。因为唯一且固定的 userID 可以让 ZEGO 技术人员快速定位线上问题。
Declared in ZegoDefine.cs
属性
userID
public string userID- 隐私保护声明:请勿在此字段填写用户敏感信息,包括但不限于手机号、身份证号、护照编号、真实姓名等。
- 注意事项:仅支持数字,英文字符 和 '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', '’', ',', '.', '<', '>', '\'。如果需要与 Web SDK 互通,请不要使用 '%'。
userName
public string userName用户名,最大长度不超过 256 字节的utf8编码字符串。请勿在此字段填写用户敏感信息,包括但不限于手机号、身份证号、护照编号、真实姓名等。
方法
ZegoUser
ZegoUser
ZegoVideoConfig
视频配置
详情
配置码率、帧率、分辨率等推流用到的参数。 开发者应该注意的是,移动端与桌面端的宽高分辨率是相反的,例如,360p,移动端的分辨率为 360x640,而桌面端为 640x360。 使用外部采集时,RTC的采集和编码分辨率不能设置为0*0,不然会导致整个引擎生命周期里的推流,都没有视频数据。
Declared in ZegoDefine.cs
属性
captureWidth
public int captureWidth采集分辨率宽度,控制摄像头图像采集的宽度。SDK 要求设置此成员为偶数。仅摄像头启动前且没有使用自定义视频采集时,设置有效。出于性能考虑,SDK 在采集摄像头画面后、渲染预览画面之前,就将视频帧缩放为编码分辨率,因此预览画面的分辨率是编码分辨率,如果您需要预览画面的分辨率为此值,请先调用 [setCapturePipelineScaleMode] 将采集缩放模式改为 [Post]。WebGL不支持设置。
captureHeight
public int captureHeight采集分辨率高度,控制摄像头图像采集的高度。SDK 要求设置此成员为偶数。仅摄像头启动前且没有使用自定义视频采集时,设置有效。出于性能考虑,SDK 在采集摄像头画面后、渲染预览画面之前,就将视频帧缩放为编码分辨率,因此预览画面的分辨率是编码分辨率,如果您需要预览画面的分辨率为此值,请先调用 [setCapturePipelineScaleMode] 将采集缩放模式改为 [Post]。WebGL不支持设置。
encodeWidth
encodeHeight
fps
bitrate
public int bitrate码率,单位为 kbps。推流前后设置均可生效。SDK 会根据开发者选择的场景,自动设置适配该场景的码率。若开发者手动设置的码率超出合理范围,SDK会自动按照合理区间处理码率。如因业务需要配置高码率,请联系 ZEGO 商务。
codecID
keyFrameInterval
public int keyFrameInterval视频关键帧间隔,单位秒。
- 是否必填:否。
- 默认值:2秒。
- 取值范围:[2, 5]。
- 注意事项:仅在推流前设置有效。
方法
ZegoVideoConfig
public void ZegoVideoConfig(ZegoVideoConfigPreset preset)ZegoDefine.csZegoVideoConfig
public void ZegoVideoConfig : this(ZegoVideoConfigPreset.Preset360P)ZegoDefine.cs360p, 15fps, 600kbps
ZegoVideoFrameParam
视频帧的参数对象
详情
包括视频帧的格式、宽高等
Declared in ZegoDefine.cs
属性
format
strides
public int[] strides每个平面上单行像素的字节数(此参数为 int 数组,数组长度为4,BGRA 只需考虑 strides[0],I420 需考虑 strides[0,1,2])
width
height
rotation
ZegoVocalRangeParam
发声范围配置。
Declared in ZegoDefine.cs
属性
min
max
方法
ZegoVocalRangeParam
ZegoVoiceChangerParam
变声器参数
详情
开发者可以使用 SDK 的内置预置来改变变声器的参数。
Declared in ZegoDefine.cs
属性
pitch
public float pitch音调参数,取值范围 [-12.0, 12.0],数值越大声音越尖,设为 0.0 即关闭变声器。注意在 2.18.0 及更老版本上,取值范围为 [-8.0, 8.0]。
方法
ZegoVoiceChangerParam
ZegoWatermark
水印对象
详情
配置一个水印的图片 URL 以及该水印在画面中的大小方位。
Declared in ZegoDefine.cs

