PlanetKitDisconnectReason

@objc
@frozen
public enum PlanetKitDisconnectReason : Int
extension PlanetKitDisconnectReason: CustomStringConvertible

Describes the disconnect reasons.

COMMON REASON (1001 ~ 1100)

  • [Both][Caller, Callee, Participant] Disconnected the call without exceptions.

    Declaration

    Swift

    case normal = 1001
  • [Both][Callee, CloudServer]

    • 1-to-1 call: Responder rejects a call.
    • Conference: Joining previously joined conference that the user did not properly leave (e.g. due to a crash) is declined until the user is disconnected by the server.

    Declaration

    Swift

    case decline = 1002
  • [Both][Caller, Callee, Participant] Received a cellular call during the PlanetKit call.

    Declaration

    Swift

    case cellCall = 1003

ERROR REASON (1101 ~ 1200)

  • [Both][Caller, Callee, Participant, CloudServer] Disconnected by PlanetKit’s internal error.

    Declaration

    Swift

    case internalError = 1109
  • [Both][Caller, Callee, AppServer] Application defined error. userCode is accompanied.

    • For events, userCode is in PlanetKitDisconnectedParam.
    • For API, userErrorReleasePhrase is the parameter of ‘PlanetKitCall.EndCall()’.

    1-to-1 call: userCode is defined by the call peer.

    Group call: userCode is defined by AppServer. For example) https://docs.lineplanet.me/server-api/server-api-kickout

    Declaration

    Swift

    case userError = 1110
  • [Both][Caller, Callee, Participant] Disconnected by an OS-specific error.

    Declaration

    Swift

    case internalKitError = 1111
  • [Both][Caller, Callee, Participant] Audio source (e.g. mic) has not sent any audio data for a while.

    Declaration

    Swift

    case micNoSource = 1112

COMMON REASON (1201 ~ 1300)

  • [1:1][Caller] Initiator disconnected the call before the responder answers.

    Declaration

    Swift

    case cancel = 1201
  • [1:1][Callee] Responder is calling.

    Declaration

    Swift

    case busy = 1202
  • [1:1][Caller] Responder doesn’t answer for 60 seconds.

    Declaration

    Swift

    case noAnswer = 1203
  • [Both][CloudServer] The initiator or the participant already has an incoming call but not received push yet.

    Declaration

    Swift

    case alreadyGotACall = 1204
  • [Both][CloudServer] The same ID pair (user-id and service-id) is calling in another device.

    Declaration

    Swift

    case multiDeviceInUse = 1205
  • [1:1][CloudServer] Responder using the same ID pair (user-id and service-id) answered the call in another device.

    Declaration

    Swift

    case multiDeviceAnswer = 1206
  • [1:1][CloudServer] Responder using the same ID pair(user-id and service-id) declined the call in another device.

    Declaration

    Swift

    case multiDeviceDecline = 1207
  • [Both][CloudServer] Maximum call time has been reached.

    Declaration

    Swift

    case maxCallTimeExceeded = 1208

ERROR REASON (1301 ~ 1400)

  • [Both][Caller, Callee, Participant, CloudServer] Network is unavailable to keep a call.

    Declaration

    Swift

    case networkUnstable = 1301
  • [1:1][CloudServer] LINE Planet GW failed to call Notify or notify_cb returned a failure. Please check AppServer or Notify url.

    Declaration

    Swift

    case pushError = 1302
  • [Both][CloudServer] Authentication failure

    Declaration

    Swift

    case authError = 1303
  • [Both][CloudServer] The call was already released. Example: Initiator already canceled.

    Declaration

    Swift

    case releasedCall = 1304
  • [Both][CloudServer] Server disconnected a call because of internal error.

    Declaration

    Swift

    case serverInternalError = 1305
  • [Both][Caller, Callee, Participant] Disconnected due to the network being unavailable for a certain period of time.

    Declaration

    Swift

    case unavailableNetwork = 1308
  • [Both][Caller, Callee, Participant] Application process is terminated.

    Declaration

    Swift

    case appDestroy = 1309
  • [Both][Caller, Callee, Participant] Application is in sleep mode.

    Declaration

    Swift

    case systemSleep = 1310
  • [Both][Caller, Callee, Participant] Application is in logoff mode.

    Declaration

    Swift

    case systemLogOff = 1311
  • [Both][Caller, Callee, Participant] The call is not connected because the MTU is exceeded.

    Declaration

    Swift

    case mtuExceeded = 1312
  • [Both][CloudServer] Planet Cloud Server failed to deliver app server data to AppServer

    Declaration

    Swift

    case appServerDataError = 1313
  • [Both][Caller, Callee, Participant] Desktop screen is locked

    Declaration

    Swift

    case desktopScreenLocked = 1314

ERROR REASON GroupCall Only (1401 ~ 1500)

  • [Group][CloudServer] The number of participants in this room is full.

    Declaration

    Swift

    case roomIsFull = 1401
  • [Group][CloudServer] Server kicks out a user when the user stays in a conference room alone for a long time.

    Declaration

    Swift

    case aloneKickOut = 1402
  • [Group][CloudServer] The room is destroyed because all remaining participants left before the other participant’s PlanetKitManager.joinConference(param:settings:) is complete.

    Declaration

    Swift

    case roomNotFound = 1404
  • [Group][Participant] Disconnected by trying to join from another instance.

    Declaration

    Swift

    case anotherInstanceTryToJoin = 1405

ERROR REASON about Http (1501 ~ 1600)

UNDEFINED REASON

  • Declaration

    Swift

    case unknown = -1

CustomStringConvertible

  • Declaration

    Swift

    public var description: String { get }