关键类型定义

类
struct	AliRTCSdk::AliEngineDeviceInfo
struct	AliEngineVideoRecordCanvasConfig
struct	AliEngineRecordVideoBgColor
struct	AliEngineRecordVideoRational
struct	AliEngineRecordVideoRectangle
struct	AliEngineRecordVideoRegion
class	AliRTCSdk::AliEngineRecordVideoRegionArray
struct	AliEngineRecordVideoLayout
struct	AliEngineRecordTemplate
struct	AliEngineScreenShareRegion
struct	AliEngineScreenSourcInfo
class	AliRTCSdk::AliEngineScreenSourceList
struct	AliEngineAuthInfo
struct	AliEngineAuthInfoList
struct	AliEngineCameraCapturerConfiguration
struct	AliRTCSdk::AliEngineVideoDimensions
struct	AliRTCSdk::AliEngineVideoEncoderConfiguration
struct	AliRTCSdk::AliEngineScreenShareEncoderConfiguration
struct	AliEngineVideoCanvas
struct	AliEngineRecordAudioConfig
struct	AliEngineRecordVideoConfig
struct	AliEngineUserVolumeInfo
struct	AliEngineStats
struct	AliEngineLocalVideoStats
struct	AliEngineRemoteVideoStats
struct	AliEngineLocalAudioStats
struct	AliEngineRemoteAudioStats
struct	AliEngineBeautyConfig
struct	AliEngineWaterMarkPosition
struct	AliEngineWaterMarkConfig
struct	AliEngineScreenShareConfig
struct	AliEngineScreenShareInfo
struct	AliEngineMessage
struct	AliEngineMessageResponse
struct	AliRTCSdk::AliEngineChannelRelayConfiguration
struct	AliRTCSdk::AliEngineLiveTranscodingEncodeParam
struct	AliRTCSdk::AliEngineLiveTranscodingImage
class	AliRTCSdk::AliEngineLiveTranscodingImageArray
struct	AliRTCSdk::AliEngineLiveTranscodingClockWidget
class	AliRTCSdk::AliEngineLiveTranscodingClockWidgetArray
struct	AliRTCSdk::AliEngineLiveTranscodingText
class	AliRTCSdk::AliEngineLiveTranscodingTextArray
struct	AliRTCSdk::AliEngineLiveTranscodingUser
class	AliRTCSdk::AliEngineLiveTranscodingUserArray
struct	AliRTCSdk::AliEngineLiveTranscodingSingleParam
struct	AliRTCSdk::AliEngineLiveTranscodingMixParam
struct	AliRTCSdk::AliEngineLiveTranscodingParam
struct	AliEngineScrollViewConfig
struct	AliEngineVideoExternalEncoderParameter
struct	AliEngineAudioRawData
struct	AliEngineVideoRawData
class	AliRTCSdk::String
class	AliRTCSdk::StringArray
class	AliRTCSdk::Dictionary

枚举
enum	AliRTCSdk::AliEngineDeviceTransportType
enum	AliRTCSdk::AliEngineInterfaceIdType
enum	AliRTCSdk::AliEngineChannelProfile
enum	AliRTCSdk::AliEngineClientRole
enum	AliRTCSdk::AliEngineNetworkQuality
enum	AliRTCSdk::AliEngineRenderMirrorMode
enum	AliRTCSdk::AliEngineCameraDirection
enum	AliRTCSdk::AliEngineCaptureOutputPreference
enum	AliRTCSdk::AliEngineVideoScale
enum	AliRTCSdk::AliEngineLogLevel
enum	AliRTCSdk::AliEngineOrientationMode
enum	AliRTCSdk::AliEngineMuteLocalAudioMode
enum	AliRTCSdk::AliEngineAudioEffectVoiceChangerMode
enum	AliRTCSdk::AliEngineAudioEffectReverbMode
enum	AliRTCSdk::AliEngineAudioEffectReverbParamType
enum	AliRTCSdk::AliEngineRecordType
enum	AliRTCSdk::AliEngineRecordFormat
enum	AliRTCSdk::AliEngineAudioQuality
enum	AliRTCSdk::AliEngineVideoQuality
enum	AliRTCSdk::AliEngineRecordVideoLayoutMode
enum	AliRTCSdk::AliEngineOnByeType
enum	AliRTCSdk::AliEngineErrorCode
enum	AliRTCSdk::AliEngineFeedbackType
enum	AliRTCSdk::AliEngineAudioPlayingType
enum	AliRTCSdk::AliEngineAudioPlayingErrorCode
enum	AliRTCSdk::AliEngineConnectionStatus
enum	AliRTCSdk::AliEngineConnectionStatusChangeReason
enum	AliRTCSdk::AliEngineScreenShareType
enum	AliRTCSdk::AliEngineExternalDeviceType
enum	AliRTCSdk::AliEngineExternalDeviceState
enum	AliRTCSdk::AliEngineAudioRouteType
enum	AliRTCSdk::AliEngineAudioFocusType
enum	AliRTCSdk::AliEnginePublishState
enum	AliRTCSdk::AliEngineSubscribeState
enum	AliRTCSdk::AliEngineLiveTranscodingErrorCode
enum	AliRTCSdk::AliEngineTrascodingPublishTaskStatus
enum	AliRTCSdk::AliEngineUserOfflineReason
enum	AliRTCSdk::AliEngineAudioProfile
enum	AliRTCSdk::AliEngineAudioScenario
enum	AliRTCSdk::AliEngineChannelRelayEvent
enum	AliRTCSdk::AliEngineChannelRelayState
enum	AliRTCSdk::AliEngineChannelRelayErrorCode
enum	AliRTCSdk::AliEngineShowDebugViewType
enum	AliRTCSdk::AliEngineFrameRate
enum	AliRTCSdk::AliEngineVideoEncoderBitrate
enum	AliRTCSdk::AliEngineVideoEncoderOrientationMode
enum	AliRTCSdk::AliEngineVideoMirrorMode
enum	AliRTCSdk::AliEngineLiveTranscodingState
enum	AliRTCSdk::AliEngineLiveTranscodingMixMode
enum	AliRTCSdk::AliEngineLiveTranscodingStreamType
enum	AliRTCSdk::AliEngineLiveTranscodingSourceType
enum	AliRTCSdk::AliEngineLiveTranscodingTaskProfile
enum	AliRTCSdk::AliEngineLiveTranscodingAudioSampleRate
enum	AliEngineLiveTranscodingFontType
enum	AliRTCSdk::AliEngineLiveTranscodingCropMode
enum	AliRTCSdk::AliEngineLiveTranscodingMediaProcessMode
enum	AliRTCSdk::AliEngineLiveTranscodingSegmentType
enum	AliRTCSdk::AliEngineVideoState
enum	AliRTCSdk::AliEngineVideoReason
enum	AliRTCSdk::AliEngineVideoEncodedFrameType
enum	AliRTCSdk::AliEnginePluginErrorCode
enum	AliRTCSdk::AliEnginePluginDataType
enum	AliRTCSdk::AliEnginePluginOperationType
enum	AliRTCSdk::AliEngineBokehScaleModel
enum	AliRTCSdk::AliEngineAudioTrack
enum	AliRTCSdk::AliEngineVideoTrack
enum	AliRTCSdk::AliEngineVideoStreamType
enum	AliRTCSdk::AliEngineVideoSource
enum	AliRTCSdk::AliEngineVideoRecordSource
enum	AliRTCSdk::AliEngineVideoFormat
enum	AliRTCSdk::AliEngineBufferType
enum	AliRTCSdk::AliEngineTextureType
enum	AliRTCSdk::AliEngineRenderMode
enum	AliRTCSdk::AliEngineRotationMode
enum	AliRTCSdk::AliEngineAudioNumChannelType
enum	AliRTCSdk::AliEngineAudioSampleRate
enum	AliRTCSdk::AliEngineAudioSource
enum	AliRTCSdk::AliEngineVideoObserPosition
enum	AliRTCSdk::AliEngineVideoObserAlignment

详细描述

---

类说明

AliRTCSdk::AliEngineDeviceInfo

struct AliRTCSdk::AliEngineDeviceInfo

Public 属性
String	deviceName
String	deviceID
AliEngineDeviceTransportType	deviceTransportType

AliEngineVideoRecordCanvasConfig

struct AliEngineVideoRecordCanvasConfig

注解

画布大小

Public 属性
int	canvasWidth
int	canvasHeight

AliEngineRecordVideoBgColor

struct AliEngineRecordVideoBgColor

Public 属性
unsigned char	r
unsigned char	g
unsigned char	b

AliEngineRecordVideoRational

struct AliEngineRecordVideoRational

Public 属性
unsigned int	numerator
unsigned int	denominator

AliEngineRecordVideoRectangle

struct AliEngineRecordVideoRectangle

Public 属性
AliEngineRecordVideoRational	left
AliEngineRecordVideoRational	top
AliEngineRecordVideoRational	width
AliEngineRecordVideoRational	height

AliEngineRecordVideoRegion

struct AliEngineRecordVideoRegion

Public 属性
char *	userId
AliEngineVideoSource	sourceType
AliEngineRecordVideoRectangle	area

AliRTCSdk::AliEngineRecordVideoRegionArray

class AliRTCSdk::AliEngineRecordVideoRegionArray

Public 成员函数
	AliEngineRecordVideoRegionArray (const AliEngineRecordVideoRegionArray &other)
AliEngineRecordVideoRegionArray &	operator= (const AliEngineRecordVideoRegionArray &other)
void	AddRecordVideoRegion (const AliEngineRecordVideoRegion &item)
const AliEngineRecordVideoRegion &	GetRecordVideoRegion (int index) const
void	Clear ()
int	Count () const

AliEngineRecordVideoLayout

struct AliEngineRecordVideoLayout

Public 属性
AliEngineRecordVideoLayoutMode	mode
AliEngineRecordVideoRegionArray	shapes
AliEngineRecordVideoBgColor	backColor

AliEngineRecordTemplate

struct AliEngineRecordTemplate

Public 属性
AliEngineRecordType	recordType
AliEngineRecordFormat	recordFormat
AliEngineAudioSampleRate	sampleRate
AliEngineAudioQuality	audioQuality
bool	externalPcmCaptureRecording
bool	externalPcmRenderRecording
AliEngineVideoRecordCanvasConfig	canvas
bool	isFragment
int	fps
int	bitrate

AliEngineScreenShareRegion

struct AliEngineScreenShareRegion

Public 属性
float	originX
float	originY
float	width
float	height

AliEngineScreenSourcInfo

struct AliEngineScreenSourcInfo

Public 属性
String	sourceId
String	sourceName

AliRTCSdk::AliEngineScreenSourceList

class AliRTCSdk::AliEngineScreenSourceList

Public 成员函数
virtual unsigned int	GetCount ()=0
virtual AliEngineScreenSourcInfo	GetSourceInfo (unsigned int index)=0
virtual void	Release ()=0

AliEngineAuthInfo

struct AliEngineAuthInfo

Public 属性
char *	channelId
char *	userId
char *	appId
char *	nonce
char *	token
char *	role
char *	session
char **	gslb
int	gslbCount
char **	agent
int	agentCount
unsigned long long	timestamp
char *	tokenType

AliEngineAuthInfoList

struct AliEngineAuthInfoList

Public 成员函数
	_tagAliEngineAuthInfoList (int size)
Public 属性
AliEngineAuthInfo *	infoList
int	count

AliEngineCameraCapturerConfiguration

struct AliEngineCameraCapturerConfiguration

Public 属性
AliEngineCaptureOutputPreference	preference

AliRTCSdk::AliEngineVideoDimensions

struct AliRTCSdk::AliEngineVideoDimensions

Public 成员函数
	AliEngineVideoDimensions (int w, int h)
Public 属性
int	width
int	height

AliRTCSdk::AliEngineVideoEncoderConfiguration

struct AliRTCSdk::AliEngineVideoEncoderConfiguration

Public 成员函数
	AliEngineVideoEncoderConfiguration (const AliEngineVideoDimensions &d, AliEngineFrameRate f, int b, AliEngineVideoEncoderOrientationMode m, AliEngineVideoMirrorMode mr=AliEngineVideoMirrorModeDisabled, AliEngineRotationMode rotation=AliEngineRotationMode_0)
	AliEngineVideoEncoderConfiguration (int width, int height, AliEngineFrameRate f, int b, AliEngineVideoEncoderOrientationMode m, AliEngineVideoMirrorMode mr=AliEngineVideoMirrorModeDisabled, AliEngineRotationMode rotation=AliEngineRotationMode_0)
Public 属性
AliEngineVideoDimensions	dimensions
AliEngineFrameRate	frameRate
int	bitrate
AliEngineVideoEncoderOrientationMode	orientationMode
AliEngineVideoMirrorMode	mirrorMode
AliEngineRotationMode	rotationMode

类成员变量说明

bitrate

int AliRTCSdk::AliEngineVideoEncoderConfiguration::bitrate

视频编码码率(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

AliRTCSdk::AliEngineScreenShareEncoderConfiguration

struct AliRTCSdk::AliEngineScreenShareEncoderConfiguration

Public 成员函数
	AliEngineScreenShareEncoderConfiguration (const AliEngineVideoDimensions &d, AliEngineFrameRate f, int b, AliEngineRotationMode rotation)
	AliEngineScreenShareEncoderConfiguration (int width, int height, AliEngineFrameRate f, int b, AliEngineRotationMode rotation)
Public 属性
AliEngineVideoDimensions	dimensions
AliEngineFrameRate	frameRate
int	bitrate
AliEngineRotationMode	rotationMode

类成员变量说明

dimensions

AliEngineVideoDimensions AliRTCSdk::AliEngineScreenShareEncoderConfiguration::dimensions

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

注解

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

bitrate

int AliRTCSdk::AliEngineScreenShareEncoderConfiguration::bitrate

视频编码码率(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

AliEngineVideoCanvas

struct AliEngineVideoCanvas

Public 属性
void *	displayView
int	backgroundColor
AliEngineRenderMode	renderMode
AliEngineRenderMirrorMode	mirrorMode
AliEngineVideoScale	scaleMode
AliEngineRotationMode	rotation
long long	renderId
int	width
int	height
bool	enableGL

类成员变量说明

enableGL

bool AliEngineVideoCanvas::enableGL

该参数只在iOS和Mac平台生效，

• true : 使用OpenGL ES 渲染
• false : 使用Metal渲染

AliEngineRecordAudioConfig

struct AliEngineRecordAudioConfig

Public 属性
AliEngineAudioSampleRate	sampleRate
AliEngineAudioQuality	quality
bool	externalPcmCaptureRecording
bool	externalPcmRenderRecording

AliEngineRecordVideoConfig

struct AliEngineRecordVideoConfig

Public 属性
int	fps
int	bitrate
AliEngineVideoQuality	quality
AliEngineVideoRecordSource	sourceType
AliEngineVideoRecordCanvasConfig	canvas

AliEngineUserVolumeInfo

struct AliEngineUserVolumeInfo

Public 属性
String	uid
bool	speechState
int	volume
int	sumVolume

AliEngineStats

struct AliEngineStats

Public 属性
long long	availableSendBitrate
long long	sentKBitrate
long long	rcvdKBitrate
long long	sentBytes
long long	rcvdBytes
long long	videoRcvdKBitrate
long long	videoSentKBitrate
unsigned int	systemCpu
unsigned int	appCpu
unsigned long long	callDuration
long long	sentLossRate
long long	sentLossPkts
long long	sentExpectedPkts
long long	rcvdLossRate
long long	rcvdLossPkts
long long	rcvdExpectedPkts
long long	lastmileDelay

AliEngineLocalVideoStats

struct AliEngineLocalVideoStats

Public 属性
AliEngineVideoTrack	track
unsigned int	targetEncodeBitrate
unsigned int	actualEncodeBitrate
unsigned int	sentBitrate
unsigned int	sentFps
unsigned int	encodeFps
unsigned int	captureFps
unsigned int	avgQpPerSec

AliEngineRemoteVideoStats

struct AliEngineRemoteVideoStats

Public 属性
const char *	userId
AliEngineVideoTrack	track
unsigned int	width
unsigned int	height
unsigned int	decodeFps
unsigned int	renderFps
unsigned int	frozenTimes

AliEngineLocalAudioStats

struct AliEngineLocalAudioStats

Public 属性
AliEngineAudioTrack	track
unsigned int	sentBitrate
unsigned int	sentSamplerate
unsigned int	numChannel
unsigned int	inputLevel

AliEngineRemoteAudioStats

struct AliEngineRemoteAudioStats

Public 属性
const char *	userId
AliEngineAudioTrack	track
int	quality
int	networkTransportDelay
int	jitterBufferDelay
int	audioLossRate
int	rcvdBitrate
int	totalFrozenTimes

AliEngineBeautyConfig

struct AliEngineBeautyConfig

Public 属性
float	whiteningLevel
float	smoothnessLevel

AliEngineWaterMarkPosition

struct AliEngineWaterMarkPosition

Public 属性
float	x
float	y
float	w
float	h

AliEngineWaterMarkConfig

struct AliEngineWaterMarkConfig

Public 属性
bool	visibleInPreview
AliEngineWaterMarkPosition	positionInPortraitMode
AliEngineWaterMarkPosition	positionInLandscapeMode
float	alpha
bool	normalized

AliEngineScreenShareConfig

struct AliEngineScreenShareConfig

Public 成员函数
void	clear ()
Public 属性
bool	isShareByRegion
AliEngineScreenShareRegion	shareRegion

AliEngineScreenShareInfo

struct AliEngineScreenShareInfo

Public 属性
AliEngineScreenShareType	shareType
unsigned int	shareSourceId
AliEngineScreenShareConfig	shareConfig

AliEngineMessage

struct AliEngineMessage

注解

已废弃使用

Public 属性
String	tID
String	contentType
String	content

AliEngineMessageResponse

struct AliEngineMessageResponse

注解

已废弃使用

Public 属性
int	result
String	contentType
String	content

AliRTCSdk::AliEngineChannelRelayConfiguration

struct AliRTCSdk::AliEngineChannelRelayConfiguration

Public 成员函数
	AliEngineChannelRelayConfiguration (int size)
Public 属性
AliEngineAuthInfo *	dests
int	destsSize

AliRTCSdk::AliEngineLiveTranscodingEncodeParam

struct AliRTCSdk::AliEngineLiveTranscodingEncodeParam

Public 属性
int	videoWidth
int	videoHeight
int	videoFramerate
int	videoBitrate
int	videoGop
AliEngineLiveTranscodingAudioSampleRate	audioSamplerate
int	audioBitrate
int	audioChannels

AliRTCSdk::AliEngineLiveTranscodingImage

struct AliRTCSdk::AliEngineLiveTranscodingImage

Public 类型
enum	DisplayType
Public 属性
String	url
float	alpha
DisplayType	display
int	x
int	y
int	width
int	height
int	zOrder

AliRTCSdk::AliEngineLiveTranscodingImageArray

class AliRTCSdk::AliEngineLiveTranscodingImageArray

Public 成员函数
	AliEngineLiveTranscodingImageArray (const AliEngineLiveTranscodingImageArray &other)
AliEngineLiveTranscodingImageArray &	operator= (const AliEngineLiveTranscodingImageArray &other)
void	Add (const AliEngineLiveTranscodingImage &item)
AliEngineLiveTranscodingImage	Get (int index) const
void	Clear ()
int	Count () const

AliRTCSdk::AliEngineLiveTranscodingClockWidget

struct AliRTCSdk::AliEngineLiveTranscodingClockWidget

Public 属性
int	x
int	y
AliEngineLiveTranscodingFontType	fontType
int	fontSize
int	fontColor
int	zOrder

AliRTCSdk::AliEngineLiveTranscodingClockWidgetArray

class AliRTCSdk::AliEngineLiveTranscodingClockWidgetArray

Public 成员函数
	AliEngineLiveTranscodingClockWidgetArray (const AliEngineLiveTranscodingClockWidgetArray &other)
AliEngineLiveTranscodingClockWidgetArray &	operator= (const AliEngineLiveTranscodingClockWidgetArray &other)
void	Add (const AliEngineLiveTranscodingClockWidget &item)
AliEngineLiveTranscodingClockWidget	Get (int index) const
void	Clear ()
int	Count () const

AliRTCSdk::AliEngineLiveTranscodingText

struct AliRTCSdk::AliEngineLiveTranscodingText

Public 属性
String	text
int	x
int	y
int	zOrder
AliEngineLiveTranscodingFontType	fontType
int	fontSize
int	fontColor

AliRTCSdk::AliEngineLiveTranscodingTextArray

class AliRTCSdk::AliEngineLiveTranscodingTextArray

Public 成员函数
	AliEngineLiveTranscodingTextArray (const AliEngineLiveTranscodingTextArray &other)
AliEngineLiveTranscodingTextArray &	operator= (const AliEngineLiveTranscodingTextArray &other)
void	Add (const AliEngineLiveTranscodingText &item)
AliEngineLiveTranscodingText	Get (int index) const
void	Clear ()
int	Count () const

AliRTCSdk::AliEngineLiveTranscodingUser

struct AliRTCSdk::AliEngineLiveTranscodingUser

Public 成员函数
bool	operator== (const AliEngineLiveTranscodingUser &rhs) const
Public 属性
String	userId
int	x
int	y
int	width
int	height
int	zOrder
AliEngineLiveTranscodingSourceType	sourceType
AliEngineLiveTranscodingSegmentType	segmentType
AliEngineLiveTranscodingImageArray	images
AliEngineLiveTranscodingTextArray	texts

AliRTCSdk::AliEngineLiveTranscodingUserArray

class AliRTCSdk::AliEngineLiveTranscodingUserArray

Public 成员函数
	AliEngineLiveTranscodingUserArray (const AliEngineLiveTranscodingUserArray &other)
AliEngineLiveTranscodingUserArray &	operator= (const AliEngineLiveTranscodingUserArray &other)
void	AddTranscodingUser (const AliEngineLiveTranscodingUser &item)
void	RemoveTranscodingUser (const AliEngineLiveTranscodingUser &item)
AliEngineLiveTranscodingUser	GetTranscodingUser (int index) const
void	Clear ()
int	Count () const

AliRTCSdk::AliEngineLiveTranscodingSingleParam

struct AliRTCSdk::AliEngineLiveTranscodingSingleParam

Public 属性
String	userId
AliEngineLiveTranscodingStreamType	streamType
AliEngineLiveTranscodingSourceType	sourceType

AliRTCSdk::AliEngineLiveTranscodingMixParam

struct AliRTCSdk::AliEngineLiveTranscodingMixParam

Public 属性
AliEngineLiveTranscodingTaskProfile	taskProfile
AliEngineLiveTranscodingEncodeParam	encodeParam
AliEngineLiveTranscodingUserArray	users
int	backgroundColor
AliEngineLiveTranscodingImageArray	backgrounds
AliEngineLiveTranscodingImageArray	watermarks
AliEngineLiveTranscodingClockWidgetArray	clockWidgets
AliEngineLiveTranscodingCropMode	cropMode
AliEngineLiveTranscodingMediaProcessMode	mediaProcessMode

AliRTCSdk::AliEngineLiveTranscodingParam

struct AliRTCSdk::AliEngineLiveTranscodingParam

Public 属性
AliEngineLiveTranscodingMixMode	mixMode
AliEngineLiveTranscodingSingleParam	singleParam
AliEngineLiveTranscodingMixParam	mixParam

AliEngineScrollViewConfig

struct AliEngineScrollViewConfig

注解

已废弃使用

Public 属性
float	fOriginX
float	fOriginY
float	width
float	height
AliEngineRenderMode	renderMode
AliEngineVideoTrack	videoTrack

AliEngineVideoExternalEncoderParameter

struct AliEngineVideoExternalEncoderParameter

Public 属性
int32_t	width
int32_t	height
int32_t	frame_rate
uint32_t	bitrate_bps

AliEngineAudioRawData

struct AliEngineAudioRawData

Public 属性
void *	dataPtr
int	numOfSamples
int	bytesPerSample
int	numOfChannels
int	sampleRate
int	samplesPerSec

AliEngineVideoRawData

struct AliEngineVideoRawData

Public 属性
AliEngineVideoFormat	format
AliEngineBufferType	type
long	dataLength
void *	pixelBuffer
void *	dataPtr
void *	dataYPtr
void *	dataUPtr
void *	dataVPtr
int	strideY
int	strideU
int	strideV
int	height
int	width
int	rotation
int	stride
long long	timeStamp
int	textureId
float	transformMatrix [16]

AliRTCSdk::String

class AliRTCSdk::String

Public 成员函数
	String (const char *str=0)
	String (const String &other)
String &	operator= (const String &other)
String &	operator= (const char *str)
String	operator+ (const String &other) const
String &	operator+= (const String &other)
bool	operator== (const String &) const
char &	operator[] (unsigned int)
const char *	c_str () const
bool	isEmpty () const
int	size () const

AliRTCSdk::StringArray

class AliRTCSdk::StringArray

Public 成员函数
	StringArray (const StringArray &other)
StringArray &	operator= (const StringArray &other)
void	addString (const String &s)
void	clear ()
int	size () const
String	at (int index) const

AliRTCSdk::Dictionary

class AliRTCSdk::Dictionary

Public 成员函数
	Dictionary (const Dictionary &other)
Dictionary &	operator= (const Dictionary &other)
void	setValue (const char *key, const char *val)
void	setValue (const char *key, bool val)
String	getValue (const char *key)
bool	getBoolValue (const char *key, bool defVal)
StringArray	keys () const

枚举类型说明

AliEngineChannelProfile

enum AliRTCSdk::AliEngineChannelProfile

频道类型

枚举值
AliEngineCommunication	通信模式
AliEngineInteractiveLive	互动模式
AliEngineInteractiveWithLowLatencyLive	低延时互动直播模式

AliEngineClientRole

enum AliRTCSdk::AliEngineClientRole

用户角色类型

枚举值
AliEngineClientRoleInteractive	互动角色
AliEngineClientRoleLive	观众角色

AliEngineNetworkQuality

enum AliRTCSdk::AliEngineNetworkQuality

网络质量

枚举值
AliEngineNetworkQualityExcellent	网络极好，流程度清晰度质量好
AliEngineNetworkQualityGood	网络好，流畅度清晰度和极好差不多
AliEngineNetworkQualityPoor	网络较差，音视频流畅度清晰度有瑕疵，不影响沟通
AliEngineNetworkQualityBad	网络差，视频卡顿严重，音频能正常沟通
AliEngineNetworkQualityVeryBad	网络极差，基本无法沟通
AliEngineNetworkQualityDisconnect	网络中断
AliEngineNetworkQualityUnknow	未知

AliEngineRenderMirrorMode

enum AliRTCSdk::AliEngineRenderMirrorMode

视频窗口镜像模式

枚举值
AliEngineRenderMirrorModeOnlyFrontMirror	只有前置摄像头预览镜像，其余不镜像
AliEngineRenderMirrorModeAllMirror	镜像开启
AliEngineRenderMirrorModeAllNoMirror	镜像关闭
AliEngineRenderMirrorModeNoChange	占位符，无意义

AliEngineCameraDirection

enum AliRTCSdk::AliEngineCameraDirection

摄像头方向

枚举值
AliEngineCameraDirectionInvalid	无效，不可用
AliEngineCameraDirectionBack	后置摄像头
AliEngineCameraDirectionFront	前置摄像头

AliEngineCaptureOutputPreference

enum AliRTCSdk::AliEngineCaptureOutputPreference

采集偏好

枚举值
AliEngineCaptureOutputPreferencePerformance	根据设置的publsh profile 分辨率和帧率，选择最接近的摄像头输出参数
AliEngineCaptureOutputPreferencePreview	选择较高的摄像头输出参数

AliEngineVideoScale

enum AliRTCSdk::AliEngineVideoScale

视频宽高比

枚举值
AliEngineVideoScale_16_9	16 : 9
AliEngineVideoScale_4_3	4 : 3

AliEngineLogLevel

enum AliRTCSdk::AliEngineLogLevel

日志级别

枚举值
AliEngineLogLevelInfo	只输出>=AliEngineLogLevelInfo 级别的日志
AliEngineLogLevelWarn	只输出>=AliEngineLogLevelWarn 级别的日志
AliEngineLogLevelError	只输出>=AliEngineLogLevelError 级别的日志
AliEngineLogLevelFatal	只输出>=AliEngineLogLevelFatal 级别的日志
AliEngineLogLevelNone	不输出日志

AliEngineOrientationMode

enum AliRTCSdk::AliEngineOrientationMode

视频设备方向

枚举值
AliEngineOrientationModePortrait	固定竖屏模式
AliEngineOrientationModeLandscapeLeft	固定左横屏模式
AliEngineOrientationModePortraitUpsideDown	固定倒立模式
AliEngineOrientationModeLandscapeRight	固定右横屏模式
AliEngineOrientationModeAuto	自适应模式

AliEngineMuteLocalAudioMode

enum AliRTCSdk::AliEngineMuteLocalAudioMode

本地静音模式

枚举值
AliEngineMuteLocalAudioModeDefault	默认模式(静音全部，包括麦克风及外部输入音频)
AliEngineMuteLocalAudioModeMuteAll	静音全部(包括麦克风及外部输入音频)
AliEngineMuteLocalAudioModeMuteOnlyMic	只静音麦克风

AliEngineAudioEffectVoiceChangerMode

enum AliRTCSdk::AliEngineAudioEffectVoiceChangerMode

变声音效模式类型枚举

枚举值
AliEngineAudioEffectVoiceChangerOff	关闭变声音效
AliEngineAudioEffectVoiceChangerOldMan	老人
AliEngineAudioEffectVoiceChangerBabyBoy	男孩
AliEngineAudioEffectVoiceChangerBabGirl	女孩
AliEngineAudioEffectVoiceChangerRobot	机器人
AliEngineAudioEffectVoiceChangerDaimo	大魔王
AliEngineAudioEffectVoiceChangerKTV	KTV
AliEngineAudioEffectVoiceChangerEcho	回声

AliEngineAudioEffectReverbMode

enum AliRTCSdk::AliEngineAudioEffectReverbMode

混响模式类型枚举

枚举值
AliEngineAudioEffectReverbOff	关闭混响
AliEngineAudioEffectReverbVocal_I	人声I
AliEngineAudioEffectReverbVocal_II	人声II
AliEngineAudioEffectReverbBathroom	澡堂
AliEngineAudioEffectReverbSmallRoomBright	明亮小房间
AliEngineAudioEffectReverbSmallRoomDark	黑暗小房间
AliEngineAudioEffectReverbMediumRoom	中等房间
AliEngineAudioEffectReverbLargeRoom	大房间
AliEngineAudioEffectReverbChurchHall	教堂走廊

AliEngineAudioEffectReverbParamType

enum AliRTCSdk::AliEngineAudioEffectReverbParamType

混响参数类型枚举

枚举值
AliEngineAudioEffectReverbRoomSize	房间大小，取值范围：[0, 100]
AliEngineAudioEffectReverbPreDelay	预延时，单位ms，取值范围：[0, 200]
AliEngineAudioEffectReverbReverberance	混响感，取值范围：[0, 100]
AliEngineAudioEffectReverbHfDamping	消声，取值范围：[0, 100]
AliEngineAudioEffectReverbToneLow	低音调，取值范围：[0, 100]
AliEngineAudioEffectReverbToneHigh	高音调，取值范围：[0, 100]
AliEngineAudioEffectReverbDryGain	干增益，取值范围：[-20, 10]
AliEngineAudioEffectReverbWetGain	湿增益，取值范围：[-20, 10]

AliEngineRecordType

enum AliRTCSdk::AliEngineRecordType

录制类型

枚举值
AliEngineRecordTypeAudio	录制单个音频文件
AliEngineRecordTypeVideo	录制单个音视频文件
AliEngineRecordTypeBoth	录制纯音频和音视频文件

AliEngineRecordFormat

enum AliRTCSdk::AliEngineRecordFormat

录制格式

枚举值
AliEngineRecordFormatAAC	录制AAC格式文件
AliEngineRecordFormatWAV	录制WAV格式文件
AliEngineRecordFormatMP4	录制MP4格式文件

AliEngineAudioQuality

enum AliRTCSdk::AliEngineAudioQuality

录制音频质量

枚举值
AliEngineAudioQualityLow	低质量文件录制，文件体积较小，音质一般
AliEngineAudioQualityMidium	中等质量文件录制，文件体积中等，音质中等
AliEngineAudioQualityHigh	高质量文件录制，文件体积较大，音质较好

AliEngineVideoQuality

enum AliRTCSdk::AliEngineVideoQuality

录制视频质量

枚举值
AliEngineVideoQualityDefault	录制默认质量视频, 和采集一致

AliEngineRecordVideoLayoutMode

enum AliRTCSdk::AliEngineRecordVideoLayoutMode

录制视频布局

枚举值
AliEngineRecordVideoLayoutModeGrid	网格布局
AliEngineRecordVideoLayoutModeSpeaker	演讲者布局
AliEngineRecordVideoLayoutModeUnique	只有一个画面布局
AliEngineRecordVideoLayoutModeCustom	自定义布局

AliEngineOnByeType

enum AliRTCSdk::AliEngineOnByeType

OnBye类型

枚举值
AliEngineOnByeBeKickOut	当前user被踢出channel
AliEngineOnByeChannelTerminated	channel已结束，需要离开会议
AliEngineOnByeUserReplaced	相同userID在其他设备 JoinChannel，当前设备被下线

AliEngineErrorCode

enum AliRTCSdk::AliEngineErrorCode

SDK错误码

枚举值
AliEngineErrorJoinBadAppId	AppId不存在，请在控制台创建应用
AliEngineErrorJoinInvaildAppId	AppId已失效，请在控制台重新启用应用
AliEngineErrorJoinBadChannel	频道不存在，请尝试重新加入频道 如会议发起者入会后又很快离会，第二个人随后入会，发现会议已经不存在了。
AliEngineErrorJoinInvaildChannel	频道已经失效（目前频道有效期为48小时），请重新生成频道鉴权令牌（Token）
AliEngineErrorJoinBadToken	Token无效。 请重新生成频道鉴权令牌（Token）
AliEngineErrorJoinTimeout	加入频道超时，请检查网络连接是否正常
AliEngineErrorJoinBadParam	参数错误，AliEngineAuthInfo中的字段为空或者timestamp<=0，请检查字段是否完整
AliEngineErrorJoinChannelFailed	加入频道失败
AliEngineErrorLogAlreadyInit	日志模块已经初始化
AliEngineErrorLogRootPathError	日志模块根路径错误，请检查路径是否存在或路径是否具有写入权限
AliEngineErrorMicOpenFail	采集设备初始化失败、采集设备媒体服务异常、音频设备被占用。 Mac端和Windows端查看系统设置中音频设备是否有能量条 iOS端和Android端确认是否被其他应用占用 如果都正常，请重启设备
AliEngineErrorSpeakerOpenFail	播放设备初始化失败、播放设备媒体服务异常、音频设备被占用。 Mac端和Windows端查看系统设置中音频设备是否有能量条 iOS端和Android端确认是否被其他应用占用 如果都正常，请重启设备
AliEngineErrorMicInterrupt	系统性能不足、采集设备媒体服务异常、音频设备被占用。建议重启应用或重启设备
AliEngineErrorSpeakerInterrupt	系统性能不足，播放设备媒体服务异常，音频设备被占用。建议重启应用或重启设备
AliEngineErrorMicAuthFail	麦克风设备未授权，建议去系统设置中，打开麦克风授权，并且重新加入频道
AliEngineErrorMicNotAvailable	无可用的音频采集设备，检查是否接入了可用的麦克风，并检查系统设置中，该设备是否被禁用
AliEngineErrorSpeakerNotAvailable	无可用的音频播放设备，检查是否接入了可用的扬声器或耳机，并检查系统设置中，该设备是否被禁用
AliEngineErrorSpecifiedAudioDeviceNotFound	指定使用的音频设备未找到
AliEngineErrorCameraOpenFail	采集设备初始化失败，检查系统相机是否可用，移动端App是否占用了相机
AliEngineErrorCameraInterrupt	采集过程中出现异常，Mac、Winodows电脑相机采集灯熄灭，设备被强制中断。建议重新加入频道或者重启App
AliEngineErrorVideoDisplayOpenFail	渲染设备初始化失败，检查Windows端显卡驱动是否需要升级，移动端手机型号或者Android平板盒子等外设是否支持OpenGL
AliEngineErrorVideoDisplayInterrupt	渲染过程中出现异常，系统异常错误导致渲染引擎报错，重新加入频道或者重启App
AliEngineErrorIceConnectionConnectFail	媒体通道建立失败，检查网络连接是否正常
AliEngineErrorIceConnectionReconnectFail	媒体通道重连失败，检查网络连接是否正常
AliEngineErrorIceConnectionHeartbeatTimeout	信令心跳超时，检查网络连接是否正常
AliEngineErrorLowLatencyLiveCommunicationFail	低延时互动直播信令失败
AliEngineErrorLowLatencyLiveMediaSettingFail	低延时互动直播媒体设置错误
AliEngineErrorLowLatencyLiveNoneBroadcaster	低延时互动直播当前房间没有主播推流
AliEngineErrorLowLatencyLiveNeedRestart	低延时互动直播错误，应用层需要重新创建新的SDK实例
AliEngineErrorLowLatencyLiveNeedRestartAgainLater	低延时互动直播错误，应用层需要稍等一定时间（自定义间隔）重新创建新的SDK实例
AliEngineErrorLowLatencyLiveServiceUnavailable	低延迟互动直播服务不可用或者服务降级，客户端应该选择其它方式拉超大方会流，即不从cdn sfu拉流
AliEngineErrorLowLatencyLiveMediaConnectionInterrruption	低延迟互动直播网络中断错误，销毁当前sdk实例重新创建sdk后重新走订阅流程
AliEngineErrorPublishInvaild	推流无效
AliEngineErrorPublishNotJoinChannel	未进入频道推流失败
AliEngineErrorPublishAudioStreamFailed	推送音频流失败
AliEngineErrorPublishVideoStreamFailed	推送视频流失败
AliEngineErrorPublishDualStreamFailed	推送小流失败
AliEngineErrorPublishScreenShareFailed	推送屏幕共享失败
AliEngineErrorPublishScreenShareConfigError	屏幕共享配置错误
AliEngineErrorSubscribeInvaild	订阅无效
AliEngineErrorSubscribeNotJoinChannel	未进入频道订阅错误
AliEngineErrorSubscribeAudioStreamFailed	订阅音频流失败
AliEngineErrorSubscribeVideoStreamFailed	订阅视频流失败
AliEngineErrorSubscribeDualStreamFailed	订阅小流失败
AliEngineErrorSubscribeScreenShareFailed	订阅屏幕共享失败
AliEngineErrorInvaildState	sdk状态错误，建议销毁SDK重新创建实例。
AliEngineErrorInvaildArgument	参数不匹配
AliEngineErrorSessionRemoved	Session已经被移除，建议销毁实例之后重新创建实例并加入频道。
AliEngineErrorAudioBufferFull	buffer队列饱和，用于外部输送裸数据功能，建议降低外部输入频次，设置等待20ms，并且单次不超过40ms数据。
AliEngineErrorVideoBufferFull	buffer队列饱和，用于外部输送裸数据功能，建议降低外部输入频次，设置等待视频帧间隔后再输入。
AliEngineErrorAudioStreamError	音频流错误
AliEngineErrorAudioFileOpenFail	音频文件打开失败
AliEngineErrorAudioFormatNotSupported	音频格式不支持
AliEngineErrorUpdateRoleChannel	互动模式下设置角色错误
AliEngineErrorInner	SDK内部错误

AliEngineAudioPlayingType

enum AliRTCSdk::AliEngineAudioPlayingType

音乐伴奏播放状态

枚举值
AliEngineAudioPlayingStarted	开始播放
AliEngineAudioPlayingStopped	停止播放
AliEngineAudioPlayingPaused	暂停播放
AliEngineAudioPlayingResumed	恢复播放
AliEngineAudioPlayingEnded	播放完毕
AliEngineAudioPlayingBuffering	正在缓冲
AliEngineAudioPlayingBufferingEnd	缓冲结束
AliEngineAudioPlayingFailed	播放失败

AliEngineAudioPlayingErrorCode

enum AliRTCSdk::AliEngineAudioPlayingErrorCode

音乐伴奏播放错误码

枚举值
AliEngineAudioPlayingNoError	没有错误
AliEngineAudioPlayingOpenFailed	打开文件失败
AliEngineAudioPlayingDecodeFailed	解码文件失败

AliEngineConnectionStatus

enum AliRTCSdk::AliEngineConnectionStatus

网络连接状态

枚举值
AliEngineConnectionInit	初始化完成
AliEngineConnectionDisconnected	网络连接断开
AliEngineConnectionConnecting	建立网络连接中
AliEngineConnectionConnected	网络已连接
AliEngineConnectionReconnecting	重新建立网络连接中
AliEngineConnectionFailed	网络连接失败

AliEngineConnectionStatusChangeReason

enum AliRTCSdk::AliEngineConnectionStatusChangeReason

网络连接状态变更原因

枚举值
AliEngineConnectionChangedDummyReason	未知原因
AliEngineConnectionMediaPathChanged	媒体通道变更
AliEngineConnectionSignalingHeartbeatTimeout	心跳超时
AliEngineConnectionSignalingHeartbeatAlive	心跳恢复
AliEngineConnectionSignalingHttpdnsResolved	DNS解析成功
AliEngineConnectionSignalingHttpdnsFailure	DNS解析失败
AliEngineConnectionSignalingGslbFailure	GSLB请求失败
AliEngineConnectionSignalingGslbSucccess	GSLB请求成功
AliEngineConnectionSignalingJoinChannelFailure	加入频道失败
AliEngineConnectionSignalingJoinChannelSuccess	加入频道成功
AliEngineConnectionSignalingLeaveChannel	离开频道
AliEngineConnectionSignalingConnecting	信令建立连接

AliEngineScreenShareType

enum AliRTCSdk::AliEngineScreenShareType

桌面分享类型

枚举值
AliEngineScreenShareDesktop	桌面分享
AliEngineScreenShareWindow	窗口分享

AliEngineExternalDeviceType

enum AliRTCSdk::AliEngineExternalDeviceType

外接设备类型

枚举值
AliEngineExternalTypeUnknown	未知类型
AliEngineExternalTypeAudioCapture	音频采集设备
AliEngineExternalTypeAudioPlayout	音频播放设备
AliEngineExternalTypeVideoCapture	视频采集设备

AliEngineExternalDeviceState

enum AliRTCSdk::AliEngineExternalDeviceState

外接设备状态

枚举值
AliEngineExternalDeviceAdd	新增外接设备
AliEngineExternalDeviceRemove	移除外接设备

AliEngineAudioRouteType

enum AliRTCSdk::AliEngineAudioRouteType

语音路由类型

枚举值
AliEngineAudioRouteTypeDefault	默认的语音路由
AliEngineAudioRouteTypeHeadset	耳机
AliEngineAudioRouteTypeEarpiece	听筒
AliEngineAudioRouteTypeHeadsetNoMic	不带麦的耳机
AliEngineAudioRouteTypeSpeakerphone	手机扬声器
AliEngineAudioRouteTypeLoudSpeaker	外接扬声器
AliEngineAudioRouteTypeBlueTooth	蓝牙耳机
AliEngineAudioRouteTypeUSB	USB耳机

AliEnginePublishState

enum AliRTCSdk::AliEnginePublishState

推流状态

枚举值
AliEngineStatsPublishIdle	初始状态
AliEngineStatsNoPublish	未推流
AliEngineStatsPublishing	推流中
AliEngineStatsPublished	已推流

AliEngineSubscribeState

enum AliRTCSdk::AliEngineSubscribeState

订阅状态

枚举值
AliEngineStatsSubscribeIdle	初始状态
AliEngineStatsNoSubscribe	未订阅
AliEngineStatsSubscribing	订阅中
AliEngineStatsSubscribed	已订阅

AliEngineTrascodingPublishTaskStatus

enum AliRTCSdk::AliEngineTrascodingPublishTaskStatus

旁路推流PublishTask状态

枚举值
AliEngineTrascodingPublishTaskStatusStart	任务开始
AliEngineTrascodingPublishTaskStatusUpdate	任务更新
AliEngineTrascodingPublishTaskStatusStop	任务已停止

AliEngineUserOfflineReason

enum AliRTCSdk::AliEngineUserOfflineReason

用户离线原因

枚举值
AliEngineUserOfflineQuit	用户主动离开
AliEngineUserOfflineDropped	因过长时间收不到对方数据包，超时掉线
AliEngineUserOfflineBecomeAudience	用户身份从主播切换为观众时触发

AliEngineAudioProfile

enum AliRTCSdk::AliEngineAudioProfile

音频编码模式

枚举值
AliEngineLowQualityMode	音频低音质模式，默认8000Hz采样率，单声道，最大编码码率12kbps
AliEngineBasicQualityMode	（默认）标准音质模式，默认16000Hz采样率，单声道，最大编码码率24kbps
AliEngineHighQualityMode	高音质模式，默认48000Hz采样率，单声道，最大编码码率48kbps
AliEngineStereoHighQualityMode	立体声高音质模式，默认48000Hz采样率，双声道，最大编码码率64kbps
AliEngineSuperHighQualityMode	超高音质模式，默认48000Hz采样率，单声道，最大编码码率96kbps
AliEngineStereoSuperHighQualityMode	立体声超高音质模式，默认48000Hz采样率，双声道，最大编码码率128kbps

AliEngineAudioScenario

enum AliRTCSdk::AliEngineAudioScenario

音频场景模式

枚举值
AliEngineSceneDefaultMode	默认场景，一般的音视频通信场景推荐使用
AliEngineSceneEducationMode	教育场景，优先保证音频连续性与稳定性
AliEngineSeneMediaMode	媒体场景，保真人声与音乐音质, 连麦直播间推荐使用
AliEngineSceneMusicMode	音乐场景，高保真音乐音质，乐器教学等对音乐音质有要求的场景推荐使用
AliEngineSceneChatroomMode	聊天室模式，适用于频繁上下麦的场景

AliEngineChannelRelayEvent

enum AliRTCSdk::AliEngineChannelRelayEvent

跨频道转发事件

枚举值
AliEngineChannelRelayEventStart	跨频道转推开始
AliEngineChannelRelayEventUpdate	跨频道转推更新
AliEngineChannelRelayEventStop	跨频道转推结束

AliEngineChannelRelayState

enum AliRTCSdk::AliEngineChannelRelayState

跨频道转发状态

枚举值
AliEngineChannelRelayStateInit	跨频道转推初始化状态
AliEngineChannelRelayStateConnecting	跨频道转推连接中状态
AliEngineChannelRelayStateRunning	跨频道转推运行中状态
AliEngineChannelRelayStateFailure	跨频道转推失败状态

AliEngineChannelRelayErrorCode

enum AliRTCSdk::AliEngineChannelRelayErrorCode

跨频道转发错误码

枚举值
AliEngineChannelRelayErrorStateError	检测到本地状态不对，没入会，角色错误，频道模式错误
AliEngineChannelRelayErrorSrcNotAllow	服务端返回436，源通道模式不匹配
AliEngineChannelRelayErrorJoinDestFailed	服务端返回437，目标通道不存在或者模式不匹配
AliEngineChannelRelayErrorTokenInvalid	服务端返回438，token无效
AliEngineChannelRelayErrorRoleError	服务端返651，session不是主播
AliEngineChannelRelayErrorInvalidParam	服务端400，参数错误
AliEngineChannelRelayErrorToSelf	服务端返回440，不能转推到本频道

AliEngineShowDebugViewType

enum AliRTCSdk::AliEngineShowDebugViewType

用户离线原因

枚举值
AliEngineShowTypeNone	不显示
AliEngineShowTypeAudio	音频
AliEngineShowTypeVideo	视频
AliEngineShowTypeNetwork	网络
AliEngineShowTypeAll	全部

AliEngineFrameRate

enum AliRTCSdk::AliEngineFrameRate

视频帧率

枚举值
AliEngineFrameRateFps5	5: 5 fps
AliEngineFrameRateFps10	10: 10 fps
AliEngineFrameRateFps15	15: 15 fps
AliEngineFrameRateFps20	20: 20 fps
AliEngineFrameRateFps25	25: 25 fps
AliEngineFrameRateFps30	30: 30 fps

AliEngineVideoEncoderBitrate

enum AliRTCSdk::AliEngineVideoEncoderBitrate

视频编码码率

枚举值
AliEngineVideoStandardBitrate	视频编码标准码率

AliEngineVideoEncoderOrientationMode

enum AliRTCSdk::AliEngineVideoEncoderOrientationMode

视频输出方向

枚举值
AliEngineVideoEncoderOrientationModeAdaptive	0: 自适应，推流方向和采集方向一致
AliEngineVideoEncoderOrientationModeFixedLandscape	1: 竖屏模式 该模式下SDK推竖屏流，始终以设置的分辨率宽和高中较小的值作为输出视频的宽，较大值作为输出视频的高
AliEngineVideoEncoderOrientationModeFixedPortrait	2: 横屏模式 该模式下SDK推横屏流，始终以设置的分辨率宽和高中较大的值作为输出视频的宽，较小值作为输出视频的高

AliEngineVideoMirrorMode

enum AliRTCSdk::AliEngineVideoMirrorMode

视频镜像模式

枚举值
AliEngineVideoMirrorModeDisabled	0: 关闭镜像
AliEngineVideoMirrorModeEnable	1: 开启镜像

AliEngineLiveTranscodingMixMode

enum AliRTCSdk::AliEngineLiveTranscodingMixMode

旁路模式

枚举值
AliEngineLiveTranscodingSINGLE	单路模式
AliEngineLiveTranscodingMIX	混流模式

AliEngineLiveTranscodingStreamType

enum AliRTCSdk::AliEngineLiveTranscodingStreamType

旁路直播转推流模式

枚举值
AliEngineLiveTranscodingOrigin	原始流
AliEngineLiveTranscodingAudio	音频
AliEngineLiveTranscodingVideo	视频

AliEngineLiveTranscodingSourceType

enum AliRTCSdk::AliEngineLiveTranscodingSourceType

旁路直播输入类型

枚举值
AliEngineLiveTranscodingCamera	相机流
AliEngineLiveTranscodingShareScreen	屏幕流

AliEngineLiveTranscodingCropMode

enum AliRTCSdk::AliEngineLiveTranscodingCropMode

旁路直播裁剪模式

枚举值
AliEngineLiveTranscodingCrop	剪裁
AliEngineLiveTranscodingFill	填充

AliEngineLiveTranscodingMediaProcessMode

enum AliRTCSdk::AliEngineLiveTranscodingMediaProcessMode

旁路直播媒体处理模式

枚举值
AliEngineLiveTranscodingNormal	通用模式
AliEngineLiveTranscodingVirtualBackground	虚拟背景模式

AliEngineLiveTranscodingSegmentType

enum AliRTCSdk::AliEngineLiveTranscodingSegmentType

旁路直播输入类型

枚举值
AliEngineLiveTranscodingNoBody	无人像分割
AliEngineLiveTranscodingBody	人像分割

AliEngineVideoEncodedFrameType

enum AliRTCSdk::AliEngineVideoEncodedFrameType

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

枚举值
AliEngineVideoEncodedFrameIDR	默认 无
AliEngineVideoEncodedFrameLTR	IDR帧
AliEngineVideoEncodedFrameB	LTR帧

AliEnginePluginErrorCode

enum AliRTCSdk::AliEnginePluginErrorCode

插件错误码

枚举值
AliEnginePluginErrorCodeSuccess	成功
AliEnginePluginErrorCodeFailed	未知错误
AliEnginePluginErrorNoFindPlugin	未找到对应插件
AliEnginePluginErrorParameterError	参数错误
AliEnginePluginErrorLoadError	插件库加载错误
AliEnginePluginErrorCreateError	插件对象创建错误
AliEnginePluginErrorInitError	插件初始化失败
AliEnginePluginErrorInitTokenError	插件鉴权失败，使用非官网下载插件

AliEnginePluginDataType

enum AliRTCSdk::AliEnginePluginDataType

插件类型

枚举值
AliEnginePluginDataTypeShared	共享型
AliEnginePluginDataTypeVideo	视频处理型
AliEnginePluginDataTypeAudio	音频处理型
AliEnginePluginDataTypeEncryption	加密型
AliEnginePluginDataTypeMax	占位符，无含义

AliEnginePluginOperationType

enum AliRTCSdk::AliEnginePluginOperationType

插件操作类型

枚举值
AliEnginePluginShared	共享插件
AliEnginePluginPreOperation	推流前处理
AliEnginePluginPostOperation	拉流后处理
AliEnginePluginEncodeOperation	编码器
AliEnginePluginDecodeOperation	解码器
AliEnginePluginRecord	采集
AliEnginePluginRender	渲染

AliEngineBokehScaleModel

enum AliRTCSdk::AliEngineBokehScaleModel

背景替换功能中背景图缩放模式

枚举值
AliEngineBokehScaleModelCrop	等比裁剪，当背景图像宽高比和视频数据宽高比不一致时, 为了保持等比例缩放, 会将背景图像裁剪到视频比例, 超出部分背景图片内容将会丢失
AliEngineBokehScaleModelFill	填充黑边，当背景图像宽高比和视频数据宽高比不一致时, 为了保持等比例缩放, 会对背景进行黑边填充

AliEngineAudioTrack

enum AliRTCSdk::AliEngineAudioTrack

音频track的类型

枚举值
AliEngineAudioTrackNo	无麦克风
AliEngineAudioTrackMic	麦克风
AliEngineAudioTrackEnd	占位符

AliEngineVideoTrack

enum AliRTCSdk::AliEngineVideoTrack

视频流类型

枚举值
AliEngineVideoTrackNo	无视频流
AliEngineVideoTrackCamera	相机流
AliEngineVideoTrackScreen	屏幕共享流
AliEngineVideoTrackBoth	相机流和屏幕共享流

AliEngineVideoStreamType

enum AliRTCSdk::AliEngineVideoStreamType

相机流类型

枚举值
AliEngineVideoStreamTypeNone	无，在OnSubscribeStreamTypeChanged回调表示当前未订阅
AliEngineVideoStreamTypeHigh	高码率，高分辨率流（大流）
AliEngineVideoStreamTypeLow	低码率，低分辨率流（小流）

AliEngineVideoSource

enum AliRTCSdk::AliEngineVideoSource

视频数据源

枚举值
AliEngineVideoSourceCamera	相机流
AliEngineVideoSourceScreenShare	屏幕共享流
AliEngineVideosourceTypeMax	占位符，无意义

AliEngineVideoRecordSource

enum AliRTCSdk::AliEngineVideoRecordSource

录制视频数据源

枚举值
AliEngineVideoRecordSourceCamera	录制相机流视频
AliEngineVideoRecordSourceScreenShare	录制屏幕流视频
AliEngineVideoRecordSourceBoth	录制相机和屏幕流视频
AliEngineVideoRecordSourceTypeMax	枚举边界（不允许使用）

AliEngineBufferType

enum AliRTCSdk::AliEngineBufferType

视频数据格式

枚举值
AliEngineBufferTypeRawData	裸数据格式
AliEngineBufferTypeTexture	纹理格式

AliEngineRenderMode

enum AliRTCSdk::AliEngineRenderMode

视图显示模式

枚举值
AliEngineRenderModeAuto	自动模式
AliEngineRenderModeStretch	拉伸平铺模式 ，如果外部输入的视频宽高比和推流设置的宽高比不一致时，将输入视频拉伸到推流设置的比例，画面会变形
AliEngineRenderModeFill	填充黑边模式，如果外部输入的视频宽高比和推流设置的宽高比不一致时，将输入视频上下或者左右填充黑边
AliEngineRenderModeCrop	裁剪模式，如果外部输入的视频宽高比和推流设置的宽高比不一致时，将输入视频宽或者高进行裁剪，画面内容会丢失
AliEngineRenderModeScroll	已废弃
AliEngineRenderModeNoChange	沿用之前的显示模式

AliEngineRotationMode

enum AliRTCSdk::AliEngineRotationMode

视频旋转角度

枚举值
AliEngineRotationModeNoChange	沿用之前的旋转角度
AliEngineRotationMode_0	0
AliEngineRotationMode_90	90
AliEngineRotationMode_180	180
AliEngineRotationMode_270	270

AliEngineAudioNumChannelType

enum AliRTCSdk::AliEngineAudioNumChannelType

音频声道类型

枚举值
AliEngineMonoAudio	单声道
AliEngineStereoAudio	双声道

AliEngineAudioSampleRate

enum AliRTCSdk::AliEngineAudioSampleRate

音频采样率类型

枚举值
AliEngineAudioSampleRate_8000	8000采样率
AliEngineAudioSampleRate_11025	11025采样率
AliEngineAudioSampleRate_16000	16000采样率
AliEngineAudioSampleRate_22050	22050采样率
AliEngineAudioSampleRate_32000	32000采样率
AliEngineAudioSampleRate_44100	44100采样率
AliEngineAudioSampleRate_48000	48000采样率

AliEngineAudioSource

enum AliRTCSdk::AliEngineAudioSource

音频数据源类型

枚举值
AliEngineAudiosourcePub	本地推流的音频数据
AliEngineAudiosourceSub	本地拉流混音的音频数据
AliEngineAudiosourceRawData	本地采集的音频数据

AliEngineVideoObserPosition

enum AliRTCSdk::AliEngineVideoObserPosition

视频数据输出位置

枚举值
AliEnginePositionPostCapture	采集视频数据，对应输出回调 OnCaptureVideoSample
AliEnginePositionPreRender	渲染视频数据，对应输出回调 OnRemoteVideoSample
AliEnginePositionPreEncoder	编码前视频数据，对应输出回调 OnPreEncodeVideoSample

AliEngineVideoObserAlignment

enum AliRTCSdk::AliEngineVideoObserAlignment

视频输出宽度对齐方式

枚举值
AliEngineAlignmentDefault	保持原有视频宽度
AliEngineAlignmentEven	宽度偶数对齐
AliEngineAlignment4	宽度是4的倍数
AliEngineAlignment8	宽度是8的倍数
AliEngineAlignment16	宽度是16的倍数