数据类型

目录

详情

• RtcEngineDeviceType：设备类型。

  枚举名	描述
  RtcEngineTypeUnknown	未知类型。
  RtcEngineTypeAudioRecording	音频采集设备。
  RtcEngineTypeAudioPlayout	音频播放设备。
  RtcEngineTypeVideoCapture	视频采集设备。

• 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	占位符。

• RtcEngineVideoTrack：视频流类型。

  枚举名	描述
  RtcEngineVideoTrackNo	无视频流。
  RtcEngineVideoTrackCamera	相机流。
  RtcEngineVideoTrackScreen	屏幕共享流。
  RtcEngineVideoTrackBoth	相机流和屏幕共享流。

• RtcEngineVideoStreamType：视频码流类型。

  枚举名	描述
  RtcEngineVideoStreamTypeNone	无，在OnSubscribeStreamTypeChanged回调表示当前未订阅。
  RtcEngineVideoStreamTypeFHD	超高清流（设备性能、网络状态、推流分辨率符合要求情况下满足），对应1080P收费档。
  RtcEngineVideoStreamTypeHD	高清流（设备性能、网络状态、推流分辨率符合要求情况下满足），对应720P收费档。
  RtcEngineVideoStreamTypeSD	标清（设备性能、网络状态、推流分辨率符合要求情况下满足），对应480P收费档。
  RtcEngineVideoStreamTypeLD	流畅（设备性能、网络状态、推流分辨率符合要求情况下满足），对应480P收费档。

• RtcEngineSubscribeState：订阅状态。

  枚举名	描述
  RtcEngineStatsSubscribeIdle	初始状态。
  RtcEngineStatsNoSubscribe	未订阅。
  RtcEngineStatsSubscribing	订阅中。
  RtcEngineStatsSubscribed	已订阅。

• RtcEngineVideoEncoderOrientationMode：视频输出方向。

  枚举名	描述
  RtcEngineVideoEncoderOrientationModeAdaptive	0：自适应，推流方向和采集方向一致。
  RtcEngineVideoEncoderOrientationModeFixedLandscape	1：横屏模式：该模式下SDK推横屏流，始终以设置的分辨率宽和高中较大的值作为输出视频的宽，较小值作为输出视频的高。
  RtcEngineVideoEncoderOrientationModeFixedPortrait	2：竖屏模式：该模式下SDK推竖屏流，始终以设置的分辨率宽和高中较小的值作为输出视频的宽，较大值作为输出视频的高。

• RtcEngineVideoMirrorMode：视频镜像模式。

  枚举名	描述
  RtcEngineRenderMirrorModeOnlyFrontMirror	只有前置摄像头预览镜像，其余不镜像
  RtcEngineRenderMirrorModeAllMirror	镜像开启
  RtcEngineRenderMirrorModeAllNoMirror	镜像关闭

• RtcEnginePublishState：推流状态。

  枚举名	描述
  RtcEngineStatsPublishIdle	初始状态。
  RtcEngineStatsNoPublish	未推流。
  RtcEngineStatsPublishing	推流中。
  RtcEngineStatsPublished	已推流。

• RtcEngineAudioProfile：音频编码模式。

  枚举名	描述
  RtcEngineBasicQualityMode	标准音质模式，默认16000Hz采样率，单声道，最大编码码率24kbps。
  RtcEngineHighQualityMode	高音质模式，默认48000Hz采样率，单声道，最大编码码率64kbps。
  RtcEngineSuperHighQualityMode	超高音质模式，默认48000Hz采样率，单声道，最大编码码率96kbps。

• RtcEngineAudioScenario：音频场景模式。

  枚举名	描述
  RtcEngineSceneDefaultMode	默认场景，一般的音视频通信场景推荐使用。
  RtcEngineSceneMusicMode	音乐场景，高音质适用于音乐为主的场景。

• AuthInfo：用户鉴权信息。

  参数名	类型	描述
  channelId	String	频道ID。
  userId	String	用户ID。
  appId	String	应用ID。
  token	String	令牌。
  gslbServer	String	GSLB地址。

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

  参数名	类型	描述
  xComponentId	string	显示视图。
  backgroundColor	number	背景颜色，格式为RGB的Hex。
  renderMode	RtcEngineRenderMode	渲染模式，默认值为RtcEngineRenderModeAuto。
  mirrorMode	RtcEngineRenderMirrorMode	镜像模式，默认值为RtcEngineRenderMirrorModeOnlyFrontMirror。
  scaleMode	RtcEngineVideoScale	视频宽高比，默认值为RtcEngineVideoScale_16_9。
  rotation	RtcEngneRotationMode	旋转角度，默认值为RtcEngineRotationMode_0。

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

  参数名	类型	描述
  width	number	视频分辨率，默认值640x480，可自行设置分辨率，也可以选择上面预定义的分辨率。
  height	number
  frameRate	number	视频帧率，默认值20，最大值30。
  orientationMode	RtcEngineVideoEncoderOrientationMode	视频输出方向，默认RtcEngineVideoEncoderOrientationModeAdaptive，详见ding::rtc::RtcEngineVideoEncoderOrientationMode。
  rotation	number	视频旋转角度，默认值：0。

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

  参数名	类型	描述
  width	number	视频分辨率，默认值640x480，可自行设置分辨率，也可以选择上面预定义的分辨率。
  height	number
  frameRate	number	视频帧率，默认值5，最大值30。

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

  参数名	类型	描述
  track	RtcEngineVideoTrack	视频流类型。
  targetEncodeBitrate	number	目标编码码率。
  actualEncodeBitrate	number	实际编码码率。
  sentBitrate	number	发送码率。
  sentFps	number	发送帧率。
  encodeFps	number	编码器输出帧率。
  captureFps	number	采集帧率。
  renderFps	number	渲染帧率。
  avgQpPerSec	number	每秒平均QP。
  encoderFrameWidth	number	编码帧宽。
  encoderFrameHeight	number	编码帧高。
  captureFrameWidth	number	采集帧宽。
  captureFrameHeight	number	采集帧高

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

  参数名	类型	描述
  track	RtcEngineAudioTrack	音频流类型。
  sentBitrate	number	发送码率。
  sentSamplerate	number	发送的采样率。
  numChannel	number	声道数。
  inputLevel	number	输入音量。

• RemoteVideoStats：远端视频统计信息。

  参数名	类型	描述
  userId	string	用户ID。
  track	RtcEngineVideoTrack	视频流类型。
  width	number	视频帧宽。
  height	number	视频帧高。
  recvBitrate	number	接收码率。
  decoderOutputFrameRate	number	解码帧率。
  rendererOutputFrameRate	number	渲染帧率。
  packetLossRate	number	丢包率。

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

  参数名	类型	描述
  userId	string	远端用户UID。
  packetLossRate	number	音频丢包率。
  recvBitrate	number	接收码率。
  totalFrozenTime	number	卡顿时长（ms）。
  speechExpandRate	number	拉伸率。

• AudioVolumeInfo：音频音量信息。

  参数名	类型	描述
  userId	string	用户ID（从AppServer下发的唯一标示符），userId为"0"表示本地用户。
  volume	number	用户音量，取值范围：[0,100]。
  speechState	number	语音状态，取值：0：当前未说话。1：当前在说话。