API changelog

This page provides the list of API changes in PlanetKit 6.0 for iOS/macOS.

PlanetKit 6.0

Changed

• PlanetKitCameraDelegate protocol 1-to-1 callGroup call

  Previous	PlanetKit 6.0
  func didStart()	func didStart(_ deviceInfo: PlanetKitVideoCaptureDeviceInfo)
  func didStop(_ error: NSError?)	func didStop(_ deviceInfo: PlanetKitVideoCaptureDeviceInfo)

• PlanetKitVideoCapability class 1-to-1 callGroup call

  Previous	PlanetKit 6.0
  var resolution: PlanetKitVideoResolutionCapability { get set }	var maxResolution: PlanetKitVideoResolutionCapability { get }
  var fps: PlanetKitVideoFps { get set }	var maxFps: PlanetKitVideoFps { get }
  init(resolution: PlanetKitVideoResolutionCapability, fps: PlanetKitVideoFps)	init(maxResolution: PlanetKitVideoResolutionCapability, maxFps: PlanetKitVideoFps)

• PlanetKitCallConnectedParam class 1-to-1 call

  Previous	PlanetKit 6.0
  var isVideoHwCodecEnabled: Bool	var isVideoHardwareCodecEnabled: Bool

• PlanetKitConferenceConnectedParam class Group call

  Previous	PlanetKit 6.0
  var isVideoHwCodecEnabled: Bool	var isVideoHardwareCodecEnabled: Bool

• PlanetKitConferencePeer class Group call

  Previous	PlanetKit 6.0
  func volumeLevelSetting(subgroupName: String?) throws -> PlanetKitVolumeLevel	func volumeLevelSetting() throws -> PlanetKitVolumeLevel

• Refactored audio management system 1-to-1 callGroup call

  • Core audio session functionality moved to PlanetKitAudioSession
  • High-level audio control features provided by PlanetKitAudioManager

• PlanetKitAudioDeviceType enum 1-to-1 callGroup call

  Previous	PlanetKit 6.0
  case spk	case speaker

• PlanetKitCameraManager class 1-to-1 callGroup call

  Previous	PlanetKit 6.0
  func resetToDefaultCamera()	func resetCustomCameraToDefaultCamera()
  func change(deviceInfo: PlanetKitVideoCaptureDeviceInfo)	func change(deviceInfo: PlanetKitVideoCaptureDeviceInfo) throws

• PlanetKitCallDelegate protocol 1-to-1 call

  Previous	PlanetKit 6.0.0
  func videoEnabledByPeer(_ call: PlanetKitCall)	func videoEnabledByPeerAndMyVideoPaused(_ call: PlanetKitCall)

• PlanetKitMakeCallSettingBuilder class 1-to-1 call

  Previous	PlanetKit 6.0
  func build() -> [String: Any]	func build() throws -> [String: Any] (iOS only)

• PlanetKitVerifyCallSettingBuilder class 1-to-1 call

  Previous	PlanetKit 6.0
  func build() -> [String: Any]	func build() throws -> [String: Any] (iOS only)

• PlanetKitJoinConferenceSettingBuilder class Group call

  Previous	PlanetKit 6.0
  func build() -> [String: Any]	func build() throws -> [String: Any] (iOS only)

Added

• PlanetKitCameraDelegate protocol 1-to-1 callGroup call
  • func didUpdate(_ deviceInfo: PlanetKitVideoCaptureDeviceInfo?)
  • func didFail(_ error: NSError, deviceInfo: PlanetKitVideoCaptureDeviceInfo?)
• PlanetKitVideoResolutionCapability enum 1-to-1 callGroup call
  • case qvga - Maximum resolution of 320x240
  • case vga - Maximum resolution of 640x480
  • case hd - Maximum resolution of 1280x960
  • case fhd - Maximum resolution of 1920x1080
• PlanetKitVideoCapabilityUsage enum 1-to-1 callGroup call
  • case callSend
  • case callReceive
  • case conferenceSend
  • case conferenceReceive
• PlanetKitPreferredHardwareCodec class 1-to-1 callGroup call
  • var callVideoSend: Bool { get }
  • var callVideoReceive: Bool { get }
  • var conferenceVideoSend: Bool { get }
  • var conferenceVideoReceive: Bool { get }
  • init(callVideoSend: Bool, callVideoReceive: Bool, conferenceVideoSend: Bool, conferenceVideoReceive: Bool)
• PlanetKitManager class 1-to-1 callGroup call
  • func getDeviceDefaultVideoCapability(usage: PlanetKitVideoCapabilityUsage) -> PlanetKitVideoCapability
  • func getVideoPreferredHardwareCodec() -> PlanetKitPreferredHardwareCodec
• PlanetKitInitialSettingBuilder class 1-to-1 callGroup call
  • func withSetPreferredHardwareCodecKey(preferredHardwareCodec: PlanetKitPreferredHardwareCodec) -> PlanetKitInitialSettingBuilder
• PlanetKitConferencePeerControl class Group call
  • func setVolumeLevelSetting(_ volumeLevel: Int8, completion: @escaping (Bool)->Void)
• PlanetKitAudioManager class 1-to-1 callGroup call
  • static var shared: PlanetKitAudioManager { get }
  • var session: PlanetKitAudioSession { get }
  • func startMicPreview(_ preview: PlanetKitAudioMicPreviewDelegate, volumeInternal: TimeInterval = 1.0) -> Bool
  • func stopMicPreview()
  • func playFile(fileResourceUrl: URL, type: String, loopCount: Int32 = -1)
  • func playFile(fileResourceUrl: URL, type: String, loopCount: Int32, completion: @escaping (Bool) -> Void)
  • func playStop(type: String)
  • func setCustomMic(_ customMic: PlanetKitCustomMic)
  • func resetCustomMicToDefaultMic()
  • func setCustomSpeaker(_ customSpeaker: PlanetKitCustomSpeaker)
  • func resetCustomSpeakerToDefaultSpeaker()
  • func addVolumeDelegate(_ delegate: PlanetKitAudioVolumeDelegate, for type: PlanetKitAudioDeviceType)
  • func removeVolumeDelegate(_ delegate: PlanetKitAudioVolumeDelegate, for type: PlanetKitAudioDeviceType)
  • var vpioEnabled: Bool { get set }
  • var defaultMicSampleRate: Float64 { get set }
  • var defaultSpeakerSampleRate: Float64 { get set }
  • var openSettings: PlanetKitAudioSessionSettings? { get set }
  • var closeSettings: PlanetKitAudioSessionSettings? { get set }
  • var defaultIOBufferDuration: Float64 { get set }
  • var micVolume: Float { get }
  • var speakerVolume: Float { get }
  • func setMicVolume(_ volume: Float)
  • func addAudioRouteChangeDelegate(_ delegate: PlanetKitAudioRouteChangeDelegate)
  • func removeAudioRouteChangeDelegate(_ delegate: PlanetKitAudioRouteChangeDelegate)
  • var isBluetoothInput: Bool { get }
  • var isBuiltInOutput: Bool { get }
  • var devices: [PlanetKitAudioDevice] { get }
  • func addDeviceChangeDelegate(_ delegate: PlanetKitAudioDeviceChangeDelegate)
  • func removeDeviceChangeDelegate(_ delegate: PlanetKitAudioDeviceChangeDelegate)
• PlanetKitAudioSession class 1-to-1 callGroup call
  • var micEnabled: Bool { get }
  • var speakerEnabled: Bool { get }
  • var isStarted: Bool { get }
  • func addMicReceiver(_ micReceiver: PlanetKitAudioMicCaptureDelegate)
  • func removeMicReceiver(_ micReceiver: PlanetKitAudioMicCaptureDelegate)
  • var micModifier: PlanetKitAudioMicCaptureDelegate? { get set }
  • func addSpeakerReceiver(_ speakerReceiver: PlanetKitAudioSpkPlayDelegate)
  • func removeSpeakerReceiver(_ speakerReceiver: PlanetKitAudioSpkPlayDelegate)
  • var speakerModifier: PlanetKitAudioSpkPlayDelegate? { get set }
  • var speakerVolumeReceiver: PlanetKitAudioDeviceVolumeDelegate? { get set }
  • var speakerVolumeInterval: TimeInterval { get set }
  • func speakerOut(_ out: Bool)
  • var isSpeakerOut: Bool
  • var micDevice: PlanetKitAudioDevice? { get }
  • var speakerDevice: PlanetKitAudioDevice? { get }
  • var micVolume: Float { get }
  • var speakerVolume: Float { get }
  • func setVolume(_ volume: Float, for type: PlanetKitAudioDeviceType)
  • func change(micDevice: PlanetKitAudioDevice?, completion: @escaping (NSError?)->Void)
  • func change(speakerDevice: PlanetKitAudioDevice?, completion: @escaping (NSError?)->Void)
  • func setPreferredDefaultDevice(type: PlanetKitAudioDeviceType) throws
• PlanetKitCustomMic class 1-to-1 callGroup call
  • func sendAudio(audioBuffer: PlanetKitAudioBuffer)
• PlanetKitCustomSpeaker class 1-to-1 callGroup call
  • func playAudio(audioBuffer: PlanetKitAudioBuffer) -> Int32
• PlanetKitAudioBuffer class 1-to-1 callGroup call
• PlanetKitAudioMicPreviewDelegate protocol 1-to-1 callGroup call
  • func volumeDidUpdate(micVolume: Float)
• PlanetKitCCParam class 1-to-1 call
  • var isRecordOnCloudEnabled: Bool
• PlanetKitSettingError enum 1-to-1 callGroup call

Removed

• PlanetKitAudioMic class 1-to-1 callGroup call
• PlanetKitAudioSpk class 1-to-1 callGroup call
• PlanetKitAudioMicSpk class 1-to-1 callGroup call
• PlanetKitAudioMicControllable protocol 1-to-1 callGroup call
• PlanetKitAudioSpkControllable protocol 1-to-1 callGroup call
• PlanetKitCall class 1-to-1 call
  • var myVideoSendCapability: PlanetKitVideoCapability { get }
  • var myVideoReceiveCapability: PlanetKitVideoCapability { get }
  • var audioManager: PlanetKitAudioManager { get }
  • weak var spkModifier: PlanetKitAudioSpkPlayDelegate? { get set }
  • weak var spkReceiver: PlanetKitAudioSpkPlayDelegate? { get set }
  • weak var micModifier: PlanetKitAudioMicCaptureDelegate? { get set }
  • weak var micReceiver: PlanetKitAudioMicCaptureDelegate? { get set }
• PlanetKitConference class Group call
  • var myVideoSendCapability: PlanetKitVideoCapability { get }
  • var myVideoRecvPreferredHwCodec: Bool { get }
  • var audioManager: PlanetKitAudioManager { get }
  • weak var spkModifier: PlanetKitAudioSpkPlayDelegate? { get set }
  • weak var spkReceiver: PlanetKitAudioSpkPlayDelegate? { get set }
  • weak var micModifier: PlanetKitAudioMicCaptureDelegate? { get set }
  • weak var micReceiver: PlanetKitAudioMicCaptureDelegate? { get set }
• PlanetKitVideoCapability class 1-to-1 callGroup call
  • var preferredHwCodec: Bool
  • static var callSendDefault: PlanetKitVideoCapability
  • static var callReceiveDefault: PlanetKitVideoCapability
  • static var conferenceSendDefault: PlanetKitVideoCapability
• PlanetKitJoinConferenceSettingBuilder class Group call
  • func withMyVideoRecvPreferredHwCodecKey(enable: Bool) -> PlanetKitJoinConferenceSettingBuilder
• PlanetKitSubgroupManager class Group call
  • func setPeerVolumeLevelSetting(_ volumeLevel: Int8, peerId: PlanetKitUserId, subgroupName: String?, allSubgroupsPeerSubscribed: Bool, completion: @escaping (Bool)->Void)
• PlanetKitMakeCallSettingBuilder class 1-to-1 call
  • func withCustomMicKey(mic: PlanetKitAudioMicControllable) -> PlanetKitMakeCallSettingBuilder
  • func withCustomSpkKey(spk: PlanetKitAudioSpkControllable) -> PlanetKitMakeCallSettingBuilder
• PlanetKitVerifyCallSettingBuilder class 1-to-1 call
  • func withCustomMicKey(mic: PlanetKitAudioMicControllable) -> PlanetKitVerifyCallSettingBuilder
  • func withCustomSpkKey(spk: PlanetKitAudioSpkControllable) -> PlanetKitVerifyCallSettingBuilder
• PlanetKitJoinConferenceSettingBuilder class Group call
  • func withCustomMicKey(mic: PlanetKitAudioMicControllable) -> PlanetKitJoinConferenceSettingBuilder
  • func withCustomSpkKey(spk: PlanetKitAudioSpkControllable) -> PlanetKitJoinConferenceSettingBuilder
• PlanetKitResponseOnEnableVideo enum 1-to-1 call
• PlanetKitCall class 1-to-1 call
  • var responseOnEnableVideo: PlanetKitResponseOnEnableVideo { get }
• PlanetKitMakeCallSettingBuilder class 1-to-1 call
  • func withResponseOnEnableVideo(response: PlanetKitResponseOnEnableVideo)
• PlanetKitVerifyCallSettingBuilder class 1-to-1 call
  • func withResponseOnEnableVideo(response: PlanetKitResponseOnEnableVideo)