View on GitHub
PlanetKitSendVoiceProcessor Class Reference
PlanetKitSendVoiceProcessor
public class PlanetKitSendVoiceProcessor : NSObjectThe PlanetKitSendVoiceProcessor class represents a voice processor for sending voice data.
-
Indicates whether the send voice processor is enabled.
Declaration
Swift
@objc public var isEnabled: Bool { get } -
Gets the current Acoustic Echo Canceller mode.
The default value is
PlanetKitAcousticEchoCancellerMode.intensityRecommended.Declaration
Swift
@objc public var acousticEchoCancellerMode: PlanetKitAcousticEchoCancellerMode { get } -
Gets the current Noise Suppressor mode.
The default value is
PlanetKitNoiseSuppressorMode.enabled.Declaration
Swift
@objc public var noiseSuppressorMode: PlanetKitNoiseSuppressorMode { get } -
Gets the current Auto Gain Control mode.
The default value is
PlanetKitAutoGainControlMode.software.Declaration
Swift
@objc public var autoGainControlMode: PlanetKitAutoGainControlMode { get } -
Enables the send voice processor.
Declaration
Swift
@objc public func enable(completion: @escaping (Bool) -> Void)Parameters
completionA closure that is called when the operation is completed.
-
Disables the send voice processor.
Declaration
Swift
@objc public func disable(completion: @escaping (Bool) -> Void)Parameters
completionA closure that is called when the operation is completed.
-
Sets the Acoustic Echo Canceller mode.
Declaration
Swift
@objc public func setAcousticEchoCanceller(mode: PlanetKitAcousticEchoCancellerMode, completion: @escaping (Bool) -> Void)Parameters
modeThe Acoustic Echo Canceller mode to set.
completionA closure that is called when the operation is completed.
-
Sets the Noise Suppressor mode.
Declaration
Swift
@objc public func setNoiseSuppressor(mode: PlanetKitNoiseSuppressorMode, completion: @escaping (Bool) -> Void)Parameters
modeThe Noise Suppressor mode to set.
completionA closure that is called when the operation is completed.
-
Sets the Auto Gain Control mode.
Declaration
Swift
@objc public func setAutoGainControl(mode: PlanetKitAutoGainControlMode, completion: @escaping (Bool) -> Void)Parameters
modeThe Auto Gain Control mode to set.
completionA closure that is called when the operation is completed.
-
The notification name for the
PlanetKitSendVoiceProcessorchange event.Declaration
Swift
@objc public static let didChangeNotification: NSNotification.Name -
Retrieves the value associated with the change notification.
Declaration
Swift
@objc public static func queryChangeNotificationValue(from: Foundation.Notification) -> PlanetKitSendVoiceProcessorChangeNotificationValue?Parameters
fromThe
Foundation.Notificationobject containing the change notification.Return Value
The
PlanetKitSendVoiceProcessorChangeNotificationValueif available, otherwisenil.