数据结构

目录

详情

• 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	音频数据指针。
  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	AliRtcVideoTrack	音频流类型。
  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	接受端到网络抖动缓存的网络延时，单位：毫秒。

• AliRtcVideoObserPosition：视频数据输出位置。

  枚举名	描述
  AliRtcPositionPostCapture	采集视频数据，对应输出回调onCaptureVideoSample。
  AliRtcPositionPreRender	渲染视频数据，对应输出回调onCaptureVideoSample。
  AliRtcPositionPreEncoder	编码前视频数据，对应输出回调onCaptureVideoSample。

• 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：网络连接状态变更原因。

  枚举名	描述
  AliRtcConnectionChangedDummyReason	未知原因。
  AliRtcConnectionChangedMediaPathChanged	媒体通道变更。
  AliRtcConnectionChangedSignalingHeartbeatTimeout	心跳超时。
  AliRtcConnectionChangedSignalingHeartbeatAlive	心跳恢复。
  AliRtcConnectionChangedSignalingHttpdnsResolved	DNS解析成功。
  AliRtcConnectionChangedSignalingHttpdnsFailure	DNS解析失败。
  AliRtcConnectionChangedSignalingGslbFailure	GSLB请求失败。
  AliRtcConnectionChangedSignalingGslbSucccess	GSLB请求成功。
  AliRtcConnectionChangedSignalingJoinChannelFailure	加入频道失败。
  AliRtcConnectionChangedSignalingJoinChannelSuccess	加入频道成功。
  AliRtcConnectionChangedSignalingLeaveRoom	离开频道。
  AliRtcConnectionChangedSignalingConnecting	信令建立连接。

• 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	音乐场景，高保真音乐音质，乐器教学等对音乐音质有要求的场景推荐使用。
  AliRtcSceneChatroomMode	聊天室场景，适用于频繁上下麦的聊天场景。

• 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	镜像模式。默认AliRtcRenderMirrorModeOnlyFront。
  backgroundColor	int	背景颜色，格式为RGB的Hex。
  rotationMode	AliRtcRotationMode	视频旋转角度，默认不旋转。
  textureId	int	纹理ID。
  textureWidth	int	纹理宽。
  textureHeight	int	纹理高。

• 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	相机方向。
  fps	int	指定摄像头的采集预览帧率，通过设置此参数，可以实现预览帧率和编码帧率不同，编码帧率设置参见：AliRtcVideoEncoderConfiguration中的frameRate

• 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	令牌。
  gslb	NSArray <NSString *> *	GSLB地址。
  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	其他错误。

• 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	演讲布局。
  AliRtcRecordVideoayoutMode_UNIQUE	单路布局。
  AliRtcRecordVideoLyoutMode_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	宽度。
  heigh	foat	高度。

• AliRtcScreenSourceInfo：屏幕分享源信息（仅Mac）。

  参数	类型	描述
  sourceId	NSString * _Nonnull	分享源ID。
  sourceName	NSString * _Nonnull	分享源名称。

• AliRtcScreenShareInfo：屏幕分享配置信息（仅Mac）。

  参数	类型	描述
  sourceType	AliRtcScreenShareType	分享类型。
  sourceId	NSString * _Nonnull	分享源ID。
  config	configAliRtcScreenShareConfig * _Nonnull	屏幕分享配置。

• AliRtcScreenShareType：屏幕分享类型（仅Mac）。

  枚举名	描述
  AliRtcScreenShareDesktop	桌面分享。
  AliRtcScreenShareWindow	窗口分享。

• AliRtcVideoObserAlignment：视频输出宽度对齐方式。

  枚举名	描述
  AliRtcAlignmentDefault	保持原有视频宽度（默认值）。
  AliRtcAlignmentEven	宽度偶数对齐。
  AliRtcAlignment4	宽度是4的倍数。
  AliRtcAlignment8	宽度是8的倍数。
  AliRtcAlignment16	宽度是16的倍数。

• AliRtcShowDebugViewType：显示仪表盘类型。

  枚举名	描述
  AliRtcShowTypeNone	不显示。
  AliRtcShowTypeAudio	音频。
  AliRtcShowTypeVideo	视频。
  AliRtcShowTypeNetwork	网络。
  AliRtcShowTypeAll	全部。

• AliRtcTrascodingLiveTaskStatus：旁路推流LiveStream状态。

  枚举名	描述
  AliRtcTrascodingLiveTaskStatusStart	任务开始。
  AliRtcTrascodingLiveTaskStatusUpdate	任务更新。
  AliRtcTrascodingLiveTaskStatusStop	任务已停止。

• AliRtcLiveTranscodingDisplayType：旁路直播图片显示类型。

  枚举名	描述
  NOT_DISPLAY	不显示。
  ALWAYS	一直显示。
  WHEN_NO_VIDEO	当没有视频时候显示。

• AliRtcLiveTranscodingFontType：旁路直播文字类型。

  枚举名	描述
  NOTO_SERIF_CJKSC_REGULAR	思源宋体NotoSerifCJKsc-REGULAR。
  ALIBABA_PUHUITI_REGULAR	阿里巴巴-普惠体-REGULAR。
  ALIBABA_PUHUITI_BOLD	阿里巴巴-普惠体-BOLD。
  ALIBABA_PUHUITI_Heavy	阿里巴巴-普惠体-Heavy。
  ALIBABA_PUHUITI_LIGHT	阿里巴巴-普惠体-LIGHT。
  ALIBABA_PUHUITI_MEDIUM	阿里巴巴-普惠体-MEDIUM。

• AliRtcLiveTranscodingSegmentType：旁路直播分割类型。

  枚举名	描述
  AliRtcLiveTranscodingNoBody	无人像分割。
  AliRtcLiveTranscodingBody	人像分割。

• AliRtcLiveTranscodingSourceType：旁路直播输入类型。

  枚举名	描述
  AliRtcLiveTranscodingCamera	相机。
  AliRtcLiveTranscodingShareScreen	共享屏幕。

• AliRtcVideoState：视频流状态变化。

  枚举名	描述
  AliRtcVideoVideoClose	关闭视频流。
  AliRtcVideoVideoOpen	恢复视频流。

• AliRtcVideoReason：触发视频流状态变化的原因。

  枚举名	描述
  AliRTCVideoChangedByClient	客户端。
  AliRTCVideoChangedByServer	服务器。

• AliRtcLiveTranscodingCropMode：旁路直播裁剪模式。

  枚举名	描述
  AliRtcLiveTranscodingCrop	保持比例裁剪。
  AliRtcLiveTranscodingFill	保持比例留边（默认值）。

• AliRtcLiveTranscodingMediaProcessMode：旁路直播媒体处理模式。

  枚举名	描述
  AliRtcLiveTranscodingNormal	通用模式。
  AliRtcLiveTranscodingVirtualBackground	虚拟背景模式。

• AliRtcLiveTranscodingStreamType：旁路直播转推流类型。

  枚举名	描述
  AliRtcLiveTranscodingOrigin	转推原始流。
  AliRtcLiveTranscodingAudio	仅转推音频流。
  AliRtcLiveTranscodingVideo	仅转推视频流。

• AliRtcLiveTranscodingMixMode：旁路直播模式。

  枚举名	描述
  AliRtcLiveTranscodingSINGLE	单路转推，不混流转码，仅转推原始单路流，无需配置混流转码参数。
  AliRtcLiveTranscodingMIX	混流转码（默认值），支持混流转码输出。

• AliRtcLiveTranscodingState：旁路直播状态。

  枚举名	描述
  AliRtcLiveTranscodingState_IDLE	推流空闲。
  AliRtcLiveTranscodingState_CONNNECT	正在连接推流服务器。
  AliRtcLiveTranscodingState_RUNNING	推流正在进行。
  AliRtcLiveTranscodingState_RECOVERING	正在恢复推流。
  AliRtcLiveTranscodingState_FAILURE	推流失败。
  AliRtcLiveTranscodingState_END	推流结束。

• AliRtcLiveTranscodingText：旁路直播文本信息。

  参数	类型	描述
  text	NSString	文本信息。
  x	int	坐标X（像素）。
  y	int	坐标Y（像素）。
  fontType	AliRtcLiveTranscodingFontType	旁路直播字体。
  fontSize	int	字体大小。
  zOrder	int	叠放顺序，0为最底层，1层在0层之上，以此类推。
  fontColor	int	字体颜色。

• AliRtcLiveTranscodingImage：旁路直播图片信息。

  参数	类型	描述
  url	NSString	图片URL。
  alpha	float	透明度。0.0表示透明，1.0表示完全不透明。
  display	AliRtcLiveTranscodingDisplayType	图片显示。
  x	int	坐标X（像素）。
  y	int	坐标Y（像素）。
  width	int	图片宽。
  height	int	图片高。
  zOrder	it	叠放顺序，0为最底层，1层0层之上，以此类推。

• AliRtcLiveTranscodingPane：旁路直播用户自定义窗格信息

  参数	类型	描述
  x	int	坐标X（像素）。
  y	int	坐标Y（像素）。
  width	int	窗格宽。
  height	int	窗格高。
  zOrder	int	叠放顺序，0为最底层，1层在0层之上，以此类推。
  userId	NSString *	用户ID。
  sourceType	AliRtcLiveTranscodingSourceType	流类型。
  segmentType	AliRtcLiveTranscodingSegmentType	旁路直播分割类型。
  images	NSArray<AliRtcLiveTranscodingImage *> *	旁路直播图片信息。
  texts	NSArray<AliRtcLiveTranscodingText *> *	旁路直播文本信息。

• AliRtcLiveTranscodingParam：旁路直播配置。

  参数	类型	描述
  mixMode	AliRtcLiveTranscodingMixMode	旁路直播模式。
  singleParam	AliRtcLiveTranscodingSingleParam	旁路直播单流参数。
  mixParam	AliRtcLiveTranscodingMixParam	旁路直播混流参数。

• AliRtcLiveTranscodingMixParam：旁路模式混流参数。

  参数	类型	描述
  taskProfile	AliRtcLiveTranscodingTaskProfile	旁路直播计费规格。
  encodeParam	AliRtcLiveTranscodingEncodeParam	旁路直播编码参数。
  users	NSArray<AliRtcLiveTranscodingPane *> *	旁路直播用户列表。
  backgroundColor	int	背景色。
  backgrounds	NSArray<AliRtcLiveTranscodingImage *> *	背景图片列表。
  watermarks	NSArray<AliRtcLiveTranscodingImage *> *	水印图片列表。
  clockWidgets	NSArray<AliRtcLiveTranscodingClockWidget *> *	时钟小部件列表。
  cropMode	AliRtcLiveTranscodingCropMode	旁路直播裁剪模式。
  mediaProcessMode	AliRtcLiveTranscodingMediaProcessMode	旁路直播媒体处理模式。

• AliRtcLiveTranscodingSingleParam：旁路模式单路参数。

  参数	类型	描述
  userId	NSString *	用户ID。
  streamType	AliRtcLiveTranscodingStreamType	旁路直播转推流类型。
  sourceType	AliRtcLiveTranscodingSourceType	旁路直播视频流类型。

• AliRtcLiveTranscodingTaskProfile：旁路直播计费规格。

  枚举名	描述
  AliRtcLiveTranscoding_Profile_1IN_1080P	1IN_1080P。
  AliRtcLiveTranscoding_Profile_1IN_720P	1IN_720P。
  AliRtcLiveTranscoding_Profile_1IN_360P	1IN_360P。
  AliRtcLiveTranscoding_Profile_2IN_1080P	2IN_1080P。
  AliRtcLiveTranscoding_Profile_2IN_720P	2IN_720P。
  AliRtcLiveTranscoding_Profile_2IN_360P	2IN_360P。
  AliRtcLiveTranscoding_Profile_4IN_1080P	4IN_1080P。
  AliRtcLiveTranscoding_Profile_4IN_720P	4IN_720P。
  AliRtcLiveTranscoding_Profile_4IN_360P	4IN_360P。
  AliRtcLiveTranscoding_Profile_9IN_1080P	9IN_1080P。
  AliRtcLiveTranscoding_Profile_9IN_720P	9IN_720P。
  AliRtcLiveTranscoding_Profile_9IN_360P	9IN_360P。
  AliRtcLiveTranscoding_Profile_12IN_1080P	12IN_1080P。
  AliRtcLiveTranscoding_Profile_12IN_720P	12IN_720P。
  AliRtcLiveTranscoding_Profile_12IN_360P	12IN_360P。
  AliRtcLiveTranscoding_Profile_16IN_1080P	16IN_1080P。
  AliRtcLiveTranscoding_Profile_16IN_720P	16IN_720P。
  AliRtcLiveTranscoding_Profile_16IN_360P	16IN_360P。
  AliRtcLiveTranscoding_Profile_Mixed	纯音频。

• AliRtcLiveTranscodingEncodeParam：旁路直播编码参数。

  参数	类型	描述
  videoWidth	int	宽。
  videoHeight	int	高。
  videoFramerate	int	帧率。
  videoBitrate	int	码率。
  videoGop	int	GOP。
  audioSamplerate	AliRtcLiveTranscodingAudioSampleRate	旁路直播音频采样率。
  audioBitrate	int	音频码率。
  audioChannels	int	音频声道数。

• AliRtcLiveTranscodingAudioSampleRate：旁路直播音频采样率。

  枚举名	描述
  AliRtcLiveTranscoding_HZ_48000	采样率48000Hz。
  AliRtcLiveTranscoding_HZ_44100	采样率44100Hz。
  AliRtcLiveTranscoding_HZ_32000	采样率32000Hz。
  AliRtcLiveTranscoding_HZ_16000	采样率16000Hz。
  AliRtcLiveTranscoding_HZ_8000	采样率8000Hz。

• AliRtcLiveTranscodingClockWidget：旁路直播时钟小工具。

  参数	类型	描述
  x	int	坐标X（像素）。
  y	int	坐标Y（像素）。
  fontSize	int	旁路直播字体大小。
  zOrder	int	叠放顺序，0为最底层，1层在0层之上，以此类推。
  fontColor	int	旁路直播字体颜色。
  fontType	AliRtcLiveTranscodingFontType	旁路直播字体。

• AliRtcBokehScaleModel：背景替换缩放模式（仅Mac）。

  枚举名	描述
  AliRtcBokehScaleModelCrop	等比裁剪。
  AliRtcBokehScaleModelFill	填充黑边。

• AliRtcAudioPlayingStateCode：音乐伴奏播放状态（仅Mac）。

  枚举名	描述
  AliRtcAudioPlayingStarted	开始播放。
  AliRtcAudioPlayingStopped	停止播放。
  AliRtcAudioPlayingPaused	播放暂停。
  AliRtcAudioPlayingResumed	播放恢复。
  AliRtcAudioPlayingEnded	播放完毕。
  AliRtcAudioPlayingBuffering	正在缓冲。
  AliRtcAudioPlayingBufferingEnd	缓冲结束。
  AliRtcAudioPlayingFailed	播放失败。

• AliRtcAudioPlayingErrorCode：音乐伴奏播放错误码（仅Mac）。

  枚举名	描述
  AliRtcAudioPlayingNoError	没有错误。
  AliRtcAudioPlayingOpenFailed	打开文件错误。
  AliRtcAudioPlayingDecodeFailed	解码文件错误。