本文为您列出了Android SDK的所有数据类型,您可以查看每个数据类型下的枚举名,结合AliEngine接口和回调进行开发。

目录

数据类型 描述 以上版本支持
AliRtcVideoTrack 视频Track类型 1.1
AliRtcAudioTrack 音频Track类型 1.1
AliRTCCameraType 摄像头类型 1.1
AliRtcNetworkQuality 网络质量 1.1
AliRtcRenderMode 渲染模式 1.1
AliRtcRenderMirrorMode 镜像模式 1.11
AliRtcLogLevel 日志级别 1.1
AliVideoCanvas 渲染画布 1.1
AliRtcAuthInfo 鉴权信息 1.1
AliRtcVideoProfile 视频质量参数 1.1
AliRtcRemoteUserInfo 远端用户信息 1.1
AliRTCImageFormat 图片格式枚举 1.14
AliStatusInfo 用户信息 1.14
AliStatusState 用户状态 1.14
AliDetectObserver 人脸识别预处理接口 1.14
AliRtcChannelProfile 频道类型 1.15
AliAudioType 音频类型枚举 1.17
AliRTCSDK_Client_Role 角色类型 1.16
AliRtcStats 当前频道通话实时数据 1.16
AliRtcAudioCodecQualityType 录音文件质量枚举 1.16
ErrorCodeEnum 错误类型 1.16
AliRtcAudioPlayingType 音乐伴奏播放状态 1.16.2
AliRtcRecordAudioConfig 录制音频设置 1.17
RTCLocalVideoStats 本地视频统计信息 1.17
RTCRemoteVideoStats 远端视频统计信息 1.17
AliRtcRecordType 录制类型 1.17
AliRtcRecordFormat 录制格式 1.17
AliRtcAudioSampleRate 音频采样率类型 1.17
AliRtcAudioQuality 录制音频质量 1.17
AliRTCSDK_AudioEffect_Reverb_Mode 混响音效模式 1.17
AliRTCSDK_AudioEffect_Reverb_Param_Type 混响音效类型 1.17
AliVideoSourceType 视频源类型 1.17
AliVideoSample 视频样本类 1.17
AliRtcBeautyConfig 美颜设置 1.17.1
AliRtcAudioVolume 用户音量信息 1.17.1
AliRtcAudioNumChannel 音频声道类型 1.17.13
AliRtcFeedbackType SDK反馈问题类型 1.17.13
AliRtcOrientationMode 横竖屏类型 1.17

详情

数据类型详情如下所示。

  • AliRtcVideoTrack:视频Track的类型。
    枚举名 描述
    AliRtcVideoTrackNo 无视频流
    AliRtcVideoTrackCamera 相机流
    AliRtcVideoTrackScreen 屏幕共享流
    AliRtcVideoTrackBoth 相机流和屏幕共享流
  • AliRtcAudioTrack:音频Track的类型。
    枚举名 描述
    AliRtcAudioTrackNo 无音频流
    AliRtcAudioTrackMic 麦克风流
  • AliRTCCameraType:摄像头类型。
    枚举名 描述
    AliRTCCameraInvalid 无效
    AliRTCCameraBack 后置摄像头
    AliRTCCameraFront 前置摄像头
  • AliRtcNetworkQuality:网络质量。
    枚举名 描述
    Network_Excellent 网络极好,流程度清晰度质量好
    Network_Good 网络好,流畅度清晰度和极好差不多
    Network_Poor 网络较差,音视频流畅度清晰度有瑕疵,不影响沟通
    Network_Bad 网络差,视频卡顿严重,音频能正常沟通
    Network_VeryBad 网络极差,基本无法沟通
    Network_Disconnected 网络中断
    Network_Unknow 未知原因
  • AliRtcRenderMode:渲染模式。
    枚举名 描述
    AliRtcRenderModeAuto 自动
    AliRtcRenderModeStretch 拉伸填充视图,不保持视频比例
    AliRtcRenderModeFill 在保持视频宽高比的同时缩放,填充黑边
    AliRtcRenderModeClip 在保持视频宽高比的同时缩放,并裁剪以适合视图
  • AliRtcRenderMirrorMode:镜像模式。
    枚举名 描述
    AliRtcRenderMirrorModeOnlyFront 只有前置摄像头预览镜像,其余不镜像
    AliRtcRenderMirrorModeAllEnabled 全部镜像
    AliRtcRenderMirrorModeAllDisable 全部不镜像
  • AliRtcLogLevel:日志级别。
    枚举名 描述
    AliRtcLogLevelDump 全量
    AliRtcLogLevelDebug 调试
    AliRtcLogLevelVerbose 详细
    AliRtcLogLevelInfo 普通
    AliRtcLogLevelWarn 警告
    AliRtcLogLevelError 错误
    AliRtcLogLevelFatal 严重
    AliRtcLogLevelNone
  • AliVideoCanvas:渲染画布。
    枚举名 描述
    SophonSurfaceView 渲染视图
    AliRtcRenderMode 渲染模式
    AliRtcRenderMirrorMode 镜像模式
  • AliRtcAuthInfo:鉴权信息。
    注意 在1.9及以上版本移除session id字段。
    字段名 类型 描述
    mConferenceId String 频道ID
    mUserId String 用户ID
    mAppid String 应用ID
    mNonce String 随机串
    mTimestamp long 时间戳
    mToken String 令牌
    mGslb String[] GSLB地址
    mAgent String[] 设置Agent服务器的地址
  • AliRtcVideoProfile:视频质量参数。
    说明 发布视频流规格,默认为AliRTCSDK_Video_Profile_Default,您可以在加入频道之前或之后设置,但是您必须在本地流发布之前通过setVideoProfile方法设置。
    枚举名 描述
    AliRTCSDK_Video_Profile_Default 默认,分辨率480*640,帧率15
    AliRTCSDK_Video_Profile_180_240P_15 分辨率180*240,帧率15
    AliRTCSDK_Video_Profile_180_320P_15 分辨率180*320,帧率15
    AliRTCSDK_Video_Profile_180_320P_30 分辨率180*320,帧率30
    AliRTCSDK_Video_Profile_240_320P_15 分辨率240*320,帧率15
    AliRTCSDK_Video_Profile_360_480P_15 分辨率360*480,帧率15
    AliRTCSDK_Video_Profile_360_480P_30 分辨率360*480,帧率30
    AliRTCSDK_Video_Profile_360_640P_15 分辨率360*640,帧率15
    AliRTCSDK_Video_Profile_360_640P_30 分辨率360*640,帧率30
    AliRTCSDK_Video_Profile_480_640P_15 分辨率480*640,帧率15
    AliRTCSDK_Video_Profile_480_640P_30 分辨率480*640,帧率30
    AliRTCSDK_Video_Profile_720_960P_15 分辨率720*960,帧率15
    AliRTCSDK_Video_Profile_720_960P_30 分辨率720*960,帧率30
    AliRTCSDK_Video_Profile_720_1280P_15 分辨率720*1280,帧率15
    AliRTCSDK_Video_Profile_720_1280P_30 分辨率720*1280,帧率30
    AliRTCSDK_Video_Profile_360_640P_15_800Kb 360*640分辨率,帧率15,800Kb码率
    AliRTCSDK_Video_Profile_480_840P_15_500Kb 480*840分辨率,帧率15,500Kb码率
    AliRTCSDK_Video_Profile_480_840P_15_800Kb 480*840分辨率,帧率15,800Kb码率
    AliRTCSDK_Video_Profile_540_960P_15_800Kb 540*960分辨率,帧率15,800Kb码率
    AliRTCSDK_Video_Profile_540_960P_15_1200Kb 540*960分辨率,帧率15,1200Kb码率
    AliRTCSDK_Video_Profile_Max 占位值
  • AliRtcRemoteUserInfo:远端用户信息。
    字段名 类型 描述
    userID String 远端用户ID
    sessionID String 远端用户会话ID
    callID String 远端用户callID
    displayName String 远端用户名称
    streamLabel String 远端用户流标签
    firstSubscribe boolean 是否第一次订阅
    muteAudioPlaying boolean 是否静音远端用户
    isOnline boolean 远端用户是否在线
    cameraCanvas AliVideoCanvas 相机流显示画布
    screenCanvas AliVideoCanvas 屏幕流显示画布
    hasAudio boolean 远端用户是否推音频流
    hasCameraMaster boolean 远端用户是否推相机大流
    hasCameraSlave boolean 远端用户是否推相机小流
    hasScreenSharing boolean 远端用户是否推屏幕流
    subAudio boolean 是否订阅远端用户的音频流
    subCamera boolean 是否订阅远端用户的相机流
    subCameraMaster boolean 是否订阅远端用户的相机大流
    subScreenSharing boolean 是否订阅远端用户的屏幕流
    requestAudio boolean 是否请求订阅远端用户的音频流
    requestCamera boolean 是否请求订阅远端用户的相机流
    requestCameraMaster boolean 是否请求订阅远端用户的相机大流
    requestScreenSharing boolean 是否请求订阅远端用户的屏幕流
  • AliRTCImageFormat:图片格式枚举。
    枚举名 描述
    ALIRTC_IMAGE_FORMATUNKNOWN 格式未知
    ALIRTC_IMAGE_FORMATARGB 格式ARGB
    ALIRTC_IMAGE_FORMATBGRA 格式BGRA
    ALIRTC_IMAGE_FORMATRGBA 格式RGBA
    ALIRTC_IMAGE_FORMATYUV420P 格式YUV420P
    ALIRTC_IMAGE_FORMATYUVYV12 格式YUVYV12
    ALIRTC_IMAGE_FORMATYUVNV21 格式YUVNV21
    ALIRTC_IMAGE_FORMATYUVNV12 格式YUVNV12
    ALIRTC_IMAGE_FORMATYUVNV12_FULL_RANGE 格式YUVNV12_FULL_RANGE
    ALIRTC_IMAGE_FORMATYUVJ420P 格式YUVJ420P
    ALIRTC_IMAGE_FORMATYUV420SP 格式YUV420SP
    ALIRTC_IMAGE_FORMATYUVJ420SP 格式YUVJ420SP
    ALIRTC_IMAGE_FORMATYUVJ444P 格式YUVJ444P
    ALIRTC_IMAGE_FORMATYUVJ422P 格式YUVJ422P
    ALIRTC_IMAGE_FORMATYUV444P 格式YUV444P
    ALIRTC_IMAGE_FORMATYUV2 格式YUV2
    ALIRTC_IMAGE_FORMATMJPEG 格式MJPEG
    ALIRTC_IMAGE_FORMATTEXTURE_2D 格式TEXTURE_2D
    ALIRTC_IMAGE_FORMATTEXTURE_OES 格式TEXTURE_OES
  • AliStatusInfo:用户信息。
    字段名 类型 描述
    user_id String 用户ID
    status AliStatusState 状态
  • AliStatusState:用户状态。
    字段名 类型 描述
    mic_open boolean 麦克风是否开启
    mic_interrupted boolean 麦克风是否被打断
    cam_open boolean 相机是否打开
    audio_disabled boolean 音频是否不可用
    video_disabled boolean 视频是否不可用
    background_mode boolean 是否后台模式
  • AliDetectObserver:人脸识别预处理接口。
    方法名 描述
    onData 人脸识别回调接口

    示例方法如下所示。

    long onData(long dataFrameY, long dataFrameU, long dataFrameV, AliRtcEngine.AliRTCImageFormat aliRTCImageFormat, int width, int height, int strideY, int strideU, int strideV, int rotate, long extraData);
    参数 类型 描述
    dataFrameY long Y分量指针
    dataFrameU long U分量指针
    dataFrameV long V分量指针,NV12和NV21该指针为null
    aliRTCImageFormat AliRtcEngine.AliRTCImageFormat 图像数据格式
    width int 图像宽度
    height int 图像高度
    strideY int 图像Y分量stride
    strideU int 图像U分量stride
    strideV int 图像V分量stride
    rotate int 图像旋转角度
    extraData long 附加字段(非定制化可忽略)
  • AliRtcChannelProfile:频道类型。
    枚举名 描述
    AliRTCSDK_Communication 通信模式
    AliRTCSDK_Interactive_live 互动模式
  • AliAudioType:音频类型枚举。
    枚举名 描述
    PUB_OBSERVER 经过音频3A处理后的音频数据
    SUB_OBSERVER 当前订阅到的远端用户混音后的音频数据
    RAW_DATA_OBSERVER 本地采集的原始音频数据
  • AliRtcClientRole:角色类型。
    枚举名 描述
    AliRTCSDK_Interactive 参与互动角色
    AliRTCSDK_live 仅观看角色
  • AliRtcStats:当前频道通话实时数据。

    枚举名 描述
    sent_kbitrate 总发送码率,单位:kb
    rcvd_kbitrate 总接收码率,单位:kb
    sent_bytes 总发送数据量,单位:bytes
    rcvd_bytes 总接收数据量,单位:bytes
    cpu_usage CPU使用量,单位:%
  • AliRtcAudioCodecQualityType:录音文件质量枚举。

    枚举名 描述
    AliRTCSDK_Audio_Codec_Quality_low 低质量文件录制,文件体积较小,音质一般
    AliRTCSDK_Audio_Codec_Quality_midium 中等质量文件录制,文件体积中等,音质中等
    AliRTCSDK_Audio_Codec_Quality_high 高质量文件录制,文件体积较大,音质较好
  • ErrorCodeEnum:错误类型。

    类别 枚举名 描述
    入会错误码 ERR_JOIN_BAD_APPID AppId(应用ID)不存在
    ERR_JOIN_INVALID_APPID AppId(应用ID)已失效
    ERR_JOIN_BAD_CHANNEL 频道不存在
    ERR_JOIN_INVALID_CHANNEL 频道已失效
    ERR_JOIN_BAD_TOKEN Token(鉴权令牌)不存在
    ERR_JOIN_TIMEOUT 加入频道超时
    ERR_JOIN_ERR_JOIN_BAD_PARAMBAD_CHANNEL 参数错误
    音频设备错误码 ERR_MIC_OPEN_FAIL 采集设备初始化失败
    ERR_SPEAKER_OPEN_FAIL 播放设备初始化失败
    ERR_MIC_INTERRUPT 采集过程中出现异常
    ERR_SPEAKER_INTERRUPT 播放过程中出现异常
    ERR_MIC_AUTH_FAIL 麦克风设备未授权
    ERR_MIC_NOT_AVAILABLE 无可用的音频采集设备
    ERR_SPEAKER_NO_AVAILABLE 无可用的音频播放设备
    视频设备错误码 ERR_CAMERA_OPEN_FAIL 采集设备初始化失败
    ERR_CAMERA_INTERRUPT 采集过程中出现异常
    ERR_VIDEO_DISPLAY_INTERRUPT 渲染设备初始化失败
    AliRtcErrDisplayInterrupt 渲染过程中出现异常
    网络错误码 ERR_ICE_CONNECTION_CONNECT_FAIL 媒体通道建立失败
    ERR_ICE_CONNECTION_RECONNECT_FAI 媒体通道重连失败
    ERR_ICE_CONNECTION_HEARTBEAT_TIMEOUT 信令心跳超时
    其他错误码 AliRtcErrSdkInvalidState SDK状态错误
    ERR_SESSION_REMOVED Session(会话)已经被移除
    AliRtcErrInner 其他错误
    ON_PERFORMANCE_LOW 当前设备性能不足
    ON_PERMORMANCE_RECOVERY 当前设备性能恢复
  • AliRtcAudioPlayingType:音乐伴奏播放状态。

    枚举名 描述
    AliRtcAudioPlayingStarted 开始播放
    AliRtcAudioPlayingStopped 停止播放
    AliRtcAudioPlayingPaused 播放暂停
    AliRtcAudioPlayingResumed 播放恢复
    AliRtcAudioPlayingEnded 播放完毕
  • AliRtcRecordAudioConfig:录制音频设置。

    枚举名 描述
    AliRtcAudioSampleRate 录制音频文件采样率
    AliRtcAudioQuality 录制音频文件质量
  • RTCLocalVideoStats:本地视频统计信息。

    参数 描述
    track_label 流类型
    sent_bitrate 发布比特率
    sent_fps 发布帧率
    encode_fps 编码帧率
  • RTCRemoteVideoStats:远端视频统计信息。

    参数 描述
    track_label 流类型
    width
    height
    decode_fps 编码帧率
    render_fps 渲染帧率
    frozen_times 打断次数
    user_id 用户ID
  • AliRtcRecordType:录制类型,当前仅支持录制音频文件。

    枚举名 描述
    AliRtcRecordTypeAudio 音频类型
  • AliRtcRecordFormat:录制格式。

    枚举名 描述
    AliRtcRecordFormatAAC 录制音频文件格式为AAC
    AliRtcRecordFormatWAV 录制音频文件格式为WAV
  • AliRtcAudioSampleRate:录制音频采样率。

    枚举名 描述
    AliRtcAudioSampleRate_8000 8K
    AliRtcAudioSampleRate_16000 16K
    AliRtcAudioSampleRate_32000 32K
    AliRtcAudioSampleRate_44100 44.1K
    AliRtcAudioSampleRate_48000 48K
    AliRtcAudioSampleRate_Max 占位值
  • AliRtcAudioQuality:录制音频质量。

    枚举名 描述
    AliRtcAudioQualityLow 质量低
    AliRtcAudioQualityMidium 质量中
    AliRtcAudioQualityHigh 质量高
  • AliRTCSDK_AudioEffect_Reverb_Mode:混响音效模式。

    枚举名 描述
    AliRTCSDK_AudioEffect_Reverb_Off 关闭
    AliRTCSDK_AudioEffect_Reverb_Vocal_I 人声I
    AliRTCSDK_AudioEffect_Reverb_Vocal_II 人声II
    AliRTCSDK_AudioEffect_Reverb_Bathroom 澡堂
    AliRTCSDK_AudioEffect_Reverb_Small_Room_Bright 明亮的小房间
    AliRTCSDK_AudioEffect_Reverb_Small_Room_Dark 黑暗的小房间
    AliRTCSDK_AudioEffect_Reverb_Medium_Room 中等大小房间
    AliRTCSDK_AudioEffect_Reverb_Large_Room 大房间
    AliRTCSDK_AudioEffect_Reverb_Church_Hall 教堂走廊
    AliRTCSDK_AudioEffect_Reverb_Cathedral 大教堂
  • AliRTCSDK_AudioEffect_Reverb_Param_Type:混响音效类型。

    枚举名 描述
    AliRTCSDK_AudioEffect_Reverb_Room_Size 房间大小,范围:[0,100]
    AliRTCSDK_AudioEffect_Reverb_Pre_Delay 预延时,单位:ms,范围:[0,200]
    AliRTCSDK_AudioEffect_Reverb_Reverberance 混响感,范围:[0,100]
    AliRTCSDK_AudioEffect_Reverb_Hf_Damping 消声,范围:[0,100]
    AliRTCSDK_AudioEffect_Reverb_Tone_Low 低音调,范围:[0,100]
    AliRTCSDK_AudioEffect_Reverb_Tone_High 高音调,范围:[0,100]
    AliRTCSDK_AudioEffect_Reverb_Dry_Gain 干增益,范围:[-20,10]
    AliRTCSDK_AudioEffect_Reverb_Wet_Gain 湿增益,范围:[-20,10]
  • AliVideoSourceType:视频源类型。
    枚举名 描述
    AliRTCSdk_Videosource_Camera_Large_Type 相机流大流
    AliRTCSdk_Videosource_Camera_Small_Type 相机流小流
    AliRTCSdk_Videosource_ScreenShare_Type 屏幕分享流
  • AliVideoSample:视频样本类。
    参数 类型 描述
    dataFrameY long Y分量指针
    dataFrameU long U分量指针
    dataFrameV long V分量指针
    format AliRTCImageFormat 视频帧格式
    width int 视频帧的宽
    height int 视频帧的高
    strideY int YUV数据中的Y缓冲区的行跨度
    strideU int YUV数据中的U缓冲区的行跨度
    strideV int YUV数据中的V缓冲区的行跨度
    rotate int 视频帧的旋转角度
    extraData long 附加字段(非定制化可忽略)
  • AliRtcBeautyConfig:美颜设置。

    参数 描述
    whiteningLevel 美白[0,1]数值越大美白效果越好
    smoothnessLevel 磨皮[0,1]数值越大磨皮效果越好
  • AliRtcAudioVolume:用户音量信息。

    参数 描述
    mUserId 当前用户的uid,0:表示本地,1:表示远端混音,其他表示远端用户
    mVolume 当前回调的音量
    mSpeechstate 1:表示正在说话,0:没说话
  • AliRtcAudioNumChannel:音频声道类型。

    枚举名 描述
    AliRtcMonoAudio = 1 单声道音频
    AliRtcStereoAudio = 2 立体声音频
  • AliRtcFeedbackType: SDK反馈问题类型。

    枚举名 描述
    AliRtcFeedbackVideoDeviceFail 视频设备问题
    AliRtcFeedbackVideoNotRender 视频无画面
    AliRtcFeedbackAudioDeviceFail 音频设备问题
    AliRtcFeedbackAudioNotRender 音频无声音
    AliRtcFeedbackAudioEchoError 音频回声异常
    AliRtcFeedbackChannelTypeError 会议状态异常:入会异常、离会异常等
    AliRtcFeedbackSDKTypeError SDK其他状态异常
    AliRtcFeedbackNetworkUnfluent 网络卡顿问题
    AliRtcFeedbackVideoBlurring 视频清晰问题
    AliRtcFeedbackUnkonw 未知类型
  • AliRtcOrientationMode:横竖屏类型。

    枚举名 描述
    AliRtcOrientationModePortrait 固定竖屏模式
    AliRtcOrientationModeLandscapeLeft 固定左横屏模式
    AliRtcOrientationModeLandscapeRight 固定右横屏模式
    AliRtcOrientationModeAuto 自适应横竖屏模式