Home
Video SDK for Flutter
RtcEngineExt
The derived interface class from RtcEngine.

Video SDK for Flutter
- API Overview
  Agora provides ensured quality of experience (QoE) for worldwide Internet-based voice and video communications through SD-RTN™.
- RtcEngine
  The basic interface of the Agora SDK that implements the core functions of real-time communication.
- RtcEngineEx
  This interface class contains multi-channel methods.
- RtcEngineEventHandler
  The SDK uses the RtcEngineEventHandler interface to send event notifications to your app. Your app can get those notifications through methods that inherit this interface.
- MediaPlayer
  This class provides media player functions and supports multiple instances.
- AudioEncodedFrameObserver
  The encoded audio observer.
- AudioDeviceManager
  Audio device management methods.
- VideoDeviceManager
  Video device management methods.
- MediaEngine
  The MediaEngine class.
- MediaPlayerCacheManager
  This class provides methods to manage cached media files.
- MediaPlayerSourceObserver
  Provides callbacks for media players.
- AudioPcmFrameSink
  This class is used to get raw PCM audio.
- AudioFrameObserverBase
  The audio frame observer.
- AudioSpectrumObserver
  The audio spectrum observer.
- MetadataObserver
  The metadata observer.
- VideoEncodedFrameObserver
  Receives encoded video images.
- VideoFrameObserver
  The IVideoFrameObserver class.
- FaceInfoObserver
  Facial information observer.
- LocalSpatialAudioEngine
  This class calculates user positions through the SDK to implement the spatial audio effect.
- MediaPlayerVideoFrameObserver
  The video frame observer for the media player.
- RtcEngineExt
  The derived interface class from RtcEngine.
- AgoraVideoView
  The AgoraVideoView Class for rendering local and remote video.
- MediaPlayerController
  The AgoraVideoView controller used to render the video for the media player.
- VideoViewController
  A AgoraVideoView controller for rendering local and remote video.
- Class and Enum
  This page lists all the definitions of Class and the enums for Flutter.

RtcEngineExt

The derived interface class from RtcEngine.

createAgoraRtcEngine

Creates one RtcEngine object.

RtcEngine createAgoraRtcEngine() {
  return impl.RtcEngineImpl.create();
}

Details

Currently, the Agora RTC SDK v6.x supports creating only one RtcEngine object for each app.

Returns

One RtcEngine object.

createAgoraRtcEngineEx

Creates one RtcEngineEx object.

RtcEngineEx createAgoraRtcEngineEx() {
  return impl.RtcEngineImpl.create();
}

Details

Currently, the Agora RTC v6.x SDK supports creating only one RtcEngineEx object for each app.

Returns

One RtcEngineEx object.

getAssetAbsolutePath

Obtains the actual absolute path of the Asset through the relative path of the Asset.

Future<String?> getAssetAbsolutePath(String assetPath)

Parameters

assetPath: The flutter -> assets field configured in the pubspec.yaml file.

Returns

The actual path of the Asset.

getMediaPlayerCacheManager

Gets one MediaPlayerCacheManager instance.

MediaPlayerCacheManager getMediaPlayerCacheManager()

Before calling any APIs in the MediaPlayerCacheManager class, you need to call this method to get a cache manager instance of a media player.

Call timing

Make sure the RtcEngine is initialized before you call this method.

Restrictions

The cache manager is a singleton pattern. Therefore, multiple calls to this method returns the same instance.

Returns

The MediaPlayerCacheManager instance.