即時音視頻Windows SDK資料結構 - ApsaraVideo Live

通過閱讀本文，您可以瞭解即時音視頻Windows SDK涉及的資料類型。

資料類型	描述
AliEngineUserVolumeInfo	使用者音量資訊。
AliEngineAudioRawData	音頻樣本。
AliEngineVideoRawData	視頻樣本。
AliEngineChannelProfile	頻道模式。
AliEngineClientRole	使用者角色。
AliEngineStats	會話資料統計資訊。
AliEngineLocalVideoStats	本地視頻統計資訊。
AliEngineRemoteVideoStats	遠端視頻統計資訊。
AliEngineLocalAudioStats	本地音頻統計資訊。
AliEngineRemoteAudioStats	遠端音頻統計資訊。
AliEngineVideoObserPosition	視頻資料輸出位置。
AliEngineVideoFormat	視頻資料類型。
AliEngineExternalDeviceType	外接裝置類型。
AliEngineExternalDeviceState	外接裝置狀態。
AliEngineConnectionStatus	網路連接狀態。
AliEngineConnectionStatusChangeReason	網路連接狀態變更原因。
AliEngineVideoTrack	視頻流類型。
AliEnginePublishState	推流狀態。
AliEngineSubscribeState	訂閱狀態。
AliEngineUserOfflineReason	使用者離線原因。
AliEngineVideoStreamType	相機流類型。
AliEngineAudioTrack	音頻流類型。
AliEngineNetworkQuality	網路品質。
AliEngineVideoEncoderOrientationMode	橫豎屏類型。
AliEngineRenderMode	渲染模式。
AliEngineRenderMirrorMode	鏡像模式。
AliEngineRotationMode	旋轉角度。
AliEngineLogLevel	記錄層級。
AliEngineAudioNumChannelType	音頻聲道數。
AliEngineAudioSampleRate	錄製音頻採樣率。
AliEngineRecordType	錄製類型。
AliEngineRecordFormat	錄製格式
AliEngineAudioQuality	錄製音頻檔案的音頻品質。
AliEngineVideoQuality	錄製視頻檔案的視頻品質。
AliEngineAudioProfile	音頻品質模式。
AliEngineAudioScenario	音頻情境模式參數。
AliEngineMuteLocalAudioMode	本地靜音。
AliEngineRecordAudioConfig	錄製音頻設定。
AliEngineRecordVideoConfig	錄製視頻設定。
AliEngineVideoRecordCanvasConfig	錄製視頻設定的畫布大小。
AliEngineRecordVideoLayoutMode	錄製視頻的布局資訊。
AliEngineRecordVideoBgColor	錄製視頻的背景顏色。
AliEngineRecordVideoRegion	錄製布局的使用者畫面配置資訊。
AliEngineRecordVideoRectangle	使用者畫面的位置資訊。
AliEngineRecordVideoRational	混流錄製座標。
AliEngineRecordTemplate	錄製模板。
AliEngineDeviceInfo	裝置資訊。
AliEngineBeautyConfig	基礎美顏設定。
AliEngineOnByeType	OnBye類型枚舉。
AliEngineAudioEffectVoiceChangerMode	變聲音效模式。
AliEngineAudioEffectReverbMode	音效混響模式。
AliEngineAudioEffectReverbParamType	音效混響參數。
AliEngineVideoCanvas	渲染畫布。
AliEngineLiveTranscodingErrorCode	旁路推流錯誤碼。
AliEngineWaterMarkConfig	浮水印圖片的設定。
AliEngineCameraCapturerConfiguration	相機採集偏好屬性。
AliEngineCameraCaptureProfile	相機採集解析度。
AliEngineDisplayMode	視頻顯示模式的枚舉類型。
AliEngineCaptureOutputPreference	網路攝影機採集偏好。
AliEngineFrameRate	視頻編碼幀率。
AliEngineVideoEncoderBitrate	視頻編碼碼率。
AliEngineVideoMirrorMode	編碼視頻鏡像模式。
AliEngineVideoEncoderConfiguration	視頻編碼偏好。
AliEngineVideoDecoderConfiguration	視頻解碼屬性設定。
AliEngineVideoCodecType	視頻轉碼器類型。
AliEngineScreenShareEncoderConfiguration	螢幕分享編碼偏好。
AliEngineScreenShareConfig	螢幕分享配置。
AliEngineScreenShareRegion	螢幕分享地區。
AliEngineScreenSourcInfo	螢幕分享源資訊。
AliEngineScreenShareInfo	螢幕分享配置資訊。
AliEngineScreenShareType	螢幕分享類型。
AliEngineAuthInfo	鑒權資訊。
AliEngineVideoSource	視頻裸資料來源類型。
AliEngineAudioSource	音頻裸資料來源類型。
AliEngineBufferType	視頻資料類型。
AliEngineErrorCode	錯誤碼。
AliEngineVideoObserAlignment	視頻輸出寬度對齊。
AliEngineShowDebugViewType	顯示儀錶盤類型。
AliEngineTrascodingPublishTaskStatus	旁路推流LiveStream狀態。
DisplayType	旁路直播圖片顯示類型。
AliEngineLiveTranscodingFontType	旁路直播文字類型。
AliEngineLiveTranscodingSegmentType	旁路直播分割類型。
AliEngineLiveTranscodingSourceType	旁路直播輸入類型。
AliEngineVideoState	視頻流狀態變化。
AliEngineVideoReason	觸發視頻流狀態變化的原因。
AliEngineLiveTranscodingCropMode	旁路直播裁剪模式。
AliEngineLiveTranscodingMediaProcessMode	旁路直播ApsaraVideo for Media Processing模式。
AliEngineLiveTranscodingStreamType	旁路直播轉推流類型。
AliEngineLiveTranscodingMixMode	旁路直播模式。
AliEngineLiveTranscodingState	旁路直播狀態。
AliEngineLiveTranscodingText	旁路直播文本資訊。
AliEngineLiveTranscodingImage	旁路直播圖片資訊。
AliEngineLiveTranscodingUser	旁路直播使用者自訂窗格資訊。
AliEngineLiveTranscodingParam	旁路直播配置。
AliEngineLiveTranscodingMixParam	旁路模式混流參數。
AliEngineLiveTranscodingSingleParam	旁路模式單路參數。
AliEngineLiveTranscodingTaskProfile	旁路直播計費規格。
AliEngineLiveTranscodingEncodeParam	旁路直播編碼參數。
AliEngineLiveTranscodingAudioSampleRate	旁路直播音頻採樣率。
AliEngineLiveTranscodingClockWidget	旁路直播時鐘小工具。
AliEngineBokehScaleModel	背景替換縮放模式。
AliEngineAudioAccompanyStateCode	音樂伴奏播放狀態。
AliEngineAudioAccompanyErrorCode	音樂伴奏播放錯誤碼。
AliEngineScreenSourceList	螢幕畫面分享源列表。
AliEngineInterfaceIdType	功能介面類型。
AliEngineVideoCodecKindType	視頻編解碼類型。
AliEngineDeviceTransportType	裝置連線類型。
AliEngineAudioFrameObserverConfig	音訊框架回調配置。
AliEngineDeviceInfoList	視頻裝置列表。
AliEngineVideoResolutionList	視頻採集裝置解析度列表。
AliEngineVideoRecordSource	錄製視頻資料來源。
AliEngineAudioFrameObserverOperationMode	音頻資料回調模式。
AliEngineVideoResolution	視頻解析度。
AliEngineVideoScale	視頻解析度寬高比。
AliEngineWaterMarkPosition	浮水印座標系。
AliEngineVideoDimensions	視頻解析度。
AliEngineVideoEncodeCodecType	視頻編碼格式。
AliEngineChannelParam	使用者屬性，如使用者暱稱、類型等。
AliCapabilityProfile	使用者屬性，需要在 AI agent 通話情境下特殊配置, 非 AI AI agent 通話情境使用預設值。
AliEngineAudioAccompanyConfig	音頻伴奏播放配置。
AliEngineVideoPipelineMirrorMode	視頻鏡像模式。
AliEngineCapturePipelineScaleMode	視頻縮放時機。
AliEngineDataChannelMsg	data channel 訊息。
AliEngineDataMsgType	data channel 訊息類型。
AliEngineAudioFileInfo	音頻檔案資訊。
AliEngineLocalAudioStateType	本地音頻採集狀態。
AliEngineLocalVideoStateType	本地視頻採集狀態。

API詳情

AliEngineUserVolumeInfo

使用者音量資訊。

參數	類型	描述
uid	String	目前使用者的UID，取值： 0：表示本地。 1：表示遠端混音。其他：表示遠端使用者。
volume	int	當前回調的音量。
speech_state	bool	true：表示正在說話。 false：表示沒有說話。
sumVolume	int	回調周期內累計的音量, 用於判別當前說話人，取值範圍[0,255]。

AliEngineAudioRawData

音頻樣本。

參數	類型	描述
dataPtr	void*	音頻資料。
numOfSamples	int	採樣點數（單個聲道）。
bytesPerSample	int	每個採樣點的位元組數。
numOfChannels	int	聲道數。
samplesPerSec	int	每秒採樣點數。

AliEngineVideoRawData

視頻樣本。

參數	類型	描述
format	AliEngineVideoFormat	視頻資料類型。
type	AliEngineBufferType	視頻資料類型。
dataLength	int	資料大小。
pixelBuffer	void*	pixelBuffer資料。
dataPtr	void*	yuv資料指標。
dataYPtr	void*	Y分量指標。
dataUPtr	void*	U分量指標。
dataVPtr	void*	V分量指標。
strideY	int	YUV資料中的Y緩衝區的行跨度。
strideU	int	YUV資料中的U緩衝區的行跨度。
strideV	int	YUV資料中的V緩衝區的行跨度。
height	int	視訊框架的高。
width	int	視訊框架的寬。
rotation	int	視訊框架的旋轉角度，僅支援設定0、90、180、270。
timeStamp	long long	時間戳記。

AliEngineChannelProfile

頻道模式。

枚舉名	描述
AliEngineCommunication	通訊模式。
AliEngineInteractiveLive	互動模式。

AliEngineClientRole

使用者角色。

枚舉名	描述
AliEngineClientRoleInteractive	主播角色。
AliEngineClientRoleLive	觀眾角色。

AliEngineStats

會話資料統計資訊。

參數	類型	描述
sentKBitrate	long long	發送碼率。
rcvdKBitrate	long long	接收碼率。
sentBytes	long long	發送位元組數。
rcvdBytes	long long	接收位元組數。
systemCpu	unsigned int	系統CPU使用率。
appCpu	unsigned int	RTC進程CPU使用率。
videoRcvdKBitrate	long long	視頻接收碼率。
videoSentKBitrate	long long	視頻發送碼率。
callDuration	unsigned long long	通話時間長度，單位：秒。
sentLossRate	long long	用戶端到伺服器的丟包率。
sentLossPkts	long long	用戶端到伺服器的丟包數。
sentExpectedPkts	long long	用戶端到伺服器的總包數。
rcvdLossRate	long long	用戶端到伺服器的下行丟包率。
rcvdLossPkts	long long	用戶端到伺服器的下行丟包數。
rcvdExpectedPkts	long long	用戶端到伺服器的下行總包數。
lastmileDelay	long long	延時時間長度，單位：毫秒。
availableSendBitrate	long long	可發送的碼率

AliEngineLocalVideoStats

本地視頻統計資訊。

參數	類型	描述
track	AliEngineVideoTrack	流類型。
sentBitrate	unsigned int	發布位元速率。
sentFps	unsigned int	發布幀率。
encodeFps	unsigned int	編碼幀率。
targetEncodeBitrate	unsigned int	目標編碼碼率。
actualEncodeBitrate	unsigned int	實際編碼碼率。
captureFps	unsigned int	採集幀率。
avgQpPerSec	unsigned int	編碼平均qp品質。

AliEngineRemoteVideoStats

遠端視頻統計資訊。

參數	類型	描述
userId	const char*	遠端使用者ID。
track	AliEngineVideoTrack	視頻流類型。
width	unsigned int	視訊框架的寬。
height	unsigned int	視訊框架的高。
decodeFps	unsigned int	編碼器輸出幀率。
renderFps	unsigned int	渲染器輸出幀率。
frozenTimes	unsigned int	卡頓次數。

AliEngineLocalAudioStats

本地音頻統計資訊。

參數	類型	描述
track	AliEngineAudioTrack	音頻流類型。
scene	AliEngineAudioScenario	音頻情境。
sentBitrate	unsigned int	發送碼率。
sentSamplerate	unsigned int	發送的採樣率。
numChannel	unsigned int	聲道數。
inputLevel	unsigned int	輸入等級。

AliEngineRemoteAudioStats

遠端音頻統計資訊。

參數	類型	描述
userId	const char*	使用者ID。
track	AliEngineAudioTrack	音頻流類型。
networkTransportDelay	int	音頻發送端到接收端的網路延遲，單位：毫秒。
quality	int	音質。
audioLossRate	int	音頻丟包率。
rcvdBitrate	int	接收碼率。
totalFrozenTimes	int	卡頓次數。
audioTotalFrozenTime	int	音頻播放的累計卡頓時間長度，單位ms。
audioTotalFrozenRate	int	音頻播放卡頓率，單位%。

AliEngineVideoObserPosition

視頻資料輸出位置。

枚舉名	描述
AliEnginePositionPostCapture	採集資料。
AliEnginePositionPreRender	拉流資料。
AliEnginePositionPreEncoder	編碼前資料。

AliEngineVideoFormat

視頻資料輸出格式。

枚舉名	描述
AliEngineVideoFormatBGRA	BGRA。
AliEngineVideoFormatUnknow	unkown。
AliEngineVideoFormatI420	I420。
AliEngineVideoFormatNV21	NV21。
AliEngineVideoFormatNV12	NV12。
AliEngineVideoFormatRGBA	RGBA。
AliEngineVideoFormatI422	I422。
AliEngineVideoFormatARGB	ARGB。
AliEngineVideoFormatABGR	ABGR。
AliEngineVideoFormatRGB24	RGB24。
AliEngineVideoFormatBGR24	BGR24。
AliEngineVideoFormatRGB565	RGB565。
AliEngineVideoFormatTextureOES	TextureOES。
AliEngineVideoFormatTexture2D	Texture2D。
AliEngineVideoFormatH264	H264。

AliEngineExternalDeviceType

外接裝置類型。

枚舉名	描述
AliEngineExternalTypeUnknown	未知類型。
AliEngineExternalTypeAudioCapture	音頻採集裝置。
AliEngineExternalTypeAudioPlayout	音頻播放裝置。
AliEngineExternalTypeVideoCapture	視頻採集裝置。

AliEngineExternalDeviceState

外接裝置狀態。

枚舉名	描述
AliEngineExternalDeviceAdd	新增外接裝置。
AliEngineExternalDeviceRemove	移除外接裝置。

AliEngineConnectionStatus

網路連接狀態。

枚舉名	描述
AliEngineConnectionInit	初始化完成。
AliEngineConnectionDisconnected	網路連接斷開。
AliEngineConnectionConnecting	建立網路連接中。
AliEngineConnectionConnected	網路已串連。
AliEngineConnectionReconnecting	重建立立網路連接中。
AliEngineConnectionFailed	網路連接失敗。

AliEngineConnectionStatusChangeReason

網路連接狀態變更原因。

枚舉名	描述
AliEngineConnectionChangedDummyReason	未知原因。
AliEngineConnectionMediaPathChanged	移媒體通道變更。
AliEngineConnectionSignalingHeartbeatTimeout	心跳逾時。
AliEngineConnectionSignalingHeartbeatAlive	心跳恢複。
AliEngineConnectionSignalingHttpdnsResolved	DNS解析成功。
AliEngineConnectionSignalingHttpdnsFailure	DNS解析失敗。
AliEngineConnectionSignalingGslbFailure	GSLB請求失敗。
AliEngineConnectionSignalingGslbSucccess	GSLB請求成功。
AliEngineConnectionSignalingJoinChannelFailure	加入頻道失敗。
AliEngineConnectionSignalingJoinChannelSuccess	加入頻道成功。
AliEngineConnectionSignalingLeaveChannel	離開頻道。
AliEngineConnectionSignalingConnecting	信令建立串連。
AliRtcConnectionChangedNetworkInterrupted	網路連接中斷。

AliEngineVideoTrack

視頻流類型。

枚舉名	描述
AliEngineVideoTrackNo	無視頻流。
AliEngineVideoTrackCamera	網路攝影機流。
AliEngineVideoTrackScreen	螢幕畫面分享流。
AliEngineVideoTrackBoth	網路攝影機和螢幕畫面分享。

AliEnginePublishState

推流狀態。

枚舉名	描述
AliEngineStatsPublishIdle	初始狀態。
AliEngineStatsNoPublish	未推流。
AliEngineStatsPublishing	推流中。
AliEngineStatsPublished	已推流。

AliEngineSubscribeState

訂閱狀態。

枚舉名	描述
AliEngineStatsSubscribeIdle	初始狀態。
AliEngineStatsNoSubscribe	未訂閱。
AliEngineStatsSubscribing	訂閱中。
AliEngineStatsSubscribed	已訂閱。

AliEngineUserOfflineReason

使用者離線原因。

枚舉名	描述
AliEngineUserOfflineQuit	使用者主動離開。
AliEngineUserOfflineDropped	因過長時間收不到對方資料包，逾時掉線。
AliEngineUserOfflineBecomeAudience	使用者身份從主播切換為觀眾時觸發。

AliEngineVideoStreamType

相機大小流類型。

枚舉名	描述
AliEngineVideoStreamTypeNone	無視頻流。
AliEngineVideoStreamTypeHigh	大流。
AliEngineVideoStreamTypeLow	小流。

AliEngineAudioTrack

音頻流類型。

枚舉名	描述
AliEngineAudioTrackNo	無音頻流。
AliEngineAudioTrackMic	麥克風流。

AliEngineNetworkQuality

網路品質。

枚舉名	描述
AliEngineNetworkQualityExcellent	網路極好，流程度清晰度品質好。
AliEngineNetworkQualityGood	網路好，流暢度清晰度和極好差不多。
AliEngineNetworkQualityPoor	網路較差，音視頻流暢度清晰度有瑕疵，不影響溝通。
AliEngineNetworkQualityBad	網路差，視訊卡頓嚴重，音頻能正常溝通。
AliEngineNetworkQualityVeryBad	網路極差，基本無法溝通。
AliEngineNetworkQualityDisconnect	網路中斷。
AliEngineNetworkQualityUnknow	未知原因。

AliEngineVideoEncoderOrientationMode

視頻輸出方向。

枚舉名	描述
AliEngineVideoEncoderOrientationModeAdaptive	0：自適應，推流方向和採集方向一致。
AliEngineVideoEncoderOrientationModeFixedLandscape	1：豎屏模式。該模式下SDK推豎屏流，始終以設定的解析度寬和高中較小的值作為輸出視頻的寬，較大值作為輸出視頻的高
AliEngineVideoEncoderOrientationModeFixedPortrait	2：橫屏模式。該模式下SDK推橫屏流，始終以設定的解析度寬和高中較大的值作為輸出視頻的寬，較小值作為輸出視頻的高

AliEngineRenderMode

渲染模式。

枚舉名	描述
AliEngineRenderModeAuto	自動。
AliEngineRenderModeStretch	展開填充視圖，不保持視頻比例。
AliEngineRenderModeFill	在保持視頻寬高比的同時縮放，填充黑邊。
AliEngineRenderModeCrop	在保持視頻寬高比的同時縮放，並裁剪以適合視圖。
AliEngineRenderModeNoChange	沿用之前的顯示模式。

AliEngineRenderMirrorMode

鏡像模式。

枚舉名	描述
AliEngineRenderMirrorModeOnlyFrontMirror	只有自拍預覽鏡像，其餘不鏡像。
AliEngineRenderMirrorModeAllMirror	全部鏡像。
AliEngineRenderMirrorModeAllNoMirror	全部不鏡像。

AliEngineRotationMode

旋轉角度。

枚舉名	描述
AliEngineRotationModeNoChange	沿用之前的旋轉角度
AliEngineRotationMode_0	不旋轉。
AliEngineRotationMode_90	旋轉90度。
AliEngineRotationMode_180	旋轉180度。
AliEngineRotationMode_270	旋轉270度。

AliEngineLogLevel

記錄層級。

枚舉名	描述
AliEngineLogLevelInfo	普通。
AliEngineLogLevelWarn	警告。
AliEngineLogLevelError	錯誤。
AliEngineLogLevelFatal	嚴重。
AliEngineLogLevelNone	無。

AliEngineAudioNumChannelType

音頻聲道類型。

枚舉名	描述
AliEngineMonoAudio	單聲道。
AliEngineStereoAudio	雙聲道。

AliEngineAudioSampleRate

音頻採樣率類型。

枚舉名	描述
AliEngineAudioSampleRate_8000	採樣率8000。
AliEngineAudioSampleRate_11025	採樣率11025。
AliEngineAudioSampleRate_16000	採樣率16000。
AliEngineAudioSampleRate_22050	採樣率22050。
AliEngineAudioSampleRate_32000	採樣率32000。
AliEngineAudioSampleRate_44100	採樣率44100。
AliEngineAudioSampleRate_48000	採樣率48000。

AliEngineRecordType

錄製類型。

枚舉名	描述
AliEngineRecordTypeAudio	純音頻錄製。
AliEngineRecordTypeVideo	錄製單個音視頻檔案
AliEngineRecordTypeBoth	錄製純音頻和音視頻檔案

AliEngineRecordFormat

錄製格式。

枚舉名	描述
AliEngineRecordFormatAAC	AAC檔案。
AliEngineRecordFormatWAV	WAV檔案。
AliEngineRecordFormatMP4	MP4檔案.

AliEngineAudioQuality

錄製音頻檔案的音頻品質。

枚舉名	描述
AliEngineAudioQualityLow	低。
AliEngineAudioQualityMidium	中。
AliEngineAudioQualityHigh	高。

AliEngineVideoQuality

錄製視頻檔案的視頻品質。

枚舉名	描述
AliEngineVideoQualityDefault	預設和視頻採集品質保持一致（移動端不提供視頻錄製）。

AliEngineAudioProfile

音頻品質模式。

枚舉名	描述
AliEngineLowQualityMode	音頻低音質模式。
AliEngineBasicQualityMode	標準音質模式。
AliEngineHighQualityMode	高音質模式。
AliEngineStereoHighQualityMode	立體聲高音質模式。
AliEngineSuperHighQualityMode	超高音質模式。
AliEngineStereoSuperHighQualityMode	立體聲超高音質模式。

AliEngineAudioScenario

音頻情境模式。

枚舉名	描述
AliEngineSceneDefaultMode	預設情境，一般的音視頻通訊情境推薦使用。
AliEngineSceneEducationMode	教育情境，優先保證音頻連續性與穩定性。
AliEngineSeneMediaMode	媒體情境，保真人聲與音樂音質，連麥直播間推薦使用。
AliEngineSceneMusicMode	音樂情境，高保真音樂音質，樂器教學等對音樂音質有要求的情境推薦使用。
AliEngineSceneChatRoomMode	聊天室情境，適用於頻繁上下麥的聊天情境，音量條始終為語音通話音量條。
AliEngineSceneShowRoomMode	秀場情境，適用於需要高音質的單主播情境。

AliEngineMuteLocalAudioMode

本地靜音。

枚舉名	描述
AliEngineMuteLocalAudioModeDefault	預設模式（靜音全部，包括麥克風及外部輸入音頻）。
AliEngineMuteLocalAudioModeMuteAll	靜音全部（包括麥克風及外部輸入音頻）。
AliEngineMuteLocalAudioModeMuteOnlyMic	只靜音麥克風。

AliEngineRecordAudioConfig

錄製音頻檔案參數配置。

參數	類型	描述
sampleRate	AliEngineAudioSampleRate	音頻採樣率。
quality	AliEngineAudioQuality	音頻品質。
externalPcmCaptureRecording	bool	是否允許錄製外部PCM輸入渲染資料。
externalPcmRenderRecording	bool	是否允許錄製外部pcm輸入渲染資料

AliEngineRecordVideoConfig

錄製視頻設定。

參數	類型	描述
quality	AliEngineVideoQuality	視頻品質。
fps	int	幀率。
bitrate	int	碼率。
sourceType	AliEngineVideoRecordSource	錄製視頻資料來源。
canvas	AliEngineVideoRecordCanvasConfig	視頻錄製解析度設定。

AliEngineVideoRecordCanvasConfig

錄製視頻解析度。

參數	類型	描述
canvasWidth	int	錄製視頻寬。
canvasHeight	int	錄製視頻高。

AliEngineRecordVideoLayoutMode

錄製視頻布局。

枚舉名	描述
AliEngineRecordVideoLayoutModeGrid	網格布局。
AliEngineRecordVideoLayoutModeSpeaker	演講者布局。
AliEngineRecordVideoLayoutModeUnique	只有一個畫面布局。
AliEngineRecordVideoLayoutModeCustom	自訂布局。

AliEngineRecordVideoBgColor

錄製視頻背景色。

參數	類型	描述
r	unsigned char	紅色分量。
g	unsigned char	綠色分量。
b	unsigned char	藍色分量。

AliEngineRecordVideoRegion

錄製視頻使用者布局。

參數	類型	描述
userId	char*	使用者資訊。
sourceType	AliEngineVideoSource	視頻源類型。
area	AliEngineRecordVideoRectangle	錄製地區。

AliEngineRecordVideoRectangle

錄製視頻座標。

參數	類型	描述
left	AliEngineRecordVideoRational	左邊座標。
top	AliEngineRecordVideoRational	上側座標。
width	AliEngineRecordVideoRational	寬度。
height	AliEngineRecordVideoRational	高度。

AliEngineRecordVideoRational

錄製視頻座標值。

參數	類型	描述
numerator	unsigned int	分子。
denominator	unsigned int	分母。

AliEngineRecordTemplate

錄製模板。

參數	類型	描述
recordType	AliEngineRecordType	錄製類型。
recordFormat	AliEngineRecordFormat	錄製格式。
sampleRate	AliEngineAudioSampleRate	錄製音頻採樣率。
audioQuality	AliEngineAudioQuality	錄製音頻品質。
externalPcmCaptureRecording	bool	是否混音錄製外部輸入音頻。
externalPcmRenderRecording	bool	是否混音錄製外部輸入渲染後的音頻。
canvas	AliEngineVideoRecordCanvasConfig	錄製視頻的畫布大小。
fps	int	幀率。
bitrate	int	碼率。
isFragment	bool	是否錄製分段MP4，預設true。

AliEngineDeviceInfo

裝置資訊。

參數	類型	描述
deviceName	String	裝置名稱。
deviceID	String	裝置ID。
deviceTransportType	AliEngineDeviceTransportType	裝置傳輸方式。

AliEngineBeautyConfig

基礎美顏設定。

參數	類型	描述
whiteningLevel	float	美白，取值範圍：[0,1]，數值越大美白效果越好。
smoothnessLevel	float	磨皮，取值範圍：[0,1]，數值越大磨皮效果越好。

AliEngineOnByeType

OnBye類型枚舉。

枚舉名	描述
AliEngineOnByeBeKickOut	被踢出。
AliEngineOnByeChannelTerminated	頻道已結束，需要離開通話。
AliEngineOnByeUserReplaced	相同使用者ID在其他裝置加入頻道，當前裝置被下線。

AliEngineAudioEffectVoiceChangerMode

變聲音效模式。

枚舉名	描述
AliEngineAudioEffectVoiceChangerOff	關閉。
AliEngineAudioEffectVoiceChangerOldMan	老人。
AliEngineAudioEffectVoiceChangerBabyBoy	男孩。
AliEngineAudioEffectVoiceChangerBabGirl	女孩。
AliEngineAudioEffectVoiceChangerRobot	機器人。
AliEngineAudioEffectVoiceChangerDaimo	大魔王。
AliEngineAudioEffectVoiceChangerKTV	KTV。
AliEngineAudioEffectVoiceChangerEcho	回聲。

AliEngineAudioEffectReverbMode

音效混響模式。

枚舉名	描述
AliEngineAudioEffectReverbOff	關閉。
AliEngineAudioEffectReverbVocal_I	人聲 I。
AliEngineAudioEffectReverbVocal_II	人聲 II。
AliEngineAudioEffectReverbBathroom	澡堂。
AliEngineAudioEffectReverbSmallRoomBright	明亮小房間。
AliEngineAudioEffectReverbSmallRoomDark	黑暗小房間。
AliEngineAudioEffectReverbMediumRoom	中等房間。
AliEngineAudioEffectReverbLargeRoom	大房間。
AliEngineAudioEffectReverbChurchHall	教堂走廊。

AliEngineAudioEffectReverbParamType

混響參數類型枚舉。

枚舉名	描述
AliEngineAudioEffectReverbRoomSize	房間大小，取值範圍：[0,100]。
AliEngineAudioEffectReverbPreDelay	預延時，單位：ms，取值範圍：[0,200]。
AliEngineAudioEffectReverbPreDelay	混響感，取值範圍：[0,100]。
AliEngineAudioEffectReverbHfDamping	消聲，取值範圍：[0,100]。
AliEngineAudioEffectReverbToneLow	低音調，取值範圍：[0,100]。
AliEngineAudioEffectReverbToneHigh	高音調，取值範圍：[0,100]。
AliEngineAudioEffectReverbDryGain	幹增益，取值範圍：[-20,10]。
AliEngineAudioEffectReverbWetGain	濕增益，取值範圍：[-20,10]。

AliEngineVideoCanvas

渲染畫布。

參數	類型	描述
displayView	void *	渲染view，不可為nil。
renderMode	AliEngineRenderMode	渲染模式，預設AliEngineRenderModeAuto。
mirrorMode	AliEngineRenderMirrorMode	鏡像模式。預設AliEngineRenderMirrorModeOnlyFrontMirror。
backgroundColor	int	背景顏色。整數類型，格式為0xRRGGBB 。
rotationMode	AliEngineRotationMode	視頻旋轉角度，預設不旋轉。
renderId	int	ID。
width	int	寬。
height	int	高。
scaleMode	AliEngineVideoScale	視頻寬高比，預設值為AliEngineVideoScale_16_9 。

AliEngineLiveTranscodingErrorCode

旁路推流錯誤碼。

枚舉名	描述
AliEngineLiveTranscodingErrorPublishOk	推流成功。
AliEngineLiveTranscodingErrorStreamNotFound	錯誤：找不到流。
AliEngineLiveTranscodingErrorStreamAlreadyExist	錯誤：目標流已存在。
AliEngineLiveTranscodingErrorInvalidParam	錯誤：非法的參數。
AliEngineLiveTranscodingErrorInternalError	錯誤：內部錯誤。
AliEngineLiveTranscodingErrorRtmpServerError	錯誤：RTMP服務異常。
AliEngineLiveTranscodingErrorRtmpStreamUrlError	錯誤：URL異常。
AliEngineLiveTranscodingErrorPublishTimeout	錯誤：任務逾時。
AliEngineLiveTranscodingErrorNotAuthorized	錯誤：操作未授權。

AliEngineWaterMarkConfig

浮水印圖片的設定。

參數	類型	描述
visibleInPreview	bool	是否將浮水印設定為預覽時本地可見。
positionInLandscapeMode	AliEngineWaterMarkPosition	橫屏時的浮水印座標。
positionInPortraitMode	AliEngineWaterMarkPosition	豎屏時的浮水印座標。
alpha	float	透明度。
normalized	bool	是否歸一化。

AliEngineCameraCapturerConfiguration

相機採集偏好屬性。

參數	類型	描述
preference	AliEngineCaptureOutputPreference	採集偏好。
fps	int	採集幀率，預設值-1，表示使用 SDK 內部編碼器的預設配置。
cameraCaptureProfile	AliEngineCameraCaptureProfile	指定視頻採集的特定解析度。
disableVideoCaptureReverse	int	不根據縱橫比設定翻轉採集視訊框架設定, -1：預設，0：不生效，1：生效。
captureObserverOriginal	int	是否回調原始的videoframe資料, -1：預設，0：關閉，1：開啟。
renderMode	AliEngineDisplayMode	如果攝像尺寸和設定的尺寸不匹配，採用的渲染方式。

AliEngineCameraCaptureProfile

相機採集解析度。

枚舉名	描述
AliEngineCameraCaptureProfileDefault	預設，跟隨編碼配置。
AliEngineCameraCaptureProfile1080P	視頻1080P使用，開啟後網路攝影機使用1080P解析度採集。

AliEngineDisplayMode

視頻顯示模式的枚舉類型，用於處理視頻源寬高比與推流配置不一致時的處理方式。

枚舉名	描述
AliEngineDisplayMode_Auto	自動（預設），如果外部輸入的視頻寬高比和推流設定的寬高比不一致時，維持外部輸入的視頻寬高比，等比例縮放寬高到推流設定的寬高範圍內，注意此模式下為了保證原始視頻的比例和內容完整性，會導致實際推流的解析度和設定的不一致。
AliEngineDisplayMode_FullOf	展開平鋪模式，如果外部輸入的視頻寬高比和推流設定的寬高比不一致時，將輸入視頻展開到推流設定的比例，畫面會變形。
AliEngineDisplayMode_FillBlack	填充黑邊模式，如果外部輸入的視頻寬高比和推流設定的寬高。
AliEngineDisplayMode_Scale	裁剪模式，如果外部輸入的視頻寬高比和推流設定的寬高比不一致時，將輸入視頻寬或者高進行裁剪，畫面內容會丟失。

AliEngineCaptureOutputPreference

網路攝影機採集偏好。

枚舉名	描述
AliEngineCaptureOutputPreferenceAuto	自動調整採集參數。
AliEngineCaptureOutputPreferencePerformance	優先保證裝置效能，根據setVideoProfile設定參數選擇最接近的網路攝影機輸出參數。
AliEngineCaptureOutputPreferencePreview	優先保證視頻預覽品質，選擇較高的網路攝影機輸出參數。

AliEngineFrameRate

視頻編碼幀率。

枚舉名	描述
AliEngineFrameRateFps5	5 FPS。
AliEngineFrameRateFps10	10 FPS。
AliEngineFrameRateFps15	15 FPS。
AliEngineFrameRateFps20	20 FPS。
AliEngineFrameRateFps30	30 FPS。

AliEngineVideoEncoderBitrate

視頻編碼碼率。

枚舉名	描述
AliEngineVideoStandardBitrate	標準碼率模式。

AliEngineVideoMirrorMode

編碼視頻鏡像模式。

枚舉名	描述
AliEngineVideoMirrorModeDisabled	編碼視頻鏡像。
AliEngineVideoMirrorModeEnable	編碼視頻不鏡像。

AliEngineVideoEncoderConfiguration

視頻編碼偏好。

參數	類型	描述
dimensions	AliEngineVideoDimensions	視頻解析度。
frameRate	AliEngineFrameRate	視頻編碼幀率。
bitrate	int	視頻編碼碼率。
keyFrameInterval	int	主要畫面格間隔，單位毫秒。預設值0，表示SDK內部控制主要畫面格間隔。
forceStrictKeyFrameInterval	bool	是否強制編碼器嚴格按照設定的主要畫面格間隔產生主要畫面格。預設值false。 false表示編碼器會響應他人入會等主要畫面格請求，主要畫面格間隔和設定的值不嚴格匹配。 true表示編碼器不響應其他主要畫面格請求，嚴格按照設定的值產生主要畫面格。可能會造成訂閱者首幀變慢。
mirrorMode	AliEngineVideoMirrorMode	編碼視頻鏡像模式。
orientationMode	AliEngineVideoEncoderOrientationMode	編碼視頻旋轉模式。
rotationMode	AliEngineRotationMode	視頻旋轉角度。
codecType	AliEngineVideoCodecType	設定編碼模式。
encodeCodecType	AliEngineVideoEncodeCodecType	編碼類別型。
seiForceFrontIFrame	int	SEI發送前強制I幀。 -1表示使用預設值，0表示不強制，1表示強制（預設值）。
enableDynamicEncode	int	使用動態編碼。
disableDipenseResolutionChange	int	是否支援編碼前縮放。
enableDowngrade	int	是否允許解析度/碼流降級。
enableH264BFrame	int	是否啟用h264 B幀。
enableHevcBFrame	int	是否啟用hevc B幀。

AliEngineVideoDecoderConfiguration

視頻解碼屬性設定。

參數

類型

描述

codecType

AliEngineVideoCodecType

設定解碼類型，例如軟解、硬解等。預設值是AliEngineVideoCodecTypeDefault，使用系統預設設定。

enableHardwareDecoderBframe

int

解碼器是否啟用 B 幀，如果發送方開了B幀，要開啟這個選項，否則無法解碼。

預設設定是-1，不啟用設定為 0,啟用設定為 1。

AliEngineVideoCodecType

視頻轉碼器類型。

枚舉值	描述
AliEngineVideoCodecTypeDefault	未設定，使用系統預設設定。
AliEngineVideoCodecTypeSoftware	軟體視頻轉碼器
AliEngineVideoCodecTypeHardware	硬體視頻轉碼器
AliEngineVideoCodecTypeHardwareTexture	硬體紋理轉碼器

AliEngineScreenShareEncoderConfiguration

螢幕分享編碼偏好。

參數	類型	描述
dimensions	AliEngineVideoDimensions	視頻解析度。
frameRate	AliEngineFrameRate	視頻編碼幀率。
bitrate	int	視頻編碼碼率。
rotationMode	AliEngineRotationMode	旋轉螢幕角度。
keyFrameInterval	int	主要畫面格間隔，單位毫秒。預設值0，表示SDK內部控制主要畫面格間隔。
forceStrictKeyFrameInterval	bool	是否強制編碼器嚴格按照設定的主要畫面格間隔產生主要畫面格。預設值為false。 false表示編碼器會響應他人入會等主要畫面格請求，主要畫面格間隔和設定的值不嚴格匹配。 true表示編碼器不響應其他主要畫面格請求，嚴格按照設定的值產生主要畫面格。可能會造成訂閱者首幀變慢。

AliEngineScreenShareConfig

螢幕分享配置。

參數	類型	描述
isShareByRegion	bool	是否是地區分享。
shareRegion	AliEngineScreenShareRegion	地區分享的布局資訊。
isPushStream	bool	是否預覽的同時推視頻流。

AliEngineScreenShareRegion

螢幕分享地區。

參數	類型	描述
originX	float	x座標。
originY	float	y座標。
width	float	寬度。
heigh	foat	高度。

AliEngineScreenSourcInfo

螢幕分享源資訊。

參數	類型	描述
sourceId	String	分享源ID。
sourceName	String	分享源名稱。
sourceIsSelf	bool	是否為SDK調用方。

AliEngineScreenShareInfo

螢幕分享配置資訊。

參數	類型	描述
shareType	AliEngineScreenShareType	分享類型。
shareSourceId	unsigned int	分享源ID。
shareConfig	AliEngineScreenShareConfig	螢幕分享配置。

AliEngineScreenShareType

螢幕分享類型。

枚舉名	描述
AliEngineScreenShareDesktop	案頭分享。
AliEngineScreenShareWindow	視窗分享。

AliEngineAuthInfo

鑒權資訊。

參數	類型	描述
channelId	char*	頻道ID。
userId	char*	使用者ID。
appId	char*	應用ID。
nonce	char*	隨機串。
token	char*	令牌。
gslb	char**	GSLB地址指標數組。
session	char*	會話id（可不填）。
role	char*	角色（可不填）。
timestamp	long long	時間戳記。
gslbCount	int	GSLB地址指標數組個數。
agent	char**	agent地址指標數組。
agentCount	int	agent地址指標數組個數。
tokenType	char*	token類型（可不填）。

AliEngineVideoSource

視頻裸資料來源類型。

枚舉名	描述
AliEngineVideoSourceCamera	視頻流。
AliEngineVideoSourceScreenShare	螢幕畫面分享流。

AliEngineAudioSource

音頻裸資料來源類型。

枚舉名	描述
AliEngineAudioSourceCaptured	採集的音頻資料。
AliEngineAudioSourceProcessCaptured	3A後的音頻資料。
AliEngineAudioSourcePub	推流音頻資料。
AliEngineAudioSourcePlayback	播放的音頻資料。
AliEngineAudioSourceRemoteUser	拉流的遠端音頻資料。
AliEngineAudioSourceMixedAll	推流和播放混音後的音頻資料。

AliEngineBufferType

視頻資料類型。

枚舉名	描述
AliEngineBufferTypeRawData	YUV裸資料。
AliEngineBufferTypeTexture	CVPixelBuffer資料。

AliEngineErrorCode

錯誤碼。

枚舉名	描述
AliEngineErrorJoinBadAppId	App ID不存在。
AliEngineErrorJoinInvaildAppId	App ID已失效。
AliEngineErrorJoinBadChannel	頻道不存在。
AliEngineErrorJoinInvaildChannel	頻道已失效。
AliEngineErrorJoinBadToken	token不存在。
AliEngineErrorJoinTimeout	加入頻道逾時。
AliEngineErrorJoinBadParam	參數錯誤。
AliEngineErrorMicOpenFail	採集裝置初始化失敗。
AliEngineErrorSpeakerOpenFail	播放裝置初始化失敗。
AliEngineErrorMicInterrupt	採集過程中出現異常。
AliEngineErrorSpeakerInterrupt	播放過程中出現異常。
AliEngineErrorMicAuthFail	麥克風裝置未授權。
AliEngineErrorMicNotAvailable	無可用的音頻採集裝置。
AliEngineErrorSpeakerNotAvailable	無可用的音頻播放裝置。
AliEngineErrorCameraOpenFail	採集裝置初始化失敗。
AliEngineErrorCameraInterrupt	採集過程中出現異常。
AliEngineErrorVideoDisplayOpenFail	染裝置初始化失敗。
AliEngineErrorVideoDisplayInterrupt	渲染過程中出現異常。
AliEngineErrorIceConnectionConnectFail	媒體通道建立失敗。
AliEngineErrorIceConnectionReconnectFail	媒體通道重連失敗。
AliEngineErrorIceConnectionHeartbeatTimeout	信令心跳逾時。
AliEngineErrorPublishInvaild	推流無效。
AliEngineErrorPublishNotJoinChannel	未進入頻道推流失敗。
AliEngineErrorPublishAudioStreamFailed	推送音頻流失敗。
AliEngineErrorPublishVideoStreamFailed	推送視頻流失敗。
AliEngineErrorPublishDualStreamFailed	推送雙流失敗。
AliEngineErrorPublishScreenShareFailed	推送螢幕畫面分享失敗。
AliEngineErrorPublishScreenShareConfigError	螢幕畫面分享配置錯誤。
AliEngineErrorSubscribeInvaild	訂閱無效。
AliEngineErrorSubscribeNotJoinChannel	未進入頻道訂閱錯誤。
AliEngineErrorSubscribeAudioStreamFailed	訂閱音頻流失敗。
AliEngineErrorSubscribeVideoStreamFailed	訂閱視頻流失敗。
AliEngineErrorSubscribeDualStreamFailed	訂閱雙流失敗。
AliEngineErrorSubscribeScreenShareFailed	訂閱螢幕畫面分享失敗。
AliEngineErrorLowLatencyLiveCommunicationFail	低延時即時音視頻信令失敗。
AliEngineErrorLowLatencyLiveMediaSettingFail	低延時即時音視頻媒體設定錯誤。
AliEngineErrorLowLatencyLiveNoneBroadcaster	低延時即時音視頻當前房間沒有主播推流。
AliEngineErrorLowLatencyLiveNeedRestart	低延時即時音視頻錯誤，應用程式層需要重新建立新的SDK執行個體。
AliEngineErrorLowLatencyLiveNeedRestartAgainLater	低延時即時音視頻錯誤，應用程式層需要稍等一定時間（自訂間隔）重新建立新的SDK執行個體。
AliEngineErrorLowLatencyLiveServiceUnavailable	低延時即時音視頻服務不可用或者服務降級。
AliEngineErrorLowLatencyLiveMediaConnectionInterrruption	低延時即時音視頻網路中斷錯誤。
AliEngineErrorInvaildState	SDK狀態錯誤。
AliEngineErrorSessionRemoved	Session已經被移除。
AliEngineErrorInvaildArgument	參數不匹配。
AliEngineErrorAudioBufferFull	buffer隊列飽和，用於外部輸送裸資料功能。
AliEngineErrorVideoBufferFull	buffer隊列飽和，用於外部輸送裸資料功能。
AliEngineErrorUpdateRoleChannel	互動模式下設定角色錯誤。
AliEngineErrorInner	其他錯誤。

AliEngineVideoObserAlignment

視頻輸出寬度對齊。

枚舉名	描述
AliEngineAlignmentDefault	保持原有視頻寬度（預設值）。
AliEngineAlignmentEven	寬度偶數對齊。
AliEngineAlignment4	寬度是4的倍數。
AliEngineAlignment8	寬度是8的倍數。
AliEngineAlignment16	寬度是16的倍數。

AliEngineShowDebugViewType

顯示儀錶盤類型。

枚舉名	描述
AliEngineShowTypeNone	不顯示。
AliEngineShowTypeAudio	音頻。
AliEngineShowTypeVideo	視頻。
AliEngineShowTypeNetwork	網路。
AliEngineShowTypeAll	全部。

AliEngineTrascodingPublishTaskStatus

旁路推流LiveStream狀態。

枚舉名	描述
AliEngineTrascodingPublishTaskStatusStart	任務開始。
AliEngineTrascodingPublishTaskStatusUpdate	任務更新。
AliEngineTrascodingPublishTaskStatusStop	任務已停止。

DisplayType

旁路直播圖片顯示類型。

枚舉名	描述
NOT_DISPLAY	不顯示。
ALWAYS	一直顯示。
WHEN_NO_VIDEO	當沒有視頻時候顯示。

AliEngineLiveTranscodingFontType

旁路直播文字類型。

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

AliEngineLiveTranscodingSegmentType

旁路直播分割類型。

枚舉名	描述
AliEngineLiveTranscodingNoBody	無人像分割。
AliEngineLiveTranscodingBody	人像分割。

AliEngineLiveTranscodingSourceType

旁路直播輸入類型。

枚舉名	描述
AliEngineLiveTranscodingCamera	相機。
AliEngineLiveTranscodingShareScreen	共用螢幕。

AliEngineVideoState

視頻流狀態變化。

枚舉名	描述
AliEngineVideoClose	關閉視頻流。
AliEngineVideoOpen	恢複視頻流。

AliEngineVideoReason

觸發視頻流狀態變化的原因。

枚舉名	描述
AliEngineVideoChangeByClient	用戶端。
AliEngineVideoChangeByServer	伺服器。

AliEngineLiveTranscodingCropMode

旁路直播裁剪模式。

枚舉名	描述
AliEngineLiveTranscodingCrop	保持比例裁剪。
AliEngineLiveTranscodingFill	保持比例留邊（預設值）。

AliEngineLiveTranscodingMediaProcessMode

旁路直播ApsaraVideo for Media Processing模式。

枚舉名	描述
AliEngineLiveTranscodingNormal	通用模式。
AliEngineLiveTranscodingVirtualBackground	虛擬背景模式。

AliEngineLiveTranscodingStreamType

旁路直播轉推流類型。

枚舉名	描述
AliEngineLiveTranscodingOrigin	轉推原始流。
AliEngineLiveTranscodingAudio	僅轉推音頻流。
AliEngineLiveTranscodingVideo	僅轉推視頻流。

AliEngineLiveTranscodingMixMode

旁路直播模式。

枚舉名	描述
AliEngineLiveTranscodingSINGLE	單路轉推，不混流轉碼，僅轉推原始單路流，無需配置混流轉碼參數。
AliEngineLiveTranscodingMIX	混流轉碼（預設值），支援混流轉碼輸出。

AliEngineLiveTranscodingState

旁路直播狀態。

枚舉名	描述
AliEngineLiveTranscodingState_IDLE	推流空閑。
AliEngineLiveTranscodingState_CONNNECT	正在串連推流伺服器。
AliEngineLiveTranscodingState_RUNNING	推流進行中。
AliEngineLiveTranscodingState_RECOVERING	正在恢複推流。
AliEngineLiveTranscodingState_FAILURE	推流失敗。
AliEngineLiveTranscodingState_END	推流結束。

AliEngineLiveTranscodingText

旁路直播文本資訊。

參數	類型	描述
text	String	文本資訊。
x	int	座標X（像素）。
y	int	座標Y（像素）。
fontType	AliEngineLiveTranscodingFontType	旁路直播字型。
fontSize	int	字型大小。
zOrder	int	疊放順序，0為最底層，1層在0層之上，以此類推。
fontColor	int	字型顏色。

AliEngineLiveTranscodingImage

旁路直播圖片資訊。

參數	類型	描述
url	String	圖片URL。
alpha	float	透明度。0.0表示透明，1.0表示完全不透明。
display	DisplayType	圖片顯示。
x	int	座標X（像素）。
y	int	座標Y（像素）。
width	int	圖片寬。
height	int	圖片高。
zOrder	int	疊放順序，0為最底層，1層0層之上，以此類推。

AliEngineLiveTranscodingUser

旁路直播使用者自訂窗格資訊。

參數	類型	描述
x	int	座標X（像素）。
y	int	座標Y（像素）。
width	int	窗格寬。
height	int	窗格高。
zOrder	int	疊放順序，0為最底層，1層在0層之上，以此類推。
userId	String	使用者ID。
sourceType	AliEngineLiveTranscodingSourceType	流類型。
segmentType	AliEngineLiveTranscodingSegmentType	旁路直播分割類型。
images	AliEngineLiveTranscodingImageArray	旁路直播圖片資訊。
texts	AliEngineLiveTranscodingTextArray	旁路直播文本資訊。

AliEngineLiveTranscodingParam

旁路直播配置。

參數	類型	描述
mixMode	AliEngineLiveTranscodingMixMode	旁路直播模式。
singleParam	AliEngineLiveTranscodingSingleParam	旁路直播單流參數。
mixParam	AliEngineLiveTranscodingMixParam	旁路直播混流參數。

AliEngineLiveTranscodingMixParam

旁路模式混流參數。

參數	類型	描述
taskProfile	AliEngineLiveTranscodingTaskProfile	旁路直播計費規格。
encodeParam	AliEngineLiveTranscodingEncodeParam	旁路直播編碼參數。
users	AliEngineLiveTranscodingUserArray	旁路直播使用者列表。
backgroundColor	int	背景色。
backgrounds	AliEngineLiveTranscodingImageArray	背景圖片列表。
watermarks	AliEngineLiveTranscodingImageArray	浮水印圖片列表。
clockWidgets	AliEngineLiveTranscodingClockWidgetArray	時鐘小組件列表。
cropMode	AliEngineLiveTranscodingCropMode	旁路直播裁剪模式。
mediaProcessMode	AliEngineLiveTranscodingMediaProcessMode	旁路直播ApsaraVideo for Media Processing模式。

AliEngineLiveTranscodingSingleParam

旁路模式單路參數。

參數	類型	描述
userId	String	使用者ID。
streamType	AliEngineLiveTranscodingStreamType	旁路直播轉推流類型。
sourceType	AliEngineLiveTranscodingSourceType	旁路直播視頻流類型。

AliEngineLiveTranscodingTaskProfile

旁路直播計費規格。

枚舉名	描述
AliEngineLiveTranscoding_Profile_1IN_1080P	1IN_1080P。
AliEngineLiveTranscoding_Profile_1IN_720P	1IN_720P。
AliEngineLiveTranscoding_Profile_1IN_360P	1IN_360P。
AliEngineLiveTranscoding_Profile_2IN_1080P	2IN_1080P。
AliEngineLiveTranscoding_Profile_2IN_720P	2IN_720P。
AliEngineLiveTranscoding_Profile_2IN_360P	2IN_360P。
AliEngineLiveTranscoding_Profile_4IN_1080P	4IN_1080P。
AliEngineLiveTranscoding_Profile_4IN_720P	4IN_720P。
AliEngineLiveTranscoding_Profile_4IN_360P	4IN_360P。
AliEngineLiveTranscoding_Profile_9IN_1080P	9IN_1080P。
AliEngineLiveTranscoding_Profile_9IN_720P	9IN_720P。
AliEngineLiveTranscoding_Profile_9IN_360P	9IN_360P。
AliEngineLiveTranscoding_Profile_12IN_1080P	12IN_1080P。
AliEngineLiveTranscoding_Profile_12IN_720P	12IN_720P。
AliEngineLiveTranscoding_Profile_12IN_360P	12IN_360P。
AliEngineLiveTranscoding_Profile_16IN_1080P	16IN_1080P。
AliEngineLiveTranscoding_Profile_16IN_720P	16IN_720P。
AliEngineLiveTranscoding_Profile_16IN_360P	16IN_360P。
AliEngineLiveTranscoding_Profile_Mixed	純音頻。

AliEngineLiveTranscodingEncodeParam

旁路直播編碼參數。

參數	類型	描述
videoWidth	int	寬。
videoHeight	int	高。
videoFramerate	int	幀率。
videoBitrate	int	碼率。
videoGop	int	GOP。
audioSamplerate	AliEngineLiveTranscodingAudioSampleRate	旁路直播音頻採樣率。
audioBitrate	int	音頻碼率。
audioChannels	int	音頻聲道數。

AliEngineLiveTranscodingAudioSampleRate

旁路直播音頻採樣率。

枚舉名	描述
AliEngineLiveTranscoding_HZ_48000	採樣率48000Hz。
AliEngineLiveTranscoding_HZ_44100	採樣率44100Hz。
AliEngineLiveTranscoding_HZ_32000	採樣率32000Hz。
AliEngineLiveTranscoding_HZ_16000	採樣率16000Hz。
AliEngineLiveTranscoding_HZ_8000	採樣率8000Hz。

AliEngineLiveTranscodingClockWidget

旁路直播時鐘小工具。

參數	類型	描述
x	int	座標X（像素）。
y	int	座標Y（像素）。
fontSize	int	旁路直播字型大小。
zOrder	int	疊放順序，0為最底層，1層在0層之上，以此類推。
fontColor	int	旁路直播字型顏色。
fontType	AliEngineLiveTranscodingFontType	旁路直播字型。

AliEngineBokehScaleModel

背景替換縮放模式。

枚舉名	描述
AliEngineBokehScaleModelCrop	等比裁剪。
AliEngineBokehScaleModelFill	填充黑邊。

AliEngineAudioAccompanyStateCode

音樂伴奏播放狀態。

枚舉名	描述
AliEngineAudioAccompanyStarted	開始播放。
AliEngineAudioAccompanyStopped	停止播放。
AliEngineAudioAccompanyPaused	播放暫停。
AliEngineAudioAccompanyResumed	播放恢複。
AliEngineAudioAccompanyEnded	播放完畢。
AliEngineAudioAccompanyBuffering	正在緩衝。
AliEngineAudioAccompanyBufferingEnd	緩衝結束。
AliEngineAudioAccompanyFailed	播放失敗。

AliEngineAudioAccompanyErrorCode

音樂伴奏播放錯誤碼。

枚舉名	描述
AliEngineAudioAccompanyNoError	沒有錯誤。
AliEngineAudioAccompanyOpenFailed	開啟檔案錯誤。
AliEngineAudioAccompanyDecodeFailed	解碼檔案錯誤。

AliEngineScreenSourceList

螢幕畫面分享源列表。

參數	類型	描述
GetCount	unsignedint	擷取螢幕分享源個數。
GetSourceInfo	AliEngineScreenSourcInfo	按索引擷取源描述資訊。
Release	無	釋放介面。

AliEngineInterfaceIdType

功能介面類型。

枚舉名	描述
AliEngineInterfaceAudioDeviceManager	對應IAliEngineAudioDeviceManager 類，實現有關音訊裝置的相關功能。
AliEngineInterfaceVideoDeviceManager	對應IAliEngineVideoDeviceManager 類，實現有關視頻裝置的相關功能。
AliEngineInterfaceMediaEngine	IAliEngineMediaEngine 類，實現音視頻媒體資料相關功能。

AliEngineVideoCodecKindType

視頻編解碼類型。

枚舉名	描述
AliEngineVideoEncoderType	編碼器。
AliEngineVideoDecoderType	解碼器。

AliEngineDeviceTransportType

裝置連線類型。

枚舉名	描述
AliEngineDeviceTransportTypeUnknown	未知裝置類型。
AliEngineDeviceTransportTypeBuiltIn	電腦內建裝置。
AliEngineDeviceTransportTypeBluetooth	藍牙裝置。
AliEngineDeviceTransportTypeUSB	USB裝置。
AliEngineDeviceTransportTypeAggregate	聚集裝置。
AliEngineDeviceTransportTypeVirtual	虛擬設備。
AliEngineDeviceTransportTypePCI	PCI裝置。
AliEngineDeviceTransportTypeFireWire	火線裝置。
AliEngineDeviceTransportTypeBluetoothLE	藍芽LE裝置。
AliEngineDeviceTransportTypeHDMI	HDMI裝置。
AliEngineDeviceTransportTypeDisplayPort	DVI裝置。
AliEngineDeviceTransportTypeAirPlay	AirPlay裝置。
AliEngineDeviceTransportTypeAVB	AVB裝置。
AliEngineDeviceTransportTypeThunderbolt	雷電口裝置。

AliEngineAudioFrameObserverConfig

音頻資料回調參數設定。

參數	類型	描述
sampleRate	AliEngineAudioSampleRate	回調音頻採樣率。
channels	AliEngineAudioNumChannelType	回調音頻聲道數。
mode	AliEngineAudioFrameObserverOperationMode	回調模式。
userDefinedInfo	int	自訂參數，取值見AliEngineAudioFrameObserverUserDefinedInfoBitMask。

AliEngineDeviceInfoList

視頻裝置列表

方法名	傳回值類型	描述
GetCount	int	解析度數量。
GetDeviceInfo	AliEngineDeviceInfo	擷取指定裝置資訊。
Release	void	釋放對象。

AliEngineVideoResolutionList

視頻解析度列表。

方法名	傳回值類型	描述
GetCount	int	解析度數量。
GetResolutionInfo	AliEngineVideoResolution	擷取指定索引的解析度。
Release	void	釋放對象。

AliEngineVideoRecordSource

錄製視頻資料來源。

枚舉名	描述
AliEngineVideoRecordSourceCamera	錄製相機流視頻。
AliEngineVideoRecordSourceScreenShare	錄製螢幕畫面分享流視頻。
AliEngineVideoRecordSourceBoth	錄製相機和螢幕畫面分享流視頻。

AliEngineAudioFrameObserverOperationMode

音頻資料回調模式。

枚舉名	描述
AliEngineAudioFrameObserverOperationModeReadOnly	唯讀模式。
AliEngineAudioFrameObserverOperationModeWriteOnly	寫入模式。
AliEngineAudioFrameObserverOperationModeReadWrite	讀寫入模式。

AliEngineVideoResolution

視頻解析度。

參數	類型	描述
width	int	寬度。
height	int	高度。

AliEngineVideoScale

視頻解析度寬高比。

枚舉名	描述
AliEngineVideoScale_16_9	16:9
AliEngineVideoScale_4_3	4:3

AliEngineWaterMarkPosition

浮水印座標系。

參數	類型	描述
x	float	橫座標，左上方起始點。
y	float	縱座標，左上方起始點。
w	float	浮水印寬度。
h	float	浮水印高度。

AliEngineVideoDimensions

視頻解析度。

參數	類型	描述
width	int	視頻寬度。
height	int	視頻高度。

AliEngineVideoEncodeCodecType

視頻編碼格式。

枚舉名	描述
AliEngineVideoEncodeCodecTypeDefault	未設定，使用預設值（目前為h264）。
AliEngineVideoEncodeCodecTypeH264	使用 H264 編碼。
AliEngineVideoEncodeCodecTypeHevc	使用 H265 編碼。

AliEngineChannelParam

使用者屬性，如使用者暱稱、類型等。

參數	類型	描述
userName	string	用於顯示的使用者名稱。
capabilityProfile	AliCapabilityProfile	使用者屬性，需要在 AI agent 通話情境下特殊配置, 非 AI AI agent 通話情境使用預設值。

AliCapabilityProfile

使用者屬性，需要在 AI agent 通話情境下特殊配置, 非 AI AI agent 通話情境使用預設值。

枚舉名	描述
AliCapabilityProfileDefault	非AI agent 通話情境。
AliCapabilityProfileHuman	使用者屬性。
AliCapabilityProfileRobot	機器人屬性。

AliEngineAudioAccompanyConfig

音頻伴奏播放配置。

參數	類型	描述
onlyLocalPlay	bool	是否只本地播放，預設值：false。
replaceMic	bool	是否替換掉MIC，預設值：false。
loopCycles	int	迴圈次數，可以設定-1(無限迴圈)或者>0的正整數次，其他值無效，預設值：-1。
startPosMs	long	起播位置，單位：ms，預設值：0 。
publishVolume	int	推流音量，取值範圍[0-100]，預設值：50。
playoutVolume	int	播放音量，取值範圍[0-100]，預設值：50。

AliEngineVideoPipelineMirrorMode

視頻鏡像模式。

枚舉名	描述
AliEngineVideoPipelineMirrorModeNoMirror	預覽和編碼均關閉鏡像。
AliEngineVideoPipelineMirrorModeBothMirror	預覽和編碼均開啟鏡像。
AliEngineVideoPipelineMirrorModeOnlyPreviewMirror	僅預覽開啟鏡像。
AliEngineVideoPipelineMirrorModeOnlyPublishMirror	僅推流開啟鏡像。

AliEngineCapturePipelineScaleMode

視頻縮放時機。

枚舉名	描述
AliEngineCapturePipelineScaleModePre	採集後立即進行縮放，預設。
AliEngineCapturePipelineScaleModePost	編碼時進行縮放。

AliEngineDataChannelMsg

data channel 訊息。

參數	類型	描述
type	AliEngineDataMsgType	訊息類型。
networkTime	long long	時間戳記。
progress	int	當天進度，單位毫秒，僅AliEngineDataMsgMusicProgress 時使用，僅在 KTV 情境使用，其他情境不需要設定。
data	void*	訊息內容，可以是任意資料，包括文字、圖片等。
dataLen	int	訊息長度。

AliEngineDataMsgType

data channel 訊息類型。

枚舉名	描述
AliEngineDataChannelNone	無訊息。
AliEngineDataChannelProgress	KTV 情境使用。
AliEngineDataChannelCustom	普通訊息，其他情境建議設定為此類型。

AliEngineAudioFileInfo

音頻檔案資訊。

參數	類型	描述
filePath	const char*	音頻檔案路徑。
durationMs	long	音頻檔案時間長度，單位為毫秒。

AliEngineLocalAudioStateType

本地音頻採集狀態。

枚舉名	描述
AliEngineLocalAudioStateTypeStarting	本地音頻採集啟動中。
AliEngineLocalAudioStateTypeStarted	本地音頻採集已啟動。
AliEngineLocalAudioStateTypeStopping	本地音頻採集關閉中。
AliEngineLocalAudioStateTypeStopped	本地音頻採集已關閉。

AliEngineLocalVideoStateType

本地視頻採集狀態。

枚舉名	描述
AliEngineLocalVideoStateTypeStarting	本地視頻採集啟動中。
AliEngineLocalVideoStateTypeStarted	本地視頻採集已啟動。
AliEngineLocalVideoStateTypeStopping	本地視頻採集關閉中。
AliEngineLocalVideoStateTypeStopped	本地視頻採集已關閉。

目錄

API詳情

AliEngineUserVolumeInfo

AliEngineAudioRawData

AliEngineVideoRawData

AliEngineChannelProfile

AliEngineClientRole

AliEngineStats

AliEngineLocalVideoStats

AliEngineRemoteVideoStats

AliEngineLocalAudioStats

AliEngineRemoteAudioStats

AliEngineVideoObserPosition

AliEngineVideoFormat

AliEngineExternalDeviceType

AliEngineExternalDeviceState

AliEngineConnectionStatus

AliEngineConnectionStatusChangeReason

AliEngineVideoTrack

AliEnginePublishState

AliEngineSubscribeState

AliEngineUserOfflineReason

AliEngineVideoStreamType

AliEngineAudioTrack

AliEngineNetworkQuality

AliEngineVideoEncoderOrientationMode

AliEngineRenderMode

AliEngineRenderMirrorMode

AliEngineRotationMode

AliEngineLogLevel

AliEngineAudioNumChannelType

AliEngineAudioSampleRate

AliEngineRecordType

AliEngineRecordFormat

AliEngineAudioQuality

AliEngineVideoQuality

AliEngineAudioProfile

AliEngineAudioScenario

AliEngineMuteLocalAudioMode

AliEngineRecordAudioConfig

AliEngineRecordVideoConfig

AliEngineVideoRecordCanvasConfig

AliEngineRecordVideoLayoutMode

AliEngineRecordVideoBgColor

AliEngineRecordVideoRegion

AliEngineRecordVideoRectangle

AliEngineRecordVideoRational

AliEngineRecordTemplate

AliEngineDeviceInfo

AliEngineBeautyConfig

AliEngineOnByeType

AliEngineAudioEffectVoiceChangerMode

AliEngineAudioEffectReverbMode

AliEngineAudioEffectReverbParamType

AliEngineVideoCanvas

AliEngineLiveTranscodingErrorCode

AliEngineWaterMarkConfig

AliEngineCameraCapturerConfiguration

AliEngineCameraCaptureProfile

AliEngineDisplayMode

AliEngineCaptureOutputPreference

AliEngineFrameRate

AliEngineVideoEncoderBitrate

AliEngineVideoMirrorMode

AliEngineVideoEncoderConfiguration

AliEngineVideoDecoderConfiguration

AliEngineVideoCodecType

AliEngineScreenShareEncoderConfiguration

AliEngineScreenShareConfig

AliEngineScreenShareRegion

AliEngineScreenSourcInfo

AliEngineScreenShareInfo

AliEngineScreenShareType

AliEngineAuthInfo

AliEngineVideoSource

AliEngineAudioSource

AliEngineBufferType

AliEngineErrorCode

AliEngineVideoObserAlignment

AliEngineShowDebugViewType