On-premise Recording SDK v3.0.6 API Reference for Linux (Java)
Public Attributes | List of all members
io.agora.recording.common.Common.LEAVE_PATH_CODE Enum Reference

Public Attributes

 LEAVE_CODE_INIT =(0)
 
 LEAVE_CODE_SIG =(1<<1)
 
 LEAVE_CODE_NO_USERS =(1<<2)
 
 LEAVE_CODE_TIMER_CATCH =(1<<3)
 
 LEAVE_CODE_CLIENT_LEAVE =(1<<4)
 

Detailed Description

The reasons why the recording server leaves the channel. You can perform a bitwise AND operation on the code and each enum value, and those with non-zero results are the reason for the exit. For example, if you perform a bit-by-bit AND operation on code 6 (binary 110) and each enum value, only LEAVE_CODE_SIG (binary 10) and LEAVE_CODE_NO_USERS (binary 100) get a non-zero result. The reasons for exiting, in this case, include a timeout and a signal triggering the exit.

Member Data Documentation

◆ LEAVE_CODE_INIT

io.agora.recording.common.Common.LEAVE_PATH_CODE.LEAVE_CODE_INIT =(0)

0: The initialization fails.

◆ LEAVE_CODE_SIG

io.agora.recording.common.Common.LEAVE_PATH_CODE.LEAVE_CODE_SIG =(1<<1)

2 (binary 10): The AgoraCoreService process receives the SIGINT signal.

◆ LEAVE_CODE_NO_USERS

io.agora.recording.common.Common.LEAVE_PATH_CODE.LEAVE_CODE_NO_USERS =(1<<2)

4 (binary 100): The recording server automatically leaves the channel and stops recording because the channel has no user.

◆ LEAVE_CODE_TIMER_CATCH

io.agora.recording.common.Common.LEAVE_PATH_CODE.LEAVE_CODE_TIMER_CATCH =(1<<3)

8 (binary 1000): Ignore it.

◆ LEAVE_CODE_CLIENT_LEAVE

io.agora.recording.common.Common.LEAVE_PATH_CODE.LEAVE_CODE_CLIENT_LEAVE =(1<<4)

16 (binary 10000): The recording server calls the leaveChannel method to leave the channel.