Enum

AiDenoiseMode

AI 降噪处理的模式

详情

AI 降噪处理的模式。

属性

AI

AI=(0)

AI 模式噪声抑制，会对音乐有较大损伤，故不能用于对需要采集背景音的音源进行噪声抑制

AIBalanced

AIBalanced=(1)

均衡 AI 模式噪声抑制，会对音乐有较大损伤，故不能用于对需要采集背景音的音源进行噪声抑制

ExceptionCode

详情

推拉流采集、编码解码异常/恢复正常的事件码

属性

captureFpsToLow

captureFpsToLow=(1001)

采集帧率过低

captureVolumeToLow

captureVolumeToLow=(1002)

采集音量过低

sendVideoBitrateToLow

sendVideoBitrateToLow=(1003)

发送视频码率过低

sendFpsToLow

sendFpsToLow=(1004)

发送视频帧率过低

sendAudioBitrateToLow

sendAudioBitrateToLow=(1005)

发送音频码率过低

receiveVolumeToLow

receiveVolumeToLow=(1006)

接收音量过低

receiveAudioDecodedFail

receiveAudioDecodedFail=(1007)

接收音频解码失败

ReceiveVideoDecodedFail

ReceiveVideoDecodedFail=(1008)

接收视频解码失败

receiveVideoFpsDecodedToLow

receiveVideoFpsDecodedToLow=(1009)

接收视频解码帧率过低

renderVideoFpsToLow

renderVideoFpsToLow=(1010)

渲染帧率过低

captureFpsNormal

captureFpsNormal=(2001)

采集帧率恢复正常

captureVolumeNormal

captureVolumeNormal=(2002)

采集音量恢复正常

sendVideoBitrateNormal

sendVideoBitrateNormal=(2003)

发送视频码率恢复正常

sendFpsNormal

sendFpsNormal=(2004)

发送视频帧率恢复正常

sendAudioBitrateNormal

sendAudioBitrateNormal=(2005)

发送音频码率恢复正常

receiveVolumeNormal

receiveVolumeNormal=(2006)

接收音量恢复正常

receiveAudioDecodedNormal

receiveAudioDecodedNormal=(2007)

接收音频解码恢复正常

receiveVideoDecodedNormal

receiveVideoDecodedNormal=(2008)

接收视频解码恢复正常

receiveVideoFpsDecodedNormal

receiveVideoFpsDecodedNormal=(2009)

接收视频解码帧率恢复正常

renderVideoFpsNormal

renderVideoFpsNormal=(2010)

渲染视频帧率恢复正常

Segmentation

背景处理分割模式

属性

PortraitSegmentation

PortraitSegmentation=(0)

人像分割

TrafficControlFocusOnMode

详情

触发推流流量控制的因素。

属性

TrafficControlFocusOnLocalOnly

TrafficControlFocusOnLocalOnly=(0)

只关注本地网络

TrafficControlFocusOnRemote

TrafficControlFocusOnRemote=(1)

关注本地网络，同时也兼顾远端网络，目前只在 1v1 场景下有效

ZegoAudioCodecID

音频编码器 ID

属性

ZegoAudioCodecIDNormal

ZegoAudioCodecIDNormal=(1)

可用于 RTC 和 CDN 推流；码率范围 10kbps ~ 128kbps；支持双声道；延迟在 500ms 左右

ZegoAudioCodecIDNormal2

ZegoAudioCodecIDNormal2=(2)

可用于 RTC 和 CDN 推流；兼容性好，码率范围 16kbps ~ 192kbps；支持双声道；延迟 350ms 左右；相同码率下（较低码率），音质弱于 [Normal]。

ZegoAudioCodecIDLow3

ZegoAudioCodecIDLow3=(6)

仅可用于 RTC 推流；码率范围 10kbps ~ 192kbps；支持双声道；延迟在 200ms 左右；相同码率下（较低码率），音质明显好于 [Normal] 与 [Normal2]；CPU 开销较低。

ZegoAudioMixMode

音频混音模式

属性

ZegoAudioMixModeRaw

ZegoAudioMixModeRaw=(0)

默认模式，无特殊行为

ZegoAudioMixModeFocused

ZegoAudioMixModeFocused=(1)

音频聚焦模式，可在多路音频流中突出某路流的声音

ZegoCopyrightedMusicBillingMode

点歌计费模式。

属性

Count

Count=(0)

按次计费。用户每获取一次歌曲资源都需要计一次费用，即根据实际调用获取歌曲资源接口（如 [requestResource] 接口）传参为按次的用户进行收费。

User

User=(1)

按用户包月计费。按月维度向单个用户计费，即统计调用获取歌曲资源传参为按用户包月的用户 ID，按月维度进行收费。

Room

Room=(2)

按房间包月计费。按月维度向房间用户计费，即统计调用获取歌曲资源传参为按房间包月的 roomID，按月维度进行收费。

Master

Master=(3)

按房主包月计费。用户每获取一次资源，都计为房主获取资源，即根据实际调用获取歌曲资源接口传参为房间的 roomID、masterID，按房主进行收费。

ZegoCopyrightedMusicResourceType

音乐资源类型。用于 [ZegoCopyrightedMusicRequestConfig] 配置。

属性

Song

Song=(0)

原曲。

Accompaniment

Accompaniment=(1)

伴奏。

AccompanimentClip

AccompanimentClip=(2)

高潮片段。

AccompanimentSegment

AccompanimentSegment=(3)

抢唱片段。

ZegoCopyrightedMusicVendorID

版权方。版权方的详细信息，请联系 ZEGO 商务人员咨询。

属性

VendorDefault

VendorDefault=(0)

默认版权方。

Vendor1

Vendor1=(1)

版权方1。

Vendor2

Vendor2=(2)

版权方2。

Vendor3

Vendor3=(4)

版权方3。

ZegoEncodeProfile

视频编码规格

属性

ZegoEncodeProfileDefault

ZegoEncodeProfileDefault=(0)

默认的视频编码规格，默认值是 Main 级别的视频编码规格。

ZegoEncodeProfileBaseline

ZegoEncodeProfileBaseline=(1)

Baseline 级别的视频编码规格，解码消耗较低，画面效果较差，一般用于低阶或需要额外容错的应用。

ZegoEncodeProfileMain

ZegoEncodeProfileMain=(2)

Main 级别的视频编码规格，解码消耗比 Baseline 稍高，画面效果也较好，一般用于主流消费类电子产品。

ZegoEncodeProfileHigh

ZegoEncodeProfileHigh=(3)

High 级别的视频编码规格，解码消耗比 Main 高，画面效果好，一般用于广播及视频碟片存储，高清电视。

ZegoFontType

字体类型。

属性

ZegoFontTypeSourceHanSans

ZegoFontTypeSourceHanSans=(0)

思源黑体。

ZegoFontTypeAlibabaSans

ZegoFontTypeAlibabaSans=(1)

阿里巴巴普惠体。

ZegoFontTypePangMenZhengDaoTitle

ZegoFontTypePangMenZhengDaoTitle=(2)

旁门正道标题体。

ZegoFontTypeHappyZcool

ZegoFontTypeHappyZcool=(3)

站酷快乐体。

ZegoGeoFenceType

地理围栏类型。

属性

ZegoGeoFenceTypeNone

ZegoGeoFenceTypeNone=(0)

不使用地理围栏。

ZegoGeoFenceTypeInclude

ZegoGeoFenceTypeInclude=(1)

包括指定的地理围栏信息。

ZegoGeoFenceTypeExclude

ZegoGeoFenceTypeExclude=(2)

排除指定的地理围栏信息。

ZegoInspectFlagType

详情

送审标识类型。

属性

Allow

Allow=(0)

允许送审

NotAllow

NotAllow=(1)

不允许送审

ZegoLiveAudioEffectMode

音质增强生效模式。

详情

音质增强生效模式。

属性

None

None=(0)

都关闭。

Local

Local=(1)

仅本地生效。

Publish

Publish=(2)

仅推流生效。

All

All=(3)

本地和推流都生效。

ZegoLowlightEnhancementMode

低照度增强模式。

属性

Off

Off=(0)

On

On=(1)

ZegoMixStreamRenderMode

混流视频渲染模式

详情

混流视频渲染模式。

属性

AspectFill

AspectFill=(0)

填充模式，等比填充布局，画面可能有部分被裁剪。

AspectFit

AspectFit=(1)

适应模式，等比缩放画面，布局内可能有留白。

ZegoRangeAudioListenMode

范围语音收听模式。

属性

All

All=(0)

收听所有人模式，可以收听到房间内所有人的声音。

World

World=(1)

只收听世界的人模式，只收听处于范围内的人员的声音。

Team

Team=(2)

只收听所属小队模式，只收听所属小队内的成员的声音（不受范围限制）。

ZegoRangeAudioMicrophoneState

麦克风发送声音状态。

详情

麦克风发送声音状态。

业务场景：获取麦克风开关状态。

属性

Off

Off=(0)

关闭状态

TurningOn

TurningOn=(1)

开启中

On

On=(2)

开启状态

ZegoRangeAudioMode

范围语音模式

详情

范围语音模式。

属性

World

World=(0)

所有人模式，可以与房间内所有人交流

Team

Team=(1)

仅小队模式，只与小队内的成员交流

SecretTeam

SecretTeam=(2)

隐秘小队模式，可与小队内的成员交流（不受范围限制），并且可以听到范围内的其他玩家（非队伍内）声音。

ZegoRangeAudioSpeakMode

范围语音发声模式。

属性

All

All=(0)

发声到所有人模式，房间内的所有人都能听到他的声音。

World

World=(1)

发声到世界模式，只有处于范围内的人才能听到他的声音。

Team

Team=(2)

发声到所属小队模式，只有小队内的成员才能听到他的声音（不受范围限制）。

ZegoReverbPreset

混响预设值。

详情

混响预设值。

属性

None

None=(0)

无混响。

SoftRoom

SoftRoom=(1)

小房间混响效果

LargeRoom

LargeRoom=(2)

大房间混响效果

ConcertHall

ConcertHall=(3)

音乐厅混响效果

Valley

Valley=(4)

山谷混响效果

RecordingStudio

RecordingStudio=(5)

录音棚混响效果

Basement

Basement=(6)

地下室混响效果

KTV

KTV=(7)

KTV 混响效果

Rock

Rock=(9)

摇滚混响效果

VocalConcert

VocalConcert=(10)

演唱会混响效果

GramoPhone

GramoPhone=(11)

留声机混响效果

EnhancedKTV

EnhancedKTV=(12)

加强的 KTV 混响效果，提供人声更加集中、亮度更好的 KTV 效果。相比原有 KTV 音效缩短了混响时长，提高了干湿比。

ZegoRoomStateChangedReason

属性

Logining

Logining=('LOGINING')

Logined

Logined=('LOGINED')

LoginFailed

LoginFailed=('LOGIN_FAILED')

Reconnecting

Reconnecting=('RECONNECTING')

ReconnectFailed

ReconnectFailed=('RECONNECT_FAILED')

Kickout

Kickout=('KICKOUT')

Logout

Logout=('LOGOUT')

LogoutFailed

LogoutFailed=('LOGOUT_FAILED')

Reconnected

Reconnected=('RECONNECTED')

ZegoRoomTransparentMessageMode

详情

透传消息类型。

属性

ZegoRoomTransparentMessageModeOnlyClient

ZegoRoomTransparentMessageModeOnlyClient=(0)

仅发送给客户端。

ZegoRoomTransparentMessageModeOnlyServer

ZegoRoomTransparentMessageModeOnlyServer=(1)

仅服务器回调，需要向zego 服务器配置回调。

ZegoRoomTransparentMessageModeClientAndServer

ZegoRoomTransparentMessageModeClientAndServer=(2)

客户端接收和服务器回调。

ZegoRoomTransparentMessageType

详情

透传消息类型。

属性

ZegoRoomTransparentMessageNormal

ZegoRoomTransparentMessageNormal=(0)

正常模式。

ZegoRoomTransparentMessageSequence

ZegoRoomTransparentMessageSequence=(1)

消息保证最终有序。

ZegoSEIType

详情

SEI 类型。

属性

ZegoDefined

ZegoDefined=(0)

采用 SEI (nalu type = 6,payload type = 243) 类型打包，此类型是 SEI 标准未规定的类型，跟视频编码器或者视频文件中的 SEI 不存在冲突性，用户不需要根据 SEI 的内容做过滤。 SDK 默认发送 SEI 采用此种类型

UserUnregister

UserUnregister=(1)

采用 SEI (nalu type = 6,payload type = 5) 类型打包，H.264 标准对于此类型有规定的格式：startcode + nalu type(6) + payload type(5) + len + pay load(uuid + context)+ trailing bits；因为视频编码器自身会产生 payload type 为 5 的 SEI，或者使用视频文件推流时，视频文件中也可能存在这样的 SEI，所以使用此类型时，用户把 uuid + context 当作一段 buffer 塞给次媒体的发送接口；此时为了区别视频编码器自身产生的 SEI， App 在发送此类型 SEI 时，可以填写业务特定的uuid（uuid长度为16字节），接收方使用SDK 解析payload type为 5的SEI时，会根据设置的过滤字符串过滤出 uuid相符的 SEI 抛给业务，如果没有设置过滤字符串，SDK会把所有收到的SEI都抛给业务方； uuid过滤字符串设置接口，setSEIConfig设置的uuid过滤字符串。

ZegoScenario

房间场景

详情

房间场景值

属性

Default

Default=(3)

默认值

StandardVideoCall

StandardVideoCall=(4)

标准化1v1

HighVideoCall

HighVideoCall=(5)

高品质1V1

StandardChatroom

StandardChatroom=(6)

标准语聊房

HighQualityChatroom

HighQualityChatroom=(7)

高品质语聊房

Broadcast

Broadcast=(8)

秀场直播

Karaoke

Karaoke=(9)

卡拉 OK （KTV）

ZegoStreamUpdateType

更新音视频类型

属性

video

video=(0)

更新视频

audio

audio=(1)

更新音频

videoAndAudio

videoAndAudio=(2)

更新音视频

ZegoVideoCodecID

视频编码ID

属性

ZegoVideoCodecIDDefault

ZegoVideoCodecIDDefault=(0)

默认的视频编码规格，默认值是h264编码。

ZegoVideoCodecIDVp8

ZegoVideoCodecIDVp8=(2)

Vp8 编码格式

ZegoVideoCodecIDH265

ZegoVideoCodecIDH265=(4)

H265 编码格式

ZegoVoiceChangerPreset

变声器预设值

详情

变声器预设值

属性

NONE

NONE=(0)

无变声

MEN_TO_CHILD

MEN_TO_CHILD=(1)

男声变童声

MEN_TO_WOMEN

MEN_TO_WOMEN=(2)

男声变女声

WOMEN_TO_CHILD

WOMEN_TO_CHILD=(3)

女声变童声

WOMEN_TO_MEN

WOMEN_TO_MEN=(4)

女声变男声

FOREIGNER

FOREIGNER=(5)

外国人音效

OPTIMUS_PRIME

OPTIMUS_PRIME=(6)

汽车人擎天柱声效

ANDROID

ANDROID=(7)

机器人声效

ETHEREAL

ETHEREAL=(8)

空灵声效

MALE_MAGNETIC

MALE_MAGNETIC=(9)

磁性男声效

FEMALE_FRESH

FEMALE_FRESH=(10)

清新女声效

MAJOR_C

MAJOR_C=(11)

C大调电音音效

MINOR_A

MINOR_A=(12)

A小调电音音效

HARMONIC_MINOR

HARMONIC_MINOR=(13)

和声小调电音音效

FEMALE_ENERGETIC

FEMALE_ENERGETIC=(14)

女活力音效

RICHNESS

RICHNESS=(15)

浑厚音效

MUFFLED

MUFFLED=(16)

低沉音效

ROUNDNESS

ROUNDNESS=(17)

圆润音效

FALSETTO

FALSETTO=(18)

假音音效

FULLNESS

FULLNESS=(19)

饱满音效

CLEAR

CLEAR=(20)

清澈音效

HIGHLY_RESONANT

HIGHLY_RESONANT=(21)

高亢音效

LOUD_CLEAR

LOUD_CLEAR=(22)

嘹亮音效