Home
Android API Reference
Full SDK API List
This page lists all interface classes on the Android platform and the APIs they contain.

Android API Reference
- API Overview
  Agora provides a flexible combination of APIs deployed globally to deliver reliable real-time audio and video communication.
- Full SDK API List
  This page lists all interface classes on the Android platform and the APIs they contain.
- Lite SDK API List
  This page lists the APIs supported by Lite SDK.
- Initialization
- Channel Management
- Publish and Subscribe
- Audio Features
- Video Features
- Media Playback
- Recording
- Cloud Media Relay
- Metadata
- Device Management
- Extensions
- Network and Others
- Class and Enum
  This page lists the definitions of all Class and Enum in Android.
- API Sunset Notice
  This page introduces the deprecated and deleted APIs in the SDK.

Full SDK API List

This page lists all interface classes on the Android platform and the APIs they contain.

AsyncCallback

Used to handle the result of an asynchronous operation.

Canvas

Used to set the video rendering view.

Since: Available since v4.4.0.

CanvasConfig

Used to configure the player's video rendering.

Since: Available since v4.4.0.

Error

Used to retrieve error codes and messages.

Since: Available since v4.4.0.

IAudioEncodedFrameObserver

Interface for listening to audio encoded frames.

IAudioFrameObserver

Interface for observing and processing audio frames.

IAudioSpectrumObserver

Interface for audio spectrum observation.

IBaseSpatialAudioEngine

IBaseSpatialAudioEngine: Basic spatial audio engine interface.

IDirectCdnStreamingEventHandler

Interface for handling CDN streaming related events.

Deprecated: Deprecated since v4.6.0.

ILocalSpatialAudioEngine

ILocalSpatialAudioEngine is the local spatial audio engine interface.

IMediaExtensionObserver

The IMediaExtensionObserver interface is used to listen for media extension-related events.

IMediaPlayer

The IMediaPlayer interface is used to implement media playback functionality.

IMediaPlayerAudioFrameObserver

Used to observe audio frames from the media player.

IMediaPlayerCacheManager

Used to manage media player cache.

IMediaPlayerCustomDataProvider

The IMediaPlayerCustomDataProvider interface is used to provide a custom data source for the media player.

IMediaPlayerObserver

Interface for monitoring media player state changes.

IMediaPlayerVideoFrameObserver

Used to observe video frames from the media player.

AgoraMediaRecorder

Used to record client-side audio and video.

Since: Available since v3.5.2.

AgoraMediaRecorder can record the following:

Audio captured by the local microphone and encoded by the SDK in AAC format.
Video captured by the local camera and encoded by the SDK.

Note: In the COMMUNICATION channel profile, this feature is not available if there are users in the channel using SDK versions earlier than v3.0.0.

IMediaRecorderCallback

Used to set media recording callback methods.

Since: Available since v4.0.0.

IMetadataObserver

Used to implement metadata observation features.

Note: Implement all callback methods in this class on the critical thread. Avoid performing any time-consuming operations on the critical thread.

IAgoraMusicContentCenter

IAgoraMusicContentCenter provides an interface for managing and accessing the music content center.

IMusicContentCenterEventHandler

Interface for handling events related to Music Content Center.

IAgoraMusicPlayer

Extends the IMediaPlayer interface to support more music playback features.

RtcEngine

Call the methods of this class to use all features of the Agora SDK.

Agora recommends calling RtcEngine API methods on the same thread to avoid calling from multiple threads. This class was previously named AgoraAudio in earlier versions and was renamed to RtcEngine starting from version 1.0.

IRtcEngineEventHandler

Encapsulates methods for sending event callbacks from the SDK to the application layer.

IRtcEngineEventHandler is an interface class used by the SDK to send event callbacks to the application layer. You can inherit this class to receive the desired event notifications. All methods in this interface are empty by default, and you can override them selectively as needed. To ensure proper SDK operation, avoid performing time-consuming operations or calling blocking APIs such as SendMessage in the callback methods.

RtcEngineEx

Extends the functionality of the RtcEngine interface.

IRtcEngineReleaseCallback

Used for asynchronous engine destruction.

Since: Available since v4.6.0.

IVideoEffectObject

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

Since: Available since v4.6.0.

IVideoEncodedFrameObserver

Used to listen for encoded video frames.

IVideoFrameObserver

Used for video frame callbacks.

You can implement the methods in the IVideoFrameObserver interface to receive and process video frames captured by the local device or sent by remote users.

Player

Used to play URL resources.

Since: Available since v4.4.0.

PlayerConfig

Used to configure media player options.

Since: Available since v4.4.0.

PlayerGetStatsCallback

Callback interface for retrieving playback statistics.

Since: Available since v4.4.0.

PlayerObserver

PlayerObserver is used to receive player event callbacks.

Since: Available since v4.4.0.

Rte

The Rte class serves as the basic interface of the Agora real-time interaction SDK.

Since: Available since v4.4.0.

PlayerInfo

Contains information about the player and media stream.

Since: Available since v4.4.0.