数据类型

通过阅读本文,您可以了解Windows SDK涉及的数据类型。

目录

数据类型

描述

支持的最低版本

RtcEngineAudioMixingStatus

伴奏混音状态。

3.4

RtcEngineAudioMixingErrorCode

伴奏混音错误码。

3.4

RtcEngineDeviceType

设备类型。

3.0

RtcEngineDeviceState

设备状态。

3.0

RtcEngineUserOfflineReason

用户离线原因。

3.0

RtcEngineOnByeType

OnBye类型。

3.0

RtcEngineConnectionStatus

网络连接状态。

3.0

RtcEngineConnectionStatusChangeReason

网络连接状态变更原因。

3.0

RtcEngineNetworkQuality

网络质量。

3.0

RtcEngineLogLevel

日志级别。

3.0

RtcEngineErrorCode

SDK错误码。

3.0

RtcEngineRenderMode

视图显示模式。

3.0

RtcEngineRenderMirrorMode

视频窗口镜像模式。

3.0

RtcEngineVideoScale

视频宽高比。

3.0

RtcEngineRotationMode

视频旋转角度。

3.0

RtcEngineAudioTrack

音频track的类型。

3.0

RtcEngineAudioFrameType

音频帧类型。

3.0

RtcEngineVideoTrack

视频流类型。

3.0

RtcEngineVideoStreamType

视频码流类型。

3.0

RtcEngineSubscribeState

订阅状态。

3.0

RtcEngineCaptureOutputPreference

采集偏好。

3.0

RtcEngineCameraDirection

摄像头方向。

3.0

RtcEngineVideoEncoderOrientationMode

视频输出方向。

3.0

RtcEngineVideoMirrorMode

视频镜像模式。

3.0

RtcEngineVirtualBackgroundMode

虚拟背景选项。

3.3

RtcEngineVideoEnhanceMode

视频暗光增强选项。

3.0

RtcEngineVideoDenoiseMode

视频去噪模式。

3.0

RtcEngineAudioDenoiseMode

音频去噪模式。

3.4

RtcEngineScreenShareType

桌面分享类型。

3.0

RtcEnginePublishState

推流状态。

3.0

RtcEngineVideoFrameType

视频帧类型。

3.0

RtcEngineVideoPixelFormat

视频数据格式。

3.0

RtcEngineAudioProfile

音频编码模式。

3.0

RtcEngineAudioScenario

音频场景模式。

3.0

RtcEngineAudioObservePosition

音频数据源类型。

3.1

RtcEngineAudioNumChannelType

音频声道类型。

3.2

RtcEngineAudioSampleRate

音频采样率类型。

3.2

RtcEngineAudioSource

音频数据源类型。

3.0

RtcEngineAudioMixingStatusConfig

伴奏混音状态信息。

3.4

RtcEngineAudioMixingConfig

伴奏混音配置信息。

3.4

RtcEngineDeviceInfo

设备信息。

3.0

RtcEngineAuthInfo

用户鉴权信息。

3.0

RtcEngineVideoCanvas

视频显示窗口设置。

3.0

RtcEngineAudioFrame

音频帧数据结构。

3.0

RtcEngineCameraCapturerConfiguration

camera采集偏好。

3.0

RtcEngineVideoDimensions

视频分辨率。

3.0

RtcEngineBeautyFaceOptions

视频美颜选项。

3.0

RtcEngineVirtualBackgroundOptions

虚拟背景选项。

3.3

RtcEngineVideoEnhanceOptions

视频暗光增强选项。

3.0

RtcEngineVideoDenoiseOptions

视频去噪选项。

3.0

RtcEngineAudioDenoiseOptions

音频去噪选项。

3.4

RtcEngineVideoEncoderConfiguration

相机流视频编码属性设置。

3.0

RtcEngineScreenShareEncoderConfiguration

屏幕流编码属性设置。

3.0

RtcEngineScreenShareRegion

屏幕分享区域。

3.0

RtcEngineScreenShareConfig

屏幕共享参数配置。

3.0

RtcEngineScreenShareInfo

屏幕共享配置信息。

3.0

RtcEngineVideoFrame

视频帧数据结构。

3.0

LocalVideoStats

本地视频统计信息。

3.0

RemoteVideoStats

远端视频统计信息。

3.0

AudioVolumeInfo

音频音量信息。

3.0

RtcEngineStats

会话数据统计信息。

3.0

LocalAudioStats

本地音频统计信息。

3.0

RemoteAudioStats

远端音频统计信息。

3.0

RtcEngineAudioFrameObserverConfig

音频数据回调参数设置。

3.2

tagQualityReport

质量报告数据。

3.0

详情

  • 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

    屏幕共享打开失败。

    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:关闭镜像。

    RtcEngineVideoMirrorModeEnable

    1:开启镜像。

  • RtcEngineVirtualBackgroundMode:虚拟背景选项。

    枚举名

    描述

    RtcEngineVirtualBackgroundBlur

    背景虚化。

    RtcEngineVirtualBackgroundReplace

    背景替换。

  • RtcEngineVideoEnhanceMode:视频暗光增强选项。

    枚举名

    描述

    RtcEngineVideoEnhanceOff

    视频暗光增强关。

    RtcEngineVideoEnhanceAuto

    视频暗光增强自动模式。

  • RtcEngineVideoDenoiseMode:视频去噪模式。

    枚举名

    描述

    RtcEngineVideoDenoiseOff

    视频去噪关。

    RtcEngineVideoDenoiseAuto

    视频去噪自动模式。

  • RtcEngineAudioDenoiseMode:音频去噪模式。

    枚举名

    描述

    RtcEngineAudioDenoiseOff

    音频去噪关。

    RtcEngineAudioDenoiseDsp

    音频去噪采用传统降噪。

    RtcEngineAudioDenoiseEnhance

    音频去噪采用智能降噪。

  • RtcEngineScreenShareType:桌面分享类型。

    枚举名

    描述

    RtcEngineScreenShareDesktop

    桌面分享。

    RtcEngineScreenShareWindow

    窗口分享。

  • 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

  • RtcEngineAudioNumChannelType:音频声道类型。

    枚举名

    描述

    RtcEngineMonoAudio

    单声道。

    RtcEngineStereoAudio

    双声道。

  • RtcEngineAudioSampleRate:音频采样率类型。

    枚举名

    描述

    RtcEngineAudioSampleRate_8000

    8000采样率。

    RtcEngineAudioSampleRate_16000

    16000采样率。

    RtcEngineAudioSampleRate_32000

    32000采样率。

    RtcEngineAudioSampleRate_44100

    44100采样率。

    RtcEngineAudioSampleRate_48000

    48000采样率。

  • RtcEngineAudioSource:音频数据源类型。

    枚举名

    描述

    RtcEngineAudioSourceCaptured

    采集的音频数据。

    RtcEngineAudioSourceProcessCaptured

    3A后的音频数据。

    RtcEngineAudioSourcePub

    推流的音频数据。

    RtcEngineAudioSourcePlayback

    播放的音频数据。

  • RtcEngineAudioMixingStatusConfig:伴奏混音状态信息。

    参数名

    类型

    描述

    status

    RtcEngineAudioMixingStatus

    伴奏混音状态。

    errorCode

    RtcEngineAudioMixingErrorCode

    伴奏混音错误信息。

    fileName

    std::string

    伴奏文件名称。

    id

    int

    伴奏文件id。

    durationMs

    long

    伴奏时长。

  • RtcEngineAudioMixingConfig:伴奏混音配置信息。

    参数名

    类型

    描述

    enablePublish

    bool

    是否允许伴奏推流到远端,true:允许推流,false:不允许推流。

    enablePlayout

    bool

    是否允许伴奏本地播放,true:允许播放,false:不允许播放。

    publishVolume

    int

    伴奏推流到远端音量,取值范围[0,100]。

    playoutVolume

    int

    伴奏本地播放音量,取值范围[0,100]。

    cycles

    int

    循环次数,大于0有效。

    startPosMs

    long

    开始播放位置,单位ms。

  • RtcEngineDeviceInfo:设备信息。

    参数名

    类型

    描述

    deviceName

    String

    设备名称。

    deviceID

    String

    设备ID。

  • RtcEngineAuthInfo:用户鉴权信息。

    参数名

    类型

    描述

    channelId

    String

    频道ID。

    userId

    String

    用户ID。

    appId

    String

    应用ID。

    token

    String

    令牌。

    gslbServer

    String

    GSLB地址。

  • RtcEngineVideoCanvas:视频显示窗口设置。

    参数名

    类型

    描述

    displayView

    void *

    显示视图。

    backgroundColor

    int

    背景颜色,格式为RGB的Hex。

    renderMode

    RtcEngineRenderMode

    渲染模式,默认值为RtcEngineRenderModeAuto。

    mirrorMode

    RtcEngineRenderMirrorMode

    镜像模式,默认值为RtcEngineRenderMirrorModeOnlyFrontMirror。

    scaleMode

    RtcEngineVideoScale

    视频宽高比,默认值为RtcEngineVideoScale_16_9。

    rotation

    RtcEngineRotationMode

    旋转角度,默认值为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

    RtcEngineAudioFrameType

    音频帧类型。

    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

    RtcEngineCaptureOutputPreference

    采集偏好。

  • 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

    RtcEngineVirtualBackgroundMode

    虚拟背景模式。

    bgFilePath

    const char *

    虚拟背景图片路径。

  • RtcEngineVideoEnhanceOptions:视频暗光增强选项。

    参数名

    类型

    描述

    mode

    RtcEngineVideoEnhanceMode

    视频暗光增强模式。

  • RtcEngineVideoDenoiseOptions:视频去噪选项。

    参数名

    类型

    描述

    mode

    RtcEngineVideoDenoiseMode

    视频去噪模式。

  • RtcEngineAudioDenoiseOptions:音频去噪选项。

    参数名

    类型

    描述

    mode

    RtcEngineAudioDenoiseMode

    音频去噪模式。

  • RtcEngineVideoEncoderConfiguration:相机流视频编码属性设置。

    参数名

    类型

    描述

    dimensions

    RtcEngineVideoDimensions

    视频分辨率,默认值640x480,可自行设置分辨率,也可以选择上面预定义的分辨率。

    frameRate

    int

    视频帧率,默认值20,最大值30。

    orientationMode

    RtcEngineVideoEncoderOrientationMode

    视频输出方向,默认RtcEngineVideoEncoderOrientationModeAdaptive,详见ding::rtc::RtcEngineVideoEncoderOrientationMode。

    rotation

    int

    视频旋转角度,默认值:0。

  • RtcEngineScreenShareEncoderConfiguration:屏幕流编码属性设置。

    参数名

    类型

    描述

    dimensions

    RtcEngineVideoDimensions

    视频分辨率,默认值0x0,最大值3840x2160。默认值表示推流分辨率等于屏幕采集的分辨率。

    frameRate

    int

    视频帧率,默认值5,最大值30。

  • RtcEngineScreenShareRegion:屏幕分享区域。

    参数名

    类型

    描述

    originX

    int

    x轴起点。

    originY

    int

    y轴起点。

    width

    int

    宽度。

    height

    int

    高度。

  • RtcEngineScreenShareConfig:屏幕共享参数配置。

    参数名

    类型

    描述

    isShareByRegion

    bool

    屏幕分享时是否指定区域,默认false。

    shareRegion

    RtcEngineScreenShareRegion

    屏幕分享区域配置。

  • RtcEngineScreenShareInfo:屏幕共享配置信息。

    参数名

    类型

    描述

    shareType

    RtcEngineScreenShareType

    桌面分享类型。

    shareSourceId

    unsigned int

    共享源ID。

    shareConfig

    RtcEngineScreenShareConfig

    屏幕共享参数配置。

  • RtcEngineVideoFrame:视频帧数据结构。

    参数名

    类型

    描述

    frameType

    RtcEngineVideoFrameType

    视频帧类型。

    pixelFormat

    RtcEngineVideoPixelFormat

    视频数据格式。

    timestamp

    long long

    时间戳。

    width

    int

    视频帧的宽。

    height

    int

    视频帧的高。

    rotation

    int

    视频旋转角度。

    count

    int

    视频帧的数量。

    offset

    int

    stride

    int

    视频帧行间距。

    data

    void *

    视频帧数据。

    textureId

    int

    纹理ID。

  • LocalVideoStats:本地视频统计信息。

    参数名

    类型

    描述

    track

    RtcEngineVideoTrack

    视频流类型。

    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

    RtcEngineVideoTrack

    视频流类型。

    width

    int

    视频帧宽。

    height

    int

    视频帧高。

    recvBitrate

    int

    接收码率。

    decoderOutputFrameRate

    int

    解码帧率。

    rendererOutputFrameRate

    int

    渲染帧率。

    packetLossRate

    int

    丢包率。

  • AudioVolumeInfo:音频音量信息。

    参数名

    类型

    描述

    userId

    ding::rtc::String

    用户ID(从AppServer下发的唯一标示符),userId为"0"表示本地用户。

    volume

    unsigned int

    用户音量,取值范围:[0,100]。

    speechState

    unsigned int

    语音状态,取值:0:当前未说话。1:当前在说话。

  • 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使用率。

  • LocalAudioStats:本地音频统计信息。

    参数名

    类型

    描述

    track

    RtcEngineAudioTrack

    音频流类型。

    sentBitrate

    unsigned int

    发送码率。

    sentSamplerate

    unsigned int

    发送的采样率。

    numChannel

    unsigned int

    声道数。

    inputLevel

    unsigned int

    输入音量。

  • RemoteAudioStats:远端音频统计信息。

    参数名

    类型

    描述

    userId

    ding::rtc::String

    远端用户UID。

    packetLossRate

    int

    音频丢包率。

    recvBitrate

    int

    接收码率。

    totalFrozenTime

    int

    卡顿时长(ms)。

    speechExpandRate

    int

    拉伸率。

  • RtcEngineAudioFrameObserverConfig:音频数据回调参数设置。

    参数名

    类型

    描述

    sampleRate

    RtcEngineAudioSampleRate

    回调音频采样率类型。

    channels

    RtcEngineAudioNumChannelType

    回调音频声道类型。

    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

    屏幕共享接收高度。