nimeet 文档中心
English

HarmonyOS(ArkTS) API 参考

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

由公开 SDK 接口定义生成

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

接口概览

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

核对项数量
接口 / 类88
方法317
方法重载317
属性413
枚举86
错误码常量40

可用性

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

加入频道核心链路

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

步骤接口方法重载数
创建 / 初始化__unattributed__create1
加入频道__unattributed__joinChannelWithUserAccount1
续期 TokenIAgoraMusicContentCenterrenewToken1
开启视频与预览RtcEngineenableVideo1
离开频道RtcEngineleaveChannel1
订阅远端媒体RtcEnginemuteRemoteAudioStream1
频道场景RtcEnginesetChannelProfile1
角色切换RtcEnginesetClientRole1
本地画面RtcEnginesetupLocalVideo1

最小可运行链路的参数

参数类型可选可变参数
configRtcEngineConfig否否
tokenstring否否
channelNamestring否否
userAccountstring否否
optionsChannelMediaOptions是否
tokenstring否否
optionsLeaveChannelOptions是否
uidnumber否否
mutedboolean否否
profilenumber否否
rolenumber否否
optionsClientRoleOptions是否
canvasVideoCanvas否否

接口索引

接口方法属性事件
__unattributed__7800
AdvancedConfigInfo010
AdvanceOptions030
AgoraFacePositionInfo050
AgoraImage070
AgoraMediaRecorder300
AgoraRhythmPlayerConfig020
AudioCaptureParameters030
AudioEncodedFrameObserverConfig020
AudioFrame050
AudioRecordingConfiguration050
AudioSpectrumInfo010
AudioTrackConfig010
AudioVolumeInfo040
BeautyOptions050
CacheStatistics030
CameraCapturerConfiguration030
CaptureFormat030
ChannelMediaInfo030
ChannelMediaOptions0240
ChannelMediaRelayConfiguration010
ClientRoleOptions010
ClimaxSegment020
ContentInspectConfig040
ContentInspectModule020
DataStreamConfig020
DeviceInfo010
DirectCdnStreamingMediaOptions050
DirectCdnStreamingStats050
EchoTestConfiguration060
EncodedVideoFrameInfo0100
EncryptionConfig030
IAgoraMusicContentCenter1800
IAgoraMusicPlayer100
ImageTrackOptions020
IMediaPlayer3400
IMediaPlayerObserver1001
IMediaRecorderCallback200
IRtcEngineEventHandler5100
LastmileProbeConfig040
LastmileProbeOneWayResult030
LastmileProbeResult040
LeaveChannelOptions030
LiveTranscoding0130
LocalAccessPointConfiguration050
LocalAudioStats080
LocalTranscoderConfiguration020
LocalVideoStats0220
LogConfig030
LogUploadServerInfo040
LowlightEnhanceOptions020
MediaPlayerSource080
MediaRecorderConfiguration050
MediaStreamInfo0120
Music0100
MusicCacheInfo010
MusicChartInfo020
MusicContentCenterConfiguration040
PlayerPlaybackStats040
PlayerUpdatedInfo060
RecorderInfo030
RecorderStreamInfo020
Rectangle040
RemoteAudioStats0160
RemoteVideoStats0160
RtcConnection020
RtcEngine10100
RtcEngineConfig050
RtcEngineEx1900
RtcStats0240
ScreenCaptureParameters030
SegmentationProperty020
SimulcastStreamConfig030
SpatialAudioZone090
SrcInfo020
TranscodingUser080
TranscodingVideoStream070
UserInfo020
VideoCanvas050
VideoCaptureParameters030
VideoDenoiserOptions020
VideoDimensions020
VideoEncoderConfiguration090
VideoFrame0180
VideoLayout080
VideoSubscriptionOptions020
VirtualBackgroundSource040
WatermarkOptions030

全部接口

__unattributed__ 78 方法 / 0 属性
typescript
addBackgroundImage(backgroundImage: unknown): unknown
create(config: RtcEngineConfig): RtcEngine
createCustomAudioTrack(trackType: Constants.AudioTrackType, config: AudioTrackConfig): number
createEngine(context: Context, appID: string, handler: IRtcEngineEventHandler): RtcEngine
destroy(): number
destroyCustomAudioTrack(trackId: number): number
destroyMediaRecorder(recorder: AgoraMediaRecorder): void
enableAutoRemoveCache(enable: unknown): unknown
enableEncryptionEx(enabled: boolean, config: EncryptionConfig, connection: RtcConnection): number
enableFaceDetection(enabled: boolean): number
enableVideoImageSource(enabled: boolean, options: ImageTrackOptions): number
getCacheDir(): unknown
getCacheFileCount(): unknown
getDestChannelMediaInfos(): Map
getEffectsVolume(): number
getMaxCacheFileCount(): unknown
getMaxCacheFileSize(): unknown
getNtpWallTimeInMs(): bigint
getSrcChannelMediaInfo(): ChannelMediaInfo
getUserInfoByUid(uid: number, userInfo: UserInfo): number
getUserInfoByUserAccount(userAccount: string, userInfo: UserInfo): number
getVolumeOfEffect(soundId: number): number
getWatermarkList(): unknown
joinChannelWithUserAccount(token: string, channelName: string, userAccount: string, options?: ChannelMediaOptions): number
joinChannelWithUserAccountEx(token: string, channelId: string, userAccount: string, options: ChannelMediaOptions, eventHandler: IRtcEngineEventHandler): number
muteRecordingSignal(muted: boolean): number
onAudioRouteChanged(route: Constants.AudioRouteTypes): void
onFacePositionChanged(imageWidth: number, imageHeight: number, faceRectArr: Array): void
onLyricResult(requestId: string, songCode: bigint, lyricUrl: string, reason: Constants.MusicContentCenterStateReason): void
onMusicChartsResult(requestId: string, list: MusicChartInfo[], reason: Constants.MusicContentCenterStateReason): void
onMusicCollectionResult(requestId: string, page: number, pageSize: number, total: number, list: Music[], reason: Constants.MusicContentCenterStateReason): void
onPreLoadEvent(requestId: string, songCode: bigint, percent: number, lyricUrl: string, state: number, reason: Constants.MusicContentCenterStateReason): void
onSongSimpleInfoResult(requestId: string, songCode: bigint, simpleInfo: string, reason: Constants.MusicContentCenterStateReason): void
onUserInfoUpdated(uid: unknown): unknown
pauseAllEffects(): number
pauseEffect(soundId: number): number
playAllEffects(loopCount: number, pitch: number, pan: number, gain: number, publish: boolean): number
playEffect(soundId: number, filePath: string, loopCount: number, pitch: number, pan: number, gain: number, publish?: boolean, startPos?: number): Promise
preloadChannelWithUserAccount(token: string, channelName: string, userAccount: string): number
preloadEffect(soundId: number, filePath: string, startPos?: number): Promise
registerLocalUserAccount(appId: string, userAccount: string): number
registerPlayerObserver(playerObserver: IMediaPlayerObserver): unknown
removeAllCaches(): unknown
removeBackgroundImage(backgroundImage: unknown): unknown
removeCacheByUri(uri: unknown): unknown
removeDestChannelInfo(channelName: string): unknown
removeOldCache(): unknown
resumeAllEffects(): number
resumeEffect(soundId: number): number
setAudioEffectPreset(preset: Constants.AudioEffectPreset): number
setBeautyEffectOptions(enabled: boolean, options: BeautyOptions, sourceType?: Constants.MediaSourceType): number
setCacheDir(): unknown
setCameraExposurePosition(positionXinView: number, positionYinView: number): number
setCameraFocusPositionInPreview(positionX: number, positionY: number): number
setCameraZoomFactor(factor: number): number
setDestChannelInfo(channelName: string, destInfo: ChannelMediaInfo): unknown
setDualStreamMode(mode: Constants.SimulcastStreamMode, streamConfig?: SimulcastStreamConfig): number
setEffectsVolume(volume: number): number
setLocalVoiceEqualization(bandFrequency: Constants.AudioEqualizationBandFrequency, bandGain: number): number
setLocalVoicePitch(pitch: number): number
setLocalVoiceReverb(reverbKey: Constants.AudioReverbType, value: number): number
setMaxCacheFileCount(count: unknown): unknown
setMaxCacheFileSize(cacheSize: unknown): unknown
setRemoteRenderModeEx(uid: number, renderMode: number, mirrorMode: number, connection: RtcConnection): number
setRemoteSubscribeFallbackOption(option: Constants.StreamFallbackOptions): number
setSrcChannelInfo(srcInfo: ChannelMediaInfo): unknown
setVolumeOfEffect(soundId: number, volume: number): number
startAudioRecording(filePath: string, quality: Constants.AudioRecordingQualityType): number
startRecordingDeviceTest(indicationInterval: number): number
stopAllEffects(): number
stopEffect(soundId: number): number
stopLocalVideoTranscoder(): number
stopRecordingDeviceTest(): number
takeSnapshotEx(connection: RtcConnection, uid: number, filePath: string): number
unRegisterPlayerObserver(): unknown
unloadAllEffects(): number
unloadEffect(soundId: number): number
updateScreenCaptureParameters(screenCaptureParameters: ScreenCaptureParameters): number

方法明细:78 / 78(参数、返回值、错误码)

方法参数返回值错误
addBackgroundImagebackgroundImage: unknownunknown错误码索引
createconfig: RtcEngineConfigRtcEngine错误码索引
createCustomAudioTracktrackType: Constants.AudioTrackType, config: AudioTrackConfignumber错误码索引
createEnginecontext: Context, appID: string, handler: IRtcEngineEventHandlerRtcEngine错误码索引
destroy—number错误码索引
destroyCustomAudioTracktrackId: numbernumber错误码索引
destroyMediaRecorderrecorder: AgoraMediaRecordervoid错误码索引
enableAutoRemoveCacheenable: unknownunknown错误码索引
enableEncryptionExenabled: boolean, config: EncryptionConfig, connection: RtcConnectionnumber错误码索引
enableFaceDetectionenabled: booleannumber错误码索引
enableVideoImageSourceenabled: boolean, options: ImageTrackOptionsnumber错误码索引
getCacheDir—unknown错误码索引
getCacheFileCount—unknown错误码索引
getDestChannelMediaInfos—Map错误码索引
getEffectsVolume—number错误码索引
getMaxCacheFileCount—unknown错误码索引
getMaxCacheFileSize—unknown错误码索引
getNtpWallTimeInMs—bigint错误码索引
getSrcChannelMediaInfo—ChannelMediaInfo错误码索引
getUserInfoByUiduid: number, userInfo: UserInfonumber错误码索引
getUserInfoByUserAccountuserAccount: string, userInfo: UserInfonumber错误码索引
getVolumeOfEffectsoundId: numbernumber错误码索引
getWatermarkList—unknown错误码索引
joinChannelWithUserAccounttoken: string, channelName: string, userAccount: string, options?: ChannelMediaOptionsnumber错误码索引
joinChannelWithUserAccountExtoken: string, channelId: string, userAccount: string, options: ChannelMediaOptions, eventHandler: IRtcEngineEventHandlernumber错误码索引
muteRecordingSignalmuted: booleannumber错误码索引
onAudioRouteChangedroute: Constants.AudioRouteTypesvoid错误码索引
onFacePositionChangedimageWidth: number, imageHeight: number, faceRectArr: Arrayvoid错误码索引
onLyricResultrequestId: string, songCode: bigint, lyricUrl: string, reason: Constants.MusicContentCenterStateReasonvoid错误码索引
onMusicChartsResultrequestId: string, list: MusicChartInfo[], reason: Constants.MusicContentCenterStateReasonvoid错误码索引
onMusicCollectionResultrequestId: string, page: number, pageSize: number, total: number, list: Music[], reason: Constants.MusicContentCenterStateReasonvoid错误码索引
onPreLoadEventrequestId: string, songCode: bigint, percent: number, lyricUrl: string, state: number, reason: Constants.MusicContentCenterStateReasonvoid错误码索引
onSongSimpleInfoResultrequestId: string, songCode: bigint, simpleInfo: string, reason: Constants.MusicContentCenterStateReasonvoid错误码索引
onUserInfoUpdateduid: unknownunknown错误码索引
pauseAllEffects—number错误码索引
pauseEffectsoundId: numbernumber错误码索引
playAllEffectsloopCount: number, pitch: number, pan: number, gain: number, publish: booleannumber错误码索引
playEffectsoundId: number, filePath: string, loopCount: number, pitch: number, pan: number, gain: number, publish?: boolean, startPos?: numberPromise错误码索引
preloadChannelWithUserAccounttoken: string, channelName: string, userAccount: stringnumber错误码索引
preloadEffectsoundId: number, filePath: string, startPos?: numberPromise错误码索引
registerLocalUserAccountappId: string, userAccount: stringnumber错误码索引
registerPlayerObserverplayerObserver: IMediaPlayerObserverunknown错误码索引
removeAllCaches—unknown错误码索引
removeBackgroundImagebackgroundImage: unknownunknown错误码索引
removeCacheByUriuri: unknownunknown错误码索引
removeDestChannelInfochannelName: stringunknown错误码索引
removeOldCache—unknown错误码索引
resumeAllEffects—number错误码索引
resumeEffectsoundId: numbernumber错误码索引
setAudioEffectPresetpreset: Constants.AudioEffectPresetnumber错误码索引
setBeautyEffectOptionsenabled: boolean, options: BeautyOptions, sourceType?: Constants.MediaSourceTypenumber错误码索引
setCacheDir—unknown错误码索引
setCameraExposurePositionpositionXinView: number, positionYinView: numbernumber错误码索引
setCameraFocusPositionInPreviewpositionX: number, positionY: numbernumber错误码索引
setCameraZoomFactorfactor: numbernumber错误码索引
setDestChannelInfochannelName: string, destInfo: ChannelMediaInfounknown错误码索引
setDualStreamModemode: Constants.SimulcastStreamMode, streamConfig?: SimulcastStreamConfignumber错误码索引
setEffectsVolumevolume: numbernumber错误码索引
setLocalVoiceEqualizationbandFrequency: Constants.AudioEqualizationBandFrequency, bandGain: numbernumber错误码索引
setLocalVoicePitchpitch: numbernumber错误码索引
setLocalVoiceReverbreverbKey: Constants.AudioReverbType, value: numbernumber错误码索引
setMaxCacheFileCountcount: unknownunknown错误码索引
setMaxCacheFileSizecacheSize: unknownunknown错误码索引
setRemoteRenderModeExuid: number, renderMode: number, mirrorMode: number, connection: RtcConnectionnumber错误码索引
setRemoteSubscribeFallbackOptionoption: Constants.StreamFallbackOptionsnumber错误码索引
setSrcChannelInfosrcInfo: ChannelMediaInfounknown错误码索引
setVolumeOfEffectsoundId: number, volume: numbernumber错误码索引
startAudioRecordingfilePath: string, quality: Constants.AudioRecordingQualityTypenumber错误码索引
startRecordingDeviceTestindicationInterval: numbernumber错误码索引
stopAllEffects—number错误码索引
stopEffectsoundId: numbernumber错误码索引
stopLocalVideoTranscoder—number错误码索引
stopRecordingDeviceTest—number错误码索引
takeSnapshotExconnection: RtcConnection, uid: number, filePath: stringnumber错误码索引
unRegisterPlayerObserver—unknown错误码索引
unloadAllEffects—number错误码索引
unloadEffectsoundId: numbernumber错误码索引
updateScreenCaptureParametersscreenCaptureParameters: ScreenCaptureParametersnumber错误码索引
AdvancedConfigInfo 0 方法 / 1 属性
属性类型只读
logUploadServerunknown否
AdvanceOptions 0 方法 / 3 属性
属性类型只读
encodingPreferenceunknown否
compressionPreferenceunknown否
encodeAlphaunknown否
AgoraFacePositionInfo 0 方法 / 5 属性
属性类型只读
xunknown否
yunknown否
widthunknown否
heightunknown否
distanceunknown否
AgoraImage 0 方法 / 7 属性
属性类型只读
urlunknown否
xunknown否
yunknown否
widthunknown否
heightunknown否
zOrderunknown否
alphaunknown否
AgoraMediaRecorder 3 方法 / 0 属性
typescript
setMediaRecorderObserver(callback: IMediaRecorderCallback | null): number
startRecording(config: MediaRecorderConfiguration): number
stopRecording(): number

方法明细:3 / 3(参数、返回值、错误码)

方法参数返回值错误
setMediaRecorderObservercallback: IMediaRecorderCallback | nullnumber错误码索引
startRecordingconfig: MediaRecorderConfigurationnumber错误码索引
stopRecording—number错误码索引
AgoraRhythmPlayerConfig 0 方法 / 2 属性
属性类型只读
beatsPerMeasureunknown否
beatsPerMinuteunknown否
AudioCaptureParameters 0 方法 / 3 属性
属性类型只读
sampleRateunknown否
channelsunknown否
captureSignalVolumeunknown否
AudioEncodedFrameObserverConfig 0 方法 / 2 属性
属性类型只读
postionTypeunknown否
encodingTypeunknown否
AudioFrame 0 方法 / 5 属性
属性类型只读
samplesPerChannelunknown否
bytesPerSampleunknown否
channelNumsunknown否
sampleRataHzunknown否
timestampunknown否
AudioRecordingConfiguration 0 方法 / 5 属性
属性类型只读
filePathunknown否
codecunknown否
sampleRateunknown否
qualityunknown否
recordingChannelunknown否
AudioSpectrumInfo 0 方法 / 1 属性
属性类型只读
audioSpectrumDataunknown否
AudioTrackConfig 0 方法 / 1 属性
属性类型只读
enableLocalPlaybackunknown否
AudioVolumeInfo 0 方法 / 4 属性
属性类型只读
uidunknown否
volumeunknown否
vadunknown否
voicePitchunknown否
BeautyOptions 0 方法 / 5 属性
属性类型只读
lighteningContrastLevelunknown否
lighteningLevelunknown否
smoothnessLevelunknown否
rednessLevelunknown否
sharpnessLevelunknown否
CacheStatistics 0 方法 / 3 属性
属性类型只读
fileSizeunknown否
cacheSizeunknown否
downloadSizeunknown否
CameraCapturerConfiguration 0 方法 / 3 属性
属性类型只读
cameraDirectionunknown否
captureFormatunknown否
followEncodeDimensionRatiounknown否
CaptureFormat 0 方法 / 3 属性
属性类型只读
widthunknown否
heightunknown否
fpsunknown否
ChannelMediaInfo 0 方法 / 3 属性
属性类型只读
channelNameunknown否
tokenunknown否
uidunknown否
ChannelMediaOptions 0 方法 / 24 属性
属性类型只读
publishCameraTrackunknown否
publishMicrophoneTrackunknown否
publishScreenCaptureVideounknown否
publishScreenCaptureAudiounknown否
publishCustomAudioTrackunknown否
publishCustomAudioTrackIdunknown否
publishCustomVideoTrackunknown否
publishEncodedVideoTrackunknown否
publishMediaPlayerAudioTrackunknown否
publishMediaPlayerVideoTrackunknown否
autoSubscribeAudiounknown否
autoSubscribeVideounknown否
enableAudioRecordingOrPlayoutunknown否
publishMediaPlayerIdunknown否
clientRoleTypeunknown否
audienceLatencyLevelunknown否
defaultVideoStreamTypeunknown否
channelProfileunknown否
audioDelayMsunknown否
tokenunknown否
publishRhythmPlayerTrackunknown否
isInteractiveAudienceunknown否
customVideoTrackIdunknown否
isAudioFilterableunknown否
ChannelMediaRelayConfiguration 0 方法 / 1 属性
属性类型只读
setSrcChannelInfounknown否
ClientRoleOptions 0 方法 / 1 属性
属性类型只读
audienceLatencyLevelunknown否
ClimaxSegment 0 方法 / 2 属性
属性类型只读
startTimeMsunknown否
endTimeMsunknown否
ContentInspectConfig 0 方法 / 4 属性
属性类型只读
extraInfounknown否
serverConfigunknown否
modulesunknown否
moduleCountunknown否
ContentInspectModule 0 方法 / 2 属性
属性类型只读
typeunknown否
intervalunknown否
DataStreamConfig 0 方法 / 2 属性
属性类型只读
syncWithAudiounknown否
orderedunknown否
DeviceInfo 0 方法 / 1 属性
属性类型只读
isLowLatencyAudioSupportedunknown否
DirectCdnStreamingMediaOptions 0 方法 / 5 属性
属性类型只读
publishCameraTrackunknown否
publishMicrophoneTrackunknown否
publishCustomAudioTrackunknown否
publishCustomVideoTrackunknown否
customVideoTrackIdunknown否
DirectCdnStreamingStats 0 方法 / 5 属性
属性类型只读
videoWidthunknown否
videoHeightunknown否
fpsunknown否
videoBitrateunknown否
audioBitrateunknown否
EchoTestConfiguration 0 方法 / 6 属性
属性类型只读
viewunknown否
enableAudiounknown否
enableVideounknown否
tokenunknown否
channelIdunknown否
intervalInSecondsunknown否
EncodedVideoFrameInfo 0 方法 / 10 属性
属性类型只读
codecTypeunknown否
widthunknown否
heightunknown否
framesPerSecondunknown否
frameTypeunknown否
rotationunknown否
trackIdunknown否
captureTimeMsunknown否
uidunknown否
streamTypeunknown否
EncryptionConfig 0 方法 / 3 属性
属性类型只读
encryptionModeunknown否
encryptionKeyunknown否
encryptionKdfSaltunknown否
IAgoraMusicContentCenter 18 方法 / 0 属性
typescript
createMusicPlayer(): IAgoraMusicPlayer
destroy(): void
destroyMusicPlayer(): unknown
getCaches(): MusicCacheInfo[]
getInternalSongCode(songCode: bigint, jsonOption: string): bigint
getLyric(songCode: bigint, lyricType: number): string
getMusicCharts(): string
getMusicCollectionByMusicChartId(musicChartId: number, page: number, pageSize: number, jsonOption?: string): string
getSongSimpleInfo(songCode: bigint): string
initialize(configuration: MusicContentCenterConfiguration): number
isPreloaded(songCode: bigint): number
preload(songCode: bigint): string
registerEventHandler(eventHandler: IMusicContentCenterEventHandler): number
release(): void
removeCache(songCode: bigint): number
renewToken(token: string): number
searchMusic(keyword: string, page: number, pageSize: number, jsonOption?: string): string
unregisterEventHandler(): number

方法明细:18 / 18(参数、返回值、错误码)

方法参数返回值错误
createMusicPlayer—IAgoraMusicPlayer错误码索引
destroy—void错误码索引
destroyMusicPlayer—unknown错误码索引
getCaches—MusicCacheInfo[]错误码索引
getInternalSongCodesongCode: bigint, jsonOption: stringbigint错误码索引
getLyricsongCode: bigint, lyricType: numberstring错误码索引
getMusicCharts—string错误码索引
getMusicCollectionByMusicChartIdmusicChartId: number, page: number, pageSize: number, jsonOption?: stringstring错误码索引
getSongSimpleInfosongCode: bigintstring错误码索引
initializeconfiguration: MusicContentCenterConfigurationnumber错误码索引
isPreloadedsongCode: bigintnumber错误码索引
preloadsongCode: bigintstring错误码索引
registerEventHandlereventHandler: IMusicContentCenterEventHandlernumber错误码索引
release—void错误码索引
removeCachesongCode: bigintnumber错误码索引
renewTokentoken: stringnumber错误码索引
searchMusickeyword: string, page: number, pageSize: number, jsonOption?: stringstring错误码索引
unregisterEventHandler—number错误码索引
IAgoraMusicPlayer 1 方法 / 0 属性
typescript
setPlayMode(mode: Constants.MusicPlayMode): number

方法明细:1 / 1(参数、返回值、错误码)

方法参数返回值错误
setPlayModemode: Constants.MusicPlayModenumber错误码索引
ImageTrackOptions 0 方法 / 2 属性
属性类型只读
imageUrlunknown否
fpsunknown否
IMediaPlayer 34 方法 / 0 属性
typescript
adjustPlayoutVolume(vol: number): number
adjustPublishSignalVolume(volume: number): number
getDuration(): number
getMediaPlayerId(): number
getMute(): boolean
getPlayPosition(): number
getPlaySrc(): string
getPlayoutVolume(): number
getPublishSignalVolume(): number
getState(): Constants.MediaPlayerState
getStreamCount(): number
getStreamInfo(index: number): MediaStreamInfo|undefined
mute(muted: boolean): number
open(url: string, startPos: number): number
openWithMediaSource(source: MediaPlayerSource): number
pause(): number
play(): number
playPreloadedSrc(src: string): number
preloadSrc(src: string, startPos: number): number
resume(): number
seek(newPos: number): number
selectAudioTrack(index: number): number
selectMultiAudioTrack(playoutTrackIndex: number, publishTrackIndex: number): number
setAudioDualMonoMode(mode: Constants.AudioDualMonoMode): number
setAudioPitch(pitch: number): number
setLoopCount(loopCount: number): number
setPlaybackSpeed(speed: number): number
setPlayerOption(key: string, value: number): unknown
setPlayerOptionString(key: string, value: string): number
setRenderMode(mode: number): number
setView(view: string): number
stop(): number
switchSrc(src: string, syncPts: boolean): number
unloadSrc(src: string): number

方法明细:34 / 34(参数、返回值、错误码)

方法参数返回值错误
adjustPlayoutVolumevol: numbernumber错误码索引
adjustPublishSignalVolumevolume: numbernumber错误码索引
getDuration—number错误码索引
getMediaPlayerId—number错误码索引
getMute—boolean错误码索引
getPlayPosition—number错误码索引
getPlaySrc—string错误码索引
getPlayoutVolume—number错误码索引
getPublishSignalVolume—number错误码索引
getState—Constants.MediaPlayerState错误码索引
getStreamCount—number错误码索引
getStreamInfoindex: numberMediaStreamInfo|undefined错误码索引
mutemuted: booleannumber错误码索引
openurl: string, startPos: numbernumber错误码索引
openWithMediaSourcesource: MediaPlayerSourcenumber错误码索引
pause—number错误码索引
play—number错误码索引
playPreloadedSrcsrc: stringnumber错误码索引
preloadSrcsrc: string, startPos: numbernumber错误码索引
resume—number错误码索引
seeknewPos: numbernumber错误码索引
selectAudioTrackindex: numbernumber错误码索引
selectMultiAudioTrackplayoutTrackIndex: number, publishTrackIndex: numbernumber错误码索引
setAudioDualMonoModemode: Constants.AudioDualMonoModenumber错误码索引
setAudioPitchpitch: numbernumber错误码索引
setLoopCountloopCount: numbernumber错误码索引
setPlaybackSpeedspeed: numbernumber错误码索引
setPlayerOptionkey: string, value: numberunknown错误码索引
setPlayerOptionStringkey: string, value: stringnumber错误码索引
setRenderModemode: numbernumber错误码索引
setViewview: stringnumber错误码索引
stop—number错误码索引
switchSrcsrc: string, syncPts: booleannumber错误码索引
unloadSrcsrc: stringnumber错误码索引
IMediaPlayerObserver 10 方法 / 0 属性
typescript
onAudioVolumeIndication(volume: number): void
onMetaData(type: Constants.MediaPlayerMetadataType, data: ArrayBuffer): void
onPlayBufferUpdated(playCachedBuffer: number): void
onPlayerEvent(eventCode: Constants.MediaPlayerEvent, elapsedTime: number, 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: number, timestampMs: number): void
onPreloadEvent(src: string, event: Constants.MediaPlayerPreloadEvent): void

方法明细:10 / 10(参数、返回值、错误码)

方法参数返回值错误
onAudioVolumeIndicationvolume: numbervoid错误码索引
onMetaDatatype: Constants.MediaPlayerMetadataType, data: ArrayBuffervoid错误码索引
onPlayBufferUpdatedplayCachedBuffer: numbervoid错误码索引
onPlayerEventeventCode: Constants.MediaPlayerEvent, elapsedTime: number, message: stringvoid错误码索引
onPlayerInfoUpdatedinfo: PlayerUpdatedInfovoid错误码索引
onPlayerPlaybackStatsstats: PlayerPlaybackStatsvoid错误码索引
onPlayerSrcInfoChangedfrom: SrcInfo, to: SrcInfovoid错误码索引
onPlayerStateChangedstate: Constants.MediaPlayerState, reason: Constants.MediaPlayerReasonvoid错误码索引
onPositionChangedpositionMs: number, timestampMs: numbervoid错误码索引
onPreloadEventsrc: string, event: Constants.MediaPlayerPreloadEventvoid错误码索引
事件名回调参数
onPlayerCacheStatsonPlayerCacheStats?:(stats:CacheStatistics
typescript
onAudioVolumeIndication(volume: number): void
onMetaData(type: Constants.MediaPlayerMetadataType, data: ArrayBuffer): void
onPlayBufferUpdated(playCachedBuffer: number): void
onPlayerEvent(eventCode: Constants.MediaPlayerEvent, elapsedTime: number, 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: number, timestampMs: number): void
onPreloadEvent(src: string, event: Constants.MediaPlayerPreloadEvent): void
IMediaRecorderCallback 2 方法 / 0 属性
typescript
onRecorderInfoUpdated(channelId: string, uid: number, info: RecorderInfo): void
onRecorderStateChanged(channelId: string, uid: number, state: number, reason: number): void

方法明细:2 / 2(参数、返回值、错误码)

方法参数返回值错误
onRecorderInfoUpdatedchannelId: string, uid: number, info: RecorderInfovoid错误码索引
onRecorderStateChangedchannelId: string, uid: number, state: number, reason: numbervoid错误码索引
IRtcEngineEventHandler 51 方法 / 0 属性
typescript
onAudioEffectFinished(soundId: number): void
onAudioMixingPositionChanged(position: bigint): void
onAudioMixingStateChanged(state: Constants.AudioMixingState, reason: Constants.AudioMixingReason): void
onAudioPublishStateChanged(channel: string, oldState: Constants.StreamPublishState, newState: Constants.StreamPublishState, elapseSinceLastState: number): void
onAudioSubscribeStateChanged(channel: string, uid: number, oldState: Constants.StreamSubscribeState, newState: Constants.StreamSubscribeState, elapseSinceLastState: number): void
onAudioVolumeIndication(speakers: Array, totalVolume: number): void
onCameraExposureAreaChanged(rect: camera.Rect): void
onCameraFocusPointChanged(point: camera.Point): void
onChannelMediaRelayStateChanged(state: Constants.ChannelMediaRelayState, code: Constants.ChannelMediaRelayError): void
onClientRoleChangeFailed(reason: number, currentRole: Constants.ClientRole): void
onClientRoleChanged(oldRole: Constants.ClientRole, newRole: Constants.ClientRole, newRoleOptions: ClientRoleOptions): void
onConnectionLost(): void
onConnectionStateChanged(state: Constants.ConnectionState, reason: Constants.ConnectionChangedReason): void
onEncryptionError(errorType: Constants.EncryptionError): void
onError(err: Constants.ErrorCode, message: string): void
onFirstLocalVideoFrame(source: Constants.VideoSourceType, width: number, height: number, elapsed: number): void
onFirstRemoteVideoFrame(uid: number, width: number, height: number, elapsed: number): void
onJoinChannelSuccess(channel: string, uid: number, elapsed: number): void
onLastmileProbeResult(result: LastmileProbeResult): void
onLastmileQuality(quality: Constants.QualityType): void
onLeaveChannel(stats: RtcStats): void
onLocalAudioStateChanged(state: Constants.LocalAudioStreamState, error: Constants.LocalAudioStreamReason): void
onLocalAudioStats(stats: LocalAudioStats): void
onLocalUserRegistered(uid: unknown, userAccount: unknown): unknown
onLocalVideoStateChanged(source: Constants.VideoSourceType, state: Constants.LocalVideoStreamState, reason: Constants.LocalVideoStreamReason): void
onLocalVideoStats(source: Constants.VideoSourceType, stats: LocalVideoStats): void
onLocalVideoTranscoderError(stream: TranscodingVideoStream, error: Constants.VideoTranscoderError): void
onNetworkQuality(uid: number, txQuality: Constants.NetworkQuality, rxQuality: Constants.NetworkQuality): void
onPermissionError(permission: Constants.PermissionType): void
onRejoinChannelSuccess(channel: string, uid: number, elapsed: number): void
onRemoteAudioStateChanged(uid: number, state: Constants.RemoteAudioStreamState, reason: Constants.RemoteAudioStreamReason, elapsed: number): void
onRemoteAudioStats(stats: RemoteAudioStats): void
onRemoteVideoStateChanged(uid: number, state: Constants.RemoteVideoStreamState, reason: Constants.RemoteVideoStreamReason, elapsed: number): void
onRemoteVideoStats(stats: RemoteVideoStats): void
onRequestToken(): void
onRtcStats(stats: RtcStats): void
onRtmpStreamingEvent(url: string, event: Constants.RtmpStreamingEvent): void
onRtmpStreamingStateChanged(url: string, state: Constants.RtmpStreamPublishState, reason: Constants.RtmpStreamPublishReason): void
onSnapshotTaken(uid: number, filePath: string, width: number, height: number, errCode: number): void
onStreamMessage(uid: number, streamId: number, data: Uint8Array): void
onStreamMessageError(uid: number, streamId: number, error: number, missed: number, cached: number): void
onTokenPrivilegeWillExpire(token: string): void
onTranscodingUpdated(): void
onUserEnableVideo(uid: number, enabled: boolean): void
onUserJoined(uid: number, elapse: number): void
onUserMuteAudio(uid: number, muted: boolean): void
onUserMuteVideo(uid: number, muted: boolean): void
onUserOffline(uid: number, reason: number): void
onVideoPublishStateChanged(source: Constants.VideoSourceType, channel: string, oldState: Constants.StreamPublishState, newState: Constants.StreamPublishState, elapseSinceLastState: number): void
onVideoSizeChanged(source: Constants.VideoSourceType, uid: number, width: number, height: number, rotation: number): void
onVideoSubscribeStateChanged(channel: string, uid: number, oldState: Constants.StreamSubscribeState, newState: Constants.StreamSubscribeState, elapseSinceLastState: number): void

方法明细:51 / 51(参数、返回值、错误码)

方法参数返回值错误
onAudioEffectFinishedsoundId: numbervoid错误码索引
onAudioMixingPositionChangedposition: bigintvoid错误码索引
onAudioMixingStateChangedstate: Constants.AudioMixingState, reason: Constants.AudioMixingReasonvoid错误码索引
onAudioPublishStateChangedchannel: string, oldState: Constants.StreamPublishState, newState: Constants.StreamPublishState, elapseSinceLastState: numbervoid错误码索引
onAudioSubscribeStateChangedchannel: string, uid: number, oldState: Constants.StreamSubscribeState, newState: Constants.StreamSubscribeState, elapseSinceLastState: numbervoid错误码索引
onAudioVolumeIndicationspeakers: Array, totalVolume: numbervoid错误码索引
onCameraExposureAreaChangedrect: camera.Rectvoid错误码索引
onCameraFocusPointChangedpoint: camera.Pointvoid错误码索引
onChannelMediaRelayStateChangedstate: Constants.ChannelMediaRelayState, code: Constants.ChannelMediaRelayErrorvoid错误码索引
onClientRoleChangeFailedreason: number, currentRole: Constants.ClientRolevoid错误码索引
onClientRoleChangedoldRole: Constants.ClientRole, newRole: Constants.ClientRole, newRoleOptions: ClientRoleOptionsvoid错误码索引
onConnectionLost—void错误码索引
onConnectionStateChangedstate: Constants.ConnectionState, reason: Constants.ConnectionChangedReasonvoid错误码索引
onEncryptionErrorerrorType: Constants.EncryptionErrorvoid错误码索引
onErrorerr: Constants.ErrorCode, message: stringvoid错误码索引
onFirstLocalVideoFramesource: Constants.VideoSourceType, width: number, height: number, elapsed: numbervoid错误码索引
onFirstRemoteVideoFrameuid: number, width: number, height: number, elapsed: numbervoid错误码索引
onJoinChannelSuccesschannel: string, uid: number, elapsed: numbervoid错误码索引
onLastmileProbeResultresult: LastmileProbeResultvoid错误码索引
onLastmileQualityquality: Constants.QualityTypevoid错误码索引
onLeaveChannelstats: RtcStatsvoid错误码索引
onLocalAudioStateChangedstate: Constants.LocalAudioStreamState, error: Constants.LocalAudioStreamReasonvoid错误码索引
onLocalAudioStatsstats: LocalAudioStatsvoid错误码索引
onLocalUserRegistereduid: unknown, userAccount: unknownunknown错误码索引
onLocalVideoStateChangedsource: Constants.VideoSourceType, state: Constants.LocalVideoStreamState, reason: Constants.LocalVideoStreamReasonvoid错误码索引
onLocalVideoStatssource: Constants.VideoSourceType, stats: LocalVideoStatsvoid错误码索引
onLocalVideoTranscoderErrorstream: TranscodingVideoStream, error: Constants.VideoTranscoderErrorvoid错误码索引
onNetworkQualityuid: number, txQuality: Constants.NetworkQuality, rxQuality: Constants.NetworkQualityvoid错误码索引
onPermissionErrorpermission: Constants.PermissionTypevoid错误码索引
onRejoinChannelSuccesschannel: string, uid: number, elapsed: numbervoid错误码索引
onRemoteAudioStateChangeduid: number, state: Constants.RemoteAudioStreamState, reason: Constants.RemoteAudioStreamReason, elapsed: numbervoid错误码索引
onRemoteAudioStatsstats: RemoteAudioStatsvoid错误码索引
onRemoteVideoStateChangeduid: number, state: Constants.RemoteVideoStreamState, reason: Constants.RemoteVideoStreamReason, elapsed: numbervoid错误码索引
onRemoteVideoStatsstats: RemoteVideoStatsvoid错误码索引
onRequestToken—void错误码索引
onRtcStatsstats: RtcStatsvoid错误码索引
onRtmpStreamingEventurl: string, event: Constants.RtmpStreamingEventvoid错误码索引
onRtmpStreamingStateChangedurl: string, state: Constants.RtmpStreamPublishState, reason: Constants.RtmpStreamPublishReasonvoid错误码索引
onSnapshotTakenuid: number, filePath: string, width: number, height: number, errCode: numbervoid错误码索引
onStreamMessageuid: number, streamId: number, data: Uint8Arrayvoid错误码索引
onStreamMessageErroruid: number, streamId: number, error: number, missed: number, cached: numbervoid错误码索引
onTokenPrivilegeWillExpiretoken: stringvoid错误码索引
onTranscodingUpdated—void错误码索引
onUserEnableVideouid: number, enabled: booleanvoid错误码索引
onUserJoineduid: number, elapse: numbervoid错误码索引
onUserMuteAudiouid: number, muted: booleanvoid错误码索引
onUserMuteVideouid: number, muted: booleanvoid错误码索引
onUserOfflineuid: number, reason: numbervoid错误码索引
onVideoPublishStateChangedsource: Constants.VideoSourceType, channel: string, oldState: Constants.StreamPublishState, newState: Constants.StreamPublishState, elapseSinceLastState: numbervoid错误码索引
onVideoSizeChangedsource: Constants.VideoSourceType, uid: number, width: number, height: number, rotation: numbervoid错误码索引
onVideoSubscribeStateChangedchannel: string, uid: number, oldState: Constants.StreamSubscribeState, newState: Constants.StreamSubscribeState, elapseSinceLastState: numbervoid错误码索引
LastmileProbeConfig 0 方法 / 4 属性
属性类型只读
probeUplinkunknown否
probeDownlinkunknown否
expectedUplinkBitrateunknown否
expectedDownlinkBitrateunknown否
LastmileProbeOneWayResult 0 方法 / 3 属性
属性类型只读
packetLossRateunknown否
jitterunknown否
availableBandwidthunknown否
LastmileProbeResult 0 方法 / 4 属性
属性类型只读
stateunknown否
uplinkReportunknown否
downlinkReportunknown否
rttunknown否
LeaveChannelOptions 0 方法 / 3 属性
属性类型只读
stopAudioMixingunknown否
stopAllEffectunknown否
stopMicrophoneRecordingunknown否
LiveTranscoding 0 方法 / 13 属性
属性类型只读
widthunknown否
heightunknown否
videoBitrateunknown否
videoFrameRateunknown否
videoGopunknown否
videoCodecProfileunknown否
videoCodecTypeunknown否
transcodingUsersunknown否
userConfigExtraInfounknown否
audioSampleRateunknown否
audioBitrateunknown否
audioChannelsunknown否
audioCodecProfileunknown否
LocalAccessPointConfiguration 0 方法 / 5 属性
属性类型只读
ipListunknown否
domainListunknown否
verifyDomainNameunknown否
modeunknown否
advancedConfigunknown否
LocalAudioStats 0 方法 / 8 属性
属性类型只读
numChannelsunknown否
sentSampleRateunknown否
sentBitrateunknown否
txPacketLossRateunknown否
internalCodecunknown否
audioDeviceDelayunknown否
earMonitorDelayunknown否
aecEstimatedDelayunknown否
LocalTranscoderConfiguration 0 方法 / 2 属性
属性类型只读
transcodingVideoStreamsunknown否
videoOutputConfigurationunknown否
LocalVideoStats 0 方法 / 22 属性
属性类型只读
uidunknown否
sentBitrateunknown否
sentFrameRateunknown否
captureFrameRateunknown否
captureFrameWidthunknown否
captureFrameHeightunknown否
regulatedCaptureFrameRateunknown否
regulatedCaptureFrameWidthunknown否
regulatedCaptureFrameHeightunknown否
encoderOutputFrameRateunknown否
rendererOutputFrameRateunknown否
targetBitrateunknown否
targetFrameRateunknown否
qualityAdaptIndicationunknown否
encodedBitrateunknown否
encodedFrameHeightunknown否
encodedFrameWidthunknown否
encodedFrameCountunknown否
codecTypeunknown否
txPacketLossRateunknown否
captureBrightnessLevelunknown否
hwEncoderAcceleratingunknown否
LogConfig 0 方法 / 3 属性
属性类型只读
filePathunknown否
fileSizeInKBunknown否
levelunknown否
LogUploadServerInfo 0 方法 / 4 属性
属性类型只读
serverDomainunknown否
serverPathunknown否
serverPortunknown否
serverHttpsunknown否
LowlightEnhanceOptions 0 方法 / 2 属性
属性类型只读
levelunknown否
modeunknown否
MediaPlayerSource 0 方法 / 8 属性
属性类型只读
urlunknown否
uriunknown否
startPosunknown否
autoPlayunknown否
enableCacheunknown否
enableMultiAudioTrackunknown否
isAgoraSourceunknown否
isLiveSourceBoolean否
MediaRecorderConfiguration 0 方法 / 5 属性
属性类型只读
storagePathunknown否
containerFormatunknown否
streamTypeunknown否
maxDurationMsunknown否
recorderInfoUpdateIntervalunknown否
MediaStreamInfo 0 方法 / 12 属性
属性类型只读
streamIndexunknown否
mediaStreamTypeunknown否
codecNameunknown否
languageunknown否
videoFrameRateunknown否
videoBitRateunknown否
videoWidthunknown否
videoHeightunknown否
audioSampleRateunknown否
audioChannelsunknown否
audioBytesPerSampleunknown否
durationunknown否
Music 0 方法 / 10 属性
属性类型只读
songCodeunknown否
nameunknown否
singerunknown否
posterunknown否
releaseTimeunknown否
typeunknown否
pitchTypeunknown否
durationSunknown否
lyricTypesunknown否
climaxSegmentsMvProperty[]否
MusicCacheInfo 0 方法 / 1 属性
属性类型只读
songCodeunknown否
MusicChartInfo 0 方法 / 2 属性
属性类型只读
nameunknown否
typeunknown否
MusicContentCenterConfiguration 0 方法 / 4 属性
属性类型只读
appIdunknown否
tokenunknown否
mccUidunknown否
maxCacheSizeunknown否
PlayerPlaybackStats 0 方法 / 4 属性
属性类型只读
videoFpsunknown否
videoBitrateInKbpsunknown否
audioBitrateInKbpsunknown否
totalBitrateInKbpsunknown否
PlayerUpdatedInfo 0 方法 / 6 属性
属性类型只读
deviceIdunknown否
videoHeightunknown否
videoWidthunknown否
audioSampleRateunknown否
audioChannelsunknown否
audioBitsPerSampleunknown否
RecorderInfo 0 方法 / 3 属性
属性类型只读
fileNameunknown否
durationMsunknown否
fileSizeunknown否
RecorderStreamInfo 0 方法 / 2 属性
属性类型只读
channelIdunknown否
uidunknown否
Rectangle 0 方法 / 4 属性
属性类型只读
xunknown否
yunknown否
widthunknown否
heightunknown否
RemoteAudioStats 0 方法 / 16 属性
属性类型只读
uidunknown否
qualityunknown否
networkTransportDelayunknown否
jitterBufferDelayunknown否
audioLossRateunknown否
numChannelsunknown否
receivedSampleRateunknown否
receivedBitrateunknown否
totalFrozenTimeunknown否
frozenRateunknown否
totalActiveTimeunknown否
publishDurationunknown否
qoeQualityunknown否
qualityChangedReasonunknown否
mosValueunknown否
e2eDelayunknown否
RemoteVideoStats 0 方法 / 16 属性
属性类型只读
uidunknown否
delayunknown否
e2eDelayunknown否
widthunknown否
heightunknown否
receivedBitrateunknown否
decoderOutputFrameRateunknown否
rendererOutputFrameRateunknown否
frameLossRateunknown否
packetLossRateunknown否
rxStreamTypeunknown否
totalFrozenTimeunknown否
frozenRateunknown否
totalActiveTimeunknown否
publishDurationunknown否
avSyncTimeMsunknown否
RtcConnection 0 方法 / 2 属性
属性类型只读
channelIdunknown否
localUidunknown否
RtcEngine 101 方法 / 0 属性
typescript
adjustAudioMixingPlayoutVolume(volume: number): number
adjustAudioMixingPublishVolume(volume: number): number
adjustAudioMixingVolume(volume: number): number
adjustPlaybackSignalVolume(volume: number): number
adjustRecordingSignalVolume(volume: number): number
adjustUserPlaybackSignalVolume(uid: number, volume: number): number
createCustomVideoTrack(): number
createDataStream(config: DataStreamConfig): number
createMediaPlayer(): IMediaPlayer|undefined
createMediaRecorder(info: RecorderStreamInfo): AgoraMediaRecorder
destroy(): Promise
destroyCustomVideoTrack(videoTrackId: number): number
disableAudio(): number
disableVideo(): number
enableAudio(): number
enableAudioVolumeIndication(interval: number, smooth: number, reportVad: boolean): number
enableContentInspect(enabled: boolean, config: ContentInspectConfig): number
enableEncryption(enabled: boolean, config: EncryptionConfig): number
enableInEarMonitoring(enabled: boolean, includeAudioFilters?: Constants.EarMontoringFilterType): number
enableLocalAudio(enabled: boolean): number
enableLocalVideo(enabled: boolean): number
enableVideo(): number
enableVirtualBackground(enabled: boolean, backgroundSource: VirtualBackgroundSource, segproperty: SegmentationProperty, sourceType?: Constants.MediaSourceType): number
getAudioMixingCurrentPosition(): number
getAudioMixingDuration(): number
getAudioMixingPlayoutVolume(): number
getAudioMixingPublishVolume(): number
getCallId(): string
getCameraMaxZoomFactor(): number
getCurrentMonotonicTimeInMs(): number
getErrorDescription(error: number): string
getNativeHandle(): bigint
getSdkVersion(): string
isCameraAutoFocusFaceModeSupported(): boolean
isCameraExposurePositionSupported(): boolean
isCameraExposureSupported(): boolean
isCameraFaceDetectSupported(): boolean
isCameraFocusSupported(): boolean
isCameraZoomSupported(): boolean
isSpeakerphoneEnabled(): boolean
joinChannel(key: string, channel: string, optionalInfo: string, uid: number): number
joinChannelWithOptions(token: string, channelId: string, uid: number, options: ChannelMediaOptions): number
leaveChannel(options?: LeaveChannelOptions): number
muteAllRemoteAudioStreams(muted: boolean): number
muteAllRemoteVideoStreams(muted: boolean): number
muteLocalAudioStream(muted: boolean): number
muteLocalVideoStream(muted: boolean): number
muteRemoteAudioStream(uid: number, muted: boolean): number
muteRemoteVideoStream(uid: number, muted: boolean): number
pauseAllChannelMediaRelay(): number
pauseAudioMixing(): number
pushExternalVideoFrame(frame: VideoFrame): boolean
pushExternalVideoFrameById(frame: VideoFrame, videoTrackId: number): number
renewToken(token: string): number
resumeAllChannelMediaRelay(): number
resumeAudioMixing(): number
sendStreamMessage(streamId: number, message: ArrayBuffer): number
setAudioMixingPlaybackSpeed(speed: number): number
setAudioMixingPosition(pos: number): number
setAudioProfile(profile: Constants.AudioProfileType): number
setAudioScenario(scenario: Constants.AudioScenarioType): number
setCameraAutoFocusFaceModeEnabled(enabled: boolean): number
setCameraCapturerConfiguration(config: CameraCapturerConfiguration): number
setChannelProfile(profile: number): number
setClientRole(role: number, options?: ClientRoleOptions): number
setDefaultAudioRouteToSpeakerphone(defaultToSpeaker: boolean): number
setEnableSpeakerphone(enabled: unknown): unknown
setExternalVideoSource(enable: boolean, useTexture: boolean, sourceType: Constants.ExternalVideoSourceType): number
setInEarMonitoringVolume(volume: number): number
setLocalRenderMode(renderMode: number, mirrorMode: number): number
setParameters(parameters: string): number
setRemoteDefaultVideoStreamType(streamType: Constants.VideoStreamType): number
setRemoteRenderMode(uid: number, renderMode: number, mirrorMode: number): number
setRemoteVideoStreamType(uid: number, streamType: Constants.VideoStreamType): number
setVideoEncoderConfiguration(configuration: VideoEncoderConfiguration): number
setVoiceBeautifierPreset(preset: Constants.VoiceBeautifierPreset): number
setupLocalVideo(canvas: VideoCanvas): number
setupRemoteVideo(canvas: VideoCanvas): number
startAudioMixing(filepath: string, loopback: boolean, cycle: number, startpos?: number): number
startAudioRecordingWithConfiguration(config: AudioRecordingConfiguration): number
startCameraCapture(sourceType: Constants.VideoSourceType, config: CameraCapturerConfiguration): number
startLastmileProbeTest(config: LastmileProbeConfig): number
startLocalVideoTranscoder(config: LocalTranscoderConfiguration): number
startOrUpdateChannelMediaRelay(channelMediaRelayConfiguration: ChannelMediaRelayConfiguration): number
startPreview(sourceType?: Constants.VideoSourceType): number
startRtmpStreamWithTranscoding(url: string, transcoding: LiveTranscoding): number
startRtmpStreamWithoutTranscoding(url: string): number
startScreenCapture(screenCaptureParameters: ScreenCaptureParameters): number
stopAudioMixing(): number
stopAudioRecording(): number
stopCameraCapture(sourceType: Constants.VideoSourceType): number
stopChannelMediaRelay(): number
stopLastmileProbeTest(): number
stopPreview(sourceType?: Constants.VideoSourceType): number
stopRtmpStream(url: string): number
stopScreenCapture(): number
switchCamera(): number
takeSnapshot(uid: number, filePath: string): number
updateChannelMediaOptions(options: ChannelMediaOptions): number
updateLocalTranscoderConfiguration(config: LocalTranscoderConfiguration): number
updateRtmpTranscoding(transcoding: LiveTranscoding): number

方法明细:101 / 101(参数、返回值、错误码)

方法参数返回值错误
adjustAudioMixingPlayoutVolumevolume: numbernumber错误码索引
adjustAudioMixingPublishVolumevolume: numbernumber错误码索引
adjustAudioMixingVolumevolume: numbernumber错误码索引
adjustPlaybackSignalVolumevolume: numbernumber错误码索引
adjustRecordingSignalVolumevolume: numbernumber错误码索引
adjustUserPlaybackSignalVolumeuid: number, volume: numbernumber错误码索引
createCustomVideoTrack—number错误码索引
createDataStreamconfig: DataStreamConfignumber错误码索引
createMediaPlayer—IMediaPlayer|undefined错误码索引
createMediaRecorderinfo: RecorderStreamInfoAgoraMediaRecorder错误码索引
destroy—Promise错误码索引
destroyCustomVideoTrackvideoTrackId: numbernumber错误码索引
disableAudio—number错误码索引
disableVideo—number错误码索引
enableAudio—number错误码索引
enableAudioVolumeIndicationinterval: number, smooth: number, reportVad: booleannumber错误码索引
enableContentInspectenabled: boolean, config: ContentInspectConfignumber错误码索引
enableEncryptionenabled: boolean, config: EncryptionConfignumber错误码索引
enableInEarMonitoringenabled: boolean, includeAudioFilters?: Constants.EarMontoringFilterTypenumber错误码索引
enableLocalAudioenabled: booleannumber错误码索引
enableLocalVideoenabled: booleannumber错误码索引
enableVideo—number错误码索引
enableVirtualBackgroundenabled: boolean, backgroundSource: VirtualBackgroundSource, segproperty: SegmentationProperty, sourceType?: Constants.MediaSourceTypenumber错误码索引
getAudioMixingCurrentPosition—number错误码索引
getAudioMixingDuration—number错误码索引
getAudioMixingPlayoutVolume—number错误码索引
getAudioMixingPublishVolume—number错误码索引
getCallId—string错误码索引
getCameraMaxZoomFactor—number错误码索引
getCurrentMonotonicTimeInMs—number错误码索引
getErrorDescriptionerror: numberstring错误码索引
getNativeHandle—bigint错误码索引
getSdkVersion—string错误码索引
isCameraAutoFocusFaceModeSupported—boolean错误码索引
isCameraExposurePositionSupported—boolean错误码索引
isCameraExposureSupported—boolean错误码索引
isCameraFaceDetectSupported—boolean错误码索引
isCameraFocusSupported—boolean错误码索引
isCameraZoomSupported—boolean错误码索引
isSpeakerphoneEnabled—boolean错误码索引
joinChannelkey: string, channel: string, optionalInfo: string, uid: numbernumber错误码索引
joinChannelWithOptionstoken: string, channelId: string, uid: number, options: ChannelMediaOptionsnumber错误码索引
leaveChanneloptions?: LeaveChannelOptionsnumber错误码索引
muteAllRemoteAudioStreamsmuted: booleannumber错误码索引
muteAllRemoteVideoStreamsmuted: booleannumber错误码索引
muteLocalAudioStreammuted: booleannumber错误码索引
muteLocalVideoStreammuted: booleannumber错误码索引
muteRemoteAudioStreamuid: number, muted: booleannumber错误码索引
muteRemoteVideoStreamuid: number, muted: booleannumber错误码索引
pauseAllChannelMediaRelay—number错误码索引
pauseAudioMixing—number错误码索引
pushExternalVideoFrameframe: VideoFrameboolean错误码索引
pushExternalVideoFrameByIdframe: VideoFrame, videoTrackId: numbernumber错误码索引
renewTokentoken: stringnumber错误码索引
resumeAllChannelMediaRelay—number错误码索引
resumeAudioMixing—number错误码索引
sendStreamMessagestreamId: number, message: ArrayBuffernumber错误码索引
setAudioMixingPlaybackSpeedspeed: numbernumber错误码索引
setAudioMixingPositionpos: numbernumber错误码索引
setAudioProfileprofile: Constants.AudioProfileTypenumber错误码索引
setAudioScenarioscenario: Constants.AudioScenarioTypenumber错误码索引
setCameraAutoFocusFaceModeEnabledenabled: booleannumber错误码索引
setCameraCapturerConfigurationconfig: CameraCapturerConfigurationnumber错误码索引
setChannelProfileprofile: numbernumber错误码索引
setClientRolerole: number, options?: ClientRoleOptionsnumber错误码索引
setDefaultAudioRouteToSpeakerphonedefaultToSpeaker: booleannumber错误码索引
setEnableSpeakerphoneenabled: unknownunknown错误码索引
setExternalVideoSourceenable: boolean, useTexture: boolean, sourceType: Constants.ExternalVideoSourceTypenumber错误码索引
setInEarMonitoringVolumevolume: numbernumber错误码索引
setLocalRenderModerenderMode: number, mirrorMode: numbernumber错误码索引
setParametersparameters: stringnumber错误码索引
setRemoteDefaultVideoStreamTypestreamType: Constants.VideoStreamTypenumber错误码索引
setRemoteRenderModeuid: number, renderMode: number, mirrorMode: numbernumber错误码索引
setRemoteVideoStreamTypeuid: number, streamType: Constants.VideoStreamTypenumber错误码索引
setVideoEncoderConfigurationconfiguration: VideoEncoderConfigurationnumber错误码索引
setVoiceBeautifierPresetpreset: Constants.VoiceBeautifierPresetnumber错误码索引
setupLocalVideocanvas: VideoCanvasnumber错误码索引
setupRemoteVideocanvas: VideoCanvasnumber错误码索引
startAudioMixingfilepath: string, loopback: boolean, cycle: number, startpos?: numbernumber错误码索引
startAudioRecordingWithConfigurationconfig: AudioRecordingConfigurationnumber错误码索引
startCameraCapturesourceType: Constants.VideoSourceType, config: CameraCapturerConfigurationnumber错误码索引
startLastmileProbeTestconfig: LastmileProbeConfignumber错误码索引
startLocalVideoTranscoderconfig: LocalTranscoderConfigurationnumber错误码索引
startOrUpdateChannelMediaRelaychannelMediaRelayConfiguration: ChannelMediaRelayConfigurationnumber错误码索引
startPreviewsourceType?: Constants.VideoSourceTypenumber错误码索引
startRtmpStreamWithTranscodingurl: string, transcoding: LiveTranscodingnumber错误码索引
startRtmpStreamWithoutTranscodingurl: stringnumber错误码索引
startScreenCapturescreenCaptureParameters: ScreenCaptureParametersnumber错误码索引
stopAudioMixing—number错误码索引
stopAudioRecording—number错误码索引
stopCameraCapturesourceType: Constants.VideoSourceTypenumber错误码索引
stopChannelMediaRelay—number错误码索引
stopLastmileProbeTest—number错误码索引
stopPreviewsourceType?: Constants.VideoSourceTypenumber错误码索引
stopRtmpStreamurl: stringnumber错误码索引
stopScreenCapture—number错误码索引
switchCamera—number错误码索引
takeSnapshotuid: number, filePath: stringnumber错误码索引
updateChannelMediaOptionsoptions: ChannelMediaOptionsnumber错误码索引
updateLocalTranscoderConfigurationconfig: LocalTranscoderConfigurationnumber错误码索引
updateRtmpTranscodingtranscoding: LiveTranscodingnumber错误码索引
RtcEngineConfig 0 方法 / 5 属性
属性类型只读
mEventHandlerunknown否
mAppIdunknown否
mContextunknown否
mLogConfigunknown否
mParametersunknown否
RtcEngineEx 19 方法 / 0 属性
typescript
adjustUserPlaybackSignalVolumeEx(uid: number, volume: number, connection: RtcConnection): number
createDataStreamEx(config: DataStreamConfig, connection: RtcConnection): number
enableAudioVolumeIndicationEx(interval: number, smooth: number, reportVad: boolean, connection: RtcConnection): number
getCallIdEx(connection: RtcConnection): string
joinChannelEx(token: string, connection: RtcConnection, options: ChannelMediaOptions, eventHandler: IRtcEngineEventHandler): number
leaveChannelEx(connection: RtcConnection, options?: LeaveChannelOptions): number
muteAllRemoteAudioStreamsEx(muted: boolean, connection: RtcConnection): number
muteAllRemoteVideoStreamsEx(muted: boolean, connection: RtcConnection): number
muteLocalAudioStreamEx(muted: boolean, connection: RtcConnection): number
muteLocalVideoStreamEx(muted: boolean, connection: RtcConnection): number
muteRemoteAudioStreamEx(uid: number, muted: boolean, connection: RtcConnection): number
muteRemoteVideoStreamEx(uid: number, muted: boolean, connection: RtcConnection): number
setDualStreamModeEx(mode: Constants.SimulcastStreamMode, streamConfig: SimulcastStreamConfig, connection: RtcConnection): number
setRemoteVideoStreamTypeEx(uid: number, streamType: number, connection: RtcConnection): number
setRemoteVoicePositionEx(uid: unknown, pan: unknown, gain: unknown, connection: unknown): unknown
setVideoEncoderConfigurationEx(configuration: VideoEncoderConfiguration, connection: RtcConnection): number
setupRemoteVideoEx(remote: VideoCanvas, connection: RtcConnection): number
startOrUpdateChannelMediaRelayEx(channelMediaRelayConfiguration: ChannelMediaRelayConfiguration, connection: RtcConnection): number
updateChannelMediaOptionsEx(options: ChannelMediaOptions, connection: RtcConnection): number

方法明细:19 / 19(参数、返回值、错误码)

方法参数返回值错误
adjustUserPlaybackSignalVolumeExuid: number, volume: number, connection: RtcConnectionnumber错误码索引
createDataStreamExconfig: DataStreamConfig, connection: RtcConnectionnumber错误码索引
enableAudioVolumeIndicationExinterval: number, smooth: number, reportVad: boolean, connection: RtcConnectionnumber错误码索引
getCallIdExconnection: RtcConnectionstring错误码索引
joinChannelExtoken: string, connection: RtcConnection, options: ChannelMediaOptions, eventHandler: IRtcEngineEventHandlernumber错误码索引
leaveChannelExconnection: RtcConnection, options?: LeaveChannelOptionsnumber错误码索引
muteAllRemoteAudioStreamsExmuted: boolean, connection: RtcConnectionnumber错误码索引
muteAllRemoteVideoStreamsExmuted: boolean, connection: RtcConnectionnumber错误码索引
muteLocalAudioStreamExmuted: boolean, connection: RtcConnectionnumber错误码索引
muteLocalVideoStreamExmuted: boolean, connection: RtcConnectionnumber错误码索引
muteRemoteAudioStreamExuid: number, muted: boolean, connection: RtcConnectionnumber错误码索引
muteRemoteVideoStreamExuid: number, muted: boolean, connection: RtcConnectionnumber错误码索引
setDualStreamModeExmode: Constants.SimulcastStreamMode, streamConfig: SimulcastStreamConfig, connection: RtcConnectionnumber错误码索引
setRemoteVideoStreamTypeExuid: number, streamType: number, connection: RtcConnectionnumber错误码索引
setRemoteVoicePositionExuid: unknown, pan: unknown, gain: unknown, connection: unknownunknown错误码索引
setVideoEncoderConfigurationExconfiguration: VideoEncoderConfiguration, connection: RtcConnectionnumber错误码索引
setupRemoteVideoExremote: VideoCanvas, connection: RtcConnectionnumber错误码索引
startOrUpdateChannelMediaRelayExchannelMediaRelayConfiguration: ChannelMediaRelayConfiguration, connection: RtcConnectionnumber错误码索引
updateChannelMediaOptionsExoptions: ChannelMediaOptions, connection: RtcConnectionnumber错误码索引
RtcStats 0 方法 / 24 属性
属性类型只读
totalDurationunknown否
txBytesunknown否
rxBytesunknown否
txAudioBytesunknown否
txVideoBytesunknown否
rxAudioBytesunknown否
rxVideoBytesunknown否
txKBitRateunknown否
rxKBitRateunknown否
rxAudioKBitRateunknown否
txAudioKBitRateunknown否
rxVideoKBitRateunknown否
txVideoKBitRateunknown否
lastmileDelayunknown否
txPacketLossRateunknown否
rxPacketLossRateunknown否
usersunknown否
cpuAppUsageunknown否
cpuTotalUsageunknown否
connectTimeMsunknown否
gatewayRttunknown否
memoryAppUsageRatiounknown否
memoryTotalUsageRatiounknown否
memoryAppUsageInKbytesunknown否
ScreenCaptureParameters 0 方法 / 3 属性
属性类型只读
dimensionsunknown否
frameRateunknown否
bitrateunknown否
SegmentationProperty 0 方法 / 2 属性
属性类型只读
modelTypeunknown否
greenCapacityunknown否
SimulcastStreamConfig 0 方法 / 3 属性
属性类型只读
dimensionsunknown否
bitrateunknown否
framerateunknown否
SpatialAudioZone 0 方法 / 9 属性
属性类型只读
zoneSetIdunknown否
positionunknown否
forwardunknown否
rightunknown否
upunknown否
forwardLengthunknown否
rightLengthunknown否
upLengthunknown否
audioAttenuationunknown否
SrcInfo 0 方法 / 2 属性
属性类型只读
bitrateInKbpsunknown否
nameunknown否
TranscodingUser 0 方法 / 8 属性
属性类型只读
uidunknown否
xunknown否
yunknown否
widthunknown否
heightunknown否
zOrderunknown否
alphaunknown否
audioChannelunknown否
TranscodingVideoStream 0 方法 / 7 属性
属性类型只读
sourceTypeunknown否
remoteUserUidunknown否
imageUrlunknown否
mediaPlayerIdunknown否
zOrderunknown否
alphaunknown否
mirrorunknown否
UserInfo 0 方法 / 2 属性
属性类型只读
uidunknown否
userAccountunknown否
VideoCanvas 0 方法 / 5 属性
属性类型只读
uidunknown否
xcomponentIdunknown否
renderModeunknown否
mirrorModeunknown否
sourceTypeunknown否
VideoCaptureParameters 0 方法 / 3 属性
属性类型只读
dimensionsunknown否
frameRateunknown否
bitrateunknown否
VideoDenoiserOptions 0 方法 / 2 属性
属性类型只读
levelunknown否
modeunknown否
VideoDimensions 0 方法 / 2 属性
属性类型只读
widththis.否
heightthis.否
VideoEncoderConfiguration 0 方法 / 9 属性
属性类型只读
dimensionsunknown否
codecTypeunknown否
frameRateunknown否
bitrateunknown否
minBitrateunknown否
orientationModeunknown否
degradationPreferenceunknown否
mirrorModeunknown否
advanceOptionsunknown否
VideoFrame 0 方法 / 18 属性
属性类型只读
typeunknown否
formatunknown否
widthunknown否
heightunknown否
strideunknown否
uStrideunknown否
vStrideunknown否
yBufferunknown否
uBufferunknown否
vBufferunknown否
bufferunknown否
rotationunknown否
timestampNsunknown否
colorSpaceunknown否
sourceTypeunknown否
sampleAspectRatiounknown否
alphaStitchModeunknown否
metaInfounknown否
VideoLayout 0 方法 / 8 属性
属性类型只读
channelIdunknown否
uidunknown否
strUidunknown否
xunknown否
yunknown否
widthunknown否
heightunknown否
videoStateunknown否
VideoSubscriptionOptions 0 方法 / 2 属性
属性类型只读
streamTypeunknown否
encodedFrameOnlyunknown否
VirtualBackgroundSource 0 方法 / 4 属性
属性类型只读
backgroundSourceTypeunknown否
colorunknown否
sourceunknown否
blurDegreeunknown否
WatermarkOptions 0 方法 / 3 属性
属性类型只读
visibleInPreviewunknown否
positionInLandscapeModeunknown否
positionInPortraitModeunknown否

枚举

枚举成员数示例值
AreaCode7AREA_CODE_CN = null
AudienceLatencyLevel2LOW_LATENCY = 1
AudioCodecProfileType3LC_AAC = 0
AudioDualMonoMode4STEREO = 0
AudioEffectPreset21AUDIO_EFFECT_OFF = null
AudioEqualizationBandFrequency10BAND_31 = 0
AudioMixingDualMonoMode4AUTO = 0
AudioMixingReason7OK = 0
AudioMixingState4PLAYING = 710
AudioProfileType4SPEECH_STANDARD = 1
AudioRecordingQuality4LOW = 0
AudioRecordingType3MIC = 1
AudioReverbType5DRY_LEVEL = 0
AudioSampleRateType3TYPE_32000 = 32000
AudioScenarioType4GAME_STREAMING = 3
AudioTrackType2MIXABLE = 0
CameraDirection3REAR = 0
ChannelMediaRelayError12OK = 0
ChannelMediaRelayState4IDLE = 0
ChannelProfile2COMMUNICATION = 0
ClientRole2BROADCASTER = 1
CompressionPrefence2PREFER_LOW_LATENCY = 0
ConnectionChangedReason21CONNECTING = 0
ConnectionState5DISCONNECTED = 1
ContentInspectType3INVALID = 0
DegradationPreference4MAINTAIN_QUALITY = 0
EarMontoringFilterType3BUILT_IN_AUDIO_FILTERS = null
EncryptionError5INTERNAL_FAILURE = 0
EncryptionMode9AES_128_XTS = 1
ErrorCode40ERR_OK = 0
ExternalVideoSourceType2VIDEO_FRAME = 0
FeatureType2VIDEO_VIRTUAL_BACKGROUND = 1
FRAME_RATE6FRAME_RATE_FPS_1 = 1
HEADPHONE_EQUALIZER_PRESET3HEADPHONE_EQUALIZER_OFF = null
LastmileProbeResult3COMPLETE = 1
LocalAudioStreamReason5OK = 0
LocalAudioStreamState4STOPPED = 0
LocalVideoStreamReason10OK = 0
LocalVideoStreamState4STOPPED = 0
LogFilter6OFF = 0
LogLevel5LOG_LEVEL_NONE = 0
MEDIA_TRACE_EVENT2MEDIA_TRACE_EVENT_VIDEO_RENDERED = 0
MediaPlayerEvent15UNKNOWN = -1
MediaPlayerMetadataType2PLAYER_METADATA_TYPE_UNKNOWN = 0
MediaPlayerPreloadEvent3PLAYER_PRELOAD_EVENT_BEGIN = 0
MediaPlayerReason16PLAYER_REASON_NONE = 0
MediaPlayerState10UNKNOWN = -1
MediaSourceType6AUDIO_PLAYOUT_SOURCE = 0
MediaStreamType4STREAM_TYPE_UNKNOWN = 0
MusicCacheStatusType2MUSIC_CACHE_STATUS_TYPE_CACHED = 0
MusicContentCenterStateReason8OK = 0
MusicPlayMode3ORIGINAL = 0
NetworkQuality7UNKNOWN = 0
ORIENTATION_MODE3ORIENTATION_MODE_ADAPTIVE = 0
PermissionType2RECORD_AUDIO = 0
PreloadState4PRELOAD_STATE_COMPLETED = 0
PRESET9OFF = null
RawAudioFrameOpMode2RAW_AUDIO_FRAME_OP_MODE_READ_ONLY = 0
RemoteAudioState5STOPPED = 0
RemoteAudioStateReason8INTERNAL = 0
RemoteVideoStreamReason11INTERNAL = 0
RemoteVideoStreamState5STOPPED = 0
RtmpStreamingEvent4FAILED_LOAD_IMAGE = 1
RtmpStreamPublishReason15OK = 0
RtmpStreamPublishState6IDLE = 0
ScreenCaptureContentHint2MOTION = null
ScreenScenarioType3SCREEN_SCENARIO_DOCUMENT = 1
SegModelType2AI = 1
SimulcastStreamMode3AUTO = -1
StreamFallbackOptions3STREAM_FALLBACK_OPTION_DISABLED = 0
StreamPublishState4IDLE = 0
StreamSubscribeState4IDLE = 0
VIDEO_CODEC_CAPABILITY_LEVEL5CODEC_CAPABILITY_LEVEL_UNSPECIFIED = -1
VideoBufferType3RAW_DATA = 1
VideoCodecProfileType3BASELINE = 66
VideoCodecType2H264 = 2
VideoFrameProcessMode2READ_ONLY = null
VideoModulePosition4POST_CAPTURER = 1
VideoPixelFormat3I420 = 1
VideoScenario1GENERAL = 0
VideoSourceType10CAMERA_SECONDARY = 1
VideoStreamType2HIGH = 0
VideoTranscoderError6VIDEO_SOURCE_NOT_READY = 1
VirtualBackgroundBlurDegree3LOW = 1
VirtualBackgroundType4COLOR = 1
VoiceBeautifierPreset14VOICE_BEAUTIFIER_OFF = null
AreaCode 7 个成员
成员值
AREA_CODE_CNnull
AREA_CODE_NAnull
AREA_CODE_EUnull
AREA_CODE_ASnull
AREA_CODE_JPnull
AREA_CODE_INnull
AREA_CODE_GLOBnull
AudienceLatencyLevel 2 个成员
成员值
LOW_LATENCY1
ULTRA_LOW_LATENCY2
AudioCodecProfileType 3 个成员
成员值
LC_AAC0
HE_AAC1
HE_AAC_V22
AudioDualMonoMode 4 个成员
成员值
STEREO0
L1
R2
MIX3
AudioEffectPreset 21 个成员
成员值
AUDIO_EFFECT_OFFnull
ROOM_ACOUSTICS_KTVnull
ROOM_ACOUSTICS_VOCAL_CONCERTnull
ROOM_ACOUSTICS_STUDIOnull
ROOM_ACOUSTICS_PHONOGRAPHnull
ROOM_ACOUSTICS_VIRTUAL_STEREOnull
ROOM_ACOUSTICS_SPACIALnull
ROOM_ACOUSTICS_ETHEREALnull
ROOM_ACOUSTICS_VIRTUAL_SURROUND_SOUNDnull
ROOM_ACOUSTICS_CHORUSnull
ROOM_ACOUSTICS_3D_VOICEnull
VOICE_CHANGER_EFFECT_UNCLEnull
VOICE_CHANGER_EFFECT_OLDMANnull
VOICE_CHANGER_EFFECT_BOYnull
VOICE_CHANGER_EFFECT_SISTERnull
VOICE_CHANGER_EFFECT_GIRLnull
VOICE_CHANGER_EFFECT_PIGKINGnull
VOICE_CHANGER_EFFECT_HULKnull
STYLE_TRANSFORMATION_RNBnull
STYLE_TRANSFORMATION_POPULARnull
PITCH_CORRECTIONnull
AudioEqualizationBandFrequency 10 个成员
成员值
BAND_310
BAND_621
BAND_1252
BAND_2503
BAND_5004
BAND_1K5
BAND_2K6
BAND_4K7
BAND_8K8
BAND_16K9
AudioMixingDualMonoMode 4 个成员
成员值
AUTO0
L1
R2
MIX3
AudioMixingReason 7 个成员
成员值
OK0
CAN_NOT_OPEN701
TOO_FREQUENT_CALL702
INTERRUPTED_EOF703
ONE_LOOP_COMPLETED721
ALL_LOOPS_COMPLETED723
STOPPED_BY_USER724
AudioMixingState 4 个成员
成员值
PLAYING710
PAUSED711
STOPPED713
FAILED714
AudioProfileType 4 个成员
成员值
SPEECH_STANDARD1
MUSIC_STANDARD2
MUSIC_STANDARD_STEREO3
MUSIC_HIGH_QUALITY_STEREO5
AudioRecordingQuality 4 个成员
成员值
LOW0
MEDIUM1
HIGH2
ULTRA_HIGH3
AudioRecordingType 3 个成员
成员值
MIC1
PLAYBACK2
MIXED3
AudioReverbType 5 个成员
成员值
DRY_LEVEL0
WET_LEVEL1
ROOM_SIZE2
WET_DELAY3
STRENGTH4
AudioSampleRateType 3 个成员
成员值
TYPE_3200032000
TYPE_4410044100
TYPE_4800048000
AudioScenarioType 4 个成员
成员值
GAME_STREAMING3
CHATROOM5
CHORUS7
MEETING8
AudioTrackType 2 个成员
成员值
MIXABLE0
DIRECT1
CameraDirection 3 个成员
成员值
REAR0
FRONT1
EXTRA2
ChannelMediaRelayError 12 个成员
成员值
OK0
SERVER_ERROR_RESPONSE1
SERVER_NO_RESPONSE2
NO_RESOURCE_AVAILABLE3
FAILED_JOIN_SRC4
FAILED_JOIN_DEST5
FAILED_PACKET_RECEIVED_FROM_SRC6
FAILED_PACKET_SENT_TO_DEST7
SERVER_CONNECTION_LOST8
INTERNAL_ERROR9
SRC_TOKEN_EXPIRED10
DEST_TOKEN_EXPIRED11
ChannelMediaRelayState 4 个成员
成员值
IDLE0
CONNECTING1
RUNNING2
FAILURE3
ChannelProfile 2 个成员
成员值
COMMUNICATION0
LIVE_BROADCASTING1
ClientRole 2 个成员
成员值
BROADCASTER1
AUDIENCE2
CompressionPrefence 2 个成员
成员值
PREFER_LOW_LATENCY0
PREFER_QUALITY1
ConnectionChangedReason 21 个成员
成员值
CONNECTING0
JOIN_SUCCESS1
INTERRUPTED2
BANNED_BY_SERVER3
JOIN_FAILED4
LEAVE_CHANNEL5
INVALID_APP_ID6
INVALID_CHANNEL_NAME7
INVALID_TOKEN8
TOKEN_EXPIRED9
REJECTED_BY_SERVER10
SETTING_PROXY_SERVER11
RENEW_TOKEN12
CLIENT_IP_ADDRESS_CHANGED13
KEEP_ALIVE_TIMEOUT14
REJOIN_SUCCESS15
LOST16
ECHO_TEST17
CLIENT_IP_ADDRESS_CHANGED_BY_USER18
SAME_UID_LOGIN19
TOO_MANY_BROADCASTERS20
ConnectionState 5 个成员
成员值
DISCONNECTED1
CONNECTING2
CONNECTED3
RECONNECTING4
FAILED5
ContentInspectType 3 个成员
成员值
INVALID0
SUPERVISE2
IMAGE_MODERATION3
DegradationPreference 4 个成员
成员值
MAINTAIN_QUALITY0
MAINTAIN_FRAMERATE1
MAINTAIN_BALANCED2
MAINTAIN_RESOLUTION3
EarMontoringFilterType 3 个成员
成员值
BUILT_IN_AUDIO_FILTERSnull
NOISE_SUPPRESSIONnull
REUSE_POST_PROCESSING_FILTERnull
EncryptionError 5 个成员
成员值
INTERNAL_FAILURE0
DECRYPTION_FAILURE1
ENCRYPTION_FAILURE2
DATASTREAM_DECRYPTION_FAILURE3
DATASTREAM_ENCRYPTION_FAILURE4
EncryptionMode 9 个成员
成员值
AES_128_XTS1
AES_128_ECB2
AES_256_XTS3
SM4_128_ECB4
AES_128_GCM5
AES_256_GCM6
AES_128_GCM27
AES_256_GCM28
MODE_ENDnull
ErrorCode 40 个成员
成员值
ERR_OK0
ERR_FAILED1
ERR_INVALID_ARGUMENT2
ERR_NOT_READY3
RtcEnginenull
ERR_NOT_SUPPORTED4
ERR_REFUSED5
ERR_BUFFER_TOO_SMALL6
ERR_NOT_INITIALIZED7
ERR_NO_PERMISSION9
ERR_TIMEDOUT10
ERR_JOIN_CHANNEL_REJECTED17
ERR_LEAVE_CHANNEL_REJECTED18
ERR_ALREADY_IN_USE19
ERR_ABORTED20
ERR_INIT_NET_ENGINE21
ERR_RESOURCE_LIMITED22
ERR_INVALID_APP_ID101
ERR_INVALID_CHANNEL_NAME102
ERR_TOKEN_EXPIRED109
ERR_INVALID_TOKEN110
ERR_CONNECTION_INTERRUPTED111
ERR_CONNECTION_LOST112
ERR_NOT_IN_CHANNEL113
ERR_SIZE_TOO_LARGE114
ERR_BITRATE_LIMIT115
ERR_TOO_MANY_DATA_STREAMS116
ERR_DECRYPTION_FAILED120
ERR_DATASTREAM_DECRYPTION_FAILED122
ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH130
ERR_INVALID_USER_ACCOUNT134
ERR_LOAD_MEDIA_ENGINE1001
ERR_ADM_GENERAL_ERROR1005
ERR_ADM_INIT_PLAYOUT1008
ERR_ADM_START_PLAYOUT1009
ERR_ADM_STOP_PLAYOUT1010
ERR_ADM_INIT_RECORDING1011
ERR_ADM_START_RECORDING1012
ERR_ADM_STOP_RECORDING1013
ERR_VDM_CAMERA_NOT_AUTHORIZED1501
ExternalVideoSourceType 2 个成员
成员值
VIDEO_FRAME0
ENCODED_VIDEO_FRAME1
FeatureType 2 个成员
成员值
VIDEO_VIRTUAL_BACKGROUND1
VIDEO_BEAUTY_EFFECT2
FRAME_RATE 6 个成员
成员值
FRAME_RATE_FPS_11
FRAME_RATE_FPS_77
FRAME_RATE_FPS_1010
FRAME_RATE_FPS_1515
FRAME_RATE_FPS_2424
FRAME_RATE_FPS_3030
HEADPHONE_EQUALIZER_PRESET 3 个成员
成员值
HEADPHONE_EQUALIZER_OFFnull
HEADPHONE_EQUALIZER_OVEREARnull
HEADPHONE_EQUALIZER_INEARnull
LastmileProbeResult 3 个成员
成员值
COMPLETE1
INCOMPLETE_NO_BWE2
UNAVAILABLE3
LocalAudioStreamReason 5 个成员
成员值
OK0
FAILURE1
DEVICE_NO_PERMISSION2
CAPTURE_FAILURE4
ENCODE_FAILURE5
LocalAudioStreamState 4 个成员
成员值
STOPPED0
RECORDING1
ENCODING2
FAILED3
LocalVideoStreamReason 10 个成员
成员值
OK0
FAILURE1
DEVICE_NO_PERMISSION2
DEVICE_BUSY3
CAPTURE_FAILURE4
CODEC_NOT_SUPPORT5
DEVICE_NOT_FOUND8
SCREEN_CAPTURE_STOPPED_BY_USER31
SCREEN_CAPTURE_INTERRUPTED_BY_OTHER32
SCREEN_CAPTURE_STOPPED_BY_CALL33
LocalVideoStreamState 4 个成员
成员值
STOPPED0
CAPTURING1
ENCODING2
FAILED3
LogFilter 6 个成员
成员值
OFF0
DEBUG2063
INFO15
WARN14
ERROR12
CRITICAL8
LogLevel 5 个成员
成员值
LOG_LEVEL_NONE0
LOG_LEVEL_INFO1
LOG_LEVEL_WARN2
LOG_LEVEL_ERROR4
LOG_LEVEL_FATAL8
MEDIA_TRACE_EVENT 2 个成员
成员值
MEDIA_TRACE_EVENT_VIDEO_RENDERED0
MEDIA_TRACE_EVENT_VIDEO_DECODED1
MediaPlayerEvent 15 个成员
成员值
UNKNOWN-1
SEEK_BEGIN0
SEEK_COMPLETE1
SEEK_ERROR2
AUDIO_TRACK_CHANGED5
BUFFER_LOW6
BUFFER_RECOVER7
FREEZE_START8
FREEZE_STOP9
SWITCH_BEGIN10
SWITCH_COMPLETE11
SWITCH_ERROR12
FIRST_DISPLAYED13
REACH_CACHE_FILE_MAX_COUNT14
REACH_CACHE_FILE_MAX_SIZE15
MediaPlayerMetadataType 2 个成员
成员值
PLAYER_METADATA_TYPE_UNKNOWN0
PLAYER_METADATA_TYPE_SEI1
MediaPlayerPreloadEvent 3 个成员
成员值
PLAYER_PRELOAD_EVENT_BEGIN0
PLAYER_PRELOAD_EVENT_COMPLETE1
PLAYER_PRELOAD_EVENT_ERROR2
MediaPlayerReason 16 个成员
成员值
PLAYER_REASON_NONE0
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
PLAYER_REASON_SRC_BUFFER_UNDERFLOW-12
PLAYER_REASON_INTERRUPTED-13
PLAYER_REASON_NOT_SUPPORTED-14
PLAYER_REASON_UNKNOWN-17
MediaPlayerState 10 个成员
成员值
UNKNOWN-1
IDLE0
OPENING1
OPEN_COMPLETED2
PLAYING3
PAUSED4
PLAYBACK_COMPLETED5
PLAYBACK_ALL_LOOPS_COMPLETED6
STOPPED7
FAILED100
MediaSourceType 6 个成员
成员值
AUDIO_PLAYOUT_SOURCE0
AUDIO_RECORDING_SOURCE1
PRIMARY_CAMERA_SOURCE2
SECONDARY_CAMERA_SOURCE3
CUSTOM_VIDEO_SOURCE6
UNKNOWN_MEDIA_SOURCE100
MediaStreamType 4 个成员
成员值
STREAM_TYPE_UNKNOWN0
STREAM_TYPE_VIDEO1
STREAM_TYPE_AUDIO2
STREAM_TYPE_SUBTITLE3
MusicCacheStatusType 2 个成员
成员值
MUSIC_CACHE_STATUS_TYPE_CACHED0
MUSIC_CACHE_STATUS_TYPE_CACHING1
MusicContentCenterStateReason 8 个成员
成员值
OK0
ERROR1
GATEWAY2
PERMISSION_AND_RESOURCE3
INTERNAL_DATA_PARSE4
MUSIC_LOADING5
MUSIC_DECRYPTION6
HTTP_INTERNAL7
MusicPlayMode 3 个成员
成员值
ORIGINAL0
ACCOMPANY1
LEAD_SING2
NetworkQuality 7 个成员
成员值
UNKNOWN0
EXCELLENT1
GOOD2
POOR3
BAD4
VBAD5
DOWN6
ORIENTATION_MODE 3 个成员
成员值
ORIENTATION_MODE_ADAPTIVE0
ORIENTATION_FIXED_LANDSCAPE1
ORIENTATION_FIXED_PORTRAIT2
PermissionType 2 个成员
成员值
RECORD_AUDIO0
CAMERA1
PreloadState 4 个成员
成员值
PRELOAD_STATE_COMPLETED0
PRELOAD_STATE_FAILED1
PRELOAD_STATE_PRELOADING2
PRELOAD_STATE_REMOVED3
PRESET 9 个成员
成员值
OFFnull
FX_KTVnull
FX_VOCAL_CONCERTnull
FX_UNCLEnull
FX_SISTERnull
FX_STUDIOnull
FX_POPULARnull
FX_RNBnull
FX_PHONOGRAPHnull
RawAudioFrameOpMode 2 个成员
成员值
RAW_AUDIO_FRAME_OP_MODE_READ_ONLY0
RAW_AUDIO_FRAME_OP_MODE_READ_WRITE2
RemoteAudioState 5 个成员
成员值
STOPPED0
STARTING1
DECODING2
FROZEN3
FAILED4
RemoteAudioStateReason 8 个成员
成员值
INTERNAL0
NETWORK_CONGESTION1
NETWORK_RECOVERY2
LOCAL_MUTED3
LOCAL_UNMUTED4
REMOTE_MUTED5
REMOTE_UNMUTED6
REMOTE_OFFLINE7
RemoteVideoStreamReason 11 个成员
成员值
INTERNAL0
NETWORK_CONGESTION1
NETWORK_RECOVERY2
LOCAL_MUTED3
LOCAL_UNMUTED4
REMOTE_MUTED5
REMOTE_UNMUTED6
REMOTE_OFFLINE7
AUDIO_FALLBACK8
AUDIO_FALLBACK_RECOVERY9
CODEC_NOT_SUPPORT13
RemoteVideoStreamState 5 个成员
成员值
STOPPED0
STARTING1
DECODING2
FROZEN3
FAILED4
RtmpStreamingEvent 4 个成员
成员值
FAILED_LOAD_IMAGE1
URL_ALREADY_IN_USE2
ADVANCED_FEATURE_NOT_SUPPORT3
REQUEST_TOO_OFTEN4
RtmpStreamPublishReason 15 个成员
成员值
OK0
INVALID_ARGUMENT1
ENCRYPTED_STREAM_NOT_ALLOWED2
CONNECTION_TIMEOUT3
INTERNAL_SERVER_ERROR4
RTMP_SERVER_ERROR5
TOO_OFTEN6
REACH_LIMIT7
NOT_AUTHORIZED8
STREAM_NOT_FOUND9
FORMAT_NOT_SUPPORTED10
NOT_BROADCASTER11
TRANSCODING_NO_MIX_STREAM13
NET_DOWN14
INVALID_PRIVILEGE16
RtmpStreamPublishState 6 个成员
成员值
IDLE0
CONNECTING1
RUNNING2
RECOVERING3
FAILURE4
DISCONNECTING5
ScreenCaptureContentHint 2 个成员
成员值
MOTIONnull
DETAILSnull
ScreenScenarioType 3 个成员
成员值
SCREEN_SCENARIO_DOCUMENT1
SCREEN_SCENARIO_GAMING2
SCREEN_SCENARIO_VIDEO3
SegModelType 2 个成员
成员值
AI1
GREEN2
SimulcastStreamMode 3 个成员
成员值
AUTO-1
DISABLE0
ENABLE1
StreamFallbackOptions 3 个成员
成员值
STREAM_FALLBACK_OPTION_DISABLED0
STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW1
STREAM_FALLBACK_OPTION_AUDIO_ONLY2
StreamPublishState 4 个成员
成员值
IDLE0
NO_PUBLISHED1
PUBLISHING2
PUBLISHED3
StreamSubscribeState 4 个成员
成员值
IDLE0
NO_SUBSCRIBED1
SUBSCRIBING2
SUBSCRIBED3
VIDEO_CODEC_CAPABILITY_LEVEL 5 个成员
成员值
CODEC_CAPABILITY_LEVEL_UNSPECIFIED-1
CODEC_CAPABILITY_LEVEL_BASIC_SUPPORT5
CODEC_CAPABILITY_LEVEL_1080P30FPS10
CODEC_CAPABILITY_LEVEL_1080P60FPS20
CODEC_CAPABILITY_LEVEL_4K60FPS30
VideoBufferType 3 个成员
成员值
RAW_DATA1
ARRAY2
TEXTURE3
VideoCodecProfileType 3 个成员
成员值
BASELINE66
MAIN77
HIGH100
VideoCodecType 2 个成员
成员值
H2642
H2653
VideoFrameProcessMode 2 个成员
成员值
READ_ONLYnull
READ_WRITEnull
VideoModulePosition 4 个成员
成员值
POST_CAPTURER1
PRE_RENDERER2
PRE_ENCODER4
POST_CAPTURER_ORIGIN8
VideoPixelFormat 3 个成员
成员值
I4201
RGBA4
I42216
VideoScenario 1 个成员
成员值
GENERAL0
VideoSourceType 10 个成员
成员值
CAMERA_SECONDARY1
SCREEN_SECONDARY3
CUSTOM4
MEDIA_PLAYER5
RTC_IMAGE_PNG6
RTC_IMAGE_JPEG7
RTC_IMAGE_GIF8
REMOTE9
TRANSCODED10
UNKNOWN100
VideoStreamType 2 个成员
成员值
HIGH0
LOW1
VideoTranscoderError 6 个成员
成员值
VIDEO_SOURCE_NOT_READY1
INVALID_VIDEO_SOURCE_TYPE2
INVALID_IMAGE_PATH3
UNSUPPORT_IMAGE_FORMAT4
INVALID_LAYOUT5
INTERNAL20
VirtualBackgroundBlurDegree 3 个成员
成员值
LOW1
MEDIUM2
HIGH3
VirtualBackgroundType 4 个成员
成员值
COLOR1
IMG2
BLUR3
VIDEO4
VoiceBeautifierPreset 14 个成员
成员值
VOICE_BEAUTIFIER_OFFnull
CHAT_BEAUTIFIER_MAGNETICnull
CHAT_BEAUTIFIER_FRESHnull
CHAT_BEAUTIFIER_VITALITYnull
SINGING_BEAUTIFIERnull
TIMBRE_TRANSFORMATION_VIGOROUSnull
TIMBRE_TRANSFORMATION_DEEPnull
TIMBRE_TRANSFORMATION_MELLOWnull
TIMBRE_TRANSFORMATION_FALSETTOnull
TIMBRE_TRANSFORMATION_FULLnull
TIMBRE_TRANSFORMATION_CLEARnull
TIMBRE_TRANSFORMATION_RESOUNDINGnull
TIMBRE_TRANSFORMATION_RINGINGnull
ULTRA_HIGH_QUALITY_VOICEnull

错误码常量

常量值
ERR_ABORTED20
ERR_ADM_GENERAL_ERROR1005
ERR_ADM_INIT_PLAYOUT1008
ERR_ADM_INIT_RECORDING1011
ERR_ADM_START_PLAYOUT1009
ERR_ADM_START_RECORDING1012
ERR_ADM_STOP_PLAYOUT1010
ERR_ADM_STOP_RECORDING1013
ERR_ALREADY_IN_USE19
ERR_BITRATE_LIMIT115
ERR_BUFFER_TOO_SMALL6
ERR_CONNECTION_INTERRUPTED111
ERR_CONNECTION_LOST112
ERR_DATASTREAM_DECRYPTION_FAILED122
ERR_DECRYPTION_FAILED120
ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH130
ERR_FAILED1
ERR_INIT_NET_ENGINE21
ERR_INVALID_APP_ID101
ERR_INVALID_ARGUMENT2
ERR_INVALID_CHANNEL_NAME102
ERR_INVALID_TOKEN110
ERR_INVALID_USER_ACCOUNT134
ERR_JOIN_CHANNEL_REJECTED17
ERR_LEAVE_CHANNEL_REJECTED18
ERR_LOAD_MEDIA_ENGINE1001
ERR_NOT_INITIALIZED7
ERR_NOT_IN_CHANNEL113
ERR_NOT_READY3
ERR_NOT_SUPPORTED4
ERR_NO_PERMISSION9
ERR_OK0
ERR_REFUSED5
ERR_RESOURCE_LIMITED22
ERR_SIZE_TOO_LARGE114
ERR_TIMEDOUT10
ERR_TOKEN_EXPIRED109
ERR_TOO_MANY_DATA_STREAMS116
ERR_VDM_CAMERA_NOT_AUTHORIZED1501
RtcEnginenull

已知限制

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

接口成员
AgoraMediaRecordersetMediaRecorderObserver
AgoraMediaRecorderstartRecording
AgoraMediaRecorderstopRecording
IAgoraMusicContentCentercreateMusicPlayer
IAgoraMusicContentCenterdestroy
IAgoraMusicContentCenterdestroyMusicPlayer
IAgoraMusicContentCentergetCaches
IAgoraMusicContentCentergetInternalSongCode
IAgoraMusicContentCentergetLyric
IAgoraMusicContentCentergetMusicCharts
IAgoraMusicContentCentergetMusicCollectionByMusicChartId
IAgoraMusicContentCentergetSongSimpleInfo
IAgoraMusicContentCenterinitialize
IAgoraMusicContentCenterisPreloaded
IAgoraMusicContentCenterpreload
IAgoraMusicContentCenterregisterEventHandler
IAgoraMusicContentCenterrelease
IAgoraMusicContentCenterremoveCache
IAgoraMusicContentCenterrenewToken
IAgoraMusicContentCentersearchMusic
IAgoraMusicContentCenterunregisterEventHandler
IAgoraMusicPlayersetPlayMode
IMediaPlayeradjustPlayoutVolume
IMediaPlayeradjustPublishSignalVolume
IMediaPlayergetDuration
IMediaPlayergetMediaPlayerId
IMediaPlayergetMute
IMediaPlayergetPlayPosition
IMediaPlayergetPlaySrc
IMediaPlayergetPlayoutVolume
IMediaPlayergetPublishSignalVolume
IMediaPlayergetState
IMediaPlayergetStreamCount
IMediaPlayergetStreamInfo
IMediaPlayermute
IMediaPlayeropen
IMediaPlayeropenWithMediaSource
IMediaPlayerpause
IMediaPlayerplay
IMediaPlayerplayPreloadedSrc
IMediaPlayerpreloadSrc
IMediaPlayerresume
IMediaPlayerseek
IMediaPlayerselectAudioTrack
IMediaPlayerselectMultiAudioTrack
IMediaPlayersetAudioDualMonoMode
IMediaPlayersetAudioPitch
IMediaPlayersetLoopCount
IMediaPlayersetPlaybackSpeed
IMediaPlayersetPlayerOption
IMediaPlayersetPlayerOptionString
IMediaPlayersetRenderMode
IMediaPlayersetView
IMediaPlayerstop
IMediaPlayerswitchSrc
IMediaPlayerunloadSrc
RtcEnginecreateCustomVideoTrack
RtcEnginecreateDataStream
RtcEnginecreateMediaPlayer
RtcEnginecreateMediaRecorder
RtcEnginedestroyCustomVideoTrack
RtcEngineenableContentInspect
RtcEngineenableEncryption
RtcEngineenableVirtualBackground
RtcEnginegetNativeHandle
RtcEnginepauseAllChannelMediaRelay
RtcEnginepushExternalVideoFrame
RtcEnginepushExternalVideoFrameById
RtcEngineresumeAllChannelMediaRelay
RtcEnginesendStreamMessage
RtcEnginesetExternalVideoSource
RtcEnginesetParameters
RtcEnginesetupLocalVideo
RtcEnginesetupRemoteVideo
RtcEnginestartAudioRecordingWithConfiguration
RtcEnginestartLastmileProbeTest
RtcEnginestartLocalVideoTranscoder
RtcEnginestartOrUpdateChannelMediaRelay
RtcEnginestartRtmpStreamWithTranscoding
RtcEnginestartRtmpStreamWithoutTranscoding
RtcEnginestopAudioRecording
RtcEnginestopChannelMediaRelay
RtcEnginestopLastmileProbeTest
RtcEnginestopRtmpStream
RtcEngineupdateChannelMediaOptions
RtcEngineupdateLocalTranscoderConfiguration
RtcEngineupdateRtmpTranscoding
RtcEngineExadjustUserPlaybackSignalVolumeEx
RtcEngineExcreateDataStreamEx
RtcEngineExenableAudioVolumeIndicationEx
RtcEngineExgetCallIdEx
RtcEngineExjoinChannelEx
RtcEngineExleaveChannelEx
RtcEngineExmuteAllRemoteAudioStreamsEx
RtcEngineExmuteAllRemoteVideoStreamsEx
RtcEngineExmuteLocalAudioStreamEx
RtcEngineExmuteLocalVideoStreamEx
RtcEngineExmuteRemoteAudioStreamEx
RtcEngineExmuteRemoteVideoStreamEx
RtcEngineExsetDualStreamModeEx
RtcEngineExsetRemoteVideoStreamTypeEx
RtcEngineExsetRemoteVoicePositionEx
RtcEngineExsetVideoEncoderConfigurationEx
RtcEngineExsetupRemoteVideoEx
RtcEngineExstartOrUpdateChannelMediaRelayEx
RtcEngineExupdateChannelMediaOptionsEx
__unattributed__addBackgroundImage
__unattributed__createCustomAudioTrack
__unattributed__destroy
__unattributed__destroyCustomAudioTrack
__unattributed__destroyMediaRecorder
__unattributed__enableAutoRemoveCache
__unattributed__enableEncryptionEx
__unattributed__enableVideoImageSource
__unattributed__getCacheDir
__unattributed__getCacheFileCount
__unattributed__getDestChannelMediaInfos
__unattributed__getMaxCacheFileCount
__unattributed__getMaxCacheFileSize
__unattributed__getSrcChannelMediaInfo
__unattributed__getWatermarkList
__unattributed__joinChannelWithUserAccountEx
__unattributed__muteRecordingSignal
__unattributed__onAudioRouteChanged
__unattributed__onFacePositionChanged
__unattributed__onLyricResult
__unattributed__onMusicChartsResult
__unattributed__onMusicCollectionResult
__unattributed__onPreLoadEvent
__unattributed__onSongSimpleInfoResult
__unattributed__onUserInfoUpdated
__unattributed__registerPlayerObserver
__unattributed__removeAllCaches
__unattributed__removeBackgroundImage
__unattributed__removeCacheByUri
__unattributed__removeDestChannelInfo
__unattributed__removeOldCache
__unattributed__setCacheDir
__unattributed__setDestChannelInfo
__unattributed__setMaxCacheFileCount
__unattributed__setMaxCacheFileSize
__unattributed__setRemoteRenderModeEx
__unattributed__setRemoteSubscribeFallbackOption
__unattributed__setSrcChannelInfo
__unattributed__startAudioRecording
__unattributed__startRecordingDeviceTest
__unattributed__stopLocalVideoTranscoder
__unattributed__stopRecordingDeviceTest
__unattributed__takeSnapshotEx
__unattributed__unRegisterPlayerObserver

本页由文档构建流水线生成 · 2026-10-31 01:24:02 UTC · 文档中心 v1.1.0.

内容依据公开 API 定义.

ni-meet 是自建 RTC PaaS,媒体面基于 LiveKit(Apache-2.0),并与声网 API 兼容。