API 列表

本页列出 Electron 所有的接口类以及其中包含的 API。

IRtcEngine

RTC SDK 的基础接口类，实现实时音视频的主要功能。

IRtcEngine 提供了 App 调用的主要方法。

在调用其他 API 之前，必须先调用 createAgoraRtcEngine 创建 IRtcEngine 对象。

相关参考

• registerEventHandler

• addVideoWatermark

• adjustAudioMixingPlayoutVolume

• adjustAudioMixingPublishVolume

• adjustAudioMixingVolume

• adjustCustomAudioPlayoutVolume

• adjustCustomAudioPublishVolume

• adjustLoopbackSignalVolume

• adjustPlaybackSignalVolume

• adjustRecordingSignalVolume

• adjustUserPlaybackSignalVolume

• clearVideoWatermarks

• complain

• configRhythmPlayer

• createAgoraRtcEngine

• createCustomVideoTrack

• createDataStream

• createMediaPlayer

• createMediaRecorder

• destroyCustomVideoTrack

• destroyMediaPlayer

• destroyRendererByConfig

• destroyRendererByView

• disableAudio

• disableAudioSpectrumMonitor

• disableVideo

• enableAudio

• enableAudioSpectrumMonitor

• enableAudioVolumeIndication

• enableContentInspect

• enableCustomAudioLocalPlayback

• enableDualStreamMode

• enableEncryption

• enableExtension

• enableInEarMonitoring

• enableInstantMediaRendering

• enableLocalAudio

• enableLocalVideo

• enableLoopbackRecording

• enableCameraCenterStage

• enableSoundPositionIndication

• enableSpatialAudio

• enableVideo

• enableVideoImageSource

• enableVirtualBackground

• enableVoiceAITuner

• enableWebSdkInteroperability

• getAudioDeviceManager

• getAudioMixingCurrentPosition

• getAudioMixingDuration

• getAudioMixingPlayoutVolume

• getAudioMixingPublishVolume

• getAudioTrackCount

• getCallId

• getConnectionState

• getCurrentMonotonicTimeInMs

• getEffectCurrentPosition

• getEffectDuration

• getEffectsVolume

• getErrorDescription

• getExtensionProperty

• getLocalSpatialAudioEngine

• getNativeHandle

• getNetworkType

• getNtpWallTimeInMs

• getScreenCaptureSources

• getUserInfoByUid

• getUserInfoByUserAccount

• getVersion

• getVideoDeviceManager

• getVolumeOfEffect

• initialize

• isFeatureAvailableOnDevice

• isCameraCenterStageSupported

• joinChannel

• joinChannelWithUserAccount

• leaveChannel

• loadExtensionProvider

• muteAllRemoteAudioStreams

• muteAllRemoteVideoStreams

• muteLocalAudioStream

• muteLocalVideoStream

• muteRecordingSignal

• muteRemoteAudioStream

• muteRemoteVideoStream

• pauseAllChannelMediaRelay

• pauseAllEffects

• pauseAudioMixing

• pauseEffect

• playAllEffects

• playEffect

• preloadChannel

• preloadChannelWithUserAccount

• preloadEffect

• queryCodecCapability

• queryDeviceScore

• rate

• registerAudioEncodedFrameObserver

• registerAudioSpectrumObserver

• registerExtension

• registerLocalUserAccount

• registerMediaMetadataObserver

• release

• unregisterEventHandler

• renewToken

• resumeAllChannelMediaRelay

• resumeAllEffects

• resumeAudioMixing

• resumeEffect

• selectAudioTrack

• sendCustomReportMessage

• sendMetaData

• sendStreamMessage

• setAdvancedAudioOptions

• setAINSMode

• setAudioEffectParameters

• setAudioEffectPreset

• setAudioMixingDualMonoMode

• setAudioMixingPitch

• setAudioMixingPosition

• setAudioMixingPlaybackSpeed

• setAudioProfile

• setAudioScenario

• setAVSyncSource

• setBeautyEffectOptions

• setCameraCapturerConfiguration

• setCameraDeviceOrientation

• setChannelProfile

• setClientRole

• setCloudProxy

• setColorEnhanceOptions

• setDirectCdnStreamingAudioConfiguration

• setDirectCdnStreamingVideoConfiguration

• setDualStreamMode

• setEarMonitoringAudioFrameParameters

• setEffectPosition

• setEffectsVolume

• setExtensionProperty

• setExtensionProviderProperty

• setExternalAudioSink

• setHeadphoneEQParameters

• setHeadphoneEQPreset

• setInEarMonitoringVolume

• setLocalRenderMode

• setLocalVideoMirrorMode

• setLocalVoiceEqualization

• setLocalVoiceFormant

• setLocalVoicePitch

• setLocalVoiceReverb

• setLogFile

• setLogFileSize

• setLogFilter

• setLogLevel

• setLowlightEnhanceOptions

• setMaxMetadataSize

• setMixedAudioFrameParameters

• setParameters

• setPlaybackAudioFrameBeforeMixingParameters

• setPlaybackAudioFrameParameters

• setRecordingAudioFrameParameters

• setRemoteDefaultVideoStreamType

• setRemoteRenderMode

• setRemoteSubscribeFallbackOption

• setRemoteUserSpatialAudioParams

• setRemoteVideoStreamType

• setRemoteVideoSubscriptionOptions

• setRemoteVoicePosition

• setScreenCaptureContentHint

• setScreenCaptureScenario

• setSubscribeAudioAllowlist

• setSubscribeAudioBlocklist

• setSubscribeVideoAllowlist

• setSubscribeVideoBlocklist

• setupLocalVideo

• setupRemoteVideo

• setVideoDenoiserOptions

• setVideoEncoderConfiguration

• setVideoScenario

• setVoiceBeautifierParameters

• setVoiceBeautifierPreset

• setVoiceConversionPreset

• setVolumeOfEffect

• startAudioMixing

• startAudioRecording

• startDirectCdnStreaming

• startEchoTest

• startLastmileProbeTest

• startLocalVideoTranscoder

• startOrUpdateChannelMediaRelay

• startPreview

• startCameraCapture

• startRhythmPlayer

• startRtmpStreamWithoutTranscoding

• startRtmpStreamWithTranscoding

• startScreenCaptureBySourceType

• startScreenCaptureByDisplayId

• startScreenCaptureByScreenRect

• startScreenCaptureByWindowId

• startMediaRenderingTracing

• stopAllEffects

• stopAudioMixing

• stopAudioRecording

• stopChannelMediaRelay

• stopDirectCdnStreaming

• stopEchoTest

• stopEffect

• stopLastmileProbeTest

• stopLocalVideoTranscoder

• stopPreview

• stopCameraCapture

• stopRhythmPlayer

• stopRtmpStream

• stopScreenCapture

• stopScreenCaptureBySourceType

• takeSnapshot

• unloadAllEffects

• unloadEffect

• unregisterAudioEncodedFrameObserver

• unregisterAudioSpectrumObserver

• unregisterMediaMetadataObserver

• unregisterVideoEncodedFrameObserver

• updateChannelMediaOptions

• updateLocalTranscoderConfiguration

• updatePreloadChannelToken

• updateRtmpTranscoding

• updateScreenCaptureParameters

• updateScreenCaptureRegion

• getMusicContentCenter

IRtcEngineEx

提供多频道方法的接口类。

继承自 IRtcEngine。

相关参考

• addVideoWatermarkEx

• clearVideoWatermarkEx

• createDataStreamEx

• enableAudioVolumeIndicationEx

• enableContentInspectEx

• enableDualStreamModeEx

• enableEncryptionEx

• enableLoopbackRecordingEx

• getCallIdEx

• getConnectionStateEx

• joinChannelEx

• joinChannelWithUserAccountEx

• leaveChannelEx

• muteAllRemoteAudioStreamsEx

• muteAllRemoteVideoStreamsEx

• muteLocalAudioStreamEx

• muteLocalVideoStreamEx

• muteRemoteAudioStreamEx

• muteRemoteVideoStreamEx

• pauseAllChannelMediaRelayEx

• resumeAllChannelMediaRelayEx

• sendCustomReportMessageEx

• setDualStreamModeEx

• setRemoteRenderModeEx

• setRemoteVideoStreamTypeEx

• setRemoteVideoSubscriptionOptionsEx

• setRemoteVoicePositionEx

• setSubscribeAudioBlocklistEx

• setSubscribeAudioAllowlistEx

• setSubscribeVideoBlocklistEx

• setSubscribeVideoAllowlistEx

• setupRemoteVideoEx

• setVideoEncoderConfigurationEx

• sendStreamMessageEx

• startMediaRenderingTracingEx

• startOrUpdateChannelMediaRelayEx

• startRtmpStreamWithoutTranscodingEx

• startRtmpStreamWithTranscodingEx

• stopChannelMediaRelayEx

• stopRtmpStreamEx

• takeSnapshotEx

• updateChannelMediaOptionsEx

• updateRtmpTranscodingEx

• adjustUserPlaybackSignalVolumeEx

IRtcEngineEventHandler

接口类 IRtcEngineEventHandler 用于 SDK 向 App 发送事件通知，App 通过继承该接口类的方法获取 SDK 的事件通知。

该接口类的所有方法都有缺省（空）实现， App 可以根据需要只继承关心的事件。

注意

• 在回调方法中，App 不应该做耗时或者调用可能会引起阻塞的 API（如 sendMessage），否则可能影响 SDK 的运行。
• SDK 不再捕获开发者在 IRtcEngineEventHandler 类回调中自行实现的代码逻辑中的异常。你需要自行处理该异常，否则异常出现时可能引起 App 崩溃。

相关参考

• onActiveSpeaker

• onAudioDeviceStateChanged

• onAudioDeviceVolumeChanged

• onAudioEffectFinished

• onAudioMixingFinished

• onAudioMixingPositionChanged

• onAudioMixingStateChanged

• onAudioPublishStateChanged

• onAudioQuality

• onAudioRoutingChanged

• onAudioSubscribeStateChanged

• onAudioVolumeIndication

• onCameraReady

• onChannelMediaRelayStateChanged

• onClientRoleChanged

• onClientRoleChangeFailed

• onConnectionBanned

• onConnectionInterrupted

• onConnectionLost

• onConnectionStateChanged

• onEncryptionError

• onError

• onExtensionErrorWithContext

• onExtensionEventWithContext

• onExtensionStartedWithContext

• onExtensionStoppedWithContext

• onFirstLocalAudioFramePublished

• onFirstLocalVideoFrame

• onFirstLocalVideoFramePublished

• onFirstRemoteAudioFrame

• onFirstRemoteAudioDecoded

• onFirstRemoteVideoDecoded

• onFirstRemoteVideoFrame

• onJoinChannelSuccess

• onLastmileProbeResult

• onLastmileQuality

• onLeaveChannel

• onLocalAudioStateChanged

• onLocalAudioStats

• onLocalUserRegistered

• onLocalVideoStateChanged

• onLocalVideoStats

• onLocalVideoTranscoderError

• onNetworkQuality

• onNetworkTypeChanged

• onPermissionError

• onProxyConnected

• onRejoinChannelSuccess

• onRemoteAudioStateChanged

• onRemoteAudioStats

• onRemoteAudioTransportStats

• onRemoteSubscribeFallbackToAudioOnly

• onRemoteVideoStateChanged

• onRemoteVideoStats

• onRemoteVideoTransportStats

• onRequestToken

• onRhythmPlayerStateChanged

• onRtcStats

• onRtmpStreamingEvent

• onRtmpStreamingStateChanged

• onSnapshotTaken

• onStreamMessage

• onStreamMessageError

• onTokenPrivilegeWillExpire

• onTranscodingUpdated

• onUplinkNetworkInfoUpdated

• onUserEnableLocalVideo

• onUserEnableVideo

• onUserInfoUpdated

• onUserJoined

• onUserMuteAudio

• onUserMuteVideo

• onUserOffline

• onVideoDeviceStateChanged

• onVideoPublishStateChanged

• onVideoSizeChanged

• onVideoStopped

• onVideoSubscribeStateChanged

• onVideoRenderingTracingResult

IMediaPlayer

提供媒体播放器功能的类，支持多实例。

相关参考

• adjustPlayoutVolume

• adjustPublishSignalVolume

• getDuration

• getMediaPlayerCacheManager

• getMediaPlayerId

• getMute

• getPlayoutVolume

• getPlayPosition

• getPlaySrc

• getPublishSignalVolume

• getState

• getStreamCount

• getStreamInfo

• mute

• open

• openWithMediaSource

• pause

• play

• playPreloadedSrc

• preloadSrc

• registerAudioFrameObserver

• registerPlayerSourceObserver

• registerVideoFrameObserver

• resume

• seek

• selectAudioTrack

• selectMultiAudioTrack

• setAudioPitch

• setAudioDualMonoMode

• setLoopCount

• setPlaybackSpeed

• setPlayerOptionInInt

• setPlayerOptionInString

• setRenderMode

• setSpatialAudioParams

• setView

• stop

• switchSrc

• unloadSrc

• unregisterAudioFrameObserver

• unregisterPlayerSourceObserver

• unregisterVideoFrameObserver

IAudioEncodedFrameObserver

编码后音频的观测器。

相关参考

• onMixedAudioEncodedFrame

• onPlaybackAudioEncodedFrame

• onRecordAudioEncodedFrame

IAudioDeviceManager

音频设备管理方法。

相关参考

• enumeratePlaybackDevices

• enumerateRecordingDevices

• followSystemLoopbackDevice

• followSystemPlaybackDevice

• followSystemRecordingDevice

• getLoopbackDevice

• getPlaybackDefaultDevice

• getPlaybackDevice

• getPlaybackDeviceInfo

• getPlaybackDeviceMute

• getRecordingDefaultDevice

• getRecordingDevice

• getRecordingDeviceInfo

• getRecordingDeviceVolume

• release

• setLoopbackDevice

• setPlaybackDevice

• setPlaybackDeviceMute

• setPlaybackDeviceVolume

• setRecordingDevice

• setRecordingDeviceVolume

• startAudioDeviceLoopbackTest

• startPlaybackDeviceTest

• startRecordingDeviceTest

• stopAudioDeviceLoopbackTest

• stopPlaybackDeviceTest

• stopRecordingDeviceTest

IVideoDeviceManager

视频设备管理方法。

相关参考

• enumerateVideoDevices

• getCapability

• getDevice

• numberOfCapabilities

• setDevice

IMediaEngine

IMediaEngine 类。

相关参考

• createCustomAudioTrack

• destroyCustomAudioTrack

• pullAudioFrame

• pushAudioFrame

• pushVideoFrame

• registerAudioFrameObserver

• registerVideoEncodedFrameObserver

• registerVideoFrameObserver

• setExternalAudioSink

• setExternalAudioSource

• setExternalVideoSource

IMediaPlayerCacheManager

该类提供管理媒体播放器中缓存媒体文件的方法。

相关参考

• enableAutoRemoveCache

• getCacheDir

• getCacheFileCount

• getMaxCacheFileCount

• getMaxCacheFileSize

• removeAllCaches

• removeCacheByUri

• removeOldCache

• setCacheDir

• setMaxCacheFileCount

• setMaxCacheFileSize

IMediaPlayerSourceObserver

提供媒体播放器的回调。

相关参考

• onAudioVolumeIndication

• onMetaData

• onPlayBufferUpdated

• onPlayerCacheStats

• onPlayerEvent

• onPlayerInfoUpdated

• onPlayerPlaybackStats

• onPlayerSourceStateChanged

• onPlayerSrcInfoChanged

• onPositionChanged

• onPreloadEvent

IAudioPcmFrameSink

该类用于获取原始的 PCM 音频数据。

你可以继承这个类，实现 onFrame 回调来获得 PCM 音频数据。

IAudioFrameObserver

音频观测器。

你可以调用 registerAudioFrameObserver 注册或取消注册 IAudioFrameObserver 音频观测器。

IMediaPlayerAudioFrameObserver

媒体播放器的音频数据观测器。

你可以调用 registerAudioFrameObserver 注册或取消注册 IMediaPlayerAudioFrameObserver 观测器。

相关参考

• onFrame

IAudioFrameObserverBase

音频观测器。

你可以调用 registerAudioFrameObserver 注册或取消注册 IAudioFrameObserverBase 音频观测器。

相关参考

• onEarMonitoringAudioFrame

• onMixedAudioFrame

• onPlaybackAudioFrame

• onPlaybackAudioFrameBeforeMixing

• onRecordAudioFrame

IDirectCdnStreamingEventHandler

IDirectCdnStreamingEventHandler 接口类用于 SDK 向 App 发送 CDN 推流的事件通知，App 通过继承该接口类的方法获取 SDK 的事件通知。

相关参考

• onDirectCdnStreamingStateChanged

• onDirectCdnStreamingStats

IAudioSpectrumObserver

音频频谱观测器。

相关参考

• onLocalAudioSpectrum

• onRemoteAudioSpectrum

IMetadataObserver

Metadata 观测器。

相关参考

• onMetadataReceived

IVideoEncodedFrameObserver

用于接收编码后的视频图像的类。

相关参考

• onEncodedVideoFrameReceived

IMediaPlayerVideoFrameObserver

媒体播放器的视频数据观测器。

你可以调用 registerVideoFrameObserver 注册或取消注册 IMediaPlayerVideoFrameObserver 观测器。

IBaseSpatialAudioEngine

该类包含 ILocalSpatialAudioEngine 类中的部分 API。

ILocalSpatialAudioEngine 类继承自 IBaseSpatialAudioEngine。

相关参考

• muteAllRemoteAudioStreams

• muteLocalAudioStream

• release

• muteRemoteAudioStream

• setAudioRecvRange

• setDistanceUnit

• setMaxAudioRecvCount

• setPlayerAttenuation

• setRemoteAudioAttenuation

• setZones

• updatePlayerPositionInfo

• updateSelfPosition

ILocalSpatialAudioEngine

该类通过 SDK 计算用户坐标，实现空间音频。

该类继承自 IBaseSpatialAudioEngine。调用该类下其他 API 前，你需要调用 initialize 方法初始化该类。

相关参考

• clearRemotePositions

• initialize

• removeRemotePosition

• updateRemotePosition

IMediaRecorder

提供本地及远端音视频录制功能的类。

相关参考

• setMediaRecorderObserver

• startRecording

• stopRecording

IMediaRecorderObserver

包含音视频录制的事件。

相关参考

• onRecorderStateChanged

• onRecorderInfoUpdated

IMusicContentCenter

IMusicContentCenter 接口类提供音乐内容中心的相关方法。

相关参考

• initialize

• renewToken

• removeCache

• registerEventHandler

• unregisterEventHandler

• createMusicPlayer

• getCaches

• getMusicCharts

• getMusicCollectionByMusicChartId

• searchMusic

• isPreloaded

• getLyric

• destroyMusicPlayer

IMusicContentCenterEventHandler

IMusicContentCenterEventHandler 接口类，用于 SDK 向客户端发送音乐内容中心事件通知。

相关参考

• onLyricResult

• onMusicChartsResult

• onMusicCollectionResult

• onPreLoadEvent

IMusicPlayer

继承自 IMediaPlayer 类，提供音乐播放器的相关方法。

相关参考

• openWithSongCode

• setPlayMode