Interface Class
This page lists all interface classes for Windows.
IRtcEngine
The basic interface of the Agora SDK that implements the core functions of real-time communication.
IRtcEngine provides the main methods that your app can call.
Before calling other APIs, you must call createAgoraRtcEngine to create an IRtcEngine object.
IRtcEngineEx
This interface class contains multi-channel methods.
Inherited from IRtcEngine.
IRtcEngineEventHandler
IRtcEngineEventHandlerThe SDK uses the interface to send event notifications to your app. Your app can get those notifications through methods that inherit this interface.
All methods in this interface have default (empty) implementation. You can choose to inherit events related to your app scenario.
- In the callbacks, avoid implementing time-consuming tasks or calling APIs that may cause thread blocking (such as
sendMessage
). Otherwise, the SDK may not work properly. - The SDK no longer catches exceptions in the code logic that developers implement themselves in IRtcEngineEventHandler class. You need to handle this exception yourself, otherwise the app may crash when the exception occurs.
IMediaPlayer
This class provides media player functions and supports multiple instances.
IAudioEncodedFrameObserver
The encoded audio observer.
IAudioDeviceManager
Audio device management methods.
IAudioDeviceManager provides methods for audio device testing. You can get an IAudioDeviceManager interface by instantiating the IAudioDeviceManager class.
IAudioDeviceCollection
The IAudioDeviceCollection interface. You can get the information of audio devices with this interface.
IVideoDeviceManager
Video device management methods.
IVideoDeviceManager provides the methods related to testing video devices. You can get an IVideoDeviceManager interface by instantiating the IVideoDeviceManager class.
IVideoDeviceCollection
You can get the information of video devices with this interface.
IMediaEngine
The IMediaEngine class.
IMediaPlayerCacheManager
This class provides methods to manage cached media files.
IMediaPlayerCustomDataProvider
The callback for custom media resource files.
IMediaPlayerSourceObserver
Provides callbacks for media players.
IAudioFrameObserver
The audio frame observer.
Inherited from IAudioFrameObserverBase.
You can call registerAudioFrameObserver to register or unregister the IAudioFrameObserver audio frame observer.
IAudioFrameObserverBase
The audio frame observer.
You can call registerAudioFrameObserver to register or unregister the IAudioFrameObserverBase audio frame observer.
IAudioSpectrumObserver
The audio spectrum observer.
IPacketObserver
The definition of IPacketObserver.
IMetadataObserver
The metadata observer.
You can call registerMediaMetadataObserver to register or unregister the IMetadataObserver object.
IVideoEncodedFrameObserver
Receives encoded video images.
IVideoFrameObserver
The IVideoFrameObserver class.
You can call registerVideoFrameObserver to register or unregister an IVideoFrameObserver object.
IBaseSpatialAudioEngine
This class contains some of the APIs in the ILocalSpatialAudioEngine class.
The ILocalSpatialAudioEngine class inherits from IBaseSpatialAudioEngine.
ILocalSpatialAudioEngine
This class calculates user positions through the SDK to implement the spatial audio effect.
This class inherits from IBaseSpatialAudioEngine. Before calling other APIs in this class, you need to call the initialize method to initialize this class.
IScreenCaptureSourceList
The IScreenCaptureSourceList class. This class is returned in the getScreenCaptureSources method.
IMediaRecorder
Used for recording audio and video on the client.
- The audio captured by the local microphone and encoded in AAC format.
- The video captured by the local camera and encoded by the SDK.
COMMUNICATION
channel profile, this feature is unavailable when there are users using
SDK versions earlier than v3.0.0.IMediaRecorderObserver
The IMediaRecorderObserver class.