In-app Chat
On this page

Struct

2026-06-24
ZIMAudioErrorZIMAudioANSParam
ZIMAudioRecordConfigZIMAudioPlayConfig

ZIMAudioError

Error information generated by the SDK

Details

Can be used to record the error type and error information generated by the SDK. Check the Error Code table on the ZEGOCLOUD official website or contact ZEGOCLOUD Technical Support for assistance

Declared in entity/ZIMAudioError.java

Properties

code

code
public ZIMAudioErrorCode code

Error code

message

message
public String message

Error description

ZIMAudioANSParam

Noise suppression configuration

Details

Contains noise suppression mode

Declared in entity/ZIMAudioANSParam.java

Properties

mode

mode
public ZIMAudioANSMode mode

Noise suppression mode(ANS)

ZIMAudioRecordConfig

Recording configuration

Details

Configures the output path and maximum recording duration for the recording file

Declared in entity/ZIMAudioRecordConfig.java

Properties

filePath

filePath
public String filePath

Output path of the recording file. Currently only supports full absolute paths with .mp3 or .m4a extensions. Passing file paths in other formats will cause the SDK to report an invalid file path error

maxDuration

maxDuration
public int maxDuration

Maximum recording duration. Default is 60000 ms (60 seconds). The unit of this parameter is milliseconds, with a maximum value not exceeding 120000

ZIMAudioPlayConfig

Playback configuration

Details

Configures the specified audio file path for current playback and the route type

Declared in entity/ZIMAudioPlayConfig.java

Properties

filePath

filePath
public String filePath

Absolute path of the file to be played. Currently only supports full absolute paths with .mp3 or .m4a extensions. Passing file paths in other formats will cause the SDK to report an invalid file path error

routeType

routeType
public ZIMAudioRouteType routeType

Initial audio route type during playback. Default playback device is Speaker.

Previous

Class

Next

Enum

On this page

Back to top