View on GitHub
Classes Reference
Classes
The following classes are available globally.
-
The audio device used by PlanetKit.
See moreDeclaration
Swift
public class PlanetKitAudioDevice : NSObject -
A class that manages audio processing.
See moreDeclaration
Swift
public class PlanetKitAudioManager : NSObject -
The
See morePlanetKitAudioMicclass provides the microphone audio processing unit.Declaration
Swift
public class PlanetKitAudioMic : NSObjectextension PlanetKitAudioMic: PlanetKitAudioMicControllableextension PlanetKitAudioMic: PlanetAudioUnitTargetDelegate -
The
See morePlanetKitAudioMicSpkclass is a class that manages the microphone and speaker audio processing unit.Declaration
Swift
public class PlanetKitAudioMicSpk : NSObjectextension PlanetKitAudioMicSpk: PlanetKitAudioMicControllable, PlanetKitAudioSpkControllableextension PlanetKitAudioMicSpk: PlanetAudioPlayerDelegateextension PlanetKitAudioMicSpk: PlanetAudioUnitTargetDelegateextension PlanetKitAudioMicSpk: PlanetAudioUnitSourceDelegate -
The
See morePlanetKitAudioSpkclass provides the speaker audio processing unit.Declaration
Swift
public class PlanetKitAudioSpk : NSObjectextension PlanetKitAudioSpk: PlanetKitAudioSpkControllableextension PlanetKitAudioSpk: PlanetAudioPlayerDelegateextension PlanetKitAudioSpk: PlanetAudioUnitSourceDelegate -
Represents the statistics for the call or conference.
See moreDeclaration
Swift
public class PlanetKitStatistics : NSObject
-
A class representing the video capability.
This class provides properties to configure the video resolution, frames per second (FPS), and preferred hardware codec for the video.
See moreDeclaration
Swift
public class PlanetKitVideoCapability : NSObject -
Represents the status of a video.
See moreDeclaration
Swift
public class PlanetKitVideoStatus : NSObject -
A class that represents a video buffer.
See moreDeclaration
Swift
public class PlanetKitVideoBuffer : NSObject -
A class that represents the audio device for PlanetKit.
See moreDeclaration
-
The
See morePlanetKitCallclass represents a 1-to-1 call within the PlanetKit framework.Declaration
Swift
public class PlanetKitCall : NSObjectextension PlanetKitCall: PlanetKitDataSessionControllableextension PlanetKitCall: PlanetKitAudioVolumeDelegateextension PlanetKitCall: PlanetKitAudioDeviceChangeDelegateextension PlanetKitCall: PlanetKitCameraDeviceChangeDelegateextension PlanetKitCall : PlanetKitAudioMicCaptureDelegateextension PlanetKitCall : PlanetKitAudioSpkPlayDelegateextension PlanetKitCall : PlanetKitVideoOutputDelegateextension PlanetKitCall: PlanetKitVideoLimiterextension PlanetKitCall: PlanetKitSharedContentsControllableextension PlanetKitCall: PlanetKitStatisticsControllableextension PlanetKitCall: PlanetKitDebugMonitor -
The
See morePlanetKitConferenceclass represents a conference in the PlanetKit framework.Declaration
Swift
public class PlanetKitConference : NSObjectextension PlanetKitConference: PlanetKitDataSessionControllableextension PlanetKitConference: PlanetKitAudioVolumeDelegateextension PlanetKitConference: PlanetKitAudioDeviceChangeDelegateextension PlanetKitConference: PlanetKitCameraDeviceChangeDelegateextension PlanetKitConference : PlanetKitAudioMicCaptureDelegateextension PlanetKitConference : PlanetKitAudioSpkPlayDelegateextension PlanetKitConference: PlanetKitVideoOutputDelegateextension PlanetKitConference: PlanetKitVideoLimiterextension PlanetKitConference: PlanetKitSharedContentsControllableextension PlanetKitConference: PlanetKitStatisticsControllableextension PlanetKitConference: PlanetKitDebugMonitor -
A class that represents the audio description for the peer user’s audio information.
See moreDeclaration
Swift
public class PlanetKitPeerAudioDescription : NSObject -
A class that represents the audio description for the local user’s audio information.
See moreDeclaration
Swift
public class PlanetKitMyAudioDescription : NSObject -
A class that represents the audio session settings for PlanetKit.
See more -
A class representing a
See morePlanetKitCCParamobject.Declaration
Swift
public class PlanetKitCCParam : NSObject -
A class that represents the parameters for a connected event of a call.
See moreDeclaration
Swift
public class PlanetKitCallConnectedParam : NSObject -
A class designed to transmit a message when initiating a call.
See moreDeclaration
Swift
public class PlanetKitCallStartMessage : NSObject -
Represents the frame rate range for PlanetKit.
See moreDeclaration
Swift
@objc public class PlanetKitFrameRate : NSObject -
A class that manages the camera device.
See moreDeclaration
Swift
public class PlanetKitCameraManager : NSObjectextension PlanetKitCameraManager: PlanetKitVideoOutputDelegate -
A class representing the hold status of a PlanetKit conference.
See moreDeclaration
Swift
public class PlanetKitHoldStatus : NSObject -
A class representing the parameters provided in the connected event for a conference.
See moreDeclaration
Swift
public class PlanetKitConferenceConnectedParam : NSObject -
A class representing the parameters provided in the event for updating the peer list during a conference.
See moreDeclaration
Swift
public class PlanetKitConferencePeerListUpdateParam : NSObject -
A class representing an updated peer in the event for updating the video during a conference.
See moreDeclaration
Swift
public class PlanetKitConferenceVideoUpdatedPeer : NSObject -
A class representing the parameters provided in the event for updating the video during a conference.
See moreDeclaration
Swift
public class PlanetKitConferenceVideoUpdateParam : NSObject -
A class representing an updated subgroup names in the event for updating the peer subgroup during a conference.
See moreDeclaration
Swift
public class PlanetKitConferenceSubgroupUpdatedPeer : NSObject -
A class representing the parameters provided in the event for updating the peer subgroup during a conference.
See moreDeclaration
Swift
public class PlanetKitConferenceSubgroupUpdateParam : NSObject -
A class representing the parameters provided in the event for updating the screen share during a conference.
See moreDeclaration
Swift
public class PlanetKitConferenceScreenShareUpdateParam : NSObject -
A class that represents an exception message that occurred in a PlanetKit conference event.
See moreDeclaration
Swift
public class PlanetKitConferenceExceptionMessage : NSObject -
A class that represents a peer hold reason in a PlanetKit conference event.
See moreDeclaration
Swift
public class PlanetKitConferencePeerHold : NSObject -
A class that represents a video pause reason for a peer in a PlanetKit conference event.
See moreDeclaration
Swift
public class PlanetKitConferencePeerVideoPause : NSObject -
A class that represents shared content in a PlanetKit conference event.
See moreDeclaration
Swift
@objc public class PlanetKitConferenceSetSharedContent : NSObject -
A class representing a peer user in a PlanetKit conference.
See moreDeclaration
Swift
public class PlanetKitConferencePeer : NSObject
-
A class representing the status of screen share in PlanetKit.
See moreDeclaration
Swift
public class PlanetKitScreenShareStatus : NSObject -
Represents the volume level of a PlanetKit conference peer.
The volume level is represented by an integer value ranging from 0 to 110. The value 0 represents a muted state, and the value 100 represents the original volume. The value 110 represents a volume level that is amplified by +9dB.
See moreDeclaration
Swift
public class PlanetKitVolumeLevel : NSObject -
A class representing shared contents in PlanetKit.
See moreDeclaration
Swift
public class PlanetKitSharedContents : NSObject -
A class that represents the control for a peer in the PlanetKit conference.
See moreRemark
This class is designed to enable real-time event reception for a specificPlanetKitConferencePeer, as well as to control video, screen share, and other functionalities.Declaration
Swift
public class PlanetKitPeerControl : NSObject
-
A class representing an outbound data session in the PlanetKit framework.
See moreDeclaration
Swift
public class PlanetKitOutboundDataSession : NSObject -
A class representing an inbound data session in the PlanetKit framework.
See moreDeclaration
Swift
public class PlanetKitInboundDataSession : NSObject -
Declaration
Swift
public class PlanetKitDeviceHandler : NSObject -
A parameter class that represents the disconnection event in PlanetKit.
See moreDeclaration
Swift
public class PlanetKitDisconnectedParam : NSObject -
A parameter class for notifying the record on cloud in PlanetKit.
See moreDeclaration
Swift
public class PlanetKitRecordOnCloudUpdatedParam : NSObject -
Declaration
Swift
@objc public class PlanetKitHookedAudio : NSObject -
A class representing the resolution of a PlanetKitMTKView.
See moreDeclaration
Swift
public class PlanetKitMTKViewResolution : NSObject -
A custom MetalKit view for rendering PlanetKit scenes.
This view subclass provides additional functionality for rendering PlanetKit scenes using Metal. It inherits from
See moreMTKViewand adds a delegate property for receiving draw events.Declaration
Swift
public class PlanetKitMTKView : MTKViewextension PlanetKitMTKView: PlanetKitVideoOutputDelegate -
PlanetKit main API
See moreDeclaration
Swift
public class PlanetKitManager : NSObject -
A class representing the parameters for making a call in PlanetKit.
See moreDeclaration
Swift
@objc public class PlanetKitCallParam : NSObject -
A class representing the parameters for a PlanetKit conference.
See moreDeclaration
Swift
@objc public class PlanetKitConferenceParam : NSObject -
A class representing the result of making a PlanetKit call.
See moreDeclaration
Swift
@objc public class PlanetKitCallMakeResult : NSObject -
A class representing the result of verifying a PlanetKit call.
See moreDeclaration
Swift
@objc public class PlanetKitCallVerifyResult : NSObject -
A class representing the result of joining a PlanetKit conference.
See moreDeclaration
Swift
@objc public class PlanetKitConferenceJoinResult : NSObject -
A class representing a video stream in PlanetKit.
See moreDeclaration
Swift
@objc public class PlanetKitVideoStream : NSObjectextension PlanetKitVideoStream: PlanetKitVideoStreamDelegate -
A class representing the local users’s media status of the PlanetKit framework.
See moreDeclaration
Swift
@objc public class PlanetKitMyMediaStatus : NSObject -
The
See morePlanetKitSendVoiceProcessorclass represents a voice processor for sending voice data.Declaration
Swift
public class PlanetKitSendVoiceProcessor : NSObject
-
A notification value representing a change in the
See morePlanetKitSendVoiceProcessor.Declaration
Swift
@objc public class PlanetKitSendVoiceProcessorChangeNotificationValue : NSObject -
A class that represents the settings for PlanetKit CallKit.
See more -
Declaration
Swift
public class PlanetKitInitialSettingBuilder : NSObject -
Declaration
Swift
public class PlanetKitMakeCallSettingBuilder : NSObject -
Declaration
Swift
public class PlanetKitVerifyCallSettingBuilder : NSObject -
Declaration
Swift
public class PlanetKitJoinConferenceSettingBuilder : NSObject -
A class representing a PlanetKit user ID.
See moreDeclaration
Swift
public class PlanetKitUserId : NSObject -
PlanetKitVirtualBackgroundenables the detection and segmentation of human subjects from the background in thePlanetKitCameravideo feeds.See moreRemark
Please note that this feature is compatible with iPhone 12 and newer models, as well as MacBook devices equipped with the Apple Silicon processor.Declaration
Swift
public class PlanetKitVirtualBackground : NSObject -
A class representing the screen in the PlanetKit framework.
See moreDeclaration
Swift
public class PlanetKitScreen : NSObjectextension PlanetKitScreen: PlanetKitScreenControllable -
Declaration
Swift
public class PlanetKitScreenCaptureDevice : NSObject -
A class representing the result of a screen capture operation in PlanetKit.
See moreDeclaration
Swift
@objc public class PlanetKitScreenCapturableResult : NSObject -
A class representing a screen capture display in the PlanetKit framework.
See moreDeclaration
Swift
public class PlanetKitScreenCaptureDisplay : NSObject
-
A window used for screen capture in the PlanetKit framework.
See moreDeclaration
Swift
public class PlanetKitScreenCaptureWindow : NSObject
-
Declaration
Swift
public class PlanetKitScreenCaptureWindowFilter : NSObject, PlanetKitScreenCaptureWindowFilterControllable -
A class representing a subgroup in the conference.
See moreDeclaration
Swift
public class PlanetKitSubgroup : NSObjectextension PlanetKitSubgroup: PlanetKitDataSessionControllable -
A class representing the attributes of a subgroup in the conference.
See moreDeclaration
Swift
public class PlanetKitSubgroupAttribute : NSObject -
A class representing the state of a subgroup in the conference.
See moreDeclaration
Swift
public class PlanetKitSubgroupState : NSObject -
The manager class for PlanetKit subgroups.
See moreDeclaration
Swift
public class PlanetKitSubgroupManager : NSObject -
The
See morePlanetKitSystemclass represents the system information for the PlanetKit framework.Declaration
Swift
public class PlanetKitSystem : NSObject -
A class that provides custom camera functionalities for the PlanetKit framework.
See moreDeclaration
Swift
@objc open class PlanetKitCustomCamera : NSObject -
Declaration
Swift
public class PlanetKitVideoCaptureDeviceInfo : NSObject