PushEvent

Normal events

There is a notification event after each successful publishing. For example, the return code 1003 indicates that the system will start rendering camera images.

Critical errors

If the SDK detects critical errors, publishing cannot continue. For example, a user disables the camera permission for the application, and the camera cannot be started as a result.

Note：

A video encoding failure does not affect publishing directly. The SDK will handle the failure automatically to ensure success of the subsequent video encoding.

Warning events

Most warning events will trigger the protection or recovery logic that involves retries, and in most cases the problems can be recovered by the SDK itself. Certain warning events need to be handled by developers.

• *WARNING_NET_BUSY: *If the host has poor network connections, the user can be notified through UI.

• *WARNING_SERVER_DISCONNECT: *The publishing request is rejected by the backend. This is usually caused by miscalculated txSecret in the publishing address, or because the publishing address is occupied by others (a publishing URL can only have one publishing end at a time).

PlayEvent

Key events

Note：

• *Determine whether the live streaming is over: *Due to the varying implementation principles of different standards, usually no end events (error code 2006) are returned for many live streams. Instead, when a host stops publishing, the SDK will soon find that data stream pull fails (WARNING_RECONNECT) and attempt to retry until the PLAY_ERR_NET_DISCONNECT event is thrown after three failed attempts. Therefore, determination needs to be made for both the error codes 2006 and -2301, and the determination result is used as the event to determine the end of live streaming.
• Do not hide the playback image after receiving PLAY_LOADING, because the time length between PLAY_LOADING and PLAY_BEGIN is uncertain (it may be 5 seconds or 5 milliseconds). Some customers consider hiding the playback image upon LOADING and displaying the image upon BEGIN, which will cause serious image flashing (especially in live streaming scenarios). It is recommended to place a translucent loading animation on top of the video playback image.

Warning events

Internal warnings are not irrecoverable errors. When warning events occur, the SDK will initiate appropriate recovery measures. The purpose of warning is mainly to inform developers or end users of the events.