Function Overview
2026-07-06
ZEGO ZIM SDKs provide rich APIs for you to quickly build in app chat capabilities into your applications.
ZEGO ZIM SDKs are available for all major platforms, including Android, iOS, Mac, Windows, and Web.
Audio plugin functions
| Method | Description |
|---|---|
| getVersion | Gets the SDK's version number. |
| setAdvancedConfigWithKey | Set up SDK advanced configuration, please contact ZEGO technical support before use. |
| sharedInstance | Get SDK singleton object. |
| initWithLicense: | Init ZIMAudio SDK |
| uninit | Uninit ZIMAudio SDK |
| setEventHandler | Sets up the event notification callbacks that need to be handled. |
| enableANS | Enables or disables active noise suppression (ANS, aka ANC). |
| enableAGC | Enables or disables automatic gain control (AGC). |
| setANSParam | Set noise suppression parameters, currently only includes noise suppression mode. |
| startRecordWithConfig | Start record audio file. |
| completeRecord | Complete record audio file. |
| cancelRecord | Cancel record audio file. |
| isRecording | Get whether recording is taking place. |
| setAudioRouteType | Set audio routing type. |
| startPlayWithConfig | Start playing audio file. |
| stopPlay | Stop playing audio file. |
| isPlaying | Get whether it is playing. |
| onError | SDK exception error notification. |
| onRecorderStarted | Recording start notification. |
| onRecorderCompleted | Recording completion notification. |
| onRecorderCancelled | Recording cancellation notification. |
| onRecorderProgress | Recording progress notification. |
| onRecorderFailed | Recording failure notification. |
| onPlayerStarted | Play start notification. |
| onPlayerEnded | Playback end notification. |
| onPlayerStopped | Play stop notification. |
| onPlayerProgress | Playback progress callback. |
| onPlayerInterrupted | Notification that playback has been interrupted. |
| onPlayerFailed | Playback failure notification. |