Interface

2026-07-06


ZIMAudioError	ZIMAudioANSParam
ZIMAudioRecordConfig	ZIMAudioPlayConfig

ZIMAudioError

Error messages generated by the SDK.

Details

It can be used to record the error type and error information generated by the SDK, check the error code table on the ZEGO official website, and seek assistance from ZEGO technical support.

Declared in ZIMAudioDefines.ts

Properties

code

code: ZIMAudioErrorCode

Error code.

message

message: string

Error message.

ZIMAudioANSParam

Noise suppression configuration.

Details

Includes noise suppression mode.

Declared in ZIMAudioDefines.ts

Properties

mode

mode: ZIMAudioANSMode

Noise Suppression Mode (ANS).

ZIMAudioRecordConfig

Recording configuration.

Details

Configure the recording file output path and maximum recording time during recording.

Declared in ZIMAudioDefines.ts

Properties

filePath

filePath: string

The output path of the recording file. Currently, only full absolute paths with the suffix .mp3 or .m4a are supported. When passing in file paths in other formats, the SDK will throw an illegal file path error.

maxDuration

maxDuration: unsigned int

The maximum recording time, the default is 60000 ms, which is 60s. The unit of this parameter is milliseconds, and the maximum value does not exceed 120000.

ZIMAudioPlayConfig

Playing configuration.

Details

Configuration specifies the audio file path and routing type that currently need to be played.

Declared in ZIMAudioDefines.ts

Properties

filePath

filePath: string

The absolute path of the file needs to be played. Currently, only full absolute paths with the suffix .mp3 or .m4a are supported. When passing in file paths in other formats, the SDK will throw an illegal file path error.

routeType

routeType: ZIMAudioRouteType

Starting audio routing type when playing. The default playback device is the speaker.