即時音視頻Android SDK有哪些資料類型 - ApsaraVideo Live

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

資料類型	描述
AliRtcAudioVolume	使用者音量資訊。
AliRtcAudioFrame	音頻裸資料。
AliRtcVideoSample	視頻樣本。
AliRtcVideoSourceType	視頻源類型。
AliRTCSdkChannelProfile	頻道模式。
AliRTCSdkClientRole	使用者角色。
AliRtcRawDataStreamType	未經處理資料流類型。
AliRtcRawDataFrame	外部視訊框架資料。
AliRtcStats	會話資料統計資訊。
AliRtcLocalVideoStats	本地視頻統計資訊。
AliRtcRemoteVideoStats	遠端視頻統計資訊。
AliRtcLocalAudioStats	本地音頻統計資訊。
AliRtcRemoteAudioStats	遠端音頻統計資訊。
AliRtcVideoObserPosition	視頻資料輸出位置。
AliRtcVideoFormat	視頻資料輸出格式。
AliRtcConnectionStatus	網路連接狀態。
AliRtcConnectionStatusChangeReason	網路連接狀態變更原因。
AliRtcVideoTrack	視頻流類型。
AliRtcPublishState	推流狀態。
AliRtcSubscribeState	訂閱狀態。
AliRtcUserOfflineReason	使用者離線原因。
AliRtcVideoStreamType	相機大小流類型。
AliRtcAudioTrack	音頻流類型。
AliRtcNetworkQuality	網路品質。
AliRtcRenderMode	渲染模式。
AliRtcRenderMirrorMode	鏡像模式。
AliRtcRotationMode	旋轉角度。
AliRtcLogLevel	記錄層級。
AliRtcAudioNumChannel	音頻聲道類型。
AliRtcAudioSampleRate	音頻採樣率類型。
AliRtcRecordType	錄製類型。
AliRtcRecordFormat	錄製格式。
AliRtcAudioQuality	錄製音頻檔案的音頻品質。
AliRtcVideoQuality	錄製視頻檔案的視頻品質。
AliRtcAudioProfile	音頻品質模式。
AliRtcAudioScenario	音頻情境模式。
AliRtcMuteLocalAudioMode	本地靜音。
AliRtcRecordAudioConfig	錄製音頻檔案參數配置。
AliRtcRecordVideoConfig	錄製視頻檔案參數配置。
AliRtcOnByeType	OnBye類型枚舉。
AliRtcAudioEffectVoiceChangerMode	變聲音效模式。
AliRtcAudioEffectReverbMode	音效混響模式。
AliRtcAudioEffectReverbParamType	音效混響參數。
AliRtcAudioRouteType	語音路由類型。
AliRtcRemoteTextureInfo	遠端使用者紋理資訊。
AliRtcVideoCanvas	渲染畫布。
AliRtcMpuState	旁路轉推任務狀態。
AliRtcRectPosition	浮水印圖片的位置和大小。
AliRtcWatermarkConfig	浮水印圖片的設定。
AliRtcTextureInfo	紋理資訊。
AliEngineCameraCapturerConfiguration	網路攝影機採集偏好屬性。
AliRtcCaptureOutputPreference	網路攝影機採集偏好。
AliRtcCameraDirection	網路攝影機方向。
AliRtcCameraCaptureProfile	指定視頻採集的特定解析度。
AliRtcVideoEncoderFrameRate	視頻編碼幀率。
AliRtcVideoEncoderBitrate	視頻編碼碼率。
AliRtcVideoEncoderMirrorMode	編碼視頻鏡像模式。
AliRtcVideoEncoderOrientationMode	編碼視頻旋轉模式。
AliRtcVideoDimensions	視頻解析度。
AliRtcVideoEncoderConfiguration	設定視頻編碼屬性。
AliRtcVideoCodecType	視頻轉碼器類型。
AliRtcVideoDecoderConfiguration	視頻解碼器設定。
AliRtcVideoEncodeCodecType	編碼器類型。
AliRtcScreenShareEncoderConfiguration	設定螢幕分享編碼屬性。
AliRtcAuthInfo	鑒權資訊。
AliRtcLiveTranscoding	旁路直播配置。
AliRtcRemoteUserInfo	遠端使用者資訊。
AliRtcVideoReason	觸發視頻流狀態變化的原因。
AliRtcVideoState	視頻流狀態變化。
AliRtcTrascodingPublishTaskStatus	旁路直播推流任務狀態。
AliEngineLiveTranscodingErrorCode	旁路直播推流錯誤碼。
AliRtcLiveTranscodingState	旁路直播狀態。
AliRtcLiveTranscodingMediaProcessMode	旁路直播ApsaraVideo for Media Processing模式。
AliRtcLiveTranscodingCropMode	旁路直播裁剪模式。
AliRtcLiveTranscodingFontType	旁路直播字型。
AliRtcLiveTranscodingSegmentType	旁路直播輸入類型。
AliRtcLiveTranscodingAudioSampleRate	旁路直播音頻採樣率。
AliRtcLiveTranscodingTaskProfile	旁路直播計費規格。
AliRtcLiveTranscodingSourceType	旁路直播視頻流類型。
AliRtcLiveTranscodingStreamType	旁路直播轉推流類型。
AliRtcLiveTranscodingMixMode	旁路直播模式。
AliRtcVideoObserAlignment	裸資料回調資料對齊類型。
AliRtcLiveTranscodingEncodeParam	旁路直播編碼參數。
AliRtcLiveTranscodingMixParam	旁路直播混流參數。
AliRtcLiveTranscodingParam	旁路直播參數。
AliRtcLiveTranscodingSingleParam	旁路直播單流參數。
TranscodingClockWidget	旁路直播時鐘小工具。
TranscodingUser	旁路直播使用者資訊。
TranscodingText	旁路直播文本資訊。
TranscodingImage	旁路直播圖片資訊。
DisplayType	圖片顯示模式。
AliRtcScreenShareMode	螢幕畫面分享類型。
AliCapabilityProfile	功能彙總參數，入會參數中使用。
AliRTCSdkChannelParam	入會參數。
AlirtcNetworkQualityProbeConfig	探測網路的參數配置。
AlirtcNetworkQualityProbeResult	探測網路的結果。
AliRtcVideoPipelineMirrorMode	視頻流鏡像模式。
AliRtcCapturePipelineScaleMode	視頻縮放時機。
AliRtcAudioSource	音頻訂閱類型。
AliRtcAudioFrameObserverConfig	音頻資料回調設定。
AliRtcAudioFrameObserverOperationMode	回調音頻資料讀寫入模式。
AliRtcAudioFrameObserverUserDefinedInfoBitMask	音頻資料回調自訂參數。
AliRtcOrientationMode	裝置方向枚舉。
AliRtcAudioAccompanyErrorCode	音樂伴奏播放錯誤碼。
AliRtcAudioAccompanyConfig	伴奏播放的配置項。
AliRtcExternalAudioStreamConfig	外部音頻流配置。
AliRtcDataChannelMsg	資料通道訊息。
AliRtcDataMsgType	資料通道訊息類型。
AliRtcVideoExternalEncoderParameter	網路變化反饋參數結構體。
AliRtcVideoEncodedFrameType	Qos反饋外置編碼器請求框架類型。
AliRtcAudioAccompanyStateCode	音樂伴奏播放狀態。
AliRtcAudioFileInfo	音頻檔案資訊。
AliRtcEngineLocalDeviceType	本地裝置類型。
AliRtcAudioEffectBeautifyMode	美聲模式類型枚舉。
AliRtcAudioEffectEqualizationBandFrequency	混響參數類型枚舉。

API詳情

AliRtcAudioVolume

使用者音量資訊。

參數	類型	描述
mUserId	String	目前使用者ID，取值： 0：本地。 1：遠端混音。其他表示遠端使用者的ID。
mVolume	int	當前回調的音量。
mSpeechstate	int	目前使用者說話狀態，取值： 0：沒有說話。 1：正在說話。

AliRtcVideoSample

視頻樣本。

參數	類型	描述
dataFrameY	long	Y分量指標。
dataFrameU	long	U分量指標。
dataFrameV	long	V分量指標。
data	byte[]	yuv資料指標。
format	AliRtcVideoFormat	視訊框架格式。
width	int	視訊框架的寬。
height	int	視訊框架的高。
strideY	int	YUV資料中的Y緩衝區的行跨度。
strideU	int	YUV資料中的U緩衝區的行跨度。
strideV	int	YUV資料中的V緩衝區的行跨度。
rotate	int	視訊框架的旋轉角度，僅支援設定0、90、180、270。
extraData	long	附加欄位（非定製化可忽略）。
textureid	long	OpenGL 紋理 ID，用於綁定紋理。
matrix	float[]	4x4 變換矩陣，用於控制紋理的旋轉、縮放或投影。
glContex	long	OpenGL 上下文指標，用於管理 GPU 渲染狀態。

AliRtcVideoSourceType

視頻源類型。

枚舉名	描述
AliRTCSdkVideoSourceCameraType	相機流。
AliRTCSdkVideoSourceScreenShareType	螢幕分享流。

AliRTCSdkChannelProfile

頻道模式。

枚舉名	描述
AliRTCSdkCommunication	通訊模式。
AliRTCSdkInteractiveLive	互動模式。
AliRTCSdkInteractiveWithLowLatencyLive	低延遲即時音視頻模式。

AliRTCSdkClientRole

使用者角色。

枚舉名	描述
AliRTCSdkInteractive	主播角色。
AliRTCSdkLive	觀眾角色。

AliRtcRawDataStreamType

未經處理資料流類型。

枚舉名	描述
AliRTCSdkStreameTypeCapture	相機流。
AliRTCSdkStreameTypeScreen	螢幕流。

AliRtcRawDataFrame

外部視訊框架資料。

參數名	類型	描述
format	AliRtcVideoFormat	視頻資料類型。
width	int	該幀的寬。
height	int	該幀的高。
rotation	int	視訊框架的旋轉角度，僅支援設定0、90、180、270。
videoFrameLength	int	該幀的長度。
lineSize	int[]	視訊框架的儲存，詳情請參見下表。
frame	byte[]	視頻的YUV位元組資料。
cropLeft	int	左側的裁剪像素點數。
cropTop	int	頂部的裁剪像素點數。
cropRight	int	右側的裁剪像素點數。
cropBottom	int	底部的裁剪像素點數。
timeStamp	long	該幀的時間戳記，單位：毫秒。
filePath	byte[]	視頻檔案路徑，對應 format 為AliRtcVideoFormatFile 時使用。
textureId	int	該幀的Texture ID。
transformMatrix	float[]	Texture幀額外的轉換。
eglContext14	EGLContext	opengl的線程相關上下文變數。

視訊框架格式	視訊框架儲存
YUV	lineSize[0] = width; // Y lineSize[1] = width/2; // U lineSize[2] = width/2; // V lineSize[3] = 0;
RGBA	lineSize[0] = width; // R lineSize[1] = width; // G lineSize[2] = width; // B lineSize[3] = width; // A

AliRtcStats

會話資料統計資訊。

參數	類型	描述
availableSendKbitrate	long	可用頻寬（kb）。
sentKbitrate	long	發送碼率。
rcvdKbitrate	long	接收碼率。
sentBytes	long	發送位元組數。
rcvdBytes	long	接收位元組數。
systemCpuUsage	float	系統CPU使用率。
cpuUsage	float	RTC進程CPU使用率。
videoRcvdKbitrate	long	視頻接收碼率。
videoSentKbitrate	long	視頻發送碼率。
callDuration	long	通話時間長度，單位：秒。
sentLossRate	long	用戶端到伺服器的丟包率。
sentLossPkts	long	用戶端到伺服器的丟包數。
sentExpectedPkts	long	用戶端到伺服器的總包數。
rcvdLossRate	long	用戶端到伺服器的下行丟包率。
rcvdLossPkts	long	用戶端到伺服器的下行丟包數。
rcvdExpectedPkts	long	用戶端到伺服器的下行總包數。
lastmileDelay	long	延時時間長度，單位：毫秒。

AliRtcLocalVideoStats

本地視頻統計資訊。

參數	類型	描述
userId	String	本機使用者ID。
track	AliRtcVideoTrack	流類型。
captureWidth	int	採集寬度。
captureHeight	int	採集高度。
encodeWidth	int	編碼寬度。
encodeHeight	int	編碼高度。
sentBitrate	int	發布位元速率。
captureFps	int	採集幀率。
sentFps	int	發布幀率。
encodeFps	int	編碼幀率。
targetEncodeBitrate	int	目標編碼碼率。
actualEncodeBitrate	int	實際編碼碼率。

AliRtcRemoteVideoStats

遠端視頻統計資訊。

參數	類型	描述
userId	String	遠端使用者ID。
track	AliRtcVideoTrack	視頻流類型。
width	int	視訊框架的寬。
height	int	視訊框架的高。
decodeFps	int	編碼器輸出幀率。
renderFps	int	渲染器輸出幀率。
frozenTimes	int	卡頓次數。
videoTotalFrozenTime	int	視頻播放的累計卡頓時間長度，單位ms。
videoTotalFrozenRate	int	視頻播放的累計卡頓率，單位% 。

AliRtcLocalAudioStats

本地音頻統計資訊。

參數	類型	描述
track	AliRtcAudioTrack	音頻流類型。
sentBitrate	int	發送碼率。
sentSamplerate	int	發送的採樣率。
numChannel	int	聲道數。
sendLoss	int	發送丟包率。

AliRtcRemoteAudioStats

遠端音頻統計資訊。

參數	類型	描述
userId	String	使用者ID。
audioTrack	AliRtcAudioTrack	音頻流類型。
sampleRate	int	採樣率。
channels	int	聲道數。
quality	int	音質。
audioLossRate	int	音頻丟包率。
rcvdBitrate	int	接收碼率。
network_transport_delay	int	音頻發送端到接收端的網路延遲，單位：毫秒。
jitter_buffer_delay	int	接收端到網路抖動緩衝的網路延遲，單位：毫秒。

AliRtcVideoObserPosition

視頻資料輸出位置。

枚舉名	描述
AliRtcPositionPostCapture	採集資料。
AliRtcPositionPreRender	拉流資料。
AliRtcPositionPreEncoder	編碼前資料。

AliRtcVideoFormat

視頻資料輸出格式。

枚舉名	描述
AliRtcVideoFormatUNKNOW	未知格式。
AliRtcVideoFormatBGRA	BGRA。
AliRtcVideoFormatI420	I420。
AliRtcVideoFormatNV21	NV21。
AliRtcVideoFormatNV12	NV12。
AliRtcVideoFormatRGBA	RGBA。
AliRtcVideoFormatI422	I422。
AliRtcVideoFormatARGB	ARGB。
AliRtcVideoFormatABGR	ABGR。
AliRtcVideoFormatRGB24	RGB24。
AliRtcVideoFormatBGR24	BGR24。
AliRtcVideoFormatRGB565	RGB565。
AliRtcVideoFormatTextureOES	TextureOES。
AliRtcVideoFormatTexture2D	Texture2D。
AliRtcVideoFormatH264	H.264 編碼視頻流格式。
AliRtcVideoFormatH265	H.265 (HEVC) 編碼視頻流格式。
AliRtcVideoFormatFile	表示資料來自檔案。

AliRtcConnectionStatus

網路連接狀態。

枚舉名	描述
AliRtcConnectionStatusInit	初始化完成。
AliRtcConnectionStatusDisconnected	網路連接斷開。
AliRtcConnectionStatusConnecting	建立網路連接中。
AliRtcConnectionStatusConnected	網路已串連。
AliRtcConnectionStatusReconnecting	重建立立網路連接中。
AliRtcConnectionStatusFailed	網路連接失敗。

AliRtcConnectionStatusChangeReason

網路連接狀態變更原因。

枚舉名	描述
AliRtcConnectionChangedDummyReason	未知原因。
AliRtcConnectionMediaPathChanged	媒體通道變更。
AliRtcConnectionSignalingHeartbeatTimeout	心跳逾時。
AliRtcConnectionSignalingHeartbeatAlive	心跳恢複。
AliRtcConnectionSignalingHttpDnsResolved	DNS解析成功。
AliRtcConnectionSignalingHttpDnsFailure	DNS解析失敗。
AliRtcConnectionSignalingGslbFailure	GSLB請求失敗。
AliRtcConnectionSignalingGslbSucccess	GSLB請求成功。
AliRtcConnectionSignalingJoinRoomFailure	加入頻道失敗。
AliRtcConnectionSignalingJoinRoomSuccess	加入頻道成功。
AliRtcConnectionSignalingLeaveRoom	離開頻道。
AliRtcConnectionSignalingConnecting	信令建立串連。
AliRtcConnectionChangedNetworkInterrupted	網路連接中斷。

AliRtcVideoTrack

視頻流類型。

枚舉名	描述
AliRtcVideoTrackNo	無視頻流。
AliRtcVideoTrackCamera	網路攝影機流。
AliRtcVideoTrackScreen	螢幕畫面分享流。
AliRtcVideoTrackBoth	網路攝影機和螢幕畫面分享。

AliRtcPublishState

推流狀態。

枚舉名	描述
AliRtcStatsPublishIdle	初始狀態。
AliRtcStatsNoPublish	未推流。
AliRtcStatsPublishing	推流中。
AliRtcStatsPublished	已推流。

AliRtcSubscribeState

訂閱狀態。

枚舉名	描述
AliRtcStatsSubscribeIdle	初始狀態。
AliRtcStatsNoSubscribe	未訂閱。
AliRtcStatsSubscribing	訂閱中。
AliRtcStatsSubscribed	已訂閱。

AliRtcUserOfflineReason

使用者離線原因。

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

AliRtcVideoStreamType

相機大小流類型。

枚舉名	描述
AliRtcVideoStreamTypeNone	無視頻流。
AliRtcVideoStreamTypeHigh	大流。
AliRtcVideoStreamTypeLow	小流。

AliRtcAudioTrack

音頻流類型。

枚舉名	描述
AliRtcAudioTrackNo	無音頻流。
AliRtcAudioTrackMic	麥克風流。
AliRtcAudioTrackDual	第二音頻流。
AliRtcAudioTrackBoth	麥克風 + 第二音頻流。

AliRtcNetworkQuality

網路品質。

枚舉名	描述
AliRtcNetworkExcellent	網路極好，流程度清晰度品質好。
AliRtcNetworkGood	網路好，流暢度清晰度和極好差不多。
AliRtcNetworkPoor	網路較差，音視頻流暢度清晰度有瑕疵，不影響溝通。
AliRtcNetworkBad	網路差，視訊卡頓嚴重，音頻能正常溝通。
AliRtcNetworkVeryBad	網路極差，基本無法溝通。
AliRtcNetworkDisconnected	網路斷開。
AliRtcNetworkUnknow	未知原因。

AliRtcRenderMode

渲染模式。

枚舉名	描述
AliRtcRenderModeAuto	自動。
AliRtcRenderModeStretch	展開填充視圖，不保持視頻比例。
AliRtcRenderModeFill	在保持視頻寬高比的同時縮放，填充黑邊。
AliRtcRenderModeClip	在保持視頻寬高比的同時縮放，並裁剪以適合視圖。
AliRtcRenderModeNoChange	不調整輸入視頻的寬高比，直接渲染（適合輸入視頻與目標解析度完全一致的情境，或開發人員自訂適配邏輯）。

AliRtcRenderMirrorMode

鏡像模式。

枚舉名	描述
AliRtcRenderMirrorModeOnlyFront	只有自拍預覽鏡像，其餘不鏡像。
AliRtcRenderMirrorModeAllEnabled	全部鏡像。
AliRtcRenderMirrorModeAllDisable	全部不鏡像。

AliRtcRotationMode

旋轉角度。

枚舉名	描述
AliRtcRotationMode_0	不旋轉。
AliRtcRotationMode_90	旋轉90度。
AliRtcRotationMode_180	旋轉180度。
AliRtcRotationMode_270	旋轉270度。

AliRtcLogLevel

記錄層級。

枚舉名	描述
AliRtcLogLevelInfo	普通。
AliRtcLogLevelWarn	警告。
AliRtcLogLevelError	錯誤。
AliRtcLogLevelFatal	嚴重。
AliRtcLogLevelNone	無。

AliRtcAudioNumChannel

音頻聲道類型。

枚舉名	描述
AliRtcMonoAudio	單聲道。
AliRtcStereoAudio	雙聲道。

AliRtcAudioSampleRate

音頻採樣率類型。

枚舉名	描述
AliRtcAudioSampleRate_8000	採樣率8000。
AliRtcAudioSampleRate_11025	採樣率11025。
AliRtcAudioSampleRate_16000	採樣率16000。
AliRtcAudioSampleRate_22050	採樣率22050。
AliRtcAudioSampleRate_32000	採樣率32000。
AliRtcAudioSampleRate_44100	採樣率44100。
AliRtcAudioSampleRate_48000	採樣率48000。
AliRtcAudioSampleRate_Unknown	未知採樣率。
AliRtcAudioSampleRate_Max	邊界值。

AliRtcRecordType

錄製類型。

枚舉名	描述
AliRtcRecordTypeAudio	錄製純音頻檔案。
AliRtcRecordTypeVideo	錄製視頻檔案。

AliRtcRecordFormat

錄製格式。

枚舉名	描述
AliRtcRecordFormatAAC	AAC檔案。
AliRtcRecordFormatWAV	WAV檔案。
AliRtcRecordFormatMP4	MP4檔案。

AliRtcAudioQuality

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

枚舉名	描述
AliRtcAudioQualityLow	低。
AliRtcAudioQualityMidium	中。
AliRtcAudioQualityHigh	高。

AliRtcVideoQuality

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

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

AliRtcAudioProfile

音頻品質模式。

枚舉名	描述
AliRtcEngineLowQualityMode	音頻低音質模式。
AliRtcEngineBasicQualityMode	標準音質模式。
AliRtcEngineHighQualityMode	高音質模式。
AliRtcEngineStereoHighQualityMode	立體聲高音質模式。
AliRtcEngineSuperHighQualityMode	超高音質模式。
AliRtcEngineStereoSuperHighQualityMode	立體聲超高音質模式。

AliRtcAudioScenario

音頻情境模式。

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

AliRtcMuteLocalAudioMode

本地靜音。

枚舉名	描述
AliRtcMuteAudioModeDefault	預設模式（靜音全部，包括麥克風及外部輸入音頻）。
AliRtcMuteAllAudioMode	靜音全部（包括麥克風及外部輸入音頻）。
AliRtcMuteOnlyMicAudioMode	只靜音麥克風。
AliRtcMuteLocalAudioMax	預留位置。

AliRtcRecordAudioConfig

錄製音頻檔案參數配置。

枚舉名	描述
AliRtcAudioSampleRate	錄製音頻檔案採樣率。
AliRtcAudioQuality	錄製音頻檔案品質。

AliRtcRecordVideoConfig

錄製視頻檔案參數配置。

枚舉名	描述
AliRtcVideoQuality	錄製視頻檔案品質。

AliRtcOnByeType

OnBye類型枚舉。

枚舉名	描述
AliRtcByeTypeKickOff	被踢出。
AliRtcByeTypeDelChannel	頻道被刪除。
AliRtcByeTypeRestoreSession	被動離開需要恢複Session。

AliRtcAudioEffectVoiceChangerMode

變聲音效模式。

枚舉名	描述
AliRtcSdk_AudioEffect_Voice_Changer_OFF	關閉。
AliRtcSdk_AudioEffect_Voice_Changer_Oldman	老人。
AliRtcSdk_AudioEffect_Voice_Changer_Babyboy	男孩。
AliRtcSdk_AudioEffect_Voice_Changer_Babygirl	女孩。
AliRtcSdk_AudioEffect_Voice_Changer_Robot	機器人。
AliRtcSdk_AudioEffect_Voice_Changer_Daimo	大魔王。
AliRtcSdk_AudioEffect_Voice_Changer_Ktv	KTV。
AliRtcSdk_AudioEffect_Voice_Changer_Echo	回聲。
AliRtcSdk_AudioEffect_Voice_Changer_Dialect	方言。
AliRtcSdk_AudioEffect_Voice_Changer_Howl	怒吼。
AliRtcSdk_AudioEffect_Voice_Changer_Electronic	電音。
AliRtcSdk_AudioEffect_Voice_Changer_Phonograph	留聲機。
AliRtcSdk_AudioEffect_Voice_Changer_MAX	預留位置，無含義。

AliRtcAudioEffectReverbMode

音效混響模式。

枚舉名	描述
AliRtcAudioEffectReverb_Off	關閉。
AliRtcAudioEffectReverb_Vocal_I	人聲 I。
AliRtcAudioEffectReverb_Vocal_II	人聲 II。
AliRtcAudioEffectReverb_Bathroom	澡堂。
AliRtcAudioEffectReverb_Small_Room_Bright	明亮小房間。
AliRtcAudioEffectReverb_Small_Room_Dark	黑暗小房間。
AliRtcAudioEffectReverb_Medium_Room	中等房間。
AliRtcAudioEffectReverb_Large_Room	大房間。
AliRtcAudioEffectReverb_Church_Hall	教堂走廊。

AliRtcAudioEffectReverbParamType

音效混響參數。

枚舉名	描述
AliRtcAudioEffectReverb_Room_Size	房間大小，取值範圍：[0,100]。
AliRtcAudioEffectReverb_Pre_Delay	預延時，單位：毫秒。取值範圍：[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]。

AliRtcAudioRouteType

語音路由。

枚舉名	描述
AliRtcAudioRouteType_Default	預設的語音路由。
AliRtcAudioRouteType_Headset	耳機。
AliRtcAudioRouteType_Earpiece	耳機。
AliRtcAudioRouteType_HeadsetNoMic	不帶麥的耳機。
AliRtcAudioRouteType_Speakerphone	手機擴音器。
AliRtcAudioRouteType_LoudSpeaker	外接擴音器。
AliRtcAudioRouteType_BlueTooth	藍芽耳機。

AliRtcRemoteTextureInfo

遠端使用者紋理資訊。

參數	類型	描述
aliVideoCanvas	AliRtcVideoCanvas	渲染畫布。
userId	String	遠端使用者ID。
videoTrack	int	視頻流類型。

AliRtcVideoCanvas

渲染畫布。

參數	類型	描述
textureId	int	視頻資料紋理類型ID。
textureWidth	int	紋理寬。
textureHeight	int	紋理高。
sharedContext	long	opengl的線程相關上下文變數。
enableBeauty	boolean	是否開啟美顏。取值： true：開啟。 false：未開啟。預設值為false。
view	View	視頻顯示視窗。必須是通過createRenderSurfaceView 介面建立出來的SurfaceView渲染視圖，或者createRenderTextureView 建立出來的TextureView渲染視圖。
renderMode	AliRtcRenderMode	視圖渲染模式，預設AliRtcRenderModeAuto。
mirrorMode	AliRtcRenderMirrorMode	視圖鏡像模式，預設AliRtcRenderMirrorModeOnlyFront。
rotationMode	AliRtcRotationMode	視圖旋轉角度，預設AliRtcRotationMode_0。
backgroundColor	int	視圖背景顏色。

AliRtcMpuState

旁路轉推任務狀態。

枚舉名	描述
AliRtcMpuStateStart	旁路任務啟動。
AliRtcMpuStateUpdate	旁路任務更新。
AliRtcMpuStateStop	旁路任務停止。
AliRtcMpuStateEnd	旁路任務結束。
AliRtcMpuStateConnect	旁路任務串連中。
AliRtcMpuStateRunning	旁路任務正在運行。
AliRtcMpuStateRecovering	旁路任務重新恢複。
AliRtcMpuStateFailed	旁路任務失敗。
AliRtcMpuStateUnknow	旁路任務未知狀態。

AliRtcRectPosition

浮水印圖片的位置和大小。

參數名	類型	描述
x	float	左上方的橫向位移。
y	float	左上方的縱向位移。
width	float	浮水印圖片的寬。
height	float	浮水印圖片的高。

AliRtcWatermarkConfig

浮水印圖片的設定選項。

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

AliRtcTextureInfo

紋理資訊。

參數	類型	描述
textureId	int	紋理ID。
mirrorMode	AliRtcRenderMirrorMode	鏡像模式。

AliEngineCameraCapturerConfiguration

相機採集偏好屬性。

參數	類型	描述
preference	AliRtcCaptureOutputPreference	採集偏好。
cameraDirection	AliRtcCameraDirection	相機方向（只支援Android和iOS）。
fps	int	說明使用encoder的fps，預設是內部fps是15
cameraCaptureProfile	AliRtcCameraCaptureProfile	指定視頻採集的特定解析度
disableVideoCaptureReverse	int	不根據縱橫比設定翻轉採集視訊框架設定
captureObserverOriginal	int	是否回調原始的videoframe資料
textureEncode	int	是否使用紋理編碼
cameraTextureCapture	int	網路攝影機是否開啟紋理採集

AliRtcCaptureOutputPreference

網路攝影機採集偏好。

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

AliRtcCameraDirection

網路攝影機方向。

枚舉名	描述
CAMERA_INVALID	無效。
CAMERA_REAR	使用後置網路攝影機。
CAMERA_FRONT	使用自拍。

AliRtcCameraCaptureProfile

指定視頻採集的特定解析度。

枚舉名	描述
ALIRTC_CAMERA_CAPTURER_PROFILE_DEFAULT	預設。
ALIRTC_CAMERA_CAPTURER_PROFILE_1080P	視頻1080P使用，開啟後網路攝影機使用1080P解析度採集。

AliRtcVideoEncoderFrameRate

視頻編碼幀率。

枚舉名	描述
AliRtcVideoEncoderFrameRate_FPS_5	5 FPS。
AliRtcVideoEncoderFrameRate_FPS_10	10 FPS。
AliRtcVideoEncoderFrameRate_FPS_15	15 FPS。
AliRtcVideoEncoderFrameRate_FPS_20	20 FPS。
AliRtcVideoEncoderFrameRate_FPS_30	30 FPS。

AliRtcVideoEncoderBitrate

視頻編碼碼率。

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

AliRtcVideoEncoderMirrorMode

編碼視頻鏡像模式。

枚舉名	描述
AliRtcVideoEncoderMirrorModeDisabled	編碼視頻鏡像。
AliRtcVideoEncoderMirrorModeEnabled	編碼視頻不鏡像。

AliRtcVideoEncoderOrientationMode

編碼視頻旋轉模式。

枚舉名	描述
AliRtcVideoEncoderOrientationModeAdaptive	自適應，和採集視頻角度保持一致。
AliRtcVideoEncoderOrientationModeFixedLandscape	固定橫屏。
AliRtcVideoEncoderOrientationModeFixedPortrait	固定豎屏。

AliRtcVideoDimensions

視頻解析度。

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

AliRtcVideoEncoderConfiguration

視頻編碼偏好。

參數名	類型	描述
dimensions	AliRtcVideoDimensions	視頻解析度，視頻解析度，預設值640x480，最大值1920x1080。
frameRate	int	視頻編碼幀率，預設值15, 最大值30。
bitrate	int	視頻編碼碼率（kbps)，預設值為 512。設定為0表示由SDK內部根據視頻解析度和碼率計算合適的編碼碼率。碼率設定應根據解析度和幀率有對應的合理範圍，該值設定在合理範圍內有效，否則SDK會自動調節碼率到有效值。
minBitrate	NSInteger	最小視頻編碼碼率(Kbps)，預設值為0。
keyFrameInterval	int	主要畫面格間隔，單位毫秒。預設值0，表示SDK內部控制主要畫面格間隔。
forceStrictKeyFrameInterval	boolean	是否強制編碼器嚴格按照設定的主要畫面格間隔產生主要畫面格，預設值false。 false：表示編碼器會響應他人入會等主要畫面格請求，主要畫面格間隔和設定的值不嚴格匹配。 true：表示編碼器不響應其他主要畫面格請求，嚴格按照設定的值產生主要畫面格。可能會造成訂閱者首幀變慢。
mirrorMode	AliRtcVideoEncoderMirrorMode	編碼視頻鏡像模式。
orientationMode	AliRtcVideoEncoderOrientationMode	編碼視頻旋轉模式。
rotationMode	AliRtcRotationMode	視頻旋轉角度。
codecType	AliRtcVideoCodecType	轉碼器類型。
encodeCodecType	AliRtcVideoEncodeCodecType	視頻編碼類別型。
seiForceFrontIFrame	int	SEI發送前強制I幀。 -1表示使用預設值，0表示不強制，1表示強制（預設值）。
enableDynamicEncode	int	啟用動態編碼。同時建立硬體編碼和軟體編碼，在硬體編碼器出問題之後降級到軟體編碼，-1表示使用預設值，0表示不同時建立兩種編碼，1表示建立兩種編碼。
disableDipenseResolutionChange	int	關閉QoS降低解析度能力。在QoS探測到即時頻寬下降不足以當前方解析度進行編碼，降低視頻編碼解析度； -1表示使用預設值，0表示允許降低，1表示不允許QoS降低解析度。
enableDowngrade	int	允許QoS根據實際探測頻寬降低視頻編碼碼流。 -1表示使用預設值，0表示不允許降低編碼碼流大小，1允許降低編碼碼流大小。
enableH264BFrame	int	是否開啟h264 B幀支援。 -1表示使用預設值，0表示不開啟B幀支援，1表示開啟B幀支援。重要開啟該項之後，必須解碼端同步開啟B幀支援。
enableHevcBFrame	int	是否開啟hevc B幀支援。 -1表示使用預設值，0表示不開啟B幀支援，1表示開啟B幀支援。重要開啟該項之後，必須解碼端同步開啟B幀支援。

AliRtcVideoCodecType

視頻編解碼類型。

枚舉名	描述
AliRtcVideoCodecTypeDefault	未設定，使用預設值（硬體編碼）
AliRtcVideoCodecTypeSoftware	軟體視頻轉碼器
AliRtcVideoCodecTypeHardware	硬體視頻轉碼器
AliRtcVideoCodecTypeHardwareTexture	硬體紋理轉碼器

AliRtcVideoDecoderConfiguration

視頻解碼器設定。

參數	類型	描述
codecType	AliRtcVideoCodecType	轉碼器類型預設值是AliRtcVideoCodecTypeDefault，使用系統預設設定，
enableDecoderBframe	int	是否啟用解碼器B幀預設設定是-1，不啟用B幀為0，啟用B幀設定為1，
textureBindContext	int	是否支援紋理解碼綁定上下文預設設定是-1，不啟用設定為0，啟用降級邏輯設定為1；

AliRtcVideoEncodeCodecType

編碼器類型。

枚舉名	描述
AliRtcVideoEncodeCodecTypeDefault	未設定，使用預設值（目前為h264）
AliRtcVideoEncodeCodecTypeH264	h264編碼
AliRtcVideoEncodeCodecTypeHevc	hevc編碼

AliRtcScreenShareEncoderConfiguration

螢幕編碼偏好。

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

AliRtcAuthInfo

鑒權資訊。

參數名	類型	描述
channelId	String	頻道ID。
userId	String	使用者ID。
appId	String	應用ID。
nonce	String	隨機串。
timestamp	long	時間戳記。
token	String	令牌。

AliRtcLiveTranscoding

旁路直播配置。

參數名	類型	描述
mMixMode	int	混流模式。取值： 0：單路轉推，不混流轉碼僅轉推原始單路流，無需配置混流轉碼參數。 1：混流轉碼，支援混流轉碼輸出。預設值為1。
mLayoutIds	List<String>	布局ID數組。
mSubSpecUsers	List<TranscodingUser>	指定混流使用者列表。
mUserPanes	List<TranscodingUserPane>	使用者窗格列表。
mLayouts	List<TranscodingLayout>	使用者自訂布局列表。
mTaskProfile	String	任務計費配置。
mBackgroundColor	int	背景色RGB，預設值為0（黑色）。計算公式為R + G × 256 + B × 65536，R（紅）、G（綠）、B（藍）的取值範圍：0~255。
mMediaEncode	int	編碼選項。
mCropMode	int	視頻的裁剪方式。取值： 1：保持比例裁剪。 2：保持比例留邊。預設值為2。
mStreamType	int	單路轉推模式下轉推音頻流。取值： 0：轉推原始流。 1：僅轉推音頻流。 2：僅轉推視頻流。預設值為0。
mSourceType	String	單路轉推模式下使用者視頻輸入資料流。取值： camera：網路攝影機。 shareScreen：螢幕畫面分享。
mExternalParam	String	拓展欄位。

AliRtcRemoteUserInfo

遠端使用者資訊。

參數名	類型	描述
userID	String	遠端使用者的ID。
sessionID	String	遠端使用者的會話ID。
displayName	String	遠端使用者的名稱。
muteAudioPlaying	boolean	本端是否靜音了此遠端使用者。
isOnline	boolean	遠端使用者是否線上。
cameraCanvas	AliRtcVideoCanvas	相機流畫布。
screenCanvas	AliRtcVideoCanvas	螢幕流畫布。
hasAudio	boolean	遠端使用者是否推送了音頻流。
hasCameraMaster	boolean	遠端使用者是否推送了相機大流。
hasCameraSlave	boolean	遠端使用者是否推送了相機小流。
hasScreenSharing	boolean	遠端使用者是否推送了螢幕流。
subScribedAudio	boolean	本端是否拉到了此遠端使用者的音頻流。
subScribedCamearSlave	boolean	本端是否拉到了此遠端使用者的相機小流。
subScribedCameraMaster	boolean	本端是否拉到了此遠端使用者的相機大流。
subScribedScreenSharing	boolean	本端是否拉到了此遠端使用者的螢幕流。
requestAudio	boolean	本端是否訂閱了此遠端使用者的音頻流。
requestCameraSlave	boolean	本端是否訂閱了此遠端使用者的相機小流。
requestCameraMaster	boolean	本端是否訂閱了此遠端使用者的相機大流。
requestScreenSharing	boolean	本端是否訂閱了此遠端使用者的螢幕流。
preferCameraMaster	boolean	遠端使用者是否開啟了大流優先。
hasCameraView	boolean	本端是否設定了此遠端使用者相機流的view。
hasScreenView	boolean	本端是否設定了此遠端使用者螢幕流的view。

AliRtcVideoReason

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

枚舉名	描述
AliRTCVideoChangedByClient	用戶端。
AliRTCVideoChangedByServer	伺服器。

AliRtcVideoState

視頻流狀態變化。

枚舉名	描述
AliRtcVideoVideoClose	關閉視頻流。
AliRtcVideoVideoOpen	恢複視頻流。

AliRtcTrascodingPublishTaskStatus

旁路直播推流任務狀態。

枚舉名	描述
AliRtcTrascodingPublishTaskStatusStart	旁路直播推流任務開始。
AliRtcTrascodingPublishTaskStatusUpdate	旁路直播推流任務更新。
AliRtcTrascodingPublishTaskStatusStop	旁路直播推流任務停止。

AliEngineLiveTranscodingErrorCode

旁路直播推流錯誤碼。

枚舉名	描述
AliEngineLiveTranscodingErrorPublishOk	旁路直播準備完成。
AliEngineLiveTranscodingErrorStreamNotFound	旁路直播推流地址未找到。
AliEngineLiveTranscodingErrorStreamAlreadyExist	請求的流已存在，無法重複建立。
AliEngineLiveTranscodingErrorInvalidParam	輸入參數不符合規範（如格式錯誤、缺失等）。
AliEngineLiveTranscodingErrorInternalError	SDK 內部發生未知錯誤。
AliEngineLiveTranscodingErrorRtmpServerError	RTMP 伺服器返回錯誤（如串連失敗、認證失敗）。
AliEngineLiveTranscodingErrorRtmpStreamUrlError	RTMP 流地址格式不正確（如缺少協議頭、網域名稱錯誤）。
AliEngineLiveTranscodingErrorPublishTimeout	旁路推流操作在指定時間內未完成。
AliEngineLiveTranscodingErrorNotAuthorized	使用者無許可權執行當前操作（如 Token 無效或到期）。

AliRtcLiveTranscodingState

旁路直播狀態。

枚舉名	描述
AliRtcLiveTranscodingState_IDLE	推流空閑。
AliRtcLiveTranscodingState_CONNNECT	正在串連推流伺服器。
AliRtcLiveTranscodingState_RUNNING	推流進行中。
AliRtcLiveTranscodingState_RECOVERING	正在恢複推流。
AliRtcLiveTranscodingState_FAILURE	推流失敗。
AliRtcLiveTranscodingState_END	推流結束。

AliRtcLiveTranscodingMediaProcessMode

旁路直播ApsaraVideo for Media Processing模式。

枚舉名	描述
AliRtcLiveTranscodingNormal	通用模式。
AliRtcLiveTranscodingVirtualBackground	虛擬背景模式。

AliRtcLiveTranscodingCropMode

旁路直播裁剪模式。

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

AliRtcLiveTranscodingFontType

旁路直播字型。

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

AliRtcLiveTranscodingSegmentType

旁路直播輸入類型。

枚舉名	描述
AliRtcLiveTranscodingNoBody	無人像分割。
AliRtcLiveTranscodingBody	人像分割。

AliRtcLiveTranscodingAudioSampleRate

旁路直播音頻採樣率。

枚舉名	描述
AliRtcLiveTranscoding_HZ_48000	採樣率48000Hz。
AliRtcLiveTranscoding_HZ_44100	採樣率44100Hz。
AliRtcLiveTranscoding_HZ_32000	採樣率32000Hz。
AliRtcLiveTranscoding_HZ_16000	採樣率16000Hz。
AliRtcLiveTranscoding_HZ_8000	採樣率8000Hz。

AliRtcLiveTranscodingTaskProfile

旁路直播計費規格。

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

AliRtcLiveTranscodingSourceType

旁路直播視頻流類型。

枚舉名	描述
AliRtcLiveTranscodingCamera	網路攝影機。
AliRtcLiveTranscodingShareScreen	螢幕畫面分享。

AliRtcLiveTranscodingStreamType

旁路直播轉推流類型。

枚舉名	描述
AliRtcLiveTranscodingOrigin	轉推原始流。
AliRtcLiveTranscodingAudio	僅轉推音頻流。
AliRtcLiveTranscodingVideo	僅轉推視頻流。

AliRtcLiveTranscodingMixMode

旁路直播模式。

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

AliRtcVideoObserAlignment

裸資料回調資料對齊類型。

枚舉名	描述
AliRtcAlignmentDefault	不處理，直接未經處理資料回調。
AliRtcAlignmentEven	寬處理成偶數。
AliRtcAlignment4	寬處理成4的倍數。
AliRtcAlignment8	寬處理成8的倍數。
AliRtcAlignment16	寬處理成16的倍數。

AliRtcLiveTranscodingEncodeParam

旁路直播編碼參數。

參數	類型	描述
videoWidth	int	寬。
videoHeight	int	高。
videoFramerate	int	幀率。
videoBitrate	int	碼率。
videoGop	int	GOP。
videoCodec	AliRtcLiveTranscodingVideoCodec	編碼器類型，H264/H265。
audioSamplerate	AliRtcLiveTranscodingAudioSampleRate	旁路直播音頻採樣率。
audioBitrate	int	音頻碼率。
audioChannels	int	音頻聲道數。

AliRtcLiveTranscodingMixParam

旁路直播混流參數。

參數	類型	描述
taskProfile	AliRtcLiveTranscodingTaskProfile	旁路直播計費規格。
encodeParam	AliRtcLiveTranscodingEncodeParam	旁路直播編碼參數。
users	List<TranscodingUser>	旁路直播使用者列表。
backgroundColor	int	背景色。
backgrounds	List<TranscodingImage>	背景圖片列表。
watermarks	List<TranscodingImage>	浮水印圖片列表。
clockWidgets	List<TranscodingClockWidget>	時鐘小組件列表。
cropMode	AliRtcLiveTranscodingCropMode	旁路直播裁剪模式。
mediaProcessMode	AliRtcLiveTranscodingMediaProcessMode	旁路直播ApsaraVideo for Media Processing模式。

AliRtcLiveTranscodingParam

旁路直播參數。

參數	類型	描述
mixMode	AliRtcLiveTranscodingMixMode	旁路直播模式。
singleParam	AliRtcLiveTranscodingSingleParam	旁路直播單流參數。
mixParam	AliRtcLiveTranscodingMixParam	旁路直播混流參數。

AliRtcLiveTranscodingSingleParam

旁路直播單流參數。

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

TranscodingClockWidget

旁路直播時鐘小工具。

參數	類型	描述
mX	int	座標X（像素）。
mY	int	座標Y（像素）。
mFontSize	int	旁路直播字型大小。
mZorder	int	疊放順序，0為最底層，1層在0層之上，以此類推。
mFontColor	int	旁路直播字型顏色。
mFontType	AliRtcLiveTranscodingFontType	旁路直播字型。

TranscodingUser

旁路直播使用者資訊。

參數	類型	描述
mUserId	String	使用者ID。
x	int	座標X（像素）。
y	int	座標Y（像素）。
width	int	窗格寬。
height	int	窗格高。
zOrder	int	疊放順序，0為最底層，1層在0層之上，以此類推。
streamType	AliRtcLiveTranscodingStreamType	旁路直播轉推流模式。
sourceType	AliRtcLiveTranscodingSourceType	旁路直播視頻流類型。
segmentType	AliRtcLiveTranscodingSegmentType	旁路直播輸入類型。
images	List<TranscodingImage>	圖片列表。
texts	List<TranscodingText>	文本列表。

TranscodingText

旁路直播文本資訊。

參數	類型	描述
mText	String	文本資訊。
mX	int	座標X（像素）。
mY	int	座標Y（像素）。
mFontSize	int	字型大小。
mZorder	int	疊放順序，0為最底層，1層在0層之上，以此類推。
mFontColor	int	字型顏色。
mFontType	AliRtcLiveTranscodingFontType	旁路直播字型。

TranscodingImage

旁路直播圖片資訊。

參數	類型	描述
mUrl	String	圖片URL。
mAlpha	float	透明度。0.0表示透明，1.0表示完全不透明。
mDisplay	DisplayType	圖片顯示。
mX	int	座標X（像素）。
mY	int	座標Y（像素）。
mWidth	int	窗格寬。
mHeight	int	窗格高。
mZorder	int	疊放順序，0為最底層，1層在0層之上，以此類推。

DisplayType

圖片顯示模式。

枚舉名	描述
NOT_DISPLAY	不顯示。
ALWAYS	總是顯示。
WHEN_NO_VIDEO	沒有視頻時顯示。

AliRtcScreenShareMode

枚舉名	描述
AliRtcScreenShareNoneMode	不共用。
AliRtcScreenShareOnlyVideoMode	共用視頻流。
AliRtcScreenShareOnlyAudioMode	共用APP音頻流。
AliRtcScreenShareAllMode	共用所有音視頻流。

AliCapabilityProfile

功能彙總參數，入會參數中使用。

枚舉名	描述
AliCapabilityProfileDefault	預設值, 無特殊要求。
AliCapabilityProfileAiHuman	AI agent通話情境下, 真實使用者的功能配置。
AliCapabilityProfileAiRobot	AI agent通話情境下, 機器人的功能配置。

AliRTCSdkChannelParam

入會參數。

參數	類型	描述
channelId	String	房間頻道號。
userId	String	入會使用者名稱。
userName	String	任意用於顯示的使用者名稱稱，不是User ID；可以不傳,標識沒有userName。
capabilityProfile	AliCapabilityProfile	使用者屬性，需要在AI agent通話情境下特殊配置, 非AI agent通話情境使用預設值。

AlirtcNetworkQualityProbeConfig

網路探測的參數配置。

參數	類型	描述
probeUplink	boolean	是否探測上行頻寬，預設false。
probeDownlink	boolean	是否探測下行頻寬，預設false，暫不支援。
expectedUplinkBitrateKbps	int	上行頻寬探測的峰值，單位Kbps，預設1000。
expectedDownlinkBitrateKbps	int	下行頻寬探測的峰值，單位Kbps。暫不支援，預設1000。

AlirtcNetworkQualityProbeResult

網路探測的結果。

參數	類型	描述
rtt	int	鏈路的RTT，單位ms。
uplinkPacketLossRate	int	探測上行網路的丟包率，最大值100%。
upLinkJitter	int	探測上行網路的jitter，單位ms。
upLinkAvailableBandwidth	int	上行網路頻寬，單位kbps。
downLinkPacketLossRate	int	探測下行網路的丟包率，最大值100%，暫不支援。
downLinkJitter	int	探測下行網路的jitter，單位ms，暫不支援。
downLinkAvailableBandwidth	int	下行網路頻寬，單位kbps，暫不支援。

AliRtcVideoPipelineMirrorMode

視頻流鏡像模式。

枚舉名	描述
AliRtcVideoPipelineMirrorModeNoMirror	預覽和編碼均關閉鏡像。
AliRtcVideoPipelineMirrorModeBothMirror	預覽和編碼均開啟鏡像。
AliRtcVideoPipelineMirrorModeOnlyPreviewMirror	僅預覽開啟鏡像。
AliRtcVideoPipelineMirrorModeOnlyPublishMirror	僅推流開啟鏡像。

AliRtcCapturePipelineScaleMode

視頻縮放時機。

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

AliRtcAudioFrame

音頻裸資料。

參數名	類型	描述
dataPtr	long	音頻資料native指標。
data	byte[]	音頻資料。
numSamples	int	採樣點數。
bytesPerSample	int	每個採樣點位元組數。
numChannels	int	聲道數。
samplesPerSec	int	每秒採樣數。

AliRtcAudioSource

音頻訂閱類型。

枚舉名	描述
AliRtcAudioSourceCaptured	採集的音頻資料。
AliRtcAudioSourceProcessCaptured	3A後的音頻資料。
AliRtcAudioSourcePub	推流的音頻資料。
AliRtcAudioSourcePlayback	播放的音頻資料。
AliRtcAudioSourceMixedAll	推流和播放混音後的音頻資料。
AliRtcAudioSourceRemoteUser	拉流的遠端音頻資料。

AliRtcAudioFrameObserverConfig

音頻資料回調設定。

參數	類型	描述
sampleRate	AliRtcAudioSampleRate	回調音頻採樣率枚舉，預設為AliRtcAudioSampleRate_48000。
channels	AliRtcAudioNumChannel	回調音頻聲道數，支援單聲道和雙聲道，預設值為單聲道（AliRtcMonoAudio）。
mode	AliRtcAudioFrameObserverOperationMode	回調模式，包含唯讀模式（0），唯寫模式（1），讀寫入模式（2）。預設值為唯讀模式（AliRtcAudioDataObserverOperationModeReadOnly）。
userDefinedInfo	int	使用者自訂參數，用於設定onMixedAllAudioFrame 回調的混流模式，預設混外部渲染的音頻（AliRtcAudioFrameObserverUserDefinedInfoBitMaskMixExRender）。

AliRtcAudioFrameObserverOperationMode

回調音頻資料讀寫入模式。

枚舉名	描述
AliRtcAudioDataObserverOperationModeReadOnly	唯讀模式。
AliRtcAudioDataObserverOperationModeWriteOnly	唯寫模式。
AliRtcAudioDataObserverOperationModeReadWrite	讀寫入模式。

AliRtcAudioFrameObserverUserDefinedInfoBitMask

音頻資料回調自訂參數。

枚舉名	描述
AliRtcAudioFrameObserverUserDefinedInfoBitMaskMixExCapture	onMixedAllAudioFrame回調混外部推流的音頻。
AliRtcAudioFrameObserverUserDefinedInfoBitMaskMixExRender	onMixedAllAudioFrame回調混外部渲染的音頻。

AliRtcOrientationMode

裝置方向枚舉。

枚舉名	描述
AliRtcOrientationModePortrait	固定豎屏模式
AliRtcOrientationModeLandscapeLeft	固定左橫屏模式
AliRtcOrientationModePortraitUpsideDown	固定倒立模式
AliRtcOrientationModeLandscapeRight	固定右橫屏模式
AliRtcOrientationModeAuto	自適應模式

AliRtcAudioAccompanyErrorCode

音樂伴奏播放錯誤碼。

枚舉值	描述
AliRtcAudioAccompanyNoError(0)	沒有錯誤，正常播放。
AliRtcAudioAccompanyOpenFailed(-100)	開啟音頻檔案失敗（如路徑無效、許可權不足、檔案損壞）。
AliRtcAudioAccompanyDecodeFailed(-101)	解碼音頻檔案失敗（如格式不支援、編碼錯誤）。

AliRtcAudioAccompanyConfig

伴奏播放的配置項

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

AliRtcExternalAudioStreamConfig

外部音頻流配置。

參數名	類型	描述
channels	int	聲道數，預設值：1。
sampleRate	int	採樣率，預設值：48000，支援的採樣率 8000, 12000, 16000, 24000, 32000, 44100, 48000, 96000。
playoutVolume	int	播放音量，取值範圍[0-100]，預設值：50。
publishVolume	int	推流音量，取值範圍[0-100]，預設值：50。
publishStream	int	指定綁定的音頻流。 0：MIC流。 1：第二音頻流。
enable3A	boolean	輸入PCM 音頻是否做3A處理，預設為 false。

AliRtcDataChannelMsg

資料通道訊息。

參數名	類型	描述
type	AliRtcDataMsgType	資料通道訊息的類型，使用時建議設定為AliEngineDataMsgCustom。
networkTime	long	發送訊息時ntp時間，僅AliEngineDataMsgMusicProgress 時使用，僅在 KTV 情境使用，其他情境不需要設定。
progress	int	當天進度，單位毫秒，僅AliEngineDataMsgMusicProgress 時使用，僅在 KTV 情境使用，其他情境不需要設定。
data	byte[]	訊息內容，可以是任意資料，包括文字、圖片等。

AliRtcDataMsgType

資料通道訊息類型。

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

AliRtcVideoExternalEncoderParameter

網路變化反饋參數結構體。

參數	類型	描述
width	int	寬度
height	int	高度
frame_rate	int	幀率
bitrate_bps	int	碼率（單位：bps)。

AliRtcVideoEncodedFrameType

Qos反饋外置編碼器請求框架類型。

枚舉名	描述
AliRtcVideoEncodedFrameNULL(0)	無。
AliRtcVideoEncodedFrameIDR(1)	IDR 幀。
AliRtcVideoEncodedFrameLTR(2)	LTR 幀。
AliRtcVideoEncodedFrameB(3)	B 幀。

AliRtcAudioAccompanyStateCode

音樂伴奏播放狀態。

枚舉名	描述
AliRtcAudioAccompanyStarted（100）	伴奏開始播放。
AliRtcAudioAccompanyStopped (101)	伴奏停止播放。
AliRtcAudioAccompanyPaused(102)	伴奏暫停。
AliRtcAudioAccompanyResumed(103)	伴奏從暫停狀態恢複播放。
AliRtcAudioAccompanyEnded(104)	伴奏播放完畢（正常結束）。
AliRtcAudioAccompanyBuffering(105)	伴奏正在緩衝（適用於網路流或大檔案）。
AliRtcAudioAccompanyBufferingEnd(106)	緩衝結束，進入正常播放。
AliRtcAudioAccompanyFailed(107)	伴奏播放失敗（需結合 errorCode 判斷具體原因）。

AliRtcAudioFileInfo

音頻檔案資訊。

參數	類型	描述
filePath	String	音頻檔案路徑.
durationMs	long	音頻檔案時間長度，單位：ms。

AliRtcEngineLocalDeviceType

本地裝置類型。

枚舉名	描述
AliEngineLocalDeviceTypeUnknown	未知裝置類型。
AliEngineLocalDeviceTypeMic	麥克風裝置。
AliEngineLocalDeviceTypeSpeaker	擴音器裝置。
AliEngineLocalDeviceTypeAudioDevice	音訊裝置。
AliEngineLocalDeviceTypeCamera	網路攝影機裝置。
AliEngineLocalDeviceTypeDisplay	顯示裝置。
AliEngineLocalDeviceTypeVideoDevice	視頻裝置。

AliRtcAudioEffectBeautifyMode

美聲模式類型枚舉。

枚舉值	描述
AliRtcSdk_AudioEffect_Beautify_Off	關閉美聲音效。
AliRtcSdk_AudioEffect_Beautify_Magnetic	磁性。
AliRtcSdk_AudioEffect_Beautify_Fresh	清新。
AliRtcSdk_AudioEffect_Beautify_Mode_Max	預留位置，表示最大值，不可用於實際設定。

AliRtcAudioEffectEqualizationBandFrequency

混響參數類型枚舉。

枚舉常量	描述
AliRtcSdk_AudioEffect_EqualizationBand31	31 Hz
AliRtcSdk_AudioEffect_EqualizationBand62	62 Hz
AliRtcSdk_AudioEffect_EqualizationBand125	125 Hz
AliRtcSdk_AudioEffect_EqualizationBand250	250 Hz
AliRtcSdk_AudioEffect_EqualizationBand500	500 Hz
AliRtcSdk_AudioEffect_EqualizationBand1K	1 kHz
AliRtcSdk_AudioEffect_EqualizationBand2K	2 kHz
AliRtcSdk_AudioEffect_EqualizationBand4K	4 kHz
AliRtcSdk_AudioEffect_EqualizationBand8K	8 kHz
AliRtcSdk_AudioEffect_EqualizationBand16K	16 kHz

目錄