Voice 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.

IAudioSpectrumObserver

The audio spectrum observer.

OnLocalAudioSpectrum

Gets the statistics of a local audio spectrum.

public virtual bool OnLocalAudioSpectrum(AudioSpectrumData data)
        {
            return true;
        }

After successfully calling RegisterAudioSpectrumObserver to implement the OnLocalAudioSpectrum callback in IAudioSpectrumObserver and calling EnableAudioSpectrumMonitor to enable audio spectrum monitoring, the SDK triggers this callback as the time interval you set to report the received remote audio data spectrum before encoding.

Parameters

data: The audio spectrum data of the local user. See AudioSpectrumData.

Returns

Whether the spectrum data is received:

true: Spectrum data is received.
false: No spectrum data is received.

OnRemoteAudioSpectrum

Gets the remote audio spectrum.

public virtual bool OnRemoteAudioSpectrum(UserAudioSpectrumInfo[] spectrums, uint spectrumNumber)
        {
            return true;
        }

After successfully calling RegisterAudioSpectrumObserver to implement the OnRemoteAudioSpectrum callback in the IAudioSpectrumObserver and calling EnableAudioSpectrumMonitor to enable audio spectrum monitoring, the SDK will trigger the callback as the time interval you set to report the received remote audio data spectrum.

Parameters

spectrums: The audio spectrum information of the remote user. See UserAudioSpectrumInfo. The number of arrays is the number of remote users monitored by the SDK. If the array is null, it means that no audio spectrum of remote users is detected.
spectrumNumber: The number of remote users.

Returns

Whether the spectrum data is received:

true: Spectrum data is received.
false: No spectrum data is received.