PlanetKitStartFailReason

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

Describes reasons when a call or conference start fails.

COMMON REASON (0 ~ 999)

  • Success

    Declaration

    Swift

    case none = 0

  • Some mandatory parameters are not provided.

    Declaration

    Swift

    case invalidParam = 1

  • There already exists an unfinished call or conference with the same identifier.

    • For calls, a set of my id, service-id, peer id and service-id is an identifier.
    • For conferences, a set of my id, service-id, room-id and room-service-id is an identifier.

    Declaration

    Swift

    case alreadyExist = 2

  • Failed to decode the argument of the verifyCall(myUserId:ccParam:delegate:) API.

    Declaration

    Swift

    case decodeCallParam = 3

  • Failed to allocate memory for a call or conference.

    Declaration

    Swift

    case memoryError = 4

  • The user ID of the callee or room ID must not be the same as the user ID.

    Declaration

    Swift

    case idConflict = 5

  • Cannot re-use an instance for a new call or conference that has already been used before.

    Declaration

    Swift

    case reuse = 6

  • The user ID string is not in a valid format. Added since PlanetKit 4.0.

    Remark

    See more detail on https://docs.lineplanet.me/overview/glossary#user-id

    Declaration

    Swift

    case invalidUserId = 7

  • The service ID string is not in a valid format. Added since PlanetKit 4.0.

    Remark

    See more detail on https://docs.lineplanet.me/overview/glossary#service-id

    Declaration

    Swift

    case invalidServiceId = 8

  • The API-key string is not in a valid format. Added since PlanetKit 4.0.

    Remark

    See more detail on https://docs.lineplanet.me/overview/glossary#api-key

    Declaration

    Swift

    case invalidAPIKey = 9

  • The room ID string is not in a valid format. Added since PlanetKit 4.0.

    Remark

    See more detail on https://docs.lineplanet.me/overview/glossary#room-id

    Declaration

    Swift

    case invalidRoomId = 10

  • The App server data is too long. (Maximum size of app server data is 4096 bytes including null termination)

    Declaration

    Swift

    case tooLongAppServerData = 11

  • PlanetKit is not initialized.

    Declaration

    Swift

    case notInitialized = 12

iOS/macOS REASON (2000 ~ 2999)

  • The media type is unknown. Please set the specific media type.

    Declaration

    Swift

    case kitUnknownMediaType = 2001

  • The room ID string is not in a valid format.

    Declaration

    Swift

    case kitInvalidRoomId = 2002

  • The peer ID (aka. user ID) string is not in a valid format.

    Declaration

    Swift

    case kitInvalidPeerId = 2003

  • The given push message is not in a valid format.

    Declaration

    Swift

    case kitInvalidPushMessage = 2004

  • No available Metal device to perform a video call or conference. The video graphic chip doesn’t support Metal Graphic API.

    Declaration

    Swift

    case kitNoMetalDevice = 2005

  • The access token or the API key is not specified.

    Declaration

    Swift

    case kitInvalidAuthentication = 2006

  • The internal error caused by PlanetKit cannot be handled by the app developer. Please ask PlanetKit developers to resolve the issue.

    Declaration

    Swift

    case kitInternalInitializationError = 2999

CustomStringConvertible

  • A textual representation of PlanetKitStartFailReason instance.

    Declaration

    Swift

    public var description: String { get }