AI Noise Canceller

Class: SkyWayNoiseCanceller

ノイズ抑制処理を行うためのクラス。

constructor(context, options)

• context (required)

  • SkyWayContext 型
  • SkyWay SDK で使用する context と同様のものを渡す

• options

  • SkyWayNCOptions 型
    • modelType (default: "small")
      • ModelType 型: "small" | "medium" | "large"
      • 利用する処理モデルの種類を選択できる
    • strength (default: 90)
      • number 型: 1 から 100 の整数
      • 処理開始時点のノイズ抑制強度を設定できる

Method

init()

インスタンスを初期化するためのメソッド。
初期化が完了したら onReady で登録されたコールバック関数が動作する。

init を使用するまえに onReady や onFatalError でコールバック関数が登録されていることが望ましい。

• 返り値: void

connect(src)

処理を行う Audio Stream を渡し、ノイズ抑制処理後の Audio Stream を返り値として受け取るためのメソッド。

• src (required)
  • LocalAudioStream 型
• 返り値: Promise<LocalAudioStream>

changeStrength(strength)

ノイズ抑制強度を変更するためのメソッド。

• strength (required)
  • number 型: 1 から 100 の整数
• 返り値: void

dispose()

インスタンスを破棄するためのメソッド。

• 返り値: void

onReady(callback)

init が完了したら実行されるコールバック関数を登録できるためのメソッド。
2 回目以降は前回登録したコールバック関数を上書きする動作となる。

※ コールバック関数内でエラーが発生した場合はライブラリでハンドリングされないため、throw されたエラーを try-catch でハンドリングするようにしてください。

• callback (required)
  • () => void 型
• 返り値: void

onFatalError(callback)

ライブラリ内部で致命的なエラーが発生したら実行されるコールバック関数を登録できるメソッド。
2 回目以降は前回登録したコールバック関数に対して上書きする動作となる。

• callback (required)
  • (CustomEvent<SkyWayNCError>) => void 型
• 返り値: void

static Method

isSupported()

利用しているブラウザとデバイスがサポート対象かどうか判定できるメソッド。

• 返り値: boolean 型

Class: SkyWayNCError

エラー発生時に返り値もしくは onFatalError で通知されるエラークラス。

Property

type

エラーの種類を判別するためのプロパティ。

• ErrorType 型: "SetupError" | "ProcessError" | "SettingChangeError"
  • SetupError
    • ノイズ抑制処理が開始される前に発生するエラーのタイプ
  • ProcessError
    • ノイズ抑制処理の実行中に発生するエラーのタイプ
  • SettingChangeError
    • ノイズ抑制処理の設定変更の際に発生するエラーのタイプ

Type

SkyWayNCOptions

• modelType
  • ModelType 型: "small" | "medium" | "large"
• strength
  • number 型: 1 から 100 の整数

ModelType

• "small" | "medium" | "large"

ErrorType

• "SetupError" | "ProcessError" | "SettingChangeError"