Enumerations

The following enumerations are available globally.

  • An enumeration representing the source of disconnection in PlanetKit.

    See more

    Declaration

    Swift

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

CustomStringConvertible

  • Describes the disconnect reasons.

    Remark

    See more details at https://docs.lineplanet.me/help/troubleshooting/troubleshooting-disconnect-reason/.
    See more

    Declaration

    Swift

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

  • An enumeration representing the state of a video in the PlanetKit call or conference.

    See more

    Declaration

    Swift

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

  • An enumeration representing the state of screen share in the PlanetKit framework.

    See more

    Declaration

    Swift

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

  • An enumeration representing different types of exceptions that can occur in a PlanetKit conference event.

    See more

    Declaration

    Swift

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

  • An enumeration representing the reasons for deactivating a record on the cloud in PlanetKit.

    See more

    Declaration

    Swift

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

  • An enumeration representing the initial state of a video in PlanetKit.

    See more

    Declaration

    Swift

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

  • An enumeration representing the rotation of video frames.

    See more

    Declaration

    Swift

    @objc
@frozen
public enum PlanetKitVideoRotation : Int32
    extension PlanetKitVideoRotation: CustomStringConvertible

  • An enumeration representing the source of a video frame.

    See more

    Declaration

    Swift

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

  • An enumeration representing the reasons for pausing a video.

    See more

    Declaration

    Swift

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

  • An enumeration representing the video resolutions.

    See more

    Declaration

    Swift

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

  • An enumeration representing the frames per second (FPS) options for the video.

    See more

    Declaration

    Swift

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

  • An enumeration representing the sample types used in PlanetKit audio.

    See more

    Declaration

    Swift

    @objc
@frozen
public enum PlanetKitAudioSampleType : Int

  • An enumeration representing the audio route options in PlanetKit.

    See more

    Declaration

    Swift

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

  • An enumeration representing the types of audio devices.

    See more

    Declaration

    Swift

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

  • An enumeration that represents the reasons for disabling media in PlanetKit.

    See more

    Declaration

    Swift

    @objc
@frozen
public enum PlanetKitMediaDisableReason : Int

  • Represents the state of a PlanetKit call.

    See more

    Declaration

    Swift

    @objc
@frozen
public enum PlanetKitCallState : Int

  • An enumeration representing the direction of a PlanetKit call.

    See more

    Declaration

    Swift

    @objc
@frozen
public enum PlanetKitCallDirection : Int

  • The response options for enabling video in PlanetKit.

    See more

    Declaration

    Swift

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

  • Represents the position of the camera in the PlanetKit framework.

    See more

    Declaration

    Swift

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

  • The state of a PlanetKit conference.

    See more

    Declaration

    Swift

    @objc
@frozen
public enum PlanetKitConferenceState : Int

  • Represents the type of user equipment in the PlanetKit conference.

    See more

    Declaration

    Swift

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

Subgroup Status

  • An enumeration representing the error codes for PlanetKit.

    See more

    Declaration

    Swift

    @objc
@frozen
public enum PlanetKitNSErrorCode : Int

  • Supported data session types.

    Remark

    The maximum chunk size for each data stream type is 128 KBytes for .reliableMsg, .reliableBytes and 4 MBytes for .unreliableBytes, .unreliableMsg.
    See more

    Declaration

    Swift

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

CustomStringConvertible

  • An enumeration representing the possible failure reasons for a data session in PlanetKit.

    See more

    Declaration

    Swift

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

  • An enumeration representing the possible reasons for closing a data session in PlanetKit.

    See more

    Declaration

    Swift

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

  • An enumeration representing the UI orientation on macOS and tvOS.

    See more

    Declaration

    Swift

    @objc
@frozen
public enum PlanetKitUIOrientation : Int

  • The log level for PlanetKit logging.

    See more

    Declaration

    Swift

    @objc
@frozen
public enum PlanetKitLogLevel : Int32
    extension PlanetKitLogLevel: CustomStringConvertible

  • An enumeration that represents the content mode for a PlanetKitUIView.

    See more

    Declaration

    Swift

    @objc
@frozen
public enum PlanetKitUIViewContentMode : Int

  • An enumeration that represents the rendering policy for PlanetKit.

    See more

    Declaration

    Swift

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

  • Types representing the mirrored state of the video. This controls the horizontal flip functionality of the video.

    See more

    Declaration

    Swift

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

  • Represents the video hardware status for PlanetKit.

    See more

    Declaration

    Swift

    @objc
@frozen
public enum PlanetKitVideoHardwareStatus : Int

  • Represents the media type used in PlanetKit.

    See more

    Declaration

    Swift

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

  • A type that represents the size limit for PlanetKit logs.

    See more

    Declaration

    Swift

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

ConferenceParam

  • Describes reasons when a call or conference start fails.

    See more

    Declaration

    Swift

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

  • An enumeration that represents the mode of the PlanetKit acoustic echo canceller.

    See more

    Declaration

    Swift

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

CustomStringConvertible

  • An enumeration representing the mode of the noise suppressor in PlanetKit.

    See more

    Declaration

    Swift

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

  • An enumeration representing the auto gain control mode for the PlanetKit voice processor.

    See more

    Declaration

    Swift

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

Notification

  • An enumeration that represents the origin of a change in the PlanetKitSendVoiceProcessor. This enumeration is used to indicate whether the change originated from the user or the vpio.

    See more

    Declaration

    Swift

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

  • An enumeration representing the target properties for the PlanetKit send voice processor.

    See more

    Declaration

    Swift

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

  • CallKit implementation types

    Remark

    PlanetKitCall instance’s default PlanetKitCallKitType value is PlanetKitCallKitType.none. When using PlanetKit internal CallKit or application implemented CallKit, please set AVAudioSession.Category to playAndRecord before calling PlanetKitManager.makeCall() or PlanetKitManager.verifyCall() to avoid AVAudioSession malfunction that occurs in older iOS devices.
    See more

    Declaration

    Swift

    @objc
@frozen
public enum PlanetKitCallKitType : Int

  • An enumeration representing the types of virtual backgrounds in PlanetKit.

    See more

    Declaration

    Swift

    @objc
@frozen
public enum PlanetKitVirtualBackgroundType : Int

  • An enumeration representing the type of peer update for a subgroup.

    See more

    Declaration

    Swift

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

CustomStringConvertible

  • An enumeration representing the possible reasons for a failure when subscribing to a subgroup.

    See more

    Declaration

    Swift

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

  • An enumeration representing the reasons for a failed unsubscribe operation in the subgroup.

    See more

    Declaration

    Swift

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