API List
This page lists all interface classes on the C++ platform and the APIs they contain.
Canvas
The Canvas class is used to render video streams.
- Since
- Available since v4.4.0.
CanvasConfig
Used to configure video rendering parameters of the player.
- Since
- Available since v4.4.0.
Error
Used to retrieve error codes and error messages.
- Since
- Available since v4.4.0.
IAudioDeviceCollection
Used to manage a collection of audio devices.
IAudioDeviceManager
Used for audio device management.
IAudioEncodedFrameObserver
Callback interface for listening to encoded audio frames.
IAudioFrameObserver
Implements audio frame observation.
IAudioFrameObserverBase
Base class for audio frame observation.
IAudioPcmFrameSink
Used to monitor audio PCM frames.
IAudioSpectrumObserver
Used to observe and process audio spectrum data.
IDirectCdnStreamingEventHandler
Used to handle CDN streaming-related event callbacks.
- Deprecated
- Deprecated since v4.6.0.
ILocalSpatialAudioEngine
Used to implement the basic spatial audio engine interface functionality.
IMediaEngine
IMediaEngine is used to implement media engine-related functions.
IMediaPlayer
Provides access to media player instances.
If you want to play multiple media sources simultaneously, you can create multiple media player source objects.
IMediaPlayerCacheManager
Used to manage and configure player cache.
IMediaPlayerCustomDataProvider
Interface callback used to provide custom data sources.
The player continuously calls this interface to request you to fill in the data stream to be played.
IMediaPlayerSourceObserver
Used to report runtime events of the media player to the application.
IMediaRecorder
Interface used to implement media recording functionality.
IMediaRecorderObserver
Used to implement the observer interface for media recording.
IMetadataObserver
IMetadataObserver interface, used to handle metadata-related callbacks.
IMusicContentCenter
IMusicContentCenter is used to manage the music content center.
IMusicContentCenterEventHandler
Used to handle events related to the music content center.
IMusicPlayer
An interface used to play music.
IPacketObserver
The IPacketObserver class is used to implement observation and processing of custom packets.
IRtcEngine
The base interface class that implements Agora real-time communication core functionality.
IRtcEngineEventHandler
Used to receive SDK callback event notifications.
The SDK sends callback event notifications to the app through this class. You can inherit methods in this class to get the required event notifications. All methods in this class provide default (empty) implementations, and you can selectively inherit methods as needed. Avoid performing time-consuming operations or calling blocking APIs in the callback methods, as this may affect the normal operation of the SDK.
IRtcEngineEventHandlerEx
Class that extends the functionality of IRtcEngineEventHandler.
IRtcEngineEx
Extends the functionality of IRtcEngine.
IScreenCaptureSourceList
Used to obtain the list of screen sharing sources.
IVideoDeviceCollection
Used to obtain video device information.
IVideoDeviceManager
Used to manage video devices.
IVideoEffectObject
Used to manage and configure video effects, such as beauty effects, style makeup, and filters.
- Since
- Added since v4.6.0.
IVideoEncodedFrameObserver
Used to process encoded video frames.
IVideoFrameObserver
Used to observe and process video frames.
MusicChartCollection
Used to retrieve detailed information of music charts.
MusicCollection
Used to retrieve detailed information about the list of music resources.
Player
The Player class is used to play URL resources.
- Since
- Available since v4.4.0.
PlayerConfig
Used to set player configurations.
- Since
- Available since v4.4.0.
PlayerObserver
Used to listen to events from the Player object.
- Since
- Available since v4.4.0.
Rte
The Rte class is the base interface of the Agora Real-Time Engagement SDK.
- Since
- Available since v4.4.0.
PlayerInfo
Used to obtain information related to the player and media stream.
- Since
- Available since v4.5.1.