API 列表
- Unreal Blueprint
更新时间不可用
本页列出 Unreal 所有的接口类以及其中包含的 API。
IAudioDeviceCollection
IAudioDeviceCollection 类。你可以通过该接口类获取音频设备相关的信息。
相关参考
- GetApplicationVolume
- GetCount
- GetDefaultDevice
- GetDevice
- IsApplicationMute
- Release
- SetApplicationMute
- SetApplicationVolume
- SetDevice
IAudioDeviceManager
音频设备管理方法。
详情
IAudioDeviceManager 接口类提供用于测试音频设备的相关接口。你可以通过调用 GetAgoraAudioDeviceManager 方法来获取 IAudioDeviceManager 接口。
相关参考
- EnumeratePlaybackDevices
- EnumerateRecordingDevices
- FollowSystemPlaybackDevice
- FollowSystemRecordingDevice
- GetPlaybackDevice
- GetPlaybackDeviceInfo
- GetPlaybackDeviceMute
- GetRecordingDevice
- GetRecordingDeviceInfo
- GetRecordingDeviceMute
- GetRecordingDeviceVolume
- Release
- SetPlaybackDevice
- SetPlaybackDeviceMute
- SetPlaybackDeviceVolume
- SetRecordingDevice
- SetRecordingDeviceMute
- SetRecordingDeviceVolume
- StartAudioDeviceLoopbackTest
- StartPlaybackDeviceTest
- StartRecordingDeviceTest
- StopAudioDeviceLoopbackTest
- StopPlaybackDeviceTest
- StopRecordingDeviceTest
IMediaPlayer
提供媒体播放器功能的类，支持多实例。
相关参考
- AdjustPlayoutVolume
- AdjustPublishSignalVolume
- GetDuration
- GetMediaPlayerId
- GetMute
- GetPlayoutVolume
- GetPlayPosition
- GetPlaySrc
- GetPublishSignalVolume
- GetState
- GetStreamCount
- GetStreamInfo
- Mute
- Open
- OpenWithMediaSource
- Pause
- Play
- PlayPreloadedSrc
- PreloadSrc
- Resume
- Seek
- SelectAudioTrack
- SelectMultiAudioTrack
- SetAudioPitch
- SetAudioDualMonoMode
- SetLoopCount
- SetPlaybackSpeed
- SetPlayerOptionWithInt
- SetPlayerOptionWithString
- SetRenderMode
- SetView
- Stop
- SwitchSrc
- UnloadSrc
IMediaPlayerSourceObserver
提供媒体播放器的回调。
相关参考
- OnAudioVolumeIndication
- OnMetaData
- OnPlayBufferUpdated
- OnPlayerCacheStats
- OnPlayerEvent
- OnPlayerInfoUpdated
- OnPlayerPlaybackStats
- OnPlayerSourceStateChanged
- OnPlayerSrcInfoChanged
- OnPositionChanged
- OnPreloadEvent
IRtcEngine
RTC SDK 的基础接口类，实现实时音视频的主要功能。
详情
IRtcEngine 提供了 App 调用的主要方法。
在调用其他 API 之前，必须先调用 GetAgoraRtcEngine 创建 IRtcEngine 对象。
相关参考
- AddVideoWatermark
- AdjustAudioMixingPlayoutVolume
- AdjustAudioMixingPublishVolume
- AdjustAudioMixingVolume
- AdjustLoopbackSignalVolume
- AdjustPlaybackSignalVolume
- AdjustRecordingSignalVolume
- AdjustUserPlaybackSignalVolume
- ClearVideoWatermarks
- Complain
- ConfigRhythmPlayer
- GetAgoraRtcEngine
- CreateDataStream
- GetAgoraMediaPlayer
- Release
- DisableAudio
- DisableVideo
- EnableAudio
- EnableAudioVolumeIndication
- EnableContentInspect
- EnableDualStreamMode
- EnableEncryption
- EnableExtension
- EnableFaceDetection
- EnableInEarMonitoring
- EnableInstantMediaRendering
- EnableLocalAudio
- EnableLocalVideo
- EnableLoopbackRecording
- EnableMultiCamera
- EnableCameraCenterStage
- EnableSoundPositionIndication
- EnableVideo
- EnableVideoImageSource
- EnableVirtualBackground
- EnableVoiceAITuner
- EnableWebSdkInteroperability
- GetAudioDeviceInfo
- GetAudioMixingCurrentPosition
- GetAudioMixingDuration
- GetAudioMixingPlayoutVolume
- GetAudioMixingPublishVolume
- GetAudioTrackCount
- GetCallId
- GetCameraMaxZoomFactor
- GetConnectionState
- GetEffectCurrentPosition
- GetEffectDuration
- GetEffectsVolume
- GetErrorDescription
- GetExtensionProperty
- GetFaceShapeAreaOptions
- GetFaceShapeBeautyOptions
- GetNetworkType
- GetNtpWallTimeInMs
- GetScreenCaptureSources
- GetUserInfoByUid
- GetUserInfoByUserAccount
- GetVersion
- GetVolumeOfEffect
- Initialize
- IsCameraAutoExposureFaceModeSupported
- IsCameraAutoFocusFaceModeSupported
- IsCameraExposurePositionSupported
- IsCameraExposureSupported
- IsCameraFaceDetectSupported
- IsCameraFocusSupported
- IsCameraTorchSupported
- IsCameraZoomSupported
- IsFeatureAvailableOnDevice
- IsSpeakerphoneEnabled
- IsCameraCenterStageSupported
- JoinChannelWithOptions
- JoinChannelWithUserAccount
- LeaveChannelWithOptions
- LoadExtensionProvider
- MuteAllRemoteAudioStreams
- MuteAllRemoteVideoStreams
- MuteLocalAudioStream
- MuteLocalVideoStream
- MuteRecordingSignal
- MuteRemoteAudioStream
- MuteRemoteVideoStream
- PauseAllChannelMediaRelay
- PauseAllEffects
- PauseAudioMixing
- PauseEffect
- PlayAllEffects
- PlayEffect
- PreloadChannel
- PreloadChannelWithUserAccount
- PreloadEffect
- QueryCameraFocalLengthCapability
- QueryCodecCapability
- QueryDeviceScore
- QueryScreenCaptureCapability
- Rate
- RegisterExtension
- RegisterLocalUserAccount
- Release
- RenewToken
- ResumeAllChannelMediaRelay
- ResumeAllEffects
- ResumeAudioMixing
- ResumeEffect
- SelectAudioTrack
- SendCustomReportMessage
- SendStreamMessage
- SetAdvancedAudioOptions
- SetAINSMode
- SetAudioEffectParameters
- SetAudioEffectPreset
- SetAudioMixingDualMonoMode
- SetAudioMixingPitch
- SetAudioMixingPosition
- SetAudioMixingPlaybackSpeed
- SetAudioProfileAndScenario
- SetAudioScenario
- SetAudioSessionOperationRestriction
- SetAVSyncSource
- SetBeautyEffectOptions
- SetFaceShapeAreaOptions
- SetFaceShapeBeautyOptions
- SetFilterEffectOptions
- SetCameraAutoExposureFaceModeEnabled
- SetCameraAutoFocusFaceModeEnabled
- SetCameraCapturerConfiguration
- SetCameraDeviceOrientation
- SetCameraExposureFactor
- SetCameraExposurePosition
- SetCameraFocusPositionInPreview
- SetCameraStabilizationMode
- SetCameraTorchOn
- SetCameraZoomFactor
- SetChannelProfile
- SetClientRole
- SetCloudProxy
- SetColorEnhanceOptions
- SetDefaultAudioRouteToSpeakerphone
- SetDualStreamMode
- SetEffectPosition
- SetEffectsVolume
- SetEnableSpeakerphone
- SetExtensionProperty
- SetExtensionProviderProperty
- SetHeadphoneEQParameters
- SetHeadphoneEQPreset
- SetInEarMonitoringVolume
- SetLocalRenderMode
- SetLocalRenderTargetFps
- SetLocalVideoMirrorMode
- SetLocalVoiceEqualization
- SetLocalVoiceFormant
- SetLocalVoicePitch
- SetLocalVoiceReverb
- SetLogFile
- SetLogFileSize
- SetLogFilter
- SetLogLevel
- SetLowlightEnhanceOptions
- SetParameters
- SetRemoteDefaultVideoStreamType
- SetRemoteRenderMode
- SetRemoteRenderTargetFps
- SetRemoteSubscribeFallbackOption
- SetRemoteVideoStreamType
- SetRemoteVoicePosition
- SetScreenCaptureContentHint
- SetScreenCaptureScenario
- SetSubscribeAudioAllowlist
- SetSubscribeAudioBlocklist
- SetSubscribeVideoAllowlist
- SetSubscribeVideoBlocklist
- SetupLocalVideo
- SetupRemoteVideo
- SetVideoDenoiserOptions
- SetVideoEncoderConfiguration
- SetVideoScenario
- SetVoiceBeautifierParameters
- SetVoiceBeautifierPreset
- SetVoiceConversionPreset
- SetVolumeOfEffect
- StartAudioMixing
- StartAudioRecording
- StartEchoTest
- StartLastmileProbeTest
- StartLocalVideoTranscoder
- StartOrUpdateChannelMediaRelay
- StartPreview
- StartCameraCapture
- StartRhythmPlayer
- StartRtmpStreamWithoutTranscoding
- StartRtmpStreamWithTranscoding
- StartScreenCapture
- StartScreenCaptureBySourceType
- StartScreenCaptureByDisplayId
- StartScreenCaptureByScreenRect
- StartScreenCaptureByWindowId
- StartMediaRenderingTracing
- StopAllEffects
- StopAudioMixing
- StopAudioRecording
- StopChannelMediaRelay
- StopEchoTest
- StopEffect
- StopLastmileProbeTest
- StopLocalVideoTranscoder
- StopPreview
- StopCameraCapture
- StopRhythmPlayer
- StopRtmpStream
- StopScreenCapture
- StopScreenCaptureBySourceType
- SwitchCamera
- TakeSnapshot
- TakeSnapshotWithConfig
- UnloadAllEffects
- UnloadEffect
- UpdateChannelMediaOptions
- UpdateLocalTranscoderConfiguration
- UpdatePreloadChannelToken
- UpdateRtmpTranscoding
- UpdateScreenCapture
- UpdateScreenCaptureParameters
- UpdateScreenCaptureRegion
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
- OnCameraExposureAreaChanged
- OnCameraFocusAreaChanged
- OnCameraReady
- OnChannelMediaRelayStateChanged
- OnClientRoleChanged
- OnClientRoleChangeFailed
- OnConnectionBanned
- OnConnectionInterrupted
- OnConnectionLost
- OnConnectionStateChanged
- OnEncryptionError
- OnError
- OnExtensionErrorWithContext
- OnExtensionEventWithContext
- OnExtensionStartedWithContext
- OnExtensionStoppedWithContext
- OnFacePositionChanged
- OnFirstLocalAudioFramePublished
- OnFirstLocalVideoFrame
- OnFirstLocalVideoFramePublished
- OnFirstRemoteAudioFrame
- OnFirstRemoteAudioDecoded
- OnFirstRemoteVideoDecoded
- OnFirstRemoteVideoFrame
- OnJoinChannelSuccess
- OnLastmileProbeResult
- OnLastmileQuality
- OnLeaveChannel
- OnLocalAudioStateChanged
- OnLocalAudioStats
- OnLocalUserRegistered
- OnLocalVideoStateChanged
- OnLocalVideoStats
- OnLocalVideoTranscoderError
- OnTranscodedStreamLayoutInfo
- 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
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
- SetRemoteVoicePositionEx
- SetSubscribeAudioBlocklistEx
- SetSubscribeAudioAllowlistEx
- SetSubscribeVideoBlocklistEx
- SetSubscribeVideoAllowlistEx
- SetupRemoteVideoEx
- SetVideoEncoderConfigurationEx
- SendStreamMessageEx
- StartMediaRenderingTracingEx
- StartOrUpdateChannelMediaRelayEx
- StartRtmpStreamWithoutTranscodingEx
- StartRtmpStreamWithTranscodingEx
- StopChannelMediaRelayEx
- StopRtmpStreamEx
- TakeSnapshotEx
- TakeSnapshotWithConfigEx
- UpdateChannelMediaOptionsEx
- UpdateRtmpTranscodingEx
- AdjustUserPlaybackSignalVolumeEx
IScreenCaptureSourceList
IScreenCaptureSourceList 类。该类在 GetScreenCaptureSources 方法中返回。
相关参考
IVideoDeviceCollection
你可以通过该接口类获取视频设备相关的信息。
相关参考
IVideoDeviceManager
视频设备管理方法。
详情
IVideoDeviceManager 接口类提供用于测试视频设备的相关接口。你可以通过调用 GetAgoraVideoDeviceManager 方法来获取 IVideoDeviceManager 接口。