Windows(C++)[v1.7.5.0]
| 命名空间 | 宏定义 | 类型定义 | 枚举 | 变量
PanoRtcDefs.h 文件参考
#include <inttypes.h>
#include <cstddef>
#include "PanoConf.h"

浏览源代码.

struct  KRect
 矩形 更多...
 
struct  WindowInfo
 窗口信息 更多...
 
struct  FaceBeautifyOption
 美颜参数 更多...
 
struct  BuiltinTransformOption
 内嵌视频形变参数 更多...
 
struct  QuadTransformOption
 视频四边形形变参数 更多...
 
struct  SnapshotVideoOption
 图片文件格式。 更多...
 
struct  UserAudioLevel
 用户音频强度。 更多...
 
struct  AudioProfile
 音频配置。 更多...
 
struct  FeedbackInfo
 用户反馈信息,用于发送用户反馈。 更多...
 
struct  NetworkQuality
 网络质量报告 更多...
 
struct  PanoData
 数据类型 更多...
 
struct  PropertyAction
 属性操作类型 更多...
 

命名空间

namespace  panortc
 

宏定义

#define PANORTC_API
 
#define PANORTC_NS_BEGIN   namespace panortc {
 
#define PANORTC_NS_END   }
 
#define PANORTC_NS_USING   using namespace panortc;
 

类型定义

using ScreenSourceID = uintptr_t
 

枚举

enum class  QResult : int {
  OK = 0 , FAILED = -1 , FATAL = -2 , INVALID_ARGS = -3 ,
  INVALID_STATE = -4 , INVALID_INDEX = -5 , ALREADY_EXIST = -6 , NOT_EXIST = -7 ,
  NOT_FOUND = -8 , NOT_SUPPORTED = -9 , NOT_IMPLEMENTED = -10 , NOT_INITIALIZED = -11 ,
  LIMIT_REACHED = -12 , NO_PRIVILEGE = -13 , IN_PROGRESS = -14 , WRONG_THREAD = -15 ,
  TIMEOUT = -16 , ABORTED = -17 , TOO_MANY_OPS = -18 , OUT_OF_MEMORY = -19 ,
  OUT_OF_DISK_SPACE = -20 , AUTH_FAILED = -101 , USER_REJECTED = -102 , USER_EXPELED = -103 ,
  USER_DUPLICATE = -104 , CHANNEL_CLOSED = -151 , CHANNEL_FULL = -152 , CHANNEL_LOCKED = -153 ,
  CHANNEL_MODE = -154 , CHANNEL_CRYPTOTYPE = -155 , GROUP_DISMISSED = -190 , NETWORK_ERROR = -301
}
 返回值 更多...
 
enum class  AudioType { PCM = 0 }
 音频数据类型 更多...
 
enum class  VideoType { I420 = 0 }
 视频数据类型 更多...
 
enum class  MediaType { Audio = 0 , Video }
 媒体类型 更多...
 
enum class  AudioDeviceType { Unknown = 0 , Record , Playout }
 音频设备类型 更多...
 
enum class  AudioDeviceState { Active = 0 , Inactive }
 音频设备状态 更多...
 
enum class  VideoDeviceType { Unknown = 0 , Capture }
 视频设备类型 更多...
 
enum class  VideoDeviceState { Added = 0 , Removed }
 视频设备状态 更多...
 
enum class  VideoCaptureState { Unknown = 0 , Normal , Suspended }
 视频采集状态 更多...
 
enum class  VideoRotation { Rotation_0 = 0 , Rotation_90 = 90 , Rotation_180 = 180 , Rotation_270 = 270 }
 视频旋转角度 更多...
 
enum class  VideoProfileType {
  Lowest = 0 , Low , Standard , HD720P ,
  HD1080P , None , Max = HD1080P
}
 视频能力类型 更多...
 
enum class  VideoDevicePosition { Unspecified = 0 , Back , Front }
 视频采集设备位置 更多...
 
enum class  VideoHwAccelerationType { None = 0 , EncodeOnly , DecodeOnly , Both }
 视频编解码硬件加速配置。 更多...
 
enum class  AudioAecType { Off = 0 , Default , Software , BuiltIn }
 回音消除类型 更多...
 
enum class  AudioSoftwareAecType {
  Off = 0 , Default , AEC3 , AEC ,
  AECM
}
 回音消除软件算法类型 更多...
 
enum class  AudioSoftwareAecLevel { Default = 0 , Bypass , Linear , Normal }
 回音消除软件算法消除等级 更多...
 
enum class  AudioAgcType {
  Off = 0 , Default , Soft , BuiltIn ,
  SoftWithBuiltIn
}
 音频自动增益控制 更多...
 
enum class  AudioNsType {
  Off = 0 , Default , Soft , BuiltIn ,
  SoftWithBuiltIn
}
 音频噪声抑制类型 更多...
 
enum class  AudioNsLevel {
  Default = 0 , Low , Mid , High ,
  VeryHigh
}
 音频噪声抑制强度 更多...
 
enum class  AudioLayer {
  PlatformDefaultAudio = 0 , AndroidOpenSLAudio , AndroidJavaAudio , AndroidJavaInputAndOpenSLESOutputAudio ,
  AndroidAAudioAudio , AndroidJavaInputAndAAudioOutputAudio
}
 音频采集和播放系统API选择 更多...
 
enum class  AudioSampleRate { SampleRate16KHz = 16000 , SampleRate48KHz = 48000 }
 音频采样率 更多...
 
enum class  AudioChannel { Mono = 1 , Stereo = 2 }
 音频采样率 更多...
 
enum class  AudioCallType { VoIP = 0 , PSTN = 1 , SIP = 2 , H323 = 3 }
 音频接入类型 更多...
 
enum class  UserLeaveReason {
  Normal = 0 , Expelled = 1 , Disconnected = 2 , ChannelEnd = 3 ,
  DuplicateUserID = 4
}
 用户离开原因 更多...
 
enum class  MediaSubscribeResult { Success , Failed , UserNotFound , LimitReached }
 用户媒体订阅结果 更多...
 
enum class  ChannelMode { Mode_1v1 , Mode_Meeting }
 频道模式 更多...
 
enum class  FailoverState { Reconnecting = 0 , Success = 1 , Failed = 2 }
 错误恢复状态 更多...
 
enum class  LogLevel {
  Fatal , Error , Warning , Info ,
  Verbos , Debug
}
 日志等级 更多...
 
enum class  ScreenSourceType { Display , Application , Window }
 桌面采集源类型 更多...
 
enum class  OptionType {
  Unknown = -1 , FaceBeautify = 0 , EnableUploadDebugLogs = 1 , EnableUploadAudioDump = 2 ,
  AudioEqualizationMode = 3 , AudioReverbMode = 4 , VideoFrameRate = 5 , EnableAudioEarMonitoring = 6 ,
  BuiltinTransform = 7 , EnableUploadDebugLogsAtFailure = 8 , EnableCpuAdaption = 9 , EnableAudioProfile = 10 ,
  VideoQuadTransform = 11 , AudioPreProcessMode = 12 , AudioNoiseSuppressionLevel = 13 , AudioAutoGainControl = 14 ,
  EnableVideoQualityAdaption = 15 , AudioVoiceChangerMode = 16 , ScreenOptimization = 17 , EnableMediaTcpCandidate = 20 ,
  EnableAudioAnalogAgc = 21 , EnableAudioBwe = 22 , EnableAudioStartWithPlayback = 23 , EnableAudioAecSuppressionLevel = 24 ,
  DisableAV1Encoding = 25 , MaxSimulcastLayerNum = 26
}
 选项 更多...
 
enum class  AudioPreProcessModeOption { Default = 0 , Enable = 1 , Disable = 2 }
 音频预处理 更多...
 
enum class  AudioNoiseSuppressionLevelOption {
  Default = 0 , Disable = 1 , Low = 2 , High = 3 ,
  VeryHigh = 4
}
 音频降噪等级配置 更多...
 
enum class  AudioAutoGainControlOption { Default = 0 , Enable = 1 , Disable = 2 }
 音频自动增益控制 更多...
 
enum class  QuadIndex { TopLeft = 0 , TopRight = 1 , BottomLeft = 2 , BottomRight = 3 }
 四边形顶点索引 更多...
 
enum class  VideoFrameRateType { Low = 0 , Standard = 1 }
 视频帧率类型 更多...
 
enum class  VideoCodecType { UNKNOWN = 0 , H264 = 1 , AV1X = 2 }
 视频编解码器类型 更多...
 
enum class  AudioCodecType {
  UNKNOWN = 0 , G711 = 1 , G722 = 2 , ILBC = 3 ,
  ISAC = 4 , OPUS = 5
}
 音频编解码器类型 更多...
 
enum class  FeedbackType {
  Unknown = -1 , General = 0 , Audio , Video ,
  Whiteboard , Screen
}
 用户反馈问题类型 更多...
 
enum class  AudioMixingState { Started = 0 , Finished = 1 }
 混音任务状态 更多...
 
enum class  AudioEqualizationOption {
  None = 0 , Bass = 1 , Loud = 2 , VocalMusic = 3 ,
  Strong = 4 , Pop = 5 , Live = 6 , DanceMusic = 7 ,
  Club = 8 , Soft = 9 , Rock = 10 , Party = 11 ,
  Classical = 12 , Test = 13
}
 音频均衡器选项 更多...
 
enum class  AudioReverbOption {
  None = 0 , VocalI = 1 , VocalII = 2 , Bathroom = 3 ,
  SmallRoomBright = 4 , SmallRoomDark = 5 , MediumRoom = 6 , LargeRoom = 7 ,
  ChurchHall = 8 , Cathedral = 9
}
 音频混响器选项 更多...
 
enum class  AudioVoiceChangerOption {
  None = 0 , Monster = 1 , Male = 2 , Female = 3 ,
  Echo = 4 , Thriller = 5 , Loli = 6
}
 音频变声器选项 更多...
 
enum class  ImageFileFormat { JPEG = 0 , PNG = 1 , BMP = 2 }
 图片文件格式。 更多...
 
enum class  QualityRating {
  Unavailable = 0 , VeryBad = 1 , Bad = 2 , Poor = 3 ,
  Good = 4 , Excellent = 5
}
 质量评分分值 更多...
 
enum class  DeviceRating {
  Unavailable = 0 , VeryBad = 1 , Bad = 2 , Poor = 3 ,
  Good = 4 , Excellent = 5
}
 设备评分分值 更多...
 
enum class  MediaProcessorType {
  AudioCaptureExProcessor = 1 , AudioCaptureExEffectProcessor = 2 , AudioRenderExProcessor = 3 , VideoPreprocessor = 100 ,
  VideoPreprocessorAutoRelease = 101
}
 媒体处理类型 更多...
 
enum class  ActionType { Add , Update , Remove }
 操作类型 更多...
 
enum class  ScreenCaptureState { Unknown = 0 , Normal , Stopped }
 屏幕采集状态 更多...
 

变量

const int kMaxDeviceNameLength = 256
 设备名字长度的最大值
 
const int kMaxDeviceIDLength = 256
 设备标识长度的最大值
 
const int kMaxVideoPlaneCount = 4
 视频数据的最大平面数
 
const int kDefaultAudioEncodeBitrate = 64000
 音频编码码率
 
const uint32_t kChannelServiceMedia = 0x01
 
const uint32_t kChannelServiceWhiteboard = 0x02
 
const uint32_t kChannelServiceMessage = 0x04
 
const int kDefaultVideoStreamId = 0
 

枚举类型说明

◆ ActionType

enum class ActionType
strong

操作类型

枚举值
Add 

添加操作。

Update 

更新操作。

Remove 

删除操作。

◆ AudioAecType

enum class AudioAecType
strong

回音消除类型

枚举值
Off 

关闭AEC算法。

Default 

默认AEC算法。

Software 

软件AEC算法。

BuiltIn 

设备内置AEC算法。

◆ AudioAgcType

enum class AudioAgcType
strong

音频自动增益控制

枚举值
Off 

关闭语音自动增益控制。

Default 

默认语音自动增益控制算法。

Soft 

软件AGC算法。

BuiltIn 

设备内置AGC算法。

SoftWithBuiltIn 

设备内置软件AGC算法。

◆ AudioAutoGainControlOption

enum class AudioAutoGainControlOption
strong

音频自动增益控制

枚举值
Default 

默认值

Enable 

打开

Disable 

关闭

◆ AudioCallType

enum class AudioCallType
strong

音频接入类型

枚举值
VoIP 

VoIP 类型。

PSTN 

电话接入。

SIP 

SIP设备接入。

H323 

H323接入。

◆ AudioChannel

enum class AudioChannel
strong

音频采样率

枚举值
Mono 

音频单通道

Stereo 

音频双通道

◆ AudioCodecType

enum class AudioCodecType
strong

音频编解码器类型

枚举值
UNKNOWN 

未知编解码器.

G711 

G.711编解码器.

G722 

G.722编解码器.

ILBC 

iLBC编解码器.

ISAC 

iSAC编解码器.

OPUS 

Opus编解码器.

◆ AudioDeviceState

enum class AudioDeviceState
strong

音频设备状态

枚举值
Active 

音频设备处于活跃状态。

Inactive 

音频设备处于不活跃状态。

◆ AudioDeviceType

enum class AudioDeviceType
strong

音频设备类型

枚举值
Unknown 

未知设备类型。

Record 

录制设备类型。

Playout 

播放设备类型。

◆ AudioEqualizationOption

enum class AudioEqualizationOption
strong

音频均衡器选项

枚举值
None 

无音效

Bass 

低音

Loud 

高音

VocalMusic 

声乐

Strong 

增强

Pop 

流行

Live 

现场

DanceMusic 

舞曲

Club 

俱乐部

Soft 

轻柔

Rock 

摇滚

Party 

聚会

Classical 

古典

Test 

测试用例

◆ AudioLayer

enum class AudioLayer
strong

音频采集和播放系统API选择

枚举值
PlatformDefaultAudio 

系统默认采集和播放API。

AndroidOpenSLAudio 

OpenSL API采集和播放, 仅在Android平台有效。

AndroidJavaAudio 

JAVA API采集和播放,仅在Android平台有效

AndroidJavaInputAndOpenSLESOutputAudio 

Java API采集和OpenSL API播放,仅在Android平台有效

AndroidAAudioAudio 

AAudio API采集和播放,仅在Android平台有效

AndroidJavaInputAndAAudioOutputAudio 

Java API采集和AAudio API播放,仅在Android平台有效

◆ AudioMixingState

enum class AudioMixingState
strong

混音任务状态

枚举值
Started 

混音开始。

Finished 

混音结束。

◆ AudioNoiseSuppressionLevelOption

音频降噪等级配置

枚举值
Default 

默认值

Disable 

关闭

Low 

低降噪等级

High 

高降噪等级(默认)

VeryHigh 

非常高降噪等级(不推荐)

◆ AudioNsLevel

enum class AudioNsLevel
strong

音频噪声抑制强度

枚举值
Default 

默认语音噪声抑制强度。

Low 

低语音噪声抑制。

Mid 

中等语音噪声抑制强度。

High 

强语音噪声抑制强度。

VeryHigh 

超强语音噪声抑制强度。

◆ AudioNsType

enum class AudioNsType
strong

音频噪声抑制类型

枚举值
Off 

关闭语音噪声抑制。

Default 

默认语音噪声抑制。

Soft 

软件语音噪声抑制。

BuiltIn 

设备内置语音噪声抑制。

SoftWithBuiltIn 

设备内置软件噪声抑制。

◆ AudioPreProcessModeOption

enum class AudioPreProcessModeOption
strong

音频预处理

枚举值
Default 

默认值

Enable 

打开

Disable 

关闭

◆ AudioReverbOption

enum class AudioReverbOption
strong

音频混响器选项

枚举值
None 

无音效

VocalI 

人声 1

VocalII 

人声 2

Bathroom 

浴室

SmallRoomBright 

明亮小房间

SmallRoomDark 

黑暗小房间

MediumRoom 

中等房间

LargeRoom 

大房间

ChurchHall 

教堂大厅

Cathedral 

大教堂

◆ AudioSampleRate

enum class AudioSampleRate
strong

音频采样率

枚举值
SampleRate16KHz 

音频采样率16kHz

SampleRate48KHz 

音频采样率48kHz

◆ AudioSoftwareAecLevel

enum class AudioSoftwareAecLevel
strong

回音消除软件算法消除等级

枚举值
Default 

AEC算法压制水平默认。

Bypass 

关闭AEC算法。

Linear 

AEC算法输出线性结果。

Normal 

AEC算法输出正常结果。

◆ AudioSoftwareAecType

enum class AudioSoftwareAecType
strong

回音消除软件算法类型

枚举值
Off 

关闭AEC算法。

Default 

默认AEC算法。

AEC3 

AEC3算法。

AEC 

AEC算法。

AECM 

AECM算法。

◆ AudioType

enum class AudioType
strong

音频数据类型

枚举值
PCM 

脉冲编码调制格式。

◆ AudioVoiceChangerOption

enum class AudioVoiceChangerOption
strong

音频变声器选项

枚举值
None 

无音效

Monster 

怪兽

Male 

男声

Female 

女声

Echo 

回声

Thriller 

惊悚

Loli 

萝莉

◆ ChannelMode

enum class ChannelMode
strong

频道模式

枚举值
Mode_1v1 

双人模式。

Mode_Meeting 

多人模式。

◆ DeviceRating

enum class DeviceRating
strong

设备评分分值

枚举值
Unavailable 

设备评分未知。

VeryBad 

设备性能非常差,只能开启普通的音频功能。

Bad 

设备性能比较差,可开启音频功能。

Poor 

设备性能一般,可开启音频和低分辨率视频。

Good 

设备性能较好,可开启音频和高清视频。

Excellent 

设备性能非常优秀,可开启音视频高级功能。

◆ FailoverState

enum class FailoverState
strong

错误恢复状态

枚举值
Reconnecting 

重连中。

Success 

错误恢复成功。

Failed 

错误恢复失败。

◆ FeedbackType

enum class FeedbackType
strong

用户反馈问题类型

枚举值
General 

通用类型。

Audio 

语音问题。

Video 

视频问题。

Whiteboard 

白板问题。

Screen 

桌面共享问题。

◆ ImageFileFormat

enum class ImageFileFormat
strong

图片文件格式。

枚举值
JPEG 

JPEG。有损压缩格式。

PNG 

PNG。无损压缩格式。

BMP 

BMP。无压缩格式。

◆ LogLevel

enum class LogLevel
strong

日志等级

枚举值
Fatal 

致命信息。

Error 

错误信息。

Warning 

警告信息。

Info 

普通信息。

Verbos 

详细信息。

Debug 

调试信息。

◆ MediaProcessorType

enum class MediaProcessorType
strong

媒体处理类型

枚举值
AudioCaptureExProcessor 

音频采集外部处理(位置位于本地采集后,前处理前)。 对应的处理模块必须为 RtcExternalAudioProcessor 指针类型或空,对应的处理模块参数必须为空。

AudioCaptureExEffectProcessor 

音频采集外部效果处理(位置位于本地处理后,编码前)。 对应的处理模块必须为 RtcExternalAudioProcess 指针类型或空,对应的处理模块参数必须为空。

AudioRenderExProcessor 

音频采集外部处理(位置位于播放前)。 对应的处理模块必须为 RtcExternalAudioProcess 指针类型或空,对应的处理模块参数必须为空。

VideoPreprocessor 

视频前处理。对应的处理模块必须为 RtcExternalVideoProcessor 指针类型或空,对应的处理模块参数必须为空。

VideoPreprocessorAutoRelease 

视频前处理。对应的处理模块必须为 RtcExternalVideoProcessor 指针类型或空,对应的处理模块参数必须为空。 SDK将接管对象生命周期的维护。注意对象可能在任何时候被SDK释放,因此用户不应该在setMediaProcessor()后再次调用对象。

◆ MediaSubscribeResult

enum class MediaSubscribeResult
strong

用户媒体订阅结果

枚举值
Success 

订阅成功。

Failed 

订阅失败。

UserNotFound 

被订阅的用户不存在。

LimitReached 

达到订阅上限。

◆ MediaType

enum class MediaType
strong

媒体类型

枚举值
Audio 

音频。

Video 

视频。

◆ OptionType

enum class OptionType
strong

选项

枚举值
FaceBeautify 

美颜。参数类型是 FaceBeautifyOption。

EnableUploadDebugLogs 

启用日志上传。参数类型是 bool。

EnableUploadAudioDump 

启用音频数据上传。参数类型是 bool。

AudioEqualizationMode 

音频均衡器。参数类型是 AudioEqualizationOption。

AudioReverbMode 

音频混响器。参数类型是 AudioReverbOption。

VideoFrameRate 

调整视频采集帧率。参数类型是 VideoFrameRateType。

EnableAudioEarMonitoring 

启用音频耳返(需要佩戴耳机)。参数类型是 bool。

BuiltinTransform 

对视频进行内部变换。参数类型是 BuiltinTransformOption。

EnableUploadDebugLogsAtFailure 

允许加会失败时上传PANO日志。参数类型是 bool。

注解
此标记设置后会一直有效。默认已经启用。
EnableCpuAdaption 

允许SDK根据CPU性能调整视频质量。参数类型是 bool。默认值是 true。仅在加入频道前可以配置。

注解
通常场景下不建议关闭此功能。
EnableAudioProfile 

音频配置设置, 参数格式: 结构体 AudioProfile

VideoQuadTransform 

对视频进行四边形变换。参数类型是 QuadTransformOption

AudioPreProcessMode 

音频预处理。参数类型是 AudioPreProcessModeOption

AudioNoiseSuppressionLevel 

音频降噪等级配置。参数类型是 AudioNoiseSuppressionLevelOption

AudioAutoGainControl 

音频自动增益控制。参数类型是 AudioAutoGainControlOption

EnableVideoQualityAdaption 

允许SDK根据视频质量自动调整分辨率, 默认值是 true。仅在加入频道前可以配置。

注解
通常场景下不建议关闭此功能。
AudioVoiceChangerMode 

音频变声器。参数类型是 AudioVoiceChangerOption

ScreenOptimization 

屏幕采集帧率模式。参数类型是 Boolean,默认值是 false, 高帧率采集用于内容变化剧烈场景。

EnableMediaTcpCandidate 

启用媒体TCP候选。参数类型是 bool。

注解
如果需要开启此功能,请先联系PANO技术支持。
EnableAudioAnalogAgc 

音频模拟Agc。参数类型是 bool。仅支持Windows和macOS

EnableAudioBwe 

音频BWE(带宽评估)打开。默认值是 true,动态监控网络带宽并调整音频编码器码率适应实时网络带宽。

EnableAudioStartWithPlayback 

音频播放设备在开启音频的时候打开。默认值是 false。

EnableAudioAecSuppressionLevel 

音频软件aec算法消除等级。参数类型是 AudioSoftwareAecLevel。默认值是 Normal。

DisableAV1Encoding 

禁用AV1编码。参数类型是 bool。默认值是 false。

MaxSimulcastLayerNum 

Simulcast的最大层数。参数类型是uint32_t。 默认值是2。值域是[2, 3]。

◆ QResult

enum class QResult : int
strong

返回值

PANO方法返回值,指示执行的情况

枚举值
OK 

执行成功。

FAILED 

执行失败。

FATAL 

致命错误。

INVALID_ARGS 

非法参数。

INVALID_STATE 

非法状态。

INVALID_INDEX 

无效索引。

ALREADY_EXIST 

对象已存在。

NOT_EXIST 

对象不存在。

NOT_FOUND 

对象没发现。

NOT_SUPPORTED 

方法不支持。

NOT_IMPLEMENTED 

方法未实现。

NOT_INITIALIZED 

对象未初始化。

LIMIT_REACHED 

已达上限。

NO_PRIVILEGE 

没有权限执行该操作。

IN_PROGRESS 

操作正在进行中。

WRONG_THREAD 

操作的线程错误。

TIMEOUT 

操作超时。

ABORTED 

操作终止。

TOO_MANY_OPS 

操作次数过多。

OUT_OF_MEMORY 

内存不足。

OUT_OF_DISK_SPACE 

磁盘空间不足。

AUTH_FAILED 

认证失败。

USER_REJECTED 

用户被拒绝。

USER_EXPELED 

用户被驱逐。

USER_DUPLICATE 

用户 ID 重复。

CHANNEL_CLOSED 

频道被关闭。

CHANNEL_FULL 

频道容量已满。

CHANNEL_LOCKED 

频道被锁定。

CHANNEL_MODE 

频道模式不匹配。

CHANNEL_CRYPTOTYPE 

频道加密类型不匹配。

GROUP_DISMISSED 

分组已解散。

NETWORK_ERROR 

出现网络错误。

◆ QuadIndex

enum class QuadIndex
strong

四边形顶点索引

枚举值
TopLeft 

四边形左上角顶点。

TopRight 

四边形右上角顶点。

BottomLeft 

四边形左下角顶点。

BottomRight 

四边形右下角顶点。

◆ QualityRating

enum class QualityRating
strong

质量评分分值

枚举值
Unavailable 

服务质量未知。

VeryBad 

服务质量非常差,几乎不可用。

Bad 

服务质量比较差,质量不稳定。

Poor 

服务质量一般。

Good 

服务质量很好。

Excellent 

服务质量非常好。

◆ ScreenCaptureState

enum class ScreenCaptureState
strong

屏幕采集状态

枚举值
Unknown 

未知屏幕采集状态。

Normal 

屏幕采集正常。

Stopped 

屏幕采集停止。

◆ ScreenSourceType

enum class ScreenSourceType
strong

桌面采集源类型

枚举值
Display 

桌面。

Application 

应用。

Window 

窗口。

◆ UserLeaveReason

enum class UserLeaveReason
strong

用户离开原因

枚举值
Normal 

正常离开。

Expelled 

被驱逐。

Disconnected 

网络断开

ChannelEnd 

频道结束

DuplicateUserID 

用户 ID 重复

◆ VideoCaptureState

enum class VideoCaptureState
strong

视频采集状态

枚举值
Unknown 

未知视频采集状态。

Normal 

视频采集正常。

Suspended 

视频采集暂停。

◆ VideoCodecType

enum class VideoCodecType
strong

视频编解码器类型

枚举值
UNKNOWN 

未知编解码器.

H264 

H.264编解码器.

AV1X 

AV1X编解码器.

◆ VideoDevicePosition

enum class VideoDevicePosition
strong

视频采集设备位置

枚举值
Unspecified 

未定义。

Back 

后置。

Front 

前置。

◆ VideoDeviceState

enum class VideoDeviceState
strong

视频设备状态

枚举值
Added 

视频设备插入。

Removed 

视频设备拔出。

◆ VideoDeviceType

enum class VideoDeviceType
strong

视频设备类型

枚举值
Unknown 

未知设备类型。

Capture 

视频采集设备。

◆ VideoFrameRateType

enum class VideoFrameRateType
strong

视频帧率类型

枚举值
Low 

最大帧率 15 fps。

Standard 

最大帧率 30 fps。

◆ VideoHwAccelerationType

enum class VideoHwAccelerationType
strong

视频编解码硬件加速配置。

枚举值
None 

不启用编解码硬件加速。

EncodeOnly 

仅启用编码硬件加速。

DecodeOnly 

仅启用解码硬件加速。

Both 

同时开启编码和解码硬件加速。

◆ VideoProfileType

enum class VideoProfileType
strong

视频能力类型

枚举值
Lowest 

分辨率为160x90/120。

Low 

分辨率为320x180/240。

Standard 

分辨率为640x360/480。

HD720P 

分辨率为1280x720。

HD1080P 

分辨率为1920x1080。

None 

分辨率未定义。

Max 

最大支持分辨率为1920x1080。

◆ VideoRotation

enum class VideoRotation
strong

视频旋转角度

枚举值
Rotation_0 

零度。

Rotation_90 

九十度。

Rotation_180 

一百八十度。

Rotation_270 

二百七十度。

◆ VideoType

enum class VideoType
strong

视频数据类型

枚举值
I420 

I420像素格式。

变量说明

◆ kChannelServiceMedia

const uint32_t kChannelServiceMedia = 0x01

频道标志位,媒体。

◆ kChannelServiceMessage

const uint32_t kChannelServiceMessage = 0x04

频道标志位,消息。

◆ kChannelServiceWhiteboard

const uint32_t kChannelServiceWhiteboard = 0x02

频道标志位,白板。

◆ kDefaultVideoStreamId

const int kDefaultVideoStreamId = 0

默认视频流ID,此视频流不可被删除。

注解
默认视频流无需创建,在频道加入成功后即有效。