ZegoLiveRoom
Classes | Enumerations | Variables
ZEGO::AV Namespace Reference

Classes

struct  DeviceInfo
 
struct  DeviceVideoCapabilityInfo
 
struct  EventInfo
 
class  IZegoAudioRecordCallback
 
class  IZegoDeviceStateCallback
 
class  IZegoLiveEventCallback
 
class  IZegoNetTypeCallback
 
struct  PlayQuality
 
struct  PublishQuality
 
struct  SoundLevelInfo
 
struct  ZegoCodecCapabilityInfo
 
struct  ZegoCompleteMixStreamConfig
 
struct  ZegoMixStreamConfig
 混流图层信息 More...
 
struct  ZegoMixStreamResult
 
struct  ZegoMixStreamResultEx
 
struct  ZegoPlayStats
 
struct  ZegoRect
 
struct  ZegoSize
 
struct  ZegoStreamInfo
 
struct  ZegoStreamRelayCDNInfo
 
struct  ZegoUser
 

Enumerations

enum  RemoteViewIndex { RemoteViewIndex_First = 0, RemoteViewIndex_Second = 1, RemoteViewIndex_Third = 2 }
 
enum  ZegoVideoViewMode { ZegoVideoViewModeScaleAspectFit = 0, ZegoVideoViewModeScaleAspectFill = 1, ZegoVideoViewModeScaleToFill = 2 }
 
enum  ZegoVideoMirrorMode { ZegoVideoMirrorModePreviewMirrorPublishNoMirror = 0, ZegoVideoMirrorModePreviewCaptureBothMirror = 1, ZegoVideoMirrorModePreviewCaptureBothNoMirror = 2, ZegoVideoMirrorModePreviewNoMirrorPublishMirror = 3 }
 
enum  ZegoVideoCodecAvc { VIDEO_CODEC_DEFAULT = 0, VIDEO_CODEC_MULTILAYER = 1, VIDEO_CODEC_VP8 = 2, VIDEO_CODEC_H265 = 3 }
 
enum  AudioDeviceType { AudioDevice_Input = 0, AudioDevice_Output }
 
enum  MixSysPlayoutPropertyMask { MIX_PROP_NONE = 0, MIX_PROP_ENABLE_AGC_FOR_SYS_PLAYOUT = 1 }
 
enum  DeviceState { Device_Added = 0, Device_Deleted }
 
enum  DeviceStatus { Device_Opened = 0, Device_Closed }
 
enum  VolumeType { Volume_EndPoint = 0, Volume_Simple }
 
enum  ZegoStreamRelayCDNState { RELAY_STOP = 0, RELAY_START = 1, RELAY_RETRY = 2 }
 
enum  ZegoStreamRelayCDNDetail {
  Relay_None = 0, Relay_ServerError = 8, Relay_HandShakeFailed = 9, Relay_AccessPointError = 10,
  Relay_CreateStreamFailed = 11, Relay_BadName = 12, Relay_CDNServerDisconnected = 13, Relay_Disconnected = 14,
  MixStream_AllInputStreamClosed = 1214, MixStream_AllInputStreamNoData = 1215, MixStream_ServerInternalError = 1230
}
 
enum  ZEGONetType {
  ZEGO_NT_NONE = 0, ZEGO_NT_LINE = 1, ZEGO_NT_WIFI = 2, ZEGO_NT_2G = 3,
  ZEGO_NT_3G = 4, ZEGO_NT_4G = 5, ZEGO_NT_5G = 6, ZEGO_NT_UNKNOWN = 32
}
 
enum  ZegoPublishFlag { ZEGO_JOIN_PUBLISH = 0, ZEGO_MIX_STREAM = 1 << 1, ZEGO_SINGLE_ANCHOR = 1 << 2 }
 
enum  ZegoTaskType { TASK_NORMAL = 1, TASK_DELAY = 2 }
 
enum  ZegoLogLevel {
  Grievous = 0, Error = 1, Warning = 2, Generic = 3,
  Debug = 4
}
 
enum  EventType {
  Play_BeginRetry = 1, Play_RetrySuccess = 2, Publish_BeginRetry = 3, Publish_RetrySuccess = 4,
  Play_TempDisconnected = 5, Publish_TempDisconnected = 6, Play_VideoBreak = 7, Play_VideoBreakEnd = 8,
  Play_VideoBreakCancel = 13, Play_AudioBreak = 9, Play_AudioBreakEnd = 10, Play_AudioBreakCancel = 14,
  PublishInfo_RegisterFailed = 11, PublishInfo_RegisterSuccess = 12
}
 
enum  ZegoVideoEncoderRateControlStrategy { ZEGO_RC_ABR, ZEGO_RC_CBR, ZEGO_RC_VBR, ZEGO_RC_CRF }
 
enum  ZegoCapturePipelineScaleMode { ZegoCapturePipelinePreScale = 0, ZegoCapturePipelinePostScale = 1 }
 
enum  ZegoAVAPIAudioDeviceMode {
  ZEGO_AUDIO_DEVICE_MODE_COMMUNICATION = 1, ZEGO_AUDIO_DEVICE_MODE_GENERAL = 2, ZEGO_AUDIO_DEVICE_MODE_AUTO = 3, ZEGO_AUDIO_DEVICE_MODE_COMMUNICATION2 = 4,
  ZEGO_AUDIO_DEVICE_MODE_COMMUNICATION3 = 5, ZEGO_AUDIO_DEVICE_MODE_GENERAL2 = 6
}
 
enum  ZegoAVAPILatencyMode {
  ZEGO_LATENCY_MODE_NORMAL = 0, ZEGO_LATENCY_MODE_LOW, ZEGO_LATENCY_MODE_NORMAL2, ZEGO_LATENCY_MODE_LOW2,
  ZEGO_LATENCY_MODE_LOW3, ZEGO_LATENCY_MODE_NORMAL3
}
 
enum  ZegoTrafficControlProperty {
  ZEGO_TRAFFIC_CONTROL_BASIC = 0, ZEGO_TRAFFIC_CONTROL_ADAPTIVE_FPS = 1, ZEGO_TRAFFIC_CONTROL_ADAPTIVE_RESOLUTION = 1 << 1, ZEGO_TRAFFIC_CONTROL_ADAPTIVE_AUDIO_BITRATE = 1 << 2,
  ZEGO_TRAFFIC_NONE = ZEGO_TRAFFIC_CONTROL_BASIC, ZEGO_TRAFFIC_FPS = ZEGO_TRAFFIC_CONTROL_ADAPTIVE_FPS, ZEGO_TRAFFIC_RESOLUTION = ZEGO_TRAFFIC_CONTROL_ADAPTIVE_RESOLUTION
}
 
enum  ZegoTrafficControlMinVideoBitrateMode { ZEGO_TRAFFIC_CONTROL_MIN_VIDEO_BITRATE_NO_VIDEO = 0, ZEGO_TRAFFIC_CONTROL_MIN_VIDEO_BITRATE_ULTRA_LOW_FPS }
 
enum  ZegoAVAPIAudioRecordMask { ZEGO_AUDIO_RECORD_NONE = 0x0, ZEGO_AUDIO_RECORD_CAP = 0x01, ZEGO_AUDIO_RECORD_RENDER = 0x02, ZEGO_AUDIO_RECORD_MIX = 0x04 }
 
enum  LiveStreamQuality {
  Unknown = -1, Excellent = 0, Good = 1, Middle = 2,
  Poor = 3, Die = 4, MaxGrade
}
 
enum  PublishChannelIndex { PUBLISH_CHN_MAIN = 0, PUBLISH_CHN_AUX }
 
enum  VideoStreamLayer { VideoStreamLayer_Auto = -1, VideoStreamLayer_BaseLayer = 0, VideoStreamLayer_ExtendLayer = 1 }
 
enum  MediaInfoType { SideInfoZegoDefined = 0, SeiZegoDefined = 1, SeiUserUnregisted = 2 }
 
enum  SeiSendType { SeiSendSingleFrame = 0, SeiSendInVideoFrame = 1 }
 
enum  ZegoAECMode { AEC_MODE_AGGRESSIVE, AEC_MODE_MEDIUM, AEC_MODE_SOFT }
 
enum  ZegoANSMode { ANS_MODE_LOW = 0, ANS_MODE_MEDIUM = 1, ANS_MODE_HIGH = 2 }
 
enum  ZegoDeviceErrorCode {
  ZEGO_DEVICE_ERROR_GENERIC = -1, ZEGO_DEVICE_ERROR_INVALID_ID = -2, ZEGO_DEVICE_ERROR_NO_AUTHORIZATION = -3, ZEGO_DEVICE_ERROR_ZERO_FPS = -4,
  ZEGO_DEVICE_ERROR_IN_USE_BY_OTHER = -5, ZEGO_DEVICE_ERROR_UNPLUGGED = -6, ZEGO_DEVICE_ERROR_REBOOT_REQUIRED = -7, ZEGO_DEVICE_ERROR_MEDIA_SERVICES_LOST = -8,
  ZEGO_DEVICE_ERROR_IN_USE_BY_SIRI = -9
}
 
enum  ZegoDeviceErrorReason {
  ZEGO_DEVICE_ERROR_REASON_GENERIC = -1, ZEGO_DEVICE_ERROR_REASON_INVALID_ID = -2, ZEGO_DEVICE_ERROR_REASON_NO_AUTHORIZATION = -3, ZEGO_DEVICE_ERROR_REASON_ZERO_FPS = -4,
  ZEGO_DEVICE_ERROR_REASON_IN_USE_BY_OTHER = -5, ZEGO_DEVICE_ERROR_REASON_UNPLUGGED = -6, ZEGO_DEVICE_ERROR_REASON_REBOOT_REQUIRED = -7, ZEGO_DEVICE_ERROR_REASON_MEDIA_SERVICES_LOST = -8,
  ZEGO_DEVICE_ERROR_REASON_IN_USE_BY_SIRI = -9, ZEGO_DEVICE_ERROR_REASON_NONE = 0, ZEGO_DEVICE_ERROR_REASON_DISABLED = 2, ZEGO_DEVICE_ERROR_REASON_MUTE = 3,
  ZEGO_DEVICE_ERROR_REASON_INTERRUPTION = 4, ZEGO_DEVICE_ERROR_REASON_IN_BACKGROUND = 5, ZEGO_DEVICE_ERROR_REASON_MULTI_FOREGROUND_APP = 6, ZEGO_DEVICE_ERROR_REASON_SYSTEM_PRESSURE = 7
}
 
enum  ChannelExtraParamKey { ZEGO_CHANNEL_PARAM_KEY_AV_CAPTURE_DEVICE = 2 }
 
enum  ZegoAudioRoute {
  ZEGO_AUDIO_ROUTE_SPEAKER = 0, ZEGO_AUDIO_ROUTE_HEADSET, ZEGO_AUDIO_ROUTE_BLUETOOTH, ZEGO_AUDIO_ROUTE_RECEIVER,
  ZEGO_AUDIO_ROUTE_USB_AUDIO, ZEGO_AUDIO_ROUTE_AIR_PLAY
}
 
enum  ZegoCodecError { ZEGO_CODEC_ERROR_NONE = 0, ZEGO_CODEC_ERROR_NOT_SUPPORT = -1, ZEGO_CODEC_ERROR_FAILED = -2, ZEGO_CODEC_ERROR_LOW_FPS = -3 }
 
enum  ZegoStreamResourceMode { DEFAULT = 0, CDN_ONLY = 1, L3_ONLY = 2, RTC_ONLY = 3 }
 
enum  ZegoAudioMixMode { ZEGO_AUDIO_MIX_MODE_RAW = 0, ZEGO_AUDIO_MIX_MODE_FOCUSED }
 
enum  ZegoTrafficControlFocusOn { ZEGO_TRAFFIC_CONTROL_FOCUS_ON_LOCAL_ONLY = 0, ZEGO_TRAFFIC_CONTROL_FOCUS_ON_REMOTE = 1 }
 
enum  ZegoVideoSourceType {
  VIDEO_SRC_DEFAULT = 0, VIDEO_SRC_NONE = 1, VIDEO_SRC_CAMERA = 2, VIDEO_SRC_EXTERNAL_CAPTURE = 3,
  VIDEO_SRC_MAIN_PUBLISH_CHN = 4
}
 
enum  ZegoVideoEncodeMode { ZEGO_VIDEO_ENCODE_MODE_LOW_DELAY = 0, ZEGO_VIDEO_ENCODE_MODE_LOW_BITRATE = 1 }
 

Variables

ZEGOAVKIT_API const char * kZegoDeviceCamera
 
ZEGOAVKIT_API const char * kZegoDeviceMicrophone
 
ZEGOAVKIT_API const char * kZegoStreamID
 

Enumeration Type Documentation

◆ AudioDeviceType

音频设备类型

Enumerator
AudioDevice_Input 

输入设备

AudioDevice_Output 

输出设备

◆ ChannelExtraParamKey

Enumerator
ZEGO_CHANNEL_PARAM_KEY_AV_CAPTURE_DEVICE 

设置编码场景模式,仅 OpehH264 有效 设置 X264 编码特性,目前仅支持 tune 获取 AVCaptureDevice 对象

◆ DeviceState

设备状态

Enumerator
Device_Added 

添加设备

Device_Deleted 

删除设备

◆ DeviceStatus

Enumerator
Device_Opened 

设备已打开

Device_Closed 

设备已关闭

◆ EventType

SDK 事件通知

Enumerator
Play_BeginRetry 

开始重试拉流

Play_RetrySuccess 

重试拉流成功

Publish_BeginRetry 

开始重试推流

Publish_RetrySuccess 

重试推流成功

Play_TempDisconnected 

拉流临时中断

Publish_TempDisconnected 

推流临时中断

Play_VideoBreak 

视频卡顿开始

Play_VideoBreakEnd 

视频卡顿结束

Play_VideoBreakCancel 

视频卡顿取消

Play_AudioBreak 

音频卡顿开始

Play_AudioBreakEnd 

音频卡顿结束

Play_AudioBreakCancel 

音频卡顿取消

PublishInfo_RegisterFailed 

注册推流信息失败

PublishInfo_RegisterSuccess 

注册推流信息成功

◆ LiveStreamQuality

Enumerator
Unknown 
Excellent 
Good 
Middle 
Poor 
Die 
MaxGrade 

◆ MediaInfoType

MediaInfo 类型

Enumerator
SideInfoZegoDefined 

ZEGO 定义的打包类型,跟视频编码器产生的信息不存兼容性问题。
但是在其它 CDN 上转码视频的时候,其它 CDN 基本上不支持提取这种方式打包的信息数据,转码完成后再从其它 CDN 拉流时,可能就丢失了这些次媒体信息。
ZEGO CDN 转码支持提取此种方式打包的信息数据。

SeiZegoDefined 

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

SeiUserUnregisted 

采用 H264 的 SEI (nalu type = 6,payload type = 5) 类型打包,H264 标准对于此类型有规定的格式:startcode + nalu type(6) + payload type(5) + len + pay load(uuid + context)+ trailing bits;


因为视频编码器自身会产生 payload type 为 5 的 SEI,或者使用视频文件推流时,视频文件中也可能存在这样的 SEI,所以使用此类型时,用户需要把 uuid + context 当作一段 buffer 塞给次媒体的发送接口;


为了区别视频编码器自身产生的 SEI,所以对 uuid 有格式要求,即 uuid 16字节的前四个字节固定为 'Z' 'E' 'G' 'O' 四个字符(全部大写),后面12字节用户任意填写;


在 SDK 接收端,对于 payload type = 5的 SEI 会根据'ZEGO'字样做过滤,识别出符合要求的 SEI 抛给用户,避免用户收到编码器自身产生的 SEI。

◆ MixSysPlayoutPropertyMask

Enumerator
MIX_PROP_NONE 
MIX_PROP_ENABLE_AGC_FOR_SYS_PLAYOUT 

◆ PublishChannelIndex

推流通道

Enumerator
PUBLISH_CHN_MAIN 

主推流通道,默认

PUBLISH_CHN_AUX 

第二路推流通道,默认没有声音,需要指定音频源。

◆ RemoteViewIndex

Enumerator
RemoteViewIndex_First 
RemoteViewIndex_Second 
RemoteViewIndex_Third 

◆ SeiSendType

SEI发送类型

Enumerator
SeiSendSingleFrame 

SEI 单帧发送,此种发送方式下,ffmpeg 解码会产生类似“此帧无视频”的警告,可能会导致一些 CDN 兼容性问题,例如转码失败等。

SeiSendInVideoFrame 

SEI 随视频帧(I, B, P)发送,推荐采用此类型。

◆ VideoStreamLayer

视频分层类型

Enumerator
VideoStreamLayer_Auto 

根据网络状态选择图层

VideoStreamLayer_BaseLayer 

指定拉基本层(小分辨率)

VideoStreamLayer_ExtendLayer 

指定拉扩展层(大分辨率)

◆ VolumeType

音量类型

Enumerator
Volume_EndPoint 

设备音量

Volume_Simple 

App 音量

◆ ZegoAECMode

回声消除模式

Enumerator
AEC_MODE_AGGRESSIVE 

激进模式

AEC_MODE_MEDIUM 

中等模式

AEC_MODE_SOFT 

轻度模式

◆ ZegoANSMode

Enumerator
ANS_MODE_LOW 

轻度模式

ANS_MODE_MEDIUM 

中等模式

ANS_MODE_HIGH 

激进模式

◆ ZegoAudioMixMode

多路混音模式

Enumerator
ZEGO_AUDIO_MIX_MODE_RAW 

关闭效果

ZEGO_AUDIO_MIX_MODE_FOCUSED 

聚焦效果

◆ ZegoAudioRoute

Enumerator
ZEGO_AUDIO_ROUTE_SPEAKER 

扬声器

ZEGO_AUDIO_ROUTE_HEADSET 

耳机

ZEGO_AUDIO_ROUTE_BLUETOOTH 

蓝牙

ZEGO_AUDIO_ROUTE_RECEIVER 

听筒

ZEGO_AUDIO_ROUTE_USB_AUDIO 

USB 音频设备

ZEGO_AUDIO_ROUTE_AIR_PLAY 

air play

◆ ZegoAVAPIAudioDeviceMode

音频设备模式

Enumerator
ZEGO_AUDIO_DEVICE_MODE_COMMUNICATION 

开启系统回声消除

ZEGO_AUDIO_DEVICE_MODE_GENERAL 

关闭系统回声消除

ZEGO_AUDIO_DEVICE_MODE_AUTO 

根据场景自动选择是否开启系统回声消除

ZEGO_AUDIO_DEVICE_MODE_COMMUNICATION2 

开启系统回声消除,与 ZEGO_AUDIO_DEVICE_MODE_COMMUNICATION 相比,该模式会始终占用麦克风设备

ZEGO_AUDIO_DEVICE_MODE_COMMUNICATION3 

开启系统回声消除,与 ZEGO_AUDIO_DEVICE_MODE_COMMUNICATION 相比,该模式下麦后释放麦克风,切回媒体音量

ZEGO_AUDIO_DEVICE_MODE_GENERAL2 

◆ ZegoAVAPIAudioRecordMask

音频录制类型

Enumerator
ZEGO_AUDIO_RECORD_NONE 

关闭音频录制

ZEGO_AUDIO_RECORD_CAP 

打开采集录制

ZEGO_AUDIO_RECORD_RENDER 

打开渲染录制

ZEGO_AUDIO_RECORD_MIX 

打开采集和渲染混音结果录制

◆ ZegoAVAPILatencyMode

延迟模式

Enumerator
ZEGO_LATENCY_MODE_NORMAL 

普通延迟模式

ZEGO_LATENCY_MODE_LOW 

低延迟模式,无法用于 RTMP 流

ZEGO_LATENCY_MODE_NORMAL2 

普通延迟模式,最高码率可达 192K

ZEGO_LATENCY_MODE_LOW2 

低延迟模式,无法用于 RTMP 流。相对于 ZEGO_LATENCY_MODE_LOW 而言,CPU 开销稍低

ZEGO_LATENCY_MODE_LOW3 

低延迟模式,无法用于 RTMP 流。支持WebRTC必须使用此模式

ZEGO_LATENCY_MODE_NORMAL3 

普通延迟模式,使用此模式前先咨询即构技术支持

◆ ZegoCapturePipelineScaleMode

视频采集缩放时机

Enumerator
ZegoCapturePipelinePreScale 

采集后立即进行缩放,默认

ZegoCapturePipelinePostScale 

编码时进行缩放

◆ ZegoCodecError

编解码错误

Enumerator
ZEGO_CODEC_ERROR_NONE 

成功

ZEGO_CODEC_ERROR_NOT_SUPPORT 

不支持

ZEGO_CODEC_ERROR_FAILED 

失败

ZEGO_CODEC_ERROR_LOW_FPS 

软解性能不足

◆ ZegoDeviceErrorCode

设备错误码

Enumerator
ZEGO_DEVICE_ERROR_GENERIC 

一般性错误

ZEGO_DEVICE_ERROR_INVALID_ID 

无效设备 ID

ZEGO_DEVICE_ERROR_NO_AUTHORIZATION 

没有权限

ZEGO_DEVICE_ERROR_ZERO_FPS 

采集帧率为0

ZEGO_DEVICE_ERROR_IN_USE_BY_OTHER 

设备被占用

ZEGO_DEVICE_ERROR_UNPLUGGED 

设备未插入

ZEGO_DEVICE_ERROR_REBOOT_REQUIRED 

需要重启系统

ZEGO_DEVICE_ERROR_MEDIA_SERVICES_LOST 

媒体服务无法恢复

ZEGO_DEVICE_ERROR_IN_USE_BY_SIRI 

设备被SIRI占用

◆ ZegoDeviceErrorReason

Enumerator
ZEGO_DEVICE_ERROR_REASON_GENERIC 

一般性错误

ZEGO_DEVICE_ERROR_REASON_INVALID_ID 

无效设备 ID

ZEGO_DEVICE_ERROR_REASON_NO_AUTHORIZATION 

没有权限

ZEGO_DEVICE_ERROR_REASON_ZERO_FPS 

采集帧率为0

ZEGO_DEVICE_ERROR_REASON_IN_USE_BY_OTHER 

设备被占用

ZEGO_DEVICE_ERROR_REASON_UNPLUGGED 

设备未插入

ZEGO_DEVICE_ERROR_REASON_REBOOT_REQUIRED 

需要重启系统

ZEGO_DEVICE_ERROR_REASON_MEDIA_SERVICES_LOST 

媒体服务无法恢复

ZEGO_DEVICE_ERROR_REASON_IN_USE_BY_SIRI 

设备被SIRI占用

ZEGO_DEVICE_ERROR_REASON_NONE 

没有错误

ZEGO_DEVICE_ERROR_REASON_DISABLED 

禁用

ZEGO_DEVICE_ERROR_REASON_MUTE 

屏蔽采集

ZEGO_DEVICE_ERROR_REASON_INTERRUPTION 

中断

ZEGO_DEVICE_ERROR_REASON_IN_BACKGROUND 

在后台

ZEGO_DEVICE_ERROR_REASON_MULTI_FOREGROUND_APP 

前台有多个 APP 运行

ZEGO_DEVICE_ERROR_REASON_SYSTEM_PRESSURE 

系统压力过大

◆ ZegoLogLevel

Enumerator
Grievous 
Error 
Warning 
Generic 

通常在发布产品中使用

Debug 

调试阶段使用

◆ ZEGONetType

网络类型

Enumerator
ZEGO_NT_NONE 

无网络

ZEGO_NT_LINE 

网线

ZEGO_NT_WIFI 

WIFI

ZEGO_NT_2G 

2G

ZEGO_NT_3G 

3G

ZEGO_NT_4G 

4G

ZEGO_NT_5G 

5G

ZEGO_NT_UNKNOWN 

未知类型

◆ ZegoPublishFlag

Enumerator
ZEGO_JOIN_PUBLISH 

连麦

ZEGO_MIX_STREAM 

混流,如果推出的流需要作为混流输入,请用这个模式

ZEGO_SINGLE_ANCHOR 

单主播

◆ ZegoStreamRelayCDNDetail

Enumerator
Relay_None 

Relay_ServerError 

服务器错误

Relay_HandShakeFailed 

握手失败

Relay_AccessPointError 

接入点错误

Relay_CreateStreamFailed 

创建流失败

Relay_BadName 

BAD NAME.

Relay_CDNServerDisconnected 

CDN服务器主动断开

Relay_Disconnected 

主动断开

MixStream_AllInputStreamClosed 

混流输入流会话关闭, 混流转推CDN时有效

MixStream_AllInputStreamNoData 

混流输入流全部没有数据, 混流转推CDN时有效

MixStream_ServerInternalError 

混流服务器内部错误,混流转推CDN时有效

◆ ZegoStreamRelayCDNState

转推CDN状态

Enumerator
RELAY_STOP 

转推停止

RELAY_START 

正在转推

RELAY_RETRY 

正在重试

◆ ZegoStreamResourceMode

Enumerator
DEFAULT 

默认模式,SDK会根据拉流设置的rtmpUrls/flvUrls/shouldSwitchServer参数和即构的后台配置自动选择拉流资源

CDN_ONLY 

只从CDN拉流

L3_ONLY 

只从L3拉流, 会忽略rtmpUrls/flvUrls/shouldSwitchServer 参数

RTC_ONLY 

只从RTC拉流 ,会忽略 rtmpUrls/flvUrls/shouldSwitchServer 参数

◆ ZegoTaskType

Enumerator
TASK_NORMAL 
TASK_DELAY 

◆ ZegoTrafficControlFocusOn

触发流量控制的因素

Enumerator
ZEGO_TRAFFIC_CONTROL_FOCUS_ON_LOCAL_ONLY 

只关注本地网络

ZEGO_TRAFFIC_CONTROL_FOCUS_ON_REMOTE 

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

◆ ZegoTrafficControlMinVideoBitrateMode

Enumerator
ZEGO_TRAFFIC_CONTROL_MIN_VIDEO_BITRATE_NO_VIDEO 

低于设置的最低码率时,停止视频发送

ZEGO_TRAFFIC_CONTROL_MIN_VIDEO_BITRATE_ULTRA_LOW_FPS 

低于设置的最低码率时,视频以极低的频率发送 (不超过3FPS)

◆ ZegoTrafficControlProperty

流量控制属性

Enumerator
ZEGO_TRAFFIC_CONTROL_BASIC 

基本流量控制,只有码率控制,不带自适应帧率和分辨率 自适应帧率

ZEGO_TRAFFIC_CONTROL_ADAPTIVE_FPS 

自适应分辨率

ZEGO_TRAFFIC_CONTROL_ADAPTIVE_RESOLUTION 

音频流量控制

ZEGO_TRAFFIC_CONTROL_ADAPTIVE_AUDIO_BITRATE 

废弃

ZEGO_TRAFFIC_NONE 
ZEGO_TRAFFIC_FPS 
ZEGO_TRAFFIC_RESOLUTION 

◆ ZegoVideoCodecAvc

Enumerator
VIDEO_CODEC_DEFAULT 

默认编码,不支持分层编码

VIDEO_CODEC_MULTILAYER 

分层编码 要达到和VIDEO_CODEC_DEFAULT相同的编码质量,建议码率和VIDEO_CODEC_DEFAULT相比增加20左右

VIDEO_CODEC_VP8 

VP8编码

VIDEO_CODEC_H265 

H265.

◆ ZegoVideoEncodeMode

视频编码模式

Enumerator
ZEGO_VIDEO_ENCODE_MODE_LOW_DELAY 

低延时

ZEGO_VIDEO_ENCODE_MODE_LOW_BITRATE 

低码率

◆ ZegoVideoEncoderRateControlStrategy

视频编码码率控制策略

Enumerator
ZEGO_RC_ABR 

平均码率

ZEGO_RC_CBR 

恒定码率

ZEGO_RC_VBR 

可变码率

ZEGO_RC_CRF 

恒定质量

◆ ZegoVideoMirrorMode

Enumerator
ZegoVideoMirrorModePreviewMirrorPublishNoMirror 

预览启用镜像,推流不启用镜像

ZegoVideoMirrorModePreviewCaptureBothMirror 

预览启用镜像,推流启用镜像

ZegoVideoMirrorModePreviewCaptureBothNoMirror 

预览不启用镜像,推流不启用镜像

ZegoVideoMirrorModePreviewNoMirrorPublishMirror 

预览不启用镜像,推流启用镜像

◆ ZegoVideoSourceType

视频数据来源,例如想设置辅路推流视频数据直接复制主路视频数据,则可以设置为 VIDEO_SRC_MAIN_PUBLISH_CHN

Attention
参考 SetVideoSource
Enumerator
VIDEO_SRC_DEFAULT 

默认采集逻辑,即如果有设置视频外部采集工厂,则使用外部采集,否则使用内部采集

VIDEO_SRC_NONE 

不启动采集,即没有视频数据

VIDEO_SRC_CAMERA 

视频源来自于摄像头

VIDEO_SRC_EXTERNAL_CAPTURE 

视频源来自于外部采集 。当没有设置外部采集工厂时,将自动修正为 VIDEO_SRC_CAMERA

VIDEO_SRC_MAIN_PUBLISH_CHN 

视频源来自于主路推流。当推主路流时,不能设置为此值

◆ ZegoVideoViewMode

Enumerator
ZegoVideoViewModeScaleAspectFit 

等比缩放,可能有黑边,SDK 默认值

ZegoVideoViewModeScaleAspectFill 

等比缩放填充整View,可能有部分被裁减

ZegoVideoViewModeScaleToFill 

填充整个View

Variable Documentation

◆ kZegoDeviceCamera

ZEGOAVKIT_API const char* ZEGO::AV::kZegoDeviceCamera

◆ kZegoDeviceMicrophone

ZEGOAVKIT_API const char* ZEGO::AV::kZegoDeviceMicrophone

◆ kZegoStreamID

ZEGOAVKIT_API const char* ZEGO::AV::kZegoStreamID