AliRTCSdk v2.5
阿里云实时音视频 SDK，覆盖在全球范围内的实时音视频开发平台，为您提供高可用、高品质、超低延时的音视频通信服务。
类 | 枚举
iOS关键类型定义

类

struct  AliRtcRecordAudioConfig
 
struct  AliRtcRecordVideoConfig
 
class  AliRtcBeautyConfig
 
struct  AliRtcStats
 
class  AliRtcLocalVideoStats
 
class  AliRtcRemoteVideoStats
 
class  AliRtcLocalAudioStats
 
class  AliRtcRemoteAudioStats
 
class  AliRtcUserVolumeInfo
 
class  AliRtcAuthInfo
 
class  AliVideoCanvas
 
class  AliRtcWatermarkConfig
 
class  AliRtcAudioDataSample
 
class  AliRtcVideoDataSample
 
class  AliRtcChannelRelayConfiguration
 
class  AliRtcMessage
 
class  AliRtcMessageResponse
 
class  AliRtcCameraCapturerConfiguration
 
class  AliRtcLiveTranscodingImage
 
class  AliRtcLiveTranscodingText
 
class  AliRtcLiveTranscodingPane
 
class  AliRtcLiveTranscodingClockWidget
 
class  AliRtcLiveTranscodingEncodeParam
 
class  AliRtcLiveTranscodingSingleParam
 
class  AliRtcLiveTranscodingMixParam
 
class  AliRtcLiveTranscodingParam
 
class  AliRtcVideoEncoderConfiguration
 
class  AliRtcScreenShareEncoderConfiguration
 
class  AliRtcVideoExternalEncoderParameter
 

枚举

enum  AliRtcPluginErrorCode
 
enum  AliRtcPluginDataType
 
enum  AliRtcPluginOperationType
 
enum  AliRtcVideoTrack : NSUInteger
 
enum  AliRtcAudioTrack : NSUInteger
 
enum  AliRtcNetworkQuality : NSUInteger
 
enum  AliRtcTranportAudioQuality : NSInteger
 
enum  AliRtcAudioProfile : NSInteger
 
enum  AliRtcAudioScenario : NSInteger
 
enum  AliRtcRenderMode : NSUInteger
 
enum  AliRtcLogLevel : NSUInteger
 
enum  AliRtcVideoEncoderFrameRate : NSInteger
 
enum  AliRtcVideoEncoderBitrate : NSInteger
 
enum  AliRtcVideoEncoderMirrorMode : NSInteger
 
enum  AliRtcRotationMode : NSInteger
 
enum  AliRtcVideoEncoderOrientationMode : NSInteger
 
enum  AliRtcOrientationMode : NSInteger
 
enum  AliRtcAudioSessionOperationRestriction : NSInteger
 
enum  AliRtcVideoStreamType : NSInteger
 
enum  AliRtcDeviceVolumeType : NSInteger
 
enum  AliRtcVideoSource : NSInteger
 
enum  AliRtcAudioSource : NSInteger
 
enum  AliRtcVideoFormat : NSInteger
 
enum  AliRtcBufferType : NSInteger
 
enum  AliRtcAudioNumChannel : NSInteger
 
enum  AliRtcRecordingQuality : NSInteger
 
enum  AliRtcAudioEffectVoiceChangerMode : NSInteger
 
enum  AliRtcAudioEffectReverbMode : NSInteger
 
enum  AliRtcAudioEffectReverbParamType : NSInteger
 
enum  AliRtcConnectionStatus : NSInteger
 
enum  AliRtcConnectionStatusChangeReason : NSInteger
 
enum  AliRtcChannelProfile : NSInteger
 
enum  AliRtcClientRole : NSInteger
 
enum  AliRtcMuteLocalAudioMode : NSInteger
 
enum  AliRtcRenderMirrorMode : NSInteger
 
enum  AliRtcAudioPlayingStateCode : NSInteger
 
enum  AliRtcAudioPlayingErrorCode : NSInteger
 
enum  AliRtcRecordType : NSUInteger
 
enum  AliRtcRecordFormat : NSUInteger
 
enum  AliRtcAudioQuality : NSUInteger
 
enum  AliRtcVideoQuality : NSUInteger
 
enum  AliRtcAudioSampleRate : NSInteger
 
enum  AliRtcAudioRouteType : NSInteger
 
enum  AliRtcVideoObserPosition : NSInteger
 
enum  AliRtcVideoObserAlignment
 
enum  AliRtcShowDebugViewType : NSInteger
 
enum  AliRtcScreenShareMode : NSInteger
 
enum  AliRtcErrorCode : NSInteger
 
enum  AliRtcOnByeType : NSInteger
 
enum  AliRtcFeedbackType : NSInteger
 
enum  AliRtcTrascodingLiveTaskStatus : NSInteger
 
enum  AliRtcTrascodingLiveStreamErrorCode : NSInteger
 
enum  AliRtcChannelRelayEvent : NSInteger
 
enum  AliRtcChannelRelayState : NSInteger
 
enum  AliRtcCaptureOutputPreference : NSInteger
 
enum  AliRtcCameraDirection : NSInteger
 
enum  AliRtcPublishState : NSInteger
 
enum  AliRtcSubscribeState : NSInteger
 
enum  AliRtcUserOfflineReason : NSInteger
 
enum  AliRtcBokehScaleModel : NSUInteger
 
enum  AliRtcLiveTranscodingDisplayType : NSUInteger
 
enum  AliRtcLiveTranscodingFontType : NSUInteger
 
enum  AliRtcLiveTranscodingSegmentType : NSUInteger
 
enum  AliRtcLiveTranscodingSourceType : NSUInteger
 
enum  AliRtcLiveTranscodingState : NSUInteger
 
enum  AliRtcLiveTranscodingMixMode : NSUInteger
 
enum  AliRtcLiveTranscodingStreamType : NSUInteger
 
enum  AliRtcLiveTranscodingMediaProcessMode : NSUInteger
 
enum  AliRtcLiveTranscodingCropMode : NSUInteger
 
enum  AliRtcLiveTranscodingAudioSampleRate : NSUInteger
 
enum  AliRtcLiveTranscodingTaskProfile : NSUInteger
 
enum  AliRtcVideoState : NSInteger
 
enum  AliRtcVideoReason : NSInteger
 
enum  AliRtcVideoEncodedFrameType : NSInteger
 

详细描述

AliRTC功能的插件扩展

类说明

◆ AliRtcRecordAudioConfig

struct AliRtcRecordAudioConfig

Public 属性

AliRtcAudioSampleRate sampleRate
 
AliRtcAudioQuality quality
 
bool enableRecordExternalRenderPCM
 
bool enableRecordExternalCapturePCM
 

类成员变量说明

◆ sampleRate

AliRtcAudioSampleRate AliRtcRecordAudioConfig::sampleRate

音频采样率类型

音频采样率类型

◆ quality

AliRtcAudioQuality AliRtcRecordAudioConfig::quality

音频录制质量

音频录制质量

◆ enableRecordExternalRenderPCM

bool AliRtcRecordAudioConfig::enableRecordExternalRenderPCM

是否允许录制外部pcm输入渲染数据

是否允许录制外部pcm输入渲染数据

◆ AliRtcRecordVideoConfig

struct AliRtcRecordVideoConfig

Public 属性

AliRtcVideoQuality quality
 
AliRtcRecordType sourceType
 
AliRtcRecordVideoCanvasConfig canvas
 
int fps
 
int bitrate
 

类成员变量说明

◆ quality

AliRtcVideoQuality AliRtcRecordVideoConfig::quality

视频质量

视频质量

◆ AliRtcBeautyConfig

class AliRtcBeautyConfig

继承自 NSObject , 以及 NSObject .

属性

float whiteningLevel
 
float smoothnessLevel
 

属性说明

◆ whiteningLevel

- (float) whiteningLevel
readwritenonatomicassign

美白等级，建议取值范围[0-1.0]

美白等级，建议取值范围[0-1.0]

◆ smoothnessLevel

- (float) smoothnessLevel
readwritenonatomicassign

磨皮等级，建议取值范围[0-1.0]

磨皮等级，建议取值范围[0-1.0]

◆ AliRtcStats

struct AliRtcStats

Public 属性

long long available_sent_kbitrate
 
long long sent_kbitrate
 
long long rcvd_kbitrate
 
long long sent_bytes
 
long long rcvd_bytes
 
long long video_rcvd_kbitrate
 
long long video_sent_kbitrate
 
long long call_duration
 
float cpu_usage
 
float systemCpuUsage
 
long long sent_loss_rate
 
long 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
 

类成员变量说明

◆ available_sent_kbitrate

long long AliRtcStats::available_sent_kbitrate

可用带宽(kb)

可用带宽(kb)

◆ sent_kbitrate

long long AliRtcStats::sent_kbitrate

总发送码率(kb)

总发送码率(kb)

◆ rcvd_kbitrate

long long AliRtcStats::rcvd_kbitrate

总接收码率(kb)

总接收码率(kb)

◆ sent_bytes

long long AliRtcStats::sent_bytes

总发送数据量(bytes)

总发送数据量(bytes)

◆ rcvd_bytes

long long AliRtcStats::rcvd_bytes

总接收数据量(bytes)

总接收数据量(bytes)

◆ video_rcvd_kbitrate

long long AliRtcStats::video_rcvd_kbitrate

视频接受码率(kb)

视频接受码率(kb)

◆ video_sent_kbitrate

long long AliRtcStats::video_sent_kbitrate

视频发送码率(kb)

视频发送码率(kb)

◆ call_duration

long long AliRtcStats::call_duration

通话时长(s)

通话时长(s)

◆ cpu_usage

float AliRtcStats::cpu_usage

进程CPU使用量(%)

进程CPU使用量(%)

◆ systemCpuUsage

float AliRtcStats::systemCpuUsage

系统CPU使用量(%)

系统CPU使用量(%)

◆ sent_loss_rate

long long AliRtcStats::sent_loss_rate

客户端到服务器的丢包率(%)

客户端到服务器的丢包率(%)

◆ sent_loss_pkts

long long AliRtcStats::sent_loss_pkts

客户端到服务器的丢包数

客户端到服务器的丢包数

◆ sent_expected_pkts

long long AliRtcStats::sent_expected_pkts

客户端到服务器的总包数

客户端到服务器的总包数

◆ rcvd_loss_rate

long long AliRtcStats::rcvd_loss_rate

服务器到客户端的下行丢包率（）

服务器到客户端的下行丢包率（）

◆ rcvd_loss_pkts

long long AliRtcStats::rcvd_loss_pkts

服务器到客户端的下行丢包数

服务器到客户端的下行丢包数

◆ rcvd_expected_pkts

long long AliRtcStats::rcvd_expected_pkts

服务器到客户端的下行总包数

服务器到客户端的下行总包数

◆ lastmile_delay

long long AliRtcStats::lastmile_delay

客户端到服务器的延迟(ms)

客户端到服务器的延迟(ms)

◆ AliRtcLocalVideoStats

class AliRtcLocalVideoStats

继承自 NSObject , 以及 NSObject .

属性

AliRtcVideoTrack track
 
unsigned int target_encode_bitrate
 
unsigned int actual_encode_bitrate
 
unsigned int sent_bitrate
 
unsigned int capture_fps
 
unsigned int sent_fps
 
unsigned int encode_fps
 
unsigned int avg_qp
 

属性说明

◆ track

- (AliRtcVideoTrack) track
readwritenonatomicassign

视频流track类型

◆ target_encode_bitrate

- (unsigned int) target_encode_bitrate
readwritenonatomicassign

目标编码码率

◆ actual_encode_bitrate

- (unsigned int) actual_encode_bitrate
readwritenonatomicassign

实际编码码率

◆ sent_bitrate

- (unsigned int) sent_bitrate
readwritenonatomicassign

发送码率

◆ capture_fps

- (unsigned int) capture_fps
readwritenonatomicassign

采集帧率

◆ sent_fps

- (unsigned int) sent_fps
readwritenonatomicassign

发送帧率

◆ encode_fps

- (unsigned int) encode_fps
readwritenonatomicassign

编码帧率

◆ avg_qp

- (unsigned int) avg_qp
readwritenonatomicassign

每秒平均QP

◆ AliRtcRemoteVideoStats

class AliRtcRemoteVideoStats

继承自 NSObject , 以及 NSObject .

属性

NSString *_Nonnull userId
 
AliRtcVideoTrack track
 
unsigned int width
 
unsigned int height
 
unsigned int decode_fps
 
unsigned int render_fps
 
unsigned int frozen_times
 

属性说明

◆ userId

- (NSString *_Nonnull) userId
readwritenonatomiccopy

远端用户userID

◆ track

- (AliRtcVideoTrack) track
readwritenonatomicassign

视频流track类型

◆ width

- (unsigned int) width
readwritenonatomicassign

宽度

◆ height

- (unsigned int) height
readwritenonatomicassign

height

◆ decode_fps

- (unsigned int) decode_fps
readwritenonatomicassign

解码帧率

◆ render_fps

- (unsigned int) render_fps
readwritenonatomicassign

渲染帧率

◆ frozen_times

- (unsigned int) frozen_times
readwritenonatomicassign

卡顿次数

◆ AliRtcLocalAudioStats

class AliRtcLocalAudioStats

继承自 NSObject , 以及 NSObject .

属性

AliRtcAudioTrack track
 
unsigned int num_channel
 
unsigned int sent_samplerate
 
unsigned int sent_bitrate
 

属性说明

◆ track

- (AliRtcAudioTrack) track
readwritenonatomicassign

音频流track类型

◆ num_channel

- (unsigned int) num_channel
readwritenonatomicassign

声道数

◆ sent_samplerate

- (unsigned int) sent_samplerate
readwritenonatomicassign

采样率

◆ sent_bitrate

- (unsigned int) sent_bitrate
readwritenonatomicassign

发送端音频的瞬时码率（Kbps）

◆ AliRtcRemoteAudioStats

class AliRtcRemoteAudioStats

音频统计信息

继承自 NSObject , 以及 NSObject .

属性

NSString *_Nonnull userId
 
AliRtcAudioTrack track
 
unsigned int quality
 
unsigned int audio_loss_rate
 
unsigned int rcvd_bitrate
 
unsigned int total_frozen_times
 
unsigned int network_transport_delay
 
unsigned int jitter_buffer_delay
 

属性说明

◆ userId

- (NSString *_Nonnull) userId
readwritenonatomiccopy

远端用户ID

◆ track

- (AliRtcAudioTrack) track
readwritenonatomicassign

音频流track类型

◆ quality

- (unsigned int) quality
readwritenonatomicassign

远端用户发送的音频流质量, 具体类型参看 AliRtcTranportAudioQuality

◆ audio_loss_rate

- (unsigned int) audio_loss_rate
readwritenonatomicassign

回调周期内的音频丢帧率

◆ rcvd_bitrate

- (unsigned int) rcvd_bitrate
readwritenonatomicassign

接收流的瞬时码率（Kbps）

◆ total_frozen_times

- (unsigned int) total_frozen_times
readwritenonatomicassign

远端用户加入频道后音频卡顿的累计时长 (ms)

◆ network_transport_delay

- (unsigned int) network_transport_delay
readwritenonatomicassign

发送端到接收端的网络延时（ms)

◆ jitter_buffer_delay

- (unsigned int) jitter_buffer_delay
readwritenonatomicassign

接受端到网络抖动缓存的网络延时（ms)

◆ AliRtcUserVolumeInfo

class AliRtcUserVolumeInfo

继承自 NSObject , 以及 NSObject .

属性

NSString *_Nonnull uid
 
BOOL speech_state
 
int volume
 

属性说明

◆ uid

- (NSString *_Nonnull) uid
readwritenonatomiccopy

发言人的用户ID

发言人的用户ID

◆ speech_state

- (BOOL) speech_state
readwritenonatomicassign

发言状态，YES：正在说话，NO：没有说话

发言状态，YES：正在说话，NO：没有说话

◆ volume

- (int) volume
readwritenonatomicassign

音量值，取值范围[0,255]

音量值，取值范围[0,255]

◆ AliRtcAuthInfo

class AliRtcAuthInfo

入会鉴权参数

继承自 NSObject , 以及 NSObject .

属性

NSString *_Nonnull channelId
 
NSString *_Nonnull userId
 
NSString *_Nonnull appId
 
NSString *_Nonnull nonce
 
NSString *_Nonnull token
 
NSString *_Nullable session
 
NSString *_Nullable role
 
NSArray< NSString * > *_Nullable gslb
 
NSArray< NSString * > *_Nullable agent
 
long long timestamp
 

◆ AliVideoCanvas

class AliVideoCanvas

继承自 NSObject , 以及 NSObject .

属性

UIView *_Nonnull view
 
AliRtcRenderMode renderMode
 
AliRtcRenderMirrorMode mirrorMode
 
int backgroundColor
 
AliRtcRotationMode rotationMode
 
NSView *_Nonnull view
 
AliRtcRotationMode rotation
 

属性说明

◆ view

- (UIView* _Nonnull) view
readwritenonatomicstrong

显示视图

◆ renderMode

- (AliRtcRenderMode) renderMode
readwritenonatomicassign

渲染模式，默认值为 AliRtcRenderModeAuto

渲染模式，默认值为 AliRtcRenderModeAuto

◆ mirrorMode

- (AliRtcRenderMirrorMode) mirrorMode
readwritenonatomicassign

镜像模式，默认值为 AliRtcRenderMirrorModeAllDisabled

镜像模式，默认值为 AliRtcRenderMirrorModeAllDisabled

◆ backgroundColor

- (int) backgroundColor
readwritenonatomicassign

背景颜色，格式为RGB的Hex

背景颜色，格式为RGB的Hex

◆ rotationMode

- (AliRtcRotationMode) rotationMode
readwritenonatomicassign

旋转角度，默认值为 AliRtcRotationMode_0

◆ AliRtcWatermarkConfig

class AliRtcWatermarkConfig

继承自 NSObject , 以及 NSObject .

属性

BOOL visibleInPreview
 
CGRect positionInPortraitMode
 
CGRect positionInLandscapeMode
 
float alpha
 
BOOL normalized
 
NSRect positionInPortraitMode
 
NSRect positionInLandscapeMode
 

属性说明

◆ visibleInPreview

- (BOOL) visibleInPreview
readwritenonatomicassign

预览水印是否可见

预览水印是否可见

◆ positionInPortraitMode

- (CGRect) positionInPortraitMode
readwritenonatomicassign

竖屏水印坐标信息

◆ positionInLandscapeMode

- (CGRect) positionInLandscapeMode
readwritenonatomicassign

横屏水印坐标信息

◆ alpha

- (float) alpha
readwritenonatomicassign

水印透明度

水印透明度

◆ normalized

- (BOOL) normalized
readwritenonatomicassign

归一化

归一化

◆ AliRtcAudioDataSample

class AliRtcAudioDataSample

音频数据采样

继承自 NSObject , 以及 NSObject .

属性

long dataPtr
 
int numOfSamples
 
int bytesPerSample
 
int numOfChannels
 
int samplesPerSec
 

◆ AliRtcVideoDataSample

class AliRtcVideoDataSample

继承自 NSObject , 以及 NSObject .

属性

AliRtcVideoFormat format
 
AliRtcBufferType type
 
CVPixelBufferRef _Nullable pixelBuffer
 
long dataPtr
 
long dataYPtr
 
long dataUPtr
 
long dataVPtr
 
long dataLength
 
int strideY
 
int strideU
 
int strideV
 
int stride
 
int height
 
int width
 
int rotation
 
long long timeStamp
 

◆ AliRtcChannelRelayConfiguration

class AliRtcChannelRelayConfiguration

继承自 NSObject , 以及 NSObject .

构造函数

(void) - addDestChannelInfoWithChannelId:authInfo:
 
(void) - removeDestChannelInfo:
 
(void) - removeAllDestChannelInfo
 
(void) - addDestChannelInfoWithChannelId:authInfo:
 
(void) - removeDestChannelInfo:
 
(void) - removeAllDestChannelInfo
 

属性

NSDictionary< NSString *, AliRtcAuthInfo * > *_Nullable destChannelInfos
 
NSDictionary< NSString *, AliRtcAuthInfo * > * destChannelInfos
 

◆ AliRtcMessage

class AliRtcMessage
注解
已废弃使用

继承自 NSObject , 以及 NSObject .

属性

NSString *_Nullable tID
 
NSString *_Nullable contentType
 
NSString *_Nullable content
 

◆ AliRtcMessageResponse

class AliRtcMessageResponse
注解
已废弃使用

继承自 NSObject , 以及 NSObject .

属性

int result
 
NSString *_Nullable contentType
 
NSString *_Nullable content
 

◆ AliRtcCameraCapturerConfiguration

class AliRtcCameraCapturerConfiguration

继承自 NSObject , 以及 NSObject .

属性

AliRtcCaptureOutputPreference preference
 
AliRtcCameraDirection cameraDirection
 

◆ AliRtcLiveTranscodingImage

class AliRtcLiveTranscodingImage

继承自 NSObject , 以及 NSObject .

属性

NSString *_Nullable url
 
float alpha
 
AliRtcLiveTranscodingDisplayType display
 
int x
 
int y
 
int width
 
int height
 
int zOrder
 

◆ AliRtcLiveTranscodingText

class AliRtcLiveTranscodingText

继承自 NSObject , 以及 NSObject .

属性

NSString *_Nullable text
 
int x
 
int y
 
int zOrder
 
AliRtcLiveTranscodingFontType fontType
 
int fontSize
 
int fontColor
 

◆ AliRtcLiveTranscodingPane

class AliRtcLiveTranscodingPane

继承自 NSObject , 以及 NSObject .

属性

int x
 
int y
 
int width
 
int height
 
int zOrder
 
NSString *_Nonnull userId
 
AliRtcLiveTranscodingSourceType sourceType
 
AliRtcLiveTranscodingSegmentType segmentType
 
NSArray< AliRtcLiveTranscodingImage * > *_Nullable images
 
NSArray< AliRtcLiveTranscodingText * > *_Nullable texts
 

◆ AliRtcLiveTranscodingClockWidget

class AliRtcLiveTranscodingClockWidget

继承自 NSObject , 以及 NSObject .

属性

int x
 
int y
 
AliRtcLiveTranscodingFontType fontType
 
int fontSize
 
int fontColor
 
int zOrder
 

◆ AliRtcLiveTranscodingEncodeParam

class AliRtcLiveTranscodingEncodeParam

继承自 NSObject , 以及 NSObject .

属性

int videoWidth
 
int videoHeight
 
int videoFramerate
 
int videoBitrate
 
int videoGop
 
AliRtcLiveTranscodingAudioSampleRate audioSamplerate
 
int audioBitrate
 
int audioChannels
 

◆ AliRtcLiveTranscodingSingleParam

class AliRtcLiveTranscodingSingleParam

继承自 NSObject , 以及 NSObject .

属性

NSString *_Nullable userId
 
AliRtcLiveTranscodingStreamType streamType
 
AliRtcLiveTranscodingSourceType sourceType
 

属性说明

◆ userId

- (NSString *_Nullable) userId
readwritenonatomiccopy

用户id

用户id

◆ streamType

- (AliRtcLiveTranscodingStreamType) streamType
readwritenonatomicassign

推流模式

推流模式

◆ sourceType

- (AliRtcLiveTranscodingSourceType) sourceType
readwritenonatomicassign

旁路直播输入类型

旁路直播输入类型

◆ AliRtcLiveTranscodingMixParam

class AliRtcLiveTranscodingMixParam

继承自 NSObject , 以及 NSObject .

属性

AliRtcLiveTranscodingTaskProfile taskProfile
 
AliRtcLiveTranscodingEncodeParam *_Nullable encodeParam
 
NSArray< AliRtcLiveTranscodingPane * > *_Nullable users
 
int backgroundColor
 
NSArray< AliRtcLiveTranscodingImage * > *_Nullable backgrounds
 
NSArray< AliRtcLiveTranscodingImage * > *_Nullable watermarks
 
NSArray< AliRtcLiveTranscodingClockWidget * > *_Nullable clockWidgets
 
AliRtcLiveTranscodingCropMode cropMode
 
AliRtcLiveTranscodingMediaProcessMode mediaProcessMode
 

属性说明

◆ taskProfile

- (AliRtcLiveTranscodingTaskProfile) taskProfile
readwritenonatomicassign

旁路直播计费规格

旁路直播计费规格

◆ encodeParam

- (AliRtcLiveTranscodingEncodeParam *_Nullable) encodeParam
readwritenonatomicstrong

旁路直播自定义编码参数

旁路直播自定义编码参数

◆ users

- (NSArray< AliRtcLiveTranscodingPane * > *_Nullable) users
readwritenonatomicstrong

旁路直播用户列表

旁路直播用户列表

◆ backgroundColor

- (int) backgroundColor
readwritenonatomicassign

背景色

背景色

◆ backgrounds

- (NSArray< AliRtcLiveTranscodingImage * > *_Nullable) backgrounds
readwritenonatomicstrong

背景图片列表

背景图片列表

◆ watermarks

- (NSArray< AliRtcLiveTranscodingImage * > *_Nullable) watermarks
readwritenonatomicstrong

水印列表

水印列表

◆ clockWidgets

- (NSArray< AliRtcLiveTranscodingClockWidget * > *_Nullable) clockWidgets
readwritenonatomicstrong

时钟组件列表

时钟组件列表

◆ cropMode

- (AliRtcLiveTranscodingCropMode) cropMode
readwritenonatomicassign

剪裁模式

剪裁模式

◆ mediaProcessMode

- (AliRtcLiveTranscodingMediaProcessMode) mediaProcessMode
readwritenonatomicassign

媒体处理模式

媒体处理模式

◆ AliRtcLiveTranscodingParam

class AliRtcLiveTranscodingParam

继承自 NSObject , 以及 NSObject .

属性

AliRtcLiveTranscodingMixMode mixMode
 
AliRtcLiveTranscodingSingleParam *_Nullable singleParam
 
AliRtcLiveTranscodingMixParam *_Nullable mixParam
 

属性说明

◆ mixMode

- (AliRtcLiveTranscodingMixMode) mixMode
readwritenonatomicassign

旁路模式

旁路模式

◆ singleParam

- (AliRtcLiveTranscodingSingleParam *_Nullable) singleParam
readwritenonatomicstrong

路模式单路参数

路模式单路参数

◆ mixParam

- (AliRtcLiveTranscodingMixParam *_Nullable) mixParam
readwritenonatomicstrong

旁路模式混流参数

旁路模式混流参数

◆ AliRtcVideoEncoderConfiguration

class AliRtcVideoEncoderConfiguration

继承自 NSObject , 以及 NSObject .

属性

CGSize dimensions
 
NSInteger frameRate
 
NSInteger bitrate
 
AliRtcVideoEncoderMirrorMode mirrorMode
 
AliRtcVideoEncoderOrientationMode orientationMode
 
AliRtcRotationMode rotationMode
 
AliRtcRotationMode rotation
 

属性说明

◆ dimensions

- (CGSize) dimensions
readwritenonatomicassign

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

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

◆ frameRate

- (NSInteger) frameRate
readwritenonatomicassign

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

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

◆ bitrate

- (NSInteger) bitrate
readwritenonatomicassign

视频编码码率(Kbps)

视频编码码率(Kbps)

  • 默认值 512
  • 设置为0，表示由SDK内部根据视频分辨率和码率计算合适的编码码率
  • 码率设置根据分辨率和帧率有对应的合理范围，该值设置在合理范围内有效，否则SDK会自动调节码率到有效值
注解
以下码表列举常见的分辨率、帧率对应的编码码率设置的区间
分辨率 帧率(fps) 最小码率 (Kbps) 推荐码率(Kbps) 最大码率(Kbps)
120 * 120 5 10 25 75
120 * 120 10 17 50 150
120 * 120 15 25 70 210
120 * 120 20 34 90 270
120 * 120 30 50 115 345
160 * 120 5 10 30 90
160 * 120 10 20 55 165
160 * 120 15 30 80 240
160 * 120 20 40 100 300
160 * 120 30 60 130 390
180 * 180 5 10 50 150
180 * 180 10 17 70 210
180 * 180 15 26 100 300
180 * 180 20 34 130 390
180 * 180 30 51 180 540
240 * 180 5 15 60 180
240 * 180 10 30 90 270
240 * 180 15 45 130 390
240 * 180 20 60 165 495
240 * 180 30 90 230 690
320 * 180 5 15 65 195
320 * 180 10 30 110 330
320 * 180 15 45 170 510
320 * 180 20 60 220 660
320 * 180 30 90 300 900
240 * 240 5 15 70 140
240 * 240 10 30 100 200
240 * 240 15 45 150 300
240 * 240 20 60 200 400
240 * 240 30 90 256 512
320 * 240 5 20 100 200
320 * 240 10 40 170 340
320 * 240 15 60 256 512
320 * 240 20 80 320 640
320 * 240 30 120 400 800
424 * 240 5 26 100 200
424 * 240 10 53 170 340
424 * 240 15 79 260 520
424 * 240 20 105 340 680
424 * 240 30 158 430 860
360 * 360 5 30 120 240
360 * 360 10 60 180 360
360 * 360 15 90 260 520
360 * 360 20 120 330 660
360 * 360 30 180 400 800
480 * 360 5 40 150 300
480 * 360 10 80 240 480
480 * 360 15 120 350 700
480 * 360 20 160 430 860
480 * 360 30 240 512 1024
640 * 360 5 83 200 400
640 * 360 10 165 340 680
640 * 360 15 248 512 1024
640 * 360 20 330 600 1200
640 * 360 30 495 700 1400
480 * 480 5 83 170 340
480 * 480 10 165 260 520
480 * 480 15 248 400 800
480 * 480 20 330 470 940
480 * 480 30 495 600 1200
640 * 480 5 110 200 400
640 * 480 10 220 350 700
640 * 480 15 330 512 1024
640 * 480 20 440 600 1200
640 * 480 30 660 700 1400
840 * 480 5 180 256 512
840 * 480 10 360 512 1024
840 * 480 15 540 610 1220
840 * 480 20 720 800 1600
840 * 480 30 1080 930 1860
960 * 720 5 250 250 600
960 * 720 10 500 500 750
960 * 720 15 750 750 1125
960 * 720 20 1000 1000 1500
960 * 720 30 1500 1500 2250
1280 * 720 5 400 400 600
1280 * 720 10 800 800 1200
1280 * 720 15 1200 1200 1800
1280 * 720 20 1600 1600 2400
1280 * 720 30 2400 2400 3600
1920 * 1080 5 500 500 750
1920 * 1080 10 1000 1000 1500
1920 * 1080 15 1500 1500 2250
1920 * 1080 20 2000 2000 3000
1920 * 1080 30 3000 3000 4500
2560 * 1440 5 800 800 1200
2560 * 1440 10 1600 1600 2400
2560 * 1440 15 2400 2400 3600
2560 * 1440 20 3200 3200 4800
2560 * 1440 30 4800 4800 7200
3840 * 2160 5 1000 1000 1500
3840 * 2160 10 2000 2000 3000
3840 * 2160 15 3000 3000 4500
3840 * 2160 20 4000 4000 6000
3840 * 2160 30 6000 6000 9000
  • 默认值 512
  • 设置为0，表示由SDK内部根据视频分辨率和码率计算合适的编码码率
  • 码率设置根据分辨率和帧率有对应的合理范围，该值设置在合理范围内有效，否则SDK会自动调节码率到有效值
注解
以下码表列举常见的分辨率、帧率对应的编码码率设置的区间
分辨率 帧率(fps) 最小码率 (Kbps) 推荐码率(Kbps) 最大码率(Kbps)
120 * 120 5 10 25 75
120 * 120 10 17 50 150
120 * 120 15 25 70 210
120 * 120 20 34 90 270
120 * 120 30 50 115 345
160 * 120 5 10 30 90
160 * 120 10 20 55 165
160 * 120 15 30 80 240
160 * 120 20 40 100 300
160 * 120 30 60 130 390
180 * 180 5 10 50 150
180 * 180 10 17 70 210
180 * 180 15 26 100 300
180 * 180 20 34 130 390
180 * 180 30 51 180 540
240 * 180 5 15 60 180
240 * 180 10 30 90 270
240 * 180 15 45 130 390
240 * 180 20 60 165 495
240 * 180 30 90 230 690
320 * 180 5 15 65 195
320 * 180 10 30 110 330
320 * 180 15 45 170 510
320 * 180 20 60 220 660
320 * 180 30 90 300 900
240 * 240 5 15 70 140
240 * 240 10 30 100 200
240 * 240 15 45 150 300
240 * 240 20 60 200 400
240 * 240 30 90 256 512
320 * 240 5 20 100 200
320 * 240 10 40 170 340
320 * 240 15 60 256 512
320 * 240 20 80 320 640
320 * 240 30 120 400 800
424 * 240 5 26 100 200
424 * 240 10 53 170 340
424 * 240 15 79 260 520
424 * 240 20 105 340 680
424 * 240 30 158 430 860
360 * 360 5 30 120 240
360 * 360 10 60 180 360
360 * 360 15 90 260 520
360 * 360 20 120 330 660
360 * 360 30 180 400 800
480 * 360 5 40 150 300
480 * 360 10 80 240 480
480 * 360 15 120 350 700
480 * 360 20 160 430 860
480 * 360 30 240 512 1024
640 * 360 5 83 200 400
640 * 360 10 165 340 680
640 * 360 15 248 512 1024
640 * 360 20 330 600 1200
640 * 360 30 495 700 1400
480 * 480 5 83 170 340
480 * 480 10 165 260 520
480 * 480 15 248 400 800
480 * 480 20 330 470 940
480 * 480 30 495 600 1200
640 * 480 5 110 200 400
640 * 480 10 220 350 700
640 * 480 15 330 512 1024
640 * 480 20 440 600 1200
640 * 480 30 660 700 1400
840 * 480 5 180 256 512
840 * 480 10 360 512 1024
840 * 480 15 540 610 1220
840 * 480 20 720 800 1600
840 * 480 30 1080 930 1860
960 * 720 5 250 250 600
960 * 720 10 500 500 750
960 * 720 15 750 750 1125
960 * 720 20 1000 1000 1500
960 * 720 30 1500 1500 2250
1280 * 720 5 400 400 600
1280 * 720 10 800 800 1200
1280 * 720 15 1200 1200 1800
1280 * 720 20 1600 1600 2400
1280 * 720 30 2400 2400 3600
1920 * 1080 5 500 500 750
1920 * 1080 10 1000 1000 1500
1920 * 1080 15 1500 1500 2250
1920 * 1080 20 2000 2000 3000
1920 * 1080 30 3000 3000 4500
2560 * 1440 5 800 800 1200
2560 * 1440 10 1600 1600 2400
2560 * 1440 15 2400 2400 3600
2560 * 1440 20 3200 3200 4800
2560 * 1440 30 4800 4800 7200
3840 * 2160 5 1000 1000 1500
3840 * 2160 10 2000 2000 3000
3840 * 2160 15 3000 3000 4500
3840 * 2160 20 4000 4000 6000
3840 * 2160 30 6000 6000 9000

◆ mirrorMode

- (AliRtcVideoEncoderMirrorMode) mirrorMode
readwritenonatomicassign

推流镜像，默认AliRtcVideoEncoderMirrorModeDisabled，详见 AliRtcVideoEncoderMirrorMode

推流镜像，默认AliRtcVideoEncoderMirrorModeDisabled，详见 AliRtcVideoEncoderMirrorMode

◆ orientationMode

- (AliRtcVideoEncoderOrientationMode) orientationMode
readwritenonatomicassign

视频输出方向，默认AliRtcVideoEncoderOrientationModeAdaptive，详见 AliRtcVideoEncoderOrientationMode

视频输出方向，默认AliRtcVideoEncoderOrientationModeAdaptive，详见 AliRtcVideoEncoderOrientationMode

◆ rotationMode

- (AliRtcRotationMode) rotationMode
readwritenonatomicassign

推流旋转，默认AliRtcRotationMode_0，详见 AliRtcRotationMode

◆ AliRtcScreenShareEncoderConfiguration

class AliRtcScreenShareEncoderConfiguration

继承自 NSObject , 以及 NSObject .

属性

CGSize dimensions
 
NSInteger frameRate
 
NSInteger bitrate
 
AliRtcRotationMode rotationMode
 
AliRtcRotationMode rotation
 

属性说明

◆ dimensions

- (CGSize) dimensions
readwritenonatomicassign

视频分辨率，默认值0x0，最大值3840x2160

视频分辨率，默认值0x0，最大值3840x2160

注解
默认值表示推流分辨率等于屏幕采集的分辨率
默认值表示推流分辨率等于屏幕采集的分辨率

◆ frameRate

- (NSInteger) frameRate
readwritenonatomicassign

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

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

◆ bitrate

- (NSInteger) bitrate
readwritenonatomicassign

视频编码码率(Kbps)

视频编码码率(Kbps)

  • 默认值 512
  • 设置为0，表示由SDK内部根据视频分辨率和码率计算合适的编码码率
  • 码率设置根据分辨率和帧率有对应的合理范围，该值设置在合理范围内有效，否则SDK会自动调节码率到有效值
注解
以下码表列举常见的分辨率、帧率对应的编码码率设置的区间
分辨率 帧率(fps) 最小码率 (Kbps) 推荐码率(Kbps) 最大码率(Kbps)
120 * 120 5 10 25 75
120 * 120 10 17 50 150
120 * 120 15 25 70 210
120 * 120 20 34 90 270
120 * 120 30 50 115 345
160 * 120 5 10 30 90
160 * 120 10 20 55 165
160 * 120 15 30 80 240
160 * 120 20 40 100 300
160 * 120 30 60 130 390
180 * 180 5 10 50 150
180 * 180 10 17 70 210
180 * 180 15 26 100 300
180 * 180 20 34 130 390
180 * 180 30 51 180 540
240 * 180 5 15 60 180
240 * 180 10 30 90 270
240 * 180 15 45 130 390
240 * 180 20 60 165 495
240 * 180 30 90 230 690
320 * 180 5 15 65 195
320 * 180 10 30 110 330
320 * 180 15 45 170 510
320 * 180 20 60 220 660
320 * 180 30 90 300 900
240 * 240 5 15 70 140
240 * 240 10 30 100 200
240 * 240 15 45 150 300
240 * 240 20 60 200 400
240 * 240 30 90 256 512
320 * 240 5 20 100 200
320 * 240 10 40 170 340
320 * 240 15 60 256 512
320 * 240 20 80 320 640
320 * 240 30 120 400 800
424 * 240 5 26 100 200
424 * 240 10 53 170 340
424 * 240 15 79 260 520
424 * 240 20 105 340 680
424 * 240 30 158 430 860
360 * 360 5 30 120 240
360 * 360 10 60 180 360
360 * 360 15 90 260 520
360 * 360 20 120 330 660
360 * 360 30 180 400 800
480 * 360 5 40 150 300
480 * 360 10 80 240 480
480 * 360 15 120 350 700
480 * 360 20 160 430 860
480 * 360 30 240 512 1024
640 * 360 5 83 200 400
640 * 360 10 165 340 680
640 * 360 15 248 512 1024
640 * 360 20 330 600 1200
640 * 360 30 495 700 1400
480 * 480 5 83 170 340
480 * 480 10 165 260 520
480 * 480 15 248 400 800
480 * 480 20 330 470 940
480 * 480 30 495 600 1200
640 * 480 5 110 200 400
640 * 480 10 220 350 700
640 * 480 15 330 512 1024
640 * 480 20 440 600 1200
640 * 480 30 660 700 1400
840 * 480 5 180 256 512
840 * 480 10 360 512 1024
840 * 480 15 540 610 1220
840 * 480 20 720 800 1600
840 * 480 30 1080 930 1860
960 * 720 5 250 250 600
960 * 720 10 500 500 750
960 * 720 15 750 750 1125
960 * 720 20 1000 1000 1500
960 * 720 30 1500 1500 2250
1280 * 720 5 400 400 600
1280 * 720 10 800 800 1200
1280 * 720 15 1200 1200 1800
1280 * 720 20 1600 1600 2400
1280 * 720 30 2400 2400 3600
1920 * 1080 5 500 500 750
1920 * 1080 10 1000 1000 1500
1920 * 1080 15 1500 1500 2250
1920 * 1080 20 2000 2000 3000
1920 * 1080 30 3000 3000 4500
2560 * 1440 5 800 800 1200
2560 * 1440 10 1600 1600 2400
2560 * 1440 15 2400 2400 3600
2560 * 1440 20 3200 3200 4800
2560 * 1440 30 4800 4800 7200
3840 * 2160 5 1000 1000 1500
3840 * 2160 10 2000 2000 3000
3840 * 2160 15 3000 3000 4500
3840 * 2160 20 4000 4000 6000
3840 * 2160 30 6000 6000 9000
  • 默认值 512
  • 设置为0，表示由SDK内部根据视频分辨率和码率计算合适的编码码率
  • 码率设置根据分辨率和帧率有对应的合理范围，该值设置在合理范围内有效，否则SDK会自动调节码率到有效值
注解
以下码表列举常见的分辨率、帧率对应的编码码率设置的区间
分辨率 帧率(fps) 最小码率 (Kbps) 推荐码率(Kbps) 最大码率(Kbps)
120 * 120 5 10 25 75
120 * 120 10 17 50 150
120 * 120 15 25 70 210
120 * 120 20 34 90 270
120 * 120 30 50 115 345
160 * 120 5 10 30 90
160 * 120 10 20 55 165
160 * 120 15 30 80 240
160 * 120 20 40 100 300
160 * 120 30 60 130 390
180 * 180 5 10 50 150
180 * 180 10 17 70 210
180 * 180 15 26 100 300
180 * 180 20 34 130 390
180 * 180 30 51 180 540
240 * 180 5 15 60 180
240 * 180 10 30 90 270
240 * 180 15 45 130 390
240 * 180 20 60 165 495
240 * 180 30 90 230 690
320 * 180 5 15 65 195
320 * 180 10 30 110 330
320 * 180 15 45 170 510
320 * 180 20 60 220 660
320 * 180 30 90 300 900
240 * 240 5 15 70 140
240 * 240 10 30 100 200
240 * 240 15 45 150 300
240 * 240 20 60 200 400
240 * 240 30 90 256 512
320 * 240 5 20 100 200
320 * 240 10 40 170 340
320 * 240 15 60 256 512
320 * 240 20 80 320 640
320 * 240 30 120 400 800
424 * 240 5 26 100 200
424 * 240 10 53 170 340
424 * 240 15 79 260 520
424 * 240 20 105 340 680
424 * 240 30 158 430 860
360 * 360 5 30 120 240
360 * 360 10 60 180 360
360 * 360 15 90 260 520
360 * 360 20 120 330 660
360 * 360 30 180 400 800
480 * 360 5 40 150 300
480 * 360 10 80 240 480
480 * 360 15 120 350 700
480 * 360 20 160 430 860
480 * 360 30 240 512 1024
640 * 360 5 83 200 400
640 * 360 10 165 340 680
640 * 360 15 248 512 1024
640 * 360 20 330 600 1200
640 * 360 30 495 700 1400
480 * 480 5 83 170 340
480 * 480 10 165 260 520
480 * 480 15 248 400 800
480 * 480 20 330 470 940
480 * 480 30 495 600 1200
640 * 480 5 110 200 400
640 * 480 10 220 350 700
640 * 480 15 330 512 1024
640 * 480 20 440 600 1200
640 * 480 30 660 700 1400
840 * 480 5 180 256 512
840 * 480 10 360 512 1024
840 * 480 15 540 610 1220
840 * 480 20 720 800 1600
840 * 480 30 1080 930 1860
960 * 720 5 250 250 600
960 * 720 10 500 500 750
960 * 720 15 750 750 1125
960 * 720 20 1000 1000 1500
960 * 720 30 1500 1500 2250
1280 * 720 5 400 400 600
1280 * 720 10 800 800 1200
1280 * 720 15 1200 1200 1800
1280 * 720 20 1600 1600 2400
1280 * 720 30 2400 2400 3600
1920 * 1080 5 500 500 750
1920 * 1080 10 1000 1000 1500
1920 * 1080 15 1500 1500 2250
1920 * 1080 20 2000 2000 3000
1920 * 1080 30 3000 3000 4500
2560 * 1440 5 800 800 1200
2560 * 1440 10 1600 1600 2400
2560 * 1440 15 2400 2400 3600
2560 * 1440 20 3200 3200 4800
2560 * 1440 30 4800 4800 7200
3840 * 2160 5 1000 1000 1500
3840 * 2160 10 2000 2000 3000
3840 * 2160 15 3000 3000 4500
3840 * 2160 20 4000 4000 6000
3840 * 2160 30 6000 6000 9000

◆ rotationMode

- (AliRtcRotationMode) rotationMode
readwritenonatomicassign

推流旋转，默认AliRtcRotationMode_0，详见 AliRtcRotationMode

◆ AliRtcVideoExternalEncoderParameter

class AliRtcVideoExternalEncoderParameter

继承自 NSObject , 以及 NSObject .

属性

NSInteger width
 
NSInteger height
 
NSInteger frame_rate
 
NSInteger bitrate_bps
 

枚举类型说明

◆ AliRtcPluginErrorCode

enum AliRtcPluginErrorCode

插件错误码

枚举值
AliRtcPluginErrorCodeSuccess 

成功

AliRtcPluginErrorCodeFailed 

未知错误

AliRtcPluginErrorNoFindPlugin 

未找到对应插件

AliRtcPluginErrorParameterError 

参数错误

AliRtcPluginErrorLoadError 

插件库加载错误

AliRtcPluginErrorCreateError 

插件对象创建错误

AliRtcPluginErrorInitError 

插件初始化失败

AliRtcPluginErrorInitTokenError 

插件鉴权失败，使用非官网下载插件

AliRtcPluginErrorCodeSuccess 

成功

AliRtcPluginErrorCodeFailed 

未知错误

AliRtcPluginErrorNoFindPlugin 

未找到对应插件

AliRtcPluginErrorParameterError 

参数错误

AliRtcPluginErrorLoadError 

插件库加载错误

AliRtcPluginErrorCreateError 

插件对象创建错误

AliRtcPluginErrorInitError 

插件初始化失败

AliRtcPluginErrorInitTokenError 

插件鉴权失败，使用非官网下载插件

◆ AliRtcPluginDataType

enum AliRtcPluginDataType

插件类型

枚举值
AliRtcPluginDataTypeShared 

共享型

AliRtcPluginDataTypeVideo 

视频处理型

AliRtcPluginDataTypeAudio 

音频处理型

AliRtcPluginDataTypeEncryption 

加密型

AliRtcPluginDataTypeMax 

占位符，无含义

AliRtcPluginDataTypeShared 

共享型

AliRtcPluginDataTypeVideo 

视频处理型

AliRtcPluginDataTypeAudio 

音频处理型

AliRtcPluginDataTypeEncryption 

加密型

AliRtcPluginDataTypeMax 

占位符，无含义

◆ AliRtcPluginOperationType

enum AliRtcPluginOperationType

插件操作类型

枚举值
AliRtcPluginShared 

共享插件

AliRtcPluginPreOperation 

推流前处理

AliRtcPluginPostOperation 

拉流后处理

AliRtcPluginEncodeOperation 

编码器

AliRtcPluginDecodeOperation 

解码器

AliRtcPluginRecord 

采集

AliRtcPluginRender 

渲染

AliRtcPluginShared 

共享插件

AliRtcPluginPreOperation 

推流前处理

AliRtcPluginPostOperation 

拉流后处理

AliRtcPluginEncodeOperation 

编码器

AliRtcPluginDecodeOperation 

解码器

AliRtcPluginRecord 

采集

AliRtcPluginRender 

渲染

◆ AliRtcVideoTrack

enum AliRtcVideoTrack : NSUInteger

视频流类型

枚举值
AliRtcVideoTrackNo 

无摄像头和屏幕共享

AliRtcVideoTrackCamera 

摄像头

AliRtcVideoTrackScreen 

屏幕共享

AliRtcVideoTrackBoth 

摄像头+屏幕共享

AliRtcVideoTrackNo 

无视频流

AliRtcVideoTrackCamera 

相机流

AliRtcVideoTrackScreen 

屏幕共享流

AliRtcVideoTrackBoth 

相机流和屏幕共享流

◆ AliRtcAudioTrack

enum AliRtcAudioTrack : NSUInteger

音频流类型

枚举值
AliRtcAudioTrackNo 

无麦克风

AliRtcAudioTrackMic 

麦克风

AliRtcAudioTrackNo 

无麦克风

AliRtcAudioTrackMic 

麦克风

◆ AliRtcNetworkQuality

enum AliRtcNetworkQuality : NSUInteger

网络质量

枚举值
AlivcRtcNetworkQualityExcellent 

网络极好，流程度清晰度质量好

AlivcRtcNetworkQualityGood 

网络好，流畅度清晰度和极好差不多

AlivcRtcNetworkQualityPoor 

网络较差，音视频流畅度清晰度有瑕疵，不影响沟通

AlivcRtcNetworkQualityBad 

网络差，视频卡顿严重，音频能正常沟通

AlivcRtcNetworkQualityVeryBad 

网络极差，基本无法沟通

AlivcRtcNetworkQualityDisconnect 

网络中断

AlivcRtcNetworkQualityUnknow 

未知

AlivcRtcNetworkQualityExcellent 

网络极好，流程度清晰度质量好

AlivcRtcNetworkQualityGood 

网络好，流畅度清晰度和极好差不多

AlivcRtcNetworkQualityPoor 

网络较差，音视频流畅度清晰度有瑕疵，不影响沟通

AlivcRtcNetworkQualityBad 

网络差，视频卡顿严重，音频能正常沟通

AlivcRtcNetworkQualityVeryBad 

网络极差，基本无法沟通

AlivcRtcNetworkQualityDisconnect 

网络中断

AlivcRtcNetworkQualityUnknow 

未知

◆ AliRtcTranportAudioQuality

enum AliRtcTranportAudioQuality : NSInteger

音频质量

枚举值
AliRtcAudioQulityUnknow 

质量未知

AliRtcAudioQulityExcellent 

质量极好

AliRtcAudioQulityGood 

用户主观感觉和极好差不多 ，但码率可能略低于极好

AliRtcAudioQulityPoor 

用户主观感受有瑕疵，但不影响沟通

AliRtcAudioQulityBad 

勉强能沟通但不顺畅

AliRtcAudioQulityVeryBad 

网络质量非常差，基本不能沟通

AliRtcAudioQulityNetworkDisconnected 

网络连接已断开，完全无法沟通

AliRtcAudioQulityUnknow 

质量未知

AliRtcAudioQulityExcellent 

质量极好

AliRtcAudioQulityGood 

用户主观感觉和极好差不多 ，但码率可能略低于极好

AliRtcAudioQulityPoor 

用户主观感受有瑕疵，但不影响沟通

AliRtcAudioQulityBad 

勉强能沟通但不顺畅

AliRtcAudioQulityVeryBad 

网络质量非常差，基本不能沟通

AliRtcAudioQulityNetworkDisconnected 

网络连接已断开，完全无法沟通

◆ AliRtcAudioProfile

enum AliRtcAudioProfile : NSInteger

音频编码模式

枚举值
AliRtcEngineLowQualityMode 

音频低音质模式，默认8000Hz采样率，单声道，最大编码码率12kbps

AliRtcEngineBasicQualityMode 

（默认）标准音质模式，默认16000Hz采样率，单声道，最大编码码率24kbps

AliRtcEngineHighQualityMode 

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

AliRtcEngineStereoHighQualityMode 

立体声高音质模式，默认48000Hz采样率，双声道，最大编码码率64kbps

AliRtcEngineSuperHighQualityMode 

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

AliRtcEngineStereoSuperHighQualityMode 

立体声超高音质模式，默认48000Hz采样率，双声道，最大编码码率128kbps

AliRtcEngineLowQualityMode 

音频低音质模式，默认8000Hz采样率，单声道，最大编码码率12kbps

AliRtcEngineBasicQualityMode 

（默认）标准音质模式，默认16000Hz采样率，单声道，最大编码码率24kbps

AliRtcEngineHighQualityMode 

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

AliRtcEngineStereoHighQualityMode 

立体声高音质模式，默认48000Hz采样率，双声道，最大编码码率64kbps

AliRtcEngineSuperHighQualityMode 

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

AliRtcEngineStereoSuperHighQualityMode 

立体声超高音质模式，默认48000Hz采样率，双声道，最大编码码率128kbps

◆ AliRtcAudioScenario

enum AliRtcAudioScenario : NSInteger

音频场景模式

枚举值
AliRtcSceneDefaultMode 

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

AliRtcSceneEducationMode 

教育场景，优先保证音频连续性与稳定性

AliRtcSeneMediaMode 

媒体场景，保真人声与音乐音质, 连麦直播间推荐使用

AliRtcSceneMusicMode 

音乐场景，高保真音乐音质，乐器教学等对音乐音质有要求的场景推荐使用

AliRtcSceneChatroomMode 

聊天室模式，适用于频繁上下麦的场景

AliRtcSceneDefaultMode 

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

AliRtcSceneEducationMode 

教育场景，优先保证音频连续性与稳定性

AliRtcSeneMediaMode 

媒体场景，保真人声与音乐音质, 连麦直播间推荐使用

AliRtcSceneMusicMode 

音乐场景，高保真音乐音质，乐器教学等对音乐音质有要求的场景推荐使用

AliRtcSceneChatroomMode 

聊天室模式，适用于频繁上下麦的场景

◆ AliRtcRenderMode

enum AliRtcRenderMode : NSUInteger

视图显示模式

枚举值
AliRtcRenderModeAuto 

自动模式

AliRtcRenderModeStretch 

延伸模式

AliRtcRenderModeFill 

填充模式

AliRtcRenderModeCrop 

裁剪模式

AliRtcRenderModeAuto 

自动模式

AliRtcRenderModeStretch 

拉伸平铺模式 ，如果外部输入的视频宽高比和推流设置的宽高比不一致时，将输入视频拉伸到推流设置的比例，画面会变形

AliRtcRenderModeFill 

填充黑边模式，如果外部输入的视频宽高比和推流设置的宽高比不一致时，将输入视频上下或者左右填充黑边

AliRtcRenderModeCrop 

裁剪模式，如果外部输入的视频宽高比和推流设置的宽高比不一致时，将输入视频宽或者高进行裁剪，画面内容会丢失

◆ AliRtcLogLevel

enum AliRtcLogLevel : NSUInteger

Log级别

枚举值
AliRtcLogLevelInfo 

只输出>=AliRtcLogLevelInfo 级别的日志

AliRtcLogLevelWarn 

只输出>=AliRtcLogLevelWarn 级别的日志

AliRtcLogLevelError 

只输出>=AliRtcLogLevelError 级别的日志

AliRtcLogLevelFatal 

只输出>=AliRtcLogLevelFatal 级别的日志

AliRtcLogLevelNone 

不输出日志

AliRtcLogLevelInfo 

只输出>=AliEngineLogLevelInfo 级别的日志

AliRtcLogLevelWarn 

只输出>=AliEngineLogLevelWarn 级别的日志

AliRtcLogLevelError 

只输出>=AliEngineLogLevelError 级别的日志

AliRtcLogLevelFatal 

只输出>=AliEngineLogLevelFatal 级别的日志

AliRtcLogLevelNone 

不输出日志

◆ AliRtcVideoEncoderFrameRate

enum AliRtcVideoEncoderFrameRate : NSInteger

视频编码帧率

枚举值
AliRtcVideoEncoderFrameRate_FPS_5 

视频编码帧率 - 5帧

AliRtcVideoEncoderFrameRate_FPS_10 

视频编码帧率 - 10帧

AliRtcVideoEncoderFrameRate_FPS_15 

视频编码帧率 - 15帧

AliRtcVideoEncoderFrameRate_FPS_20 

视频编码帧率 - 20帧

AliRtcVideoEncoderFrameRate_FPS_30 

视频编码帧率 - 30帧

AliRtcVideoEncoderFrameRate_FPS_5 

视频编码帧率 - 5帧

AliRtcVideoEncoderFrameRate_FPS_10 

视频编码帧率 - 10帧

AliRtcVideoEncoderFrameRate_FPS_15 

视频编码帧率 - 15帧

AliRtcVideoEncoderFrameRate_FPS_20 

视频编码帧率 - 20帧

AliRtcVideoEncoderFrameRate_FPS_30 

视频编码帧率 - 30帧

◆ AliRtcVideoEncoderBitrate

enum AliRtcVideoEncoderBitrate : NSInteger

视频编码码率

枚举值
AliRtcVideoEncoderStandardBitrate 

视频编码标准码率

AliRtcVideoEncoderStandardBitrate 

视频编码标准码率

◆ AliRtcVideoEncoderMirrorMode

enum AliRtcVideoEncoderMirrorMode : NSInteger

编码视频镜像模式

枚举值
AliRtcVideoEncoderMirrorModeDisabled 

视频编码不镜像

AliRtcVideoEncoderMirrorModeEnabled 

视频编码镜像

AliRtcVideoEncoderMirrorModeDisabled 

视频编码不镜像

AliRtcVideoEncoderMirrorModeEnabled 

视频编码镜像

◆ AliRtcRotationMode

enum AliRtcRotationMode : NSInteger

视频旋转角度

枚举值
AliRtcRotationMode_0 

视频旋转角度 - 0

AliRtcRotationMode_90 

视频旋转角度 - 90

AliRtcRotationMode_180 

视频旋转角度 - 180

AliRtcRotationMode_270 

视频旋转角度 - 270

AliRtcRotationMode_0 

视频旋转角度 - 0

AliRtcRotationMode_90 

视频旋转角度 - 90

AliRtcRotationMode_180 

视频旋转角度 - 180

AliRtcRotationMode_270 

视频旋转角度 - 270

◆ AliRtcVideoEncoderOrientationMode

enum AliRtcVideoEncoderOrientationMode : NSInteger

编码视频旋转模式

枚举值
AliRtcVideoEncoderOrientationModeAdaptive 

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

AliRtcVideoEncoderOrientationModeFixedLandscape 

固定横屏

AliRtcVideoEncoderOrientationModeFixedPortrait 

固定竖屏

AliRtcVideoEncoderOrientationModeAdaptive 

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

AliRtcVideoEncoderOrientationModeFixedLandscape 

固定横屏

AliRtcVideoEncoderOrientationModeFixedPortrait 

固定竖屏

◆ AliRtcOrientationMode

enum AliRtcOrientationMode : NSInteger

视频设备方向

枚举值
AliRtcOrientationModePortrait 

固定竖屏模式

AliRtcOrientationModeLandscapeLeft 

固定左横屏模式

AliRtcOrientationModePortraitUpsideDown 

固定倒立模式

AliRtcOrientationModeLandscapeRight 

固定右横屏模式

AliRtcOrientationModeAuto 

自适应模式

◆ AliRtcAudioSessionOperationRestriction

enum AliRtcAudioSessionOperationRestriction : NSInteger

SDK对Audio Session的控制权限

枚举值
AliRtcAudioSessionOperationRestrictionNone 

无限制，SDK完全控制AVAudioSession

AliRtcAudioSessionOperationRestrictionSetCategory 

SDK不能修改AVAudioSession的Category

AliRtcAudioSessionOperationRestrictionConfigureSession 

SDK不能修改AVAudioSession的配置，包括Category，Mode，CategoryOptions

AliRtcAudioSessionOperationRestrictionDeactivateSession 

SDK不能关闭AVAudioSession的活动状态，离开频道时，AVAudioSession依然处于活动状态

◆ AliRtcVideoStreamType

enum AliRtcVideoStreamType : NSInteger

相机流类型

枚举值
AliRtcVideoStreamTypeNone 

无，在OnSubscribeStreamTypeChanged回调表示当前未订阅

AliRtcVideoStreamTypeHigh 

高码率，高分辨率流（大流）

AliRtcVideoStreamTypeLow 

低码率，低分辨率流（小流）

AliRtcVideoStreamTypeNone 

无，在OnSubscribeStreamTypeChanged回调表示当前未订阅

AliRtcVideoStreamTypeHigh 

高码率，高分辨率流（大流）

AliRtcVideoStreamTypeLow 

低码率，低分辨率流（小流）

◆ AliRtcDeviceVolumeType

enum AliRtcDeviceVolumeType : NSInteger

设备音量类型

注解
默认为Auto类型，SDK 内部会自动选择合适的音量类型，如无特殊需求，不推荐自行设置
枚举值
AliRtcDeviceVolumeTypeAuto 

SDK自动设置音量类型

AliRtcDeviceVolumeTypeMedia 

设置为媒体音量，适合媒体播放场景，音量可以调节到零

AliRtcDeviceVolumeTypeVOIP 

设置为通话音量，适合通话场景，音量无法调节到零

◆ AliRtcVideoSource

enum AliRtcVideoSource : NSInteger

视频裸数据源类型

枚举值
AliRtcVideosourceCameraType 

相机流

AliRtcVideosourceScreenShareType 

屏幕共享流

AliRtcVideosourceTypeMax 

占位符，无意义

AliRtcVideosourceCameraType 

视频流

AliRtcVideosourceScreenShareType 

屏幕共享流

AliRtcVideosourceBoth 

视频流 + 屏幕共享流

AliRtcVideosourceTypeMax 

占位符，无意义

◆ AliRtcAudioSource

enum AliRtcAudioSource : NSInteger

音频数据源类型

枚举值
AliRtcAudiosourcePub 

本地推流的音频数据

AliRtcAudiosourceSub 

本地拉流混音的音频数据

AliRtcAudiosourceRawData 

本地采集的音频数据

AliRtcAudiosourcePub 

本地推流的原始音频数据

AliRtcAudiosourceSub 

本地拉流混音的待播放音频数据

AliRtcAudiosourceRawData 

本地采集的原始音频数据

◆ AliRtcBufferType

enum AliRtcBufferType : NSInteger

视频数据类型

枚举值
AliRtcBufferType_Raw_Data 

YUV裸数据

AliRtcBufferType_CVPixelBuffer 

CVPixelBuffer数据

AliRtcBufferType_Raw_Data 

YUV裸数据

AliRtcBufferType_CVPixelBuffer 

CVPixelBuffer数据

◆ AliRtcAudioNumChannel

enum AliRtcAudioNumChannel : NSInteger

音频声道数

枚举值
AliRtcMonoAudio 

单声道

AliRtcStereoAudio 

双声道

AliRtcMonoAudio 

单声道

AliRtcStereoAudio 

双声道

◆ AliRtcRecordingQuality

enum AliRtcRecordingQuality : NSInteger

文件录制质量

枚举值
AliRtcRecording_Low_Quality 

低质量文件录制，文件体积较小，音质一般

AliRtcRecording_Midium_Quality 

中等质量文件录制，文件体积中等，音质中等

AliRtcRecording_High_Quality 

高质量文件录制，文件体积较大，音质较好

◆ AliRtcAudioEffectVoiceChangerMode

enum AliRtcAudioEffectVoiceChangerMode : NSInteger

变声音效模式

枚举值
AliRtcAudioEffectvVoiceChanger_OFF 

关闭变声音效

AliRtcAudioEffectvVoiceChanger_OLD_MAN 

老人

AliRtcAudioEffectvVoiceChanger_BABYBOY 

男孩

AliRtcAudioEffectvVoiceChanger_BABYGILR 

女孩

AliRtcAudioEffectvVoiceChanger_ROBOT 

机器人

AliRtcAudioEffectvVoiceChanger_DAIMO 

大魔王

AliRtcAudioEffectvVoiceChanger_KTV 

KTV

AliRtcAudioEffectvVoiceChangerR_ECHO 

回声

AliRtcAudioEffectvVoiceChanger_MAX 

占位符

AliRtcAudioEffectvVoiceChanger_OFF 

关闭变声音效

AliRtcAudioEffectvVoiceChanger_OLD_MAN 

老人

AliRtcAudioEffectvVoiceChanger_BABYBOY 

男孩

AliRtcAudioEffectvVoiceChanger_BABYGILR 

女孩

AliRtcAudioEffectvVoiceChanger_ROBOT 

机器人

AliRtcAudioEffectvVoiceChanger_DAIMO 

大魔王

AliRtcAudioEffectvVoiceChanger_KTV 

KTV

AliRtcAudioEffectvVoiceChangerR_ECHO 

回声

AliRtcAudioEffectvVoiceChanger_MAX 

占位符

◆ AliRtcAudioEffectReverbMode

enum AliRtcAudioEffectReverbMode : NSInteger

音效混响模式

枚举值
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_Mode_Max 

占位符

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_Mode_Max 

占位符

◆ AliRtcAudioEffectReverbParamType

enum AliRtcAudioEffectReverbParamType : NSInteger

音效混响参数

枚举值
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 

占位符

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 

占位符

◆ AliRtcConnectionStatus

enum AliRtcConnectionStatus : NSInteger

网络连接状态

枚举值
AliRtcConnectionStatusInit 

初始化完成

AliRtcConnectionStatusDisconnected 

网络连接断开

AliRtcConnectionStatusConnecting 

建立网络连接中

AliRtcConnectionStatusConnected 

网络已连接

AliRtcConnectionStatusReconnecting 

重新建立网络连接中

AliRtcConnectionStatusFailed 

网络连接失败

AliRtcConnectionStatusInit 

初始化完成

AliRtcConnectionStatusDisconnected 

网络连接断开

AliRtcConnectionStatusConnecting 

建立网络连接中

AliRtcConnectionStatusConnected 

网络已连接

AliRtcConnectionStatusReconnecting 

重新建立网络连接中

AliRtcConnectionStatusFailed 

网络连接失败

◆ AliRtcConnectionStatusChangeReason

enum AliRtcConnectionStatusChangeReason : NSInteger

引起网络状态变更原因

枚举值
AliRtcConnectionChangedDummyReason 

未知原因

AliRtcConnectionChangedMediaPathChanged 

媒体通道变更

AliRtcConnectionChangedSignalingHeartbeatTimeout 

心跳超时

AliRtcConnectionChangedSignalingHeartbeatAlive 

心跳恢复

AliRtcConnectionChangedSignalingHttpdnsResolved 

DNS解析成功

AliRtcConnectionChangedSignalingHttpdnsFailure 

DNS解析失败

AliRtcConnectionChangedSignalingGslbFailure 

GSLB请求失败

AliRtcConnectionChangedSignalingGslbSucccess 

GSLB请求成功

AliRtcConnectionChangedSignalingJoinChannelFailure 

加入频道失败

AliRtcConnectionChangedSignalingJoinChannelSuccess 

加入频道成功

AliRtcConnectionChangedSignalingLeaveRoom 

离开频道

AliRtcConnectionChangedSignalingConnecting 

信令建立连接

AliRtcConnectionChangedDummyReason 

未知原因

AliRtcConnectionChangedMediaPathChanged 

媒体通道变更

AliRtcConnectionChangedSignalingHeartbeatTimeout 

心跳超时

AliRtcConnectionChangedSignalingHeartbeatAlive 

心跳恢复

AliRtcConnectionChangedSignalingHttpdnsResolved 

DNS解析成功

AliRtcConnectionChangedSignalingHttpdnsFailure 

DNS解析失败

AliRtcConnectionChangedSignalingGslbFailure 

GSLB请求失败

AliRtcConnectionChangedSignalingGslbSucccess 

GSLB请求成功

AliRtcConnectionChangedSignalingJoinChannelFailure 

加入频道失败

AliRtcConnectionChangedSignalingJoinChannelSuccess 

加入频道成功

AliRtcConnectionChangedSignalingLeaveRoom 

离开频道

AliRtcConnectionChangedSignalingConnecting 

信令建立连接

◆ AliRtcChannelProfile

enum AliRtcChannelProfile : NSInteger

频道类型

枚举值
AliRtcCommunication 

通信模式

AliRtcInteractivelive 

互动模式

AliRtcInteractiveWithLowLatencyLive 

低延时互动直播模式

◆ AliRtcClientRole

enum AliRtcClientRole : NSInteger

角色类型

枚举值
AliRtcClientRoleInteractive 

互动角色

AliRtcClientRolelive 

观众角色

AliRtcClientRoleInteractive 

互动角色

AliRtcClientRolelive 

观众角色

◆ AliRtcMuteLocalAudioMode

enum AliRtcMuteLocalAudioMode : NSInteger

本地静音模式

枚举值
AliRtcMuteAudioModeDefault 

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

AliRtcMuteAllAudioMode 

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

AliRtcMuteOnlyMicAudioMode 

只静音麦克风

AliRtcMuteLocalAudioMax 

占位符，无意义

AliRtcMuteAudioModeDefault 

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

AliRtcMuteAllAudioMode 

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

AliRtcMuteOnlyMicAudioMode 

只静音麦克风

AliRtcMuteLocalAudioMax 

占位符，无意义

◆ AliRtcRenderMirrorMode

enum AliRtcRenderMirrorMode : NSInteger

镜像模式

枚举值
AliRtcRenderMirrorModeOnlyFrontCameraPreviewEnabled 

只有前置摄像头预览镜像，其余不镜像

AliRtcRenderMirrorModeAllEnabled 

镜像开启

AliRtcRenderMirrorModeAllDisabled 

镜像关闭

AliRtcRenderMirrorModeAllEnabled 

镜像开启

AliRtcRenderMirrorModeAllDisabled 

镜像关闭

◆ AliRtcAudioPlayingStateCode

enum AliRtcAudioPlayingStateCode : NSInteger

音乐伴奏播放状态

枚举值
AliRtcAudioPlayingStarted 

开始播放

AliRtcAudioPlayingStopped 

停止播放

AliRtcAudioPlayingPaused 

播放暂停

AliRtcAudioPlayingResumed 

播放恢复

AliRtcAudioPlayingEnded 

播放完毕

AliRtcAudioPlayingBuffering 

正在缓冲

AliRtcAudioPlayingBufferingEnd 

缓冲结束

AliRtcAudioPlayingFailed 

播放失败

AliRtcAudioPlayingStarted 

开始播放

AliRtcAudioPlayingStopped 

停止播放

AliRtcAudioPlayingPaused 

播放暂停

AliRtcAudioPlayingResumed 

播放恢复

AliRtcAudioPlayingEnded 

播放完毕

AliRtcAudioPlayingBuffering 

正在缓冲

AliRtcAudioPlayingBufferingEnd 

缓冲结束

AliRtcAudioPlayingFailed 

播放失败

◆ AliRtcAudioPlayingErrorCode

enum AliRtcAudioPlayingErrorCode : NSInteger

音乐伴奏播放错误码

枚举值
AliRtcAudioPlayingNoError 

没有错误

AliRtcAudioPlayingOpenFailed 

打开文件失败

AliRtcAudioPlayingDecodeFailed 

解码文件失败

AliRtcAudioPlayingNoError 

没有错误

AliRtcAudioPlayingOpenFailed 

打开文件失败

AliRtcAudioPlayingDecodeFailed 

解码文件失败

◆ AliRtcRecordType

enum AliRtcRecordType : NSUInteger

录制类型

枚举值
AliRtcRecordTypeAudio 

录制单个音频文件

AliRtcRecordTypeAudio 

录制单个音频文件

AliRtcRecordTypeVideo 

录制单个音视频文件

AliRtcRecordTypeBoth 

录制纯音频和音视频文件

◆ AliRtcRecordFormat

enum AliRtcRecordFormat : NSUInteger

录制格式

枚举值
AliRtcRecordFormatAAC 

录制AAC格式文件

AliRtcRecordFormatWAV 

录制WAV格式文件

AliRtcRecordFormatAAC 

录制AAC格式文件

AliRtcRecordFormatWAV 

录制WAV格式文件

AliRtcRecordFormatMP4 

录制MP4格式文件

◆ AliRtcAudioQuality

enum AliRtcAudioQuality : NSUInteger

录制音频质量

枚举值
AliRtcAudioQualityLow 

低质量文件录制，文件体积较小，音质一般

AliRtcAudioQualityMidium 

中等质量文件录制，文件体积中等，音质中等

AliRtcAudioQualityHigh 

高质量文件录制，文件体积较大，音质较好

AliRtcAudioQualityLow 

低质量文件录制，文件体积较小，音质一般

AliRtcAudioQualityMidium 

中等质量文件录制，文件体积中等，音质中等

AliRtcAudioQualityHigh 

高质量文件录制，文件体积较大，音质较好

◆ AliRtcVideoQuality

enum AliRtcVideoQuality : NSUInteger

录制视频质量

枚举值
AliRtcVideoQualityDefault 

默认，和采集保持一致

AliRtcVideoQualityDefault 

录制默认质量视频, 和采集保持一致

◆ AliRtcAudioSampleRate

enum AliRtcAudioSampleRate : NSInteger

录制音频采样率

枚举值
AliRtcAudioSampleRate_8000 

采样率：8000

AliRtcAudioSampleRate_11025 

采样率：11025

AliRtcAudioSampleRate_16000 

采样率：16000

AliRtcAudioSampleRate_22050 

采样率：22050

AliRtcAudioSampleRate_32000 

采样率：32000

AliRtcAudioSampleRate_44100 

采样率：44100

AliRtcAudioSampleRate_48000 

采样率：48000

AliRtcAudioSampleRate_8000 

采样率：8000

AliRtcAudioSampleRate_11025 

采样率：11025

AliRtcAudioSampleRate_16000 

采样率：16000

AliRtcAudioSampleRate_22050 

采样率：22050

AliRtcAudioSampleRate_32000 

采样率：32000

AliRtcAudioSampleRate_44100 

采样率：44100

AliRtcAudioSampleRate_48000 

采样率：48000

◆ AliRtcAudioRouteType

enum AliRtcAudioRouteType : NSInteger

音频路由

枚举值
AliRtcAudioRouteTypeDefault 

默认的语音路由

AliRtcAudioRouteTypeHeadset 

耳机

AliRtcAudioRouteTypeEarpiece 

听筒

AliRtcAudioRouteTypeHeadsetNoMic 

不带麦克风的耳机

AliRtcAudioRouteTypeSpeakerphone 

手机扬声器

AliRtcAudioRouteTypeLoudSpeaker 

外接扬声器

AliRtcAudioRouteTypeBlueTooth 

蓝牙耳机

◆ AliRtcVideoObserPosition

enum AliRtcVideoObserPosition : NSInteger

视频数据输出位置

枚举值
AliRtcPositionPostCapture 

采集视频数据，对应输出回调onCaptureVideoSample

AliRtcPositionPreRender 

渲染视频数据，对应输出回调onRemoteVideoSample

AliRtcPositionPreEncoder 

编码前视频数据，对应输出回调onPreEncodeVideoSample

AliRtcPositionPostCapture 

采集视频数据，对应输出回调onCaptureVideoSample

AliRtcPositionPreRender 

渲染视频数据，对应输出回调onRemoteVideoSample

AliRtcPositionPreEncoder 

编码前视频数据，对应输出回调onPreEncodeVideoSample

◆ AliRtcVideoObserAlignment

enum AliRtcVideoObserAlignment

视频输出宽度对齐方式

枚举值
AliRtcAlignmentDefault 

保持原有视频宽度(默认值)

AliRtcAlignmentEven 

宽度偶数对齐

AliRtcAlignment4 

宽度是4的倍数

AliRtcAlignment8 

宽度是8的倍数

AliRtcAlignment16 

宽度是16的倍数

AliRtcAlignmentDefault 

保持原有视频宽度(默认值)

AliRtcAlignmentEven 

宽度偶数对齐

AliRtcAlignment4 

宽度是4的倍数

AliRtcAlignment8 

宽度是8的倍数

AliRtcAlignment16 

宽度是16的倍数

◆ AliRtcShowDebugViewType

enum AliRtcShowDebugViewType : NSInteger

Debug显示类型

枚举值
AliRtcShowTypeNone 

不显示

AliRtcShowTypeAudio 

音频

AliRtcShowTypeVideo 

视频

AliRtcShowTypeNetwork 

网络

AliRtcShowTypeAll 

全部

AliRtcShowTypeNone 

不显示

AliRtcShowTypeAudio 

音频

AliRtcShowTypeVideo 

视频

AliRtcShowTypeNetwork 

网络

AliRtcShowTypeAll 

全部

◆ AliRtcScreenShareMode

enum AliRtcScreenShareMode : NSInteger

屏幕共享模式 支持位运算按需组合

枚举值
AliRtcScreenShareNone 

不共享音视频流

AliRtcScreenShareVideo 

共享视频流

AliRtcScreenShareAudioApp 

共享App音频流

AliRtcScreenShareAll 

共享所有音视频流 , 不支持屏幕共享Mic音频流, 请使用SDK自带的Mic音频采集

◆ AliRtcErrorCode

enum AliRtcErrorCode : NSInteger

错误码

枚举值
AliRtcErrNone 

状态正常，无错误

AliRtcErrJoinBadAppId 

AppId不存在，请在控制台创建应用

AliRtcErrJoinInvalidAppId 

AppId已失效，请在控制台重新启用应用

AliRtcErrJoinBadChannel 

频道不存在，请尝试重新加入频道 如会议发起者入会后又很快离会，第二个人随后入会，发现会议已经不存在了。

AliRtcErrJoinInvalidChannel 

频道已经失效（目前频道有效期为48小时），请重新生成频道鉴权令牌（Token）

AliRtcErrJoinBadToken 

Token无效。 请重新生成频道鉴权令牌（Token）

AliRtcErrJoinTimeout 

加入频道超时，请检查网络连接是否正常

AliRtcErrJoinBadParam 

参数错误，AliRtcAuthInfo 中的字段为空或者timestamp<=0，请检查字段是否完整

AliRtcErrJoinChannelFailed 

加入频道失败

AliRtcErrLogAlreadyInit 

日志模块已经初始化

AliRtcErrLogRootPathError 

日志模块根路径错误，请检查路径是否存在或路径是否具有写入权限

AliRtcErrMicOpenFail 

采集设备初始化失败、采集设备媒体服务异常、音频设备被占用。

  • Mac端和Windows端查看系统设置中音频设备是否有能量条
  • iOS端和Android端确认是否被其他应用占用
  • 如果都正常，请重启设备
AliRtcErrSpeakerOpenFail 

播放设备初始化失败、播放设备媒体服务异常、音频设备被占用。

  • Mac端和Windows端查看系统设置中音频设备是否有能量条
  • iOS端和Android端确认是否被其他应用占用
  • 如果都正常，请重启设备
AliRtcErrMicInterrupt 

系统性能不足、采集设备媒体服务异常、音频设备被占用。建议重启应用或重启设备

AliRtcErrSpeakerInterrupt 

系统性能不足，播放设备媒体服务异常，音频设备被占用。建议重启应用或重启设备

AliRtcErrMicAuthFail 

麦克风设备未授权，建议去系统设置中，打开麦克风授权，并且重新加入频道

AliRtcErrMicNotAvailable 

无可用的音频采集设备，检查是否接入了可用的麦克风，并检查系统设置中，该设备是否被禁用

AliRtcErrSpeakerNotAvailable 

无可用的音频播放设备，检查是否接入了可用的扬声器或耳机，并检查系统设置中，该设备是否被禁用

AliRtcErrCameraOpenFail 

采集设备初始化失败，检查系统相机是否可用，移动端App是否占用了相机

AliRtcErrCameraInterrupt 

采集过程中出现异常，Mac、Winodows电脑相机采集灯熄灭，设备被强制中断。建议重新加入频道或者重启App

AliRtcErrDisplayOpenFail 

渲染设备初始化失败，检查Windows端显卡驱动是否需要升级，移动端手机型号或者Android平板盒子等外设是否支持OpenGL

AliRtcErrDisplayInterrupt 

渲染过程中出现异常，系统异常错误导致渲染引擎报错，重新加入频道或者重启App

AliRtcErrIceConnectionConnectFail 

媒体通道建立失败，检查网络连接是否正常

AliRtcErrIceConnectionReconnectFail 

媒体通道重连失败，检查网络连接是否正常

AliRtcErrIceConnectionHeartbeatTimeout 

信令心跳超时，检查网络连接是否正常

AliRtcErrCdnLiveCommunicationFailed 

低延时互动直播信令失败

AliRtcErrCdnLiveMeidaSettingFailed 

低延时互动直播媒体设置错误

AliRtcErrCdnLiveNoneBroadcaster 

低延时互动直播当前房间没有主播推流

AliRtcErrCdnLiveNeedRestart 

低延时互动直播错误，应用层需要重新创建新的SDK实例

AliRtcErrCdnLiveNeedRestartAgainLater 

低延时互动直播错误，应用层需要稍等一定时间（自定义间隔）重新创建新的SDK实例

AliRtcErrCdnLiveServiceUnavailable 

低延迟互动直播服务不可用或者服务降级，客户端应该选择其它方式拉超大方会流，即不从cdn sfu拉流

AliRtcErrCdnLiveMediaConnectionInterruption 

低延迟互动直播网络中断错误，销毁当前sdk实例重新创建sdk后重新走订阅流程

AliRtcErrPublishInvaild 

推流无效

AliRtcErrPublishNotJoinChannel 

未进入频道推流失败

AliRtcErrPublishAudioStreamFailed 

推送音频流失败

AliRtcErrPublishVideoStreamFailed 

推送视频流失败

AliRtcErrPublishDualStreamFailed 

推送小流失败

AliRtcErrPublishScreenShareFailed 

推送屏幕共享失败

AliRtcErrPublishScreenShareConfigError 

屏幕共享配置错误

AliRtcErrSubscribeInvaild 

订阅无效

AliRtcErrSubscribeNotJoinChannel 

未进入频道订阅错误

AliRtcErrSubscribeAudioStreamFailed 

订阅音频流失败

AliRtcErrSubscribeVideoStreamFailed 

订阅视频流失败

AliRtcErrSubscribeDualStreamFailed 

订阅小流失败

AliRtcErrSubscribeScreenShareFailed 

订阅屏幕共享失败

AliRtcErrSdkInvalidState 

SDK状态错误，建议销毁SDK重新创建实例。

AliRtcErrInvalidArguments 

参数不匹配

AliRtcErrSessionRemoved 

Session已经被移除，建议销毁实例之后重新创建实例并加入频道。

AliRtcErrAudioBufferFull 

buffer队列饱和，用于外部输送裸数据功能，建议降低外部输入频次，设置等待20ms，并且单次不超过40ms数据。

AliRtcErrVideoBufferFull 

buffer队列饱和，用于外部输送裸数据功能，建议降低外部输入频次，设置等待视频帧间隔后再输入。

AliRtcErrUpdateRoleChannel 

互动模式下设置角色错误

AliRtcErrInner 

SDK内部错误

AliRtcErrNone 

状态正常，无错误

AliRtcErrJoinBadAppId 

AppId不存在，请在控制台创建应用

AliRtcErrJoinInvalidAppId 

AppId已失效，请在控制台重新启用应用

AliRtcErrJoinBadChannel 

频道不存在，请尝试重新加入频道 如会议发起者入会后又很快离会，第二个人随后入会，发现会议已经不存在了。

AliRtcErrJoinInvalidChannel 

频道已经失效（目前频道有效期为48小时），请重新生成频道鉴权令牌（Token）

AliRtcErrJoinBadToken 

Token无效。 请重新生成频道鉴权令牌（Token）

AliRtcErrJoinTimeout 

加入频道超时，请检查网络连接是否正常

AliRtcErrJoinBadParam 

参数错误，AliRtcAuthInfo中的字段为空或者timestamp<=0，请检查字段是否完整

AliRtcErrJoinChannelFailed 

加入频道失败

AliRtcErrLogAlreadyInit 

日志模块已经初始化

AliRtcErrLogRootPathError 

日志模块根路径错误，请检查路径是否存在或路径是否具有写入权限

AliRtcErrMicOpenFail 

采集设备初始化失败、采集设备媒体服务异常、音频设备被占用。

  • Mac端和Windows端查看系统设置中音频设备是否有能量条
  • iOS端和Android端确认是否被其他应用占用
  • 如果都正常，请重启设备
AliRtcErrSpeakerOpenFail 

播放设备初始化失败、播放设备媒体服务异常、音频设备被占用。

  • Mac端和Windows端查看系统设置中音频设备是否有能量条
  • iOS端和Android端确认是否被其他应用占用
  • 如果都正常，请重启设备
AliRtcErrMicInterrupt 

系统性能不足、采集设备媒体服务异常、音频设备被占用。建议重启应用或重启设备

AliRtcErrSpeakerInterrupt 

系统性能不足，播放设备媒体服务异常，音频设备被占用。建议重启应用或重启设备

AliRtcErrMicAuthFail 

麦克风设备未授权，建议去系统设置中，打开麦克风授权，并且重新加入频道

AliRtcErrMicNotAvailable 

无可用的音频采集设备，检查是否接入了可用的麦克风，并检查系统设置中，该设备是否被禁用

AliRtcErrSpeakerNotAvailable 

无可用的音频播放设备，检查是否接入了可用的扬声器或耳机，并检查系统设置中，该设备是否被禁用

AliRtcErrCameraOpenFail 

采集设备初始化失败，检查系统相机是否可用，移动端App是否占用了相机

AliRtcErrCameraInterrupt 

采集过程中出现异常，Mac、Winodows电脑相机采集灯熄灭，设备被强制中断。建议重新加入频道或者重启App

AliRtcErrDisplayOpenFail 

渲染设备初始化失败，检查Windows端显卡驱动是否需要升级，移动端手机型号或者Android平板盒子等外设是否支持OpenGL

AliRtcErrDisplayInterrupt 

渲染过程中出现异常，系统异常错误导致渲染引擎报错，重新加入频道或者重启App

AliRtcErrIceConnectionConnectFail 

媒体通道建立失败，检查网络连接是否正常

AliRtcErrIceConnectionReconnectFail 

媒体通道重连失败，检查网络连接是否正常

AliRtcErrIceConnectionHeartbeatTimeout 

信令心跳超时，检查网络连接是否正常

AliRtcErrCdnLiveCommunicationFailed 

低延时互动直播信令失败

AliRtcErrCdnLiveMeidaSettingFailed 

低延时互动直播媒体设置错误

AliRtcErrCdnLiveNoneBroadcaster 

低延时互动直播当前房间没有主播推流

AliRtcErrCdnLiveNeedRestart 

低延时互动直播错误，应用层需要重新创建新的SDK实例

AliRtcErrCdnLiveNeedRestartAgainLater 

低延时互动直播错误，应用层需要稍等一定时间（自定义间隔）重新创建新的SDK实例

AliRtcErrCdnLiveServiceUnavailable 

低延迟互动直播服务不可用或者服务降级，客户端应该选择其它方式拉超大方会流，即不从cdn sfu拉流

AliRtcErrCdnLiveMediaConnectionInterruption 

低延迟互动直播网络中断错误，销毁当前sdk实例重新创建sdk后重新走订阅流程

AliRtcErrPublishInvaild 

推流无效

AliRtcErrPublishNotJoinChannel 

未进入频道推流失败

AliRtcErrPublishAudioStreamFailed 

推送音频流失败

AliRtcErrPublishVideoStreamFailed 

推送视频流失败

AliRtcErrPublishDualStreamFailed 

推送小流失败

AliRtcErrPublishScreenShareFailed 

推送屏幕共享失败

AliRtcErrPublishScreenShareConfigError 

屏幕共享配置错误

AliRtcErrSubscribeInvaild 

订阅无效

AliRtcErrSubscribeNotJoinChannel 

未进入频道订阅错误

AliRtcErrSubscribeAudioStreamFailed 

订阅音频流失败

AliRtcErrSubscribeVideoStreamFailed 

订阅视频流失败

AliRtcErrSubscribeDualStreamFailed 

订阅小流失败

AliRtcErrSubscribeScreenShareFailed 

订阅屏幕共享失败

AliRtcErrSdkInvalidState 

SDK状态错误，建议销毁SDK重新创建实例。

AliRtcErrInvalidArguments 

参数不匹配

AliRtcErrSessionRemoved 

Session已经被移除，建议销毁实例之后重新创建实例并加入频道。

AliRtcErrAudioBufferFull 

buffer队列饱和，用于外部输送裸数据功能，建议降低外部输入频次，设置等待20ms，并且单次不超过40ms数据。

AliRtcErrVideoBufferFull 

buffer队列饱和，用于外部输送裸数据功能，建议降低外部输入频次，设置等待视频帧间隔后再输入。

AliRtcErrUpdateRoleChannel 

互动模式下设置角色错误

AliRtcErrInner 

SDK内部错误

◆ AliRtcOnByeType

enum AliRtcOnByeType : NSInteger

OnBye类型

枚举值
AliRtcOnByeBeKickedOut 

当前user被踢出channel

AliRtcOnByeChannelTerminated 

channel已结束，需要离开会议

AliRtcOnByeUserReplaced 

相同userID在其他设备joinChannel，当前设备被下线

AliRtcOnByeBeKickedOut 

当前user被踢出channel

AliRtcOnByeChannelTerminated 

channel已结束，需要离开会议

AliRtcOnByeUserReplaced 

相同userID在其他设备joinChannel，当前设备被下线

◆ AliRtcFeedbackType

enum AliRtcFeedbackType : NSInteger

SDK问题反馈类型

枚举值
AliRtcFeedbackVideoDeviceFail 

视频设备问题

AliRtcFeedbackVideoNotRender 

视频无画面

AliRtcFeedbackAudioDeviceFail 

音频设备问题

AliRtcFeedbackAudioNotRender 

音频无声音

AliRtcFeedbackAudioEchoError 

音频回声异常

AliRtcFeedbackChannelTypeError 

会议状态异常：入会异常、离会异常等

AliRtcFeedbackSDKTypeError 

SDK其他状态异常

AliRtcFeedbackNetworkUnfluent 

网络卡顿问题

AliRtcFeedbackVideoBlurring 

视频清晰问题

AliRtcFeedbackUnkonw 

未知类型

AliRtcFeedbackVideoDeviceFail 

视频设备问题

AliRtcFeedbackVideoNotRender 

视频无画面

AliRtcFeedbackAudioDeviceFail 

音频设备问题

AliRtcFeedbackAudioNotRender 

音频无声音

AliRtcFeedbackAudioEchoError 

音频回声异常

AliRtcFeedbackChannelTypeError 

会议状态异常：入会异常、离会异常等

AliRtcFeedbackSDKTypeError 

SDK其他状态异常

AliRtcFeedbackNetworkUnfluent 

网络卡顿问题

AliRtcFeedbackVideoBlurring 

视频清晰问题

AliRtcFeedbackUnkonw 

未知类型

◆ AliRtcTrascodingLiveTaskStatus

enum AliRtcTrascodingLiveTaskStatus : NSInteger

旁路推流LiveStream状态

枚举值
AliRtcTrascodingLiveTaskStatusStart 

任务开始

AliRtcTrascodingLiveTaskStatusUpdate 

任务更新

AliRtcTrascodingLiveTaskStatusStop 

任务已停止

AliRtcTrascodingLiveTaskStatusStart 

任务开始

AliRtcTrascodingLiveTaskStatusUpdate 

任务更新

AliRtcTrascodingLiveTaskStatusStop 

任务已停止

◆ AliRtcChannelRelayEvent

enum AliRtcChannelRelayEvent : NSInteger

跨频道转推事件

枚举值
AliRtcChannelRelayStart 

跨频道转推开始

AliRtcChannelRelayUpdate 

跨频道转推更新

AliRtcChannelRelayStop 

跨频道转推结束

AliRtcChannelRelayStart 

跨频道转推开始

AliRtcChannelRelayUpdate 

跨频道转推更新

AliRtcChannelRelayStop 

跨频道转推结束

◆ AliRtcChannelRelayState

enum AliRtcChannelRelayState : NSInteger

跨频道转推事件

枚举值
AliRtcChannelRelayStateInit 

跨频道转推初始化状态

AliRtcChannelRelayStateConnecting 

跨频道转推连接中状态

AliRtcChannelRelayStateRunning 

跨频道转推运行中状态

AliRtcChannelRelayStateFailure 

跨频道转推失败状态

AliRtcChannelRelayStateInit 

跨频道转推初始化状态

AliRtcChannelRelayStateConnecting 

跨频道转推连接中状态

AliRtcChannelRelayStateRunning 

跨频道转推运行中状态

AliRtcChannelRelayStateFailure 

跨频道转推失败状态

◆ AliRtcCaptureOutputPreference

enum AliRtcCaptureOutputPreference : NSInteger

采集偏好

枚举值
AliRtcCaptureOutputPreferenceAuto 

SDK自动调整采集参数

AliRtcCaptureOutputPreferencePerformance 

SDK优先保证设备性能，根据设置编码参数选择最接近的摄像头输出参数

AliRtcCaptureOutputPreferencePreview 

SDK优先保证视频预览质量，选择较高的摄像头输出参数

AliRtcCaptureOutputPreferenceAuto 

SDK自动调整采集参数

AliRtcCaptureOutputPreferencePerformance 

SDK优先保证设备性能，根据设置编码参数选择最接近的摄像头输出参数

AliRtcCaptureOutputPreferencePreview 

SDK优先保证视频预览质量，选择较高的摄像头输出参数

◆ AliRtcCameraDirection

enum AliRtcCameraDirection : NSInteger

摄像头方向

枚举值
AliRtcCameraDirectionInvalid 

无效，不可用

AliRtcCameraDirectionBack 

后置摄像头

AliRtcCameraDirectionFront 

前置摄像头

◆ AliRtcPublishState

enum AliRtcPublishState : NSInteger

推流状态

枚举值
AliRtcStatsPublishIdle 

0: SDK初始推流状态

AliRtcStatsNoPublish 

1: 未推流状态，可能是因为:

  • 已设置停止推送媒体流
  • 推送媒体流失败
AliRtcStatsPublishing 

2: 推流链接建立过程中

AliRtcStatsPublished 

3: 推流成功

◆ AliRtcSubscribeState

enum AliRtcSubscribeState : NSInteger

订阅状态

枚举值
AliRtcStatsSubscribeIdle 

初始状态

AliRtcStatsNoSubscribe 

未订阅

AliRtcStatsSubscribing 

订阅中

AliRtcStatsSubscribed 

已订阅

AliRtcStatsSubscribeIdle 

初始状态

AliRtcStatsNoSubscribe 

未订阅

AliRtcStatsSubscribing 

订阅中

AliRtcStatsSubscribed 

已订阅

◆ AliRtcUserOfflineReason

enum AliRtcUserOfflineReason : NSInteger

用户离线原因

枚举值
AliRtcUserOfflineQuit 

用户主动离开

AliRtcUserOfflineDropped 

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

AliRtcUserOfflineBecomeAudience 

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

AliRtcUserOfflineQuit 

用户主动离开

AliRtcUserOfflineDropped 

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

AliRtcUserOfflineBecomeAudience 

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

◆ AliRtcBokehScaleModel

enum AliRtcBokehScaleModel : NSUInteger

背景替换背景图缩放模式

枚举值
AliRtcBokehScaleModelCrop 

等比裁剪，当背景图像宽高比和视频数据宽高比不一致时, 为了保持等比例缩放, 会将背景图像裁剪到视频比例, 超出部分背景图片内容将会丢失

AliRtcBokehScaleModelFill 

填充黑边，当背景图像宽高比和视频数据宽高比不一致时, 为了保持等比例缩放, 会对背景进行黑边填充

AliRtcBokehScaleModelCrop 

等比裁剪，当背景图像宽高比和视频数据宽高比不一致时, 为了保持等比例缩放, 会将背景图像裁剪到视频比例, 超出部分背景图片内容将会丢失

AliRtcBokehScaleModelFill 

填充黑边，当背景图像宽高比和视频数据宽高比不一致时, 为了保持等比例缩放, 会对背景进行黑边填充

◆ AliRtcLiveTranscodingSegmentType

enum AliRtcLiveTranscodingSegmentType : NSUInteger

旁路直播输入类型

枚举值
AliRtcLiveTranscodingNoBody 

无人像分割

AliRtcLiveTranscodingBody 

人像分割

AliRtcLiveTranscodingNoBody 

无人像分割

AliRtcLiveTranscodingBody 

人像分割

◆ AliRtcLiveTranscodingSourceType

enum AliRtcLiveTranscodingSourceType : NSUInteger

旁路直播输入类型

枚举值
AliRtcLiveTranscodingCamera 

相机流

AliRtcLiveTranscodingShareScreen 

屏幕流

AliRtcLiveTranscodingCamera 

相机流

AliRtcLiveTranscodingShareScreen 

屏幕流

◆ AliRtcLiveTranscodingMixMode

enum AliRtcLiveTranscodingMixMode : NSUInteger

旁路模式

枚举值
AliRtcLiveTranscodingSINGLE 

单路模式

AliRtcLiveTranscodingMIX 

混流模式

AliRtcLiveTranscodingSINGLE 

单路模式

AliRtcLiveTranscodingMIX 

混流模式

◆ AliRtcLiveTranscodingStreamType

enum AliRtcLiveTranscodingStreamType : NSUInteger

旁路直播转推流模式

枚举值
AliRtcLiveTranscodingOrigin 

原始流

AliRtcLiveTranscodingAudio 

音频

AliRtcLiveTranscodingVideo 

视频

AliRtcLiveTranscodingOrigin 

原始流

AliRtcLiveTranscodingAudio 

音频

AliRtcLiveTranscodingVideo 

视频

◆ AliRtcLiveTranscodingMediaProcessMode

enum AliRtcLiveTranscodingMediaProcessMode : NSUInteger

旁路直播媒体处理模式

枚举值
AliRtcLiveTranscodingNormal 

通用模式

AliRtcLiveTranscodingVirtualBackground 

虚拟背景模式

AliRtcLiveTranscodingNormal 

通用模式

AliRtcLiveTranscodingVirtualBackground 

虚拟背景模式

◆ AliRtcLiveTranscodingCropMode

enum AliRtcLiveTranscodingCropMode : NSUInteger

旁路直播裁剪模式

枚举值
AliRtcLiveTranscodingCrop 

剪裁

AliRtcLiveTranscodingFill 

填充

AliRtcLiveTranscodingCrop 

剪裁

AliRtcLiveTranscodingFill 

填充

◆ AliRtcVideoState

enum AliRtcVideoState : NSInteger

视频状态

枚举值
AliRtcVideoClose 

视频关闭

AliRtcVideoOpen 

视频打开

AliRtcVideoClose 

视频关闭

AliRtcVideoOpen 

视频打开

◆ AliRtcVideoReason

enum AliRtcVideoReason : NSInteger

视频状态变化原因

枚举值
AliRtcVideoChangeByClient 

由客户端触发

AliRtcVideoChangeByServer 

由服务器触发

AliRtcVideoChangeByClient 

由客户端触发

AliRtcVideoChangeByServer 

由服务器触发

◆ AliRtcVideoEncodedFrameType

enum AliRtcVideoEncodedFrameType : NSInteger

Qos反馈外置编码器请求帧类型

枚举值
AliRtcVideoEncodedFrameNULL 

默认无

AliRtcVideoEncodedFrameIDR 

IDR帧

AliRtcVideoEncodedFrameLTR 

LTR帧

AliRtcVideoEncodedFrameB 

B帧

AliRtcVideoEncodedFrameNULL 

默认无

AliRtcVideoEncodedFrameIDR 

IDR帧

AliRtcVideoEncodedFrameLTR 

LTR帧

AliRtcVideoEncodedFrameB 

B帧