Package ai.nexconn.call.api

Enum Class NCCallEndReason

java.lang.Object
java.lang.Enum<NCCallEndReason>
ai.nexconn.call.api.NCCallEndReason
All Implemented Interfaces:
Serializable, Comparable<NCCallEndReason>, Constable
public enum NCCallEndReason extends Enum<NCCallEndReason>
Reasons for call termination or state changes.

  • Enum Constant Details

    • NONE

      public static final NCCallEndReason NONE
      Invalid state. This normally does not occur and is usually used as the default enum value.

    • IDLE

      public static final NCCallEndReason IDLE
      Idle state. For a user, this means the user is not currently in an audio/video call. For a call, this means the call has ended or was never started.

    • CALLING

      public static final NCCallEndReason CALLING
      Calling state. The user is calling another user.

    • INVITED

      public static final NCCallEndReason INVITED
      Invited state. Example: user A and user B are in an audio/video call, and user A calls NCCallEngine.inviteToCall(List) to invite user C. Before user C answers successfully, user C is in this state from the perspective of user A and user B.

    • RINGING

      public static final NCCallEndReason RINGING
      Ringing state. After a user receives a call invitation, the SDK sends this state to remote users. It is only a marker and is unrelated to whether the device ringtone is playing.

    • BUSY_LINE_RINGING

      public static final NCCallEndReason BUSY_LINE_RINGING
      Busy-line (ringing) state. Example: user A is calling user B, and user C calls user A or B. User A and user B appear in this state to user C.

    • BUSY_LINE_WAIT

      public static final NCCallEndReason BUSY_LINE_WAIT
      Busy-line (in call) state. Example: user A and user B are in a call, and user C calls user A or B. User A and user B appear in this state to user C.

    • CONNECTING

      public static final NCCallEndReason CONNECTING
      Connecting state. The user enters this state after successfully calling NCCallEngine.acceptCall(String) or NCCallEngine.joinCall(String).

    • ON_CALL

      public static final NCCallEndReason ON_CALL
      In-call state. The audio/video call has been established successfully.

    • ON_PHONE

      public static final NCCallEndReason ON_PHONE
      The user has started placing or answering a carrier phone call. This state is not triggered if `android.permission.READ_PHONE_STATE` is not granted dynamically.

    • ON_PHONE_ENDED

      public static final NCCallEndReason ON_PHONE_ENDED
      The user has ended a carrier phone call. This state is not triggered if `android.permission.READ_PHONE_STATE` is not granted dynamically.

    • ON_DEVICE_DISABLE

      public static final NCCallEndReason ON_DEVICE_DISABLE
      The user has no audio/video input devices available. Triggered only on desktop clients.

    • ON_DEVICE_ENABLE

      public static final NCCallEndReason ON_DEVICE_ENABLE
      The user's audio/video input devices are available again. Triggered only on desktop clients.

    • BOUNDARY_ENDED

      public static final NCCallEndReason BOUNDARY_ENDED
      Abnormal termination.

    • ENDED

      public static final NCCallEndReason ENDED
      Call ended state.

    • NO_ANSWER

      public static final NCCallEndReason NO_ANSWER
      No-answer state. Example: user A places a one-to-one call to user B, and user B never answers. After the call times out and ends, user A is in `NO_ANSWER` and user B is in `MISSED`.

    • MISSED

      public static final NCCallEndReason MISSED
      Missed state. Example: user A places a one-to-one call to user B, and user B never answers. After the call times out and ends, user A is in `NO_ANSWER` and user B is in `MISSED`.

    • CANCELED

      public static final NCCallEndReason CANCELED
      Canceled state. Example: user A calls user B and hangs up successfully before user B answers. User A is then in the canceled state.

    • DECLINED

      public static final NCCallEndReason DECLINED
      Declined state. Example: user A calls user B and user B directly hangs up the call. User B is then in the declined state.

    • OTHER_CLIENT_CALLING

      public static final NCCallEndReason OTHER_CLIENT_CALLING
      In multi-device login scenarios, another local client is ringing, so audio/video calls are not allowed on this client.

    • ACCEPT_BY_OTHER_CLIENT

      public static final NCCallEndReason ACCEPT_BY_OTHER_CLIENT
      In multi-device login scenarios, another local client has already answered the call, so audio/video calls are not allowed on this client.

    • JOIN_RTC_ERROR

      public static final NCCallEndReason JOIN_RTC_ERROR
      The local user failed to join the room. If this happens, contact an engineer and provide logs for investigation.

    • PUBLISH_ERROR

      public static final NCCallEndReason PUBLISH_ERROR
      The local user failed to publish resources. This usually means remote users cannot see or hear the local user.

    • SUBSCRIBE_ERROR

      public static final NCCallEndReason SUBSCRIBE_ERROR
      The local user failed to subscribe to resources. This usually means the local user cannot see or hear remote users.

    • KICKED_BY_SERVER

      public static final NCCallEndReason KICKED_BY_SERVER
      The local user has been banned from calling by the server.

    • CONNECTION_ERROR

      public static final NCCallEndReason CONNECTION_ERROR
      The local user's UDP connection was disconnected.

    • LOGOUT

      public static final NCCallEndReason LOGOUT
      The local user's IM session logged out.

    • OTHER_CLIENT_LOGIN

      public static final NCCallEndReason OTHER_CLIENT_LOGIN
      The local user was kicked offline because the same account logged in to IM on another client, in scenarios where multi-device login is not enabled.

    • OTHER_JOINED_RTC

      public static final NCCallEndReason OTHER_JOINED_RTC
      The local user was kicked out because another client joined the RTC LIB room.

    • OTHER_CLIENT_IN_RTC

      public static final NCCallEndReason OTHER_CLIENT_IN_RTC
      Another local client is already in the RTC LIB room, so audio/video calls are not allowed on this client.

    • HANGUP_BY_OTHER_CLIENT

      public static final NCCallEndReason HANGUP_BY_OTHER_CLIENT
      In multi-device login scenarios, another local client has already hung up the call.

    • REMOTE_JOIN_RTC_ERROR

      public static final NCCallEndReason REMOTE_JOIN_RTC_ERROR
      The remote user failed to join the room.

    • REMOTE_PUBLISH_ERROR

      public static final NCCallEndReason REMOTE_PUBLISH_ERROR
      The remote user failed to publish resources.

    • REMOTE_SUBSCRIBE_ERROR

      public static final NCCallEndReason REMOTE_SUBSCRIBE_ERROR
      The remote user failed to subscribe to resources.

    • REMOTE_KICKED_BY_SERVER

      public static final NCCallEndReason REMOTE_KICKED_BY_SERVER
      The remote user has been banned from calling.

    • REMOTE_CONNECTION_ERROR

      public static final NCCallEndReason REMOTE_CONNECTION_ERROR
      The remote user's UDP connection was disconnected.

    • REMOTE_LOGOUT

      public static final NCCallEndReason REMOTE_LOGOUT
      The remote user's IM session logged out.

    • REMOTE_OTHER_CLIENT_LOGIN

      public static final NCCallEndReason REMOTE_OTHER_CLIENT_LOGIN
      The remote user was kicked offline because the same account logged in on another client.

    • REMOTE_OTHER_JOINED_RTC

      public static final NCCallEndReason REMOTE_OTHER_JOINED_RTC
      The remote user was kicked out because another client joined the RTC LIB room.

    • REMOTE_OTHER_CLIENT_IN_RTC

      public static final NCCallEndReason REMOTE_OTHER_CLIENT_IN_RTC
      Another client of the remote user is already in the RTC LIB room, so audio/video calls are not allowed.

    • NOT_SUPPORT_ENCRYPT

      public static final NCCallEndReason NOT_SUPPORT_ENCRYPT
      Encrypted calls are not supported.

    • ENCRYPT_FAILED

      public static final NCCallEndReason ENCRYPT_FAILED
      Encrypted call failed.

  • Field Details

    • ACTIVE_HANGUP_REASON

      public static final NCCallEndReason[] ACTIVE_HANGUP_REASON
      Set of reasons related to local active hang-up.

  • Method Details

    • values

      public static NCCallEndReason[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static NCCallEndReason valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getValue

      public int getValue()
      Returns the numeric reason value.

    • setValue

      public void setValue(int val)
      Sets the reason value. Used to support numeric mappings that are not explicitly included.
      Parameters:
      val - reason value

    • valueOf

      public static NCCallEndReason valueOf(int value)
      Resolves the reason from its numeric value.
      Parameters:
      value - reason value
      Returns:
      the matching reason, or NONE for unknown values while preserving the raw value