API 列表
- Unreal C++
更新时间不可用
本页列出 Unreal 所有的接口类以及其中包含的 API。
IAgoraParameter
RTC SDK 的接口类，提供 SDK 的 JSON 配置信息。
相关参考
IAudioDeviceCollection
IAudioDeviceCollection 类。你可以通过该接口类获取音频设备相关的信息。
相关参考
- getApplicationVolume
- getCount
- getDefaultDevice [1/2]
- getDefaultDevice [2/2]
- getDevice [1/2]
- getDevice [2/2]
- isApplicationMute
- release
- setApplicationMute
- setApplicationVolume
- setDevice
IAudioDeviceManager
音频设备管理方法。
详情
IAudioDeviceManager 接口类提供用于测试音频设备的相关接口。你可以通过调用 queryInterface 方法来获取 IAudioDeviceManager 接口。
相关参考
- enumeratePlaybackDevices
- enumerateRecordingDevices
- followSystemLoopbackDevice
- followSystemPlaybackDevice
- followSystemRecordingDevice
- getLoopbackDevice
- getPlaybackDevice
- getPlaybackDeviceInfo [1/2]
- getPlaybackDeviceMute
- getRecordingDevice
- getRecordingDeviceInfo [1/2]
- getRecordingDeviceMute
- getRecordingDeviceVolume
- release
- setLoopbackDevice
- setPlaybackDevice
- setPlaybackDeviceMute
- setPlaybackDeviceVolume
- setRecordingDevice
- setRecordingDeviceMute
- setRecordingDeviceVolume
- startAudioDeviceLoopbackTest
- startPlaybackDeviceTest
- startRecordingDeviceTest
- stopAudioDeviceLoopbackTest
- stopPlaybackDeviceTest
- stopRecordingDeviceTest
IAudioEncodedFrameObserver
编码后音频的观测器。
相关参考
IAudioFrameObserver
音频观测器。
详情
你可以调用 registerAudioFrameObserver 注册或取消注册 IAudioFrameObserver 音频观测器。
IAudioFrameObserverBase
音频观测器。
详情
你可以调用 registerAudioFrameObserver 注册或取消注册 IAudioFrameObserverBase 音频观测器。
相关参考
- onEarMonitoringAudioFrame
- onMixedAudioFrame
- onPlaybackAudioFrame
- onRecordAudioFrame
- getObservedAudioFramePosition
- getRecordAudioParams
- getMixedAudioParams
- getPlaybackAudioParams
- getEarMonitoringAudioParams
IAudioPcmFrameSink
该类用于获取原始的 PCM 音频数据。
详情
你可以继承这个类，实现 onFrame 回调来获得 PCM 音频数据。
相关参考
IAudioSpectrumObserver
音频频谱观测器。
相关参考
IBaseSpatialAudioEngine
该类包含 ILocalSpatialAudioEngine 类中的部分 API。
详情
ILocalSpatialAudioEngine 类继承自 IBaseSpatialAudioEngine。
相关参考
- muteAllRemoteAudioStreams
- muteLocalAudioStream
- release
- muteRemoteAudioStream
- setAudioRecvRange
- setDistanceUnit
- setMaxAudioRecvCount
- setPlayerAttenuation
- setRemoteAudioAttenuation
- setZones
- updatePlayerPositionInfo
- updateSelfPosition
IDirectCdnStreamingEventHandler
IDirectCdnStreamingEventHandler 接口类用于 SDK 向 App 发送 CDN 推流的事件通知，App 通过继承该接口类的方法获取 SDK 的事件通知。
相关参考
ILocalSpatialAudioEngine
该类通过 SDK 计算用户坐标，实现空间音频。
详情
该类继承自 IBaseSpatialAudioEngine。调用该类下其他 API 前，你需要调用 initialize 方法初始化该类。
相关参考
IMediaEngine
IMediaEngine 类。
相关参考
- createCustomAudioTrack
- destroyCustomAudioTrack
- pullAudioFrame
- pushAudioFrame
- pushVideoFrame
- registerAudioFrameObserver
- registerVideoEncodedFrameObserver
- registerVideoFrameObserver
- setExternalAudioSink
- setExternalAudioSource
- setExternalVideoSource
IMediaPlayer
提供媒体播放器功能的类，支持多实例。
相关参考
- adjustPlayoutVolume
- adjustPublishSignalVolume
- getDuration
- getMediaPlayerCacheManager
- getMediaPlayerId
- getMute
- getPlayoutVolume
- getPlayPosition
- getPlaySrc
- getPublishSignalVolume
- getState
- getStreamCount
- getStreamInfo
- mute
- open
- openWithMediaSource
- pause
- play
- playPreloadedSrc
- preloadSrc
- registerAudioFrameObserver [1/2]
- registerAudioFrameObserver [2/2]
- registerPlayerSourceObserver
- registerVideoFrameObserver
- resume
- seek
- selectAudioTrack [2/2]
- selectMultiAudioTrack
- setAudioPitch
- setAudioDualMonoMode
- setLoopCount
- setPlaybackSpeed
- setPlayerOption [1/2]
- setPlayerOption [2/2]
- setRenderMode
- setSpatialAudioParams
- setView
- stop
- switchSrc
- unloadSrc
- unregisterAudioFrameObserver
- unregisterPlayerSourceObserver
- unregisterVideoFrameObserver
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
IMediaRecorder
提供本地及远端音视频录制功能的类。
相关参考
IMediaRecorderObserver
包含音视频录制的事件。
相关参考
IMetadataObserver
Metadata 观测器。
你可以调用 registerMediaMetadataObserver 注册或取消注册 IMetadataObserver 观测器。
相关参考
IMusicContentCenter
IMusicContentCenter 接口类提供音乐内容中心的相关方法。 该接口类下的方法仅适用于 Android 和 iOS 平台。
相关参考
- initialize
- renewToken
- release
- removeCache
- registerEventHandler
- unregisterEventHandler
- createMusicPlayer
- getCaches
- getInternalSongCode
- getMusicCharts
- getMusicCollectionWithMusicChartId
- getSongSimpleInfo
- searchMusic
- preload [1/2]
- preload [2/2]
- isPreloaded
- getLyric
- destroyMusicPlayer
IMusicContentCenterEventHandler
IMusicContentCenterEventHandler 接口类，用于 SDK 向客户端发送音乐内容中心事件通知。
相关参考
IMusicPlayer
继承自 IMediaPlayer 类，提供音乐播放器的相关方法。
相关参考
IPacketObserver
IPacketObserver 定义。
相关参考
IRtcEngine
RTC SDK 的基础接口类，实现实时音视频的主要功能。
详情
IRtcEngine 提供了 App 调用的主要方法。
在调用其他 API 之前，必须先调用 Get 创建 IRtcEngine 对象。
相关参考
- addVideoWatermark [1/2]
- addVideoWatermark [2/2]
- adjustAudioMixingPlayoutVolume
- adjustAudioMixingPublishVolume
- adjustAudioMixingVolume
- adjustCustomAudioPlayoutVolume
- adjustCustomAudioPublishVolume
- adjustLoopbackSignalVolume
- adjustPlaybackSignalVolume
- adjustRecordingSignalVolume
- adjustUserPlaybackSignalVolume
- clearVideoWatermarks
- complain
- configRhythmPlayer
- Get
- createCustomVideoTrack
- createDataStream [1/2]
- createDataStream [2/2]
- createMediaPlayer
- createMediaRecorder
- destroyCustomVideoTrack
- destroyMediaPlayer
- disableAudio
- disableAudioSpectrumMonitor
- disableVideo
- enableAudio
- enableAudioSpectrumMonitor
- enableAudioVolumeIndication
- enableContentInspect
- enableCustomAudioLocalPlayback
- enableDualStreamMode [1/2]
- enableDualStreamMode [2/2]
- enableEncryption
- enableExtension
- enableFaceDetection
- enableInEarMonitoring
- enableInstantMediaRendering
- enableLocalAudio
- enableLocalVideo
- enableLoopbackRecording
- enableMultiCamera
- enableCameraCenterStage
- enableSoundPositionIndication
- enableSpatialAudio
- enableVideo
- enableVideoImageSource
- enableVirtualBackground
- enableVoiceAITuner
- enableWebSdkInteroperability
- getAudioDeviceInfo
- getAudioMixingCurrentPosition
- getAudioMixingDuration
- getAudioMixingPlayoutVolume
- getAudioMixingPublishVolume
- getAudioTrackCount
- getCallId
- getCameraMaxZoomFactor
- getConnectionState
- getCurrentMonotonicTimeInMs
- 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
- joinChannel [1/2]
- joinChannel [2/2]
- joinChannelWithUserAccount [1/2]
- joinChannelWithUserAccount [2/2]
- leaveChannel [1/2]
- leaveChannel [2/2]
- loadExtensionProvider
- muteAllRemoteAudioStreams
- muteAllRemoteVideoStreams
- muteLocalAudioStream
- muteLocalVideoStream
- muteRecordingSignal
- muteRemoteAudioStream
- muteRemoteVideoStream
- pauseAllChannelMediaRelay
- pauseAllEffects
- pauseAudioMixing
- pauseEffect
- playAllEffects
- playEffect
- preloadChannel
- preloadChannelWithUserAccount
- preloadEffect
- queryCameraFocalLengthCapability
- queryCodecCapability
- queryDeviceScore
- queryInterface
- queryScreenCaptureCapability
- rate
- registerAudioEncodedFrameObserver
- registerAudioSpectrumObserver
- registerExtension
- registerLocalUserAccount
- registerMediaMetadataObserver
- registerPacketObserver
- Release
- renewToken
- resumeAllChannelMediaRelay
- resumeAllEffects
- resumeAudioMixing
- resumeEffect
- selectAudioTrack [1/2]
- sendCustomReportMessage
- sendStreamMessage
- setAdvancedAudioOptions
- setAINSMode
- setAudioEffectParameters
- setAudioEffectPreset
- setAudioMixingDualMonoMode
- setAudioMixingPitch
- setAudioMixingPosition
- setAudioMixingPlaybackSpeed
- setAudioProfile [1/2]
- setAudioProfile [2/2]
- setAudioScenario
- setAudioSessionOperationRestriction
- setAVSyncSource
- setBeautyEffectOptions
- setFaceShapeAreaOptions
- setFaceShapeBeautyOptions
- setFilterEffectOptions
- setCameraAutoExposureFaceModeEnabled
- setCameraAutoFocusFaceModeEnabled
- setCameraCapturerConfiguration
- setCameraDeviceOrientation
- setCameraExposureFactor
- setCameraExposurePosition
- setCameraFocusPositionInPreview
- setCameraStabilizationMode
- setCameraTorchOn
- setCameraZoomFactor
- setChannelProfile
- setClientRole [1/2]
- setClientRole [2/2]
- setCloudProxy
- setColorEnhanceOptions
- setDefaultAudioRouteToSpeakerphone
- setDirectCdnStreamingAudioConfiguration
- setDirectCdnStreamingVideoConfiguration
- setDualStreamMode [1/2]
- setDualStreamMode [2/2]
- setEarMonitoringAudioFrameParameters
- setEffectPosition
- setEffectsVolume
- setEnableSpeakerphone
- setExtensionProperty
- setExtensionProviderProperty
- setExternalAudioSink
- setExternalRemoteEglContext
- setHeadphoneEQParameters
- setHeadphoneEQPreset
- setInEarMonitoringVolume
- setLocalRenderMode [1/2]
- setLocalRenderMode [2/2]
- setLocalRenderTargetFps
- setLocalVideoMirrorMode
- setLocalVoiceEqualization
- setLocalVoiceFormant
- setLocalVoicePitch
- setLocalVoiceReverb
- setLogFile
- setLogFileSize
- setLogFilter
- setLogLevel
- setLowlightEnhanceOptions
- setMixedAudioFrameParameters
- setParameters [1/2]
- setPlaybackAudioFrameBeforeMixingParameters
- setPlaybackAudioFrameParameters
- setRecordingAudioFrameParameters
- setRemoteDefaultVideoStreamType
- setRemoteRenderMode
- setRemoteRenderTargetFps
- setRemoteSubscribeFallbackOption
- setRemoteUserSpatialAudioParams
- setRemoteVideoStreamType
- setRemoteVideoSubscriptionOptions
- setRemoteVoicePosition
- setRouteInCommunicationMode
- setScreenCaptureContentHint
- setScreenCaptureScenario
- setSubscribeAudioAllowlist
- setSubscribeAudioBlocklist
- setSubscribeVideoAllowlist
- setSubscribeVideoBlocklist
- setupLocalVideo
- setupRemoteVideo
- setVideoDenoiserOptions
- setVideoEncoderConfiguration
- setVideoScenario
- setVoiceBeautifierParameters
- setVoiceBeautifierPreset
- setVoiceConversionPreset
- setVolumeOfEffect
- startAudioMixing [1/2]
- startAudioMixing [2/2]
- startAudioRecording [3/3]
- startDirectCdnStreaming
- startEchoTest
- startLastmileProbeTest
- startLocalVideoTranscoder
- startOrUpdateChannelMediaRelay
- startPreview [1/2]
- startPreview [2/2]
- startCameraCapture
- startRhythmPlayer
- startLocalAudioMixer
- stopLocalAudioMixer
- updateLocalAudioMixerConfiguration
- startRtmpStreamWithoutTranscoding
- startRtmpStreamWithTranscoding
- startScreenCapture [1/2]
- startScreenCapture [2/2]
- startScreenCaptureByDisplayId
- startScreenCaptureByScreenRect
- startScreenCaptureByWindowId
- startMediaRenderingTracing
- stopAllEffects
- stopAudioMixing
- stopAudioRecording
- stopChannelMediaRelay
- stopDirectCdnStreaming
- stopEchoTest
- stopEffect
- stopLastmileProbeTest
- stopLocalVideoTranscoder
- stopPreview [1/2]
- stopPreview [2/2]
- stopCameraCapture
- stopRhythmPlayer
- stopRtmpStream
- stopScreenCapture [1/2]
- stopScreenCapture [2/2]
- switchCamera
- takeSnapshot
- takeSnapshot [2/2]
- unloadAllEffects
- unloadEffect
- unregisterAudioSpectrumObserver
- unregisterMediaMetadataObserver
- 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 [1/2]
- createDataStreamEx [2/2]
- enableAudioVolumeIndicationEx
- enableContentInspectEx
- enableDualStreamModeEx
- enableEncryptionEx
- enableLoopbackRecordingEx
- getCallIdEx
- getConnectionStateEx
- joinChannelEx
- joinChannelWithUserAccountEx
- leaveChannelEx [1/2]
- leaveChannelEx [2/2]
- 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
- takeSnapshotEx [2/2]
- updateChannelMediaOptionsEx
- updateRtmpTranscodingEx
- adjustUserPlaybackSignalVolumeEx
IScreenCaptureSourceList
IScreenCaptureSourceList 类。该类在 getScreenCaptureSources 方法中返回。
相关参考
IVideoDeviceCollection
你可以通过该接口类获取视频设备相关的信息。
相关参考
IVideoDeviceManager
视频设备管理方法。
详情
IVideoDeviceManager 接口类提供用于测试视频设备的相关接口。你可以通过调用 queryInterface 方法来获取 IVideoDeviceManager 接口。
相关参考
IVideoEncodedFrameObserver
用于接收编码后的视频图像的类。
相关参考
IVideoFrameObserver
视频观测器。
详情
你可以调用 registerVideoFrameObserver 注册或取消注册 IVideoFrameObserver 视频观测器。