文档

数据类型

更新时间:

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

目录

数据类型

描述

支持的最低版本

DingRtcAuthInfo

用户信息类。

3.0

DingRtcAudioSource

音频订阅类型。

3.0

DingRtcAudioFrame

音频裸数据。

3.0

DingRtcVideoSample

视频裸数据。

3.0

DingRtcVideoSourceType

视频源类型。

3.0

DingRtcRawDataFrame

视频裸数据帧信息。

3.0

DingRtcStats

实时数据。

3.0

DingRtcLocalVideoStats

本地视频统计信息。

3.0

DingRtcRemoteVideoStats

远端视频统计信息。

3.0

DingRtcLocalAudioStats

本地音频统计信息。

3.0

DingRtcRemoteAudioStats

远端音频统计信息。

3.0

DingRtcAudioVolumeInfo

用户音量信息。

3.0

DingRtcVideoFormat

视频格式。

3.0

DingRtcConnectionStatus

网络连接状态。

3.0

DingRtcConnectionStatusChangeReason

引起网络状态变更原因。

3.0

DingRtcVideoTrack

视频流类型。

3.0

DingRtcPublishState

推流状态。

3.0

DingRtcSubscribeState

订阅状态。

3.0

DingRtcUserOfflineReason

用户退出频道的原因。

3.0

DingRtcVideoStreamType

相机流类型。

3.0

DingRtcAudioTrack

音频流类型。

3.0

DingRtcNetworkQuality

网络质量类型。

3.0

DingRtcRenderMode

渲染模式。

3.0

DingRtcRenderMirrorMode

镜像模式。

3.0

DingRtcRotationMode

旋转角度。

3.0

DingRtcLogLevel

Log级别。

3.0

DingRtcAudioNumChannel

音频声道数。

3.0

DingRtcAudioSampleRate

音频采样率类型。

3.0

DingRtcAudioProfile

音频编码模式。

3.0

DingRtcAudioScenario

音频场景模式。

3.0

DingRtcMuteLocalAudioMode

本地静音模式。

3.0

DingRtcScreenShareMode

屏幕共享模式。

3.0

DingRtcAudioFrameObserverOperationMode

音频数据回调模式。

3.0

DingRtcAudioFrameObserverUserDefinedInfoBitMask

音频数据回调自定义参数。

3.0

DingRtcAudioFrameObserverConfig

音频数据回调设置。

3.0

DingRtcOnByeType

OnBye类型枚举。

3.0

DingRtcAudioRouteType

音频路由。

3.0

DingRtcVideoCanvas

显示视图配置。

3.0

DingEngineCameraCapturerConfiguration

摄像头采集偏好。

3.0

DingRtcCameraDirection

摄像头方向。

3.0

DingRtcCaptureOutputPreference

采集偏好。

3.0

DingRtcVideoEncoderFrameRate

视频编码帧率。

3.0

DingRtcVideoEncoderOrientationMode

编码视频旋转模式。

3.0

DingRtcVideoDimensions

视频分辨率。

3.0

DingRtcVideoEncoderConfiguration

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

3.0

DingRtcScreenShareEncoderConfiguration

屏幕流编码属性设置。

3.0

详情

  • DingRtcAuthInfo:用户信息类。

    参数名

    类型

    描述

    channelId

    String

    频道ID。

    userId

    String

    用户ID。

    appId

    String

    应用ID。

    token

    String

    令牌。

    gslbServer

    String

    GSLB地址。

  • DingRtcAudioSource:音频订阅类型。

    枚举名

    描述

    DingRtcAudioSourceCaptured

    采集的音频数据。

    DingRtcAudioSourceProcessCaptured

    3A后的音频数据。

    DingRtcAudioSourcePub

    推流的音频数据。

    DingRtcAudioSourcePlayback

    播放的音频数据。

  • 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

    DingRtcVideoFormat

    视频数据类型。

    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

    DingRtcVideoFormat

    视频数据类型。

    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

    DingRtcVideoTrack

    流类型。

    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

    DingRtcVideoTrack

    视频流类型。

    width

    int

    视频帧的宽。

    height

    int

    视频帧的高。

    recvBitrate

    int

    接收码率。

    decoderOutputFrameRate

    int

    编码器输出帧率。

    rendererOutputFrameRate

    int

    渲染器输出帧率。

    packetLossRate

    int

    丢包率。

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

    参数名

    类型

    描述

    track

    DingRtcAudioTrack

    音频流类型。

    sentBitrate

    int

    发送码率。

    sentSamplerate

    int

    发送的采样率。

    numChannel

    int

    声道数。

    inputLevel

    int

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

    参数名

    类型

    描述

    userId

    String

    用户ID。

    packetLossRate

    int

    音频丢包率。

    recvBitrate

    int

    接收码率。

    totalFrozenTime

    int

    卡顿时长(ms)。

    speechExpandRate

    int

    音频拉伸率。

  • DingRtcAudioVolumeInfo:用户音量信息。

    参数名

    类型

    描述

    userId

    String

    用户ID。

    volume

    int

    当前音量。

    speechState

    int

    当前用户说话状态。

  • DingRtcVideoFormat:视频格式。

    枚举名

    描述

    DingRtcVideoFormatBGRA

    BGRA。

    DingRtcVideoFormatI420

    I420。

    DingRtcVideoFormatNV21

    NV21。

    DingRtcVideoFormatNV12

    NV12。

    DingRtcVideoFormatRGBA

    RGBA。

    DingRtcVideoFormatI422

    I422。

    DingRtcVideoFormatARGB

    ARGB。

    DingRtcVideoFormatABGR

    ABGR。

    DingRtcVideoFormatRGB24

    RGB24。

    DingRtcVideoFormatBGR24

    BGR24。

    DingRtcVideoFormatRGB565

    RGB565。

    DingRtcVideoFormatTextureOES

    TextureOES。

    DingRtcVideoFormatTexture2D

    Texture2D。

  • DingRtcConnectionStatus:网络连接状态。

    枚举名

    描述

    DingRtcConnectionStatusInit

    初始化完成。

    DingRtcConnectionStatusDisconnected

    网络连接断开。

    DingRtcConnectionStatusConnecting

    建立网络连接中。

    DingRtcConnectionStatusConnected

    网络已连接。

    DingRtcConnectionStatusReconnecting

    重新建立网络连接中。

    DingRtcConnectionStatusFailed

    网络连接失败。

  • DingRtcConnectionStatusChangeReason:引起网络状态变更原因。

    枚举名

    描述

    DingRtcConnectionChangedDummyReason

    未知原因。

    DingRtcConnectionChangedSignalingHeartbeatTimeout

    心跳超时。

    DingRtcConnectionChangedSignalingHeartbeatAlive

    心跳恢复。

    DingRtcConnectionChangedSignalingJoinChannelFailure

    加入频道失败。

    DingRtcConnectionChangedSignalingJoinChannelSuccess

    加入频道成功。

    DingRtcConnectionChangedSignalingLeaveRoom

    离开频道。

    DingRtcConnectionChangedSignalingConnecting

    信令建立连接。

  • DingRtcVideoTrack:视频流类型。

    枚举名

    描述

    DingRtcVideoTrackNo

    无视频流。

    DingRtcVideoTrackCamera

    相机流。

    DingRtcVideoTrackScreen

    屏幕共享流。

    DingRtcVideoTrackBoth

    相机流和屏幕共享流。

  • DingRtcPublishState:推流状态。

    枚举名

    描述

    DingRtcStatsPublishIdle

    0:SDK初始推流状态。

    DingRtcStatsNoPublish

    1:未推流状态,可能是因为:已设置停止推送媒体流。推送媒体流失败。

    DingRtcStatsPublishing

    2:推流链接建立过程中。

    DingRtcStatsPublished

    3:推流成功。

  • DingRtcSubscribeState:订阅状态。

    枚举名

    描述

    DingRtcStatsSubscribeIdle

    初始状态。

    DingRtcStatsNoSubscribe

    未订阅。

    DingRtcStatsSubscribing

    订阅中。

    DingRtcStatsSubscribed

    已订阅。

  • DingRtcUserOfflineReason:用户退出频道的原因。

    枚举名

    描述

    DingRtcUserOfflineQuit

    用户主动离开。

    DingRtcUserOfflineDropped

    因过长时间收不到对方数据包,超时掉线。

    DingRtcUserOfflineBecomeAudience

    用户身份从主播切换为观众时触发。

  • 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度。

  • DingRtcLogLevel:Log级别。

    枚举名

    描述

    DingRtcLogLevelInfo

    只输出>=DingRtcLogLevelInfo级别的日志。

    DingRtcLogLevelWarn

    只输出>=DingRtcLogLevelWarn级别的日志。

    DingRtcLogLevelError

    只输出>=DingRtcLogLevelError级别的日志。

    DingRtcLogLevelNone

    不输出日志。

  • DingRtcAudioNumChannel:音频声道数。

    枚举名

    描述

    DingRtcMonoAudio

    单声道。

    DingRtcStereoAudio

    双声道。

  • DingRtcAudioSampleRate:音频采样率类型。

    枚举名

    描述

    DingRtcAudioSampleRate_8000

    8000采样率。

    DingRtcAudioSampleRate_11025

    11025采样率。

    DingRtcAudioSampleRate_16000

    16000采样率。

    DingRtcAudioSampleRate_22050

    22050采样率。

    DingRtcAudioSampleRate_32000

    32000采样率。

    DingRtcAudioSampleRate_44100

    44100采样率。

    DingRtcAudioSampleRate_48000

    48000采样率。

    DingRtcAudioSampleRate_Max

    边界值(不可使用)。

  • DingRtcAudioProfile:音频编码模式。

    枚举名

    描述

    DingRtcEngineBasicQualityMode

    (默认)标准音质模式,默认16000Hz采样率,单声道,最大编码码率24kbps。

    DingRtcEngineHighQualityMode

    高音质模式,默认48000Hz采样率,单声道,最大编码码率64kbps。

    DingRtcEngineSuperHighQualityMode

    超高音质模式,默认48000Hz采样率,单声道,最大编码码率96kbps。

  • DingRtcAudioScenario:音频场景模式。

    枚举名

    描述

    DingRtcSceneDefaultMode

    默认场景,一般的音视频通信场景推荐使用。

  • DingRtcMuteLocalAudioMode:本地静音模式。

    枚举名

    描述

    DingRtcMuteAudioModeDefault

    默认模式(静音全部,包括麦克风及外部输入音频)。

    DingRtcMuteAllAudioMode

    静音全部(包括麦克风及外部输入音频)。

    DingRtcMuteOnlyMicAudioMode

    只静音麦克风。

    DingRtcMuteLocalAudioMax

    占位符。

  • DingRtcScreenShareMode:屏幕共享模式。

    枚举名

    描述

    DingRtcScreenShareNoneMode

    不共享音视频。

    DingRtcScreenShareOnlyVideoMode

    只共享视频。

    DingRtcScreenShareOnlyAudioMode

    只共享音频。

    DingRtcScreenShareAllMode

    共享音视频。

  • DingRtcAudioFrameObserverOperationMode:音频数据回调模式。

    枚举名

    描述

    DingRtcAudioDataObserverOperationModeReadOnly

    只读模式。

    DingRtcAudioDataObserverOperationModeWriteOnly

    只写模式。

    DingRtcAudioDataObserverOperationModeReadWrite

    读写模式。

  • DingRtcAudioFrameObserverUserDefinedInfoBitMask:音频数据回调自定义参数。

    枚举名

    描述

    DingRtcAudioFrameObserverUserDefinedInfoBitMaskNone

    无。

    DingRtcAudioFrameObserverUserDefinedInfoBitMaskMixExCapture

    onMixedAllAudioFrame回调混外部推流的音频。

    DingRtcAudioFrameObserverUserDefinedInfoBitMaskMixExRender

    onMixedAllAudioFrame回调混外部渲染的音频。

  • DingRtcAudioFrameObserverConfig:音频数据回调设置。

    参数名

    类型

    描述

    sampleRate

    DingRtcAudioSampleRate

    回调音频采样率。

    channels

    DingRtcAudioNumChannel

    回调音频声道数。

    mode

    DingRtcAudioFrameObserverOperationMode

    回调模式。

    userDefinedInfo

    int

    用户自定义参数。

  • DingRtcOnByeType:OnBye类型枚举。

    枚举名

    描述

    DingRtcByeTypeKickOff

    当前user被踢出channel。

    DingRtcByeTypeDelChannel

    channel已结束,需要离开会议。

    DingRtcByeTypeRestoreSession

    被动离开需要恢复session。

  • DingRtcAudioRouteType:音频路由。

    枚举名

    描述

    DingRtcAudioRouteType_Default

    默认的语音路由。

    DingRtcAudioRouteType_Headset

    耳机。

    DingRtcAudioRouteType_Earpiece

    听筒。

    DingRtcAudioRouteType_HeadsetNoMic

    不带麦克风的耳机。

    DingRtcAudioRouteType_Speakerphone

    手机扬声器。

    DingRtcAudioRouteType_LoudSpeaker

    外接扬声器。

    DingRtcAudioRouteType_BlueTooth

    蓝牙耳机。

  • 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

    DingRtcRenderMode

    渲染模式,默认值为DingRtcRenderModeAuto。

    mirrorMode

    DingRtcRenderMirrorMode

    镜像模式,默认值为DingRtcRenderMirrorModeOnlyFront。

    rotationMode

    DingRtcRotationMode

    旋转角度,默认值为DingRtcRotationMode::DingRtcRotationMode_0。

    backgroundColor

    int

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

  • DingEngineCameraCapturerConfiguration:摄像头采集偏好。

    参数名

    类型

    描述

    preference

    DingRtcCaptureOutputPreference

    采集偏好。

    cameraDirection

    DingRtcCameraDirection

    相机方向(只支持Android和iOS)。

  • DingRtcCameraDirection:摄像头方向。

    枚举名

    描述

    CAMERA_INVALID

    无效。

    CAMERA_REAR

    后置。

    CAMERA_FRONT

    前置。

  • 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帧。

  • DingRtcVideoEncoderOrientationMode:编码视频旋转模式。

    枚举名

    描述

    DingRtcVideoEncoderOrientationModeAdaptive

    自适应,和采集视频保持一致。

    DingRtcVideoEncoderOrientationModeFixedLandscape

    固定横屏。

    DingRtcVideoEncoderOrientationModeFixedPortrait

    固定竖屏。

  • DingRtcVideoDimensions:视频分辨率。

    参数名

    类型

    描述

    width

    int

    宽度。

    height

    int

    宽度。

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

    参数名

    类型

    描述

    dimensions

    DingRtcVideoDimensions

    视频分辨率,默认值640x480,最大值1920x1080。

    frameRate

    int

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

    orientationMode

    DingRtcVideoEncoderOrientationMode

    视频输出方向,DingRtcVideoEncoderOrientationModeAdaptive,详见com::ding::rtc::DingRtcEngine::DingRtcVideoEncoderOrientationMode。

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

    参数名

    类型

    描述

    dimensions

    DingRtcVideoDimensions

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

    frameRate

    int

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