Function Overview
2026-06-24
The ZEGOCLOUD In-app Chat SDK has network nodes comprehensively covering key regions worldwide, providing rich APIs to offer developers cross-platform interactive, high-concurrency, ultra-low-latency, guaranteed-message-delivery communication services, helping to build scenarios such as large-scale live streaming and audio chat rooms.
Audio Component Functions
| Method | Description |
|---|---|
| getVersion | Gets the SDK version number. |
| setAdvancedConfig | Sets advanced SDK configuration. Please contact ZEGOCLOUD Technical Support before use. |
| getInstance | Gets the SDK singleton object. |
| init | Initializes the ZIMAudio SDK |
| uninit | Deinitializes the ZIMAudio SDK |
| setEventHandler | Sets the event notification callback. |
| enableANS | Enables or disables noise suppression |
| enableAGC | Enables or disables automatic gain control |
| setANSParam | Sets noise suppression parameters, currently only includes noise suppression mode |
| startRecord | Starts recording an audio file |
| completeRecord | Completes recording an audio file |
| cancelRecord | Stops recording an audio file |
| isRecording | Gets whether recording is in progress |
| setAudioRouteType | Sets the audio route type |
| startPlay | Starts playing an audio file |
| stopPlay | Stops playing an audio file |
| isPlaying | Gets whether playback is in progress |
| onError | SDK error notification |
| onRecorderStarted | Recording started notification |
| onRecorderCompleted | Recording completed notification |
| onRecorderCancelled | Recording cancelled notification |
| onRecorderProgress | Recording progress notification |
| onRecorderFailed | Recording failed notification |
| onPlayerStarted | Playback started notification |
| onPlayerEnded | Playback ended notification |
| onPlayerStopped | Playback stopped notification |
| onPlayerProgress | Playback progress callback |
| onPlayerInterrupted | Playback interrupted notification |
| onPlayerFailed | Playback failed notification |