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

目录

数据类型 描述 支持的最低版本
AliRtcAudioPlayingErrorCode 音乐伴奏播放错误码(仅iOS)。 2.1
AliRtcAudioPlayingStateCode 音乐伴奏播放状态(仅iOS)。 2.1
AliRtcUserVolumeInfo 用户音量信息。 1.17
AliRtcAudioDataSample 音频样本。 2.1
AliRtcVideoDataSample 视频样本。 2.1
AliRtcChannelProfile 频道模式。 1.17
AliRtcClientRole 用户角色。 1.17
AliRtcStats 会话数据统计信息。 1.17
AliRtcLocalVideoStats 本地视频统计信息。 1.17
AliRtcRemoteVideoStats 远端视频统计信息。 1.17
AliRtcLocalAudioStats 本地音频统计信息。 1.7
AliRtcRemoteAudioStats 远端音频统计信息。 1.17
AliRtcFeedbackType SDK反馈问题类型。 1.17
AliRtcChannelRelayEvent 跨频道转发事件。 2.1
AliRtcChannelRelayState 跨频道转发状态。 2.1
AliRtcChannelRelayConfiguration 跨频道转推设置。 2.1
AliRtcVideoObserPosition 视频数据输出位置。 2.1
AliRtcVideoFormat 视频数据类型。
  • iOS:1.15
  • Mac:1.16.2
AliRtcExternalDeviceType 外接设备类型(仅Mac)。 2.1
AliRtcExternalDeviceState 外接设备状态(仅Mac)。 2.1
AliRtcConnectionStatus 网络连接状态。 2.1
AliRtcConnectionStatusChangeReason 网络连接状态变更原因。 2.1
AliRtcVideoTrack 视频流类型。 1.1
AliRtcPublishState 推流状态。 2.1
AliRtcSubscribeState 订阅状态。 2.1
AliRtcUserOfflineReason 用户离线原因。 2.1
AliRtcVideoStreamType 相机流类型。 2.1
AliRtcAudioTrack 音频流类型。 1.1
AliRtcNetworkQuality 网络质量。 1.1
AliRtcOrientationMode 横竖屏类型(仅iOS)。 2.1
AliRtcAudioSessionOperationRestriction SDK对Audio Session的控制权限(仅iOS)。 1.15
AliRtcRenderMode 渲染模式。 1.17
AliRtcRenderMirrorMode 镜像模式。 1.17
AliRtcRotationMode 旋转角度。 2.1
AliRtcLogLevel 日志级别。 1.17
AliRtcAudioNumChannel 音频声道数。 1.15
AliRtcAudioSampleRate 录制音频采样率。 2.1
AliRtcRecordType 录制类型。 2.1
AliRtcRecordFormat 录制格式 2.1
AliRtcAudioQuality 录制音频文件的音频质量。 2.1
AliRtcVideoQuality 录制视频文件的视频质量。 1.17
AliRtcTranportAudioQuality 音频质量。 2.1
AliRtcAudioProfile 音频质量模式。 2.1
AliRtcAudioScenario 音频场景模式参数。 2.1
AliRtcMuteLocalAudioMode 本地静音模式。 2.1
AliRtcRecordAudioConfig 录制音频设置。 1.17
AliRtcRecordVideoConfig 录制视频设置。 1.17
AliRtcRecordVideoCanvasConfig 录制视频设置的画布大小(仅Mac)。 2.1
AliRtcRecordVideoLayout 录制视频的布局信息(仅Mac)。 2.1
AliRtcRecordVideoLayoutMode 录制视频的布局模式(仅Mac)。 2.1
AliRtcRecordVideoBgColor 录制视频的背景颜色(仅Mac)。 2.1
AliRtcRecordVideoRegion 录制布局的用户画面配置信息(仅Mac)。 2.1
AliRtcRecordVideoRectangle 用户画面的位置信息(仅Mac)。 2.1
AliRtcRecordVideoRational 混流录制坐标(仅Mac)。 2.1
AliRtcRecordTemplate 录制模板(仅Mac)。 2.1
AliRtcDeviceInfo 设备信息(仅Mac)。 2.1
AliRtcBeautyConfig 基础美颜设置。 1.17
AliRtcOnByeType OnBye类型枚举。 2.1
AliRtcAudioEffectVoiceChangerMode 变声音效模式。 2.1
AliRtcAudioEffectReverbMode 音效混响模式。 2.1
AliRtcAudioEffectReverbParamType 音效混响参数。 2.1
AliRtcAudioRouteType 语音路由(仅iOS)。 2.1
AliVideoCanvas 渲染画布。 1.17
AliRtcTrascodingLiveStreamStatus 旁路转推任务状态。 2.1
AliRtcTrascodingLiveStreamErrorCode 旁路推流错误码。 2.1
AliRtcWatermarkConfig 水印图片的设置。 2.1
AliRtcCameraCapturerConfiguration 相机采集偏好属性。 2.1
AliRtcCameraDirection 摄像头方向。 2.1
AliRtcCaptureOutputPreference 摄像头采集偏好。 2.1
AliRtcVideoEncoderFrameRate 视频编码帧率。 2.1
AliRtcVideoEncoderBitrate 视频编码码率。 2.1
AliRtcVideoEncoderMirrorMode 编码视频镜像模式。 2.1
AliRtcVideoEncoderOrientationMode 编码视频旋转模式。 2.1
AliRtcVideoEncoderConfiguration 视频编码偏好。 2.1
AliRtcScreenShareEncoderConfiguration 屏幕分享编码偏好。 2.1
AliRtcScreenShareConfig 屏幕分享配置(仅Mac)。 2.1
AliRtcScreenShareRegion 屏幕分享区域(仅Mac)。 2.1
AliRtcScreenSourceInfo 屏幕分享源信息(仅Mac)。 2.1
AliRtcScreenShareInfo 屏幕分享配置信息(仅Mac)。 2.1
AliRtcScreenShareType 屏幕分享类型(仅Mac)。 2.1
AliRtcAuthInfo 鉴权信息。 1.17
AliRtcDeviceVolumeType 设备音量类型(仅iOS)。 1.17.39
AliRtcVideoSource 视频裸数据源类型。 1.16.2
AliRtcAudioSource 音频裸数据源类型。 1.15
AliRtcBufferType 视频数据类型。
  • iOS:1.15
  • Mac:1.16.2
AliRtcErrorCode 错误码。 1.9
AliRtcTranscodingUser 旁路直播用户信息。 2.1
AliRtcTranscodingUserPane 旁路直播用户窗格信息。 2.1
AliRtcTranscodingPane 旁路直播用户自定义窗格信息。 2.1
AliRtcTranscodingLayout 旁路直播用户自定义layout信息。 2.1
AliRtcLiveTranscoding 旁路直播配置。 2.1

详情

  • AliRtcAudioPlayingErrorCode:音乐伴奏播放错误码(仅iOS)。
    枚举名 描述
    AliRtcAudioPlayingNoError 正常状态。
    AliRtcAudioPlayingOpenFailed 打开文件失败。
    AliRtcAudioPlayingDecodeFailed 编码失败。
  • AliRtcAudioPlayingStateCode:音乐伴奏播放状态(仅iOS)。
    枚举名 描述
    AliRtcAudioPlayingStarted 正在播放。
    AliRtcAudioPlayingStopped 停止播放。
    AliRtcAudioPlayingPaused 暂停播放。
    AliRtcAudioPlayingResumed 恢复播放。
    AliRtcAudioPlayingEnded 播放结束。
    AliRtcAudioPlayingBuffering 正在缓冲。
    AliRtcAudioPlayingBufferingEnd 缓冲结束。
    AliRtcAudioPlayingFailed 播放失败。
  • AliRtcUserVolumeInfo:用户音量信息。
    参数 类型 描述
    uid NSString * _Nonnull 当前用户的UID,取值:
    • 0:表示本地。
    • 1:表示远端混音。
    • 其他:表示远端用户。
    volume int 当前回调的音量。
    speech_state BOOL true表示正在说话,false表示没有说话。
  • AliRtcAudioDataSample:音频样本。
    参数 类型 描述
    dataPtr long 当前用户的UID,取值:
    • 0:表示本地。
    • 1:表示远端混音。
    • 其他:表示远端用户。
    numOfSamples int 每个声道的采样点数。
    bytesPerSample int 每个采样点的字节数:对于PCM来说,一般使用16 bit,即两个字节。
    numOfChannels int 声道数量,取值:
    • 1:单声道。
    • 2:双声道。
    samplesPerSec int 每声道每秒的采样点数,即采样率。
  • AliRtcVideoDataSample:视频样本。
    参数 类型 描述
    format AliRtcVideoFormat 视频数据格式。
    type AliRtcBufferType 视频数据类型。
    pixelBuffer CVPixelBufferRef _Nullable pixelBuffer数据。
    dataPtr long yuv数据指针。
    dataYPtr long Y分量指针。
    dataUPtr long U分量指针。
    dataVPtr long V分量指针。
    dataLength long 数据大小。
    strideY int YUV数据中的Y缓冲区的行跨度。
    strideU int YUV数据中的U缓冲区的行跨度。
    strideV int YUV数据中的V缓冲区的行跨度。
    height int 视频帧的高。
    width int 视频帧的宽。
    rotation int 视频帧的旋转角度。
    timeStamp long long 时间戳。
  • AliRtcChannelProfile:频道模式。
    枚举名 描述
    AliRtcCommunication 通信模式。
    AliRtcInteractivelive 互动模式。
    AliRtcInteractiveWithLowLatencyLive 低延迟互动直播模式。
  • AliRtcClientRole:用户角色。
    枚举名 描述
    AliRtcClientRoleInteractive 主播角色。
    AliRtcClientRolelive 观众角色。
  • AliRtcStats:会话数据统计信息。
    参数 类型 描述
    sent_kbitrate long long 发送码率。
    rcvd_kbitrate long long 接收码率。
    sent_bytes long long 发送字节数。
    rcvd_bytes long long 接收字节数。
    systemCpuUsage float 系统CPU使用率。
    cpu_usage float RTC进程CPU使用率。
    video_rcvd_kbitrate long 视频接收码率。
    video_sent_kbitrate long 视频发送码率。
    call_duration long 通话时长,单位:秒。
    sent_loss_rate long 客户端到服务器的丢包率。
    sent_loss_pkts long long 客户端到服务器的丢包数。
    sent_expected_pkts long long 客户端到服务器的总包数。
    rcvd_loss_rate long long 客户端到服务器的下行丢包率。
    rcvd_loss_pkts long long 客户端到服务器的下行丢包数。
    rcvd_expected_pkts long long 客户端到服务器的下行总包数。
    lastmile_delay int 延时时长,单位:毫秒。
  • AliRtcLocalVideoStats:本地视频统计信息。
    参数 类型 描述
    track AliRtcVideoTrack 流类型。
    sent_bitrate unsigned int 发布比特率。
    sent_fps unsigned int 发布帧率。
    encode_fps unsigned int 编码帧率。
  • AliRtcRemoteVideoStats:远端视频统计信息。
    参数 类型 描述
    userId NSString * _Nonnull 用户ID。
    track AliRtcVideoTrack 视频流类型。
    width unsigned int 宽。
    height unsigned int 高。
    decode_fps unsigned int 编码器输出帧率。
    render_fps unsigned int 渲染器输出帧率。
    frozen_times iunsigned int 卡顿次数。
  • AliRtcLocalAudioStats:本地音频统计信息。
    参数 类型 描述
    track AliRtcAudioTrack 音频流类型。
    sent_bitrate int 发送码率,单位:Kbps。
    sent_samplerate int 发送的采样率。
    num_channel int 声道数。
  • AliRtcRemoteAudioStats:远端音频统计信息。
    参数 类型 描述
    userId NSString * _Nonnull 远端用户UID。
    track AliRtcAudioTrack 音频流类型。
    quality unsigned int 音质,详情请参见AliRtcTranportAudioQuality
    audio_loss_rate unsigned int 回调周期内的音频丢帧率。
    rcvd_bitrate unsigned int 接收流的瞬时码率,单位:Kbps。
    totalFrozenTimes unsigned int 卡顿次数。
    network_transport_delay unsigned int 发送端到接收端的网络延时,单位:毫秒。
    jitter_buffer_delay unsigned int 接受端到网络抖动缓存的网络延时,单位:毫秒。
  • AliRtcFeedbackType:SDK反馈问题类型。
    枚举名 描述
    AliRtcFeedbackVideoDeviceFail 视频设备问题。
    AliRtcFeedbackVideoNotRender 视频无画面。
    AliRtcFeedbackAudioDeviceFail 音频设备问题。
    AliRtcFeedbackAudioNotRender 音频无声音。
    AliRtcFeedbackAudioEchoError 音频回声异常。
    AliRtcFeedbackChannelTypeError 会议状态异常,例如入会异常、离会异常等。
    AliRtcFeedbackSdkTypeError SDK其他状态异常。
    AliRtcFeedbackNetworkUnfluent 网络卡顿问题。
    AliRtcFeedbackVideoBlurring 视频清晰问题。
    AliRtcFeedbackUnkonw 未知类型。
  • AliRtcChannelRelayEvent:跨频道转发事件。
    枚举名 描述
    AliRtcChannelRelayStart 开启。
    AliRtcChannelRelayUpdate 更新。
    AliRtcChannelRelayStop 停止。
  • AliRtcChannelRelayState:跨频道转发状态。
    枚举名 描述
    AliRtcChannelRelayStateInit 初始化。
    AliRtcChannelRelayStateConnecting 连接中。
    AliRtcChannelRelayStateRunning 转发中。
    AliRtcChannelRelayStateFailure 转发失败。
  • AliRtcChannelRelayConfiguration:跨频道转推设置。
    参数 类型 描述
    destChannelInfos NSDictionary<NSString*,AliRtcAuthInfo*> *_Nullable 转推频道的鉴权信息集合。
  • AliRtcVideoObserPosition:视频数据输出位置。
    枚举名 描述
    AliRtcPositionPostCapture 采集视频数据,对应输出回调onCaptureVideoSample
    AliRtcPositionPreRender 渲染视频数据,对应输出回调onRemoteVideoSample
    AliRtcPositionPreEncoder 编码前视频数据,对应输出回调onPreEncodeVideoSample
  • AliRtcVideoFormat:视频数据类型。
    枚举名 描述
    AliRtcVideoFormat_UNKNOW 未知。
    AliRtcVideoFormat_BGRA BGRA。
    AliRtcVideoFormat_I420 I420。
    AliRtcVideoFormat_NV21 NV21。
    AliRtcVideoFormat_NV12 NV12。
    AliRtcVideoFormat_RGBA RGBA。
    AliRtcVideoFormat_I422 I422。
    AliRtcVideoFormat_ARGB ARGB。
    AliRtcVideoFormat_ABGR ABGR。
    AliRtcVideoFormat_RGB24 RGB24。
    AliRtcVideoFormat_BGR24 BGR24。
    AliRtcVideoFormat_RGB565 RGB565。
  • AliRtcConnectionStatus:网络连接状态。
    枚举名 描述
    AliRtcConnectionStatusInit 初始化完成。
    AliRtcConnectionStatusDisconnected 网络连接断开。
    AliRtcConnectionStatusConnecting 建立网络连接中。
    AliRtcConnectionStatusConnected 网络已连接。
    AliRtcConnectionStatusReconnecting 重新建立网络连接中。
    AliRtcConnectionStatusFailed 网络连接失败。
  • AliRtcConnectionStatusChangeReason:网络连接状态变更原因。
    枚举名 描述
    ConnectionChangedDummyReason 未知原因。
    ConnectionMediaPathChanged 媒体通道变更。
    ConnectionSignalingHeartbeatTimeout 心跳超时。
    ConnectionSignalingHeartbeatAlive 心跳恢复。
    ConnectionSignalingHttpDnsResolved DNS解析成功。
    ConnectionSignalingHttpDnsFailure DNS解析失败。
    ConnectionSignalingGslbFailure GSLB请求失败。
    ConnectionSignalingGslbSucccess GSLB请求成功。
    ConnectionSignalingJoinRoomFailure 加入频道失败。
    ConnectionSignalingJoinRoomSuccess 加入频道成功。
    ConnectionSignalingLeaveRoom 离开频道。
    ConnectionSignalingLeaveRoom 信令建立连接。
  • AliRtcVideoTrack:视频流类型。
    枚举名 描述
    AliRtcVideoTrackNo 无视频流。
    AliRtcVideoTrackCamera 摄像头流。
    AliRtcVideoTrackScreen 屏幕共享流。
    AliRtcVideoTrackBoth 摄像头和屏幕共享。
  • AliRtcPublishState:推流状态。
    枚举名 描述
    AliRtcStatsPublishIdle 初始状态。
    AliRtcStatsNoPublish 未推流。
    AliRtcStatsPublishing 推流中。
    AliRtcStatsPublished 已推流。
  • AliRtcSubscribeState:订阅状态。
    枚举名 描述
    AliRtcStatsSubscribeIdle 初始状态。
    AliRtcStatsNoSubscribe 未订阅。
    AliRtcStatsSubscribing 订阅中。
    AliRtcStatsSubscribed 已订阅。
  • AliRtcUserOfflineReason:用户离线原因。
    枚举名 描述
    AliRtcUserOfflineQuit 用户主动离开。
    AliRtcUserOfflineDropped 因过长时间收不到对方数据包,超时掉线。
    AliRtcUserOfflineBecomeAudience 用户身份从主播切换为观众时触发。
  • AliRtcVideoStreamType:相机流类型。
    枚举名 描述
    AliRtcVideoStreamTypeNone 无视频流。
    AliRtcVideoStreamTypeHigh 大流。
    AliRtcVideoStreamTypeLow 小流。
  • AliRtcAudioTrack:音频流类型。
    枚举名 描述
    AliRtcAudioTrackNo 无音频流。
    AliRtcAudioTrackMic 麦克风流。
  • AliRtcNetworkQuality:网络质量。
    枚举名 描述
    Network_Excellent 网络极好,流程度清晰度质量好。
    Network_Good 网络好,流畅度清晰度和极好差不多。
    Network_Poor 网络较差,音视频流畅度清晰度有瑕疵,不影响沟通。
    Network_Bad 网络差,视频卡顿严重,音频能正常沟通。
    Network_VeryBad 网络极差,基本无法沟通。
    Network_Disconnected 网络中断。
    Network_Unknow 未知原因。
  • AliRtcOrientationMode:横竖屏类型(仅iOS)。
    枚举名 描述
    AliRtcOrientationModePortrait 固定竖屏模式。
    AliRtcOrientationModeLandscapeLeft 固定左横屏模式。
    AliRtcOrientationModePortraitUpsideDown 固定倒立模式。
    AliRtcOrientationModeLandscapeRight 固定右横屏模式。
    AliRtcOrientationModeAuto 自适应横竖屏模式。
  • AliRtcAudioSessionOperationRestriction:SDK对Audio Session的控制权限(仅iOS)。
    枚举名 描述
    AliRtcAudioSessionOperationRestrictionNone 没有限制,SDK完全控制AVAudioSession。
    AliRtcAudioSessionOperationRestrictionSetCategory SDK不能修改AVAudioSession的Category。
    AliRtcAudioSessionOperationRestrictionConfigureSession SDK不能修改AVAudioSession的配置,包括Category、Mode、CategoryOptions。
    AliRtcAudioSessionOperationRestrictionDeactivateSession SDK不能关闭AVAudioSession的活动状态,离开频道时,AVAudioSession依然处于活动状态。
  • AliRtcRenderMode:渲染模式。
    枚举名 描述
    AliRtcRenderModeAuto 自动。
    AliRtcRenderModeStretch 拉伸填充视图,不保持视频比例。
    AliRtcRenderModeFill 在保持视频宽高比的同时缩放,填充黑边。
    AliRtcRenderModeClip 在保持视频宽高比的同时缩放,并裁剪以适合视图。
  • AliRtcRenderMirrorMode:镜像模式。
    枚举名 描述
    AliRtcRenderMirrorModeOnlyFront 只有前置摄像头预览镜像,其余不镜像。
    AliRtcRenderMirrorModeAllEnabled 全部镜像。
    AliRtcRenderMirrorModeAllDisable 全部不镜像。
  • AliRtcRotationMode:旋转角度。
    枚举名 描述
    AliRtcRotationMode_0 不旋转。
    AliRtcRotationMode_90 旋转90度。
    AliRtcRotationMode_180 旋转180度。
    AliRtcRotationMode_270 旋转270度。
  • AliRtcLogLevel:日志级别。
    枚举名 描述
    AliRtcLogLevelInfo 普通。
    AliRtcLogLevelWarn 警告。
    AliRtcLogLevelError 错误。
    AliRtcLogLevelFatal 严重。
    AliRtcLogLevelNone 无。
  • AliRtcAudioNumChannel:音频声道数。
    枚举名 描述
    AliRtcMonoAudio 单声道。
    AliRtcStereoAudio 双声道。
  • AliRtcAudioSampleRate:录制音频采样率。
    枚举名 描述
    AliRtcAudioSampleRate_8000 采样率8000Hz。
    AliRtcAudioSampleRate_11025 采样率11025Hz。
    AliRtcAudioSampleRate_16000 采样率16000Hz。
    AliRtcAudioSampleRate_22050 采样率22050Hz。
    AliRtcAudioSampleRate_32000 采样率32000Hz。
    AliRtcAudioSampleRate_44100 采样率44100Hz。
    AliRtcAudioSampleRate_48000 采样率48000Hz。
  • AliRtcRecordType:录制类型。
    枚举名 描述
    AliRtcRecordTypeAudio 纯音频录制。
  • AliRtcRecordFormat:录制格式。
    枚举名 描述
    AliRtcRecordFormatAAC AAC文件。
    AliRtcRecordFormatWAV WAV文件。
  • AliRtcAudioQuality:录制音频质量。
    枚举名 描述
    AliRtcAudioQualityLow 低。
    AliRtcAudioQualityMidium 中。
    AliRtcAudioQualityHigh 高。
  • AliRtcVideoQuality:录制视频质量。
    枚举名 描述
    AliRtcVideoQualityDefault 默认和采集保持一致
  • AliRtcTranportAudioQuality:音频质量。
    枚举名 描述
    AliRtcAudioQulityUnknow 质量未知。
    AliRtcAudioQulityExcellent 质量极好。
    AliRtcAudioQulityGood 用户主观感觉和极好差不多,但码率可能略低于极好。
    AliRtcAudioQulityPoor 用户主观感受有瑕疵,但不影响沟通。
    AliRtcAudioQulityBad 勉强能沟通但不顺畅。
    AliRtcAudioQulityVeryBad 网络质量非常差,基本不能沟通。
    AliRtcAudioQulityNetworkDisconnected 网络连接已断开,完全无法沟通。
  • AliRtcAudioProfile:音频质量模式。
    枚举名 描述
    AliRtcEngineLowQualityMode 音频低音质模式。
    AliRtcEngineBasicQualityMode 标准音质模式。
    AliRtcEngineHighQualityMode 高音质模式。
    AliRtcEngineStereoHighQualityMode 立体声高音质模式。
    AliRtcEngineSuperHighQualityMode 超高音质模式。
    AliRtcEngineStereoSuperHighQualityMode 立体声超高音质模式。
  • AliRtcAudioScenario:音频场景模式。
    枚举名 描述
    AliRtcSceneDefaultMode 默认场景,一般的音视频通信场景推荐使用。
    AliRtcSceneEducationMode 教育场景,优先保证音频连续性与稳定性。
    AliRtcSceneMediaMode 媒体场景,保真人声与音乐音质,连麦直播间推荐使用。
    AliRtcSceneMusicMode 音乐场景,高保真音乐音质,乐器教学等对音乐音质有要求的场景推荐使用。
  • AliRtcMuteLocalAudioMode:本地静音模式。
    枚举名 描述
    AliRtcMuteAudioModeDefault 默认模式(静音全部,包括麦克风及外部输入音频)。
    AliRtcMuteAllAudioMode 静音全部(包括麦克风及外部输入音频)。
    AliRtcMuteOnlyMicAudioMode 只静音麦克风。
    AliRtcMuteLocalAudioMax 占位符。
  • AliRtcRecordAudioConfig:录制音频设置。
    参数 类型 描述
    sampleRate AliRtcAudioSampleRate 音频采样率。
    quality AliRtcAudioQuality 音频质量。
    enableRecordExternalRenderPCM bool 是否允许录制外部PCM输入渲染数据。
  • AliRtcRecordVideoConfig:录制视频设置。
    参数 类型 描述
    quality AliRtcVideoQuality 视频质量。
  • AliRtcBeautyConfig:基础美颜设置。
    参数 类型 描述
    whiteningLevel float 美白,取值范围:[0,1],数值越大美白效果越好。
    smoothnessLevel float 磨皮,取值范围:[0,1],数值越大磨皮效果越好。
  • AliRtcOnByeType:OnBye类型枚举。
    枚举名 描述
    AliRtcOnByeBeKickedOut 被踢出。
    AliRtcOnByeChannelTerminated 频道已结束,需要离开会议。
    AliRtcOnByeUserReplaced 相同用户ID在其他设备加入频道,当前设备被下线。
  • AliRtcAudioEffectVoiceChangerMode:变声音效模式。
    枚举名 描述
    AliRtcSdk_AudioEffect_Voice_Changer_OFF 关闭。
    AliRtcSdk_AudioEffect_Voice_Changer_Oldman 老人。
    AliRtcSdk_AudioEffect_Voice_Changer_Babyboy 男孩。
    AliRtcSdk_AudioEffect_Voice_Changer_Babygirl 女孩。
    AliRtcSdk_AudioEffect_Voice_Changer_Robot 机器人。
    AliRtcSdk_AudioEffect_Voice_Changer_Daimo 大魔王。
    AliRtcSdk_AudioEffect_Voice_Changer_Ktv KTV。
    AliRtcSdk_AudioEffect_Voice_Changer_Echo 回声。
    AliRtcSdk_AudioEffect_Voice_Changer_MAX 占位符,无含义。
  • 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 占位符,无含义。
  • AliRtcAudioRouteType:语音路由(仅iOS)。
    枚举名 描述
    AliRtcAudioRouteTypeDefault 默认的语音路由。
    AliRtcAudioRouteTypeHeadset 耳机。
    AliRtcAudioRouteTypeEarpiece 听筒。
    AliRtcAudioRouteTypeHeadsetNoMic 不带麦的耳机。
    AliRtcAudioRouteTypeSpeakerphone 手机扬声器。
    AliRtcAudioRouteTypeLoudSpeaker 外接扬声器。
    AliRtcAudioRouteTypeBlueTooth 蓝牙耳机。
  • AliVideoCanvas:渲染画布。
    参数 类型 描述
    view UIView * _Nonnull 渲染view,不可为nil。
    renderMode AliRtcRenderMode 渲染模式,默认AliRtcRenderModeAuto。
    mirrorMode AliRtcRenderMirrorMode 镜像模式。
    backgroundColor int 背景颜色,格式为RGB的Hex。
    rotationMode AliRtcRotationMode 视频旋转角度,默认不旋转。
    textureId int 纹理ID。
    textureWidth int 纹理宽。
    textureHeight int 纹理高。
  • AliRtcTrascodingLiveStreamStatus:旁路转推任务状态。
    枚举名 描述
    AliRtcMpuStateStart 旁路任务启动。
    AliRtcMpuStateUpdate 旁路任务更新。
    AliRtcMpuStateStop 旁路任务停止。
    AliRtcMpuStateEnd 旁路任务结束。
    AliRtcMpuStateConnect 旁路任务连接中。
    AliRtcMpuStateRunning 旁路任务正在运行。
    AliRtcMpuStateRecovering 旁路任务重新恢复。
    AliRtcMpuStateFailed 旁路任务失败。
    AliRtcMpuStateUnknow 旁路任务未知状态。
  • AliRtcTrascodingLiveStreamErrorCode:旁路推流错误码。
    枚举名 描述
    AliRtcTrascodingLiveStreamErrorPublishOk 推流成功。
    AliRtcTrascodingLiveStreamErrorStreamNotFound 错误:找不到流。
    AliRtcTrascodingLiveStreamErrorStreamAlreadyExist 错误:目标流已存在。
    AliRtcTrascodingLiveStreamErrorInvalidParam 错误:非法的参数。
    AliRtcTrascodingLiveStreamErrorInternalError 错误:内部错误。
    AliRtcTrascodingLiveStreamErrorRtmpServerError 错误:RTMP服务异常。
    AliRtcTrascodingLiveStreamErrorRtmpStreamUrlError 错误:URL异常。
    AliRtcTrascodingLiveStreamErrorPublishTimeout 错误:任务超时。
    AliRtcTrascodingLiveStreamErrorNotAuthorized 错误:操作未授权。
  • AliRtcWatermarkConfig:水印图片的设置。
    参数 类型 描述
    visibleInPreview BOOL 是否将水印设置为预览时本地可见。
    positionInLandscapeMode CGRect 横屏时的水印坐标。
    positionInPortraitMode CGRect 竖屏时的水印坐标。
    alpha float 透明度。
    normalized BOOL 是否归一化。
  • AliRtcCameraCapturerConfiguration:相机采集偏好属性。
    参数 类型 描述
    preference AliRtcCaptureOutputPreference 采集偏好。
    cameraDirection AliRtcCameraDirection 相机方向。
  • AliRtcCameraDirection:摄像头方向。
    枚举名 描述
    AliRtcCameraDirectionInvalid 未知。
    AliRtcCameraDirectionBack 后置摄像头。
    AliRtcCameraDirectionFront 前置摄像头。
  • AliRtcCaptureOutputPreference:摄像头采集偏好。
    枚举名 描述
    AliRtcCaptureOutputPreferenceAuto 自动调整采集参数。
    AliRtcCaptureOutputPreferencePerformance 优先保证设备性能,根据setVideoProfile设置参数选择最接近的摄像头输出参数。
    AliRtcCaptureOutputPreferencePreview 优先保证视频预览质量,选择较高的摄像头输出参数。
  • AliRtcVideoEncoderFrameRate:视频编码帧率。
    枚举名 描述
    AliRtcVideoEncoderFrameRate_FPS_5 5 FPS。
    AliRtcVideoEncoderFrameRate_FPS_10 10 FPS。
    AliRtcVideoEncoderFrameRate_FPS_15 15 FPS。
    AliRtcVideoEncoderFrameRate_FPS_20 20 FPS。
    AliRtcVideoEncoderFrameRate_FPS_30 30 FPS。
  • AliRtcVideoEncoderBitrate:视频编码码率。
    枚举名 描述
    AliRtcVideoEncoderStandardBitrate 标准码率模式。
  • AliRtcVideoEncoderMirrorMode:编码视频镜像模式。
    枚举名 描述
    AliRtcVideoEncoderMirrorModeDisabled 编码视频镜像。
    AliRtcVideoEncoderMirrorModeEnabled 编码视频不镜像。
  • AliRtcVideoEncoderOrientationMode:编码视频旋转模式。
    枚举名 描述
    AliRtcVideoEncoderOrientationModeAdaptive 自适应,和采集视频保持一致。
    AliRtcVideoEncoderOrientationModeFixedLandscape 固定横屏。
    AliRtcVideoEncoderOrientationModeFixedPortrait 固定竖屏。
  • AliRtcVideoEncoderConfiguration:视频编码偏好。
    参数 类型 描述
    dimensions CGSize 视频分辨率。
    frameRate NSInteger 视频编码帧率。
    bitrate NSInteger 视频编码码率。
    mirrorMode AliRtcVideoEncoderMirrorMode 编码视频镜像模式。
    orientationMode AliRtcVideoEncoderOrientationMode 编码视频旋转模式。
    rotationMode AliRtcRotationMode 视频旋转角度。
  • AliRtcScreenShareEncoderConfiguration:屏幕分享编码偏好。
    参数 类型 描述
    dimensions CGSize 视频分辨率。
    frameRate NSInteger 视频编码帧率。
    bitrate NSInteger 视频编码码率。
    rotationMode AliRtcRotationMode 屏幕旋转角度。
  • AliRtcAuthInfo:鉴权信息。
    参数 类型 描述
    channelId NSString * _Nonnull 频道ID。
    userId NSString * _Nonnull 用户ID。
    appId NSString * _Nonnull 应用ID。
    nonce NSString * _Nonnull 随机串。
    token NSString * _Nonnull 令牌。
    session NSString * _Nullable 会话。
    role NSString * _Nullable 角色,值为空表示不涉及此功能。取值:
    • pub:主播角色。
    • sub:观众角色。
    gslb NSArray <NSString *> * GSLB地址。
    agent NSArray <NSString *> * 设置Agent服务器的地址。
    timestamp long long 时间戳。
  • AliRtcDeviceVolumeType:设备音量类型(仅iOS)。
    枚举名 描述
    AliRtcDeviceVolumeTypeAuto SDK自动设置音量类型(默认值)。SDK内部会自动选择合适的音量类型,如无特殊需求,不推荐自行设置。
    AliRtcDeviceVolumeTypeMedia 设置为媒体音量,适合媒体播放场景,音量可以调节到零。
    AliRtcDeviceVolumeTypeVOIP 设置为通话音量,适合通话场景,音量无法调节到零。
  • AliRtcVideoSource:视频裸数据源类型。
    枚举名 描述
    AliRtcVideosourceCameraType 视频流。
    AliRtcVideosourceScreenShareType 屏幕共享流。
    AliRtcVideosourceTypeMax 占位符。
  • AliRtcAudioSource:音频裸数据源类型。
    枚举名 描述
    AliRtcAudiosourcePub 推流音频数据。
    AliRtcAudiosourceSub 拉流音频数据。
    AliRtcAudiosourceRawData 采集音频裸数据。
  • AliRtcBufferType:视频数据类型。
    枚举名 描述
    AliRtcBufferType_Raw_Data YUV裸数据。
    AliRtcBufferType_CVPixelBuffer CVPixelBuffer数据。
  • AliRtcErrorCode:错误码。
    枚举名 描述
    AliRtcErrNone 无。
    AliRtcErrJoinBadAppId App ID不存在。
    AliRtcErrJoinInvalidAppId App ID已失效。
    AliRtcErrJoinBadChannel 频道不存在。
    AliRtcErrJoinInvalidChannel 频道已失效。
    AliRtcErrJoinBadToken token不存在。
    AliRtcErrJoinTimeout 加入频道超时。
    AliRtcErrJoinBadParam 参数错误。
    AliRtcErrMicOpenFail 采集设备初始化失败。
    AliRtcErrSpeakerOpenFail 播放设备初始化失败。
    AliRtcErrMicInterrupt 采集过程中出现异常。
    AliRtcErrSpeakerInterrupt 播放过程中出现异常。
    AliRtcErrMicAuthFail 麦克风设备未授权。
    AliRtcErrMicNotAvailable 无可用的音频采集设备。
    AliRtcErrSpeakerNotAvailable 无可用的音频播放设备。
    AliRtcErrCameraOpenFail 采集设备初始化失败。
    AliRtcErrCameraInterrupt 采集过程中出现异常。
    AliRtcErrDisplayOpenFail 渲染设备初始化失败。
    AliRtcErrDisplayInterrupt 渲染过程中出现异常。
    AliRtcErrIceConnectionConnectFail 媒体通道建立失败。
    AliRtcErrIceConnectionReconnectFail 媒体通道重连失败。
    AliRtcErrIceConnectionHeartbeatTimeout 信令心跳超时。
    AliRtcErrPublishInvaild 推流无效。
    AliRtcErrPublishNotJoinChannel 未进入频道推流失败。
    AliRtcErrPublishAudioStreamFailed 推送音频流失败。
    AliRtcErrPublishVideoStreamFailed 推送视频流失败。
    AliRtcErrPublishDualStreamFailed 推送双流失败。
    AliRtcErrPublishScreenShareFailed 推送屏幕共享失败。
    AliRtcErrPublishScreenShareConfigError 屏幕共享配置错误。
    AliRtcErrSubscribeInvaild 订阅无效。
    AliRtcErrSubscribeNotJoinChannel 未进入频道订阅错误。
    AliRtcErrSubscribeAudioStreamFailed 订阅音频流失败。
    AliRtcErrSubscribeVideoStreamFailed 订阅视频流失败。
    AliRtcErrSubscribeDualStreamFailed 订阅双流失败。
    AliRtcErrSubscribeScreenShareFailed 订阅屏幕共享失败。
    AliRtcErrCdnLiveCommunicationFailed 低延时互动直播信令失败。
    AliRtcErrCdnLiveMeidaSettingFailed 低延时互动直播媒体设置错误。
    AliRtcErrCdnLiveNoneBroadcaster 低延时互动直播当前房间没有主播推流。
    AliRtcErrCdnLiveNeedRestart 低延时互动直播错误,应用层需要重新创建新的SDK实例。
    AliRtcErrCdnLiveNeedRestartAgainLater 低延时互动直播错误,应用层需要稍等一定时间(自定义间隔)重新创建新的SDK实例。
    AliRtcErrCdnLiveServiceUnavailable 低延时互动直播服务不可用或者服务降级。
    AliRtcErrCdnLiveMediaConnectionInterruption 低延时互动直播网络中断错误。
    AliRtcErrSdkInvalidState sdk状态错误。
    AliRtcErrSessionRemoved Session已经被移除。
    AliRtcErrInvalidArguments 参数不匹配。
    AliRtcErrAudioBufferFull buffer队列饱和,用于外部输送裸数据功能。
    AliRtcErrVideoBufferFull buffer队列饱和,用于外部输送裸数据功能。
    AliRtcErrUpdateRoleChannel 互动模式下设置角色错误。
    AliRtcErrInner 其他错误。
  • AliRtcTranscodingUser:旁路直播用户信息
    参数 类型 描述
    userId NSString *_Nonnull 用户ID。
  • AliRtcTranscodingUserPane:旁路直播用户窗格信息。
    参数 类型 描述
    paneId int 窗格ID。
    userId NSString *_Nonnull 用户ID。
    sourceType NSString *_Nonnull 流类型,取值:
    • camera:摄像头。
    • shareScreen:屏幕共享。
  • AliRtcTranscodingPane:旁路直播用户自定义窗格信息。
    参数 类型 描述
    paneId int 窗格ID。
    majorPane int 用户ID。
    x float 该区域相对左上角的横坐标,归一化百分比。
    y float 该区域相对左上角的纵坐标,归一化百分比。
    width float 窗格宽度。
    height float 窗格高度。
    zorder int 叠放顺序,0为最底层,1层在0层之上,以此类推。
    userId NSString *_Nonnull 用户ID。
    sourceType NSString *_Nonnull 流类型,取值:
    • camera:摄像头。
    • shareScreen:屏幕共享。
    segmentType int 人像分割类型,取值:
    • 0(默认值):无人像分割。
    • 1:人像分割,仅在虚拟背景模式有效。
  • AliRtcTranscodingLayout:旁路直播用户自定义layout信息。
    参数 类型 描述
    audioMixCount int 最大混音个数。
    panes NSArray<AliRtcTranscodingPane *> *_Nullable 自定义布局窗格参数。
  • AliRtcLiveTranscoding:旁路直播配置。
    参数 类型 描述
    mixMode int 混流模式,取值:
    • 0:单路转推,不混流转码,仅转推原始单路流,无需配置混流转码参数。
    • 1(默认值):混流转码,支持混流转码输出。
    layoutIds NSArray<NSString *> *_Nullable 布局ID数组。
    subSpecUsers NSMutableArray<AliRtcTranscodingUser *> *_Nullable 指定混流用户列表。
    userPanes NSArray<AliRtcTranscodingUserPane *> *_Nullable 用户窗格列表。
    layouts NSArray<AliRtcTranscodingLayout *> *_Nullable 用户自定义布局列表。
    taskProfile NSString *_Nullable 任务计费配置。
    backgroundColor UIColor *_Nullable 背景色RGB,默认是0(黑色)。计算公式为R + G × 256 + B × 65536,R(红)、G(绿)、B(蓝)的取值:[0,255]。
    mediaEncode int 编码选项。
    cropMode int 视频的裁剪方式,取值:
    • 1:保持比例裁剪。
    • 2(默认值):保持比例留边。
    streamType int 单路转推模式下转推音频流,取值:
    • 0(默认值):转推原始流。
    • 1:仅转推音频流。
    • 2:仅转推视频流。
    sourceType NSString *_Nullable 单路转推模式下用户视频输入流,取值:
    • camera:摄像头。
    • shareScreen:屏幕共享。
    externalParam NSString *_Nullable 拓展字段。
  • AliRtcExternalDeviceType:外接设备类型(仅Mac)。
    枚举名 描述
    AliRtcExternalTypeUnknown 未知类型。
    AliRtcExternalTypeAudioCapture 音频采集设备。
    AliRtcExternalTypeAudioPlayout 音频播放设备。
    AliRtcExternalTypeVideoCapture 视频采集设备。
  • AliRtcExternalDeviceState:外接设备状态(仅Mac)。
    枚举名 描述
    AliRtcExternalDeviceAdd 新增外接设备。
    AliRtcExternalDeviceRemove 移除外接设备。
  • AliRtcRecordVideoCanvasConfig:录制视频设置的画布大小(仅Mac)。
    参数 类型 描述
    canvasWidth int 画布的宽。
    canvasHeight int 画布的高。
  • AliRtcRecordVideoLayout:录制视频的布局信息(仅Mac)。
    参数 类型 描述
    mode AliRtcRecordVideoLayoutMode 布局模式。
    backColor AliRtcRecordVideoBgColor 背景颜色。
    shapes NSMutableArray<AliRtcRecordVideoRegion *> * _Nullable 各用户的画面位置信息。
  • AliRtcRecordVideoLayoutMode:录制视频的布局模式(仅Mac)。
    枚举名 描述
    AliRtcRecordVideoLayoutMode_GRID 窗格布局。
    AliRtcRecordVideoLayoutMode_SPEAKER 演讲布局。
    AliRtcRecordVideoLayoutMode_UNIQUE 单路布局。
    AliRtcRecordVideoLayoutMode_CUSTOM 自定义布局。
  • AliRtcRecordVideoBgColor:录制视频的背景颜色(仅Mac)。
    参数 类型 描述
    r uint8_t 颜色配比中红色的值。
    g uint8_t 颜色配比中绿色的值。
    b uint8_t 颜色配比中蓝色的值。
  • AliRtcRecordVideoRegion:录制布局的用户画面配置信息(仅Mac)。
    参数 类型 描述
    userId NSString * _Nonnull 用户ID。
    sourceType AliRtcVideoSource 视频裸数据源类型。
    area AliRtcRecordVideoRectangle 用户画面的位置信息。
  • AliRtcRecordVideoRectangle:用户画面的位置信息(仅Mac)。
    参数 类型 描述
    left AliRtcRecordVideoRational 左边距。
    top AliRtcRecordVideoRational 上边距。
    width AliRtcRecordVideoRational 宽度。
    height AliRtcRecordVideoRational 高度。
  • AliRtcRecordVideoRational:混流录制坐标(仅Mac)。
    参数 类型 描述
    numerator uint32_t 分子(整数)。
    denominator uint32_t 分母(整数)。
  • AliRtcRecordTemplate:录制模板(仅Mac)。
    参数 类型 描述
    recordType AliRtcRecordType 录制类型。
    recordFormat AliRtcRecordFormat 录制格式。
    sampleRate AliRtcAudioSampleRate 录制音频采样率。
    audioQuality AliRtcAudioQuality 录制音频质量。
    enableRecordExternalCapturePCM bool 是否混音录制外部输入音频。
    enableRecordExternalRenderPCM bool 是否混音录制外部输入渲染后的音频。
    canvas AliRtcRecordVideoCanvasConfig 录制视频的画布大小。
    fps int 帧率。
    bitrate int 码率。
    isFragment bool 是否录制分段mp4,默认true。
  • AliRtcDeviceInfo:设备信息(仅Mac)。
    参数 类型 描述
    deviceName NSString * _Nullable 设备名称。
    deviceID NSString * _Nullable 设备ID。
  • AliRtcScreenShareConfig:屏幕分享配置(仅Mac)。
    参数 类型 描述
    isShareByRegion bool 是否是区域分享。
    shareRegion AliRtcScreenShareRegion * _Nonnull 区域分享的布局信息。
  • AliRtcScreenShareRegion:屏幕分享区域(仅Mac)。
    参数 类型 描述
    originX float x坐标。
    originY float y坐标。
    width float 宽度。
    height float 高度。
  • AliRtcScreenSourceInfo:屏幕分享源信息(仅Mac)。
    参数 类型 描述
    sourceId NSString * _Nonnull 分享源ID。
    sourceName NSString * _Nonnull 分享源名称。
  • AliRtcScreenShareInfo:屏幕分享配置信息(仅Mac)。
    参数 类型 描述
    sourceType AliRtcScreenShareType 分享类型。
    sourceId NSString * _Nonnull 分享源ID。
    config AliRtcScreenShareConfig * _Nonnull 屏幕分享配置。
  • AliRtcScreenShareType:屏幕分享类型(仅Mac)。
    枚举名 描述
    AliRtcScreenShareDesktop 桌面分享。
    AliRtcScreenShareWindow 窗口分享。