VideoEffectsFeature interface
VideoEffects 機能の API インターフェイス
- Extends
プロパティ
| active |
現在アクティブな効果の一覧 |
継承されたプロパティ
| name | 機能名。 |
メソッド
継承されたメソッド
| dispose() |
プロパティの詳細
activeEffects
継承されたプロパティの詳細
name
メソッドの詳細
isSupported(VideoEffectProcessor)
現在の環境で効果がサポートされているかどうかを確認するメソッド。
function isSupported(effect: VideoEffectProcessor): Promise<boolean>パラメーター
- effect
- VideoEffectProcessor
サポートを確認する効果のインスタンス。
戻り値
Promise<boolean>
現在の環境で効果がサポートされている場合は true。
off("effectsError", VideoEffectsFeatureErrorListener)
Unsubscribe 関数 - effectsError
function off(event: "effectsError", listener: VideoEffectsFeatureErrorListener)パラメーター
- event
-
"effectsError"
VideoEffectsFeatureEvent 型のイベント
- listener
- VideoEffectsFeatureErrorListener
リスナー コールバック
off("effectsStarted", VideoEffectsFeatureListener)
Unsubscribe 関数 - effectsStarted
function off(event: "effectsStarted", listener: VideoEffectsFeatureListener)パラメーター
- event
-
"effectsStarted"
VideoEffectsFeatureEvent 型のイベント
- listener
- VideoEffectsFeatureListener
リスナー コールバック
off("effectsStopped", VideoEffectsFeatureListener)
Unsubscribe 関数 - effectsStopped
function off(event: "effectsStopped", listener: VideoEffectsFeatureListener)パラメーター
- event
-
"effectsStopped"
VideoEffectsFeatureEvent 型のイベント
- listener
- VideoEffectsFeatureListener
リスナー コールバック
off("fpsWarningThresholdReached", VideoEffectsFeatureListener)
Unsubscribe 関数 - fpsWarningThresholdReached
function off(event: "fpsWarningThresholdReached", listener: VideoEffectsFeatureListener)パラメーター
- event
-
"fpsWarningThresholdReached"
VideoEffectsFeatureEvent 型のイベント
- listener
- VideoEffectsFeatureListener
リスナー コールバック
off("timeForEffectsWarningReached", VideoEffectsFeatureListener)
Unsubscribe 関数 - timeForEffectsWarningReached
function off(event: "timeForEffectsWarningReached", listener: VideoEffectsFeatureListener)パラメーター
- event
-
"timeForEffectsWarningReached"
VideoEffectsFeatureEvent 型のイベント
- listener
- VideoEffectsFeatureListener
リスナー コールバック
on("effectsError", VideoEffectsFeatureErrorListener)
サブスクライブ関数 - 効果の使用中にエラーが発生する
function on(event: "effectsError", listener: VideoEffectsFeatureErrorListener)パラメーター
- event
-
"effectsError"
VideoEffectsFeatureEvent 型のイベント
- listener
- VideoEffectsFeatureErrorListener
リスナー コールバック
on("effectsStarted", VideoEffectsFeatureListener)
サブスクライブ関数 - 効果が開始されたときに発生します
function on(event: "effectsStarted", listener: VideoEffectsFeatureListener)パラメーター
- event
-
"effectsStarted"
VideoEffectsFeatureEvent 型のイベント
- listener
- VideoEffectsFeatureListener
リスナー コールバック
on("effectsStopped", VideoEffectsFeatureListener)
サブスクライブ関数 - 効果が停止したときに発生します
function on(event: "effectsStopped", listener: VideoEffectsFeatureListener)パラメーター
- event
-
"effectsStopped"
VideoEffectsFeatureEvent 型のイベント
- listener
- VideoEffectsFeatureListener
リスナー コールバック
on("fpsWarningThresholdReached", VideoEffectsFeatureListener)
サブスクライブ関数 - ストリーム fps が 'fpsWarningThreshold' 値以下の場合に発生します。
function on(event: "fpsWarningThresholdReached", listener: VideoEffectsFeatureListener)パラメーター
- event
-
"fpsWarningThresholdReached"
VideoEffectsFeatureEvent 型のイベント
- listener
- VideoEffectsFeatureListener
リスナー コールバック
on("timeForEffectsWarningReached", VideoEffectsFeatureListener)
サブスクライブ関数 - 効果の開始にかかった時間が 'effectInitTimeThresholdInMs' 値を超えると発生します。
function on(event: "timeForEffectsWarningReached", listener: VideoEffectsFeatureListener)パラメーター
- event
-
"timeForEffectsWarningReached"
VideoEffectsFeatureEvent 型のイベント
- listener
- VideoEffectsFeatureListener
リスナー コールバック
startEffects(VideoEffectProcessor)
効果の開始
function startEffects(effect: VideoEffectProcessor): Promise<void>パラメーター
- effect
- VideoEffectProcessor
効果のインスタンス
戻り値
Promise<void>
stopEffects()
効果を停止する
function stopEffects(): Promise<void>戻り値
Promise<void>
継承済みメソッドの詳細
dispose()
function dispose()