Voice SDK for Electron
- 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 main 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 these 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.
- IAudioEncodedFrameObserver
  Observer for encoded audio frames.
- IAudioFrameObserver
  Audio frame observer.
- IAudioFrameObserverBase
  Audio frame observer.
- IMediaPlayerVideoFrameObserver
  Video data observer for media player.
- IVideoEncodedFrameObserver
  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
  The IMediaEngine class.
- IDirectCdnStreamingEventHandler
  The IDirectCdnStreamingEventHandler interface is used by the SDK to send CDN streaming event notifications to the app. The app receives SDK event notifications by inheriting methods from this interface.
- IBaseSpatialAudioEngine
  This class contains part of the 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 Electron.

IAudioSpectrumObserver

Audio spectrum observer.

onLocalAudioSpectrum

Gets the local audio spectrum.

onLocalAudioSpectrum?(data: AudioSpectrumData): void;

After successfully calling registerAudioSpectrumObserver to implement 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: The local user's audio spectrum data. See AudioSpectrumData.

onRemoteAudioSpectrum

Gets the remote audio spectrum.

onRemoteAudioSpectrum?(
    spectrums: UserAudioSpectrumInfo[],
    spectrumNumber: number
  ): void;

After successfully calling registerAudioSpectrumObserver to implement 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: The audio spectrum information of remote users. See UserAudioSpectrumInfo. The number of elements in the array equals the number of remote users monitored by the SDK. An empty array indicates no remote user audio spectrum is detected.
spectrumNumber: The number of remote users.