通过阅读本文,您可以了解Android SDK涉及的数据类型。
目录
数据类型 |
描述 |
支持的最低版本 |
视频暗光增强选项。 |
3.4 |
|
视频暗光增强选项。 |
3.4 |
|
视频去噪模式。 |
3.4 |
|
视频去噪选项。 |
3.4 |
|
音频去噪模式。 |
3.4 |
|
音频去噪选项。 |
3.4 |
|
音频数据源类型。 |
3.1 |
|
音频裸数据。 |
3.0 |
|
视频裸数据。 |
3.0 |
|
视频源类型。 |
3.0 |
|
视频裸数据帧信息 |
3.0 |
|
实时数据。 |
3.0 |
|
本地视频统计信息。 |
3.0 |
|
远端视频统计信息。 |
3.0 |
|
本地音频统计信息。 |
3.0 |
|
远端音频统计信息。 |
3.0 |
|
伴奏混音状态。 |
3.4 |
|
伴奏混音错误码。 |
3.4 |
|
伴奏混音状态信息。 |
3.4 |
|
伴奏混音配置信息。 |
3.4 |
|
用户音量信息。 |
3.0 |
|
视频格式。 |
3.0 |
|
视频数据对应输出回调位置。 |
3.1 |
|
网络连接状态 |
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.5 |
|
Log级别。 |
3.0 |
|
音频声道数。 |
3.0 |
|
音频采样率类型。 |
3.0 |
|
音频编码模式。 |
3.0 |
|
音频场景模式。 |
3.0 |
|
本地静音模式。 |
3.0 |
|
屏幕共享模式。 |
3.0 |
|
音频数据回调模式。 |
3.0 |
|
音频数据回调自定义参数。 |
3.0 |
|
音频数据权限。 |
3.3.0 |
|
音频数据回调设置。 |
3.0 |
|
美颜参数。 |
3.0 |
|
虚拟背景模式 |
3.5 |
|
虚拟背景参数。 |
3.5 |
|
OnBye类型枚举。 |
3.0 |
|
音频路由。 |
3.0 |
|
音频设备信息。 |
3.3 |
|
视频频设备信息 |
3.4.2 |
|
显示视图配置。 |
3.0 |
|
摄像头采集偏好。 |
3.0 |
|
采集偏好。 |
3.0 |
|
视频编码帧率。 |
3.0 |
|
摄像头方向。 |
3.0 |
|
编码视频旋转模式。 |
3.0 |
|
视频分辨率。 |
3.0 |
|
相机流视频编码属性设置。 |
3.0 |
|
屏幕流编码属性设置。 |
3.0 |
|
音频组成员。 |
3.4 |
|
用户信息类 |
3.0 |
|
远端用户的状态。 |
3.0 |
|
白板角色类型。 |
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.6 |
|
白板模式。 |
3.6 |
|
白板错误码。 |
3.6 |
|
白板配置参数。 |
3.6 |
|
白板贴图类。 |
3.6 |
|
白板成员。 |
3.6 |
|
白板手势缩放配置。 |
3.6 |
详情
-
DingRtcEngineVideoEnhanceMode:视频暗光增强选项。
枚举名
描述
DingRtcEngineVideoEnhanceOff
视频暗光增强关。
DingRtcEngineVideoEnhanceAuto
视频暗光增强自动模式。
-
DingRtcEngineVideoEnhanceOptions:视频暗光增强选项。
参数名
类型
描述
mode
视频暗光增强模式。
-
DingRtcEngineVideoDenoiseMode:视频去噪模式。
枚举名
描述
DingRtcEngineVideoDenoiseOff
视频去噪关。
DingRtcEngineVideoDenoiseAuto
视频去噪自动模式。
-
DingRtcEngineVideoDenoiseOptions:视频去噪选项。
参数名
类型
描述
mode
视频去噪模式。
-
DingRtcEngineAudioDenoiseMode:音频去噪模式。
枚举名
描述
DingRtcEngineAudioDenoiseOff
音频去噪关。
DingRtcEngineAudioDenoiseDsp
音频去噪采用传统降噪。
DingRtcEngineAudioDenoiseEnhance
音频去噪采用智能降噪。
-
DingRtcEngineAudioDenoiseOptions:音频去噪选项。
参数名
类型
描述
mode
音频去噪模式。
-
DingRtcAudioObservePosition:音频数据源类型。
参数名
类型
描述
RtcEngineAudioPositionCaptured
final int
采集的音频数据,对应输出回调OnCapturedAudioFrame。
RtcEngineAudioPositionProcessCaptured
final int
3A后的音频数据,对应输出回调OnProcessCapturedAudioFrame。
RtcEngineAudioPositionPub
final int
推流的音频数据,对应输出回调OnPublishAudioFrame。
RtcEngineAudioPositionPlayback
final int
播放的音频数据,对应输出回调OnPlaybackAudioFrame。
RtcEngineAudioPositionRemoteUser
final int
拉流的远端音频数据,对应输出回调OnRemoteUserAudioFrame。
-
DingRtcAudioFrame:音频裸数据。
参数名
类型
描述
data
ByteBuffer
音频数据DirectByteBuffer。
numSamples
int
采样点数(每个声道)。
bytesPerSample
int
每个采样点字节数。
numChannels
int
声道数。
samplesPerSec
int
每秒采样点数。
-
DingRtcVideoSample:视频裸数据。
参数名
类型
描述
dataFrameY
long
Y分量指针。
dataFrameU
long
U分量指针。
dataFrameV
long
V分量指针,NV12和NV21该指针为null。
data
byte[]
format
视频数据类型。
width
int
图像宽度。
height
int
图像高度。
strideY
int
图像Y分量stride。
strideU
int
图像U分量stride。
strideV
int
图像V分量stride。
rotate
int
图像旋转角度。
extraData
long
附加字段(非定制化可忽略)。
textureId
int
该帧的TextureID。
type
VideoFrame.TextureBuffer.Type
transformMatrix
Matrix
Texture帧额外的转换。
eglBaseContext
EglBase.Context
-
DingRtcVideoSourceType:视频源类型。
枚举名
描述
DingRtcSdkVideoSourceCameraType
相机视频源。
DingRtcSdkVideoSourceScreenShareType
屏幕分享视频源。
-
DingRtcRawDataFrame:视频裸数据帧信息
参数名
类型
描述
format
视频数据类型。
width
int
视频流宽。
height
int
视频流高。
rotation
int
视频流角度。
videoFrameLength
int
数据buffer长度。
lineSize
int[]
yuv数据数组。
frame
byte[]
buffer数据。
cropLeft
int
左侧的裁剪像素点数。
cropTop
int
顶部的裁剪像素点数。
cropRight
int
右侧的裁剪像素点数。
cropBottom
int
底部的裁剪像素点数。
timestamp
long
该帧的时间戳,单位:毫秒。
textureId
int
该帧的TextureID。
transformMatrix
float[]
Texture帧额外的转换。
eglContext14
android.opengl.EGLContext
opengl的线程相关上下文变量。
eglContext10
javax.microedition.khronos.egl.EGLContext
-
DingRtcStats:实时数据。
参数名
类型
描述
duration
long
通话时长,单位:秒。
txBytes
long
发送字节数。
txAudioBytes
long
音频发送字节数。
txVideoBytes
long
视频发送字节数。
txKBitrate
short
发送码率。
txAudioKBitrate
short
音频发送码率。
txVideoKBitrate
short
视频发送码率。
txPacketLossRate
int
客户端到服务器的丢包率。
rxBytes
long
接收字节数。
rxPackets
long
接收数据包。
rxAudioBytes
long
音频接收字节数。
rxVideoBytes
long
视频接收字节数。
rxKBitrate
short
接收码率。
rxAudioKBitrate
short
音频接收码率。
rxVideoKBitrate
short
视频接收码率。
rxPacketLossRate
int
客户端到服务器的下行丢包率。
rxLostPackets
long
客户端到服务器的下行丢包数。
lastmileDelay
short
延时时长。
connectTimeMs
int
连接时长。
systemCpuRate
int
系统CPU使用率。
appCpuRate
int
RTC进程CPU使用率。
-
DingRtcLocalVideoStats:本地视频统计信息。
参数名
类型
描述
track
流类型。
targetEncodeBitrate
int
actualEncodeBitrate
int
sentBitrate
int
发布比特率。
sentFps
int
发布帧率。
encodeFps
int
编码帧率。
captureFps
int
采集帧率。
renderFps
int
渲染帧率。
avgQpPerSec
int
encoderFrameWidth
int
编码帧宽。
encoderFrameHeight
int
编码帧高。
captureFrameWidth
int
采集帧宽。
captureFrameHeight
int
采集帧高。
-
DingRtcRemoteVideoStats:远端视频统计信息。
参数名
类型
描述
userId
String
远端用户ID。
track
视频流类型。
width
int
视频帧的宽。
height
int
视频帧的高。
recvBitrate
int
接收码率。
decoderOutputFrameRate
int
编码器输出帧率。
rendererOutputFrameRate
int
渲染器输出帧率。
packetLossRate
int
丢包率。
stuckTime
int
视频流卡顿时长。
-
DingRtcLocalAudioStats:本地音频统计信息。
参数名
类型
描述
track
音频流类型。
sentBitrate
int
发送码率。
sentSamplerate
int
发送的采样率。
numChannel
int
声道数。
inputLevel
int
-
DingRtcRemoteAudioStats:远端音频统计信息。
参数名
类型
描述
userId
String
用户ID。
packetLossRate
int
音频丢包率。
recvBitrate
int
接收码率。
totalFrozenTime
int
卡顿时长(ms)。
speechExpandRate
int
音频拉伸率。
-
DingRtcAudioMixingStatus:伴奏混音状态。
枚举名
描述
DingRtcAudioMixingNone
初始状态
DingRtcAudioMixingStarted
开始混音
DingRtcAudioMixingStopped
停止混音
DingRtcAudioMixingPaused
混音暂停
DingRtcAudioMixingResumed
混音恢复
DingRtcAudioMixingEnded
混音完毕
DingRtcAudioMixingBuffering
正在缓冲
DingRtcAudioMixingBufferingEnd
缓冲结束
DingRtcAudioMixingFailed
混音失败
-
DingRtcAudioMixingErrorCode:伴奏混音错误码。
枚举名
描述
DingRtcAudioMixingNoError
无错误
DingRtcAudioMixingOpenFailed
打开文件失败
DingRtcAudioMixingDecodeFailed
解码失败
-
DingRtcAudioMixingStatusConfig:伴奏混音状态信息。
参数名
类型
描述
status
伴奏混音状态。
errorCode
伴奏混音错误信息。
fileName
String
伴奏文件名称。
id
int
伴奏文件id。
durationMs
long
伴奏时长。
-
DingRtcAudioMixingConfig:伴奏混音配置信息。
参数名
类型
描述
enablePublish
boolean
是否允许伴奏推流到远端,true:允许推流,false:不允许推流。
enablePlayout
boolean
是否允许伴奏本地播放,true:允许播放,false:不允许播放。
publishVolume
int
伴奏推流到远端音量,取值范围[0,100]。
playoutVolume
int
伴奏本地播放音量,取值范围[0,100]。
cycles
int
循环次数,大于0有效。
startPosMs
long
开始位置,单位ms。
-
DingRtcAudioVolumeInfo:用户音量信息。
参数名
类型
描述
userId
String
用户ID,userId为"0"表示本地用户
volume
int
当前音量,取值范围[0,100]
speechState
int
当前用户说话状态,取值:0:表示未说话,1:表示正在说话
-
DingRtcVideoFormat:视频格式。
枚举名
描述
DingRtcVideoFormatI420
I420。
DingRtcVideoFormatNV12
NV12。
DingRtcVideoFormatNV21
NV21。
DingRtcVideoFormatBGRA
BGRA。
DingRtcVideoFormatARGB
ARGB。
DingRtcVideoFormatRGBA
RGBA。
DingRtcVideoFormatABGR
ABGR。
DingRtcVideoFormatTexture2D
Texture2D。
DingRtcVideoFormatTextureOES
TextureOES。
-
DingRtcVideoObservePosition:视频数据对应输出回调位置。
参数名
类型
描述
DingRtcPositionPostCapture
final int
采集视频数据,对应输出回调onCaptureVideoFrame。
DingRtcPositionPreRender
final int
渲染视频数据,对应输出回调onRemoteVideoFrame。
DingRtcPositionPreEncoder
final int
编码前视频数据,对应输出回调OnPreEncodeVideoFrame。
-
DingRtcConnectionStatus:网络连接状态
枚举名
描述
DingRtcConnectionStatusInit
初始化完成。
DingRtcConnectionStatusDisconnected
网络连接断开。
DingRtcConnectionStatusConnecting
建立网络连接中。
DingRtcConnectionStatusConnected
网络已连接。
DingRtcConnectionStatusReconnecting
重新建立网络连接中。
DingRtcConnectionStatusFailed
网络连接失败。
-
DingRtcConnectionStatusChangeReason:引起网络状态变更原因。
枚举名
描述
DingRtcConnectionChangedDummyReason
未知原因。
DingRtcConnectionChangedSignalingHeartbeatTimeout
心跳超时。
DingRtcConnectionChangedSignalingHeartbeatAlive
心跳恢复。
DingRtcConnectionChangedSignalingJoinChannelFailure
加入频道失败。
DingRtcConnectionChangedSignalingJoinChannelSuccess
加入频道成功。
DingRtcConnectionChangedSignalingLeaveRoom
离开频道。
DingRtcConnectionChangedSignalingConnecting
信令建立连接。
DingRtcConnectionChangedMediaLinkChange
媒体链路变化
DingRtcConnectionChangedNetworkInterrupted
网络连接中断
DingRtcConnectionChangedNetworkRecovery
网络连接恢复
-
DingRtcVideoTrack:视频流类型。
枚举名
描述
DingRtcVideoTrackNo
无视频流。
DingRtcVideoTrackCamera
相机流。
DingRtcVideoTrackScreen
屏幕共享流。
DingRtcVideoTrackBoth
相机流和屏幕共享流。
-
DingRtcPublishState:推流状态。
枚举名
描述
DingRtcStatsPublishIdle
0:SDK初始推流状态。
DingRtcStatsNoPublish
1:未推流状态,可能是因为:已设置停止推送媒体流;推送媒体流失败。
DingRtcStatsPublishing
2:推流链接建立过程中。
DingRtcStatsPublished
3:推流成功。
-
DingRtcUserOfflineReason:用户退出频道的原因。
枚举名
描述
DingRtcUserOfflineQuit
用户主动离开。
DingRtcUserOfflineDropped
因过长时间收不到对方数据包,超时掉线。
DingRtcUserOfflineBecomeAudience
用户身份从主播切换为观众时触发。
-
DingRtcSubscribeState:订阅状态。
枚举名
描述
DingRtcStatsSubscribeIdle
初始状态。
DingRtcStatsNoSubscribe
未订阅。
DingRtcStatsSubscribing
订阅中。
DingRtcStatsSubscribed
已订阅。
-
DingRtcVideoStreamType:相机流类型。
枚举名
描述
DingRtcVideoStreamTypeNone
无,在OnSubscribeStreamTypeChanged回调表示当前未订阅。
DingRtcVideoStreamTypeFHD
超高清流(设备性能、网络状态、推流分辨率符合要求情况下满足),对应1080P收费档。
DingRtcVideoStreamTypeHD
高清流(设备性能、网络状态、推流分辨率符合要求情况下满足),对应720P收费档)。
DingRtcVideoStreamTypeSD
标清(设备性能、网络状态、推流分辨率符合要求情况下满足),对应480P收费档。
DingRtcVideoStreamTypeLD
流畅(设备性能、网络状态、推流分辨率符合要求情况下满足),对应480P收费档。
-
DingRtcAudioTrack:音频流类型。
枚举名
描述
DingRtcAudioTrackNo
无麦克风。
DingRtcAudioTrackMic
麦克风。
-
DingRtcNetworkQuality:网络质量类型。
枚举名
描述
DingRtcNetworkQualityGood
网络质量好。
DingRtcNetworkQualityPoor
网络质量差。
DingRtcNetworkQualityDisconnect
网络中断。
DingRtcNetworkQualityUnKnow
未知。
-
DingRtcRenderMode:渲染模式。
枚举名
描述
DingRtcRenderModeAuto
自动模式。
DingRtcRenderModeStretch
拉伸平铺模式,如果外部输入的视频宽高比和推流设置的宽高比不一致时,将输入视频拉伸到推流设置的比例,画面会变形。
DingRtcRenderModeFill
填充黑边模式,如果外部输入的视频宽高比和推流设置的宽高比不一致时,将输入视频上下或者左右填充黑边。
DingRtcRenderModeCrop
裁剪模式,如果外部输入的视频宽高比和推流设置的宽高比不一致时,将输入视频宽或者高进行裁剪,画面内容会丢失。
DingRtcRenderModeNoChange
沿用之前的显示模式。
-
DingRtcRenderMirrorMode:镜像模式。
枚举名
描述
DingRtcRenderMirrorModeOnlyFront
只有前置摄像头预览镜像,其他不镜像。
DingRtcRenderMirrorModeAllEnabled
全部镜像。
DingRtcRenderMirrorModeAllDisable
全部不镜像。
-
DingRtcRotationMode:旋转角度。
枚举名
描述
DingRtcRotationMode_0
旋转0度。
DingRtcRotationMode_90
旋转90度。
DingRtcRotationMode_180
旋转180度。
DingRtcRotationMode_270
旋转270度。
-
DingRtcMirrorMode:镜像模式。
枚举名
描述
DingRtcMirrorMode_Disable
关闭镜像。
DingRtcMirrorMode_Enable
打开镜像。
-
DingRtcLogLevel:Log级别。
枚举名
描述
DingRtcLogLevelInfo
只输出>=DingRtcLogLevelInfo级别的日志。
DingRtcLogLevelWarn
只输出>=DingRtcLogLevelWarn级别的日志。
DingRtcLogLevelError
只输出>=DingRtcLogLevelError级别的日志。
DingRtcLogLevelNone
不输出日志。
-
DingRtcAudioNumChannel:音频声道数。
枚举名
描述
DingRtcMonoAudio
单声道。
DingRtcStereoAudio
双声道。
-
DingRtcAudioSampleRate:音频采样率类型。
枚举名
描述
DingRtcAudioSampleRate_8000
8000采样率。
DingRtcAudioSampleRate_16000
16000采样率。
DingRtcAudioSampleRate_32000
32000采样率。
DingRtcAudioSampleRate_44100
44100采样率。
DingRtcAudioSampleRate_48000
48000采样率。
-
DingRtcAudioProfile:音频编码模式。
枚举名
描述
DingRtcEngineBasicQualityMode
(默认)标准音质模式,默认16000Hz采样率,单声道,最大编码码率24kbps。
DingRtcEngineHighQualityMode
高音质模式,默认48000Hz采样率,单声道,最大编码码率64kbps。
DingRtcEngineSuperHighQualityMode
超高音质模式,默认48000Hz采样率,单声道,最大编码码率96kbps。
-
DingRtcAudioScenario:音频场景模式。
枚举名
描述
DingRtcSceneDefaultMode
默认场景,一般的音视频通信场景推荐使用。
DingRtcSceneMusicMode
音乐场景,高音质场景,适用于音乐为主的场景。
-
DingRtcMuteLocalAudioMode:本地静音模式。
枚举名
描述
DingRtcMuteAudioModeDefault
默认模式(静音全部,包括麦克风及外部输入音频)。
DingRtcMuteAllAudioMode
静音全部(包括麦克风及外部输入音频)。
DingRtcMuteOnlyMicAudioMode
只静音麦克风。
DingRtcMuteLocalAudioMax
占位符。
-
DingRtcAudioFrameObserverOperationMode:音频数据回调模式。
枚举名
描述
DingRtcAudioDataObserverOperationModeReadOnly
只读模式。
DingRtcAudioDataObserverOperationModeWriteOnly
只写模式。
DingRtcAudioDataObserverOperationModeReadWrite
读写模式。
-
DingRtcAudioFrameObserverUserDefinedInfoBitMask:音频数据回调自定义参数。
枚举名
描述
DingRtcAudioFrameObserverUserDefinedInfoBitMaskNone
DingRtcAudioFrameObserverUserDefinedInfoBitMaskMixExCapture
DingRtcAudioFrameObserverUserDefinedInfoBitMaskMixExRender
-
DingRtcAudioFramePermission:音频数据权限。
枚举名
描述
DingRtcAudioFramePermissionReadOnly
只读权限。
DingRtcAudioFramePermissionReadAndWrite
读写权限。
-
DingRtcAudioFrameObserverConfig:音频数据回调设置。
参数名
类型
描述
sampleRate
回调音频采样率。
channels
回调音频声道数。
permission
回调音频读写权限。
userDefinedInfo
int
用户自定义参数。
-
DingRtcBeautyFaceOptions:美颜参数。
参数名
类型
描述
resourcePath
String
资源文件路径。
enableSkinBuffing
boolean
开启美肤。
skinBuffingFactor
float
磨皮系数。
skinSharpenFactor
float
锐化系数。
enableSkinWhitening
boolean
美白系数。
skinWhitingFactor
float
美白系数。
-
DingRtcEngineVirtualBackgroundMode:虚拟背景模式
枚举名
描述
DingRtcEngineVirtualBackgroundBlur
背景虚化。
DingRtcEngineVirtualBackgroundReplace
背景替换。
-
DingRtcVirtualBackgroundOptions:虚拟背景参数。
参数名
类型
描述
mode
虚拟背景模式。
bgFilePath
String
虚拟背景图片路径
-
DingRtcOnByeType:OnBye类型枚举。
枚举名
描述
DingRtcByeTypeKickOff
当前user被踢出channel。
DingRtcByeTypeDelChannel
channel已结束,需要离开会议。
DingRtcByeTypeRestoreSession
被动离开需要恢复session。
-
DingRtcAudioRouteType:音频路由。
枚举名
描述
DingRtcAudioRouteType_Default
默认的语音路由。
DingRtcAudioRouteType_Headset
耳机。
DingRtcAudioRouteType_Earpiece
听筒。
DingRtcAudioRouteType_HeadsetNoMic
不带麦克风的耳机。
DingRtcAudioRouteType_Speakerphone
手机扬声器。
DingRtcAudioRouteType_LoudSpeaker
外接扬声器。
DingRtcAudioRouteType_BlueTooth
蓝牙耳机。
-
DingRtcAudioDeviceInfo:音频设备信息。
参数名
类型
描述
name
String
音频设备名称。
type
音频设备路由类型。
isUsed
boolean
音频设备是否是当前路由设备。
-
DingRtcVideoDeviceInfo:视频频设备信息
参数名
类型
描述
name
String
视频设备名称。
deviceId
String
视频设备ID。
direction
视频设备方向。
-
DingRtcVideoCanvas:显示视图配置。
参数名
类型
描述
textureId
int
支持第三方OpenGLES纹理显示,纹理ID。
textureWidth
int
支持第三方OpenGLES纹理显示,纹理宽。
textureHeight
int
支持第三方OpenGLES纹理显示,纹理高。
sharedContext
long
支持第三方OpenGLES纹理显示,纹理共享上下文。
enableBeauty
boolean
支持第三方OpenGLES纹理显示,纹理共享上下文。
view
java.lang.Object
显示视图(SurfaceView/TextureView/Surface)。
renderMode
渲染模式,默认值为DingRtcRenderModeAuto。
mirrorMode
镜像模式,默认值为DingRtcRenderMirrorModeOnlyFront。
rotationMode
旋转角度,默认值为DingRtcRotationMode::DingRtcRotationMode_0。
backgroundColor
int
背景颜色,格式为RGB的Hex。
-
DingEngineCameraCapturerConfiguration:摄像头采集偏好。
参数名
类型
描述
preference
采集偏好。
cameraDirection
相机方向(只支持Android和iOS)。
-
DingRtcCaptureOutputPreference:采集偏好。
枚举名
描述
DingRtc_CAPTURER_OUTPUT_PREFERENCE_AUTO
SDK自动调整采集参数。
DingRtc_CAPTURER_OUTPUT_PREFERENCE_PERFORMANCE
SDK优先保证设备性能,根据设置编码参数选择最接近的摄像头输出参数。
DingRtc_CAPTURER_OUTPUT_PREFERENCE_PREVIEW
SDK优先保证视频预览质量,选择较高的摄像头输出参数。
-
DingRtcVideoEncoderFrameRate:视频编码帧率。
枚举名
描述
DingRtcVideoEncoderFrameRate_FPS_5
视频编码帧率-5帧。
DingRtcVideoEncoderFrameRate_FPS_10
视频编码帧率-10帧。
DingRtcVideoEncoderFrameRate_FPS_15
视频编码帧率-15帧。
DingRtcVideoEncoderFrameRate_FPS_20
视频编码帧率-20帧。
DingRtcVideoEncoderFrameRate_FPS_30
视频编码帧率-30帧。
-
DingRtcCameraDirection:摄像头方向。
枚举名
描述
CAMERA_INVALID
无效。
CAMERA_REAR
后置。
CAMERA_FRONT
前置。
-
DingRtcVideoEncoderOrientationMode:编码视频旋转模式。
枚举名
描述
DingRtcVideoEncoderOrientationModeAdaptive
自适应,和采集视频保持一致。
DingRtcVideoEncoderOrientationModeFixedLandscape
固定横屏。
DingRtcVideoEncoderOrientationModeFixedPortrait
固定竖屏。
-
DingRtcVideoDimensions:视频分辨率。
参数名
类型
描述
width
int
宽度。
height
int
宽度。
-
DingRtcVideoEncoderConfiguration:相机流视频编码属性设置。
参数名
类型
描述
dimensions
视频分辨率,默认值640x480,最大值1920x1080。
frameRate
int
视频帧率,默认值15,最大值30。
orientationMode
视频输出方向,DingRtcVideoEncoderOrientationModeAdaptive,详见com::ding::rtc::DingRtcEngine::DingRtcVideoEncoderOrientationMode。
rotation
视频旋转角度,默认值:DingRtcRotationMode_0。
mirrorMode
视频镜像,默认值:DingRtcMirrorMode_Disable。
-
DingRtcAudioGroupMember:音频组成员。
参数名
类型
描述
uid
String
用户ID。
usrData
String
-
DingRtcAuthInfo:用户信息类
参数名
类型
描述
channelId
String
频道ID。
userId
String
用户ID。
appId
String
应用ID。
token
String
令牌。
gslbServer
String
GSLB地址。
-
DingRtcRemoteUserInfo:远端用户的状态。
参数名
类型
描述
userID
String
远端用户的ID。
isOnline
boolean
远端用户是否在线。
sessionID
String
远端用户的会话ID。
callID
String
当前会话的callID。
displayName
String
远端用户的名称。
hasAudio
boolean
远端用户是否推送了音频流。
hasCamera
boolean
远端用户是否推送了相机流。
hasScreenSharing
boolean
远端用户是否推送了屏幕流。
requestAudio
boolean
本端是否订阅了此远端用户的音频流。
requestCamera
boolean
本端是否订阅了此远端用户的相机流。此状态,系在成功订阅该用户摄像头大流前的状态。
requestScreenSharing
boolean
本端是否订阅了此远端用户的屏幕流。此状态,系在成功订阅该用户屏幕共享前的状态。
preferCameraType
String
远端用户是否开启的流类型。
subScribedAudio
boolean
本端是否拉到了此远端用户的音频流。
subScribedCameraType
String
本端是否拉到了此远端用户的相机流。
subScribedScreenSharing
boolean
本端是否拉到了此远端用户的屏幕流。
hasCameraView
boolean
本端是否设置了此远端用户相机流的view。
hasScreenView
boolean
本端是否设置了此远端用户屏幕流的view。
cameraCanvas
nativefieldsend
screenCanvas
nativefieldsend
-
DingRtcWBRoleType:白板角色类型。
枚举名
描述
ADMIN
白板管理员。
ATTENDEE
普通白板参与者。
VIEWER
只看白板参与者。
-
DingRtcWhiteboardDocInfo:白板文档信息
参数名
类型
描述
type
文档类型。
docId
String
文档ID。
name
String
文档名称。
creater
String
文档创建人用户ID。
-
DingRtcWBToolType:白板工具参数。
枚举名
描述
NONE
空
SELECT
选中
CLICK
点击
HAND
拖拽
PATH
画笔
LINE
直线
RECT
矩形
ELLIPSE
椭圆
IMAGE
图片
TEXT
文本
DELETER
删除工具
BRUSH
刷子
ARROW
箭头
POLYLINE
折线。仅支持Windows及macOS平台。
POLYGON
多边形。仅支持Windows及macOS平台。
ARC
弧线。仅支持Windows及macOS平台。
CURVE
曲线。仅支持Windows及macOS平台。
LASER
激光笔。
STAMP
图章
VANISHPEN
消失笔
HIGHLIGHTER
荧光笔
ERASER
橡皮擦
-
DingRtcWBFillType:白板填充类型。
枚举名
描述
NONE
不填充
COLOR
填充颜色
BORDER_FILL
边框并填充
-
DingRtcWBFontStyle:白板字体样式。
枚举名
描述
NORMAL
常规
BOLD
粗体
ITALIC
斜体
BOLD_ITALIC
粗斜体
-
DingRtcWBScalingMode:白板渲染缩放模式。
枚举名
描述
FIT
保持宽高比
CropFill
保持宽高比全填充
CenterCrop
原始大小居中显示
StretchFill
拉伸铺满全填充
-
DingRtcWBDocType:白板文档类型。
枚举名
描述
NORMAL
普通。
PDF
PDF。
EXTERNAL
外部。
-
DingRtcWBDrawEvent:绘制事件类型
枚举名
描述
DRAW_UNKNOWN
未知事件。
DRAW_START
绘制开始。
DRAW_END
绘制结束。
DRAW_CANCEL
绘制取消。
SELECT_MOVE_START
选择移动开始。
SELECT_MOVE_END
选择移动结束。
DELETE_START
删除开始。
DELETE_END
删除结束。
TEXT_DRAW
文本绘制。
TEXT_UPDATE
文本更新。
-
DingRtcWBContentUpdateType:内容更新类型。
枚举名
描述
UNKNOWN
未知。
REMOTE_DRAW
远端绘制。
-
DingRtcWBOption:白板选项。
枚举名
描述
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
触摸配置。默认关闭
-
DingRtcWBSnapshotMode:快照模式
枚举名
描述
VIEW
视图显示区域。
ALL
全部区域。
-
DingRtcWBClearMode:白板清除模式。
枚举名
描述
ALL
全部内容。
OTHERS
其它人内容。
SELF
自己内容。
SPECIFIC
指定内容。
-
DingRtcWBImageState:白板图像状态。
枚举名
描述
LOAD_START
开始加载图片。
LOAD_COMPLETE
图片加载成功。
LOAD_FAIL
图片加载失败。
-
DingRtcWBFileTransState:文件转码状态。
枚举名
描述
TRANSCODE_START
开启转码。
TRANSCODE_COMPLETE
转码成功。
TRANSCODE_FAIL
转码失败。
TRANSCODE_START_FAIL
转码开启失败
TRANSCODE_QUERY_FAIL
转码查询失败
-
DingRtcWBColor:白板颜色。
参数名
类型
描述
r
float
g
float
b
float
a
float
-
DingRtcWBDocExtContents:白板外部文档信息
参数名
类型
描述
name
String
外部文档名称
totalPages
int
总页数
width
int
文档宽度
height
int
文档高度
-
DingRtcWBDocContents:白板文档内容信息
参数名
类型
描述
type
文档类型
name
String
文档名称
urls
List< String >
url地址数组
transDocId
String
文档转码ID
-
DingRtcWBClearParam:白板清除配置。
参数名
类型
描述
curPage
boolean
是否仅清除当前页。
mode
白板清除模式
-
DingRtcWBMode:白板模式。
枚举名
描述
BASIC
基础模式。
ADVANCE
高级模式。
-
ErrorCode:白板错误码。
枚举名
描述
OK
Executionsucceed.
FAILED
Executionfailed.
FATAL
Fatalerror.
INVALID_ARGS
Invalidargument.
INVALID_STATE
Invalidstate.
INVALID_INDEX
Invalidindex.
ALREADY_EXIST
Theobjectalreadyexists.
NOT_EXIST
Theobjectdoesnotexist.
NOT_FOUND
Theobjectisnotfound.
NOT_SUPPORTED
Themethodisnotsupported.
NOT_IMPLEMENTED
Themethodisnotimplemented.
NOT_INITIALIZED
Theobjectisnotinitialized.
LIMIT_REACHED
Theresourcelimitisreached.
NO_PRIVILEGE
Noprivilegetodo.
IN_PROGRESS
Operationinprogress.
WRONG_THREAD
Theoperationthreadiswrong.
TIMEOUT
Theoperationthreadistimeout.
ABORTED
Theoperationthreadisaborted.
TOO_MANY_OPS
Toomanyoperations.
OUT_OF_MEMORY
Outofmemory.
OUT_OF_DISK_SPACE
Outofdiskspace.
AUTH_FAILED
Authenticationfailed.
USER_REJECTED
Theuserisrejected.
USER_EXPELED
Theuserisexpelled.
USER_DUPLICATE
TheuserIdisduplicate.
CHANNEL_CLOSED
Thechannelisclosed.
CHANNEL_FULL
Thechannelcapacityisfull.
CHANNEL_LOCKED
Thechannelislocked.
CHANNEL_MODE
Thechannelmodeismismatch.
CHANNEL_CRYPTOTYPE
Thechannelcryptotypeismismatch.
GROUP_DISMISSED
Thegroupisdismissed.
NETWORK_ERROR
Anetworkerroroccurred.
DEVICE_OCCUPIED
Deviceoccupied.
-
DingRtcWBConfig:白板配置参数。
参数名
类型
描述
width
int
白板宽度。
height
int
白板高度。
mode
白板模式。
-
DingRtcWBStamp:白板贴图类。
参数名
类型
描述
stampId
String
贴图ID。
stampPath
String
贴图路径。
resizable
boolean
贴图是否可伸展。
-
DingRtcWBUserMember:白板成员。
参数名
类型
描述
uid
String
用户ID
-
DingRtcWBGestureConfig:白板手势缩放配置。
参数名
类型
描述
minMoveSpan
int
最小移动范围
minScaleSpan
int
最小缩放范围
minScrollSpan
int
最小滚动范围
palmEnabled
boolean
是否开启掌纹识别
palmDetectLevel_0
float
手势识别级别0参数
palmDetectLevel_1
float
手势识别级别1参数
palmSizeLevel_0
float
手掌大小级别0参数
palmSizeLevel_1
float
手掌大小级别1参数