VideoEffectsFeature interface

الحزمة:

@azure/communication-calling

واجهة واجهة برمجة التطبيقات لميزة VideoEffects

Extends

VideoStreamFeature

الخصائص

activeEffects

قائمة التأثيرات النشطة الحالية

الخصائص الموروثة

name	اسم الميزة.

الأساليب

isSupported(VideoEffectProcessor)	أسلوب للتحقق مما إذا كان التأثير مدعوما في البيئة الحالية.
off("effectsError", VideoEffectsFeatureErrorListener)	دالات إلغاء الاشتراك - effectsError
off("effectsStarted", VideoEffectsFeatureListener)	دالات إلغاء الاشتراك - تأثيرات تم بدء تشغيلها
off("effectsStopped", VideoEffectsFeatureListener)	إلغاء الاشتراك في الوظائف - التأثيرات التي تم ضغطها
off("fpsWarningThresholdReached", VideoEffectsFeatureListener)	دالات إلغاء الاشتراك - fpsWarningThresholdReached
off("timeForEffectsWarningReached", VideoEffectsFeatureListener)	دالات إلغاء الاشتراك - timeForEffectsWarningReached
on("effectsError", VideoEffectsFeatureErrorListener)	وظائف الاشتراك - تشغيل الأخطاء أثناء استخدام التأثيرات
on("effectsStarted", VideoEffectsFeatureListener)	وظائف الاشتراك - الحرائق عند بدء التأثيرات
on("effectsStopped", VideoEffectsFeatureListener)	وظائف الاشتراك - الحرائق عند إيقاف التأثيرات
on("fpsWarningThresholdReached", VideoEffectsFeatureListener)	وظائف الاشتراك - يتم إطلاقها عندما يكون الدفق في الثانية مساويا ل/أقل من قيمة "fpsWarningThreshold"
on("timeForEffectsWarningReached", VideoEffectsFeatureListener)	وظائف الاشتراك - يتم تشغيل عندما يكون الوقت المستغرق لبدء التأثيرات أكثر من قيمة "effectInitTimeThresholdInMs"
startEffects(VideoEffectProcessor)	تأثيرات البدء
stopEffects()	إيقاف التأثيرات

الأساليب المتوارثة

dispose()

تفاصيل الخاصية

activeEffects

قائمة التأثيرات النشطة الحالية

activeEffects: VideoEffectName[]

قيمة الخاصية

VideoEffectName[]

تفاصيل الخاصية الموروثة

name

اسم الميزة.

name: string

قيمة الخاصية

string

موروث منVideoStreamFeature.name

تفاصيل الأسلوب

isSupported(VideoEffectProcessor)

أسلوب للتحقق مما إذا كان التأثير مدعوما في البيئة الحالية.

function isSupported(effect: VideoEffectProcessor): Promise<boolean>

المعلمات

effect

VideoEffectProcessor

مثيل التأثير للتحقق من دعم.

المرتجعات

Promise<boolean>

صحيح إذا كان التأثير مدعوما في البيئة الحالية.

off("effectsError", VideoEffectsFeatureErrorListener)

دالات إلغاء الاشتراك - effectsError

function off(event: "effectsError", listener: VideoEffectsFeatureErrorListener)

المعلمات

event

"effectsError"

حدث من النوع VideoEffectsFeatureEvent

listener

VideoEffectsFeatureErrorListener

رد اتصال المستمع

off("effectsStarted", VideoEffectsFeatureListener)

دالات إلغاء الاشتراك - تأثيرات تم بدء تشغيلها

function off(event: "effectsStarted", listener: VideoEffectsFeatureListener)

المعلمات

event

"effectsStarted"

حدث من النوع VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

رد اتصال المستمع

off("effectsStopped", VideoEffectsFeatureListener)

إلغاء الاشتراك في الوظائف - التأثيرات التي تم ضغطها

function off(event: "effectsStopped", listener: VideoEffectsFeatureListener)

المعلمات

event

"effectsStopped"

حدث من النوع VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

رد اتصال المستمع

off("fpsWarningThresholdReached", VideoEffectsFeatureListener)

دالات إلغاء الاشتراك - fpsWarningThresholdReached

function off(event: "fpsWarningThresholdReached", listener: VideoEffectsFeatureListener)

المعلمات

event

"fpsWarningThresholdReached"

حدث من النوع VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

رد اتصال المستمع

off("timeForEffectsWarningReached", VideoEffectsFeatureListener)

دالات إلغاء الاشتراك - 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)

وظائف الاشتراك - يتم إطلاقها عندما يكون الدفق في الثانية مساويا ل/أقل من قيمة "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()

موروث منVideoStreamFeature.dispos