Video SDK for Unity
- API Overview
  Agora provides ensured quality of experience (QoE) for worldwide Internet-based voice and video communications through SD-RTN™.
- IRtcEngine
  The basic interface of the Agora SDK that implements the core functions of real-time communication.
- IRtcEngineEx
  This interface class contains multi-channel methods.
- IRtcEngineEventHandler
  The SDK uses the IRtcEngineEventHandler interface to send event notifications to your app. Your app can get those notifications through methods that inherit this interface.
- IMediaPlayer
  This class provides media player functions and supports multiple instances.
- IMediaPlayerAudioFrameObserver
  The audio frame observer for the media player.
- IMediaPlayerCacheManager
  This class provides methods to manage cached media files.
- IMediaPlayerCustomDataProvider
  The callback for custom media resource files.
- IMediaPlayerSourceObserver
  Provides callbacks for media players.
- IAudioEncodedFrameObserver
  The encoded audio observer.
- IAudioDeviceManager
  Audio device management methods.
- IAudioPcmFrameSink
  This class is used to get raw PCM audio.
- IAudioFrameObserver
  The audio frame observer.
- IAudioSpectrumObserver
  The audio spectrum observer.
- IMetadataObserver
  The metadata observer.
- IVideoDeviceManager
  Video device management methods.
- IVideoEncodedFrameObserver
  Receives encoded video images.
- IVideoFrameObserver
  The IVideoFrameObserver class.
- IFaceInfoObserver
  Facial information observer.
- ILocalSpatialAudioEngine
  This class calculates user positions through the SDK to implement the spatial audio effect.
- VideoSurface
  This class contains Unity native methods related to video rendering.
- VideoSurfaceYUV
  Porivdes APIs for rendering videos. This class inherits all APIs from the VideoSurface class, but enables you to render video images with high resolutions (such as 4K) faster and at higher frame rates. As of v4.2.0, Agora Unity SDK does not support rendering different video sources with both VideoSurface and VideoSurfaceYUV at the same time. Specifically, after successfully creating IRtcEngine, if the first view is rendered with VideoSurfaceYUV, then only VideoSurfaceYUV can be used for rendering throughout the entire lifecycle of IRtcEngine.
- Class and Enum
  This page lists all the definitions of Class and the enums for Unity.

IAudioEncodedFrameObserver

The encoded audio observer.

OnMixedAudioEncodedFrame

Gets the mixed and encoded audio data of the local and all remote users.

public virtual void OnMixedAudioEncodedFrame(IntPtr frameBufferPtr, int length,
                                                    EncodedAudioFrameInfo audioEncodedFrameInfo)
        {

        }

After calling RegisterAudioEncodedFrameObserver and setting the audio profile as AUDIO_ENCODED_FRAME_OBSERVER_POSITION_MIXED, you can get the mixed and encoded audio data of the local and all remote users through this callback.

Parameters

frameBufferPtr: The audio buffer.
length: The data length (byte).
audioEncodedFrameInfo: Audio information after encoding. See EncodedAudioFrameInfo.

OnPlaybackAudioEncodedFrame

Gets the encoded audio data of all remote users.

public virtual void OnPlaybackAudioEncodedFrame(IntPtr frameBufferPtr, int length,
                                                    EncodedAudioFrameInfo audioEncodedFrameInfo)
        {

        }

After calling RegisterAudioEncodedFrameObserver and setting the encoded audio as AUDIO_ENCODED_FRAME_OBSERVER_POSITION_PLAYBACK, you can get encoded audio data of all remote users through this callback.

Parameters

frameBufferPtr: The audio buffer.
length: The data length (byte).
audioEncodedFrameInfo: Audio information after encoding. See EncodedAudioFrameInfo.

OnRecordAudioEncodedFrame

Gets the encoded audio data of the local user.

public virtual void OnRecordAudioEncodedFrame(IntPtr frameBufferPtr, int length,
                                                    EncodedAudioFrameInfo audioEncodedFrameInfo)
        {

        }

After calling RegisterAudioEncodedFrameObserver and setting the encoded audio as AUDIO_ENCODED_FRAME_OBSERVER_POSITION_RECORD, you can get the encoded audio data of the local user from this callback.

Parameters

frameBufferPtr: The audio buffer.
length: The data length (byte).
audioEncodedFrameInfo: Audio information after encoding. See EncodedAudioFrameInfo.