本章节为您列出了iOS SDK和Mac SDK的所有数据类型。

数据类型 描述 以上版本支持
AliRtcVideoTrack 视频Track类型 1.1
AliRtcAudioTrack 音频Track类型 1.1
AliRtcNetworkQuality 网络质量 1.1
AliRtcRenderMode 渲染模式 1.1
AliRtcLogLevel 日志级别 1.1
AliRtcVideoProfile 视频质量参数 1.1
AliRtcErrorCode 错误类型 1.9
AliRtcAuthInfo 鉴权信息 1.1
AliVideoCanvas 渲染画布 1.1
AliRtcRenderMirrorMode 镜像模式 1.11
AliRtcOnByeType OnBye类型 1.11
AliRtcAudioNumChannel 音频声道(仅iOS) 1.15
AudioSamplerate 采样率(仅iOS) 1.15
AliRtcChannelProfile 频道类型 1.15
AliRtcAudioSessionOperationRestriction SDK对Audio Session的控制权限(仅iOS) 1.15
AliRtcVideoFormat 影片格式 iOS1.15/Mac1.16.2
AliRtcBufferType 缓冲区类型 iOS1.15/Mac1.16.2
AliRtcAudioSource 音频裸数据源类型 1.15
AliRtcStats 实时数据 1.16
AliRtcRecordingQuality 录音文件质量枚举 1.16
AliRtcClientRole 角色类型 1.16
AliRtcAudioPlayingType 音乐伴奏播放状态(仅iOS) 1.16.2
AliRtcVideoSource 视频裸数据源类型(仅Mac) 1.16.2
AliRtcMuteLocalAudioMode 本地静音模式(仅Mac) 1.16.2
AliRtcAudioEffectReverbMode 音效混响模式 1.17
AliRtcAudioEffectReverbParamType 音效混响参数 1.17
AliRtcRecordType 录制类型 1.17
AliRtcRecordFormat 录制格式 1.17
AliRtcAudioQuality 录制音频质量 1.17
AliRtcVideoQuality 录制视频质量 1.17
AliRtcAudioSampleRate 录制音频采样率 1.17
AliRtcRecordAudioConfig 录制音频设置 1.17
AliRtcRecordVideoConfig 录制视频设置 1.17
AliRtcLocalVideoStats 本地视频统计信息 1.17
AliRtcRemoteVideoStats 远端视频统计信息 1.17
  • AliRtcVideoTrack:视频Track的类型。

    枚举名 描述
    AliRtcVideoTrackNo 无摄像头和屏幕共享流
    AliRtcVideoTrackCamera 相机流
    AliRtcVideoTrackScreen 屏幕共享流
    AliRtcVideoTrackBoth 相机流和屏幕共享流
  • AliRtcAudioTrack:音频Track的类型。

    枚举名 描述
    AliRtcAudioTrackNo 无麦克风流
    AliRtcAudioTrackMic 麦克风流
  • AliRtcNetworkQuality:网络质量。

    枚举名 描述
    AlivcRtcNetworkQualityExcellent 网络极好,流程度清晰度质量好
    AlivcRtcNetworkQualityGood 网络好,流畅度清晰度和极好差不多
    AlivcRtcNetworkQualityPoor 网络较差,音视频流畅度清晰度有瑕疵,不影响沟通
    AlivcRtcNetworkQualityBad 网络差,视频卡顿严重,音频能正常沟通
    AlivcRtcNetworkQualityVeryBad 网络极差,基本无法沟通
    AlivcRtcNetworkQualityDisconnect 网络中断
    AlivcRtcNetworkQualityUnknow 未知
  • AliRtcRenderMode:渲染模式。

    枚举名 描述
    AliRtcRenderModeAuto 自动模式
    AliRtcRenderModeStretch 拉伸填充视图,不保持视频比例
    AliRtcRenderModeFill 在保持视频宽高比的同时缩放,填充黑边
    AliRtcRenderModeCrop 在保持视频宽高比的同时缩放,并裁剪以适合视图
  • AliRtcLogLevel:日志级别。

    枚举名 描述
    AliRtcLogLevelDump 全量
    AliRtcLogLevelDebug 调试
    AliRtcLogLevelVerbose 详细
    AliRtcLogLevelInfo 普通
    AliRtcLogLevelWarn 警告
    AliRtcLogLevelError 错误
    AliRtcLogLevelFatal 严重
    AliRtcLogLevelNone
  • AliRtcVideoProfile:视频流规格。

    发布视频流规格,默认为AliRtcSDK_Video_Profile_Default,可以在加入频道之前或者之后设置,但必须在发布之前通过setVideoProfile方法设置。

    iOS视频流规格:

    枚举名 描述
    AliRtcVideoProfile_Default 默认分辨率_480*640P分辨率_15帧
    AliRtcVideoProfile_180_240P_15 180*240P分辨率_15帧
    AliRtcVideoProfile_180_320P_15 180*320P分辨率_15帧
    AliRtcVideoProfile_180_320P_30 180*320P分辨率_30帧
    AliRtcVideoProfile_240_320P_15 240*320P分辨率_15帧
    AliRtcVideoProfile_360_480P_15 360*480P分辨率_15帧
    AliRtcVideoProfile_360_480P_30 360*480P分辨率_30帧
    AliRtcVideoProfile_360_640P_15 360*640P分辨率_15帧
    AliRtcVideoProfile_360_640P_30 360*640P分辨率_30帧
    AliRtcVideoProfile_480_640P_15 480*640P分辨率_15帧
    AliRtcVideoProfile_480_640P_30 480*640P分辨率_30帧
    AliRtcVideoProfile_720_960P_15 720*960P分辨率_15帧
    AliRtcVideoProfile_720_960P_30 720*960P分辨率_30帧
    AliRtcVideoProfile_720_1280P_15 720*1280P分辨率_15帧
    AliRtcVideoProfile_720_1280P_30 720*1280P分辨率_30帧
    AliRtcVideoProfile_Max 占位值

    Mac视频流规格:

    枚举名 描述
    AliRtcVideoProfile_Default 默认分辨率_480*640P分辨率_15帧
    AliRtcVideoProfile_180_240P_15 180*240P分辨率_15帧
    AliRtcVideoProfile_180_320P_15 180*320P分辨率_15帧
    AliRtcVideoProfile_180_320P_30 180*320P分辨率_30帧
    AliRtcVideoProfile_240_320P_15 240*320P分辨率_15帧
    AliRtcVideoProfile_360_480P_15 360*480P分辨率_15帧
    AliRtcVideoProfile_360_480P_30 360*480P分辨率_30帧
    AliRtcVideoProfile_360_640P_15 360*640P分辨率_15帧
    AliRtcVideoProfile_360_640P_30 360*640P分辨率_30帧
    AliRtcVideoProfile_480_640P_15 480*640P分辨率_15帧
    AliRtcVideoProfile_480_640P_30 480*640P分辨率_30帧
    AliRtcVideoProfile_720_960P_15 720*960P分辨率_15帧
    AliRtcVideoProfile_720_960P_30 720*960P分辨率_30帧
    AliRtcVideoProfile_720_1280P_15 720*1280P分辨率_15帧
    AliRtcVideoProfile_720_1280P_30 720*1280P分辨率_30帧
    AliRtcVideoProfile_1080_1920P_15 1080*1920P分辨率_15帧
    AliRtcVideoProfile_1080_1920P_30 1080*1920P分辨率_30帧
    AliRtcVideoProfile_480_640P_15_1500Kb 480*640P分辨率_15帧_1500Kb带宽
    AliRtcVideoProfile_Max 占位值
  • AliRtcErrorCode:错误类型。

    类别 枚举名 描述
    入会错误码 AliRtcErrJoinBadAppId AppId不存在
    AliRtcErrJoinInvalidAppId AppId已失效
    AliRtcErrJoinBadChannel 频道不存在
    AliRtcErrJoinInvalidChannel 频道已失效
    AliRtcErrJoinBadToken Token不存在
    AliRtcErrJoinTimeout 加入频道超时
    AliRtcErrJoinBadParam 参数错误
    音频设备错误码 AliRtcErrMicOpenFail 采集设备初始化失败
    AliRtcErrSpeakerOpenFail 播放设备初始化失败
    AliRtcErrMicInterrupt 采集过程中出现异常
    AliRtcErrSpeakerInterrupt 播放过程中出现异常
    AliRtcErrMicAuthFail 麦克风设备未授权
    AliRtcErrMicNotAvailable 无可用的音频采集设备
    AliRtcErrSpeakerNotAvailable 无可用的音频播放设备
    视频设备错误码 AliRtcErrCameraOpenFail 采集设备初始化失败
    AliRtcErrCameraInterrupt 采集过程中出现异常
    AliRtcErrDisplayOpenFail 渲染设备初始化失败
    AliRtcErrDisplayInterrupt 渲染过程中出现异常
    网络错误码 AliRtcErrIceConnectionConnectFail 媒体通道建立失败
    AliRtcErrIceConnectionReconnectFail 媒体通道重连失败
    AliRtcErrIceConnectionHeartbeatTimeout 信令心跳超时
    其他错误码 AliRtcErrSdkInvalidState SDK状态错误
    AliRtcErrSessionRemoved Session已经被移除
    AliRtcErrInner 其他错误
    AliRtcErrAudioBufferFull buffer队列饱和,用于外部输送裸数据功能
  • AliRtcAuthInfo:鉴权信息。

    注意 在1.9及以上版本移出session id字段。
    枚举名 类型 描述
    channel NSString * 频道号
    user_id NSString * 用户ID
    appid NSString * 应用ID
    nonce NSString * 令牌随机码
    token NSString * 令牌
    gslb NSArray 服务器地址
    timestamp long long 时间戳
    agent NSArray 设置Agent服务器地址(默认状态不需要传)
  • AliVideoCanvas:渲染画布。

    枚举名 类型 描述
    view AliRenderView * 渲染视图,继承UIView类,创建视图前需创建view
    renderMode AliRtcRenderMode 渲染模式,默认为AliRtcRenderModeAuto
    mirrorMode AliRtcRenderMirrorMode 镜像模式,默认为前置镜像
  • AliRtcRenderMirrorMode:镜像模式。

    枚举名 描述
    AliRtcRenderMirrorModeOnlyFrontCameraPreviewEnabled 只有前置摄像头预览镜像,其余不镜像
    AliRtcRenderMirrorModeAllEnabled 全部镜像
    AliRtcRenderMirrorModeAllDisabled 全部不镜像
  • AliRtcOnByeType:OnBye类型(被服务器踢出频道的消息)。

    枚举名 描述
    AliRtcOnByeBeKickedOut 当前用户被踢出频道
    AliRtcOnByeChannelDestroy 频道已结束,需要离开会议
    AliRtcOnByeUserReplaced 相同UserID在其他设备加入频道,当前设备被下线
  • AliRtcAudioNumChannel:音频声道数。

    枚举名 描述
    AliRtcMonoAudio 单声道音频
    AliRtcStereoAudio 立体声音频
  • AudioSamplerate:采样率。

    枚举名 描述
    AliRtcAudioSampleRate_8000 8000
    AliRtcAudioSampleRate_11025 11025
    AliRtcAudioSampleRate_16000 16000
    AliRtcAudioSampleRate_22050 22050
    AliRtcAudioSampleRate_32000 32000
    AliRtcAudioSampleRate_44100 44100
    AliRtcAudioSampleRate_48000 48000
  • AliRtcChannelProfile:频道类型(默认为通讯模式)。

    枚举名 描述
    AliRtcCommunication 通信模式
    AliRtcInteractivelive 互动模式
  • AliRtcAudioSessionOperationRestriction:SDK对Audio Session的控制权限。

    枚举名 描述
    AliRtcAudioSessionOperationRestrictionNone 没有限制,SDK完全控制AVAudioSession
    AliRtcAudioSessionOperationRestrictionSetCategory SDK不能修改AVAudioSession的Category
    AliRtcAudioSessionOperationRestrictionConfigureSession SDK不能修改AVAudioSession的配置,包括Category、Mode、CategoryOptions
    AliRtcAudioSessionOperationRestrictionDeactivateSession SDK不能关闭AVAudioSession的活动状态,离开频道时,AVAudioSession依然处于活动状态
  • AliRtcVideoFormat:影片格式。

    枚举名 描述
    AliRtcVideoFormat_UNKNOW 未知
    AliRtcVideoFormat_BGRA BGRA
    AliRtcVideoFormat_I420 I420
    AliRtcVideoFormat_NV21 NV21
    AliRtcVideoFormat_NV12 NV12
  • AliRtcBufferType:缓冲区类型。

    枚举名 描述
    AliRtcBufferType_Raw_Data Raw_Data
    AliRtcBufferType_CVPixelBuffer CVPixelBuffer
    AliRtcBufferType_Texture Texture
  • AliRtcAudioSource:音频裸数据源类型。

    枚举名 描述
    AliRtcAudiosourcePub 推流音频数据
    AliRtcAudiosourceSub 拉流音频数据
    AliRtcAudiosourceRawData 采集音频裸数据
    AliRtcAudiosourceVolume 音量
    说明 Mac和iOS从1.16版本开始都支持AliRtcAudiosourceVolume枚举。两种语言区别:iOS支持AliRtcAudioSource全部枚举,而Mac仅支持AliRtcAudiosourceVolume。
  • AliRtcStats:实时数据。

    枚举名 描述
    sent_kbitrate 总发送码率,单位:kb
    rcvd_kbitrate 总接收码率,单位:kb
    sent_bytes 总发送数据量,单位:bytes
    rcvd_bytes 总接收数据量,单位:bytes
    cpu_usage CPU使用量,单位:%
    video_rcvd_kbitrate 视频发送码率,单位:kb
    video_sent_kbitrate 视频接收码率,单位:kb
    call_duration 通话时长,单位:s
  • AliRtcRecordingQuality:录音文件质量枚举。

    枚举名 描述
    AliRtcRecording_Low_Quality 低质量文件录制,文件体积较小,音质一般
    AliRtcRecording_Midium_Quality 中等质量文件录制,文件体积中等,音质中等
    AliRtcRecording_High_Quality 高质量文件录制,文件体积较大,音质较好
  • AliRtcClientRole:角色类型。

    枚举名 描述
    AliRtcClientRoleInteractive 参与互动角色
    AliRtcClientRolelive 仅观看角色
  • AliRtcAudioPlayingType:音乐伴奏播放状态。

    枚举名 描述
    AliRtcAudioPlayingStarted 开始播放
    AliRtcAudioPlayingStopped 停止播放
    AliRtcAudioPlayingPaused 播放暂停
    AliRtcAudioPlayingResumed 播放恢复
    AliRtcAudioPlayingEnded 播放完毕
  • AliRtcVideoSource:视频裸数据源类型。

    枚举名 描述
    AliRtcVideosourceCameraLargeType 大分辨率视频流
    AliRtcVideosourceCameraSmallType 小分辨率视频流
    AliRtcVideosourceScreenShareType 屏幕共享流
    AliRtcVideosourceTypeMax 占位符
  • AliRtcMuteLocalAudioMode:本地静音模式。

    枚举名 描述
    AliRtcMuteAudioModeDefault 默认模式
    AliRtcMuteAllAudioMode 静音全部(麦克风及外部输入音频)
    AliRtcMuteOnlyMicAudioMode 只静音麦克风
    AliRtcMuteLocalAudioMax 占位值
  • AliRtcAudioEffectReverbMode:音效混响模式。

    枚举名 描述
    AliRtcAudioEffectReverb_Off 关闭
    AliRtcAudioEffectReverb_Vocal_I 人声I
    AliRtcAudioEffectReverb_Vocal_II 人声II
    AliRtcAudioEffectReverb_Bathroom 澡堂
    AliRtcAudioEffectReverb_Small_Room_Bright 明亮小房间
    AliRtcAudioEffectReverb_Small_Room_Dark 黑暗小房间
    AliRtcAudioEffectReverb_Medium_Room 中等房间
    AliRtcAudioEffectReverb_Large_Room 大房间
    AliRtcAudioEffectReverb_Church_Hall 教堂走廊
    AliRtcAudioEffectReverb_Cathedral 大教堂
    AliRtcAudioEffectReverb_Mode_Max 占位符,无含义
  • AliRtcAudioEffectReverbParamType:音效混响参数。

    枚举名 描述
    AliRtcAudioEffectReverb_Room_Size 房间大小,范围:[0,100]
    AliRtcAudioEffectReverb_Pre_Delay 预延时,单位:ms,范围:[0,200]
    AliRtcAudioEffectReverb_Revetberance 混响感,范围:[0,100]
    AliRtcAudioEffectReverb_Hf_Damping 消声,范围:[0,100]
    AliRtcAudioEffectReverb_Tone_Low 低音调,范围:[0,100]
    AliRtcAudioEffectReverb_Tone_High 高音调,范围:[0,100]
    AliRtcAudioEffectReverb_Dry_Gain 干增益,范围:[-20,10]
    AliRtcAudioEffectReverb_Wet_Gain 湿增益,范围:[-20,10]
    AliRtcAudioEffectReverb_Type_Max 占位符
  • AliRtcRecordType:录制类型。

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

    枚举名 描述
    AliRtcRecordFormatAAC AAC文件
    AliRtcRecordFormatWAV WAV文件
  • AliRtcAudioQuality:录制音频质量。

    枚举名 描述
    AliRtcAudioQualityLow
    AliRtcAudioQualityMidium
    AliRtcAudioQualityHigh
  • AliRtcVideoQuality:录制视频质量。

    枚举名 描述
    AliRtcVideoQualityDefault 默认,和采集保持一致(例如:采集视频流最高为1080P,默认录制1080P视频流)
  • AliRtcAudioSampleRate:录制音频采样率。

    枚举名 描述
    AliRtcAudioSampleRate_8000 采样率8000
    AliRtcAudioSampleRate_11025 采样率11025
    AliRtcAudioSampleRate_16000 采样率16000
    AliRtcAudioSampleRate_22050 采样率22050
    AliRtcAudioSampleRate_32000 采样率32000
    AliRtcAudioSampleRate_44100 采样率44100
    AliRtcAudioSampleRate_48000 采样率48000
  • AliRtcRecordAudioConfig:录制音频设置。

    枚举名 描述
    sampleRate 音频采样率
    quality 音频质量
    enableRecordExternalRenderPCM 是否允许录制外部PCM输入渲染数据
  • AliRtcRecordVideoConfig:录制视频设置。

    枚举名 描述
    quality 视频质量
  • AliRtcLocalVideoStats:本地视频统计信息。

    枚举名 描述
    track 视频流Track类型
    sent_bitrate 发送码率
    sent_fps 发送帧率
    encode_fps 编码帧率
  • AliRtcRemoteVideoStats:远端视频统计信息。

    枚举名 描述
    userId 远端用户ID
    track 视频流Track类型
    width
    height
    decode_fps 解码帧率
    render_fps 渲染帧率
    frozen_times 卡顿次数