AudioEffectsFeature interface
AudioEffects 機能の API インターフェイス
- Extends
プロパティ
| active |
現在アクティブなオーディオ効果を表す読み取り専用オブジェクト |
継承されたプロパティ
| name | 機能名。 |
メソッド
| is |
現在の環境で効果がサポートされているかどうかを確認するメソッド。 |
| off("effects |
Unsubscribe 関数 - 効果の使用中にエラーが発生した場合に発生します |
| off("effects |
サブスクライブ解除関数 - 効果が開始されたときに発生します |
| off("effects |
サブスクライブ解除関数 - 効果が停止したときに発生します |
| on("effects |
サブスクライブ関数 - 効果の使用中にエラーが発生する |
| on("effects |
サブスクライブ関数 - 効果が開始されたときに発生します |
| on("effects |
サブスクライブ関数 - 効果が停止したときに発生します |
| start |
効果の開始 |
| stop |
効果を停止する |
継承されたメソッド
| dispose() |
プロパティの詳細
activeEffects
継承されたプロパティの詳細
name
機能名。
name: stringプロパティ値
string
メソッドの詳細
isSupported("BrowserNoiseSuppression" | DeepNoiseSuppressionEffect)
現在の環境で効果がサポートされているかどうかを確認するメソッド。
function isSupported(effect: "BrowserNoiseSuppression" | DeepNoiseSuppressionEffect): Promise<boolean>パラメーター
- effect
-
"BrowserNoiseSuppression" | DeepNoiseSuppressionEffect
効果のインスタンスまたは 'Browser..' のサポートを確認する効果。
戻り値
Promise<boolean>
現在の環境で効果がサポートされている場合は true。
off("effectsError", AudioEffectsFeatureErrorListener)
Unsubscribe 関数 - 効果の使用中にエラーが発生した場合に発生します
function off(event: "effectsError", listener: AudioEffectsFeatureErrorListener)パラメーター
- event
-
"effectsError"
AudioEffectsFeatureEvent 型のイベント
- listener
- AudioEffectsFeatureErrorListener
リスナー コールバック
off("effectsStarted", AudioEffectsFeatureListener)
サブスクライブ解除関数 - 効果が開始されたときに発生します
function off(event: "effectsStarted", listener: AudioEffectsFeatureListener)パラメーター
- event
-
"effectsStarted"
AudioEffectsFeatureEvent 型のイベント
- listener
- AudioEffectsFeatureListener
リスナー コールバック
off("effectsStopped", AudioEffectsFeatureListener)
サブスクライブ解除関数 - 効果が停止したときに発生します
function off(event: "effectsStopped", listener: AudioEffectsFeatureListener)パラメーター
- event
-
"effectsStopped"
AudioEffectsFeatureEvent 型のイベント
- listener
- AudioEffectsFeatureListener
リスナー コールバック
on("effectsError", AudioEffectsFeatureErrorListener)
サブスクライブ関数 - 効果の使用中にエラーが発生する
function on(event: "effectsError", listener: AudioEffectsFeatureErrorListener)パラメーター
- event
-
"effectsError"
AudioEffectsFeatureEvent 型のイベント
- listener
- AudioEffectsFeatureErrorListener
リスナー コールバック
on("effectsStarted", AudioEffectsFeatureListener)
サブスクライブ関数 - 効果が開始されたときに発生します
function on(event: "effectsStarted", listener: AudioEffectsFeatureListener)パラメーター
- event
-
"effectsStarted"
AudioEffectsFeatureEvent 型のイベント
- listener
- AudioEffectsFeatureListener
リスナー コールバック
on("effectsStopped", AudioEffectsFeatureListener)
サブスクライブ関数 - 効果が停止したときに発生します
function on(event: "effectsStopped", listener: AudioEffectsFeatureListener)パラメーター
- event
-
"effectsStopped"
AudioEffectsFeatureEvent 型のイベント
- listener
- AudioEffectsFeatureListener
リスナー コールバック
startEffects(AudioEffectsStartConfig)
効果の開始
function startEffects(audioEffects: AudioEffectsStartConfig): Promise<void>パラメーター
- audioEffects
- AudioEffectsStartConfig
開始するオーディオ効果を表すオブジェクト
戻り値
Promise<void>
stopEffects(AudioEffectsStopConfig)
効果を停止する
function stopEffects(audioEffects: AudioEffectsStopConfig): Promise<void>パラメーター
- audioEffects
- AudioEffectsStopConfig
戻り値
Promise<void>
継承済みメソッドの詳細
dispose()
function dispose()