Video SDK for Unity
- API Overview
  Agora provides a flexible combination of APIs deployed globally to deliver reliable real-time audio and video communication.
- IRtcEngine
  The base interface class of the RTC SDK that implements the core functions of real-time audio and video.
- IRtcEngineEx
  Interface class that provides multi-channel methods.
- IRtcEngineEventHandler
  The IRtcEngineEventHandler interface class is used by the SDK to send event notifications to the App. The App receives the SDK's event notifications by inheriting methods of this interface class.
- IMediaPlayer
  Class that provides media player functionality and supports multiple instances.
- IMediaPlayerCacheManager
  This class provides methods to manage cached media files in the media player.
- IMediaPlayerSourceObserver
  Provides callbacks for the media player.
- IMediaPlayerCustomDataProvider
  Provides callbacks for opening custom media resource files.
- IAudioEncodedFrameObserver
  Observer for encoded audio.
- IAudioFrameObserver
  Audio frame observer.
- IAudioFrameObserverBase
  Audio observer.
- IVideoEncodedFrameObserver
  A class used to receive encoded video frames.
- IVideoFrameObserver
  Video frame observer.
- IAudioSpectrumObserver
  Audio spectrum observer.
- IMetadataObserver
  Metadata observer.
- IAudioDeviceManager
  Audio device management methods.
- IVideoDeviceManager
  Video device management methods.
- IMediaEngine
  IMediaEngine class.
- IDirectCdnStreamingEventHandler
  The IDirectCdnStreamingEventHandler interface class is used by the SDK to send CDN streaming event notifications to the App. The App receives the SDK's event notifications by inheriting methods of this interface class.
- IBaseSpatialAudioEngine
  This class contains some APIs from the ILocalSpatialAudioEngine class.
- ILocalSpatialAudioEngine
  This class implements spatial audio by calculating user coordinates through the SDK.
- Class and Enum
  This page lists the definitions of all Class and Enum in Unity.

IAudioSpectrumObserver

Audio spectrum observer.

OnLocalAudioSpectrum

Receives local audio spectrum.

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

After successfully calling RegisterAudioSpectrumObserver, implementing the OnLocalAudioSpectrum callback in IAudioSpectrumObserver, and calling EnableAudioSpectrumMonitor to enable audio spectrum monitoring, the SDK triggers this callback at the interval you set to report the spectrum of local audio data before encoding.

Parameters

data: Audio spectrum data of the local user. See AudioSpectrumData.

Return Values

Whether to receive spectrum data:

true: Receive.
false: Do not receive.

OnRemoteAudioSpectrum

Receives remote audio spectrum.

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

After successfully calling RegisterAudioSpectrumObserver, implementing the OnRemoteAudioSpectrum callback in IAudioSpectrumObserver, and calling EnableAudioSpectrumMonitor to enable audio spectrum monitoring, the SDK triggers this callback at the interval you set to report the spectrum of received remote audio data.

Parameters

spectrums: Audio spectrum information of remote users. See UserAudioSpectrumInfo. The array size equals the number of remote users detected by the SDK. An empty array indicates no remote user audio spectrum was detected.
spectrumNumber: Number of remote users.

Return Values

Whether to receive spectrum data:

true: Receive.
false: Do not receive.