通过阅读本文,您可以了解Windows SDK涉及的数据类型。
目录
数据类型 |
描述 |
支持的最低版本 |
数据类型 |
描述 |
支持的最低版本 |
伴奏混音状态。 |
3.4 |
|
伴奏混音错误码。 |
3.4 |
|
设备类型。 |
3.0 |
|
设备状态。 |
3.0 |
|
用户离线原因。 |
3.0 |
|
OnBye类型。 |
3.0 |
|
网络连接状态。 |
3.0 |
|
网络连接状态变更原因。 |
3.0 |
|
网络质量。 |
3.0 |
|
日志级别。 |
3.0 |
|
SDK错误码。 |
3.0 |
|
视图显示模式。 |
3.0 |
|
视频窗口镜像模式。 |
3.0 |
|
视频宽高比。 |
3.0 |
|
视频旋转角度。 |
3.0 |
|
音频track的类型。 |
3.0 |
|
音频帧类型。 |
3.0 |
|
视频流类型。 |
3.0 |
|
视频码流类型。 |
3.0 |
|
订阅状态。 |
3.0 |
|
采集偏好。 |
3.0 |
|
摄像头方向。 |
3.0 |
|
视频输出方向。 |
3.0 |
|
视频镜像模式。 |
3.0 |
|
虚拟背景选项。 |
3.3 |
|
视频暗光增强选项。 |
3.0 |
|
视频去噪模式。 |
3.0 |
|
音频去噪模式。 |
3.4 |
|
桌面分享类型。 |
3.0 |
|
推流状态。 |
3.0 |
|
视频帧类型。 |
3.0 |
|
视频数据格式。 |
3.0 |
|
音频编码模式。 |
3.0 |
|
音频场景模式。 |
3.0 |
|
音频数据源类型。 |
3.1 |
|
音频声道类型。 |
3.2 |
|
音频采样率类型。 |
3.2 |
|
白板模式。 |
3.6 |
|
标注类型。 |
3.6 |
|
白板角色类型。 |
3.6 |
|
白板工具参数。 |
3.6 |
|
白板填充类型。 |
3.6 |
|
白板字体样式。 |
3.6 |
|
白板图像状态。 |
3.6 |
|
文件转码状态。 |
3.6 |
|
白板渲染缩放模式。 |
3.6 |
|
白板渲染缩放基准。 |
3.6 |
|
白板清除模式。 |
3.6 |
|
绘制事件类型 |
3.6 |
|
内容更新类型。 |
3.6 |
|
快照模式 |
3.6 |
|
白板文档类型。 |
3.6 |
|
白板选项。 |
3.6 |
|
标注选项。 |
3.6 |
|
伴奏混音状态信息。 |
3.4 |
|
设备信息。 |
3.0 |
|
屏幕共享设备信息 |
3.5 |
|
伴奏混音配置信息。 |
3.4 |
|
用户鉴权信息。 |
3.0 |
|
视频显示窗口设置。 |
3.0 |
|
音频帧数据结构。 |
3.0 |
|
camera采集偏好。 |
3.0 |
|
视频分辨率。 |
3.0 |
|
视频美颜选项。 |
3.0 |
|
虚拟背景选项。 |
3.3 |
|
视频暗光增强选项。 |
3.0 |
|
视频去噪选项。 |
3.0 |
|
音频去噪选项。 |
3.4 |
|
相机流视频编码属性设置。 |
3.0 |
|
屏幕流编码属性设置。 |
3.0 |
|
屏幕分享区域。 |
3.0 |
|
屏幕共享参数配置。 |
3.0 |
|
屏幕共享配置信息。 |
3.0 |
|
视频帧数据结构。 |
3.0 |
|
会话数据统计信息。 |
3.0 |
|
本地视频统计信息。 |
3.0 |
|
远端视频统计信息。 |
3.0 |
|
本地音频统计信息。 |
3.0 |
|
音频音量信息。 |
3.0 |
|
远端音频统计信息。 |
3.0 |
|
音频数据回调参数设置。 |
3.2 |
|
质量报告数据。 |
3.0 |
|
白板配置参数。 |
3.6 |
|
标注配置参数。 |
3.6 |
|
白板用户成员。 |
3.6 |
|
点。 |
3.6 |
|
矩形。 |
3.6 |
|
大小。 |
3.6 |
|
白板颜色。 |
3.6 |
|
白板文本格式。 |
3.6 |
|
白板图章。 |
3.6 |
|
白板清除配置。 |
3.6 curPage为false时不支持撤消重做 |
|
白板文档信息。 |
3.6 |
|
白板文档内容信息 |
3.6 |
|
白板触摸配置。 |
3.6 |
详情
-
RtcEngineAudioMixingStatus:伴奏混音状态。
枚举名
描述
枚举名
描述
kAudioMixingNone
初始状态。
kAudioMixingStarted
开始混音。
kAudioMixingStopped
停止混音。
kAudioMixingPaused
混音暂停。
kAudioMixingResumed
混音恢复。
kAudioMixingEnded
混音完毕。
kAudioMixingBuffering
正在缓冲。
kAudioMixingBufferingEnd
缓冲结束。
kAudioMixingFailed
混音失败。
-
RtcEngineAudioMixingErrorCode:伴奏混音错误码。
枚举名
描述
枚举名
描述
kAudioMixingNoError
无错误。
kAudioMixingOpenFailed
打开文件失败。
kAudioMixingDecodeFailed
解码失败。
-
RtcEngineDeviceType:设备类型。
枚举名
描述
枚举名
描述
RtcEngineTypeUnknown
未知类型。
RtcEngineTypeAudioRecording
音频采集设备。
RtcEngineTypeAudioPlayout
音频播放设备。
RtcEngineTypeVideoCapture
视频采集设备。
-
RtcEngineDeviceState:设备状态。
枚举名
描述
枚举名
描述
RtcEngineDeviceStateAdd
设备已添加。
RtcEngineDeviceStateRemove
设备已移除。
-
RtcEngineUserOfflineReason:用户离线原因。
枚举名
描述
枚举名
描述
RtcEngineUserOfflineQuit
用户主动离开。
RtcEngineUserOfflineDropped
因过长时间收不到对方数据包,超时掉线。
-
RtcEngineOnByeType:OnBye类型。
枚举名
描述
枚举名
描述
RtcEngineOnByeBeKickedOut
当前user被踢出channel。
RtcEngineOnByeChannelTerminated
channel已结束,需要离开会议。
RtcEngineOnByeUserReplaced
相同userID在其他设备JoinChannel,当前设备被下线。
RtcEngineOnByeNeedRelogin
信令服务失败,自动重连失败,需要用户手动重试。
-
RtcEngineConnectionStatus:网络连接状态。
枚举名
描述
枚举名
描述
RtcEngineConnectionInit
初始化完成。
RtcEngineConnectionDisconnected
网络连接断开。
RtcEngineConnectionConnecting
建立网络连接中。
RtcEngineConnectionConnected
网络已连接。
RtcEngineConnectionReconnecting
重新建立网络连接中。
RtcEngineConnectionFailed
网络连接失败。
-
RtcEngineConnectionStatusChangeReason:网络连接状态变更原因。
枚举名
描述
枚举名
描述
RtcEngineConnectionChangedDummyReason
未知原因。
RtcEngineConnectionSignalingHeartbeatTimeout
心跳超时。
RtcEngineConnectionSignalingHeartbeatAlive
心跳恢复。
RtcEngineConnectionSignalingJoinChannelFailure
加入频道失败。
RtcEngineConnectionSignalingJoinChannelSuccess
加入频道成功。
RtcEngineConnectionSignalingLeaveChannel
离开频道。
RtcEngineConnectionSignalingConnecting
信令建立连接。
RtcEngineConnectionMediaLinkChange
媒体链路变化
RtcEngineConnectionChangedNetworkInterrupted
网络连接中断。
RtcEngineConnectionChangedNetworkRecovery
网络连接恢复。
-
RtcEngineNetworkQuality:网络质量。
枚举名
描述
枚举名
描述
RtcEngineNetworkQualityGood
网络质量好。
RtcEngineNetworkQualityPoor
网络质量差。
RtcEngineNetworkQualityDisconnect
网络中断。
RtcEngineNetworkQualityUnknown
未知。
-
RtcEngineLogLevel:日志级别。
枚举名
描述
枚举名
描述
RtcEngineLogLevelInfo
只输出>=RtcEngineLogLevelInfo级别的日志。
RtcEngineLogLevelWarn
只输出>=RtcEngineLogLevelWarn级别的日志。
RtcEngineLogLevelError
只输出>=RtcEngineLogLevelError级别的日志。
RtcEngineLogLevelNone
不输出日志。
-
RtcEngineErrorCode:SDK错误码。
枚举名
描述
枚举名
描述
RtcEngineErrorJoinBadAppId
AppId不存在,请在控制台创建应用。
RtcEngineErrorJoinInvaildAppId
AppId已失效,请在控制台重新启用应用。
RtcEngineErrorJoinBadChannel
频道不存在,请尝试重新加入频道,如会议发起者入会后又很快离会,第二个人随后入会,发现会议已经不存在了。
RtcEngineErrorJoinInvaildChannel
频道已经失效(目前频道有效期为48小时),请重新生成频道鉴权令牌(Token)。
RtcEngineErrorJoinBadToken
Token无效。请重新生成频道鉴权令牌(Token)。
RtcEngineErrorJoinTimeout
加入频道超时,请检查网络连接是否正常。
RtcEngineErrorJoinBadParam
参数错误,RtcEngineAuthInfo中的字段为空或者timestamp<=0,请检查字段是否完整。
RtcEngineErrorJoinChannelFailed
加入频道失败。
RtcEngineErrorLogRootPathError
日志模块根路径错误,请检查路径是否存在或路径是否具有写入权限。
RtcEngineErrorMicOpenFail
采集设备初始化失败、采集设备媒体服务异常、音频设备被占用。Mac端和Windows端查看系统设置中音频设备是否有能量条。iOS端和Android端确认是否被其他应用占用。如果都正常,请重启设备。
RtcEngineErrorSpeakerOpenFail
播放设备初始化失败、播放设备媒体服务异常、音频设备被占用。Mac端和Windows端查看系统设置中音频设备是否有能量条。iOS端和Android端确认是否被其他应用占用。如果都正常,请重启设备。
RtcEngineErrorMicInterrupt
系统性能不足、采集设备媒体服务异常、音频设备被占用。建议重启应用或重启设备。
RtcEngineErrorSpeakerInterrupt
系统性能不足,播放设备媒体服务异常,音频设备被占用。建议重启应用或重启设备。
RtcEngineErrorMicAuthFail
麦克风设备未授权,建议去系统设置中,打开麦克风授权,并且重新加入频道。
RtcEngineErrorMicNotAvailable
无可用的音频采集设备,检查是否接入了可用的麦克风,并检查系统设置中,该设备是否被禁用。
RtcEngineErrorSpeakerNotAvailable
无可用的音频播放设备,检查是否接入了可用的扬声器或耳机,并检查系统设置中,该设备是否被禁用。
RtcEngineErrorSpecifiedAudioDeviceNotFound
指定使用的音频设备未找到。
RtcEngineErrorCameraOpenFail
采集设备初始化失败,检查系统相机是否可用,移动端App是否占用了相机。
RtcEngineErrorCameraInterrupt
采集过程中出现异常,Mac、Winodows电脑相机采集灯熄灭,设备被强制中断。建议重新加入频道或者重启App。
RtcEngineErrorSpecifiedCameraDeviceNotFound
指定使用的摄像头设备未找到。
RtcEngineErrorScreenShareOpenFail
屏幕共享打开失败。
RtcEngineErrorScreenShareNoPermission
屏幕共享无权限
RtcEngineErrorVideoDisplayOpenFail
渲染设备初始化失败,检查Windows端显卡驱动是否需要升级,移动端手机型号或者Android平板盒子等外设是否支持OpenGL。
RtcEngineErrorVideoDisplayInterrupt
渲染过程中出现异常,系统异常错误导致渲染引擎报错,重新加入频道或者重启App。
RtcEngineErrorIceConnectionConnectFail
媒体通道建立失败,检查网络连接是否正常。
RtcEngineErrorIceConnectionReconnectFail
媒体通道重连失败,检查网络连接是否正常。
RtcEngineErrorConnectionHeartbeatTimeout
信令心跳超时,检查网络连接是否正常。
RtcEngineErrorConnectionConnectFail
信令链接失败,检查信令网络连接是否正常。
RtcEngineErrorPublishInvaild
推流无效。
RtcEngineErrorPublishNotJoinChannel
未进入频道推流失败。
RtcEngineErrorPublishAudioStreamFailed
推送音频流失败。
RtcEngineErrorPublishVideoStreamFailed
推送视频流失败。
RtcEngineErrorPublishScreenShareFailed
推送屏幕共享失败。
RtcEngineErrorPublishScreenShareConfigError
屏幕共享配置错误。
RtcEngineErrorSubscribeInvaild
订阅无效
RtcEngineErrorSubscribeNotJoinChannel
未进入频道订阅错误。
RtcEngineErrorSubscribeAudioStreamFailed
订阅音频流失败。
RtcEngineErrorSubscribeVideoStreamFailed
订阅视频流失败。
RtcEngineErrorSubscribeScreenShareFailed
订阅屏幕共享失败。
RtcEngineErrorInvaildState
sdk状态错误,建议销毁SDK重新创建实例。
RtcEngineErrorInvaildArgument
参数不匹配。
RtcEngineErrorSessionRemoved
Session已经被移除,建议销毁实例之后重新创建实例并加入频道,已废弃。
RtcEngineErrorAudioBufferFull
buffer队列饱和,用于外部输送裸数据功能,建议降低外部输入频次,设置等待20ms,并且单次不超过40ms数据。
RtcEngineErrorVideoBufferFull
buffer队列饱和,用于外部输送裸数据功能,建议降低外部输入频次,设置等待视频帧间隔后再输入。
RtcEngineErrorAudioStreamError
音频流错误。
RtcEngineErrorAudioFileOpenFail
音频文件打开失败。
RtcEngineErrorAudioFormatNotSupported
音频格式不支持。
RtcEngineErrorUpdateRoleChannel
互动模式下设置角色错误。
RtcEngineErrorInner
SDK内部错误。
-
RtcEngineRenderMode:视图显示模式。
枚举名
描述
枚举名
描述
RtcEngineRenderModeAuto
自动模式。
RtcEngineRenderModeStretch
拉伸平铺模式,如果外部输入的视频宽高比和推流设置的宽高比不一致时,将输入视频拉伸到推流设置的比例,画面会变形。
RtcEngineRenderModeFill
填充黑边模式,如果外部输入的视频宽高比和推流设置的宽高比不一致时,将输入视频上下或者左右填充黑边。
RtcEngineRenderModeCrop
裁剪模式,如果外部输入的视频宽高比和推流设置的宽高比不一致时,将输入视频宽或者高进行裁剪,画面内容会丢失。
RtcEngineRenderModeNoChange
沿用之前的显示模式。
-
RtcEngineRenderMirrorMode:视频窗口镜像模式。
枚举名
描述
枚举名
描述
RtcEngineRenderMirrorModeOnlyFrontMirror
只有前置摄像头预览镜像,其余不镜像。
RtcEngineRenderMirrorModeAllMirror
镜像开启。
RtcEngineRenderMirrorModeAllNoMirror
镜像关闭。
RtcEngineRenderMirrorModeNoChange
占位符,无意义。
-
RtcEngineVideoScale:视频宽高比。
枚举名
描述
枚举名
描述
RtcEngineVideoScale_16_9
16:9。
RtcEngineVideoScale_4_3
4:3。
-
RtcEngineRotationMode:视频旋转角度。
枚举名
描述
枚举名
描述
RtcEngineRotationModeNoChange
沿用之前的旋转角度。
RtcEngineRotationMode_0
旋转0度。
RtcEngineRotationMode_90
旋转90度。
RtcEngineRotationMode_180
旋转180度。
RtcEngineRotationMode_270
旋转270度。
-
RtcEngineAudioTrack:音频track的类型。
枚举名
描述
枚举名
描述
RtcEngineAudioTrackNo
无麦克风。
RtcEngineAudioTrackMic
麦克风。
RtcEngineAudioTrackEnd
占位符。
-
RtcEngineAudioFrameType:音频帧类型。
枚举名
描述
枚举名
描述
RtcEngineAudioFramePcm16
-
RtcEngineVideoTrack:视频流类型。
枚举名
描述
枚举名
描述
RtcEngineVideoTrackNo
无视频流。
RtcEngineVideoTrackCamera
相机流。
RtcEngineVideoTrackScreen
屏幕共享流。
RtcEngineVideoTrackBoth
相机流和屏幕共享流。
-
RtcEngineVideoStreamType:视频码流类型。
枚举名
描述
枚举名
描述
RtcEngineVideoStreamTypeNone
无,在OnSubscribeStreamTypeChanged回调表示当前未订阅。
RtcEngineVideoStreamTypeFHD
超高清流(设备性能、网络状态、推流分辨率符合要求情况下满足),对应1080P收费档。
RtcEngineVideoStreamTypeHD
高清流(设备性能、网络状态、推流分辨率符合要求情况下满足),对应720P收费档。
RtcEngineVideoStreamTypeSD
标清(设备性能、网络状态、推流分辨率符合要求情况下满足),对应480P收费档。
RtcEngineVideoStreamTypeLD
流畅(设备性能、网络状态、推流分辨率符合要求情况下满足),对应480P收费档。
-
RtcEngineSubscribeState:订阅状态。
枚举名
描述
枚举名
描述
RtcEngineStatsSubscribeIdle
初始状态。
RtcEngineStatsNoSubscribe
未订阅。
RtcEngineStatsSubscribing
订阅中。
RtcEngineStatsSubscribed
已订阅。
-
RtcEngineCaptureOutputPreference:采集偏好。
枚举名
描述
枚举名
描述
RtcEngineCaptureOutputPreferenceAuto
自动调整采集参数(默认)。
RtcEngineCaptureOutputPreferencePerformance
根据设置的publshprofile分辨率和帧率,选择最接近的摄像头输出参数。
RtcEngineCaptureOutputPreferencePreview
选择较高的摄像头输出参数。
-
RtcEngineCameraDirection:摄像头方向。
枚举名
描述
枚举名
描述
RtcEngineCameraDirectionInvalid
无效,不可用。
RtcEngineCameraDirectionBack
后置摄像头。
RtcEngineCameraDirectionFront
前置摄像头。
-
RtcEngineVideoEncoderOrientationMode:视频输出方向。
枚举名
描述
枚举名
描述
RtcEngineVideoEncoderOrientationModeAdaptive
0:自适应,推流方向和采集方向一致。
RtcEngineVideoEncoderOrientationModeFixedLandscape
1:横屏模式:该模式下SDK推横屏流,始终以设置的分辨率宽和高中较大的值作为输出视频的宽,较小值作为输出视频的高。
RtcEngineVideoEncoderOrientationModeFixedPortrait
2:竖屏模式:该模式下SDK推竖屏流,始终以设置的分辨率宽和高中较小的值作为输出视频的宽,较大值作为输出视频的高。
-
RtcEngineVideoMirrorMode:视频镜像模式。
枚举名
描述
枚举名
描述
RtcEngineVideoMirrorModeDisabled
0:关闭镜像。
RtcEngineVideoMirrorModeEnabled
1:开启镜像。
-
RtcEngineVirtualBackgroundMode:虚拟背景选项。
枚举名
描述
枚举名
描述
RtcEngineVirtualBackgroundBlur
背景虚化。
RtcEngineVirtualBackgroundReplace
背景替换。
-
RtcEngineVideoEnhanceMode:视频暗光增强选项。
枚举名
描述
枚举名
描述
RtcEngineVideoEnhanceOff
视频暗光增强关。
RtcEngineVideoEnhanceAuto
视频暗光增强自动模式。
-
RtcEngineVideoDenoiseMode:视频去噪模式。
枚举名
描述
枚举名
描述
RtcEngineVideoDenoiseOff
视频去噪关。
RtcEngineVideoDenoiseAuto
视频去噪自动模式。
-
RtcEngineAudioDenoiseMode:音频去噪模式。
枚举名
描述
枚举名
描述
RtcEngineAudioDenoiseOff
音频去噪关。
RtcEngineAudioDenoiseDsp
音频去噪采用传统降噪。
RtcEngineAudioDenoiseEnhance
音频去噪采用智能降噪。
-
RtcEnginePublishState:推流状态。
枚举名
描述
枚举名
描述
RtcEngineStatsPublishIdle
初始状态。
RtcEngineStatsNoPublish
未推流。
RtcEngineStatsPublishing
推流中。
RtcEngineStatsPublished
已推流。
-
RtcEngineVideoFrameType:视频帧类型。
枚举名
描述
枚举名
描述
RtcEngineVideoFrameRaw
裸数据类型。
RtcEngineVideoFramePixelBuffer
CVPixelBufferRef类型。
RtcEngineVideoFrameTexture
纹理类型。
-
RtcEngineVideoPixelFormat:视频数据格式。
枚举名
描述
枚举名
描述
RtcEngineVideoI420
I420。
RtcEngineVideoNV12
NV12。
RtcEngineVideoNV21
NV21。
RtcEngineVideoBGRA
BGRA
RtcEngineVideoARGB
ARGB。
RtcEngineVideoRGBA
RGBA。
RtcEngineVideoABGR
ABGR。
RtcEngineVideoTexture
纹理。
-
RtcEngineAudioProfile:音频编码模式。
枚举名
描述
枚举名
描述
RtcEngineBasicQualityMode
标准音质模式,默认16000Hz采样率,单声道,最大编码码率24kbps。
RtcEngineHighQualityMode
高音质模式,默认48000Hz采样率,单声道,最大编码码率64kbps。
RtcEngineSuperHighQualityMode
超高音质模式,默认48000Hz采样率,单声道,最大编码码率96kbps。
-
RtcEngineAudioScenario:音频场景模式。
枚举名
描述
枚举名
描述
RtcEngineSceneDefaultMode
默认场景,一般的音视频通信场景推荐使用。
RtcEngineSceneMusicMode
音乐场景,高音质适用于音乐为主的场景。
-
RtcEngineAudioObservePosition:音频数据源类型。
枚举名
描述
枚举名
描述
RtcEngineAudioPositionCaptured
采集的音频数据,对应输出回调OnCapturedAudioFrame。
RtcEngineAudioPositionProcessCaptured
3A后的音频数据,对应输出回调OnProcessCapturedAudioFrame
RtcEngineAudioPositionPub
推流的音频数据,对应输出回调OnPublishAudioFrame
RtcEngineAudioPositionPlayback
播放的音频数据,对应输出回调OnPlaybackAudioFrame
RtcEngineAudioPositionRemoteUser
拉流的远端音频数据,对应输出回调OnRemoteUserAudioFrame
-
RtcEngineAudioNumChannelType:音频声道类型。
枚举名
描述
枚举名
描述
RtcEngineMonoAudio
单声道。
RtcEngineStereoAudio
双声道。
-
RtcEngineAudioSampleRate:音频采样率类型。
枚举名
描述
枚举名
描述
RtcEngineAudioSampleRate_8000
8000采样率。
RtcEngineAudioSampleRate_16000
16000采样率。
RtcEngineAudioSampleRate_32000
32000采样率。
RtcEngineAudioSampleRate_44100
44100采样率。
RtcEngineAudioSampleRate_48000
48000采样率。
-
WBMode:白板模式。
枚举名
描述
枚举名
描述
BASIC
基础模式。
ADVANCE
高级模式。
-
AnnoType:标注类型。
枚举名
描述
枚举名
描述
SHARE
共享标注
VIDEO
视频标注
EXTERNAL
外部标注
-
WBRoleType:白板角色类型。
枚举名
描述
枚举名
描述
ADMIN
白板管理员。
ATTENDEE
普通白板参与者。
VIEWER
只看白板参与者。
-
WBToolType:白板工具参数。
枚举名
描述
枚举名
描述
NONE
空
SELECT
选中
CLICK
点击
HAND
拖拽
PATH
画笔
LINE
直线
RECT
矩形
ELLIPSE
椭圆
IMAGE
图片
TEXT
文本
DELETER
删除工具
BRUSH
刷子
ARROW
箭头
POLYLINE
折线。仅支持Windows及macOS平台。
ARC
弧线。仅支持Windows及macOS平台。
CURVE
曲线。仅支持Windows及macOS平台。
LASER
激光笔。
STAMP
图章
VANISHPEN
消失笔
HIGHLIGHTER
荧光笔
ERASER
橡皮擦
-
WBFillType:白板填充类型。
枚举名
描述
枚举名
描述
NONE
不填充
COLOR
填充颜色
BORDER_FILL
边框并填充
-
WBFontStyle:白板字体样式。
枚举名
描述
枚举名
描述
NORMAL
常规
BOLD
粗体
ITALIC
斜体
BOLD_ITALIC
粗斜体
-
WBImageState:白板图像状态。
枚举名
描述
枚举名
描述
LOAD_START
开始加载图片。
LOAD_COMPLETE
图片加载成功。
LOAD_FAIL
图片加载失败。
-
WBFileTransState:文件转码状态。
枚举名
描述
枚举名
描述
TRANSCODE_START
开启转码。
TRANSCODE_COMPLETE
转码成功。
TRANSCODE_FAIL
转码失败。
TRANSCODE_START_FAIL
转码开启失败
TRANSCODE_QUERY_FAIL
转码查询失败
-
WBScalingMode:白板渲染缩放模式。
枚举名
描述
枚举名
描述
Fit
保持宽高比
CropFill
保持宽高比全填充
CenterCrop
原始大小居中显示
StretchFill
拉伸铺满全填充
-
WBScalingBase:白板渲染缩放基准。
枚举名
描述
枚举名
描述
DEFAULT
默认。100对应原始白板大小。
VIEW
视图基准。100对应FIT填充视图。
-
WBClearMode:白板清除模式。
枚举名
描述
枚举名
描述
ALL
全部内容。
OTHERS
其它人内容。
SELF
自己内容。
SPECIFIC
指定内容。
-
WBDrawEvent:绘制事件类型
枚举名
描述
枚举名
描述
DRAW_UNKNOWN
未知事件。
DRAW_START
绘制开始。
DRAW_END
绘制结束。
DRAW_CANCEL
绘制取消。
SELECT_MOVE_START
选择移动开始。
SELECT_MOVE_END
选择移动结束。
DELETE_START
删除开始。
DELETE_END
删除结束。
TEXT_DRAW
文本绘制。
TEXT_UPDATE
文本更新。
-
WBContentUpdateType:内容更新类型。
枚举名
描述
枚举名
描述
UNKNOWN
未知。
REMOTE_DRAW
远端绘制。
-
WBSnapshotMode:快照模式
枚举名
描述
枚举名
描述
VIEW
视图显示区域。
ALL
全部区域。
-
WBDocType:白板文档类型。
枚举名
描述
枚举名
描述
NORMAL
普通。
PDF
PDF。
EXTERNAL
外部。
-
WBOption:白板选项。
枚举名
描述
枚举名
描述
ENABLE_UI_RESPONSE
启用白板响应UI事件。默认启用
ENABLE_SHOW_DRAWS
显示或隐藏白板涂鸦。默认显示背景图和H5内容不受此选项影响
ENABLE_SCALE_MOVE
启用白板画布缩放移动。默认启用SetZoomScale不受此选项的影响
ENABLE_AUTO_SELECTED
设置图片或音视频对象默认选中状态。默认启用
ENABLE_CURSORPOS_SYNC
启用光标位置同步。默认关闭
ENABLE_SHOW_REMOTE_CURSOR
开启显示远端光标。默认关闭
ENABLE_LOCAL_CURSOR_LABEL
是否显示本地用户名称。默认关闭
ENABLE_SELECT_SHOW_NAME
选中时是否显示对象用户名称。默认打开
ENABLE_TOUCH_SCREEN
打开触屏模式。默认关闭
ENABLE_LASER_TRAIL
打开激光笔尾巴。默认打开
ENABLE_ERASE_TRAIL
打开橡皮擦轨迹。默认关闭
ENABLE_RENDER_THREAD
开启渲染线程。默认关闭。当前仅对Windows有效
HOT_ZONE_SIZE
设置选择和删除热区大小。默认值10.f(float类型)
TOUCH_CURSOR_SIZE
设置触摸点光标大小。默认值32(uint32_t类型)
ENABLE_PALM_ERASER
开启手掌橡皮擦。默认关闭
ERASER_ZONE_SIZE
设置橡皮擦热区大小。默认值100.f(float类型)
TOUCH_CONFIG
触摸配置。默认关闭
-
AnnoOption:标注选项。
枚举名
描述
枚举名
描述
ENABLE_LOCAL_RENDER
启用本地标注渲染。默认启用。该选项需要在调用open前设置
ENABLE_SHOW_DRAWS
显示或隐藏标注涂鸦。默认显示
ENABLE_UI_RESPONSE
启用标注响应UI事件。默认启用
ENABLE_SCALE_MOVE
启用标注画布缩放移动。默认启用SetZoomScale不受此选项的影响
ENABLE_CURSORPOS_SYNC
启用光标位置同步。默认关闭
ENABLE_SHOW_REMOTE_CURSOR
开启显示远端光标。默认关闭
SCALE_BASE_MODE
缩放基准模式。默认WBScalingBase::Default
ENABLE_LOCAL_CURSOR_LABEL
是否显示本地用户名称。默认关闭
ENABLE_AUTO_TRACKING_WINDOW
是否自动跟踪窗口大小和位置。默认开启,如关闭需依赖setWindowPos设置。
ENABLE_SELECT_SHOW_NAME
选中时是否显示对象用户名称。默认打开
ENABLE_TOUCH_SCREEN
打开触屏模式。默认关闭
ENABLE_LASER_TRAIL
打开激光笔尾巴。默认打开
ENABLE_ERASE_TRAIL
打开橡皮擦轨迹。默认关闭
ENABLE_LOCAL_LOW_REFRESH_RATE
本地绘制开启低刷新率。默认关闭仅对低渲染性能设备设置
ENABLE_RENDER_THREAD
开启渲染线程。默认关闭当前仅对Windows有效
HOT_ZONE_SIZE
设置选择和删除热区大小。默认值10.f(float类型)
TOUCH_CURSOR_SIZE
设置触摸点光标大小。默认值32(uint32_t类型)
ERASER_ZONE_SIZE
设置橡皮擦热区大小。默认值100.f(float类型)
-
RtcEngineAudioMixingStatusConfig:伴奏混音状态信息。
参数名
类型
描述
参数名
类型
描述
status
伴奏混音状态。
errorCode
伴奏混音错误信息。
fileName
std::string
伴奏文件名称。
id
int
伴奏文件id。
durationMs
long
伴奏时长。
-
RtcEngineDeviceInfo:设备信息。
参数名
类型
描述
参数名
类型
描述
deviceName
String
设备名称。
deviceID
String
设备ID。
-
RtcEngineScreenDeviceInfo:屏幕共享设备信息
参数名
类型
描述
参数名
类型
描述
thumbnail
icon
-
RtcEngineAudioMixingConfig:伴奏混音配置信息。
参数名
类型
描述
参数名
类型
描述
enablePublish
bool
是否允许伴奏推流到远端,true:允许推流,false:不允许推流。
enablePlayout
bool
是否允许伴奏本地播放,true:允许播放,false:不允许播放。
publishVolume
int
伴奏推流到远端音量,取值范围[0,100]。
playoutVolume
int
伴奏本地播放音量,取值范围[0,100]。
cycles
int
循环次数,大于0有效。
startPosMs
long
开始播放位置,单位ms。
-
RtcEngineAuthInfo:用户鉴权信息。
参数名
类型
描述
参数名
类型
描述
channelId
String
频道ID。
userId
String
用户ID。
appId
String
应用ID。
token
String
令牌。
gslbServer
String
GSLB地址。
-
RtcEngineVideoCanvas:视频显示窗口设置。
参数名
类型
描述
参数名
类型
描述
displayView
void *
显示视图。
backgroundColor
int
背景颜色,格式为RGB的Hex。
renderMode
渲染模式,默认值为RtcEngineRenderModeAuto。
mirrorMode
镜像模式,默认值为RtcEngineRenderMirrorModeOnlyFrontMirror。
scaleMode
视频宽高比,默认值为RtcEngineVideoScale_16_9。
rotation
旋转角度,默认值为RtcEngineRotationMode_0。
renderId
long long
支持第三方OpenGLES纹理显示,纹理ID。
width
int
支持第三方OpenGLES纹理显示,纹理宽。
height
int
支持第三方OpenGLES纹理显示,纹理高。
enableGL
bool
该参数只在iOS和Mac平台生效,true:使用OpenGLES渲染。false:使用Metal渲染。
toBeRemoved
bool
是否移除视图。
enableHwAcceleration
bool
是否使用硬件加速渲染
-
RtcEngineAudioFrame:音频帧数据结构。
参数名
类型
描述
参数名
类型
描述
type
音频帧类型。
bytesPerSample
int
每个音频采样字节数,通常是16bit(即2字节)。
samplesPerSec
int
采样率。
channels
int
声道数:1:单声道,2:双声道。
samples
int
采样点数(每个声道)。
buffer
void *
音频帧数据缓冲区,该缓冲区大小为:buffer_size=samples×channels×bytesPerSample。
timestamp
long long
音频时间戳。
-
RtcEngineCameraCapturerConfiguration:camera采集偏好。
参数名
类型
描述
参数名
类型
描述
preference
采集偏好。
-
RtcEngineVideoDimensions:视频分辨率。
参数名
类型
描述
参数名
类型
描述
width
int
分辨率宽。
height
int
分辨率高。
-
RtcEngineBeautyFaceOptions:视频美颜选项。
参数名
类型
描述
参数名
类型
描述
resourcePath
const char *
资源文件路径,reserved。
enableSkinBuffing
bool
是否开启美肤。
skinBuffingFactor
float
磨皮系数,取值范围[0-1]。
skinSharpenFactor
float
锐化系数,取值范围[0-1]。
enableSkinWhitening
bool
是否开启美白。
skinWhitingFactor
float
美白系数,取值范围[0-1]。
-
RtcEngineVirtualBackgroundOptions:虚拟背景选项。
参数名
类型
描述
参数名
类型
描述
mode
虚拟背景模式。
bgFilePath
const char *
虚拟背景图片路径。
-
RtcEngineVideoEnhanceOptions:视频暗光增强选项。
参数名
类型
描述
参数名
类型
描述
mode
视频暗光增强模式。
-
RtcEngineVideoDenoiseOptions:视频去噪选项。
参数名
类型
描述
参数名
类型
描述
mode
视频去噪模式。
-
RtcEngineAudioDenoiseOptions:音频去噪选项。
参数名
类型
描述
参数名
类型
描述
mode
音频去噪模式。
-
RtcEngineVideoEncoderConfiguration:相机流视频编码属性设置。
参数名
类型
描述
参数名
类型
描述
dimensions
视频分辨率,默认值640x480,可自行设置分辨率,也可以选择上面预定义的分辨率。
frameRate
int
视频帧率,默认值20,最大值30。
orientationMode
视频输出方向,默认RtcEngineVideoEncoderOrientationModeAdaptive,详见ding::rtc::RtcEngineVideoEncoderOrientationMode。
rotation
int
视频旋转角度,默认值:0。
mirrorMode
视频镜像模式,默认RtcEngineVideoMirrorModeDisabled,详见ding::rtc::RtcEngineVideoMirrorMode。
-
RtcEngineVideoFrame:视频帧数据结构。
参数名
类型
描述
参数名
类型
描述
frameType
视频帧类型。
pixelFormat
视频数据格式。
timestamp
long long
时间戳。
width
int
视频帧的宽。
height
int
视频帧的高。
rotation
int
视频旋转角度。
count
int
视频帧的数量。
offset
int
stride
int
视频帧行间距。
data
void *
视频帧数据。
textureId
int
纹理ID。
mirror
bool
镜像
-
RtcEngineStats:会话数据统计信息。
参数名
类型
描述
参数名
类型
描述
duration
unsigned long long
通话时长,单位:秒。
txBytes
unsigned long long
发送字节数。
txAudioBytes
unsigned long long
音频发送字节数。
txVideoBytes
unsigned long long
视频发送字节数。
txKBitrate
unsigned short
发送码率。
txAudioKBitrate
unsigned short
音频发送码率。
txVideoKBitrate
unsigned short
视频发送码率
txPacketLossRate
int
客户端到服务器的丢包率。
rxBytes
unsigned long long
接收字节数。
rxPackets
unsigned long long
接收数据包。
rxAudioBytes
unsigned long long
音频接收字节数。
rxVideoBytes
unsigned long long
视频接收字节数。
rxKBitrate
unsigned short
接收码率。
rxAudioKBitrate
unsigned short
音频接收码率。
rxVideoKBitrate
unsigned short
视频接收码率。
rxPacketLossRate
int
客户端到服务器的下行丢包率。
rxLostPackets
unsigned long long
客户端到服务器的下行丢包数。
lastmileDelay
unsigned short
延时时长,单位:毫秒。
connectTimeMs
int
连接时长。
systemCpuRate
int
系统CPU使用率。
appCpuRate
int
RTC进程CPU使用率。
-
LocalVideoStats:本地视频统计信息。
参数名
类型
描述
参数名
类型
描述
track
视频流类型。
targetEncodeBitrate
unsigned int
目标编码码率。
actualEncodeBitrate
unsigned int
实际编码码率。
sentBitrate
unsigned int
发送码率。
sentFps
unsigned int
发送帧率。
encodeFps
unsigned int
编码器输出帧率。
captureFps
unsigned int
采集帧率。
renderFps
unsigned int
渲染帧率。
avgQpPerSec
unsigned int
每秒平均QP。
encoderFrameWidth
int
编码帧宽。
encoderFrameHeight
int
编码帧高。
captureFrameWidth
int
采集帧宽。
captureFrameHeight
int
采集帧高
-
RemoteVideoStats:远端视频统计信息。
参数名
类型
描述
参数名
类型
描述
userId
ding::rtc::String
用户ID。
track
视频流类型。
width
int
视频帧宽。
height
int
视频帧高。
recvBitrate
int
接收码率。
decoderOutputFrameRate
int
解码帧率。
rendererOutputFrameRate
int
渲染帧率。
packetLossRate
int
丢包率。
stuckTime
int
卡顿时长(ms)。
-
LocalAudioStats:本地音频统计信息。
参数名
类型
描述
参数名
类型
描述
track
音频流类型。
sentBitrate
unsigned int
发送码率。
sentSamplerate
unsigned int
发送的采样率。
numChannel
unsigned int
声道数。
inputLevel
unsigned int
输入音量。
-
AudioVolumeInfo:音频音量信息。
参数名
类型
描述
参数名
类型
描述
userId
ding::rtc::String
用户ID(从AppServer下发的唯一标示符),userId为"0"表示本地用户。
volume
unsigned int
用户音量,取值范围:[0,100]。
speechState
unsigned int
语音状态,取值:0:当前未说话。1:当前在说话。
-
RemoteAudioStats:远端音频统计信息。
参数名
类型
描述
参数名
类型
描述
userId
ding::rtc::String
远端用户UID。
packetLossRate
int
音频丢包率。
recvBitrate
int
接收码率。
totalFrozenTime
int
卡顿时长(ms)。
speechExpandRate
int
拉伸率。
-
RtcEngineAudioFrameObserverConfig:音频数据回调参数设置。
参数名
类型
描述
参数名
类型
描述
sampleRate
回调音频采样率类型。
channels
回调音频声道类型。
permission
RtcEngineAudioFramePermissions
回调音频数据读写选项。
-
tagQualityReport:质量报告数据。
参数名
类型
描述
参数名
类型
描述
cpu_physical_cores
int
cpu_logic_cores
int
cpu_frequency_mhz
int
cpu_used_by_app
int
cpu_used_by_other_apps
int
memory_total_mb
int
memory_used_by_app
int
memory_used_by_other_apps
int
loss_rate
int
丢包率。
rtt_ms
int
延时。
recv_bitrate
int
接收码率。
send_bitrate
int
发送码率。
signal_level
int
network_type
char
网络类型。
audio_send_bitrate
int
音频发送码率。
audio_send_volume
int
音频发送音量。
audio_recv_bitrate
int
音频接收码率。
audio_recv_volume
int
音频接收音量。
camera_send_bitrate
int
视频发送码率。
camera_send_capture_fps
int
视频发送的采集帧率。
camera_send_drop_fps
int
camera_send_fps
int
视频发送帧率。
camera_send_hw
int
camera_send_width
int
视频发送宽度。
camera_send_height
int
视频发送高度。
screenshare_send_bitrate
int
屏幕共享发送码率。
screenshare_send_capture_fps
int
屏幕共享采集帧率。
screenshare_send_drop_fps
int
screenshare_send_fps
int
屏幕共享发送帧率。
screenshare_send_hw
int
screenshare_send_width
int
屏幕共享宽度。
screenshare_send_height
int
屏幕共享高度。
camera_recv_bitrate
int
视频接收码率。
camera_recv_fps
int
视频接收帧率。
camera_recv_render_fps
int
视频渲染器帧率。
camera_recv_hw
int
camera_recv_width
int
视频接收宽度。
camera_recv_height
int
视频接收高度。
screenshare_recv_bitrate
int
屏幕共享接收码率。
screenshare_recv_fps
int
屏幕共享接收帧率。
screenshare_recv_render_fps
int
屏幕共享渲染帧率。
screenshare_recv_hw
int
screenshare_recv_width
int
屏幕共享接收宽度。
screenshare_recv_height
int
屏幕共享接收高度。
-
WBConfig:白板配置参数。
参数名
类型
描述
参数名
类型
描述
mode
白板模式。
width
uint32_t
白板宽度。
height
uint32_t
白板高度。
-
AnnoConfig:标注配置参数。
参数名
类型
描述
参数名
类型
描述
type
标注类型。
-
WBUserMember:白板用户成员。
参数名
类型
描述
参数名
类型
描述
uid
String
-
WBPoint:点。
参数名
类型
描述
参数名
类型
描述
x
float
x坐标
y
float
y坐标
-
WBRect:矩形。
参数名
类型
描述
参数名
类型
描述
left
float
左上角x坐标
top
float
左上角y坐标
right
float
右下角x坐标
bottom
float
右下角y坐标
-
WBSize:大小。
参数名
类型
描述
参数名
类型
描述
cx
float
宽度
cy
float
高度
-
WBColor:白板颜色。
参数名
类型
描述
参数名
类型
描述
r
float
红色成分,有效值范围:[0.0,1.0]。默认值:0.0。
g
float
绿色成分,有效值范围:[0.0,1.0]。默认值:0.0。
b
float
蓝色成分,有效值范围:[0.0,1.0]。默认值:0.0。
a
float
透明度成分,有效值范围:[0.0,1.0]。默认值:1.0。
-
WBTextFormat:白板文本格式。
参数名
类型
描述
参数名
类型
描述
size
uint32_t
字体大小,有效值范围:[10,96]。默认值:12。
style
字体样式
color
字体颜色
-
WBStamp:白板图章。
参数名
类型
描述
参数名
类型
描述
stampId
const char *
图章资源ID。最大长度128字节
path
const char *
图章资源路径
resizable
bool
图章是否可以改变大小。默认值:false。
-
WBClearParam:白板清除配置。
参数名
类型
描述
参数名
类型
描述
curPage
bool
是否仅清除当前页。
mode
白板清除模式
-
WBDocInfo:白板文档信息。
参数名
类型
描述
参数名
类型
描述
type
文档类型。
docId
String
文档ID。
name
String
文档名称。
creator
String
文档创建人用户ID。
-
WBDocContents:白板文档内容信息
参数名
类型
描述
参数名
类型
描述
type
文档类型
name
String
文档名称
urls
StringArray
url地址数组
transDocId
String
文档转码ID
-
WBTouchConfig:白板触摸配置。
参数名
类型
描述
参数名
类型
描述
enable
bool
是否开启手掌检测。
smallContactSize
float
小接触大小。
largeContactSize
float
大接触大小。
smallEraserSize
float
小橡皮擦大小。
largeEraserSize
float
大橡皮擦大小。
- 本页导读 (0)
- 目录
- 详情