SpotlightCallFeature interface

الحزمة:

@azure/communication-calling

ميزة مكالمة Spotlight.

يمتد

CallFeature

الخصائص

maxParticipantsToSpotlight

إرجاع الحد الأقصى لعدد المشاركين الذين يمكن إبرازهم

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

name	اسم الميزة.

الأساليب

getSpotlightedParticipants()
off("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)	وظيفة الاشتراك لحدث SpotlightUpdated
on("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)	وظيفة الاشتراك لحدث SpotlightUpdated
startSpotlight(CommunicationIdentifier[])
stopAllSpotlight()	إيقاف تسليط الضوء على جميع المشاركين.
stopSpotlight(CommunicationIdentifier[])

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

dispose()

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

maxParticipantsToSpotlight

إرجاع الحد الأقصى لعدد المشاركين الذين يمكن إبرازهم

maxParticipantsToSpotlight: number

قيمة الخاصية

number

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

name

اسم الميزة.

name: string

قيمة الخاصية

string

موروث منCallFeature.name

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

getSpotlightedParticipants()

function getSpotlightedParticipants(): SpotlightedParticipant[]

المرتجعات

SpotlightedParticipant[]

إرجاع قائمة بجميع المشاركين الذين تم إبرازهم حاليا

off("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)

وظيفة الاشتراك لحدث SpotlightUpdated

function off(event: "spotlightChanged", listener: CollectionUpdatedEvent<SpotlightedParticipant>)

المعلمات

event

"spotlightChanged"

اسم الحدث

listener

CollectionUpdatedEvent<SpotlightedParticipant>

دالة رد الاتصال التي تم استخدامها للاشتراك في هذا الحدث

on("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)

وظيفة الاشتراك لحدث SpotlightUpdated

function on(event: "spotlightChanged", listener: CollectionUpdatedEvent<SpotlightedParticipant>)

المعلمات

event

"spotlightChanged"

اسم الحدث

listener

CollectionUpdatedEvent<SpotlightedParticipant>

دالة رد الاتصال التي تم استخدامها للاشتراك في هذا الحدث

startSpotlight(CommunicationIdentifier[])

function startSpotlight(participants?: CommunicationIdentifier[]): Promise<void>

المعلمات

participants

CommunicationIdentifier[]

بدء تسليط الضوء على المشاركين المحليين والنائية عند عدم تمرير صفيف المشاركين، يتم تنفيذ الإجراء على المشارك المحلي

المرتجعات

Promise<void>

وعد يمثل إكمال عملية startParticipantSpotlight. سيتم إصدار حدث 'SpotlightUpdated' عند بدء تشغيل startParticipantSpotlight بنجاح.

stopAllSpotlight()

إيقاف تسليط الضوء على جميع المشاركين.

function stopAllSpotlight(): Promise<void>

المرتجعات

Promise<void>

وعد يمثل إكمال عملية stopAllSpotlight. سيتم إصدار حدث 'SpotlightUpdated' عند إيقاف stopAllSpotlight بنجاح.

stopSpotlight(CommunicationIdentifier[])

function stopSpotlight(participants?: CommunicationIdentifier[]): Promise<void>

المعلمات

participants

CommunicationIdentifier[]

إيقاف تسليط الضوء على المشاركين المحليين والنائية عند عدم تمرير صفيف المشاركين، يتم تنفيذ الإجراء على المشارك المحلي

المرتجعات

Promise<void>

وعد يمثل إكمال عملية stopParticipantSpotlight. سيتم إصدار حدث 'SpotlightUpdated' عند إيقاف stopParticipantSpotlight بنجاح.

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

dispose()

function dispose()

موروث منCallFeature.dispos