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.

IMediaPlayer

Provides access to media player instances.

If you want to play multiple media sources simultaneously, you can create multiple media player source objects.

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.

IMediaRecorder

Interface used to implement media recording functionality.

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.

IVideoEffectObject

Used to manage and configure video effects, such as beauty effects, style makeup, and filters.

Since
Added since v4.6.0.

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.

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.