SkyWayNoiseCanceller

public final class SkyWayNoiseCanceller

ノイズ抑制クラス

  • イニシャライザは利用できません。

    shared変数を利用してインスタンスを取得してください。

    Declaration

    Swift

    public static let shared: SkyWayNoiseCanceller
  • ノイズ抑制の初期化オプション

    See more

    Declaration

    Swift

    public struct Options
  • ノイズ抑制が初期化されているかどうか

    Declaration

    Swift

    public var isSetup: Bool
  • ノイズ抑制が処理中かどうか

    Declaration

    Swift

    public var isProcessing: Bool
  • 致命的なエラーが発生した際のハンドラ

    SkyWay の内部で致命的なエラーが発生すると、SkyWayNoiseCanceller は自動的に stop() および dispose() を実行したあと、このハンドラが呼び出されます。

    引数で渡される ErrorCode に応じて、以下の対応を行ってください。

    • ErrorCode.quotaExceeded: 利用量の上限を超えています。ご利用中のプランの変更をご検討ください。
    • その他のエラー: 再度 setup(options:) を呼び出すことで復旧できる可能性があります。

    Declaration

    Swift

    public var fatalErrorHandler: ((ErrorCode) -> Void)?
  • setup(options:) Asynchronous

    ノイズ抑制の初期化を行います。

    Declaration

    Swift

    public func setup(options: Options = Options()) async -> Bool

    Parameters

    options

    初期化オプション

    Return Value

    初期化に成功したかどうか

  • ノイズ抑制を開始します。

    Declaration

    Swift

    public func start() -> Bool

    Return Value

    開始に成功したかどうか

  • ノイズ抑制を停止します。

    Declaration

    Swift

    public func stop() -> Bool

    Return Value

    停止に成功したかどうか

  • ノイズ抑制の強度を変更します。

    Declaration

    Swift

    public func changeStrength(_ strength: Int) -> Bool

    Parameters

    strength

    強度(1〜100)

    Return Value

    変更に成功したかどうか

  • ノイズ抑制を終了し、内部リソースを解放します。

    dispose() を呼んだ後、再度使用するには setup() が必要です。

    Declaration

    Swift

    public func dispose()