Error Codes

---

Introduction

When the SDK is running with network or media-related errors, the SDK cannot be automatically restored and requires APP intervention or user prompts. If there is an error message in the returned result after calling an interface, an error message in the event callback, or an error log in the console log, it means that the interface is called abnormally.

• Sample code of error message returned after calling the interface:

const { errorCode, extendedData } = await zg.setCaptureVolume(stream, result);
// errorCode Is the Error Codes, extendedData is the error Description information
console.log(errorCode, extendedData); 

• Example code of error message in event callback:

zg.on('roomStateUpdate', (roomID, state, errorCode, extendedData) => {
    if (errorCode !== 0) {
      // errorCode Is the Error Codes, extendedData is the error Description information
      console.log(errorCode, extendedData); 
    }
})

1000xxx/1100xxx General Error Codes

Generic class Error Codes error Error Codes common interfaces, usually call startPublishingStream , startPlayingStream interfaces will appear, and the following processing according to the corresponding Error Codes.

1001xxx/1101xxx Error Codes During Debugging

Error Codes in the debugging phase refer to the errors that developers tend to make during application development, and are generally manifested as interface parameter errors.

1002xxx/1102xxx Room Related Error Codes

An error occurred when calling the loginRoom interface, usually due to an error in the login room parameter, and an abnormality in the communication between the SDK and the ZEGOCLOUD room server.

1003xxx/1103xxx Error Codes Related to Publish Streams

After calling the publish streams interface, or if an exception occurs during the publish streams process, the developer can obtain the relevant Error Codes from the publisherStateUpdate callback, and please deal with it accordingly according to the following Error Codes.

Handling the case where the publish streams callback Error Codes is not 0:

1. When the "state" is "NO_PUBLISH", and "errorCode" non-zero, indicates a failure publish streams, while will not retry the publish streams, publish streams can be made at this time at the interface prompt failure.
2. When the "state" is "PUBLISH_REQUESTING" and the "errorCode" is not 0, it means that the publish streams. At this time, if the publish streams is unsuccessful beyond the retry time, a publish streams failure notification will be thrown.

1004xxx/1104xxx Play Streams Related Error Codes

After calling the play streams interface, or if an exception occurs in the middle of the play streams , the developer can obtain the relevant Error Codes from the playerStateUpdate play streams state callback. Please deal with the corresponding error code according to the following Error Codes.

1005xxx Stream Mixing Stream Related Error Codes

Call the start Stream Mixing stream startMixerTask and stop Stream Mixing stream stopMixerTask interface to return possible errors in the result.

1006xxx/1106xxx Device Error

The process of publish streams and play streams may cause errors in the audio and Video equipment used. When the developer receives deviceError the "errorCode" of the device exception callback parameter is not 0, please follow the Error Codes below deal with.

1009xxx/1109xxx IM Error

Errors in sending IM messages.

1017xxx Errors Related to copyrightedmusic

The errors related to the SDK's copyrightedmusic functions.

Errors Related to ZegoExpressPlayer