API changelog

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

PlanetKit 7.0

Changed

• PlanetKitAudioManager class 1-to-1 callGroup call

  Previous	PlanetKit 7.0
  func resetCustomMicToDefaultMic()	func clearCustomMic()
  func resetCustomSpeakerToDefaultSpeaker()	func clearCustomSpeaker()
  var defaultMicSampleRate: Float64 { get set }	var defaultMicSampleRate: PlanetKitAudioSampleRate { get set }
  var defaultSpeakerSampleRate: Float64 { get set }	var defaultSpeakerSampleRate: PlanetKitAudioSampleRate { get set }
  func startMicPreview(_ preview: PlanetKitAudioMicPreviewDelegate, volumeInternal: TimeInterval) -> Bool	func startMicPreview(_ preview: PlanetKitAudioMicPreviewDelegate, volumeInterval: TimeInterval) -> Bool

• PlanetKitCall class 1-to-1 call

  Previous	PlanetKit 7.0
  func sendShortData(type: String, data: Data, completion: @escaping (Bool)->Void)	func sendShortData(type: String, data: Data, completion: @escaping (PlanetKitSendShortDataFailReason)->Void)

• PlanetKitCallDelegate protocol 1-to-1 call

  Previous	PlanetKit 7.0
  func peerDidStopScreenShare(_ call: PlanetKitCall, reason: Int32)	func peerDidStopScreenShare(_ call: PlanetKitCall, reason: NSNumber?)

• PlanetKitCameraManager class 1-to-1 callGroup call

  Previous	PlanetKit 7.0
  var previewModifier: PlanetKitVideoModifierDelegate?	var modifier: PlanetKitVideoModifierDelegate?

• PlanetKitConference class Group call

  Previous	PlanetKit 7.0
  func sendShortData(peerId: PlanetKitUserId, type: String, data: Data, completion: @escaping (Bool)->Void)	func sendShortData(peerId: PlanetKitUserId, type: String, data: Data, completion: @escaping (PlanetKitSendShortDataFailReason)->Void)
  func sendShortData(type: String, data: Data, completion: @escaping (Bool)->Void)	func sendShortData(type: String, data: Data, completion: @escaping (PlanetKitSendShortDataFailReason)->Void)

• PlanetKitInitialSettingBuilder class 1-to-1 callGroup call

  Previous	PlanetKit 7.0
  func withEnableKitLogKey(level: PlanetKitLogLevel, enable: Bool, logSize: PlanetKitLogSizeLimit) -> PlanetKitInitialSettingBuilder	func withEnableLog(logOption: PlanetKitLogOption) -> PlanetKitInitialSettingBuilder
  func withSetKitBasePathKey(path: String) throws -> PlanetKitInitialSettingBuilder	func withSetPlanetKitSystemDirectory(path: String) throws -> PlanetKitInitialSettingBuilder

• PlanetKitPeerControlDelegate protocol Group call

  Previous	PlanetKit 7.0
  func didUpdateScreenShare(_ peerControl: PlanetKitPeerControl, subgroup: PlanetKitSubgroup, status: PlanetKitScreenShareStatus)	func didUpdateScreenShare(_ peerControl: PlanetKitPeerControl, subgroup: PlanetKitSubgroup, status: PlanetKitScreenShareStatus, disabledReason: NSNumber?)

• PlanetKitStatistics.PeerScreenShare class Group call

  Previous	PlanetKit 7.0
  let subGroupName: String?	let subgroupName: String?

• PlanetKitStatistics.PeerVideo class Group call

  Previous	PlanetKit 7.0
  let subGroupName: String?	let subgroupName: String?

• PlanetKitStatistics.Video class 1-to-1 callGroup call

  Previous	PlanetKit 7.0
  let witdh: UInt16	let width: UInt16

• PlanetKitVideoBuffer class 1-to-1 callGroup call

  Previous	PlanetKit 7.0
  var timestamp: CMTime	let timestamp: CMTime
  var rotation: PlanetKitVideoRotation	let rotation: PlanetKitVideoRotation
  var position: PlanetKitCameraPosition	let position: PlanetKitCameraPosition
  var sender: PlanetKitUserId?	let sender: PlanetKitUserId?
  var source: PlanetKitVideoSource	let source: PlanetKitVideoSource

Added

• PlanetKitAudioSampleRate enum 1-to-1 callGroup call

  • case sampleRate16k - 16,000 Hz
  • case sampleRate32k - 32,000 Hz
  • case sampleRate48k - 48,000 Hz
  • var floatValue: Float64

• (macOS only) PlanetKitAutoGainControlMode enum 1-to-1 callGroup call

  • case hardwareEchoTolerance

• PlanetKitCall class 1-to-1 call

  • weak var myScreenShareModifier: PlanetKitVideoModifierDelegate?

• PlanetKitConference class Group call

  • weak var myScreenShareModifier: PlanetKitVideoModifierDelegate?

• PlanetKitConferenceScreenShareUpdateParam class Group call

  • let disabledReason: NSNumber?

• PlanetKitLogOption class 1-to-1 callGroup call

  • let logDirectory: String
  • let logLevel: PlanetKitLogLevel
  • let logFileName: String?
  • static func withSizeLimitUnlimited(logDirectory: String, logFileName: String?, logLevel: PlanetKitLogLevel = .simple) -> PlanetKitLogOption?
  • static func withSizeLimit(logDirectory: String, logLevel: PlanetKitLogLevel = .simple, logSizeLimit: PlanetKitLogSizeLimit = .large) -> PlanetKitLogOption?

• PlanetKitSendShortDataFailReason enum 1-to-1 callGroup call

  • case none
  • case invalidParameter
  • case tooLongDataType
  • case tooLongData
  • case tooFrequent
  • case timeout
  • case internalError

• PlanetKitVideoModifierDelegate protocol 1-to-1 callGroup call

  • func didEncounterError(_ error: PlanetKitVideoModifierError)

• PlanetKitVideoModifierError enum 1-to-1 callGroup call

  • case videoFrameRejectedByUpscaling
  • case videoFrameRejectedByFormatChange

Removed

• (iOS only) PlanetKitAutoGainControlMode enum 1-to-1 callGroup call

  • case hardware

• PlanetKitCall class 1-to-1 call

  • let APIKey: String?
  • weak var myVideoModifier: PlanetKitVideoModifierDelegate?

• PlanetKitCallParam class 1-to-1 call

  • var APIKey: String?
  • init(myUserId: PlanetKitUserId, peerUserId: PlanetKitUserId, delegate: PlanetKitCallDelegate, APIKey: String)

• PlanetKitConference class Group call

  • let APIKey: String?
  • weak var myVideoModifier: PlanetKitVideoModifierDelegate?
  • weak var myVideoReceiver: PlanetKitVideoOutputDelegate?
  • func requestPeerVideo(id: PlanetKitUserId, maxResolution: PlanetKitVideoResolution, delegate: PlanetKitVideoOutputDelegate, subgroupName: String?, completion: @escaping (Bool)->Void)
  • func requestPeerVideo(id: PlanetKitUserId, maxResolution: PlanetKitVideoResolution, delegate: PlanetKitVideoOutputDelegate, subgroupName: String?, resolution: @escaping (Bool, PlanetKitVideoResolution, PlanetKitVideoResolution, String)->Void)
  • func stopPeerVideo(id: PlanetKitUserId, subgroupName: String?, completion: @escaping (Bool)->Void)
  • func requestPeerScreenShare(peerId: PlanetKitUserId, subgroupName: String?, completion: @escaping (Bool)->Void)
  • func stopPeerScreenShare(peerId: PlanetKitUserId, subgroupName: String?, completion: @escaping (Bool)->Void)

• PlanetKitConferenceParam class Group call

  • var APIKey: String?
  • init(myUserId: PlanetKitUserId, roomId: String, roomServiceId: String, displayName: String?, delegate: PlanetKitConferenceDelegate, APIKey: String)

• PlanetKitInitialSettingBuilder class 1-to-1 callGroup call

  • func withSetKitLogFilePathKey(filePath: String) -> PlanetKitInitialSettingBuilder

• PlanetKitLogLevel enum 1-to-1 callGroup call

  • case silent

• PlanetKitLogSizeLimit enum 1-to-1 callGroup call

  • case unlimited

• PlanetKitStartFailReason enum 1-to-1 callGroup call

  • case invalidAPIKey

• PlanetKitVideoStream class 1-to-1 callGroup call

  • weak var modifier: PlanetKitVideoModifierDelegate?