Android API 参考

构建时从公开 SDK 接口定义生成：接口、方法重载、属性、事件、枚举与错误码。

由公开 SDK 接口定义生成

版本 v1.1.0 · 更新于 2026-10-26 · 修订 1

接口概览

本页列出 Android 端公开 API 的类、方法、重载、属性、事件与错误码，接口定义与 SDK 包版本一致。

核对项	数量
接口 / 类	143
方法	654
方法重载	709
属性	631
枚举	52
错误码常量	6

可用性

该端 SDK：正式可用。接口定义与 SDK 包版本一致；运行时的能力边界以实际发布的 SDK 包为准。

加入频道核心链路

按 join / leave / publish / subscribe 的典型调用顺序整理；参数表在“最小可运行链路”一节展开。

步骤	接口	方法	重载数
创建 / 初始化	`IAgoraMusicContentCenter`	`initialize`	1
续期 Token	`IAgoraMusicContentCenter`	`renewToken`	1
订阅远端媒体	`IBaseSpatialAudioEngine`	`muteRemoteAudioStream`	1
开启视频与预览	`RtcEngine`	`enableVideo`	1
加入频道	`RtcEngine`	`joinChannel`	2
离开频道	`RtcEngine`	`leaveChannel`	2
频道场景	`RtcEngine`	`setChannelProfile`	1
角色切换	`RtcEngine`	`setClientRole`	2
本地画面	`RtcEngine`	`setupLocalVideo`	1

最小可运行链路的参数

参数	类型	可选	可变参数
`configuration`	`MusicContentCenterConfiguration`	否	否
`token`	`String`	否	否
`uid`	`int`	否	否
`mute`	`boolean`	否	否
`token`	`String`	否	否
`channelId`	`String`	否	否
`optionalInfo`	`String`	否	否
`uid`	`int`	否	否
`token`	`String`	否	否
`channelId`	`String`	否	否
`uid`	`int`	否	否
`options`	`ChannelMediaOptions`	否	否
`options`	`LeaveChannelOptions`	否	否
`profile`	`int`	否	否
`role`	`int`	否	否
`role`	`int`	否	否
`options`	`ClientRoleOptions`	否	否
`local`	`VideoCanvas`	否	否

接口索引

接口	方法	属性
`AdvancedAudioOptions`	0	1
`AdvancedConfigInfo`	0	1
`AdvanceOptions`	0	3
`AgoraFacePositionInfo`	0	5
`AgoraFocalLengthInfo`	0	2
`AgoraImage`	0	7
`AgoraMediaRecorder`	3	0
`AgoraMetadata`	0	4
`AgoraRhythmPlayerConfig`	0	2
`AgoraVideoFrame`	0	16
`AreaCode`	0	9
`AsyncCallback`	1	0
`AudioCaptureParameters`	0	4
`AudioEncodedFrameObserverConfig`	0	2
`AudioFrame`	0	6
`AudioParams`	0	4
`AudioRecordingConfiguration`	0	6
`AudioSpectrumInfo`	0	2
`AudioTrackConfig`	0	2
`AudioVolumeInfo`	0	4
`BeautyOptions`	0	8
`CacheStatistics`	0	3
`CameraCapturerConfiguration`	0	5
`Canvas`	5	0
`CanvasConfig`	4	0
`CaptureFormat`	0	3
`ChannelMediaInfo`	0	3
`ChannelMediaOptions`	0	35
`ChannelMediaRelayConfiguration`	3	2
`ClientRoleOptions`	0	1
`ClimaxSegment`	0	2
`CodecCapInfo`	0	3
`CodecCapLevels`	0	2
`ColorEnhanceOptions`	0	2
`Config`	4	0
`ContentInspectConfig`	0	9
`ContentInspectModule`	0	3
`DataStreamConfig`	0	2
`DeviceInfo`	0	1
`EchoTestConfiguration`	0	6
`EncodedVideoFrameInfo`	0	10
`EncryptionConfig`	0	4
`Error`	2	0
`ExtensionContext`	0	4
`FaceShapeAreaOptions`	0	13
`FaceShapeBeautyOptions`	0	5
`FilterEffectOptions`	0	2
`IAgoraMusicContentCenter`	17	0
`IAgoraMusicPlayer`	5	0
`IAudioEncodedFrameObserver`	3	0
`IAudioFrameObserver`	10	0
`IAudioSpectrumObserver`	2	0
`IBaseSpatialAudioEngine`	11	0
`ILocalSpatialAudioEngine`	6	0
`ImageTrackOptions`	0	3
`IMediaPlayer`	41	0
`IMediaPlayerAudioFrameObserver`	1	0
`IMediaPlayerCacheManager`	12	0
`IMediaPlayerCustomDataProvider`	2	0
`IMediaPlayerObserver`	11	0
`IMediaPlayerVideoFrameObserver`	1	0
`IMediaRecorderCallback`	2	0
`IMetadataObserver`	3	0
`IMusicContentCenterEventHandler`	5	0
`IRtcEngineEventHandler`	84	0
`IRtcEngineReleaseCallback`	1	0
`IVideoEffectObject`	10	0
`IVideoEncodedFrameObserver`	1	0
`IVideoFrameObserver`	8	0
`LastmileProbeConfig`	0	4
`LastmileProbeOneWayResult`	0	3
`LastmileProbeResult`	0	4
`LeaveChannelOptions`	0	3
`LiveTranscoding`	21	15
`LocalAccessPointConfiguration`	0	6
`LocalAudioMixerConfiguration`	0	2
`LocalAudioStats`	0	9
`LocalSpatialAudioConfig`	0	1
`LocalTranscoderConfiguration`	0	3
`LocalVideoStats`	0	23
`LogConfig`	0	3
`LogUploadServerInfo`	0	4
`LowLightEnhanceOptions`	0	6
`MediaPlayerSource`	0	9
`MediaRecorderConfiguration`	0	11
`MediaStreamInfo`	0	13
`MixedAudioStream`	0	4
`MultipathStats`	0	8
`Music`	0	11
`MusicCacheInfo`	0	2
`MusicCacheStatusType`	0	2
`MusicChartInfo`	0	2
`MusicContentCenterConfiguration`	0	5
`MusicContentCenterStateReason`	0	8
`PathStats`	0	3
`Player`	18	0
`PlayerConfig`	12	0
`PlayerGetStatsCallback`	1	0
`PlayerInfo`	14	0
`PlayerObserver`	7	0
`PlayerPlaybackStats`	0	4
`PlayerStats`	0	0
`PlayerUpdatedInfo`	0	6
`PreloadState`	0	4
`RecorderInfo`	0	3
`RecorderStreamInfo`	0	3
`Rectangle`	0	4
`RemoteAudioStats`	0	19
`RemoteVideoStats`	0	18
`RemoteVoicePositionInfo`	0	2
`RtcConnection`	0	2
`RtcEngine`	256	0
`RtcEngineConfig`	0	14
`RtcEngineEx`	48	0
`RtcStats`	0	24
`Rte`	6	0
`RteException`	1	1
`ScreenCaptureParameters`	0	4
`SegmentationProperty`	0	8
`SimulcastStreamConfig`	0	3
`SnapshotConfig`	0	2
`SpatialAudioParams`	0	8
`SpatialAudioZone`	0	9
`SrcInfo`	0	2
`TranscodingUser`	0	8
`TranscodingVideoStream`	0	11
`UplinkNetworkInfo`	0	1
`UserAudioSpectrumInfo`	0	2
`UserInfo`	0	2
`VideoCanvas`	0	19
`VideoCaptureParameters`	0	5
`VideoDenoiserOptions`	0	6
`VideoDimensions`	0	2
`VideoEncoderConfiguration`	0	10
`VideoFrame`	0	6
`VideoLayout`	0	8
`VideoLayoutInfo`	0	4
`VideoRenderingTracingInfo`	0	7
`VideoSubscriptionOptions`	0	2
`VirtualBackgroundSource`	0	4
`WatermarkBuffer`	5	8
`WatermarkConfig`	3	7
`WatermarkOptions`	4	4

全部接口

AdvancedAudioOptions 0 方法 / 1 属性

属性	类型	只读
`audioProcessingChannels`	`AudioProcessingChannelsEnum`	否

AdvancedConfigInfo 0 方法 / 1 属性

属性	类型	只读
`logUploadServer`	`LogUploadServerInfo`	否

AdvanceOptions 0 方法 / 3 属性

属性	类型	只读
`encodingPreference`	`ENCODING_PREFERENCE`	否
`compressionPreference`	`COMPRESSION_PREFERENCE`	否
`encodeAlpha`	`boolean`	否

AgoraFacePositionInfo 0 方法 / 5 属性

属性	类型	只读
`x`	`int`	否
`y`	`int`	否
`width`	`int`	否
`height`	`int`	否
`distance`	`int`	否

AgoraFocalLengthInfo 0 方法 / 2 属性

属性	类型	只读
`cameraDirection`	`int`	否
`focalLengthType`	`int`	否

AgoraImage 0 方法 / 7 属性

属性	类型	只读
`url`	`String`	否
`x`	`int`	否
`y`	`int`	否
`width`	`int`	否
`height`	`int`	否
`zOrder`	`int`	否
`alpha`	`double`	否

AgoraMediaRecorder 3 方法 / 0 属性

typescript

setMediaRecorderObserver(callback: IMediaRecorderCallback): int
startRecording(config: MediaRecorderConfiguration): int
stopRecording(): int

方法明细：3 / 3（参数、返回值、错误码）

方法	参数	返回值	错误
`setMediaRecorderObserver`	`callback: IMediaRecorderCallback`	`int`	错误码索引
`startRecording`	`config: MediaRecorderConfiguration`	`int`	错误码索引
`stopRecording`	—	`int`	错误码索引

AgoraMetadata 0 方法 / 4 属性

属性	类型	只读
`channelId`	`String`	否
`uid`	`int`	否
`data`	`byte[]`	否
`timeStampMs`	`long`	否

AgoraRhythmPlayerConfig 0 方法 / 2 属性

属性	类型	只读
`beatsPerMeasure`	`int`	否
`beatsPerMinute`	`int`	否

AgoraVideoFrame 0 方法 / 16 属性

属性	类型	只读
`format`	`int`	否
`timeStamp`	`long`	否
`stride`	`int`	否
`height`	`int`	否
`textureID`	`int`	否
`syncMode`	`boolean`	否
`transform`	`float[]`	否
`eglContext10`	`javax.microedition.khronos.egl.EGLContext`	否
`eglContext14`	`android.opengl.EGLContext`	否
`buf`	`byte[]`	否
`cropLeft`	`int`	否
`cropTop`	`int`	否
`cropRight`	`int`	否
`cropBottom`	`int`	否
`rotation`	`int`	否
`alphaStitchMode`	`AlphaStitchMode`	否

AreaCode 0 方法 / 9 属性

属性	类型	只读
`AREA_CODE_NONE`	`int`	否
`AREA_CODE_CN`	`int`	否
`AREA_CODE_NA`	`int`	否
`AREA_CODE_EU`	`int`	否
`AREA_CODE_AS`	`int`	否
`AREA_CODE_JP`	`int`	否
`AREA_CODE_IN`	`int`	否
`AREA_CODE_RU`	`int`	否
`AREA_CODE_GLOB`	`int`	否

AsyncCallback 1 方法 / 0 属性

typescript

onResult(error: Error): void

方法明细：1 / 1（参数、返回值、错误码）

方法	参数	返回值	错误
`onResult`	`error: Error`	`void`	错误码索引

AudioCaptureParameters 0 方法 / 4 属性

属性	类型	只读
`sampleRate`	`int`	否
`channels`	`int`	否
`captureSignalVolume`	`int`	否
`allowCaptureCurrentApp`	`boolean`	否

AudioEncodedFrameObserverConfig 0 方法 / 2 属性

属性	类型	只读
`postionType`	`int`	否
`encodingType`	`int`	否

AudioFrame 0 方法 / 6 属性

属性	类型	只读
`buffer`	`ByteBuffer`	否
`sampleRataHz`	`int`	否
`bytesPerSample`	`int`	否
`channelNums`	`int`	否
`samplesPerChannel`	`int`	否
`timestamp`	`long`	否

AudioParams 0 方法 / 4 属性

属性	类型	只读
`sampleRate`	`int`	否
`channel`	`int`	否
`mode`	`int`	否
`samplesPerCall`	`int`	否

AudioRecordingConfiguration 0 方法 / 6 属性

属性	类型	只读
`filePath`	`String`	否
`sampleRate`	`int`	否
`codec`	`boolean`	否
`fileRecordOption`	`int`	否
`quality`	`int`	否
`recordingChannel`	`int`	否

AudioSpectrumInfo 0 方法 / 2 属性

属性	类型	只读
`audioSpectrumData`	`float[]`	否
`dataLength`	`int`	否

AudioTrackConfig 0 方法 / 2 属性

属性	类型	只读
`enableLocalPlayback`	`boolean`	否
`enableAudioProcessing`	`boolean`	否

AudioVolumeInfo 0 方法 / 4 属性

属性	类型	只读
`uid`	`int`	否
`volume`	`int`	否
`vad`	`int`	否
`voicePitch`	`double`	否

BeautyOptions 0 方法 / 8 属性

属性	类型	只读
`LIGHTENING_CONTRAST_LOW`	`int`	否
`LIGHTENING_CONTRAST_NORMAL`	`int`	否
`LIGHTENING_CONTRAST_HIGH`	`int`	否
`lighteningContrastLevel`	`int`	否
`lighteningLevel`	`float`	否
`smoothnessLevel`	`float`	否
`rednessLevel`	`float`	否
`sharpnessLevel`	`float`	否

CacheStatistics 0 方法 / 3 属性

属性	类型	只读
`fileSize`	`long`	否
`cacheSize`	`long`	否
`downloadSize`	`long`	否

CameraCapturerConfiguration 0 方法 / 5 属性

属性	类型	只读
`cameraDirection`	`CAMERA_DIRECTION`	否
`cameraId`	`String`	否
`cameraFocalLengthType`	`CAMERA_FOCAL_LENGTH_TYPE`	否
`captureFormat`	`CaptureFormat`	否
`followEncodeDimensionRatio`	`Boolean`	否

Canvas 5 方法 / 0 属性

typescript

Canvas(rte: Rte, config: CanvasInitialConfig): unknown
addView(view: View, viewConfig: ViewConfig): void
getConfigs(config: CanvasConfig): void
removeView(view: View, viewConfig: ViewConfig): void
setConfigs(config: CanvasConfig): void

方法明细：5 / 5（参数、返回值、错误码）

方法	参数	返回值	错误
`Canvas`	`rte: Rte, config: CanvasInitialConfig`	`unknown`	错误码索引
`addView`	`view: View, viewConfig: ViewConfig`	`void`	错误码索引
`getConfigs`	`config: CanvasConfig`	`void`	错误码索引
`removeView`	`view: View, viewConfig: ViewConfig`	`void`	错误码索引
`setConfigs`	`config: CanvasConfig`	`void`	错误码索引

CanvasConfig 4 方法 / 0 属性

typescript

getVideoMirrorMode(): Constants.VideoMirrorMode
getVideoRenderMode(): Constants.VideoRenderMode
setVideoMirrorMode(mode: Constants.VideoMirrorMode): void
setVideoRenderMode(mode: Constants.VideoRenderMode): void

方法明细：4 / 4（参数、返回值、错误码）

方法	参数	返回值	错误
`getVideoMirrorMode`	—	`Constants.VideoMirrorMode`	错误码索引
`getVideoRenderMode`	—	`Constants.VideoRenderMode`	错误码索引
`setVideoMirrorMode`	`mode: Constants.VideoMirrorMode`	`void`	错误码索引
`setVideoRenderMode`	`mode: Constants.VideoRenderMode`	`void`	错误码索引

CaptureFormat 0 方法 / 3 属性

属性	类型	只读
`width`	`int`	否
`height`	`int`	否
`fps`	`int`	否

ChannelMediaInfo 0 方法 / 3 属性

属性	类型	只读
`channelName`	`String`	否
`token`	`String`	否
`uid`	`int`	否

ChannelMediaOptions 0 方法 / 35 属性

属性	类型	只读
`publishCameraTrack`	`Boolean`	否
`publishSecondaryCameraTrack`	`Boolean`	否
`publishThirdCameraTrack`	`Boolean`	否
`publishFourthCameraTrack`	`Boolean`	否
`publishMicrophoneTrack`	`Boolean`	否
`publishScreenCaptureVideo`	`Boolean`	否
`publishScreenCaptureAudio`	`Boolean`	否
`publishCustomAudioTrack`	`Boolean`	否
`publishCustomAudioTrackId`	`Integer`	否
`publishCustomVideoTrack`	`Boolean`	否
`publishEncodedVideoTrack`	`Boolean`	否
`publishMediaPlayerAudioTrack`	`Boolean`	否
`publishMediaPlayerVideoTrack`	`Boolean`	否
`publishTranscodedVideoTrack`	`Boolean`	否
`publishMixedAudioTrack`	`Boolean`	否
`publishLipSyncTrack`	`Boolean`	否
`autoSubscribeAudio`	`Boolean`	否
`autoSubscribeVideo`	`Boolean`	否
`enableAudioRecordingOrPlayout`	`Boolean`	否
`publishMediaPlayerId`	`Integer`	否
`clientRoleType`	`Integer`	否
`audienceLatencyLevel`	`Integer`	否
`defaultVideoStreamType`	`Integer`	否
`channelProfile`	`Integer`	否
`audioDelayMs`	`Integer`	否
`mediaPlayerAudioDelayMs`	`Integer`	否
`token`	`String`	否
`enableBuiltInMediaEncryption`	`Boolean`	否
`publishRhythmPlayerTrack`	`Boolean`	否
`isInteractiveAudience`	`Boolean`	否
`customVideoTrackId`	`Integer`	否
`isAudioFilterable`	`Boolean`	否
`startPreview`	`Boolean`	否
`enableMultipath`	`Boolean`	否
`preferMultipathType`	`Integer`	否

ChannelMediaRelayConfiguration 3 方法 / 2 属性

typescript

removeDestChannelInfo(channelName: String): void
setDestChannelInfo(channelName: String, destInfo: ChannelMediaInfo): void
setSrcChannelInfo(srcInfo: ChannelMediaInfo): void

方法明细：3 / 3（参数、返回值、错误码）

方法	参数	返回值	错误
`removeDestChannelInfo`	`channelName: String`	`void`	错误码索引
`setDestChannelInfo`	`channelName: String, destInfo: ChannelMediaInfo`	`void`	错误码索引
`setSrcChannelInfo`	`srcInfo: ChannelMediaInfo`	`void`	错误码索引

属性	类型	只读
`srcInfo`	`ChannelMediaInfo`	否
`destInfos`	`Map`	否

ClientRoleOptions 0 方法 / 1 属性

属性	类型	只读
`audienceLatencyLevel`	`int`	否

ClimaxSegment 0 方法 / 2 属性

属性	类型	只读
`startTimeMs`	`int`	否
`endTimeMs`	`int`	否

CodecCapInfo 0 方法 / 3 属性

属性	类型	只读
`codecType`	`int`	否
`codecCapMask`	`int`	否
`codecLevels`	`CodecCapLevels`	否

CodecCapLevels 0 方法 / 2 属性

属性	类型	只读
`hwDecodingLevel`	`int`	否
`swDecodingLevel`	`int`	否

ColorEnhanceOptions 0 方法 / 2 属性

属性	类型	只读
`strengthLevel`	`float`	否
`skinProtectLevel`	`float`	否

Config 4 方法 / 0 属性

typescript

getAppId(): String
getJsonParameter(): String
setAppId(appId: String): void
setJsonParameter(jsonParameter: String): void

方法明细：4 / 4（参数、返回值、错误码）

方法	参数	返回值	错误
`getAppId`	—	`String`	错误码索引
`getJsonParameter`	—	`String`	错误码索引
`setAppId`	`appId: String`	`void`	错误码索引
`setJsonParameter`	`jsonParameter: String`	`void`	错误码索引

ContentInspectConfig 0 方法 / 9 属性

属性	类型	只读
`CONTENT_INSPECT_TYPE_INVALID`	`int`	否
`CONTENT_INSPECT_TYPE_MODERATION`	`unknown`	否
`CONTENT_INSPECT_TYPE_SUPERVISE`	`int`	否
`CONTENT_INSPECT_TYPE_IMAGE_MODERATION`	`int`	否
`MAX_CONTENT_INSPECT_MODULE_COUNT`	`int`	否
`extraInfo`	`String`	否
`serverConfig`	`String`	否
`modules`	`ContentInspectModule[]`	否
`moduleCount`	`int`	否

ContentInspectModule 0 方法 / 3 属性

属性	类型	只读
`type`	`int`	否
`interval`	`int`	否
`position`	`Constants.VideoModulePosition`	否

DataStreamConfig 0 方法 / 2 属性

属性	类型	只读
`syncWithAudio`	`boolean`	否
`ordered`	`boolean`	否

DeviceInfo 0 方法 / 1 属性

属性	类型	只读
`isLowLatencyAudioSupported`	`boolean`	否

EchoTestConfiguration 0 方法 / 6 属性

属性	类型	只读
`view`	`SurfaceView`	否
`enableAudio`	`boolean`	否
`enableVideo`	`boolean`	否
`token`	`String`	否
`channelId`	`String`	否
`intervalInSeconds`	`int`	否

EncodedVideoFrameInfo 0 方法 / 10 属性

属性	类型	只读
`codecType`	`int`	否
`width`	`int`	否
`height`	`int`	否
`framesPerSecond`	`int`	否
`frameType`	`int`	否
`rotation`	`int`	否
`trackId`	`int`	否
`captureTimeMs`	`long`	否
`decodeTimeMs`	`long`	否
`streamType`	`int`	否

EncryptionConfig 0 方法 / 4 属性

属性	类型	只读
`encryptionMode`	`EncryptionMode`	否
`encryptionKey`	`String`	否
`encryptionKdfSalt`	`byte[]`	否
`datastreamEncryptionEnabled`	`boolean`	否

Error 2 方法 / 0 属性

typescript

code(): Constants.ErrorCode
message(): String

方法明细：2 / 2（参数、返回值、错误码）

方法	参数	返回值	错误
`code`	—	`Constants.ErrorCode`	错误码索引
`message`	—	`String`	错误码索引

ExtensionContext 0 方法 / 4 属性

属性	类型	只读
`isValid`	`boolean`	否
`uid`	`int`	否
`providerName`	`String`	否
`extensionName`	`String`	否

FaceShapeAreaOptions 0 方法 / 13 属性

属性	类型	只读
`shapeArea`	`int`	否
`shapeIntensity`	`int`	否
`FACE_SHAPE_AREA_HEADSCALE`	`int`	否
`FACE_SHAPE_AREA_FACELENGTH`	`int`	否
`FACE_SHAPE_AREA_FACESMALL`	`int`	否
`FACE_SHAPE_AREA_EYESCALE`	`int`	否
`FACE_SHAPE_AREA_NOSEWING`	`int`	否
`FACE_SHAPE_AREA_NOSEBRIDGE`	`int`	否
`FACE_SHAPE_AREA_NOSETIP`	`int`	否
`FACE_SHAPE_AREA_NOSEGENERAL`	`int`	否
`FACE_SHAPE_AREA_MOUTHSCALE`	`int`	否
`FACE_SHAPE_AREA_MOUTHSMILE`	`int`	否
`FACE_SHAPE_AREA_EYEANGLE`	`int`	否

FaceShapeBeautyOptions 0 方法 / 5 属性

属性	类型	只读
`FACE_SHAPE_BEAUTY_STYLE_FEMALE`	`int`	否
`FACE_SHAPE_BEAUTY_STYLE_MALE`	`int`	否
`FACE_SHAPE_BEAUTY_STYLE_NATURAL`	`int`	否
`shapeStyle`	`int`	否
`styleIntensity`	`int`	否

FilterEffectOptions 0 方法 / 2 属性

属性	类型	只读
`path`	`String`	否
`strength`	`float`	否

IAgoraMusicContentCenter 17 方法 / 0 属性

typescript

createMusicPlayer(): IAgoraMusicPlayer
destroy(): void
destroyMusicPlayer(player: IAgoraMusicPlayer): int
getCaches(): MusicCacheInfo[]
getInternalSongCode(songCode: long, jsonOption: String): long
getLyric(songCode: long, lyricType: int): String
getMusicCharts(): String
getMusicCollectionByMusicChartId(musicChartId: int, page: int, pageSize: int): String
getMusicCollectionByMusicChartId(musicChartId: int, page: int, pageSize: int, jsonOption: String): String
getSongSimpleInfo(songCode: long): String
initialize(configuration: MusicContentCenterConfiguration): int
isPreloaded(songCode: long): int
preload(songCode: long, jsonOption: String): int
preload(songCode: long): String
registerEventHandler(eventHandler: IMusicContentCenterEventHandler): int
removeCache(songCode: long): int
renewToken(token: String): int
searchMusic(keyword: String, page: int, pageSize: int): String
searchMusic(keyword: String, page: int, pageSize: int, jsonOption: String): String
unregisterEventHandler(): int

方法明细：17 / 17（参数、返回值、错误码）

方法	参数	返回值	错误
`createMusicPlayer`	—	`IAgoraMusicPlayer`	错误码索引
`destroy`	—	`void`	错误码索引
`destroyMusicPlayer`	`player: IAgoraMusicPlayer`	`int`	错误码索引
`getCaches`	—	`MusicCacheInfo[]`	错误码索引
`getInternalSongCode`	`songCode: long, jsonOption: String`	`long`	错误码索引
`getLyric`	`songCode: long, lyricType: int`	`String`	错误码索引
`getMusicCharts`	—	`String`	错误码索引
`getMusicCollectionByMusicChartId`	`musicChartId: int, page: int, pageSize: int`	`String`	错误码索引
`getSongSimpleInfo`	`songCode: long`	`String`	错误码索引
`initialize`	`configuration: MusicContentCenterConfiguration`	`int`	错误码索引
`isPreloaded`	`songCode: long`	`int`	错误码索引
`preload`	`songCode: long, jsonOption: String`	`int`	错误码索引
`registerEventHandler`	`eventHandler: IMusicContentCenterEventHandler`	`int`	错误码索引
`removeCache`	`songCode: long`	`int`	错误码索引
`renewToken`	`token: String`	`int`	错误码索引
`searchMusic`	`keyword: String, page: int, pageSize: int`	`String`	错误码索引
`unregisterEventHandler`	—	`int`	错误码索引

IAgoraMusicPlayer 5 方法 / 0 属性

typescript

destroy(): int
getPlaySrc(): String
open(songCode: long, startPos: long): int
open(url: String, startPos: long): int
setPlayMode(mode: MusicPlayMode): int
stop(): int

方法明细：5 / 5（参数、返回值、错误码）

方法	参数	返回值	错误
`destroy`	—	`int`	错误码索引
`getPlaySrc`	—	`String`	错误码索引
`open`	`songCode: long, startPos: long`	`int`	错误码索引
`setPlayMode`	`mode: MusicPlayMode`	`int`	错误码索引
`stop`	—	`int`	错误码索引

IAudioEncodedFrameObserver 3 方法 / 0 属性

typescript

onMixedAudioEncodedFrame(buffer: ByteBuffer, samplesPerChannel: int, channels: int, samplesPerSec: int, codecType: int): void
onPlaybackAudioEncodedFrame(buffer: ByteBuffer, samplesPerChannel: int, channels: int, samplesPerSec: int, codecType: int): void
onRecordAudioEncodedFrame(buffer: ByteBuffer, samplesPerChannel: int, channels: int, samplesPerSec: int, codecType: int): void

方法明细：3 / 3（参数、返回值、错误码）

方法	参数	返回值	错误
`onMixedAudioEncodedFrame`	`buffer: ByteBuffer, samplesPerChannel: int, channels: int, samplesPerSec: int, codecType: int`	`void`	错误码索引
`onPlaybackAudioEncodedFrame`	`buffer: ByteBuffer, samplesPerChannel: int, channels: int, samplesPerSec: int, codecType: int`	`void`	错误码索引
`onRecordAudioEncodedFrame`	`buffer: ByteBuffer, samplesPerChannel: int, channels: int, samplesPerSec: int, codecType: int`	`void`	错误码索引

IAudioFrameObserver 10 方法 / 0 属性

typescript

getEarMonitoringAudioParams(): AudioParams
getMixedAudioParams(): AudioParams
getObservedAudioFramePosition(): int
getPlaybackAudioParams(): AudioParams
getRecordAudioParams(): AudioParams
onEarMonitoringAudioFrame(type: int, samplesPerChannel: int, bytesPerSample: int, channels: int, samplesPerSec: int, buffer: ByteBuffer, renderTimeMs: long, avsync_type: int): boolean
onMixedAudioFrame(channelId: String, type: int, samplesPerChannel: int, bytesPerSample: int, channels: int, samplesPerSec: int, buffer: ByteBuffer, renderTimeMs: long, avsync_type: int): boolean
onPlaybackAudioFrame(channelId: String, type: int, samplesPerChannel: int, bytesPerSample: int, channels: int, samplesPerSec: int, buffer: ByteBuffer, renderTimeMs: long, avsync_type: int): boolean
onPlaybackAudioFrameBeforeMixing(channelId: String, uid: int, type: int, samplesPerChannel: int, bytesPerSample: int, channels: int, samplesPerSec: int, buffer: ByteBuffer, renderTimeMs: long, avsync_type: int, rtpTimestamp: int, presentationMs: long): boolean
onRecordAudioFrame(channelId: String, type: int, samplesPerChannel: int, bytesPerSample: int, channels: int, samplesPerSec: int, buffer: ByteBuffer, renderTimeMs: long, avsync_type: int): boolean

方法明细：10 / 10（参数、返回值、错误码）

方法	参数	返回值	错误
`getEarMonitoringAudioParams`	—	`AudioParams`	错误码索引
`getMixedAudioParams`	—	`AudioParams`	错误码索引
`getObservedAudioFramePosition`	—	`int`	错误码索引
`getPlaybackAudioParams`	—	`AudioParams`	错误码索引
`getRecordAudioParams`	—	`AudioParams`	错误码索引
`onEarMonitoringAudioFrame`	`type: int, samplesPerChannel: int, bytesPerSample: int, channels: int, samplesPerSec: int, buffer: ByteBuffer, renderTimeMs: long, avsync_type: int`	`boolean`	错误码索引
`onMixedAudioFrame`	`channelId: String, type: int, samplesPerChannel: int, bytesPerSample: int, channels: int, samplesPerSec: int, buffer: ByteBuffer, renderTimeMs: long, avsync_type: int`	`boolean`	错误码索引
`onPlaybackAudioFrame`	`channelId: String, type: int, samplesPerChannel: int, bytesPerSample: int, channels: int, samplesPerSec: int, buffer: ByteBuffer, renderTimeMs: long, avsync_type: int`	`boolean`	错误码索引
`onPlaybackAudioFrameBeforeMixing`	`channelId: String, uid: int, type: int, samplesPerChannel: int, bytesPerSample: int, channels: int, samplesPerSec: int, buffer: ByteBuffer, renderTimeMs: long, avsync_type: int, rtpTimestamp: int, presentationMs: long`	`boolean`	错误码索引
`onRecordAudioFrame`	`channelId: String, type: int, samplesPerChannel: int, bytesPerSample: int, channels: int, samplesPerSec: int, buffer: ByteBuffer, renderTimeMs: long, avsync_type: int`	`boolean`	错误码索引

IAudioSpectrumObserver 2 方法 / 0 属性

typescript

onLocalAudioSpectrum(data: AudioSpectrumInfo): boolean
onRemoteAudioSpectrum(userAudioSpectrumInfos: UserAudioSpectrumInfo[], spectrumNumber: int): boolean

方法明细：2 / 2（参数、返回值、错误码）

方法	参数	返回值	错误
`onLocalAudioSpectrum`	`data: AudioSpectrumInfo`	`boolean`	错误码索引
`onRemoteAudioSpectrum`	`userAudioSpectrumInfos: UserAudioSpectrumInfo[], spectrumNumber: int`	`boolean`	错误码索引

IBaseSpatialAudioEngine 11 方法 / 0 属性

typescript

clearRemotePositions(): int
muteAllRemoteAudioStreams(mute: boolean): int
muteLocalAudioStream(mute: boolean): int
muteRemoteAudioStream(uid: int, mute: boolean): int
setAudioRecvRange(range: float): int
setDistanceUnit(unit: float): int
setMaxAudioRecvCount(maxCount: int): int
setPlayerAttenuation(playerId: int, attenuation: double, forceSet: boolean): int
setZones(zones: SpatialAudioZone[]): int
updatePlayerPositionInfo(playerId: int, positionInfo: RemoteVoicePositionInfo): int
updateSelfPosition(position: float[], axisForward: float[], axisRight: float[], axisUp: float[]): int

方法明细：11 / 11（参数、返回值、错误码）

方法	参数	返回值	错误
`clearRemotePositions`	—	`int`	错误码索引
`muteAllRemoteAudioStreams`	`mute: boolean`	`int`	错误码索引
`muteLocalAudioStream`	`mute: boolean`	`int`	错误码索引
`muteRemoteAudioStream`	`uid: int, mute: boolean`	`int`	错误码索引
`setAudioRecvRange`	`range: float`	`int`	错误码索引
`setDistanceUnit`	`unit: float`	`int`	错误码索引
`setMaxAudioRecvCount`	`maxCount: int`	`int`	错误码索引
`setPlayerAttenuation`	`playerId: int, attenuation: double, forceSet: boolean`	`int`	错误码索引
`setZones`	`zones: SpatialAudioZone[]`	`int`	错误码索引
`updatePlayerPositionInfo`	`playerId: int, positionInfo: RemoteVoicePositionInfo`	`int`	错误码索引
`updateSelfPosition`	`position: float[], axisForward: float[], axisRight: float[], axisUp: float[]`	`int`	错误码索引

ILocalSpatialAudioEngine 6 方法 / 0 属性

typescript

create(): ILocalSpatialAudioEngine
destroy(): void
initialize(config: LocalSpatialAudioConfig): int
removeRemotePosition(uid: int): int
setRemoteAudioAttenuation(uid: int, attenuation: double, forceSet: boolean): int
updateRemotePosition(uid: int, posInfo: RemoteVoicePositionInfo): int

方法明细：6 / 6（参数、返回值、错误码）

方法	参数	返回值	错误
`create`	—	`ILocalSpatialAudioEngine`	错误码索引
`destroy`	—	`void`	错误码索引
`initialize`	`config: LocalSpatialAudioConfig`	`int`	错误码索引
`removeRemotePosition`	`uid: int`	`int`	错误码索引
`setRemoteAudioAttenuation`	`uid: int, attenuation: double, forceSet: boolean`	`int`	错误码索引
`updateRemotePosition`	`uid: int, posInfo: RemoteVoicePositionInfo`	`int`	错误码索引

ImageTrackOptions 0 方法 / 3 属性

属性	类型	只读
`imageUrl`	`String`	否
`fps`	`int`	否
`mirrorMode`	`VideoEncoderConfiguration.MIRROR_MODE_TYPE`	否

IMediaPlayer 41 方法 / 0 属性

typescript

adjustPlayoutVolume(volume: int): int
adjustPublishSignalVolume(volume: int): int
destroy(): int
getAudioBufferDelay(): int
getDuration(): long
getMediaPlayerId(): int
getMute(): boolean
getPlayPosition(): long
getPlaySrc(): String
getPlayoutVolume(): int
getPublishSignalVolume(): int
getState(): Constants.MediaPlayerState
getStreamCount(): int
getStreamInfo(index: int): MediaStreamInfo
mute(muted: boolean): int
open(url: String, startPos: long): int
open(uri: Uri, startPos: long): int
openWithMediaSource(source: MediaPlayerSource): int
pause(): int
play(): int
playPreloadedSrc(src: String): int
preloadSrc(src: String, startPos: long): int
registerAudioFrameObserver(audioFrameObserver: IMediaPlayerAudioFrameObserver, mode: int): int
registerPlayerObserver(playerObserver: IMediaPlayerObserver): int
registerVideoFrameObserver(videoFrameObserver: IMediaPlayerVideoFrameObserver): int
resume(): int
seek(newPos: long): int
selectAudioTrack(index: int): int
selectMultiAudioTrack(playoutTrackIndex: int, publishTrackIndex: int): int
setAudioDualMonoMode(mode: int): int
setAudioPitch(pitch: int): int
setLoopCount(loopCount: int): int
setPlaybackSpeed(speed: int): int
setPlayerOption(key: String, value: int): int
setPlayerOptionString(key: String, value: String): int
setSpatialAudioParams(params: SpatialAudioParams): int
setVideoRenderMode(mode: unknown): unknown
setView(videoView: View): int
stop(): int
switchSrc(src: String, syncPts: boolean): int
unRegisterPlayerObserver(playerObserver: IMediaPlayerObserver): int
unloadSrc(src: String): int

方法明细：41 / 41（参数、返回值、错误码）

方法	参数	返回值	错误
`adjustPlayoutVolume`	`volume: int`	`int`	错误码索引
`adjustPublishSignalVolume`	`volume: int`	`int`	错误码索引
`destroy`	—	`int`	错误码索引
`getAudioBufferDelay`	—	`int`	错误码索引
`getDuration`	—	`long`	错误码索引
`getMediaPlayerId`	—	`int`	错误码索引
`getMute`	—	`boolean`	错误码索引
`getPlayPosition`	—	`long`	错误码索引
`getPlaySrc`	—	`String`	错误码索引
`getPlayoutVolume`	—	`int`	错误码索引
`getPublishSignalVolume`	—	`int`	错误码索引
`getState`	—	`Constants.MediaPlayerState`	错误码索引
`getStreamCount`	—	`int`	错误码索引
`getStreamInfo`	`index: int`	`MediaStreamInfo`	错误码索引
`mute`	`muted: boolean`	`int`	错误码索引
`open`	`url: String, startPos: long`	`int`	错误码索引
`openWithMediaSource`	`source: MediaPlayerSource`	`int`	错误码索引
`pause`	—	`int`	错误码索引
`play`	—	`int`	错误码索引
`playPreloadedSrc`	`src: String`	`int`	错误码索引
`preloadSrc`	`src: String, startPos: long`	`int`	错误码索引
`registerAudioFrameObserver`	`audioFrameObserver: IMediaPlayerAudioFrameObserver, mode: int`	`int`	错误码索引
`registerPlayerObserver`	`playerObserver: IMediaPlayerObserver`	`int`	错误码索引
`registerVideoFrameObserver`	`videoFrameObserver: IMediaPlayerVideoFrameObserver`	`int`	错误码索引
`resume`	—	`int`	错误码索引
`seek`	`newPos: long`	`int`	错误码索引
`selectAudioTrack`	`index: int`	`int`	错误码索引
`selectMultiAudioTrack`	`playoutTrackIndex: int, publishTrackIndex: int`	`int`	错误码索引
`setAudioDualMonoMode`	`mode: int`	`int`	错误码索引
`setAudioPitch`	`pitch: int`	`int`	错误码索引
`setLoopCount`	`loopCount: int`	`int`	错误码索引
`setPlaybackSpeed`	`speed: int`	`int`	错误码索引
`setPlayerOption`	`key: String, value: int`	`int`	错误码索引
`setPlayerOptionString`	`key: String, value: String`	`int`	错误码索引
`setSpatialAudioParams`	`params: SpatialAudioParams`	`int`	错误码索引
`setVideoRenderMode`	`mode: unknown`	`unknown`	错误码索引
`setView`	`videoView: View`	`int`	错误码索引
`stop`	—	`int`	错误码索引
`switchSrc`	`src: String, syncPts: boolean`	`int`	错误码索引
`unRegisterPlayerObserver`	`playerObserver: IMediaPlayerObserver`	`int`	错误码索引
`unloadSrc`	`src: String`	`int`	错误码索引

IMediaPlayerAudioFrameObserver 1 方法 / 0 属性

typescript

onFrame(frame: AudioFrame): AudioFrame

方法明细：1 / 1（参数、返回值、错误码）

方法	参数	返回值	错误
`onFrame`	`frame: AudioFrame`	`AudioFrame`	错误码索引

IMediaPlayerCacheManager 12 方法 / 0 属性

typescript

enableAutoRemoveCache(enable: boolean): int
getCacheDir(): String
getCacheFileCount(): int
getMaxCacheFileCount(): int
getMaxCacheFileSize(): long
getMediaPlayerCacheManager(): IMediaPlayerCacheManager
removeAllCaches(): int
removeCacheByUri(uri: String): int
removeOldCache(): int
setCacheDir(path: String): int
setMaxCacheFileCount(count: int): int
setMaxCacheFileSize(cacheSize: long): int

方法明细：12 / 12（参数、返回值、错误码）

方法	参数	返回值	错误
`enableAutoRemoveCache`	`enable: boolean`	`int`	错误码索引
`getCacheDir`	—	`String`	错误码索引
`getCacheFileCount`	—	`int`	错误码索引
`getMaxCacheFileCount`	—	`int`	错误码索引
`getMaxCacheFileSize`	—	`long`	错误码索引
`getMediaPlayerCacheManager`	—	`IMediaPlayerCacheManager`	错误码索引
`removeAllCaches`	—	`int`	错误码索引
`removeCacheByUri`	`uri: String`	`int`	错误码索引
`removeOldCache`	—	`int`	错误码索引
`setCacheDir`	`path: String`	`int`	错误码索引
`setMaxCacheFileCount`	`count: int`	`int`	错误码索引
`setMaxCacheFileSize`	`cacheSize: long`	`int`	错误码索引

IMediaPlayerCustomDataProvider 2 方法 / 0 属性

typescript

onReadData(buffer: ByteBuffer, bufferSize: int): int
onSeek(offset: long, whence: int): long

方法明细：2 / 2（参数、返回值、错误码）

方法	参数	返回值	错误
`onReadData`	`buffer: ByteBuffer, bufferSize: int`	`int`	错误码索引
`onSeek`	`offset: long, whence: int`	`long`	错误码索引

IMediaPlayerObserver 11 方法 / 0 属性

typescript

onAudioVolumeIndication(volume: int): void
onMetaData(type: Constants.MediaPlayerMetadataType, data: byte[]): void
onPlayBufferUpdated(playCachedBuffer: long): void
onPlayerCacheStats(stats: CacheStatistics): void
onPlayerEvent(eventCode: Constants.MediaPlayerEvent, elapsedTime: long, message: String): void
onPlayerInfoUpdated(info: PlayerUpdatedInfo): void
onPlayerPlaybackStats(stats: PlayerPlaybackStats): void
onPlayerSrcInfoChanged(from: SrcInfo, to: SrcInfo): void
onPlayerStateChanged(state: Constants.MediaPlayerState, reason: Constants.MediaPlayerReason): void
onPositionChanged(positionMs: long, timestampMs: long): void
onPreloadEvent(src: String, event: Constants.MediaPlayerPreloadEvent): void

方法明细：11 / 11（参数、返回值、错误码）

方法	参数	返回值	错误
`onAudioVolumeIndication`	`volume: int`	`void`	错误码索引
`onMetaData`	`type: Constants.MediaPlayerMetadataType, data: byte[]`	`void`	错误码索引
`onPlayBufferUpdated`	`playCachedBuffer: long`	`void`	错误码索引
`onPlayerCacheStats`	`stats: CacheStatistics`	`void`	错误码索引
`onPlayerEvent`	`eventCode: Constants.MediaPlayerEvent, elapsedTime: long, message: String`	`void`	错误码索引
`onPlayerInfoUpdated`	`info: PlayerUpdatedInfo`	`void`	错误码索引
`onPlayerPlaybackStats`	`stats: PlayerPlaybackStats`	`void`	错误码索引
`onPlayerSrcInfoChanged`	`from: SrcInfo, to: SrcInfo`	`void`	错误码索引
`onPlayerStateChanged`	`state: Constants.MediaPlayerState, reason: Constants.MediaPlayerReason`	`void`	错误码索引
`onPositionChanged`	`positionMs: long, timestampMs: long`	`void`	错误码索引
`onPreloadEvent`	`src: String, event: Constants.MediaPlayerPreloadEvent`	`void`	错误码索引

IMediaPlayerVideoFrameObserver 1 方法 / 0 属性

typescript

onFrame(frame: VideoFrame): void

方法明细：1 / 1（参数、返回值、错误码）

方法	参数	返回值	错误
`onFrame`	`frame: VideoFrame`	`void`	错误码索引

IMediaRecorderCallback 2 方法 / 0 属性

typescript

onRecorderInfoUpdated(channelId: String, uid: int, info: RecorderInfo): void
onRecorderStateChanged(channelId: String, uid: int, state: int, reason: int): void

方法明细：2 / 2（参数、返回值、错误码）

方法	参数	返回值	错误
`onRecorderInfoUpdated`	`channelId: String, uid: int, info: RecorderInfo`	`void`	错误码索引
`onRecorderStateChanged`	`channelId: String, uid: int, state: int, reason: int`	`void`	错误码索引

IMetadataObserver 3 方法 / 0 属性

typescript

getMaxMetadataSize(): int
onMetadataReceived(metadata: AgoraMetadata): void
onReadyToSendMetadata(timeStampMs: long, sourceType: int): byte[]

方法明细：3 / 3（参数、返回值、错误码）

方法	参数	返回值	错误
`getMaxMetadataSize`	—	`int`	错误码索引
`onMetadataReceived`	`metadata: AgoraMetadata`	`void`	错误码索引
`onReadyToSendMetadata`	`timeStampMs: long, sourceType: int`	`byte[]`	错误码索引

IMusicContentCenterEventHandler 5 方法 / 0 属性

typescript

onLyricResult(requestId: String, songCode: long, lyricUrl: String, reason: int): void
onMusicChartsResult(requestId: String, list: MusicChartInfo[], reason: int): void
onMusicCollectionResult(requestId: String, page: int, pageSize: int, total: int, list: Music[], reason: int): void
onPreLoadEvent(requestId: String, songCode: long, percent: int, lyricUrl: String, state: int, reason: int): void
onSongSimpleInfoResult(requestId: String, songCode: long, simpleInfo: String, reason: int): void

方法明细：5 / 5（参数、返回值、错误码）

方法	参数	返回值	错误
`onLyricResult`	`requestId: String, songCode: long, lyricUrl: String, reason: int`	`void`	错误码索引
`onMusicChartsResult`	`requestId: String, list: MusicChartInfo[], reason: int`	`void`	错误码索引
`onMusicCollectionResult`	`requestId: String, page: int, pageSize: int, total: int, list: Music[], reason: int`	`void`	错误码索引
`onPreLoadEvent`	`requestId: String, songCode: long, percent: int, lyricUrl: String, state: int, reason: int`	`void`	错误码索引
`onSongSimpleInfoResult`	`requestId: String, songCode: long, simpleInfo: String, reason: int`	`void`	错误码索引

IRtcEngineEventHandler 84 方法 / 0 属性

typescript

onActiveSpeaker(uid: int): void
onAudioEffectFinished(soundId: int): void
onAudioMixingFinished(): void
onAudioMixingPositionChanged(position: long): void
onAudioMixingStateChanged(state: int, reason: int): void
onAudioPublishStateChanged(channel: String, oldState: int, newState: int, elapseSinceLastState: int): void
onAudioQuality(uid: int, quality: int, delay: short, lost: short): void
onAudioRouteChanged(routing: int): void
onAudioSubscribeStateChanged(channel: String, uid: int, oldState: int, newState: int, elapseSinceLastState: int): void
onAudioVolumeIndication(speakers: AudioVolumeInfo[], totalVolume: int): void
onCameraExposureAreaChanged(rect: Rect): void
onCameraFocusAreaChanged(rect: Rect): void
onCameraReady(): void
onChannelMediaRelayStateChanged(state: int, code: int): void
onClientRoleChangeFailed(reason: int, currentRole: int): void
onClientRoleChanged(oldRole: int, newRole: int, newRoleOptions: ClientRoleOptions): void
onConnectionBanned(): void
onConnectionInterrupted(): void
onConnectionLost(): void
onConnectionStateChanged(state: int, reason: int): void
onEncryptionError(errorType: int): void
onError(err: int): void
onErrorWithContext(extContext: ExtensionContext, error: int, message: String): void
onEventWithContext(extContext: ExtensionContext, key: String, value: String): void
onFacePositionChanged(imageWidth: int, imageHeight: int, faceRectArr: AgoraFacePositionInfo[]): void
onFirstLocalAudioFramePublished(elapsed: int): void
onFirstLocalVideoFrame(source: Constants.VideoSourceType, width: int, height: int, elapsed: int): void
onFirstLocalVideoFramePublished(source: Constants.VideoSourceType, elapsed: int): void
onFirstRemoteAudioDecoded(uid: int, elapsed: int): void
onFirstRemoteAudioFrame(uid: int, elapsed: int): void
onFirstRemoteVideoDecoded(uid: int, width: int, height: int, elapsed: int): void
onFirstRemoteVideoFrame(uid: int, width: int, height: int, elapsed: int): void
onJoinChannelSuccess(channel: String, uid: int, elapsed: int): void
onLastmileProbeResult(result: LastmileProbeResult): void
onLastmileQuality(quality: int): void
onLeaveChannel(stats: RtcStats): void
onLocalAudioStateChanged(state: int, reason: int): void
onLocalAudioStats(stats: LocalAudioStats): void
onLocalUserRegistered(uid: int, userAccount: String): void
onLocalVideoEvent(source: Constants.VideoSourceType, event: int): void
onLocalVideoStateChanged(source: Constants.VideoSourceType, state: int, reason: int): void
onLocalVideoStats(source: Constants.VideoSourceType, stats: LocalVideoStats): void
onLocalVideoTranscoderError(stream: LocalTranscoderConfiguration.TranscodingVideoStream, error: int): void
onMultipathStats(stats: MultipathStats): void
onNetworkQuality(uid: int, txQuality: int, rxQuality: int): void
onNetworkTypeChanged(type: int): void
onPermissionError(permission: int): void
onPermissionGranted(permission: int): void
onProxyConnected(channel: String, uid: int, proxyType: int, localProxyIp: String, elapsed: int): void
onRejoinChannelSuccess(channel: String, uid: int, elapsed: int): void
onRemoteAudioStateChanged(uid: int, state: int, reason: int, elapsed: int): void
onRemoteAudioStats(stats: RemoteAudioStats): void
onRemoteAudioTransportStats(uid: int, delay: int, lost: int, rxKBitRate: int): void
onRemoteSubscribeFallbackToAudioOnly(uid: int, isFallbackOrRecover: boolean): void
onRemoteVideoStateChanged(uid: int, state: int, reason: int, elapsed: int): void
onRemoteVideoStats(stats: RemoteVideoStats): void
onRemoteVideoTransportStats(uid: int, delay: int, lost: int, rxKBitRate: int): void
onRenewTokenResult(token: String, code: Constants.RenewTokenErrorCode): void
onRequestToken(): void
onRhythmPlayerStateChanged(state: int, reason: int): void
onRtcStats(stats: RtcStats): void
onRtmpStreamingEvent(url: String, event: int): void
onRtmpStreamingStateChanged(url: String, state: int, reason: int): void
onSnapshotTaken(uid: int, filePath: String, width: int, height: int, errCode: int): void
onStartedWithContext(extContext: ExtensionContext): void
onStoppedWithContext(extContext: ExtensionContext): void
onStreamMessage(uid: int, streamId: int, data: byte[]): void
onStreamMessageError(uid: int, streamId: int, error: int, missed: int, cached: int): void
onTokenPrivilegeWillExpire(token: String): void
onTranscodedStreamLayoutInfo(uid: int, info: VideoLayoutInfo): void
onTranscodingUpdated(): void
onUplinkNetworkInfoUpdated(info: UplinkNetworkInfo): void
onUserEnableLocalVideo(uid: int, enabled: boolean): void
onUserEnableVideo(uid: int, enabled: boolean): void
onUserInfoUpdated(uid: int, userInfo: UserInfo): void
onUserJoined(uid: int, elapsed: int): void
onUserMuteAudio(uid: int, muted: boolean): void
onUserMuteVideo(uid: int, muted: boolean): void
onUserOffline(uid: int, reason: int): void
onVideoPublishStateChanged(source: Constants.VideoSourceType, channel: String, oldState: int, newState: int, elapseSinceLastState: int): void
onVideoRenderingTracingResult(uid: int, currentEvent: Constants.MEDIA_TRACE_EVENT, tracingInfo: VideoRenderingTracingInfo): void
onVideoSizeChanged(source: Constants.VideoSourceType, uid: int, width: int, height: int, rotation: int): void
onVideoStopped(): void
onVideoSubscribeStateChanged(channel: String, uid: int, oldState: int, newState: int, elapseSinceLastState: int): void

方法明细：84 / 84（参数、返回值、错误码）

方法	参数	返回值	错误
`onActiveSpeaker`	`uid: int`	`void`	错误码索引
`onAudioEffectFinished`	`soundId: int`	`void`	错误码索引
`onAudioMixingFinished`	—	`void`	错误码索引
`onAudioMixingPositionChanged`	`position: long`	`void`	错误码索引
`onAudioMixingStateChanged`	`state: int, reason: int`	`void`	错误码索引
`onAudioPublishStateChanged`	`channel: String, oldState: int, newState: int, elapseSinceLastState: int`	`void`	错误码索引
`onAudioQuality`	`uid: int, quality: int, delay: short, lost: short`	`void`	错误码索引
`onAudioRouteChanged`	`routing: int`	`void`	错误码索引
`onAudioSubscribeStateChanged`	`channel: String, uid: int, oldState: int, newState: int, elapseSinceLastState: int`	`void`	错误码索引
`onAudioVolumeIndication`	`speakers: AudioVolumeInfo[], totalVolume: int`	`void`	错误码索引
`onCameraExposureAreaChanged`	`rect: Rect`	`void`	错误码索引
`onCameraFocusAreaChanged`	`rect: Rect`	`void`	错误码索引
`onCameraReady`	—	`void`	错误码索引
`onChannelMediaRelayStateChanged`	`state: int, code: int`	`void`	错误码索引
`onClientRoleChangeFailed`	`reason: int, currentRole: int`	`void`	错误码索引
`onClientRoleChanged`	`oldRole: int, newRole: int, newRoleOptions: ClientRoleOptions`	`void`	错误码索引
`onConnectionBanned`	—	`void`	错误码索引
`onConnectionInterrupted`	—	`void`	错误码索引
`onConnectionLost`	—	`void`	错误码索引
`onConnectionStateChanged`	`state: int, reason: int`	`void`	错误码索引
`onEncryptionError`	`errorType: int`	`void`	错误码索引
`onError`	`err: int`	`void`	错误码索引
`onErrorWithContext`	`extContext: ExtensionContext, error: int, message: String`	`void`	错误码索引
`onEventWithContext`	`extContext: ExtensionContext, key: String, value: String`	`void`	错误码索引
`onFacePositionChanged`	`imageWidth: int, imageHeight: int, faceRectArr: AgoraFacePositionInfo[]`	`void`	错误码索引
`onFirstLocalAudioFramePublished`	`elapsed: int`	`void`	错误码索引
`onFirstLocalVideoFrame`	`source: Constants.VideoSourceType, width: int, height: int, elapsed: int`	`void`	错误码索引
`onFirstLocalVideoFramePublished`	`source: Constants.VideoSourceType, elapsed: int`	`void`	错误码索引
`onFirstRemoteAudioDecoded`	`uid: int, elapsed: int`	`void`	错误码索引
`onFirstRemoteAudioFrame`	`uid: int, elapsed: int`	`void`	错误码索引
`onFirstRemoteVideoDecoded`	`uid: int, width: int, height: int, elapsed: int`	`void`	错误码索引
`onFirstRemoteVideoFrame`	`uid: int, width: int, height: int, elapsed: int`	`void`	错误码索引
`onJoinChannelSuccess`	`channel: String, uid: int, elapsed: int`	`void`	错误码索引
`onLastmileProbeResult`	`result: LastmileProbeResult`	`void`	错误码索引
`onLastmileQuality`	`quality: int`	`void`	错误码索引
`onLeaveChannel`	`stats: RtcStats`	`void`	错误码索引
`onLocalAudioStateChanged`	`state: int, reason: int`	`void`	错误码索引
`onLocalAudioStats`	`stats: LocalAudioStats`	`void`	错误码索引
`onLocalUserRegistered`	`uid: int, userAccount: String`	`void`	错误码索引
`onLocalVideoEvent`	`source: Constants.VideoSourceType, event: int`	`void`	错误码索引
`onLocalVideoStateChanged`	`source: Constants.VideoSourceType, state: int, reason: int`	`void`	错误码索引
`onLocalVideoStats`	`source: Constants.VideoSourceType, stats: LocalVideoStats`	`void`	错误码索引
`onLocalVideoTranscoderError`	`stream: LocalTranscoderConfiguration.TranscodingVideoStream, error: int`	`void`	错误码索引
`onMultipathStats`	`stats: MultipathStats`	`void`	错误码索引
`onNetworkQuality`	`uid: int, txQuality: int, rxQuality: int`	`void`	错误码索引
`onNetworkTypeChanged`	`type: int`	`void`	错误码索引
`onPermissionError`	`permission: int`	`void`	错误码索引
`onPermissionGranted`	`permission: int`	`void`	错误码索引
`onProxyConnected`	`channel: String, uid: int, proxyType: int, localProxyIp: String, elapsed: int`	`void`	错误码索引
`onRejoinChannelSuccess`	`channel: String, uid: int, elapsed: int`	`void`	错误码索引
`onRemoteAudioStateChanged`	`uid: int, state: int, reason: int, elapsed: int`	`void`	错误码索引
`onRemoteAudioStats`	`stats: RemoteAudioStats`	`void`	错误码索引
`onRemoteAudioTransportStats`	`uid: int, delay: int, lost: int, rxKBitRate: int`	`void`	错误码索引
`onRemoteSubscribeFallbackToAudioOnly`	`uid: int, isFallbackOrRecover: boolean`	`void`	错误码索引
`onRemoteVideoStateChanged`	`uid: int, state: int, reason: int, elapsed: int`	`void`	错误码索引
`onRemoteVideoStats`	`stats: RemoteVideoStats`	`void`	错误码索引
`onRemoteVideoTransportStats`	`uid: int, delay: int, lost: int, rxKBitRate: int`	`void`	错误码索引
`onRenewTokenResult`	`token: String, code: Constants.RenewTokenErrorCode`	`void`	错误码索引
`onRequestToken`	—	`void`	错误码索引
`onRhythmPlayerStateChanged`	`state: int, reason: int`	`void`	错误码索引
`onRtcStats`	`stats: RtcStats`	`void`	错误码索引
`onRtmpStreamingEvent`	`url: String, event: int`	`void`	错误码索引
`onRtmpStreamingStateChanged`	`url: String, state: int, reason: int`	`void`	错误码索引
`onSnapshotTaken`	`uid: int, filePath: String, width: int, height: int, errCode: int`	`void`	错误码索引
`onStartedWithContext`	`extContext: ExtensionContext`	`void`	错误码索引
`onStoppedWithContext`	`extContext: ExtensionContext`	`void`	错误码索引
`onStreamMessage`	`uid: int, streamId: int, data: byte[]`	`void`	错误码索引
`onStreamMessageError`	`uid: int, streamId: int, error: int, missed: int, cached: int`	`void`	错误码索引
`onTokenPrivilegeWillExpire`	`token: String`	`void`	错误码索引
`onTranscodedStreamLayoutInfo`	`uid: int, info: VideoLayoutInfo`	`void`	错误码索引
`onTranscodingUpdated`	—	`void`	错误码索引
`onUplinkNetworkInfoUpdated`	`info: UplinkNetworkInfo`	`void`	错误码索引
`onUserEnableLocalVideo`	`uid: int, enabled: boolean`	`void`	错误码索引
`onUserEnableVideo`	`uid: int, enabled: boolean`	`void`	错误码索引
`onUserInfoUpdated`	`uid: int, userInfo: UserInfo`	`void`	错误码索引
`onUserJoined`	`uid: int, elapsed: int`	`void`	错误码索引
`onUserMuteAudio`	`uid: int, muted: boolean`	`void`	错误码索引
`onUserMuteVideo`	`uid: int, muted: boolean`	`void`	错误码索引
`onUserOffline`	`uid: int, reason: int`	`void`	错误码索引
`onVideoPublishStateChanged`	`source: Constants.VideoSourceType, channel: String, oldState: int, newState: int, elapseSinceLastState: int`	`void`	错误码索引
`onVideoRenderingTracingResult`	`uid: int, currentEvent: Constants.MEDIA_TRACE_EVENT, tracingInfo: VideoRenderingTracingInfo`	`void`	错误码索引
`onVideoSizeChanged`	`source: Constants.VideoSourceType, uid: int, width: int, height: int, rotation: int`	`void`	错误码索引
`onVideoStopped`	—	`void`	错误码索引
`onVideoSubscribeStateChanged`	`channel: String, uid: int, oldState: int, newState: int, elapseSinceLastState: int`	`void`	错误码索引

IRtcEngineReleaseCallback 1 方法 / 0 属性

typescript

onEngineReleased(): void

方法明细：1 / 1（参数、返回值、错误码）

方法	参数	返回值	错误
`onEngineReleased`	—	`void`	错误码索引

IVideoEffectObject 10 方法 / 0 属性

typescript

addOrUpdateVideoEffect(nodeId: int, templateName: String): int
getVideoEffectBoolParam(option: String, key: String): boolean
getVideoEffectFloatParam(option: String, key: String): float
getVideoEffectIntParam(option: String, key: String): int
performVideoEffectAction(nodeId: int, actionId: VIDEO_EFFECT_ACTION): int
removeVideoEffect(nodeId: int): int
setVideoEffectBoolParam(option: String, key: String, value: boolean): int
setVideoEffectFloatParam(option: String, key: String, value: float): int
setVideoEffectIntParam(option: String, key: String, value: int): int
setVideoEffectStringParam(option: String, key: String, value: String): int

方法明细：10 / 10（参数、返回值、错误码）

方法	参数	返回值	错误
`addOrUpdateVideoEffect`	`nodeId: int, templateName: String`	`int`	错误码索引
`getVideoEffectBoolParam`	`option: String, key: String`	`boolean`	错误码索引
`getVideoEffectFloatParam`	`option: String, key: String`	`float`	错误码索引
`getVideoEffectIntParam`	`option: String, key: String`	`int`	错误码索引
`performVideoEffectAction`	`nodeId: int, actionId: VIDEO_EFFECT_ACTION`	`int`	错误码索引
`removeVideoEffect`	`nodeId: int`	`int`	错误码索引
`setVideoEffectBoolParam`	`option: String, key: String, value: boolean`	`int`	错误码索引
`setVideoEffectFloatParam`	`option: String, key: String, value: float`	`int`	错误码索引
`setVideoEffectIntParam`	`option: String, key: String, value: int`	`int`	错误码索引
`setVideoEffectStringParam`	`option: String, key: String, value: String`	`int`	错误码索引

IVideoEncodedFrameObserver 1 方法 / 0 属性

typescript

onEncodedVideoFrameReceived(channelId: String, remoteUid: int, buffer: ByteBuffer, info: EncodedVideoFrameInfo): boolean

方法明细：1 / 1（参数、返回值、错误码）

方法	参数	返回值	错误
`onEncodedVideoFrameReceived`	`channelId: String, remoteUid: int, buffer: ByteBuffer, info: EncodedVideoFrameInfo`	`boolean`	错误码索引

IVideoFrameObserver 8 方法 / 0 属性

typescript

getMirrorApplied(): boolean
getObservedFramePosition(): int
getRotationApplied(): boolean
getVideoFormatPreference(): int
getVideoFrameProcessMode(): int
onCaptureVideoFrame(sourceType: int, videoFrame: VideoFrame): boolean
onPreEncodeVideoFrame(sourceType: int, videoFrame: VideoFrame): boolean
onRenderVideoFrame(channelId: String, uid: int, videoFrame: VideoFrame): boolean

方法明细：8 / 8（参数、返回值、错误码）

方法	参数	返回值	错误
`getMirrorApplied`	—	`boolean`	错误码索引
`getObservedFramePosition`	—	`int`	错误码索引
`getRotationApplied`	—	`boolean`	错误码索引
`getVideoFormatPreference`	—	`int`	错误码索引
`getVideoFrameProcessMode`	—	`int`	错误码索引
`onCaptureVideoFrame`	`sourceType: int, videoFrame: VideoFrame`	`boolean`	错误码索引
`onPreEncodeVideoFrame`	`sourceType: int, videoFrame: VideoFrame`	`boolean`	错误码索引
`onRenderVideoFrame`	`channelId: String, uid: int, videoFrame: VideoFrame`	`boolean`	错误码索引

LastmileProbeConfig 0 方法 / 4 属性

属性	类型	只读
`probeUplink`	`boolean`	否
`probeDownlink`	`boolean`	否
`expectedUplinkBitrate`	`int`	否
`expectedDownlinkBitrate`	`int`	否

LastmileProbeOneWayResult 0 方法 / 3 属性

属性	类型	只读
`packetLossRate`	`int`	否
`jitter`	`int`	否
`availableBandwidth`	`int`	否

LastmileProbeResult 0 方法 / 4 属性

属性	类型	只读
`state`	`short`	否
`rtt`	`int`	否
`uplinkReport`	`LastmileProbeOneWayResult`	否
`downlinkReport`	`LastmileProbeOneWayResult`	否

LeaveChannelOptions 0 方法 / 3 属性

属性	类型	只读
`stopAudioMixing`	`boolean`	否
`stopAllEffect`	`boolean`	否
`stopMicrophoneRecording`	`boolean`	否

LiveTranscoding 21 方法 / 15 属性

typescript

addBackgroundImage(backgroundImage: AgoraImage): void
addUser(user: TranscodingUser): int
addWatermark(watermark: AgoraImage): void
getAdvancedFeatures(): Map
getBackgroundColor(): int
getBackgroundImageList(): ArrayList
getBlue(): int
getGreen(): int
getRed(): int
getUserCount(): int
getUsers(): ArrayList
getWatermarkList(): ArrayList
removeBackgroundImage(backgroundImage: AgoraImage): boolean
removeUser(uid: int): int
removeWatermark(watermark: AgoraImage): boolean
setAdvancedFeatures(featureName: String, opened: Boolean): void
setBackgroundColor(color: int): void
setBackgroundColor(red: int, green: int, blue: int): void
setBlue(blue: int): void
setGreen(green: int): void
setRed(red: int): void
setUsers(users: ArrayList): void
setUsers(users: Map): void

方法明细：21 / 21（参数、返回值、错误码）

方法	参数	返回值	错误
`addBackgroundImage`	`backgroundImage: AgoraImage`	`void`	错误码索引
`addUser`	`user: TranscodingUser`	`int`	错误码索引
`addWatermark`	`watermark: AgoraImage`	`void`	错误码索引
`getAdvancedFeatures`	—	`Map`	错误码索引
`getBackgroundColor`	—	`int`	错误码索引
`getBackgroundImageList`	—	`ArrayList`	错误码索引
`getBlue`	—	`int`	错误码索引
`getGreen`	—	`int`	错误码索引
`getRed`	—	`int`	错误码索引
`getUserCount`	—	`int`	错误码索引
`getUsers`	—	`ArrayList`	错误码索引
`getWatermarkList`	—	`ArrayList`	错误码索引
`removeBackgroundImage`	`backgroundImage: AgoraImage`	`boolean`	错误码索引
`removeUser`	`uid: int`	`int`	错误码索引
`removeWatermark`	`watermark: AgoraImage`	`boolean`	错误码索引
`setAdvancedFeatures`	`featureName: String, opened: Boolean`	`void`	错误码索引
`setBackgroundColor`	`color: int`	`void`	错误码索引
`setBlue`	`blue: int`	`void`	错误码索引
`setGreen`	`green: int`	`void`	错误码索引
`setRed`	`red: int`	`void`	错误码索引
`setUsers`	`users: ArrayList`	`void`	错误码索引

属性	类型	只读
`width`	`int`	否
`height`	`int`	否
`videoBitrate`	`int`	否
`videoFramerate`	`int`	否
`lowLatency`	`unknown`	否
`videoGop`	`int`	否
`audioSampleRate`	`AudioSampleRateType`	否
`audioBitrate`	`int`	否
`audioChannels`	`int`	否
`audioCodecProfile`	`AudioCodecProfileType`	否
`videoCodecProfile`	`VideoCodecProfileType`	否
`videoCodecType`	`VideoCodecType`	否
`userCount`	`unknown`	否
`userConfigExtraInfo`	`String`	否
`metadata`	`unknown`	否

LocalAccessPointConfiguration 0 方法 / 6 属性

属性	类型	只读
`ipList`	`ArrayList`	否
`domainList`	`ArrayList`	否
`verifyDomainName`	`String`	否
`mode`	`int`	否
`disableAut`	`boolean`	否
`advancedConfig`	`AdvancedConfigInfo`	否

LocalAudioMixerConfiguration 0 方法 / 2 属性

属性	类型	只读
`audioInputStreams`	`ArrayList`	否
`syncWithLocalMic`	`boolean`	否

LocalAudioStats 0 方法 / 9 属性

属性	类型	只读
`numChannels`	`int`	否
`sentSampleRate`	`int`	否
`sentBitrate`	`int`	否
`internalCodec`	`int`	否
`txPacketLossRate`	`int`	否
`audioDeviceDelay`	`int`	否
`audioPlayoutDelay`	`int`	否
`earMonitorDelay`	`int`	否
`aecEstimatedDelay`	`int`	否

LocalSpatialAudioConfig 0 方法 / 1 属性

属性	类型	只读
`mRtcEngine`	`RtcEngine`	否

LocalTranscoderConfiguration 0 方法 / 3 属性

属性	类型	只读
`transcodingVideoStreams`	`ArrayList`	否
`syncWithPrimaryCamera`	`boolean`	否
`videoOutputConfiguration`	`VideoEncoderConfiguration`	否

LocalVideoStats 0 方法 / 23 属性

属性	类型	只读
`uid`	`int`	否
`sentBitrate`	`int`	否
`sentFrameRate`	`int`	否
`captureFrameRate`	`int`	否
`captureFrameWidth`	`int`	否
`captureFrameHeight`	`int`	否
`regulatedCaptureFrameRate`	`int`	否
`regulatedCaptureFrameWidth`	`int`	否
`regulatedCaptureFrameHeight`	`int`	否
`encoderOutputFrameRate`	`int`	否
`rendererOutputFrameRate`	`int`	否
`targetBitrate`	`int`	否
`targetFrameRate`	`int`	否
`qualityAdaptIndication`	`int`	否
`encodedBitrate`	`int`	否
`encodedFrameWidth`	`int`	否
`encodedFrameHeight`	`int`	否
`encodedFrameCount`	`int`	否
`codecType`	`int`	否
`txPacketLossRate`	`int`	否
`captureBrightnessLevel`	`int`	否
`dualStreamEnabled`	`boolean`	否
`hwEncoderAccelerating`	`int`	否

LogConfig 0 方法 / 3 属性

属性	类型	只读
`filePath`	`String`	否
`fileSizeInKB`	`int`	否
`level`	`int`	否

LogUploadServerInfo 0 方法 / 4 属性

属性	类型	只读
`serverDomain`	`String`	否
`serverPath`	`String`	否
`serverPort`	`int`	否
`serverHttps`	`boolean`	否

LowLightEnhanceOptions 0 方法 / 6 属性

属性	类型	只读
`LOW_LIGHT_ENHANCE_AUTO`	`int`	否
`LOW_LIGHT_ENHANCE_MANUAL`	`int`	否
`LOW_LIGHT_ENHANCE_LEVEL_HIGH_QUALITY`	`int`	否
`LOW_LIGHT_ENHANCE_LEVEL_FAST`	`int`	否
`lowlightEnhanceMode`	`int`	否
`lowlightEnhanceLevel`	`int`	否

MediaPlayerSource 0 方法 / 9 属性

属性	类型	只读
`url`	`String`	否
`uri`	`String`	否
`startPos`	`long`	否
`autoPlay`	`boolean`	否
`enableCache`	`boolean`	否
`enableMultiAudioTrack`	`boolean`	否
`isAgoraSource`	`Boolean`	否
`isLiveSource`	`Boolean`	否
`provider`	`IMediaPlayerCustomDataProvider`	否

MediaRecorderConfiguration 0 方法 / 11 属性

属性	类型	只读
`storagePath`	`String`	否
`containerFormat`	`int`	否
`streamType`	`int`	否
`maxDurationMs`	`int`	否
`recorderInfoUpdateInterval`	`int`	否
`width`	`int`	否
`height`	`int`	否
`fps`	`int`	否
`sample_rate`	`int`	否
`channel_num`	`int`	否
`videoSourceType`	`int`	否

MediaStreamInfo 0 方法 / 13 属性

属性	类型	只读
`streamIndex`	`int`	否
`mediaStreamType`	`int`	否
`codecName`	`String`	否
`language`	`String`	否
`videoFrameRate`	`int`	否
`videoBitRate`	`int`	否
`videoWidth`	`int`	否
`videoHeight`	`int`	否
`videoRotation`	`int`	否
`audioSampleRate`	`int`	否
`audioChannels`	`int`	否
`audioBytesPerSample`	`int`	否
`duration`	`long`	否

MixedAudioStream 0 方法 / 4 属性

属性	类型	只读
`remoteUserUid`	`int`	否
`channelId`	`String`	否
`sourceType`	`Constants.AudioSourceType`	否
`trackId`	`int`	否

MultipathStats 0 方法 / 8 属性

属性	类型	只读
`lanTxBytes`	`int`	否
`lanRxBytes`	`int`	否
`wifiTxBytes`	`int`	否
`wifiRxBytes`	`int`	否
`mobileTxBytes`	`int`	否
`mobileRxBytes`	`int`	否
`activePathNum`	`int`	否
`pathStats`	`PathStats[]`	否

Music 0 方法 / 11 属性

属性	类型	只读
`songCode`	`long`	否
`name`	`String`	否
`singer`	`String`	否
`poster`	`String`	否
`releaseTime`	`String`	否
`type`	`int`	否
`pitchType`	`int`	否
`durationS`	`int`	否
`lyricTypes`	`int[]`	否
`mvProperties`	`MvProperty[]`	否
`climaxSegments`	`ClimaxSegment[]`	否

MusicCacheInfo 0 方法 / 2 属性

属性	类型	只读
`songCode`	`long`	否
`status`	`int`	否

MusicCacheStatusType 0 方法 / 2 属性

属性	类型	只读
`MUSIC_CACHE_STATUS_TYPE_CACHED`	`int`	否
`MUSIC_CACHE_STATUS_TYPE_CACHING`	`int`	否

MusicChartInfo 0 方法 / 2 属性

属性	类型	只读
`name`	`String`	否
`type`	`int`	否

MusicContentCenterConfiguration 0 方法 / 5 属性

属性	类型	只读
`appId`	`String`	否
`token`	`String`	否
`mccUid`	`long`	否
`maxCacheSize`	`int`	否
`eventHandler`	`IMusicContentCenterEventHandler`	否

MusicContentCenterStateReason 0 方法 / 8 属性

属性	类型	只读
`MUSIC_CONTENT_CENTER_STATE_REASON_OK`	`int`	否
`MUSIC_CONTENT_CENTER_STATE_REASON_ERROR`	`int`	否
`MUSIC_CONTENT_CENTER_STATE_REASON_GATEWAY`	`int`	否
`MUSIC_CONTENT_CENTER_STATE_REASON_PERMISSION_AND_RESOURCE`	`int`	否
`MUSIC_CONTENT_CENTER_STATE_REASON_INTERNAL_DATA_PARSE`	`int`	否
`MUSIC_CONTENT_CENTER_STATE_REASON_MUSIC_LOADING`	`int`	否
`MUSIC_CONTENT_CENTER_STATE_REASON_MUSIC_DECRYPTION`	`int`	否
`MUSIC_CONTENT_CENTER_STATE_REASON_HTTP_INTERNAL`	`int`	否

PathStats 0 方法 / 3 属性

属性	类型	只读
`pathType`	`int`	否
`txKBitRate`	`int`	否
`rxKBitRate`	`int`	否

Player 18 方法 / 0 属性

typescript

Player(rte: Rte, initialConfig: PlayerInitialConfig): unknown
getConfigs(config: PlayerConfig): void
getInfo(info: PlayerInfo): void
getPosition(): long
getStats(callback: PlayerGetStatsCallback): void
muteAudio(mute: boolean): void
muteVideo(mute: boolean): void
openWithUrl(url: String, startTime: long, callback: AsyncCallback): void
pause(): void
play(): void
preloadWithUrl(url: String): void
registerObserver(observer: PlayerObserver): void
seek(newTime: long): void
setCanvas(canvas: Canvas): void
setConfigs(config: PlayerConfig): void
stop(): void
switchWithUrl(url: String, syncPts: boolean, callback: AsyncCallback): void
unregisterObserver(observer: PlayerObserver): void

方法明细：18 / 18（参数、返回值、错误码）

方法	参数	返回值	错误
`Player`	`rte: Rte, initialConfig: PlayerInitialConfig`	`unknown`	错误码索引
`getConfigs`	`config: PlayerConfig`	`void`	错误码索引
`getInfo`	`info: PlayerInfo`	`void`	错误码索引
`getPosition`	—	`long`	错误码索引
`getStats`	`callback: PlayerGetStatsCallback`	`void`	错误码索引
`muteAudio`	`mute: boolean`	`void`	错误码索引
`muteVideo`	`mute: boolean`	`void`	错误码索引
`openWithUrl`	`url: String, startTime: long, callback: AsyncCallback`	`void`	错误码索引
`pause`	—	`void`	错误码索引
`play`	—	`void`	错误码索引
`preloadWithUrl`	`url: String`	`void`	错误码索引
`registerObserver`	`observer: PlayerObserver`	`void`	错误码索引
`seek`	`newTime: long`	`void`	错误码索引
`setCanvas`	`canvas: Canvas`	`void`	错误码索引
`setConfigs`	`config: PlayerConfig`	`void`	错误码索引
`stop`	—	`void`	错误码索引
`switchWithUrl`	`url: String, syncPts: boolean, callback: AsyncCallback`	`void`	错误码索引
`unregisterObserver`	`observer: PlayerObserver`	`void`	错误码索引

PlayerConfig 12 方法 / 0 属性

typescript

getAbrFallbackLayer(): Constants.AbrFallbackLayer
getAbrSubscriptionLayer(): Constants.AbrSubscriptionLayer
getAutoPlay(): boolean
getLoopCount(): int
getPlaybackSpeed(): int
getPlayoutVolume(): int
setAbrFallbackLayer(fallbackLayer: Constants.AbrFallbackLayer): void
setAbrSubscriptionLayer(subscriptionLayer: Constants.AbrSubscriptionLayer): void
setAutoPlay(autoPlay: boolean): void
setLoopCount(count: int): void
setPlaybackSpeed(speed: int): void
setPlayoutVolume(volume: int): void

方法明细：12 / 12（参数、返回值、错误码）

方法	参数	返回值	错误
`getAbrFallbackLayer`	—	`Constants.AbrFallbackLayer`	错误码索引
`getAbrSubscriptionLayer`	—	`Constants.AbrSubscriptionLayer`	错误码索引
`getAutoPlay`	—	`boolean`	错误码索引
`getLoopCount`	—	`int`	错误码索引
`getPlaybackSpeed`	—	`int`	错误码索引
`getPlayoutVolume`	—	`int`	错误码索引
`setAbrFallbackLayer`	`fallbackLayer: Constants.AbrFallbackLayer`	`void`	错误码索引
`setAbrSubscriptionLayer`	`subscriptionLayer: Constants.AbrSubscriptionLayer`	`void`	错误码索引
`setAutoPlay`	`autoPlay: boolean`	`void`	错误码索引
`setLoopCount`	`count: int`	`void`	错误码索引
`setPlaybackSpeed`	`speed: int`	`void`	错误码索引
`setPlayoutVolume`	`volume: int`	`void`	错误码索引

PlayerGetStatsCallback 1 方法 / 0 属性

typescript

onResult(playerStats: PlayerStats, error: Error): void

方法明细：1 / 1（参数、返回值、错误码）

方法	参数	返回值	错误
`onResult`	`playerStats: PlayerStats, error: Error`	`void`	错误码索引

PlayerInfo 14 方法 / 0 属性

typescript

abrSubscriptionLayer(): Constants.AbrSubscriptionLayer
audioBitsPerSample(): int
audioChannels(): int
audioSampleRate(): int
currentUrl(): String
duration(): long
hasAudio(): boolean
hasVideo(): boolean
isAudioMuted(): boolean
isVideoMuted(): boolean
state(): int
streamCount(): int
videoHeight(): int
videoWidth(): int

方法明细：14 / 14（参数、返回值、错误码）

方法	参数	返回值	错误
`abrSubscriptionLayer`	—	`Constants.AbrSubscriptionLayer`	错误码索引
`audioBitsPerSample`	—	`int`	错误码索引
`audioChannels`	—	`int`	错误码索引
`audioSampleRate`	—	`int`	错误码索引
`currentUrl`	—	`String`	错误码索引
`duration`	—	`long`	错误码索引
`hasAudio`	—	`boolean`	错误码索引
`hasVideo`	—	`boolean`	错误码索引
`isAudioMuted`	—	`boolean`	错误码索引
`isVideoMuted`	—	`boolean`	错误码索引
`state`	—	`int`	错误码索引
`streamCount`	—	`int`	错误码索引
`videoHeight`	—	`int`	错误码索引
`videoWidth`	—	`int`	错误码索引

PlayerObserver 7 方法 / 0 属性

typescript

onAudioVolumeIndication(volume: int): void
onEvent(event: int): void
onMetadata(type: int, data: byte[]): void
onPlayerInfoUpdated(info: PlayerInfo): void
onPositionChanged(curr_time: long, utc_time: long): void
onResolutionChanged(width: int, height: int): void
onStateChanged(old_state: int, new_state: int, error: Error): void

方法明细：7 / 7（参数、返回值、错误码）

方法	参数	返回值	错误
`onAudioVolumeIndication`	`volume: int`	`void`	错误码索引
`onEvent`	`event: int`	`void`	错误码索引
`onMetadata`	`type: int, data: byte[]`	`void`	错误码索引
`onPlayerInfoUpdated`	`info: PlayerInfo`	`void`	错误码索引
`onPositionChanged`	`curr_time: long, utc_time: long`	`void`	错误码索引
`onResolutionChanged`	`width: int, height: int`	`void`	错误码索引
`onStateChanged`	`old_state: int, new_state: int, error: Error`	`void`	错误码索引

PlayerPlaybackStats 0 方法 / 4 属性

属性	类型	只读
`videoFps`	`long`	否
`videoBitrateInKbps`	`long`	否
`audioBitrateInKbps`	`long`	否
`totalBitrateInKbps`	`long`	否

PlayerStats 0 方法 / 0 属性

无公开成员。

PlayerUpdatedInfo 0 方法 / 6 属性

属性	类型	只读
`deviceId`	`String`	否
`videoHeight`	`long`	否
`videoWidth`	`long`	否
`audioSampleRate`	`long`	否
`audioChannels`	`long`	否
`audioBitsPerSample`	`long`	否

PreloadState 0 方法 / 4 属性

属性	类型	只读
`PRELOAD_STATE_COMPLETED`	`int`	否
`PRELOAD_STATE_FAILED`	`int`	否
`PRELOAD_STATE_PRELOADING`	`int`	否
`PRELOAD_STATE_REMOVED`	`int`	否

RecorderInfo 0 方法 / 3 属性

属性	类型	只读
`fileName`	`String`	否
`durationMs`	`int`	否
`fileSize`	`int`	否

RecorderStreamInfo 0 方法 / 3 属性

属性	类型	只读
`uid`	`int`	否
`channelId`	`String`	否
`recorderStreamType`	`int`	否

Rectangle 0 方法 / 4 属性

属性	类型	只读
`x`	`int`	否
`y`	`int`	否
`width`	`int`	否
`height`	`int`	否

RemoteAudioStats 0 方法 / 19 属性

属性	类型	只读
`uid`	`int`	否
`quality`	`int`	否
`networkTransportDelay`	`int`	否
`jitterBufferDelay`	`int`	否
`audioLossRate`	`int`	否
`numChannels`	`int`	否
`receivedSampleRate`	`int`	否
`receivedBitrate`	`int`	否
`totalFrozenTime`	`int`	否
`frozenRate`	`int`	否
`mosValue`	`int`	否
`frozenRateByCustomPlcCount`	`int`	否
`plcCount`	`int`	否
`totalActiveTime`	`long`	否
`publishDuration`	`long`	否
`qoeQuality`	`int`	否
`qualityChangedReason`	`int`	否
`rxAudioBytes`	`int`	否
`e2eDelay`	`int`	否

RemoteVideoStats 0 方法 / 18 属性

属性	类型	只读
`uid`	`int`	否
`delay`	`int`	否
`e2eDelay`	`int`	否
`width`	`int`	否
`height`	`int`	否
`receivedBitrate`	`int`	否
`decoderOutputFrameRate`	`int`	否
`rendererOutputFrameRate`	`int`	否
`frameLossRate`	`int`	否
`packetLossRate`	`int`	否
`rxStreamType`	`int`	否
`totalFrozenTime`	`int`	否
`frozenRate`	`int`	否
`avSyncTimeMs`	`int`	否
`totalActiveTime`	`long`	否
`publishDuration`	`long`	否
`mosValue`	`int`	否
`rxVideoBytes`	`int`	否

RemoteVoicePositionInfo 0 方法 / 2 属性

属性	类型	只读
`position`	`float[]`	否
`forward`	`float[]`	否

RtcConnection 0 方法 / 2 属性

属性	类型	只读
`localUid`	`int`	否
`channelId`	`String`	否

RtcEngine 256 方法 / 0 属性

typescript

addExtension(providerName: String): void
addHandler(handler: IRtcEngineEventHandler): void
addVideoWatermark(watermark: AgoraImage): int
addVideoWatermark(watermarkUrl: String, options: WatermarkOptions): int
addVideoWatermark(config: WatermarkConfig): int
adjustAudioMixingPlayoutVolume(volume: int): int
adjustAudioMixingPublishVolume(volume: int): int
adjustAudioMixingVolume(volume: int): int
adjustCustomAudioPlayoutVolume(trackId: int, volume: int): int
adjustCustomAudioPublishVolume(trackId: int, volume: int): int
adjustPlaybackSignalVolume(volume: int): int
adjustRecordingSignalVolume(volume: int): int
adjustUserPlaybackSignalVolume(uid: int, volume: int): int
clearVideoWatermarks(): int
complain(callId: String, description: String): int
configRhythmPlayer(config: AgoraRhythmPlayerConfig): int
create(context: Context, appId: String, handler: IRtcEngineEventHandler): RtcEngine
create(config: RtcEngineConfig): RtcEngine
createCustomAudioTrack(trackType: Constants.AudioTrackType, config: AudioTrackConfig): int
createCustomVideoTrack(): int
createDataStream(reliable: boolean, ordered: boolean): int
createDataStream(config: DataStreamConfig): int
createMediaPlayer(): IMediaPlayer
createMediaRecorder(info: RecorderStreamInfo): AgoraMediaRecorder
createVideoEffectObject(bundlePath: String, sourceType: Constants.MediaSourceType): IVideoEffectObject
destroy(): void
destroy(callback: IRtcEngineReleaseCallback): void
destroyCustomAudioTrack(trackId: int): int
destroyCustomVideoTrack(video_track_id: int): int
destroyMediaRecorder(mediaRecorder: AgoraMediaRecorder): void
destroyVideoEffectObject(videoEffectObject: IVideoEffectObject): int
disableAudio(): int
disableAudioSpectrumMonitor(): int
disableVideo(): int
enableAudio(): int
enableAudioSpectrumMonitor(intervalInMS: int): int
enableAudioVolumeIndication(interval: int, smooth: int, reportVad: boolean): int
enableContentInspect(enabled: boolean, config: ContentInspectConfig): int
enableCustomAudioLocalPlayback(trackId: int, enabled: boolean): int
enableDualStreamMode(enabled: boolean): int
enableDualStreamMode(enabled: boolean, streamConfig: SimulcastStreamConfig): int
enableEncryption(enabled: boolean, config: EncryptionConfig): int
enableExtension(provider: String, extension: String, enable: boolean): int
enableFaceDetection(enabled: boolean): int
enableInEarMonitoring(enabled: boolean): int
enableInEarMonitoring(enabled: boolean, includeAudioFilters: int): int
enableInstantMediaRendering(): int
enableLocalAudio(enabled: boolean): int
enableLocalVideo(enabled: boolean): int
enableSoundPositionIndication(enabled: boolean): int
enableSpatialAudio(enabled: boolean): int
enableVideo(): int
enableVideoImageSource(enabled: boolean, options: ImageTrackOptions): int
enableVirtualBackground(enabled: boolean, backgroundSource: VirtualBackgroundSource, segproperty: SegmentationProperty): int
enableVirtualBackground(enabled: boolean, backgroundSource: VirtualBackgroundSource, segproperty: SegmentationProperty, sourceType: Constants.MediaSourceType): int
enableVoiceAITuner(enabled: boolean, type: Constants.VOICE_AI_TUNER_TYPE): int
enableWebSdkInteroperability(enabled: boolean): int
getAudioDeviceInfo(): DeviceInfo
getAudioEffectManager(): IAudioEffectManager
getAudioMixingCurrentPosition(): int
getAudioMixingDuration(): int
getAudioMixingPlayoutVolume(): int
getAudioMixingPublishVolume(): int
getAudioTrackCount(): int
getCallId(): String
getCameraMaxZoomFactor(): float
getConnectionState(): int
getCurrentMonotonicTimeInMs(): long
getEffectCurrentPosition(soundId: int): int
getEffectDuration(filePath: String): int
getEffectsVolume(): double
getErrorDescription(error: int): String
getExtensionProperty(provider: String, extension: String, key: String): String
getExtensionProperty(provider: String, extension: String, key: String, sourceType: Constants.MediaSourceType): String
getFaceShapeAreaOptions(shapeArea: int, sourceType: Constants.MediaSourceType): FaceShapeAreaOptions
getFaceShapeAreaOptions(shapeArea: int): FaceShapeAreaOptions
getFaceShapeBeautyOptions(sourceType: Constants.MediaSourceType): FaceShapeBeautyOptions
getFaceShapeBeautyOptions(): FaceShapeBeautyOptions
getNativeHandle(): long
getNetworkType(): int
getNtpWallTimeInMs(): long
getSdkVersion(): String
getUserInfoByUid(uid: int, userInfo: UserInfo): int
getUserInfoByUserAccount(userAccount: String, userInfo: UserInfo): int
getVolumeOfEffect(soundId: int): int
isCameraAutoFocusFaceModeSupported(): boolean
isCameraExposurePositionSupported(): boolean
isCameraExposureSupported(): boolean
isCameraFaceDetectSupported(): boolean
isCameraFocusSupported(): boolean
isCameraTorchSupported(): boolean
isCameraZoomSupported(): boolean
isFeatureAvailableOnDevice(type: int): boolean
isSpeakerphoneEnabled(): boolean
isTextureEncodeSupported(): boolean
joinChannel(token: String, channelId: String, optionalInfo: String, uid: int): int
joinChannel(token: String, channelId: String, uid: int, options: ChannelMediaOptions): int
joinChannelWithUserAccount(token: String, channelName: String, userAccount: String): int
joinChannelWithUserAccount(token: String, channelName: String, userAccount: String, options: ChannelMediaOptions): int
leaveChannel(): int
leaveChannel(options: LeaveChannelOptions): int
muteAllRemoteAudioStreams(muted: boolean): int
muteAllRemoteVideoStreams(muted: boolean): int
muteLocalAudioStream(muted: boolean): int
muteLocalVideoStream(muted: boolean): int
muteRecordingSignal(muted: boolean): int
muteRemoteAudioStream(uid: int, muted: boolean): int
muteRemoteVideoStream(uid: int, muted: boolean): int
pauseAllChannelMediaRelay(): int
pauseAllEffects(): int
pauseAudioMixing(): int
pauseEffect(soundId: int): int
playAllEffects(loopCount: int, pitch: double, pan: double, gain: double, publish: boolean): int
playEffect(soundId: int, filePath: String, loopCount: int, pitch: double, pan: double, gain: double, publish: boolean): int
playEffect(soundId: int, filePath: String, loopCount: int, pitch: double, pan: double, gain: double, publish: boolean, startPos: int): int
preloadChannel(token: String, channelName: String, optionalUid: int): int
preloadChannelWithUserAccount(token: String, channelName: String, userAccount: String): int
preloadEffect(soundId: int, filePath: String, startPos: int): int
preloadEffect(soundId: int, filePath: String): int
pullPlaybackAudioFrame(data: byte[], lengthInByte: int): int
pullPlaybackAudioFrame(data: ByteBuffer, lengthInByte: int): int
pushExternalAudioFrame(data: byte[], timestamp: long, sampleRate: int, channels: int, bytesPerSample: Constants.BytesPerSample, trackId: int): int
pushExternalVideoFrame(frame: VideoFrame): boolean
pushExternalVideoFrame(frame: AgoraVideoFrame): boolean
pushExternalVideoFrameById(frame: VideoFrame, videoTrackId: int): int
pushExternalVideoFrameById(frame: AgoraVideoFrame, videoTrackId: int): int
queryCameraFocalLengthCapability(): AgoraFocalLengthInfo[]
queryCodecCapability(): CodecCapInfo[]
queryDeviceScore(): int
queryScreenCaptureCapability(): int
rate(callId: String, rating: int, description: String): int
registerAudioEncodedFrameObserver(config: AudioEncodedFrameObserverConfig, observer: IAudioEncodedFrameObserver): int
registerAudioFrameObserver(observer: IAudioFrameObserver): int
registerAudioSpectrumObserver(observer: IAudioSpectrumObserver): int
registerExtension(provider: String, extension: String, sourceType: Constants.MediaSourceType): int
registerLocalUserAccount(appId: String, userAccount: String): int
registerMediaMetadataObserver(observer: IMetadataObserver, type: int): int
registerVideoEncodedFrameObserver(receiver: IVideoEncodedFrameObserver): int
registerVideoFrameObserver(observer: IVideoFrameObserver): int
removeHandler(handler: IRtcEngineEventHandler): void
removeVideoWatermark(id: String): int
renewToken(token: String): int
resumeAllChannelMediaRelay(): int
resumeAllEffects(): int
resumeAudioMixing(): int
resumeEffect(soundId: int): int
selectAudioTrack(audioIndex: int): int
sendCustomReportMessage(id: String, category: String, event: String, label: String, value: int): int
sendStreamMessage(streamId: int, message: byte[]): int
setAINSMode(enabled: boolean, mode: int): int
setAVSyncSource(channelId: String, uid: int): int
setAdvancedAudioOptions(options: AdvancedAudioOptions): int
setAudioEffectParameters(preset: int, param1: int, param2: int): int
setAudioEffectPreset(preset: int): int
setAudioMixingDualMonoMode(mode: Constants.AudioMixingDualMonoMode): int
setAudioMixingPitch(pitch: int): int
setAudioMixingPlaybackSpeed(speed: int): int
setAudioMixingPosition(pos: int): int
setAudioProfile(profile: int, scenario: int): int
setAudioProfile(profile: int): int
setAudioScenario(scenario: int): int
setBeautyEffectOptions(enabled: boolean, options: BeautyOptions): int
setBeautyEffectOptions(enabled: boolean, options: BeautyOptions, sourceType: Constants.MediaSourceType): int
setCameraAutoFocusFaceModeEnabled(enabled: boolean): int
setCameraCapturerConfiguration(config: CameraCapturerConfiguration): int
setCameraExposureFactor(factor: int): int
setCameraExposurePosition(positionXinView: float, positionYinView: float): int
setCameraFocusPositionInPreview(positionX: float, positionY: float): int
setCameraTorchOn(isOn: boolean): int
setCameraZoomFactor(factor: float): int
setChannelProfile(profile: int): int
setClientRole(role: int): int
setClientRole(role: int, options: ClientRoleOptions): int
setCloudProxy(proxyType: int): int
setColorEnhanceOptions(enabled: boolean, options: ColorEnhanceOptions): int
setColorEnhanceOptions(enabled: boolean, options: ColorEnhanceOptions, sourceType: Constants.MediaSourceType): int
setDefaultAudioRoutetoSpeakerphone(defaultToSpeaker: boolean): int
setDualStreamMode(mode: Constants.SimulcastStreamMode): int
setDualStreamMode(mode: Constants.SimulcastStreamMode, streamConfig: SimulcastStreamConfig): int
setEarMonitoringAudioFrameParameters(sampleRate: int, channel: int, mode: int, samplesPerCall: int): int
setEffectPosition(soundId: int, pos: int): int
setEffectsVolume(volume: double): int
setEnableSpeakerphone(enabled: boolean): int
setExtensionProperty(provider: String, extension: String, key: String, value: String): int
setExtensionProviderProperty(provider: String, key: String, value: String): int
setExternalAudioSink(enabled: boolean, sampleRate: int, channels: int): int
setExternalAudioSource(enabled: boolean, sampleRate: int, channels: int): int
setExternalAudioSource(enabled: boolean, sampleRate: int, channels: int, localPlayback: boolean, publish: boolean): int
setExternalMediaProjection(mediaProjection: MediaProjection): int
setExternalRemoteEglContext(eglContext: Object): int
setExternalVideoSource(enable: boolean, useTexture: boolean, sourceType: Constants.ExternalVideoSourceType): int
setFaceShapeAreaOptions(options: FaceShapeAreaOptions, sourceType: Constants.MediaSourceType): int
setFaceShapeAreaOptions(options: FaceShapeAreaOptions): int
setFaceShapeBeautyOptions(enabled: boolean, options: FaceShapeBeautyOptions, sourceType: Constants.MediaSourceType): int
setFaceShapeBeautyOptions(enabled: boolean, options: FaceShapeBeautyOptions): int
setFilterEffectOptions(enabled: boolean, options: FilterEffectOptions, sourceType: Constants.MediaSourceType): int
setFilterEffectOptions(enabled: boolean, options: FilterEffectOptions): int
setHeadphoneEQParameters(lowGain: int, highGain: int): int
setHeadphoneEQPreset(preset: int): int
setInEarMonitoringVolume(volume: int): int
setLocalAccessPoint(config: LocalAccessPointConfiguration): int
setLocalRenderMode(renderMode: int): int
setLocalRenderMode(renderMode: int, mirrorMode: int): int
setLocalRenderTargetFps(sourceType: Constants.VideoSourceType, targetFps: int): int
setLocalVideoMirrorMode(mode: int): int
setLocalVoiceEqualization(bandFrequency: Constants.AUDIO_EQUALIZATION_BAND_FREQUENCY, bandGain: int): int
setLocalVoiceFormant(formantRatio: double): int
setLocalVoicePitch(pitch: double): int
setLocalVoiceReverb(reverbKey: Constants.AUDIO_REVERB_TYPE, value: int): int
setLogFile(filePath: String): int
setLogFileSize(fileSizeInKBytes: long): int
setLogFilter(filter: int): int
setLogLevel(level: int): int
setLowlightEnhanceOptions(enabled: boolean, options: LowLightEnhanceOptions): int
setLowlightEnhanceOptions(enabled: boolean, options: LowLightEnhanceOptions, sourceType: Constants.MediaSourceType): int
setMixedAudioFrameParameters(sampleRate: int, channel: int, samplesPerCall: int): int
setParameters(parameters: String): int
setPlaybackAudioFrameBeforeMixingParameters(sampleRate: int, channel: int): int
setPlaybackAudioFrameBeforeMixingParameters(sampleRate: int, channel: int, samplesPerCall: int): int
setPlaybackAudioFrameParameters(sampleRate: int, channel: int, mode: int, samplesPerCall: int): int
setRecordingAudioFrameParameters(sampleRate: int, channel: int, mode: int, samplesPerCall: int): int
setRemoteDefaultVideoStreamType(streamType: Constants.VideoStreamType): int
setRemoteDefaultVideoStreamType(streamType: int): int
setRemoteRenderMode(uid: int, renderMode: int): int
setRemoteRenderTargetFps(targetFps: int): int
setRemoteSubscribeFallbackOption(option: Constants.StreamFallbackOptions): int
setRemoteSubscribeFallbackOption(option: int): int
setRemoteUserSpatialAudioParams(uid: int, params: SpatialAudioParams): int
setRemoteVideoStreamType(uid: int, streamType: Constants.VideoStreamType): int
setRemoteVideoStreamType(uid: int, streamType: int): int
setRemoteVideoSubscriptionOptions(uid: int, options: VideoSubscriptionOptions): int
setRemoteVoicePosition(uid: int, pan: double, gain: double): int
setRouteInCommunicationMode(route: int): int
setScreenCaptureScenario(screenScenario: Constants.ScreenScenarioType): int
setSubscribeAudioAllowlist(uidList: int[]): int
setSubscribeAudioBlocklist(uidList: int[]): int
setSubscribeVideoAllowlist(uidList: int[]): int
setSubscribeVideoBlocklist(uidList: int[]): int
setVideoDenoiserOptions(enabled: boolean, options: VideoDenoiserOptions): int
setVideoDenoiserOptions(enabled: boolean, options: VideoDenoiserOptions, sourceType: Constants.MediaSourceType): int
setVideoEncoderConfiguration(config: VideoEncoderConfiguration): int
setVideoScenario(scenarioType: Constants.VideoScenario): int
setVoiceBeautifierParameters(preset: int, param1: int, param2: int): int
setVoiceBeautifierPreset(preset: int): int
setVoiceConversionPreset(preset: int): int
setVolumeOfEffect(soundId: int, volume: double): int
setupLocalVideo(local: VideoCanvas): int
setupRemoteVideo(remote: VideoCanvas): int
startAudioMixing(filePath: String, loopback: boolean, cycle: int): int
startAudioMixing(filePath: String, loopback: boolean, cycle: int, startPos: int): int
startAudioRecording(filePath: String, quality: int): int
startAudioRecording(config: AudioRecordingConfiguration): int
startCameraCapture(sourceType: Constants.VideoSourceType, config: CameraCapturerConfiguration): int
startEchoTest(config: EchoTestConfiguration): int
startLastmileProbeTest(config: LastmileProbeConfig): int
startLocalAudioMixer(config: LocalAudioMixerConfiguration): int
startLocalVideoTranscoder(config: LocalTranscoderConfiguration): int
startMediaRenderingTracing(): int
startOrUpdateChannelMediaRelay(channelMediaRelayConfiguration: ChannelMediaRelayConfiguration): int
startPlaybackDeviceTest(audioFileName: String): int
startPreview(): int
startPreview(sourceType: Constants.VideoSourceType): int
startRecordingDeviceTest(indicationInterval: int): int
startRhythmPlayer(sound1: String, sound2: String, config: AgoraRhythmPlayerConfig): int
startRtmpStreamWithTranscoding(url: String, transcoding: LiveTranscoding): int
startRtmpStreamWithoutTranscoding(url: String): int
startScreenCapture(screenCaptureParameters: ScreenCaptureParameters): int
stopAllEffects(): int
stopAudioMixing(): int
stopAudioRecording(): int
stopCameraCapture(sourceType: Constants.VideoSourceType): int
stopChannelMediaRelay(): int
stopEchoTest(): int
stopEffect(soundId: int): int
stopLastmileProbeTest(): int
stopLocalAudioMixer(): int
stopLocalVideoTranscoder(): int
stopPlaybackDeviceTest(): int
stopPreview(): int
stopPreview(sourceType: Constants.VideoSourceType): int
stopRecordingDeviceTest(): int
stopRhythmPlayer(): int
stopRtmpStream(url: String): int
stopScreenCapture(): int
switchCamera(): int
switchCamera(cameraId: String): int
takeSnapshot(uid: int, filePath: String): int
takeSnapshot(uid: int, config: SnapshotConfig): int
unRegisterAudioSpectrumObserver(observer: IAudioSpectrumObserver): int
unloadEffect(soundId: int): int
unregisterMediaMetadataObserver(observer: IMetadataObserver, type: int): int
updateChannelMediaOptions(options: ChannelMediaOptions): int
updateLocalAudioMixerConfiguration(config: LocalAudioMixerConfiguration): int
updateLocalTranscoderConfiguration(config: LocalTranscoderConfiguration): int
updatePreloadChannelToken(token: String): int
updateRtmpTranscoding(transcoding: LiveTranscoding): int
updateScreenCaptureParameters(screenCaptureParameters: ScreenCaptureParameters): int

方法明细：256 / 256（参数、返回值、错误码）

方法	参数	返回值	错误
`addExtension`	`providerName: String`	`void`	错误码索引
`addHandler`	`handler: IRtcEngineEventHandler`	`void`	错误码索引
`addVideoWatermark`	`watermark: AgoraImage`	`int`	错误码索引
`adjustAudioMixingPlayoutVolume`	`volume: int`	`int`	错误码索引
`adjustAudioMixingPublishVolume`	`volume: int`	`int`	错误码索引
`adjustAudioMixingVolume`	`volume: int`	`int`	错误码索引
`adjustCustomAudioPlayoutVolume`	`trackId: int, volume: int`	`int`	错误码索引
`adjustCustomAudioPublishVolume`	`trackId: int, volume: int`	`int`	错误码索引
`adjustPlaybackSignalVolume`	`volume: int`	`int`	错误码索引
`adjustRecordingSignalVolume`	`volume: int`	`int`	错误码索引
`adjustUserPlaybackSignalVolume`	`uid: int, volume: int`	`int`	错误码索引
`clearVideoWatermarks`	—	`int`	错误码索引
`complain`	`callId: String, description: String`	`int`	错误码索引
`configRhythmPlayer`	`config: AgoraRhythmPlayerConfig`	`int`	错误码索引
`create`	`context: Context, appId: String, handler: IRtcEngineEventHandler`	`RtcEngine`	错误码索引
`createCustomAudioTrack`	`trackType: Constants.AudioTrackType, config: AudioTrackConfig`	`int`	错误码索引
`createCustomVideoTrack`	—	`int`	错误码索引
`createDataStream`	`reliable: boolean, ordered: boolean`	`int`	错误码索引
`createMediaPlayer`	—	`IMediaPlayer`	错误码索引
`createMediaRecorder`	`info: RecorderStreamInfo`	`AgoraMediaRecorder`	错误码索引
`createVideoEffectObject`	`bundlePath: String, sourceType: Constants.MediaSourceType`	`IVideoEffectObject`	错误码索引
`destroy`	—	`void`	错误码索引
`destroyCustomAudioTrack`	`trackId: int`	`int`	错误码索引
`destroyCustomVideoTrack`	`video_track_id: int`	`int`	错误码索引
`destroyMediaRecorder`	`mediaRecorder: AgoraMediaRecorder`	`void`	错误码索引
`destroyVideoEffectObject`	`videoEffectObject: IVideoEffectObject`	`int`	错误码索引
`disableAudio`	—	`int`	错误码索引
`disableAudioSpectrumMonitor`	—	`int`	错误码索引
`disableVideo`	—	`int`	错误码索引
`enableAudio`	—	`int`	错误码索引
`enableAudioSpectrumMonitor`	`intervalInMS: int`	`int`	错误码索引
`enableAudioVolumeIndication`	`interval: int, smooth: int, reportVad: boolean`	`int`	错误码索引
`enableContentInspect`	`enabled: boolean, config: ContentInspectConfig`	`int`	错误码索引
`enableCustomAudioLocalPlayback`	`trackId: int, enabled: boolean`	`int`	错误码索引
`enableDualStreamMode`	`enabled: boolean`	`int`	错误码索引
`enableEncryption`	`enabled: boolean, config: EncryptionConfig`	`int`	错误码索引
`enableExtension`	`provider: String, extension: String, enable: boolean`	`int`	错误码索引
`enableFaceDetection`	`enabled: boolean`	`int`	错误码索引
`enableInEarMonitoring`	`enabled: boolean`	`int`	错误码索引
`enableInstantMediaRendering`	—	`int`	错误码索引
`enableLocalAudio`	`enabled: boolean`	`int`	错误码索引
`enableLocalVideo`	`enabled: boolean`	`int`	错误码索引
`enableSoundPositionIndication`	`enabled: boolean`	`int`	错误码索引
`enableSpatialAudio`	`enabled: boolean`	`int`	错误码索引
`enableVideo`	—	`int`	错误码索引
`enableVideoImageSource`	`enabled: boolean, options: ImageTrackOptions`	`int`	错误码索引
`enableVirtualBackground`	`enabled: boolean, backgroundSource: VirtualBackgroundSource, segproperty: SegmentationProperty`	`int`	错误码索引
`enableVoiceAITuner`	`enabled: boolean, type: Constants.VOICE_AI_TUNER_TYPE`	`int`	错误码索引
`enableWebSdkInteroperability`	`enabled: boolean`	`int`	错误码索引
`getAudioDeviceInfo`	—	`DeviceInfo`	错误码索引
`getAudioEffectManager`	—	`IAudioEffectManager`	错误码索引
`getAudioMixingCurrentPosition`	—	`int`	错误码索引
`getAudioMixingDuration`	—	`int`	错误码索引
`getAudioMixingPlayoutVolume`	—	`int`	错误码索引
`getAudioMixingPublishVolume`	—	`int`	错误码索引
`getAudioTrackCount`	—	`int`	错误码索引
`getCallId`	—	`String`	错误码索引
`getCameraMaxZoomFactor`	—	`float`	错误码索引
`getConnectionState`	—	`int`	错误码索引
`getCurrentMonotonicTimeInMs`	—	`long`	错误码索引
`getEffectCurrentPosition`	`soundId: int`	`int`	错误码索引
`getEffectDuration`	`filePath: String`	`int`	错误码索引
`getEffectsVolume`	—	`double`	错误码索引
`getErrorDescription`	`error: int`	`String`	错误码索引
`getExtensionProperty`	`provider: String, extension: String, key: String`	`String`	错误码索引
`getFaceShapeAreaOptions`	`shapeArea: int, sourceType: Constants.MediaSourceType`	`FaceShapeAreaOptions`	错误码索引
`getFaceShapeBeautyOptions`	`sourceType: Constants.MediaSourceType`	`FaceShapeBeautyOptions`	错误码索引
`getNativeHandle`	—	`long`	错误码索引
`getNetworkType`	—	`int`	错误码索引
`getNtpWallTimeInMs`	—	`long`	错误码索引
`getSdkVersion`	—	`String`	错误码索引
`getUserInfoByUid`	`uid: int, userInfo: UserInfo`	`int`	错误码索引
`getUserInfoByUserAccount`	`userAccount: String, userInfo: UserInfo`	`int`	错误码索引
`getVolumeOfEffect`	`soundId: int`	`int`	错误码索引
`isCameraAutoFocusFaceModeSupported`	—	`boolean`	错误码索引
`isCameraExposurePositionSupported`	—	`boolean`	错误码索引
`isCameraExposureSupported`	—	`boolean`	错误码索引
`isCameraFaceDetectSupported`	—	`boolean`	错误码索引
`isCameraFocusSupported`	—	`boolean`	错误码索引
`isCameraTorchSupported`	—	`boolean`	错误码索引
`isCameraZoomSupported`	—	`boolean`	错误码索引
`isFeatureAvailableOnDevice`	`type: int`	`boolean`	错误码索引
`isSpeakerphoneEnabled`	—	`boolean`	错误码索引
`isTextureEncodeSupported`	—	`boolean`	错误码索引
`joinChannel`	`token: String, channelId: String, optionalInfo: String, uid: int`	`int`	错误码索引
`joinChannelWithUserAccount`	`token: String, channelName: String, userAccount: String`	`int`	错误码索引
`leaveChannel`	—	`int`	错误码索引
`muteAllRemoteAudioStreams`	`muted: boolean`	`int`	错误码索引
`muteAllRemoteVideoStreams`	`muted: boolean`	`int`	错误码索引
`muteLocalAudioStream`	`muted: boolean`	`int`	错误码索引
`muteLocalVideoStream`	`muted: boolean`	`int`	错误码索引
`muteRecordingSignal`	`muted: boolean`	`int`	错误码索引
`muteRemoteAudioStream`	`uid: int, muted: boolean`	`int`	错误码索引
`muteRemoteVideoStream`	`uid: int, muted: boolean`	`int`	错误码索引
`pauseAllChannelMediaRelay`	—	`int`	错误码索引
`pauseAllEffects`	—	`int`	错误码索引
`pauseAudioMixing`	—	`int`	错误码索引
`pauseEffect`	`soundId: int`	`int`	错误码索引
`playAllEffects`	`loopCount: int, pitch: double, pan: double, gain: double, publish: boolean`	`int`	错误码索引
`playEffect`	`soundId: int, filePath: String, loopCount: int, pitch: double, pan: double, gain: double, publish: boolean`	`int`	错误码索引
`preloadChannel`	`token: String, channelName: String, optionalUid: int`	`int`	错误码索引
`preloadChannelWithUserAccount`	`token: String, channelName: String, userAccount: String`	`int`	错误码索引
`preloadEffect`	`soundId: int, filePath: String, startPos: int`	`int`	错误码索引
`pullPlaybackAudioFrame`	`data: byte[], lengthInByte: int`	`int`	错误码索引
`pushExternalAudioFrame`	`data: byte[], timestamp: long, sampleRate: int, channels: int, bytesPerSample: Constants.BytesPerSample, trackId: int`	`int`	错误码索引
`pushExternalVideoFrame`	`frame: VideoFrame`	`boolean`	错误码索引
`pushExternalVideoFrameById`	`frame: VideoFrame, videoTrackId: int`	`int`	错误码索引
`queryCameraFocalLengthCapability`	—	`AgoraFocalLengthInfo[]`	错误码索引
`queryCodecCapability`	—	`CodecCapInfo[]`	错误码索引
`queryDeviceScore`	—	`int`	错误码索引
`queryScreenCaptureCapability`	—	`int`	错误码索引
`rate`	`callId: String, rating: int, description: String`	`int`	错误码索引
`registerAudioEncodedFrameObserver`	`config: AudioEncodedFrameObserverConfig, observer: IAudioEncodedFrameObserver`	`int`	错误码索引
`registerAudioFrameObserver`	`observer: IAudioFrameObserver`	`int`	错误码索引
`registerAudioSpectrumObserver`	`observer: IAudioSpectrumObserver`	`int`	错误码索引
`registerExtension`	`provider: String, extension: String, sourceType: Constants.MediaSourceType`	`int`	错误码索引
`registerLocalUserAccount`	`appId: String, userAccount: String`	`int`	错误码索引
`registerMediaMetadataObserver`	`observer: IMetadataObserver, type: int`	`int`	错误码索引
`registerVideoEncodedFrameObserver`	`receiver: IVideoEncodedFrameObserver`	`int`	错误码索引
`registerVideoFrameObserver`	`observer: IVideoFrameObserver`	`int`	错误码索引
`removeHandler`	`handler: IRtcEngineEventHandler`	`void`	错误码索引
`removeVideoWatermark`	`id: String`	`int`	错误码索引
`renewToken`	`token: String`	`int`	错误码索引
`resumeAllChannelMediaRelay`	—	`int`	错误码索引
`resumeAllEffects`	—	`int`	错误码索引
`resumeAudioMixing`	—	`int`	错误码索引
`resumeEffect`	`soundId: int`	`int`	错误码索引
`selectAudioTrack`	`audioIndex: int`	`int`	错误码索引
`sendCustomReportMessage`	`id: String, category: String, event: String, label: String, value: int`	`int`	错误码索引
`sendStreamMessage`	`streamId: int, message: byte[]`	`int`	错误码索引
`setAINSMode`	`enabled: boolean, mode: int`	`int`	错误码索引
`setAVSyncSource`	`channelId: String, uid: int`	`int`	错误码索引
`setAdvancedAudioOptions`	`options: AdvancedAudioOptions`	`int`	错误码索引
`setAudioEffectParameters`	`preset: int, param1: int, param2: int`	`int`	错误码索引
`setAudioEffectPreset`	`preset: int`	`int`	错误码索引
`setAudioMixingDualMonoMode`	`mode: Constants.AudioMixingDualMonoMode`	`int`	错误码索引
`setAudioMixingPitch`	`pitch: int`	`int`	错误码索引
`setAudioMixingPlaybackSpeed`	`speed: int`	`int`	错误码索引
`setAudioMixingPosition`	`pos: int`	`int`	错误码索引
`setAudioProfile`	`profile: int, scenario: int`	`int`	错误码索引
`setAudioScenario`	`scenario: int`	`int`	错误码索引
`setBeautyEffectOptions`	`enabled: boolean, options: BeautyOptions`	`int`	错误码索引
`setCameraAutoFocusFaceModeEnabled`	`enabled: boolean`	`int`	错误码索引
`setCameraCapturerConfiguration`	`config: CameraCapturerConfiguration`	`int`	错误码索引
`setCameraExposureFactor`	`factor: int`	`int`	错误码索引
`setCameraExposurePosition`	`positionXinView: float, positionYinView: float`	`int`	错误码索引
`setCameraFocusPositionInPreview`	`positionX: float, positionY: float`	`int`	错误码索引
`setCameraTorchOn`	`isOn: boolean`	`int`	错误码索引
`setCameraZoomFactor`	`factor: float`	`int`	错误码索引
`setChannelProfile`	`profile: int`	`int`	错误码索引
`setClientRole`	`role: int`	`int`	错误码索引
`setCloudProxy`	`proxyType: int`	`int`	错误码索引
`setColorEnhanceOptions`	`enabled: boolean, options: ColorEnhanceOptions`	`int`	错误码索引
`setDefaultAudioRoutetoSpeakerphone`	`defaultToSpeaker: boolean`	`int`	错误码索引
`setDualStreamMode`	`mode: Constants.SimulcastStreamMode`	`int`	错误码索引
`setEarMonitoringAudioFrameParameters`	`sampleRate: int, channel: int, mode: int, samplesPerCall: int`	`int`	错误码索引
`setEffectPosition`	`soundId: int, pos: int`	`int`	错误码索引
`setEffectsVolume`	`volume: double`	`int`	错误码索引
`setEnableSpeakerphone`	`enabled: boolean`	`int`	错误码索引
`setExtensionProperty`	`provider: String, extension: String, key: String, value: String`	`int`	错误码索引
`setExtensionProviderProperty`	`provider: String, key: String, value: String`	`int`	错误码索引
`setExternalAudioSink`	`enabled: boolean, sampleRate: int, channels: int`	`int`	错误码索引
`setExternalAudioSource`	`enabled: boolean, sampleRate: int, channels: int`	`int`	错误码索引
`setExternalMediaProjection`	`mediaProjection: MediaProjection`	`int`	错误码索引
`setExternalRemoteEglContext`	`eglContext: Object`	`int`	错误码索引
`setExternalVideoSource`	`enable: boolean, useTexture: boolean, sourceType: Constants.ExternalVideoSourceType`	`int`	错误码索引
`setFaceShapeAreaOptions`	`options: FaceShapeAreaOptions, sourceType: Constants.MediaSourceType`	`int`	错误码索引
`setFaceShapeBeautyOptions`	`enabled: boolean, options: FaceShapeBeautyOptions, sourceType: Constants.MediaSourceType`	`int`	错误码索引
`setFilterEffectOptions`	`enabled: boolean, options: FilterEffectOptions, sourceType: Constants.MediaSourceType`	`int`	错误码索引
`setHeadphoneEQParameters`	`lowGain: int, highGain: int`	`int`	错误码索引
`setHeadphoneEQPreset`	`preset: int`	`int`	错误码索引
`setInEarMonitoringVolume`	`volume: int`	`int`	错误码索引
`setLocalAccessPoint`	`config: LocalAccessPointConfiguration`	`int`	错误码索引
`setLocalRenderMode`	`renderMode: int`	`int`	错误码索引
`setLocalRenderTargetFps`	`sourceType: Constants.VideoSourceType, targetFps: int`	`int`	错误码索引
`setLocalVideoMirrorMode`	`mode: int`	`int`	错误码索引
`setLocalVoiceEqualization`	`bandFrequency: Constants.AUDIO_EQUALIZATION_BAND_FREQUENCY, bandGain: int`	`int`	错误码索引
`setLocalVoiceFormant`	`formantRatio: double`	`int`	错误码索引
`setLocalVoicePitch`	`pitch: double`	`int`	错误码索引
`setLocalVoiceReverb`	`reverbKey: Constants.AUDIO_REVERB_TYPE, value: int`	`int`	错误码索引
`setLogFile`	`filePath: String`	`int`	错误码索引
`setLogFileSize`	`fileSizeInKBytes: long`	`int`	错误码索引
`setLogFilter`	`filter: int`	`int`	错误码索引
`setLogLevel`	`level: int`	`int`	错误码索引
`setLowlightEnhanceOptions`	`enabled: boolean, options: LowLightEnhanceOptions`	`int`	错误码索引
`setMixedAudioFrameParameters`	`sampleRate: int, channel: int, samplesPerCall: int`	`int`	错误码索引
`setParameters`	`parameters: String`	`int`	错误码索引
`setPlaybackAudioFrameBeforeMixingParameters`	`sampleRate: int, channel: int`	`int`	错误码索引
`setPlaybackAudioFrameParameters`	`sampleRate: int, channel: int, mode: int, samplesPerCall: int`	`int`	错误码索引
`setRecordingAudioFrameParameters`	`sampleRate: int, channel: int, mode: int, samplesPerCall: int`	`int`	错误码索引
`setRemoteDefaultVideoStreamType`	`streamType: Constants.VideoStreamType`	`int`	错误码索引
`setRemoteRenderMode`	`uid: int, renderMode: int`	`int`	错误码索引
`setRemoteRenderTargetFps`	`targetFps: int`	`int`	错误码索引
`setRemoteSubscribeFallbackOption`	`option: Constants.StreamFallbackOptions`	`int`	错误码索引
`setRemoteUserSpatialAudioParams`	`uid: int, params: SpatialAudioParams`	`int`	错误码索引
`setRemoteVideoStreamType`	`uid: int, streamType: Constants.VideoStreamType`	`int`	错误码索引
`setRemoteVideoSubscriptionOptions`	`uid: int, options: VideoSubscriptionOptions`	`int`	错误码索引
`setRemoteVoicePosition`	`uid: int, pan: double, gain: double`	`int`	错误码索引
`setRouteInCommunicationMode`	`route: int`	`int`	错误码索引
`setScreenCaptureScenario`	`screenScenario: Constants.ScreenScenarioType`	`int`	错误码索引
`setSubscribeAudioAllowlist`	`uidList: int[]`	`int`	错误码索引
`setSubscribeAudioBlocklist`	`uidList: int[]`	`int`	错误码索引
`setSubscribeVideoAllowlist`	`uidList: int[]`	`int`	错误码索引
`setSubscribeVideoBlocklist`	`uidList: int[]`	`int`	错误码索引
`setVideoDenoiserOptions`	`enabled: boolean, options: VideoDenoiserOptions`	`int`	错误码索引
`setVideoEncoderConfiguration`	`config: VideoEncoderConfiguration`	`int`	错误码索引
`setVideoScenario`	`scenarioType: Constants.VideoScenario`	`int`	错误码索引
`setVoiceBeautifierParameters`	`preset: int, param1: int, param2: int`	`int`	错误码索引
`setVoiceBeautifierPreset`	`preset: int`	`int`	错误码索引
`setVoiceConversionPreset`	`preset: int`	`int`	错误码索引
`setVolumeOfEffect`	`soundId: int, volume: double`	`int`	错误码索引
`setupLocalVideo`	`local: VideoCanvas`	`int`	错误码索引
`setupRemoteVideo`	`remote: VideoCanvas`	`int`	错误码索引
`startAudioMixing`	`filePath: String, loopback: boolean, cycle: int`	`int`	错误码索引
`startAudioRecording`	`filePath: String, quality: int`	`int`	错误码索引
`startCameraCapture`	`sourceType: Constants.VideoSourceType, config: CameraCapturerConfiguration`	`int`	错误码索引
`startEchoTest`	`config: EchoTestConfiguration`	`int`	错误码索引
`startLastmileProbeTest`	`config: LastmileProbeConfig`	`int`	错误码索引
`startLocalAudioMixer`	`config: LocalAudioMixerConfiguration`	`int`	错误码索引
`startLocalVideoTranscoder`	`config: LocalTranscoderConfiguration`	`int`	错误码索引
`startMediaRenderingTracing`	—	`int`	错误码索引
`startOrUpdateChannelMediaRelay`	`channelMediaRelayConfiguration: ChannelMediaRelayConfiguration`	`int`	错误码索引
`startPlaybackDeviceTest`	`audioFileName: String`	`int`	错误码索引
`startPreview`	—	`int`	错误码索引
`startRecordingDeviceTest`	`indicationInterval: int`	`int`	错误码索引
`startRhythmPlayer`	`sound1: String, sound2: String, config: AgoraRhythmPlayerConfig`	`int`	错误码索引
`startRtmpStreamWithTranscoding`	`url: String, transcoding: LiveTranscoding`	`int`	错误码索引
`startRtmpStreamWithoutTranscoding`	`url: String`	`int`	错误码索引
`startScreenCapture`	`screenCaptureParameters: ScreenCaptureParameters`	`int`	错误码索引
`stopAllEffects`	—	`int`	错误码索引
`stopAudioMixing`	—	`int`	错误码索引
`stopAudioRecording`	—	`int`	错误码索引
`stopCameraCapture`	`sourceType: Constants.VideoSourceType`	`int`	错误码索引
`stopChannelMediaRelay`	—	`int`	错误码索引
`stopEchoTest`	—	`int`	错误码索引
`stopEffect`	`soundId: int`	`int`	错误码索引
`stopLastmileProbeTest`	—	`int`	错误码索引
`stopLocalAudioMixer`	—	`int`	错误码索引
`stopLocalVideoTranscoder`	—	`int`	错误码索引
`stopPlaybackDeviceTest`	—	`int`	错误码索引
`stopPreview`	—	`int`	错误码索引
`stopRecordingDeviceTest`	—	`int`	错误码索引
`stopRhythmPlayer`	—	`int`	错误码索引
`stopRtmpStream`	`url: String`	`int`	错误码索引
`stopScreenCapture`	—	`int`	错误码索引
`switchCamera`	—	`int`	错误码索引
`takeSnapshot`	`uid: int, filePath: String`	`int`	错误码索引
`unRegisterAudioSpectrumObserver`	`observer: IAudioSpectrumObserver`	`int`	错误码索引
`unloadEffect`	`soundId: int`	`int`	错误码索引
`unregisterMediaMetadataObserver`	`observer: IMetadataObserver, type: int`	`int`	错误码索引
`updateChannelMediaOptions`	`options: ChannelMediaOptions`	`int`	错误码索引
`updateLocalAudioMixerConfiguration`	`config: LocalAudioMixerConfiguration`	`int`	错误码索引
`updateLocalTranscoderConfiguration`	`config: LocalTranscoderConfiguration`	`int`	错误码索引
`updatePreloadChannelToken`	`token: String`	`int`	错误码索引
`updateRtmpTranscoding`	`transcoding: LiveTranscoding`	`int`	错误码索引
`updateScreenCaptureParameters`	`screenCaptureParameters: ScreenCaptureParameters`	`int`	错误码索引

RtcEngineConfig 0 方法 / 14 属性

属性	类型	只读
`mEventHandler`	`IRtcEngineEventHandler`	否
`mContext`	`Context`	否
`mAppId`	`String`	否
`mAreaCode`	`int`	否
`mChannelProfile`	`int`	否
`mLicense`	`String`	否
`mAudioScenario`	`int`	否
`mAutoRegisterAgoraExtensions`	`boolean`	否
`mExtensionList`	`List`	否
`mExtensionObserver`	`IMediaExtensionObserver`	否
`mLogConfig`	`LogConfig`	否
`mThreadPriority`	`Integer`	否
`mNativeLibPath`	`String`	否
`mDomainLimit`	`boolean`	否

RtcEngineEx 48 方法 / 0 属性

typescript

addVideoWatermarkEx(watermarkUrl: String, options: WatermarkOptions, connection: RtcConnection): int
addVideoWatermarkEx(config: WatermarkConfig, connection: RtcConnection): int
adjustUserPlaybackSignalVolumeEx(uid: int, volume: int, connection: RtcConnection): int
clearVideoWatermarkEx(connection: RtcConnection): int
createDataStreamEx(reliable: boolean, ordered: boolean, connection: RtcConnection): int
createDataStreamEx(config: DataStreamConfig, connection: RtcConnection): int
enableAudioVolumeIndicationEx(interval: int, smooth: int, reportVad: boolean, connection: RtcConnection): int
enableContentInspectEx(enabled: boolean, config: ContentInspectConfig, connection: RtcConnection): int
enableDualStreamModeEx(enabled: boolean, streamConfig: SimulcastStreamConfig, connection: RtcConnection): int
enableEncryptionEx(enabled: boolean, config: EncryptionConfig, connection: RtcConnection): int
getCallIdEx(connection: RtcConnection): String
getConnectionStateEx(connection: RtcConnection): int
getUserInfoByUidEx(uid: int, userInfo: UserInfo, connection: RtcConnection): int
getUserInfoByUserAccountEx(userAccount: String, userInfo: UserInfo, connection: RtcConnection): int
joinChannelEx(token: String, connection: RtcConnection, options: ChannelMediaOptions, eventHandler: IRtcEngineEventHandler): int
joinChannelWithUserAccountEx(token: String, channelId: String, userAccount: String, options: ChannelMediaOptions, eventHandler: IRtcEngineEventHandler): int
leaveChannelEx(connection: RtcConnection): int
leaveChannelEx(connection: RtcConnection, options: LeaveChannelOptions): int
muteAllRemoteAudioStreamsEx(muted: boolean, connection: RtcConnection): int
muteAllRemoteVideoStreamsEx(muted: boolean, connection: RtcConnection): int
muteLocalAudioStreamEx(muted: boolean, connection: RtcConnection): int
muteLocalVideoStreamEx(muted: boolean, connection: RtcConnection): int
muteRemoteAudioStreamEx(uid: int, muted: boolean, connection: RtcConnection): int
muteRemoteVideoStreamEx(uid: int, muted: boolean, connection: RtcConnection): int
pauseAllChannelMediaRelayEx(connection: RtcConnection): int
playEffectEx(connection: RtcConnection, soundId: int, filePath: String, loopCount: int, pitch: double, pan: double, gain: double, publish: boolean, startPos: int): int
playEffectEx(connection: RtcConnection, soundId: int, filePath: String, loopCount: int, pitch: double, pan: double, gain: double, publish: boolean): int
preloadEffectEx(connection: RtcConnection, soundId: int, filePath: String, startPos: int): int
preloadEffectEx(connection: RtcConnection, soundId: int, filePath: String): int
removeVideoWatermarkEx(id: String, connection: RtcConnection): int
resumeAllChannelMediaRelayEx(connection: RtcConnection): int
sendCustomReportMessageEx(id: String, category: String, event: String, label: String, value: int, connection: RtcConnection): int
sendStreamMessageEx(streamId: int, message: byte[], connection: RtcConnection): int
setDualStreamModeEx(mode: Constants.SimulcastStreamMode, streamConfig: SimulcastStreamConfig, connection: RtcConnection): int
setRemoteRenderModeEx(uid: int, renderMode: int, mirrorMode: int, connection: RtcConnection): int
setRemoteVideoStreamTypeEx(uid: int, streamType: Constants.VideoStreamType, connection: RtcConnection): int
setRemoteVideoStreamTypeEx(uid: int, streamType: int, connection: RtcConnection): int
setRemoteVideoSubscriptionOptionsEx(uid: int, options: VideoSubscriptionOptions, rtcConnection: RtcConnection): int
setRemoteVoicePositionEx(uid: int, pan: double, gain: double, connection: RtcConnection): int
setSubscribeAudioAllowlistEx(uidList: int[], connection: RtcConnection): int
setSubscribeAudioBlocklistEx(uidList: int[], connection: RtcConnection): int
setSubscribeVideoAllowlistEx(uidList: int[], connection: RtcConnection): int
setSubscribeVideoBlocklistEx(uidList: int[], connection: RtcConnection): int
setVideoEncoderConfigurationEx(config: VideoEncoderConfiguration, connection: RtcConnection): int
setupRemoteVideoEx(remote: VideoCanvas, connection: RtcConnection): int
startMediaRenderingTracingEx(connection: RtcConnection): int
startOrUpdateChannelMediaRelayEx(channelMediaRelayConfiguration: ChannelMediaRelayConfiguration, connection: RtcConnection): int
startRtmpStreamWithTranscodingEx(url: String, transcoding: LiveTranscoding, connection: RtcConnection): int
startRtmpStreamWithoutTranscodingEx(url: String, connection: RtcConnection): int
stopChannelMediaRelayEx(connection: RtcConnection): int
stopRtmpStreamEx(url: String, connection: RtcConnection): int
takeSnapshotEx(connection: RtcConnection, uid: int, filePath: String): int
takeSnapshotEx(connection: RtcConnection, uid: int, config: SnapshotConfig): int
updateChannelMediaOptionsEx(options: ChannelMediaOptions, connection: RtcConnection): int
updateRtmpTranscodingEx(transcoding: LiveTranscoding, connection: RtcConnection): int

方法明细：48 / 48（参数、返回值、错误码）

方法	参数	返回值	错误
`addVideoWatermarkEx`	`watermarkUrl: String, options: WatermarkOptions, connection: RtcConnection`	`int`	错误码索引
`adjustUserPlaybackSignalVolumeEx`	`uid: int, volume: int, connection: RtcConnection`	`int`	错误码索引
`clearVideoWatermarkEx`	`connection: RtcConnection`	`int`	错误码索引
`createDataStreamEx`	`reliable: boolean, ordered: boolean, connection: RtcConnection`	`int`	错误码索引
`enableAudioVolumeIndicationEx`	`interval: int, smooth: int, reportVad: boolean, connection: RtcConnection`	`int`	错误码索引
`enableContentInspectEx`	`enabled: boolean, config: ContentInspectConfig, connection: RtcConnection`	`int`	错误码索引
`enableDualStreamModeEx`	`enabled: boolean, streamConfig: SimulcastStreamConfig, connection: RtcConnection`	`int`	错误码索引
`enableEncryptionEx`	`enabled: boolean, config: EncryptionConfig, connection: RtcConnection`	`int`	错误码索引
`getCallIdEx`	`connection: RtcConnection`	`String`	错误码索引
`getConnectionStateEx`	`connection: RtcConnection`	`int`	错误码索引
`getUserInfoByUidEx`	`uid: int, userInfo: UserInfo, connection: RtcConnection`	`int`	错误码索引
`getUserInfoByUserAccountEx`	`userAccount: String, userInfo: UserInfo, connection: RtcConnection`	`int`	错误码索引
`joinChannelEx`	`token: String, connection: RtcConnection, options: ChannelMediaOptions, eventHandler: IRtcEngineEventHandler`	`int`	错误码索引
`joinChannelWithUserAccountEx`	`token: String, channelId: String, userAccount: String, options: ChannelMediaOptions, eventHandler: IRtcEngineEventHandler`	`int`	错误码索引
`leaveChannelEx`	`connection: RtcConnection`	`int`	错误码索引
`muteAllRemoteAudioStreamsEx`	`muted: boolean, connection: RtcConnection`	`int`	错误码索引
`muteAllRemoteVideoStreamsEx`	`muted: boolean, connection: RtcConnection`	`int`	错误码索引
`muteLocalAudioStreamEx`	`muted: boolean, connection: RtcConnection`	`int`	错误码索引
`muteLocalVideoStreamEx`	`muted: boolean, connection: RtcConnection`	`int`	错误码索引
`muteRemoteAudioStreamEx`	`uid: int, muted: boolean, connection: RtcConnection`	`int`	错误码索引
`muteRemoteVideoStreamEx`	`uid: int, muted: boolean, connection: RtcConnection`	`int`	错误码索引
`pauseAllChannelMediaRelayEx`	`connection: RtcConnection`	`int`	错误码索引
`playEffectEx`	`connection: RtcConnection, soundId: int, filePath: String, loopCount: int, pitch: double, pan: double, gain: double, publish: boolean, startPos: int`	`int`	错误码索引
`preloadEffectEx`	`connection: RtcConnection, soundId: int, filePath: String, startPos: int`	`int`	错误码索引
`removeVideoWatermarkEx`	`id: String, connection: RtcConnection`	`int`	错误码索引
`resumeAllChannelMediaRelayEx`	`connection: RtcConnection`	`int`	错误码索引
`sendCustomReportMessageEx`	`id: String, category: String, event: String, label: String, value: int, connection: RtcConnection`	`int`	错误码索引
`sendStreamMessageEx`	`streamId: int, message: byte[], connection: RtcConnection`	`int`	错误码索引
`setDualStreamModeEx`	`mode: Constants.SimulcastStreamMode, streamConfig: SimulcastStreamConfig, connection: RtcConnection`	`int`	错误码索引
`setRemoteRenderModeEx`	`uid: int, renderMode: int, mirrorMode: int, connection: RtcConnection`	`int`	错误码索引
`setRemoteVideoStreamTypeEx`	`uid: int, streamType: Constants.VideoStreamType, connection: RtcConnection`	`int`	错误码索引
`setRemoteVideoSubscriptionOptionsEx`	`uid: int, options: VideoSubscriptionOptions, rtcConnection: RtcConnection`	`int`	错误码索引
`setRemoteVoicePositionEx`	`uid: int, pan: double, gain: double, connection: RtcConnection`	`int`	错误码索引
`setSubscribeAudioAllowlistEx`	`uidList: int[], connection: RtcConnection`	`int`	错误码索引
`setSubscribeAudioBlocklistEx`	`uidList: int[], connection: RtcConnection`	`int`	错误码索引
`setSubscribeVideoAllowlistEx`	`uidList: int[], connection: RtcConnection`	`int`	错误码索引
`setSubscribeVideoBlocklistEx`	`uidList: int[], connection: RtcConnection`	`int`	错误码索引
`setVideoEncoderConfigurationEx`	`config: VideoEncoderConfiguration, connection: RtcConnection`	`int`	错误码索引
`setupRemoteVideoEx`	`remote: VideoCanvas, connection: RtcConnection`	`int`	错误码索引
`startMediaRenderingTracingEx`	`connection: RtcConnection`	`int`	错误码索引
`startOrUpdateChannelMediaRelayEx`	`channelMediaRelayConfiguration: ChannelMediaRelayConfiguration, connection: RtcConnection`	`int`	错误码索引
`startRtmpStreamWithTranscodingEx`	`url: String, transcoding: LiveTranscoding, connection: RtcConnection`	`int`	错误码索引
`startRtmpStreamWithoutTranscodingEx`	`url: String, connection: RtcConnection`	`int`	错误码索引
`stopChannelMediaRelayEx`	`connection: RtcConnection`	`int`	错误码索引
`stopRtmpStreamEx`	`url: String, connection: RtcConnection`	`int`	错误码索引
`takeSnapshotEx`	`connection: RtcConnection, uid: int, filePath: String`	`int`	错误码索引
`updateChannelMediaOptionsEx`	`options: ChannelMediaOptions, connection: RtcConnection`	`int`	错误码索引
`updateRtmpTranscodingEx`	`transcoding: LiveTranscoding, connection: RtcConnection`	`int`	错误码索引

RtcStats 0 方法 / 24 属性

属性	类型	只读
`totalDuration`	`int`	否
`txBytes`	`int`	否
`rxBytes`	`int`	否
`txKBitRate`	`int`	否
`txAudioBytes`	`int`	否
`rxAudioBytes`	`int`	否
`txVideoBytes`	`int`	否
`rxVideoBytes`	`int`	否
`rxKBitRate`	`int`	否
`txAudioKBitRate`	`int`	否
`rxAudioKBitRate`	`int`	否
`txVideoKBitRate`	`int`	否
`rxVideoKBitRate`	`int`	否
`lastmileDelay`	`int`	否
`cpuTotalUsage`	`double`	否
`gatewayRtt`	`int`	否
`cpuAppUsage`	`double`	否
`users`	`int`	否
`connectTimeMs`	`int`	否
`txPacketLossRate`	`int`	否
`rxPacketLossRate`	`int`	否
`memoryAppUsageRatio`	`double`	否
`memoryTotalUsageRatio`	`double`	否
`memoryAppUsageInKbytes`	`int`	否

Rte 6 方法 / 0 属性

typescript

Rte(initialConfig: InitialConfig): unknown
destroy(): void
getConfigs(config: Config): void
getFromBridge(): Rte
initMediaEngine(callBack: AsyncCallback): void
setConfigs(config: Config): void

方法明细：6 / 6（参数、返回值、错误码）

方法	参数	返回值	错误
`Rte`	`initialConfig: InitialConfig`	`unknown`	错误码索引
`destroy`	—	`void`	错误码索引
`getConfigs`	`config: Config`	`void`	错误码索引
`getFromBridge`	—	`Rte`	错误码索引
`initMediaEngine`	`callBack: AsyncCallback`	`void`	错误码索引
`setConfigs`	`config: Config`	`void`	错误码索引

RteException 1 方法 / 1 属性

typescript

errorCode(): Constants.ErrorCode

方法明细：1 / 1（参数、返回值、错误码）

方法	参数	返回值	错误
`errorCode`	—	`Constants.ErrorCode`	错误码索引

属性	类型	只读
`mErrorCode`	`int`	否

ScreenCaptureParameters 0 方法 / 4 属性

属性	类型	只读
`captureAudio`	`boolean`	否
`videoCaptureParameters`	`VideoCaptureParameters`	否
`captureVideo`	`boolean`	否
`audioCaptureParameters`	`AudioCaptureParameters`	否

SegmentationProperty 0 方法 / 8 属性

属性	类型	只读
`SEG_MODEL_AI`	`int`	否
`SEG_MODEL_GREEN`	`int`	否
`SCREEN_COLOR_AUTO`	`int`	否
`SCREEN_COLOR_GREEN`	`int`	否
`SCREEN_COLOR_BLUE`	`int`	否
`modelType`	`int`	否
`greenCapacity`	`float`	否
`screenColorType`	`int`	否

SimulcastStreamConfig 0 方法 / 3 属性

属性	类型	只读
`dimensions`	`VideoEncoderConfiguration.VideoDimensions`	否
`bitrate`	`int`	否
`framerate`	`int`	否

SnapshotConfig 0 方法 / 2 属性

属性	类型	只读
`filePath`	`String`	否
`position`	`Constants.VideoModulePosition`	否

SpatialAudioParams 0 方法 / 8 属性

属性	类型	只读
`speaker_azimuth`	`Double`	否
`speaker_elevation`	`Double`	否
`speaker_distance`	`Double`	否
`speaker_orientation`	`Integer`	否
`enable_blur`	`Boolean`	否
`enable_air_absorb`	`Boolean`	否
`speaker_attenuation`	`Double`	否
`enable_doppler`	`Boolean`	否

SpatialAudioZone 0 方法 / 9 属性

属性	类型	只读
`zoneSetId`	`int`	否
`position`	`float[]`	否
`forward`	`float[]`	否
`right`	`float[]`	否
`up`	`float[]`	否
`forwardLength`	`float`	否
`rightLength`	`float`	否
`upLength`	`float`	否
`audioAttenuation`	`float`	否

SrcInfo 0 方法 / 2 属性

属性	类型	只读
`bitrateInKbps`	`int`	否
`name`	`String`	否

TranscodingUser 0 方法 / 8 属性

属性	类型	只读
`uid`	`int`	否
`x`	`int`	否
`y`	`int`	否
`width`	`int`	否
`height`	`int`	否
`zOrder`	`int`	否
`alpha`	`float`	否
`audioChannel`	`int`	否

TranscodingVideoStream 0 方法 / 11 属性

属性	类型	只读
`remoteUserUid`	`int`	否
`sourceType`	`Constants.VideoSourceType`	否
`imageUrl`	`String`	否
`mediaPlayerId`	`int`	否
`x`	`int`	否
`y`	`int`	否
`width`	`int`	否
`height`	`int`	否
`zOrder`	`int`	否
`alpha`	`double`	否
`mirror`	`boolean`	否

UplinkNetworkInfo 0 方法 / 1 属性

属性	类型	只读
`video_encoder_target_bitrate_bps`	`int`	否

UserAudioSpectrumInfo 0 方法 / 2 属性

属性	类型	只读
`uid`	`int`	否
`audioSpectrumInfo`	`AudioSpectrumInfo`	否

UserInfo 0 方法 / 2 属性

属性	类型	只读
`uid`	`int`	否
`userAccount`	`String`	否

VideoCanvas 0 方法 / 19 属性

属性	类型	只读
`uid`	`int`	否
`subviewUid`	`int`	否
`RENDER_MODE_HIDDEN`	`int`	否
`RENDER_MODE_FIT`	`int`	否
`RENDER_MODE_ADAPTIVE`	`int`	否
`VIEW_SETUP_MODE_REPLACE`	`int`	否
`VIEW_SETUP_MODE_ADD`	`int`	否
`VIEW_SETUP_MODE_REMOVE`	`int`	否
`view`	`View`	否
`surfaceTexture`	`SurfaceTexture`	否
`renderMode`	`int`	否
`mirrorMode`	`int`	否
`setupMode`	`int`	否
`sourceType`	`int`	否
`mediaPlayerId`	`int`	否
`rect`	`Rect`	否
`enableAlphaMask`	`boolean`	否
`backgroundColor`	`int`	否
`position`	`Constants.VideoModulePosition`	否

VideoCaptureParameters 0 方法 / 5 属性

属性	类型	只读
`bitrate`	`int`	否
`framerate`	`int`	否
`width`	`int`	否
`height`	`int`	否
`contentHint`	`int`	否

VideoDenoiserOptions 0 方法 / 6 属性

属性	类型	只读
`VIDEO_DENOISER_AUTO`	`int`	否
`VIDEO_DENOISER_MANUAL`	`int`	否
`VIDEO_DENOISER_LEVEL_HIGH_QUALITY`	`int`	否
`VIDEO_DENOISER_LEVEL_FAST`	`int`	否
`denoiserMode`	`int`	否
`denoiserLevel`	`int`	否

VideoDimensions 0 方法 / 2 属性

属性	类型	只读
`width`	`int`	否
`height`	`int`	否

VideoEncoderConfiguration 0 方法 / 10 属性

属性	类型	只读
`dimensions`	`VideoDimensions`	否
`frameRate`	`int`	否
`minFrameRate`	`int`	否
`bitrate`	`int`	否
`minBitrate`	`int`	否
`orientationMode`	`ORIENTATION_MODE`	否
`degradationPrefer`	`DEGRADATION_PREFERENCE`	否
`mirrorMode`	`MIRROR_MODE_TYPE`	否
`advanceOptions`	`AdvanceOptions`	否
`codecType`	`VIDEO_CODEC_TYPE`	否

VideoFrame 0 方法 / 6 属性

属性	类型	只读
`type`	`unknown`	否
`buffer`	`unknown`	否
`TextureBuffer`	`unknown`	否
`rotation`	`unknown`	否
`timestampNs`	`unknown`	否
`colorSpace`	`unknown`	否

VideoLayout 0 方法 / 8 属性

属性	类型	只读
`channelId`	`String`	否
`uid`	`int`	否
`strUid`	`String`	否
`videoState`	`int`	否
`x`	`int`	否
`y`	`int`	否
`width`	`int`	否
`height`	`int`	否

VideoLayoutInfo 0 方法 / 4 属性

属性	类型	只读
`width`	`int`	否
`height`	`int`	否
`layoutCount`	`int`	否
`layoutList`	`VideoLayout[]`	否

VideoRenderingTracingInfo 0 方法 / 7 属性

属性	类型	只读
`elapsedTime`	`int`	否
`start2JoinChannel`	`int`	否
`join2JoinSuccess`	`int`	否
`joinSuccess2RemoteJoined`	`int`	否
`remoteJoined2SetView`	`int`	否
`remoteJoined2UnmuteVideo`	`int`	否
`remoteJoined2PacketReceived`	`int`	否

VideoSubscriptionOptions 0 方法 / 2 属性

属性	类型	只读
`streamType`	`REMOTE_VIDEO_STREAM_TYPE`	否
`encodedFrameOnly`	`Boolean`	否

VirtualBackgroundSource 0 方法 / 4 属性

属性	类型	只读
`backgroundSourceType`	`int`	否
`color`	`int`	否
`source`	`String`	否
`blurDegree`	`int`	否

WatermarkBuffer 5 方法 / 8 属性

typescript

getBuffer(): ByteBuffer
getFormat(): int
getHeight(): int
getId(): String
getWidth(): int

方法明细：5 / 5（参数、返回值、错误码）

方法	参数	返回值	错误
`getBuffer`	—	`ByteBuffer`	错误码索引
`getFormat`	—	`int`	错误码索引
`getHeight`	—	`int`	错误码索引
`getId`	—	`String`	错误码索引
`getWidth`	—	`int`	错误码索引

属性	类型	只读
`WATERMARK_BUFFER_FORMAT_I420`	`int`	否
`WATERMARK_BUFFER_FORMAT_BGRA`	`int`	否
`WATERMARK_BUFFER_FORMAT_NV21`	`int`	否
`WATERMARK_BUFFER_FORMAT_RGBA`	`int`	否
`buffer`	`ByteBuffer`	否
`width`	`int`	否
`height`	`int`	否
`format`	`int`	否

WatermarkConfig 3 方法 / 7 属性

typescript

getImageUrl(): String
getOptions(): WatermarkOptions
getType(): int

方法明细：3 / 3（参数、返回值、错误码）

方法	参数	返回值	错误
`getImageUrl`	—	`String`	错误码索引
`getOptions`	—	`WatermarkOptions`	错误码索引
`getType`	—	`int`	错误码索引

属性	类型	只读
`WATERMARK_TYPE_IMAGE`	`int`	否
`WATERMARK_TYPE_BUFFER`	`int`	否
`id`	`String`	否
`type`	`int`	否
`buffer`	`WatermarkBuffer`	否
`imageUrl`	`String`	否
`options`	`WatermarkOptions`	否

WatermarkOptions 4 方法 / 4 属性

typescript

getPositionInLandscapeMode(): int[]
getPositionInPortraitMode(): int[]
getzOrder(): int
isVisibleInPreview(): boolean

方法明细：4 / 4（参数、返回值、错误码）

方法	参数	返回值	错误
`getPositionInLandscapeMode`	—	`int[]`	错误码索引
`getPositionInPortraitMode`	—	`int[]`	错误码索引
`getzOrder`	—	`int`	错误码索引
`isVisibleInPreview`	—	`boolean`	错误码索引

属性	类型	只读
`visibleInPreview`	`boolean`	否
`positionInLandscapeMode`	`Rectangle`	否
`positionInPortraitMode`	`Rectangle`	否
`zOrder`	`int`	否

枚举

枚举	成员数	示例值
`AbrFallbackLayer`	9	`DISABLED = 0`
`AbrSubscriptionLayer`	8	`HIGH = 0`
`AUDIO_EQUALIZATION_BAND_FREQUENCY`	10	`AUDIO_EQUALIZATION_BAND_31 = 0`
`AUDIO_REVERB_TYPE`	5	`AUDIO_REVERB_DRY_LEVEL = 0`
`AudioCodecProfileType`	3	`LC_AAC = 0`
`AudioDualMonoMode`	4	`AUDIO_DUAL_MONO_STEREO = 0`
`AudioMixingDualMonoMode`	4	`AUDIO_MIXING_DUAL_MONO_AUTO = 0`
`AudioProcessingChannelsEnum`	2	`AGORA_AUDIO_MONO_PROCESSING = 1`
`AudioProfile`	5	`SPEECH_STANDARD = 1`
`AudioSampleRateType`	3	`TYPE_32000 = 32000`
`AudioSourceType`	8	`AUDIO_SOURCE_MICROPHONE = 0`
`AudioTrackType`	2	`AUDIO_TRACK_MIXABLE = 0`
`CAMERA_DIRECTION`	3	`CAMERA_REAR = 0`
`CAMERA_FOCAL_LENGTH_TYPE`	4	`CAMERA_FOCAL_LENGTH_DEFAULT = 0`
`COMPRESSION_PREFERENCE`	3	`PREFER_COMPRESSION_AUTO = -1`
`DEGRADATION_PREFERENCE`	6	`MAINTAIN_AUTO = -1`
`ENCODING_PREFERENCE`	3	`PREFER_AUTO = -1`
`EncryptionMode`	9	`AES_128_XTS = 1`
`ErrorCode`	6	`OK = 0`
`ExternalVideoSourceType`	2	`VIDEO_FRAME = 0`
`FRAME_RATE`	7	`FRAME_RATE_FPS_1 = 1`
`LogLevel`	5	`LOG_LEVEL_NONE = 0`
`MEDIA_TRACE_EVENT`	2	`MEDIA_TRACE_EVENT_VIDEO_RENDERED = 0`
`MediaPlayerEvent`	18	`PLAYER_EVENT_UNKNOWN = -1`
`MediaPlayerMetadataType`	2	`PLAYER_METADATA_TYPE_UNKNOWN = 0`
`MediaPlayerPreloadEvent`	3	`PLAYER_PRELOAD_EVENT_BEGIN = 0`
`MediaPlayerReason`	18	`PLAYER_REASON_NONE = 0`
`MediaPlayerState`	10	`PLAYER_STATE_UNKNOWN = -1`
`MediaSourceType`	15	`AUDIO_PLAYOUT_SOURCE = 0`
`MediaStreamType`	4	`STREAM_TYPE_UNKNOWN = 0`
`MultipathMode`	1	`MULTIPATH_MODE_DUPLICATE = 0`
`MultipathType`	4	`MULTIPATH_TYPE_LAN = 0`
`MusicPlayMode`	3	`MUSIC_PLAY_MODE_ORIGINAL = 0`
`ORIENTATION_MODE`	3	`ORIENTATION_MODE_ADAPTIVE = 0`
`PlayerEvent`	21	`SEEK_BEGIN = 0`
`PlayerState`	8	`IDLE = 0`
`RenewTokenErrorCode`	7	`RENEW_TOKEN_SUCCESS = 0`
`ScreenScenarioType`	3	`SCREEN_SCENARIO_DOCUMENT = 1`
`SimulcastStreamMode`	3	`AUTO_SIMULCAST_STREAM = -1`
`StreamFallbackOptions`	9	`STREAM_FALLBACK_OPTION_DISABLED = 0`
`VIDEO_CODEC_TYPE`	7	`VIDEO_CODEC_NONE = 0`
`VIDEO_EFFECT_ACTION`	2	`SAVE = 1`
`VIDEO_EFFECT_NODE_ID`	4	`BEAUTY = 1`
`VideoCodecProfileType`	3	`BASELINE = 66`
`VideoCodecType`	2	`H264 = 1`
`VideoMirrorMode`	3	`AUTO = 0`
`VideoModulePosition`	4	`VIDEO_MODULE_POSITION_POST_CAPTURER = 1`
`VideoRenderMode`	2	`HIDDEN = 0`
`VideoScenario`	4	`APPLICATION_SCENARIO_GENERAL = 0`
`VideoSourceType`	15	`VIDEO_SOURCE_CAMERA_PRIMARY = 0`
`VideoStreamType`	8	`VIDEO_STREAM_HIGH = 0`
`VOICE_AI_TUNER_TYPE`	10	`VOICE_AI_TUNER_MATURE_MALE = 0`

AbrFallbackLayer 9 个成员

成员	值
`DISABLED`	`0`
`LOW`	`1`
`AUDIO_ONLY`	`2`
`LAYER1`	`3`
`LAYER2`	`4`
`LAYER3`	`5`
`LAYER4`	`6`
`LAYER5`	`7`
`LAYER6`	`8`

AbrSubscriptionLayer 8 个成员

成员	值
`HIGH`	`0`
`LOW`	`1`
`LAYER1`	`2`
`LAYER2`	`3`
`LAYER3`	`4`
`LAYER4`	`5`
`LAYER5`	`6`
`LAYER6`	`7`

AUDIO_EQUALIZATION_BAND_FREQUENCY 10 个成员

成员	值
`AUDIO_EQUALIZATION_BAND_31`	`0`
`AUDIO_EQUALIZATION_BAND_62`	`1`
`AUDIO_EQUALIZATION_BAND_125`	`2`
`AUDIO_EQUALIZATION_BAND_250`	`3`
`AUDIO_EQUALIZATION_BAND_500`	`4`
`AUDIO_EQUALIZATION_BAND_1K`	`5`
`AUDIO_EQUALIZATION_BAND_2K`	`6`
`AUDIO_EQUALIZATION_BAND_4K`	`7`
`AUDIO_EQUALIZATION_BAND_8K`	`8`
`AUDIO_EQUALIZATION_BAND_16K`	`9`

AUDIO_REVERB_TYPE 5 个成员

成员	值
`AUDIO_REVERB_DRY_LEVEL`	`0`
`AUDIO_REVERB_WET_LEVEL`	`1`
`AUDIO_REVERB_ROOM_SIZE`	`2`
`AUDIO_REVERB_WET_DELAY`	`3`
`AUDIO_REVERB_STRENGTH`	`4`

AudioCodecProfileType 3 个成员

成员	值
`LC_AAC`	`0`
`HE_AAC`	`1`
`HE_AAC_V2`	`2`

AudioDualMonoMode 4 个成员

成员	值
`AUDIO_DUAL_MONO_STEREO`	`0`
`AUDIO_DUAL_MONO_L`	`1`
`AUDIO_DUAL_MONO_R`	`2`
`AUDIO_DUAL_MONO_MIX`	`3`

AudioMixingDualMonoMode 4 个成员

成员	值
`AUDIO_MIXING_DUAL_MONO_AUTO`	`0`
`AUDIO_MIXING_DUAL_MONO_L`	`1`
`AUDIO_MIXING_DUAL_MONO_R`	`2`
`AUDIO_MIXING_DUAL_MONO_MIX`	`3`

AudioProcessingChannelsEnum 2 个成员

成员	值
`AGORA_AUDIO_MONO_PROCESSING`	`1`
`AGORA_AUDIO_STEREO_PROCESSING`	`2`

AudioProfile 5 个成员

成员	值
`SPEECH_STANDARD`	`1`
`MUSIC_STANDARD`	`2`
`MUSIC_STANDARD_STEREO`	`3`
`MUSIC_HIGH_QUALITY`	`4`
`MUSIC_HIGH_QUALITY_STEREO`	`5`

AudioSampleRateType 3 个成员

成员	值
`TYPE_32000`	`32000`
`TYPE_44100`	`44100`
`TYPE_48000`	`48000`

AudioSourceType 8 个成员

成员	值
`AUDIO_SOURCE_MICROPHONE`	`0`
`AUDIO_SOURCE_CUSTOM`	`1`
`AUDIO_SOURCE_MEDIA_PLAYER`	`2`
`AUDIO_SOURCE_LOOPBACK_RECORDING`	`3`
`AUDIO_SOURCE_MIXED_STREAM`	`4`
`AUDIO_SOURCE_REMOTE_USER`	`5`
`AUDIO_SOURCE_REMOTE_CHANNEL`	`6`
`AUDIO_SOURCE_UNKNOWN`	`100`

AudioTrackType 2 个成员

成员	值
`AUDIO_TRACK_MIXABLE`	`0`
`AUDIO_TRACK_DIRECT`	`1`

CAMERA_DIRECTION 3 个成员

成员	值
`CAMERA_REAR`	`0`
`CAMERA_FRONT`	`1`
`CAMERA_EXTRAL`	`2`

CAMERA_FOCAL_LENGTH_TYPE 4 个成员

成员	值
`CAMERA_FOCAL_LENGTH_DEFAULT`	`0`
`CAMERA_FOCAL_LENGTH_WIDE_ANGLE`	`1`
`CAMERA_FOCAL_LENGTH_ULTRA_WIDE`	`2`
`CAMERA_FOCAL_LENGTH_TELEPHOTO`	`3`

COMPRESSION_PREFERENCE 3 个成员

成员	值
`PREFER_COMPRESSION_AUTO`	`-1`
`PREFER_LOW_LATENCY`	`0`
`PREFER_QUALITY`	`1`

DEGRADATION_PREFERENCE 6 个成员

成员	值
`MAINTAIN_AUTO`	`-1`
`MAINTAIN_QUALITY`	`0`
`MAINTAIN_FRAMERATE`	`1`
`MAINTAIN_BALANCED`	`2`
`MAINTAIN_RESOLUTION`	`3`
`DISABLED`	`100`

ENCODING_PREFERENCE 3 个成员

成员	值
`PREFER_AUTO`	`-1`
`PREFER_SOFTWARE`	`0`
`PREFER_HARDWARE`	`1`

EncryptionMode 9 个成员

成员	值
`AES_128_XTS`	`1`
`AES_128_ECB`	`2`
`AES_256_XTS`	`3`
`SM4_128_ECB`	`4`
`AES_128_GCM`	`5`
`AES_256_GCM`	`6`
`AES_128_GCM2`	`7`
`AES_256_GCM2`	`8`
`MODE_END`	`9`

ErrorCode 6 个成员

成员	值
`OK`	`0`
`INVALID_ARGUMENT`	`2`
`INVALID_OPERATION`	`3`
`NETWORK_ERROR`	`4`
`AUTHENTICATION_FAILED`	`5`
`STREAM_NOT_FOUND`	`6`

ExternalVideoSourceType 2 个成员

成员	值
`VIDEO_FRAME`	`0`
`ENCODED_VIDEO_FRAME`	`1`

FRAME_RATE 7 个成员

成员	值
`FRAME_RATE_FPS_1`	`1`
`FRAME_RATE_FPS_7`	`7`
`FRAME_RATE_FPS_10`	`10`
`FRAME_RATE_FPS_15`	`15`
`FRAME_RATE_FPS_24`	`24`
`FRAME_RATE_FPS_30`	`30`
`FRAME_RATE_FPS_60`	`60`

LogLevel 5 个成员

成员	值
`LOG_LEVEL_NONE`	`0`
`LOG_LEVEL_INFO`	`1`
`LOG_LEVEL_WARN`	`2`
`LOG_LEVEL_ERROR`	`4`
`LOG_LEVEL_FATAL`	`8`

MEDIA_TRACE_EVENT 2 个成员

成员	值
`MEDIA_TRACE_EVENT_VIDEO_RENDERED`	`0`
`MEDIA_TRACE_EVENT_VIDEO_DECODED`	`1`

MediaPlayerEvent 18 个成员

成员	值
`PLAYER_EVENT_UNKNOWN`	`-1`
`PLAYER_EVENT_SEEK_BEGIN`	`0`
`PLAYER_EVENT_SEEK_COMPLETE`	`1`
`PLAYER_EVENT_SEEK_ERROR`	`2`
`PLAYER_EVENT_AUDIO_TRACK_CHANGED`	`5`
`PLAYER_EVENT_BUFFER_LOW`	`6`
`PLAYER_EVENT_BUFFER_RECOVER`	`7`
`PLAYER_EVENT_FREEZE_START`	`8`
`PLAYER_EVENT_FREEZE_STOP`	`9`
`PLAYER_EVENT_SWITCH_BEGIN`	`10`
`PLAYER_EVENT_SWITCH_COMPLETE`	`11`
`PLAYER_EVENT_SWITCH_ERROR`	`12`
`PLAYER_EVENT_FIRST_DISPLAYED`	`13`
`PLAYER_EVENT_REACH_CACHE_FILE_MAX_COUNT`	`14`
`PLAYER_EVENT_REACH_CACHE_FILE_MAX_SIZE`	`15`
`PLAYER_EVENT_TRY_OPEN_START`	`16`
`PLAYER_EVENT_TRY_OPEN_SUCCEED`	`17`
`PLAYER_EVENT_TRY_OPEN_FAILED`	`18`

MediaPlayerMetadataType 2 个成员

成员	值
`PLAYER_METADATA_TYPE_UNKNOWN`	`0`
`PLAYER_METADATA_TYPE_SEI`	`1`

MediaPlayerPreloadEvent 3 个成员

成员	值
`PLAYER_PRELOAD_EVENT_BEGIN`	`0`
`PLAYER_PRELOAD_EVENT_COMPLETE`	`1`
`PLAYER_PRELOAD_EVENT_ERROR`	`2`

MediaPlayerReason 18 个成员

成员	值
`PLAYER_REASON_NONE`	`0`
`PLAYER_REASON_INVALID_ARGUMENTS`	`-1`
`PLAYER_REASON_INTERNAL`	`-2`
`PLAYER_REASON_NO_RESOURCE`	`-3`
`PLAYER_REASON_INVALID_MEDIA_SOURCE`	`-4`
`PLAYER_REASON_UNKNOWN_STREAM_TYPE`	`-5`
`PLAYER_REASON_OBJ_NOT_INITIALIZED`	`-6`
`PLAYER_REASON_CODEC_NOT_SUPPORTED`	`-7`
`PLAYER_REASON_VIDEO_RENDER_FAILED`	`-8`
`PLAYER_REASON_INVALID_STATE`	`-9`
`PLAYER_REASON_URL_NOT_FOUND`	`-10`
`PLAYER_REASON_INVALID_CONNECTION_STATE`	`-11`
`PLAY_REASON_SRC_BUFFER_UNDERFLOW`	`-12`
`PLAYER_REASON_INTERRUPTED`	`-13`
`PLAYER_REASON_NOT_SUPPORTED`	`-14`
`PLAYER_REASON_TOKEN_EXPIRED`	`-15`
`PLAYER_REASON_IP_EXPIRED`	`-16`
`PLAYER_REASON_UNKNOWN`	`-17`

MediaPlayerState 10 个成员

成员	值
`PLAYER_STATE_UNKNOWN`	`-1`
`PLAYER_STATE_IDLE`	`0`
`PLAYER_STATE_OPENING`	`1`
`PLAYER_STATE_OPEN_COMPLETED`	`2`
`PLAYER_STATE_PLAYING`	`3`
`PLAYER_STATE_PAUSED`	`4`
`PLAYER_STATE_PLAYBACK_COMPLETED`	`5`
`PLAYER_STATE_PLAYBACK_ALL_LOOPS_COMPLETED`	`6`
`PLAYER_STATE_STOPPED`	`7`
`PLAYER_STATE_FAILED`	`100`

MediaSourceType 15 个成员

成员	值
`AUDIO_PLAYOUT_SOURCE`	`0`
`AUDIO_RECORDING_SOURCE`	`1`
`PRIMARY_CAMERA_SOURCE`	`2`
`SECONDARY_CAMERA_SOURCE`	`3`
`PRIMARY_SCREEN_SOURCE`	`4`
`SECONDARY_SCREEN_SOURCE`	`5`
`CUSTOM_VIDEO_SOURCE`	`6`
`MEDIA_PLAYER_SOURCE`	`7`
`RTC_IMAGE_PNG_SOURCE`	`8`
`RTC_IMAGE_JPEG_SOURCE`	`9`
`RTC_IMAGE_GIF_SOURCE`	`10`
`REMOTE_VIDEO_SOURCE`	`11`
`TRANSCODED_VIDEO_SOURCE`	`12`
`SPEECH_DRIVEN_VIDEO_SOURCE`	`13`
`UNKNOWN_MEDIA_SOURCE`	`100`

MediaStreamType 4 个成员

成员	值
`STREAM_TYPE_UNKNOWN`	`0`
`STREAM_TYPE_VIDEO`	`1`
`STREAM_TYPE_AUDIO`	`2`
`STREAM_TYPE_SUBTITLE`	`3`

MultipathMode 1 个成员

成员	值
`MULTIPATH_MODE_DUPLICATE`	`0`

MultipathType 4 个成员

成员	值
`MULTIPATH_TYPE_LAN`	`0`
`MULTIPATH_TYPE_WIFI`	`1`
`MULTIPATH_TYPE_MOBILE`	`2`
`MULTIPATH_TYPE_UNKNOWN`	`99`

MusicPlayMode 3 个成员

成员	值
`MUSIC_PLAY_MODE_ORIGINAL`	`0`
`MUSIC_PLAY_MODE_ACCOMPANY`	`1`
`MUSIC_PLAY_MODE_LEAD_SING`	`2`

ORIENTATION_MODE 3 个成员

成员	值
`ORIENTATION_MODE_ADAPTIVE`	`0`
`ORIENTATION_MODE_FIXED_LANDSCAPE`	`1`
`ORIENTATION_MODE_FIXED_PORTRAIT`	`2`

PlayerEvent 21 个成员

成员	值
`SEEK_BEGIN`	`0`
`SEEK_COMPLETE`	`1`
`SEEK_ERROR`	`2`
`BUFFER_LOW`	`3`
`BUFFER_RECOVER`	`4`
`FREEZE_START`	`5`
`FREEZE_STOP`	`6`
`ONE_LOOP_PLAYBACK_COMPLETED`	`7`
`AUTHENTICATION_WILL_EXPIRE`	`8`
`ABR_FALLBACK_TO_AUDIO_ONLY_LAYER`	`9`
`ABR_RECOVER_FROM_AUDIO_ONLY_LAYER`	`10`
`SWITCH_BEGIN`	`11`
`SWITCH_COMPLETE`	`12`
`SWITCH_ERROR`	`13`
`FIRST_DISPLAYED`	`14`
`REACH_CACHE_FILE_MAX_COUNT`	`15`
`REACH_CACHE_FILE_MAX_SIZE`	`16`
`TRY_OPEN_START`	`17`
`TRY_OPEN_SUCCEED`	`18`
`TRY_OPEN_FAILED`	`19`
`AUDIO_TRACK_CHANGED`	`20`

PlayerState 8 个成员

成员	值
`IDLE`	`0`
`OPENING`	`1`
`OPEN_COMPLETED`	`2`
`PLAYING`	`3`
`PAUSED`	`4`
`PLAYBACK_COMPLETED`	`5`
`STOPPED`	`6`
`FAILED`	`7`

RenewTokenErrorCode 7 个成员

成员	值
`RENEW_TOKEN_SUCCESS`	`0`
`RENEW_TOKEN_FAILURE`	`1`
`RENEW_TOKEN_TOKEN_EXPIRED`	`2`
`RENEW_TOKEN_INVALID_TOKEN`	`3`
`RENEW_TOKEN_INVALID_CHANNEL_NAME`	`4`
`RENEW_TOKEN_INCONSISTENT_APPID`	`5`
`RENEW_TOKEN_CANCELED_BY_NEW_REQUEST`	`6`

ScreenScenarioType 3 个成员

成员	值
`SCREEN_SCENARIO_DOCUMENT`	`1`
`SCREEN_SCENARIO_GAMING`	`2`
`SCREEN_SCENARIO_VIDEO`	`3`

SimulcastStreamMode 3 个成员

成员	值
`AUTO_SIMULCAST_STREAM`	`-1`
`DISABLE_SIMULCAST_STREAM`	`0`
`ENABLE_SIMULCAST_STREAM`	`1`

StreamFallbackOptions 9 个成员

成员	值
`STREAM_FALLBACK_OPTION_DISABLED`	`0`
`STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW`	`1`
`STREAM_FALLBACK_OPTION_AUDIO_ONLY`	`2`
`STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_1`	`3`
`STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_2`	`4`
`STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_3`	`5`
`STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_4`	`6`
`STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_5`	`7`
`STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_6`	`8`

VIDEO_CODEC_TYPE 7 个成员

成员	值
`VIDEO_CODEC_NONE`	`0`
`VIDEO_CODEC_VP8`	`1`
`VIDEO_CODEC_H264`	`2`
`VIDEO_CODEC_H265`	`3`
`VIDEO_CODEC_GENERIC`	`6`
`VIDEO_CODEC_VP9`	`13`
`VIDEO_CODEC_GENERIC_JPEG`	`20`

VIDEO_EFFECT_ACTION 2 个成员

成员	值
`SAVE`	`1`
`RESET`	`2`

VIDEO_EFFECT_NODE_ID 4 个成员

成员	值
`BEAUTY`	`1`
`STYLE_MAKEUP`	`2`
`FILTER`	`4`
`STICKER`	`8`

VideoCodecProfileType 3 个成员

成员	值
`BASELINE`	`66`
`MAIN`	`77`
`HIGH`	`100`

VideoCodecType 2 个成员

成员	值
`H264`	`1`
`H265`	`2`

VideoMirrorMode 3 个成员

成员	值
`AUTO`	`0`
`ENABLED`	`1`
`DISABLED`	`2`

VideoModulePosition 4 个成员

成员	值
`VIDEO_MODULE_POSITION_POST_CAPTURER`	`1`
`VIDEO_MODULE_POSITION_PRE_RENDERER`	`2`
`VIDEO_MODULE_POSITION_PRE_ENCODER`	`4`
`VIDEO_MODULE_POSITION_POST_CAPTURER_ORIGIN`	`8`

VideoRenderMode 2 个成员

成员	值
`HIDDEN`	`0`
`FIT`	`1`

VideoScenario 4 个成员

成员	值
`APPLICATION_SCENARIO_GENERAL`	`0`
`APPLICATION_SCENARIO_MEETING`	`null`
`APPLICATION_SCENARIO_1V1`	`2`
`APPLICATION_SCENARIO_LIVESHOW`	`3`

VideoSourceType 15 个成员

成员	值
`VIDEO_SOURCE_CAMERA_PRIMARY`	`0`
`VIDEO_SOURCE_CAMERA_SECONDARY`	`1`
`VIDEO_SOURCE_SCREEN_PRIMARY`	`2`
`VIDEO_SOURCE_SCREEN_SECONDARY`	`3`
`VIDEO_SOURCE_CUSTOM`	`4`
`VIDEO_SOURCE_MEDIA_PLAYER`	`5`
`VIDEO_SOURCE_RTC_IMAGE_PNG`	`6`
`VIDEO_SOURCE_RTC_IMAGE_JPEG`	`7`
`VIDEO_SOURCE_RTC_IMAGE_GIF`	`8`
`VIDEO_SOURCE_REMOTE`	`9`
`VIDEO_SOURCE_TRANSCODED`	`10`
`VIDEO_SOURCE_CAMERA_THIRD`	`11`
`VIDEO_SOURCE_CAMERA_FOURTH`	`12`
`VIDEO_SOURCE_SPEECH_DRIVEN`	`15`
`VIDEO_SOURCE_UNKNOWN`	`100`

VideoStreamType 8 个成员

成员	值
`VIDEO_STREAM_HIGH`	`0`
`VIDEO_STREAM_LOW`	`1`
`VIDEO_STREAM_LAYER_1`	`4`
`VIDEO_STREAM_LAYER_2`	`5`
`VIDEO_STREAM_LAYER_3`	`6`
`VIDEO_STREAM_LAYER_4`	`7`
`VIDEO_STREAM_LAYER_5`	`8`
`VIDEO_STREAM_LAYER_6`	`9`

VOICE_AI_TUNER_TYPE 10 个成员

成员	值
`VOICE_AI_TUNER_MATURE_MALE`	`0`
`VOICE_AI_TUNER_FRESH_MALE`	`1`
`VOICE_AI_TUNER_ELEGANT_FEMALE`	`2`
`VOICE_AI_TUNER_SWEET_FEMALE`	`3`
`VOICE_AI_TUNER_WARM_MALE_SINGING`	`4`
`VOICE_AI_TUNER_GENTLE_FEMALE_SINGING`	`5`
`VOICE_AI_TUNER_HUSKY_MALE_SINGING`	`6`
`VOICE_AI_TUNER_WARM_ELEGANT_FEMALE_SINGING`	`7`
`VOICE_AI_TUNER_POWERFUL_MALE_SINGING`	`8`
`VOICE_AI_TUNER_DREAMY_FEMALE_SINGING`	`9`

错误码常量

常量	值
`AUTHENTICATION_FAILED`	`5`
`INVALID_ARGUMENT`	`2`
`INVALID_OPERATION`	`3`
`NETWORK_ERROR`	`4`
`OK`	`0`
`STREAM_NOT_FOUND`	`6`

已知限制

以下成员在当前版本暂不可用，调用时返回 -4（ERR_NOT_SUPPORTED）。接口定义中保留这些成员，便于跨端代码保持一致。

接口	成员
`Canvas`	`Canvas`
`Canvas`	`addView`
`Canvas`	`getConfigs`
`Canvas`	`removeView`
`Canvas`	`setConfigs`
`CanvasConfig`	`getVideoMirrorMode`
`CanvasConfig`	`getVideoRenderMode`
`CanvasConfig`	`setVideoMirrorMode`
`CanvasConfig`	`setVideoRenderMode`
`ChannelMediaRelayConfiguration`	`removeDestChannelInfo`
`ChannelMediaRelayConfiguration`	`setDestChannelInfo`
`ChannelMediaRelayConfiguration`	`setSrcChannelInfo`
`Config`	`getAppId`
`Config`	`getJsonParameter`
`Config`	`setAppId`
`Config`	`setJsonParameter`
`Error`	`code`
`Error`	`message`
`IAgoraMusicContentCenter`	`createMusicPlayer`
`IAgoraMusicContentCenter`	`destroy`
`IAgoraMusicContentCenter`	`destroyMusicPlayer`
`IAgoraMusicContentCenter`	`getCaches`
`IAgoraMusicContentCenter`	`getInternalSongCode`
`IAgoraMusicContentCenter`	`getLyric`
`IAgoraMusicContentCenter`	`getMusicCharts`
`IAgoraMusicContentCenter`	`getMusicCollectionByMusicChartId`
`IAgoraMusicContentCenter`	`getSongSimpleInfo`
`IAgoraMusicContentCenter`	`initialize`
`IAgoraMusicContentCenter`	`isPreloaded`
`IAgoraMusicContentCenter`	`preload`
`IAgoraMusicContentCenter`	`registerEventHandler`
`IAgoraMusicContentCenter`	`removeCache`
`IAgoraMusicContentCenter`	`renewToken`
`IAgoraMusicContentCenter`	`searchMusic`
`IAgoraMusicContentCenter`	`unregisterEventHandler`
`IAgoraMusicPlayer`	`destroy`
`IAgoraMusicPlayer`	`getPlaySrc`
`IAgoraMusicPlayer`	`open`
`IAgoraMusicPlayer`	`setPlayMode`
`IAgoraMusicPlayer`	`stop`
`IAudioFrameObserver`	`getEarMonitoringAudioParams`
`IAudioFrameObserver`	`getMixedAudioParams`
`IAudioFrameObserver`	`getObservedAudioFramePosition`
`IAudioFrameObserver`	`getPlaybackAudioParams`
`IAudioFrameObserver`	`getRecordAudioParams`
`IAudioFrameObserver`	`onEarMonitoringAudioFrame`
`IAudioFrameObserver`	`onMixedAudioFrame`
`IAudioFrameObserver`	`onPlaybackAudioFrame`
`IAudioFrameObserver`	`onPlaybackAudioFrameBeforeMixing`
`IAudioFrameObserver`	`onRecordAudioFrame`
`IAudioSpectrumObserver`	`onLocalAudioSpectrum`
`IAudioSpectrumObserver`	`onRemoteAudioSpectrum`
`IBaseSpatialAudioEngine`	`clearRemotePositions`
`IBaseSpatialAudioEngine`	`muteAllRemoteAudioStreams`
`IBaseSpatialAudioEngine`	`muteLocalAudioStream`
`IBaseSpatialAudioEngine`	`muteRemoteAudioStream`
`IBaseSpatialAudioEngine`	`setAudioRecvRange`
`IBaseSpatialAudioEngine`	`setDistanceUnit`
`IBaseSpatialAudioEngine`	`setMaxAudioRecvCount`
`IBaseSpatialAudioEngine`	`setPlayerAttenuation`
`IBaseSpatialAudioEngine`	`setZones`
`IBaseSpatialAudioEngine`	`updatePlayerPositionInfo`
`IBaseSpatialAudioEngine`	`updateSelfPosition`
`ILocalSpatialAudioEngine`	`create`
`ILocalSpatialAudioEngine`	`destroy`
`ILocalSpatialAudioEngine`	`initialize`
`ILocalSpatialAudioEngine`	`removeRemotePosition`
`ILocalSpatialAudioEngine`	`setRemoteAudioAttenuation`
`ILocalSpatialAudioEngine`	`updateRemotePosition`
`IMediaPlayer`	`registerAudioFrameObserver`
`IMediaPlayer`	`registerVideoFrameObserver`
`IMediaPlayerCustomDataProvider`	`onReadData`
`IMediaPlayerCustomDataProvider`	`onSeek`
`IMetadataObserver`	`getMaxMetadataSize`
`IMetadataObserver`	`onReadyToSendMetadata`
`IVideoEffectObject`	`addOrUpdateVideoEffect`
`IVideoEffectObject`	`getVideoEffectBoolParam`
`IVideoEffectObject`	`getVideoEffectFloatParam`
`IVideoEffectObject`	`getVideoEffectIntParam`
`IVideoEffectObject`	`performVideoEffectAction`
`IVideoEffectObject`	`removeVideoEffect`
`IVideoEffectObject`	`setVideoEffectBoolParam`
`IVideoEffectObject`	`setVideoEffectFloatParam`
`IVideoEffectObject`	`setVideoEffectIntParam`
`IVideoEffectObject`	`setVideoEffectStringParam`
`IVideoEncodedFrameObserver`	`onEncodedVideoFrameReceived`
`IVideoFrameObserver`	`getMirrorApplied`
`IVideoFrameObserver`	`getObservedFramePosition`
`IVideoFrameObserver`	`getRotationApplied`
`IVideoFrameObserver`	`getVideoFormatPreference`
`IVideoFrameObserver`	`getVideoFrameProcessMode`
`IVideoFrameObserver`	`onCaptureVideoFrame`
`IVideoFrameObserver`	`onPreEncodeVideoFrame`
`IVideoFrameObserver`	`onRenderVideoFrame`
`LiveTranscoding`	`addBackgroundImage`
`LiveTranscoding`	`addUser`
`LiveTranscoding`	`addWatermark`
`LiveTranscoding`	`getAdvancedFeatures`
`LiveTranscoding`	`getBackgroundColor`
`LiveTranscoding`	`getBackgroundImageList`
`LiveTranscoding`	`getBlue`
`LiveTranscoding`	`getGreen`
`LiveTranscoding`	`getRed`
`LiveTranscoding`	`getUserCount`
`LiveTranscoding`	`getUsers`
`LiveTranscoding`	`getWatermarkList`
`LiveTranscoding`	`removeBackgroundImage`
`LiveTranscoding`	`removeUser`
`LiveTranscoding`	`removeWatermark`
`LiveTranscoding`	`setAdvancedFeatures`
`LiveTranscoding`	`setBackgroundColor`
`LiveTranscoding`	`setBlue`
`LiveTranscoding`	`setGreen`
`LiveTranscoding`	`setRed`
`LiveTranscoding`	`setUsers`
`Player`	`Player`
`Player`	`getConfigs`
`Player`	`getInfo`
`Player`	`getPosition`
`Player`	`getStats`
`Player`	`muteAudio`
`Player`	`muteVideo`
`Player`	`openWithUrl`
`Player`	`pause`
`Player`	`play`
`Player`	`preloadWithUrl`
`Player`	`registerObserver`
`Player`	`seek`
`Player`	`setCanvas`
`Player`	`setConfigs`
`Player`	`stop`
`Player`	`switchWithUrl`
`Player`	`unregisterObserver`
`PlayerConfig`	`getAbrFallbackLayer`
`PlayerConfig`	`getAbrSubscriptionLayer`
`PlayerConfig`	`getAutoPlay`
`PlayerConfig`	`getLoopCount`
`PlayerConfig`	`getPlaybackSpeed`
`PlayerConfig`	`getPlayoutVolume`
`PlayerConfig`	`setAbrFallbackLayer`
`PlayerConfig`	`setAbrSubscriptionLayer`
`PlayerConfig`	`setAutoPlay`
`PlayerConfig`	`setLoopCount`
`PlayerConfig`	`setPlaybackSpeed`
`PlayerConfig`	`setPlayoutVolume`
`PlayerInfo`	`abrSubscriptionLayer`
`PlayerInfo`	`audioBitsPerSample`
`PlayerInfo`	`audioChannels`
`PlayerInfo`	`audioSampleRate`
`PlayerInfo`	`currentUrl`
`PlayerInfo`	`duration`
`PlayerInfo`	`hasAudio`
`PlayerInfo`	`hasVideo`
`PlayerInfo`	`isAudioMuted`
`PlayerInfo`	`isVideoMuted`
`PlayerInfo`	`state`
`PlayerInfo`	`streamCount`
`PlayerInfo`	`videoHeight`
`PlayerInfo`	`videoWidth`
`RtcEngine`	`addExtension`
`RtcEngine`	`adjustCustomAudioPlayoutVolume`
`RtcEngine`	`adjustCustomAudioPublishVolume`
`RtcEngine`	`createCustomAudioTrack`
`RtcEngine`	`createCustomVideoTrack`
`RtcEngine`	`createVideoEffectObject`
`RtcEngine`	`destroyCustomAudioTrack`
`RtcEngine`	`destroyCustomVideoTrack`
`RtcEngine`	`destroyVideoEffectObject`
`RtcEngine`	`enableContentInspect`
`RtcEngine`	`enableCustomAudioLocalPlayback`
`RtcEngine`	`enableExtension`
`RtcEngine`	`enableSpatialAudio`
`RtcEngine`	`getAudioEffectManager`
`RtcEngine`	`getExtensionProperty`
`RtcEngine`	`getNativeHandle`
`RtcEngine`	`isTextureEncodeSupported`
`RtcEngine`	`pauseAllChannelMediaRelay`
`RtcEngine`	`pullPlaybackAudioFrame`
`RtcEngine`	`pushExternalAudioFrame`
`RtcEngine`	`pushExternalVideoFrame`
`RtcEngine`	`pushExternalVideoFrameById`
`RtcEngine`	`registerAudioEncodedFrameObserver`
`RtcEngine`	`registerAudioFrameObserver`
`RtcEngine`	`registerAudioSpectrumObserver`
`RtcEngine`	`registerExtension`
`RtcEngine`	`registerMediaMetadataObserver`
`RtcEngine`	`registerVideoEncodedFrameObserver`
`RtcEngine`	`registerVideoFrameObserver`
`RtcEngine`	`resumeAllChannelMediaRelay`
`RtcEngine`	`setEarMonitoringAudioFrameParameters`
`RtcEngine`	`setExtensionProperty`
`RtcEngine`	`setExtensionProviderProperty`
`RtcEngine`	`setExternalAudioSink`
`RtcEngine`	`setExternalAudioSource`
`RtcEngine`	`setExternalMediaProjection`
`RtcEngine`	`setExternalRemoteEglContext`
`RtcEngine`	`setExternalVideoSource`
`RtcEngine`	`setLocalAccessPoint`
`RtcEngine`	`setMixedAudioFrameParameters`
`RtcEngine`	`setPlaybackAudioFrameBeforeMixingParameters`
`RtcEngine`	`setPlaybackAudioFrameParameters`
`RtcEngine`	`setRecordingAudioFrameParameters`
`RtcEngine`	`startEchoTest`
`RtcEngine`	`startLastmileProbeTest`
`RtcEngine`	`startOrUpdateChannelMediaRelay`
`RtcEngine`	`startPlaybackDeviceTest`
`RtcEngine`	`startRecordingDeviceTest`
`RtcEngine`	`startRtmpStreamWithTranscoding`
`RtcEngine`	`startRtmpStreamWithoutTranscoding`
`RtcEngine`	`stopChannelMediaRelay`
`RtcEngine`	`stopEchoTest`
`RtcEngine`	`stopLastmileProbeTest`
`RtcEngine`	`stopPlaybackDeviceTest`
`RtcEngine`	`stopRecordingDeviceTest`
`RtcEngine`	`stopRtmpStream`
`RtcEngine`	`takeSnapshot`
`RtcEngine`	`unRegisterAudioSpectrumObserver`
`RtcEngine`	`unregisterMediaMetadataObserver`
`RtcEngine`	`updateRtmpTranscoding`
`RtcEngineEx`	`enableContentInspectEx`
`RtcEngineEx`	`pauseAllChannelMediaRelayEx`
`RtcEngineEx`	`resumeAllChannelMediaRelayEx`
`RtcEngineEx`	`startOrUpdateChannelMediaRelayEx`
`RtcEngineEx`	`startRtmpStreamWithTranscodingEx`
`RtcEngineEx`	`startRtmpStreamWithoutTranscodingEx`
`RtcEngineEx`	`stopChannelMediaRelayEx`
`RtcEngineEx`	`stopRtmpStreamEx`
`RtcEngineEx`	`takeSnapshotEx`
`RtcEngineEx`	`updateRtmpTranscodingEx`
`Rte`	`Rte`
`Rte`	`destroy`
`Rte`	`getConfigs`
`Rte`	`getFromBridge`
`Rte`	`initMediaEngine`
`Rte`	`setConfigs`
`RteException`	`errorCode`
`WatermarkBuffer`	`getBuffer`
`WatermarkBuffer`	`getFormat`
`WatermarkBuffer`	`getHeight`
`WatermarkBuffer`	`getId`
`WatermarkBuffer`	`getWidth`
`WatermarkConfig`	`getImageUrl`
`WatermarkConfig`	`getOptions`
`WatermarkConfig`	`getType`
`WatermarkOptions`	`getPositionInLandscapeMode`
`WatermarkOptions`	`getPositionInPortraitMode`
`WatermarkOptions`	`getzOrder`
`WatermarkOptions`	`isVisibleInPreview`