API 列表

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

IRtcEngine

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

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

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

相关参考

• AddVideoWatermark [2/2]

• AdjustAudioMixingPlayoutVolume

• AdjustAudioMixingPublishVolume

• AdjustAudioMixingVolume

• AdjustCustomAudioPlayoutVolume

• AdjustCustomAudioPublishVolume

• AdjustPlaybackSignalVolume

• AdjustRecordingSignalVolume

• AdjustUserPlaybackSignalVolume

• ClearVideoWatermarks

• Complain

• ../API/toc_rhythmplayer.html#api_irtcengine_configrhythmplayer

• CreateAgoraRtcEngine

• CreateCustomVideoTrack

• CreateDataStream [2/2]

• CreateMediaPlayer

• CreateMediaRecorder

• DestroyCustomVideoTrack

• DestroyMediaPlayer

• DisableAudio

• DisableAudioSpectrumMonitor

• DisableVideo

• EnableAudio

• EnableAudioSpectrumMonitor

• EnableAudioVolumeIndication

• EnableContentInspect

• EnableCustomAudioLocalPlayback

• EnableDualStreamMode [2/2]

• EnableEncryption

• EnableExtension

• ../API/toc_audio_capture.html#api_irtcengine_enableinearmonitoring2

• EnableInstantMediaRendering

• EnableLocalAudio

• EnableLocalVideo

• EnableCameraCenterStage

• EnableSoundPositionIndication

• EnableSpatialAudio

• EnableVideo

• EnableVideoImageSource

• EnableVirtualBackground

• EnableVoiceAITuner

• EnableWebSdkInteroperability

• ../API/toc_pc_audio_device_management.html#api_irtcengine_getaudiodeviceinfo

• GetAudioMixingCurrentPosition

• GetAudioMixingDuration

• GetAudioMixingPlayoutVolume

• GetAudioMixingPublishVolume

• GetAudioTrackCount

• GetCallId

• GetConnectionState

• GetCurrentMonotonicTimeInMs

• GetEffectCurrentPosition

• GetEffectDuration

• GetEffectsVolume

• GetErrorDescription

• GetExtensionProperty

• GetNetworkType

• GetNtpWallTimeInMs

• GetUserInfoByUid

• GetUserInfoByUserAccount

• GetVersion

• GetVolumeOfEffect

• Initialize

• IsCameraCenterStageSupported

• JoinChannel [2/2]

• JoinChannelWithUserAccount [2/2]

• LeaveChannel [2/2]

• 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

• Dispose

• RenewToken

• ResumeAllChannelMediaRelay

• ResumeAllEffects

• ResumeAudioMixing

• ResumeEffect

• SelectAudioTrack [1/2]

• SendCustomReportMessage

• SendStreamMessage

• SetAdvancedAudioOptions

• SetAINSMode

• SetAudioEffectParameters

• SetAudioEffectPreset

• SetAudioMixingDualMonoMode

• SetAudioMixingPitch

• SetAudioMixingPosition

• SetAudioMixingPlaybackSpeed

• SetAudioProfile [1/2]

• SetAudioScenario

• SetAVSyncSource

• ../API/toc_video_enhance_option.html#api_irtcengine_setbeautyeffectoptions

• ../API/toc_mobile_camera.html#api_irtcengine_setcameracapturerconfiguration

• SetChannelProfile

• SetClientRole [2/2]

• SetCloudProxy

• SetColorEnhanceOptions

• SetDirectCdnStreamingAudioConfiguration

• SetDirectCdnStreamingVideoConfiguration

• SetDualStreamMode [2/2]

• SetEarMonitoringAudioFrameParameters

• SetEffectPosition

• SetEffectsVolume

• SetExtensionProperty

• SetExtensionProviderProperty

• SetExternalAudioSink

• SetHeadphoneEQParameters

• SetHeadphoneEQPreset

• ../API/toc_audio_capture.html#api_irtcengine_setinearmonitoringvolume

• SetLocalRenderMode [2/2]

• SetLocalVideoMirrorMode

• SetLocalVoiceEqualization

• SetLocalVoiceFormant

• SetLocalVoicePitch

• SetLocalVoiceReverb

• SetLogFile

• SetLogFileSize

• SetLogFilter

• SetLogLevel

• SetLowlightEnhanceOptions

• SetMixedAudioFrameParameters

• SetParameters [1/2]

• SetPlaybackAudioFrameBeforeMixingParameters

• SetPlaybackAudioFrameParameters

• SetRecordingAudioFrameParameters

• SetRemoteDefaultVideoStreamType

• SetRemoteRenderMode

• SetRemoteSubscribeFallbackOption

• SetRemoteUserSpatialAudioParams

• SetRemoteVideoStreamType

• SetRemoteVideoSubscriptionOptions

• SetRemoteVoicePosition

• SetScreenCaptureContentHint

• SetScreenCaptureScenario

• SetSubscribeAudioAllowlist

• SetSubscribeAudioBlocklist

• SetSubscribeVideoAllowlist

• SetSubscribeVideoBlocklist

• SetVideoDenoiserOptions

• SetVideoEncoderConfiguration

• SetVideoScenario

• SetVoiceBeautifierParameters

• SetVoiceBeautifierPreset

• SetVoiceConversionPreset

• SetVolumeOfEffect

• StartAudioMixing [2/2]

• StartAudioRecording [3/3]

• StartDirectCdnStreaming

• StartEchoTest

• StartLastmileProbeTest

• StartLocalVideoTranscoder

• StartOrUpdateChannelMediaRelay

• StartPreview [2/2]

• StartCameraCapture

• ../API/toc_rhythmplayer.html#api_irtcengine_startrhythmplayer

• StartRtmpStreamWithoutTranscoding

• StartRtmpStreamWithTranscoding

• StartMediaRenderingTracing

• StopAllEffects

• StopAudioMixing

• StopAudioRecording

• StopChannelMediaRelay

• StopDirectCdnStreaming

• StopEchoTest

• StopEffect

• StopLastmileProbeTest

• StopLocalVideoTranscoder

• StopPreview [2/2]

• StopCameraCapture

• ../API/toc_rhythmplayer.html#api_irtcengine_stoprhythmplayer

• StopRtmpStream

• StopScreenCapture [1/2]

• TakeSnapshot

• UnloadAllEffects

• UnloadEffect

• UnRegisterAudioEncodedFrameObserver

• UnRegisterAudioFrameObserver

• UnregisterAudioSpectrumObserver

• UnregisterMediaMetadataObserver

• UnregisterVideoEncodedFrameObserver

• UpdateChannelMediaOptions

• UpdateLocalTranscoderConfiguration

• UpdatePreloadChannelToken

• UpdateRtmpTranscoding

• UpdateScreenCaptureParameters

• UpdateScreenCaptureRegion

IRtcEngineEx

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

继承自 IRtcEngine。

相关参考

• AddVideoWatermarkEx

• ClearVideoWatermarkEx

• CreateDataStreamEx [2/2]

• EnableAudioVolumeIndicationEx

• EnableContentInspectEx

• EnableDualStreamModeEx

• EnableEncryptionEx

• GetCallIdEx

• GetConnectionStateEx

• JoinChannelEx

• LeaveChannelEx [2/2]

• MuteAllRemoteAudioStreamsEx

• MuteAllRemoteVideoStreamsEx

• MuteLocalAudioStreamEx

• MuteLocalVideoStreamEx

• MuteRemoteAudioStreamEx

• MuteRemoteVideoStreamEx

• PauseAllChannelMediaRelayEx

• ResumeAllChannelMediaRelayEx

• SendCustomReportMessageEx

• SetDualStreamModeEx

• SetRemoteVideoStreamTypeEx

• SetRemoteVideoSubscriptionOptionsEx

• SetRemoteVoicePositionEx

• SetSubscribeAudioBlocklistEx

• SetSubscribeAudioAllowlistEx

• SetSubscribeVideoBlocklistEx

• SetSubscribeVideoAllowlistEx

• 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

• OnAudioEffectFinished

• OnAudioMixingFinished

• OnAudioMixingPositionChanged

• OnAudioMixingStateChanged

• OnAudioPublishStateChanged

• OnAudioQuality

• ../API/toc_audio_route.html#callback_irtcengineeventhandler_onaudioroutingchanged

• OnAudioSubscribeStateChanged

• OnAudioVolumeIndication

• ../API/toc_mobile_camera.html#callback_irtcengineeventhandler_oncameraready

• OnChannelMediaRelayStateChanged

• OnClientRoleChanged

• OnClientRoleChangeFailed

• OnConnectionBanned

• OnConnectionInterrupted

• OnConnectionLost

• OnConnectionStateChanged

• OnEncryptionError

• OnError

• OnExtensionErrorWithContext

• OnExtensionEventWithContext

• OnExtensionStartedWithContext

• OnExtensionStoppedWithContext

• OnFirstLocalAudioFramePublished

• 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

• ../API/toc_rhythmplayer.html#callback_irtcengineeventhandler_onrhythmplayerstatechanged

• OnRtcStats

• OnRtmpStreamingEvent

• OnRtmpStreamingStateChanged

• OnSnapshotTaken

• OnStreamMessage

• OnStreamMessageError

• OnTokenPrivilegeWillExpire

• OnTranscodingUpdated

• OnUplinkNetworkInfoUpdated

• OnUserEnableLocalVideo

• OnUserEnableVideo

• OnUserInfoUpdated

• OnUserJoined

• OnUserMuteAudio

• OnUserMuteVideo

• OnUserOffline

• OnVideoPublishStateChanged

• OnVideoSizeChanged

• OnVideoStopped

• OnVideoSubscribeStateChanged

• OnVideoRenderingTracingResult

IMediaPlayer

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

相关参考

• AdjustPlayoutVolume

• AdjustPublishSignalVolume

• GetDuration

• GetMediaPlayerCacheManager

• GetId

• GetMute

• GetPlayoutVolume

• GetPlayPosition

• GetPlaySrc

• GetPublishSignalVolume

• GetState

• GetStreamCount

• GetStreamInfo

• Mute

• Open

• OpenWithMediaSource

• Pause

• Play

• PlayPreloadedSrc

• PreloadSrc

• RegisterAudioFrameObserver [1/2]

• RegisterAudioFrameObserver [2/2]

• Resume

• Seek

• SelectAudioTrack [2/2]

• SelectMultiAudioTrack

• SetAudioPitch

• SetAudioDualMonoMode

• SetLoopCount

• SetPlaybackSpeed

• SetPlayerOption [1/2]

• setPlayerOption [2/2]

• SetRenderMode

• SetSpatialAudioParams

• SetView

• Stop

• SwitchSrc

• UnloadSrc

• UnregisterAudioFrameObserver

IAudioEncodedFrameObserver

编码后音频的观测器。

相关参考

• OnMixedAudioEncodedFrame

• OnPlaybackAudioEncodedFrame

• OnRecordAudioEncodedFrame

IAudioDeviceManager

音频设备管理方法。

IVideoDeviceManager

视频设备管理方法。

IMediaPlayerAudioFrameObserver

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

你可以调用 RegisterAudioFrameObserver [2/2] 注册或取消注册 IMediaPlayerAudioFrameObserver 观测器。

IMediaPlayerCacheManager

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

相关参考

• EnableAutoRemoveCache

• GetCacheDir

• GetCacheFileCount

• GetMaxCacheFileCount

• GetMaxCacheFileSize

• RemoveAllCaches

• RemoveCacheByUri

• RemoveOldCache

• SetCacheDir

• SetMaxCacheFileCount

• SetMaxCacheFileSize

IMediaPlayerCustomDataProvider

提供打开自定义媒体资源文件的回调。

IMediaPlayerSourceObserver

提供媒体播放器的回调。

相关参考

• OnAudioVolumeIndication

• OnMetaData

• OnPlayBufferUpdated

• OnPlayerCacheStats

• OnPlayerEvent

• OnPlayerInfoUpdated

• OnPlayerPlaybackStats

• OnPlayerSourceStateChanged

• OnPlayerSrcInfoChanged

• OnPositionChanged

• OnPreloadEvent

IAudioFrameObserver

音频观测器。

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

IAudioSpectrumObserver

音频频谱观测器。

相关参考

• OnLocalAudioSpectrum

• OnRemoteAudioSpectrum

IMetadataObserver

Metadata 观测器。

相关参考

• OnMetadataReceived

IVideoEncodedFrameObserver

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

相关参考

• OnEncodedVideoFrameReceived

IVideoFrameObserver

视频观测器。

你可以调用 RegisterVideoFrameObserver 注册或取消注册 IVideoFrameObserver 视频观测器。

相关参考

• OnCaptureVideoFrame

• OnPreEncodeVideoFrame

• OnRenderVideoFrame

ILocalSpatialAudioEngine

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

调用该类下其他 API 前，你需要调用 Initialize 方法初始化该类。

相关参考

• ClearRemotePositions

• Initialize

• RemoveRemotePosition

• UpdateRemotePosition

IMediaRecorder

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

相关参考

• SetMediaRecorderObserver

• StartRecording

• StopRecording

IMediaRecorderObserver

包含音视频录制的事件。

相关参考

• OnRecorderStateChanged

• OnRecorderInfoUpdated

IMusicContentCenter

IMusicContentCenter 接口类提供音乐内容中心的相关方法。该接口类下的方法仅适用于 Android 和 iOS 平台。

IMusicContentCenterEventHandler

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

IMusicPlayer

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

VideoSurface

该类包含视频渲染相关的 Unity 原生方法。