CallWithChatAdapterManagement interface

الحزمة:: @azure/communication-react

وظيفة لإدارة المكالمة الحالية باستخدام الدردشة.

الخصائص

forbidAudio	يحظر الصوت لمعرفات المستخدم المحددة.
forbidOthersAudio	يحظر الصوت للحاضرين في اجتماع Teams باستثناء المستخدم المحلي.
forbidOthersVideo	يحظر الفيديو لحضور اجتماعات Teams باستثناء المستخدم المحلي.
forbidVideo	يحظر الفيديو لمعرفات المستخدمين المحددة.
permitAudio	يسمح بالصوت لمعرفات المستخدم المحددة.
permitOthersAudio	يسمح بالصوت لحضور اجتماعات Teams باستثناء المستخدم المحلي.
permitOthersVideo	يسمح بالفيديو للحاضرين في اجتماع Teams باستثناء المستخدم المحلي.
permitVideo	يسمح بالفيديو لمعرفات المستخدم المحددة.
sendDtmfTone	إرسال DTMF Tone إلى مشارك آخر في المكالمة في مكالمات 1: 1
sendRealTimeText	إرسال نص في الوقت الحقيقي

الأساليب

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)	يضيف مشاركا جديدا إلى المكالمة.
askDevicePermission(PermissionConstraints)	اطلب أذونات الأجهزة.
createStreamView(string, VideoStreamOptions)	إنشاء طريقة عرض html لدفق.
createTogetherModeStreamView(TogetherModeStreamOptions)	قم بإنشاء طريقة عرض html لدفق وضع togethermode.
deleteMessage(string)	حذف رسالة في مؤشر الترابط.
disposeLocalVideoStreamView()	التخلص من طريقة عرض html لدفق فيديو محلي
disposeRemoteVideoStreamView(string)	التخلص من طريقة عرض html لدفق فيديو بعيد
disposeScreenShareStreamView(string)	التخلص من طريقة عرض html لتدفق مشاركة الشاشة
disposeStreamView(string, VideoStreamOptions)	التخلص من طريقة عرض html للدفق.
disposeTogetherModeStreamView()	تخلص من طريقة عرض html لدفق وضع together.
downloadResourceToCache(ResourceDetails)
fetchInitialData()	إحضار الحالة الأولية لمحول الدردشة. ينفذ الحد الأدنى من الجلب الضروري لأساليب ChatComposite وواجهة برمجة التطبيقات.
holdCall()	يضع المكالمة في تعليق محلي.
joinCall(boolean)	انضم إلى المكالمة مع تشغيل/إيقاف تشغيل الميكروفون في البداية.
joinCall(JoinCallOptions)	انضم إلى المكالمة مع حقيبة الخيارات لضبط الحالة الأولية للميكروفون / الكاميرا عند الانضمام إلى المكالمة true = تشغيل الجهاز عند الانضمام إلى المكالمة false = إيقاف تشغيل الجهاز عند الانضمام إلى المكالمة "احتفظ" / غير محدد = الاحتفاظ بحالة الاستدعاء المسبق للأجهزة
leaveCall(boolean)	اترك المكالمة.
loadPreviousChatMessages(number)	تحميل المزيد من الرسائل السابقة في محفوظات مؤشر ترابط الدردشة.
lowerHand()	اليد الدنيا للمستخدم المحلي.
mute()	كتم صوت المستخدم الحالي أثناء المكالمة أو تعطيل الميكروفون محليا.
muteAllRemoteParticipants()	كتم صوت مشارك
muteParticipant(string)	كتم صوت مشارك
onReactionClick(Reaction)	إرسال رد فعل على الاجتماع الجاري.
queryCameras()	الاستعلام عن أجهزة الكاميرا المتوفرة.
queryMicrophones()	الاستعلام عن أجهزة الميكروفون المتوفرة.
querySpeakers()	الاستعلام عن أجهزة الميكروفون المتوفرة.
raiseHand()	ارفع اليد للمستخدم المحلي.
removeParticipant(CommunicationIdentifier)	إزالة مشارك من المكالمة.
removeParticipant(string)	إزالة مشارك من مكالمة.
removeResourceFromCache(ResourceDetails)
resumeCall()	استئناف المكالمة من حالة LocalHold.
returnFromBreakoutRoom()	العودة إلى مكالمة المنشأ لغرفة الاختراق
sendMessage(string, SendMessageOptions)	إرسال رسالة في مؤشر الترابط.
sendReadReceipt(string)	إرسال إيصال قراءة لرسالة.
sendTypingIndicator()	إرسال مؤشر الكتابة في مؤشر الترابط.
setCamera(VideoDeviceInfo, VideoStreamOptions)	قم بتعيين الكاميرا لاستخدامها في المكالمة.
setCaptionLanguage(string)	وظيفة لتعيين لغة التسمية التوضيحية
setMicrophone(AudioDeviceInfo)	قم بتعيين الميكروفون لاستخدامه في المكالمة.
setSpeaker(AudioDeviceInfo)	تعيين السماعة لاستخدامها في المكالمة.
setSpokenLanguage(string)	وظيفة لتعيين اللغة المنطوقة
setTogetherModeSceneSize(number, number)	أعد حساب أوضاع الجلوس للوضع معا.
startCall((CommunicationUserIdentifier \| PhoneNumberIdentifier \| MicrosoftTeamsUserIdentifier \| MicrosoftTeamsAppIdentifier \| UnknownIdentifier)[], StartCallOptions)	بدء المكالمة.
startCall(string[], StartCallOptions)	بدء المكالمة.
startCamera(VideoStreamOptions)	بدء تشغيل الكاميرا. سيبدأ هذا الأسلوب في عرض طريقة عرض الكاميرا المحلية عندما لا تكون المكالمة نشطة.
startCaptions(StartCaptionsAdapterOptions)	وظيفة لبدء التسميات التوضيحية
startNoiseSuppressionEffect()	ابدأ تأثير قمع الضوضاء.
startScreenShare()	ابدأ بمشاركة الشاشة أثناء إجراء مكالمة.
startSpotlight(string[])	بدء تسليط الضوء
startTogetherMode()	وضع البدء معا.
startVideoBackgroundEffect(VideoBackgroundEffect)	ابدأ تأثير خلفية الفيديو.
stopAllSpotlight()	أوقف جميع الأضواء الكاشفة
stopCamera()	أوقف الكاميرا. سيتوقف هذا الأسلوب عن عرض طريقة عرض الكاميرا المحلية عندما لا تكون المكالمة نشطة.
stopCaptions(StopCaptionsAdapterOptions)	وظيفة لإيقاف التسميات التوضيحية
stopNoiseSuppressionEffect()	ابدأ تأثير قمع الضوضاء.
stopScreenShare()	إيقاف مشاركة الشاشة.
stopSpotlight(string[])	إيقاف الأضواء
stopVideoBackgroundEffects()	أوقف تأثير خلفية الفيديو.
submitSurvey(CallSurvey)	إرسال نتيجة استطلاع نهاية المكالمة
unmute()	إلغاء كتم صوت المستخدم الحالي أثناء المكالمة أو تمكين الميكروفون محليا.
updateBackgroundPickerImages(VideoBackgroundImage[])	تجاوز صور منتقي الخلفية للحصول على تأثير استبدال الخلفية.
updateMessage(string, string, Record<string, string>)	تحديث محتوى رسالة.
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)	تحديث تأثير خلفية الفيديو المحدد

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

forbidAudio

يحظر الصوت لمعرفات المستخدم المحددة.

forbidAudio: (userIds: string[]) => Promise<void>

قيمة الخاصية

(userIds: string[]) => Promise<void>

forbidOthersAudio

يحظر الصوت للحاضرين في اجتماع Teams باستثناء المستخدم المحلي.

forbidOthersAudio: () => Promise<void>

قيمة الخاصية

() => Promise<void>

forbidOthersVideo

يحظر الفيديو لحضور اجتماعات Teams باستثناء المستخدم المحلي.

forbidOthersVideo: () => Promise<void>

قيمة الخاصية

() => Promise<void>

forbidVideo

يحظر الفيديو لمعرفات المستخدمين المحددة.

forbidVideo: (userIds: string[]) => Promise<void>

قيمة الخاصية

(userIds: string[]) => Promise<void>

permitAudio

يسمح بالصوت لمعرفات المستخدم المحددة.

permitAudio: (userIds: string[]) => Promise<void>

قيمة الخاصية

(userIds: string[]) => Promise<void>

permitOthersAudio

يسمح بالصوت لحضور اجتماعات Teams باستثناء المستخدم المحلي.

permitOthersAudio: () => Promise<void>

قيمة الخاصية

() => Promise<void>

permitOthersVideo

يسمح بالفيديو للحاضرين في اجتماع Teams باستثناء المستخدم المحلي.

permitOthersVideo: () => Promise<void>

قيمة الخاصية

() => Promise<void>

permitVideo

يسمح بالفيديو لمعرفات المستخدم المحددة.

permitVideo: (userIds: string[]) => Promise<void>

قيمة الخاصية

(userIds: string[]) => Promise<void>

sendDtmfTone

إرسال DTMF Tone إلى مشارك آخر في المكالمة في مكالمات 1: 1

public sendDtmfTone: (dtmfTone: DtmfTone) => Promise<void>

قيمة الخاصية

(dtmfTone: DtmfTone) => Promise<void>

sendRealTimeText

إرسال نص في الوقت الحقيقي

sendRealTimeText: (text: string, isFinalized: boolean) => Promise<void>

قيمة الخاصية

(text: string, isFinalized: boolean) => Promise<void>

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

addParticipant(CommunicationUserIdentifier)

function addParticipant(participant: CommunicationUserIdentifier): Promise<void>

المعلمات

participant: CommunicationUserIdentifier

المرتجعات

Promise<void>

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

يضيف مشاركا جديدا إلى المكالمة.

function addParticipant(participant: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): Promise<void>

المعلمات

participant: PhoneNumberIdentifier

options: AddPhoneNumberOptions

المرتجعات

Promise<void>

askDevicePermission(PermissionConstraints)

اطلب أذونات الأجهزة.

function askDevicePermission(constrain: PermissionConstraints): Promise<DeviceAccess>

المعلمات

constrain: PermissionConstraints

تحديد القيود للوصول إلى الأجهزة المحلية <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>

المرتجعات

Promise<DeviceAccess>

الملاحظات

ستظهر نافذة أذونات المستعرض إذا لم يتم منح الأذونات بعد.

createStreamView(string, VideoStreamOptions)

إنشاء طريقة عرض html لدفق.

function createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>

المعلمات

remoteUserId: string

معرف المشارك الذي سيتم عرضه، اتركه غير محدد لإنشاء طريقة عرض الكاميرا المحلية

options: VideoStreamOptions

خيارات للتحكم في كيفية عرض تدفقات الفيديو <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

المرتجعات

Promise<void | CreateVideoStreamViewResult>

الملاحظات

يتم تنفيذ هذا الأسلوب للمركب.

createTogetherModeStreamView(TogetherModeStreamOptions)

قم بإنشاء طريقة عرض html لدفق وضع togethermode.

function createTogetherModeStreamView(options?: TogetherModeStreamOptions): Promise<void | TogetherModeStreamViewResult>

المعلمات

options: TogetherModeStreamOptions

خيارات للتحكم في كيفية عرض تدفقات الفيديو <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

المرتجعات

Promise<void | TogetherModeStreamViewResult>

الملاحظات

يتم تنفيذ هذا الأسلوب للمركب

deleteMessage(string)

حذف رسالة في مؤشر الترابط.

function deleteMessage(messageId: string): Promise<void>

المعلمات

messageId: string

المرتجعات

Promise<void>

disposeLocalVideoStreamView()

التخلص من طريقة عرض html لدفق فيديو محلي

function disposeLocalVideoStreamView(): Promise<void>

المرتجعات

Promise<void>

disposeRemoteVideoStreamView(string)

التخلص من طريقة عرض html لدفق فيديو بعيد

function disposeRemoteVideoStreamView(remoteUserId: string): Promise<void>

المعلمات

remoteUserId: string

هوية المشارك المراد التخلص منه

المرتجعات

Promise<void>

disposeScreenShareStreamView(string)

التخلص من طريقة عرض html لتدفق مشاركة الشاشة

function disposeScreenShareStreamView(remoteUserId: string): Promise<void>

المعلمات

remoteUserId: string

معرف المشارك للتخلص من عرض دفق مشاركة الشاشة له.

المرتجعات

Promise<void>

الملاحظات

يتم تنفيذ هذه الطريقة للمركب

disposeStreamView(string, VideoStreamOptions)

التخلص من طريقة عرض html للدفق.

function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>

المعلمات

remoteUserId: string

معرف المشارك الذي سيتم عرضه، اتركه غير محدد للتخلص من طريقة عرض الكاميرا المحلية

options: VideoStreamOptions

خيارات للتحكم في كيفية عرض تدفقات الفيديو <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

المرتجعات

Promise<void>

الملاحظات

يتم تنفيذ هذا الأسلوب للمركب.

disposeTogetherModeStreamView()

تخلص من طريقة عرض html لدفق وضع together.

function disposeTogetherModeStreamView(): Promise<void>

المرتجعات

Promise<void>

الملاحظات

يتم تنفيذ هذا الأسلوب للمركب

downloadResourceToCache(ResourceDetails)

function downloadResourceToCache(resourceDetails: ResourceDetails): Promise<void>

المعلمات

resourceDetails: ResourceDetails

المرتجعات

Promise<void>

fetchInitialData()

إحضار الحالة الأولية لمحول الدردشة.

ينفذ الحد الأدنى من الجلب الضروري لأساليب ChatComposite وواجهة برمجة التطبيقات.

function fetchInitialData(): Promise<void>

المرتجعات

Promise<void>

holdCall()

يضع المكالمة في تعليق محلي.

function holdCall(): Promise<void>

المرتجعات

Promise<void>

joinCall(boolean)

تحذير

واجهة برمجة التطبيقات هذه مهملة الآن.

Use joinCall(options?:JoinCallOptions) instead.

انضم إلى المكالمة مع تشغيل/إيقاف تشغيل الميكروفون في البداية.

function joinCall(microphoneOn?: boolean): undefined | Call

المعلمات

microphoneOn: boolean

ما إذا كان الميكروفون ممكنا في البداية

المرتجعات

undefined | Call

joinCall(JoinCallOptions)

انضم إلى المكالمة مع حقيبة الخيارات لضبط الحالة الأولية للميكروفون / الكاميرا عند الانضمام إلى المكالمة true = تشغيل الجهاز عند الانضمام إلى المكالمة false = إيقاف تشغيل الجهاز عند الانضمام إلى المكالمة "احتفظ" / غير محدد = الاحتفاظ بحالة الاستدعاء المسبق للأجهزة

function joinCall(options?: JoinCallOptions): undefined | Call

المعلمات

options: JoinCallOptions

param لضبط الميكروفون / الكاميرا في البداية على / إيقاف / استخدام حالة الاستدعاء المسبق.

المرتجعات

undefined | Call

leaveCall(boolean)

اترك المكالمة.

function leaveCall(forEveryone?: boolean): Promise<void>

المعلمات

forEveryone: boolean

ما إذا كنت تريد إزالة جميع المشاركين عند المغادرة

المرتجعات

Promise<void>

loadPreviousChatMessages(number)

تحميل المزيد من الرسائل السابقة في محفوظات مؤشر ترابط الدردشة.

function loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>

المعلمات

messagesToLoad: number

المرتجعات

Promise<boolean>

الملاحظات

عادة ما يتم استخدام هذا الأسلوب للتحكم في الجلب التزايدي/ التمرير اللانهائي.

lowerHand()

اليد الدنيا للمستخدم المحلي.

function lowerHand(): Promise<void>

المرتجعات

Promise<void>

mute()

كتم صوت المستخدم الحالي أثناء المكالمة أو تعطيل الميكروفون محليا.

function mute(): Promise<void>

المرتجعات

Promise<void>

muteAllRemoteParticipants()

كتم صوت مشارك

function muteAllRemoteParticipants(): Promise<void>

المرتجعات

Promise<void>

muteParticipant(string)

كتم صوت مشارك

function muteParticipant(userId: string): Promise<void>

المعلمات

userId: string

المرتجعات

Promise<void>

onReactionClick(Reaction)

إرسال رد فعل على الاجتماع الجاري.

function onReactionClick(reaction: Reaction): Promise<void>

المعلمات

reaction: Reaction

قيمة النوع <xref:%40azure%2Fcommunication-calling%23Reaction>

المرتجعات

Promise<void>

queryCameras()

الاستعلام عن أجهزة الكاميرا المتوفرة.

function queryCameras(): Promise<VideoDeviceInfo[]>

المرتجعات

Promise<VideoDeviceInfo[]>

صفيف من كيانات معلومات جهاز الفيديو <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>

الملاحظات

يجب استدعاء هذا الأسلوب بعد askDevicePermission()

queryMicrophones()

الاستعلام عن أجهزة الميكروفون المتوفرة.

function queryMicrophones(): Promise<AudioDeviceInfo[]>

المرتجعات

Promise<AudioDeviceInfo[]>

صفيف من كيانات معلومات جهاز الصوت <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

الملاحظات

يجب استدعاء هذا الأسلوب بعد askDevicePermission()

querySpeakers()

الاستعلام عن أجهزة الميكروفون المتوفرة.

function querySpeakers(): Promise<AudioDeviceInfo[]>

المرتجعات

Promise<AudioDeviceInfo[]>

صفيف من كيانات معلومات جهاز الصوت <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

الملاحظات

يجب استدعاء هذا الأسلوب بعد askDevicePermission()

raiseHand()

ارفع اليد للمستخدم المحلي.

function raiseHand(): Promise<void>

المرتجعات

Promise<void>

removeParticipant(CommunicationIdentifier)

إزالة مشارك من المكالمة.

function removeParticipant(participant: CommunicationIdentifier): Promise<void>

المعلمات

participant: CommunicationIdentifier

<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> من المشارك المراد إزالته

المرتجعات

Promise<void>

removeParticipant(string)

إزالة مشارك من مكالمة.

function removeParticipant(userId: string): Promise<void>

المعلمات

userId: string

معرف المستخدم للمشارك المراد إزالته.

المرتجعات

Promise<void>

removeResourceFromCache(ResourceDetails)

function removeResourceFromCache(resourceDetails: ResourceDetails)

المعلمات

resourceDetails: ResourceDetails

resumeCall()

استئناف المكالمة من حالة LocalHold.

function resumeCall(): Promise<void>

المرتجعات

Promise<void>

returnFromBreakoutRoom()

العودة إلى مكالمة المنشأ لغرفة الاختراق

function returnFromBreakoutRoom(): Promise<void>

المرتجعات

Promise<void>

sendMessage(string, SendMessageOptions)

إرسال رسالة في مؤشر الترابط.

function sendMessage(content: string, options?: SendMessageOptions): Promise<void>

المعلمات

content: string

options: SendMessageOptions

المرتجعات

Promise<void>

sendReadReceipt(string)

إرسال إيصال قراءة لرسالة.

function sendReadReceipt(chatMessageId: string): Promise<void>

المعلمات

chatMessageId: string

المرتجعات

Promise<void>

sendTypingIndicator()

إرسال مؤشر الكتابة في مؤشر الترابط.

function sendTypingIndicator(): Promise<void>

المرتجعات

Promise<void>

setCamera(VideoDeviceInfo, VideoStreamOptions)

قم بتعيين الكاميرا لاستخدامها في المكالمة.

function setCamera(sourceInfo: VideoDeviceInfo, options?: VideoStreamOptions): Promise<void>

المعلمات

sourceInfo: VideoDeviceInfo

جهاز الكاميرا للاختيار، اختر جهازا تم إرجاعه بواسطة queryCameras

options: VideoStreamOptions

خيارات للتحكم في كيفية عرض دفق الكاميرا <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

المرتجعات

Promise<void>

setCaptionLanguage(string)

وظيفة لتعيين لغة التسمية التوضيحية

function setCaptionLanguage(language: string): Promise<void>

المعلمات

language: string

مجموعة اللغة للتسمية التوضيحية

المرتجعات

Promise<void>

setMicrophone(AudioDeviceInfo)

قم بتعيين الميكروفون لاستخدامه في المكالمة.

function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>

المعلمات

sourceInfo: AudioDeviceInfo

جهاز الميكروفون للاختيار، اختر جهازا تم إرجاعه بواسطة queryMicrophones

المرتجعات

Promise<void>

setSpeaker(AudioDeviceInfo)

تعيين السماعة لاستخدامها في المكالمة.

function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>

المعلمات

sourceInfo: AudioDeviceInfo

جهاز مكبر الصوت للاختيار، اختر جهازا تم إرجاعه بواسطة querySpeakers

المرتجعات

Promise<void>

setSpokenLanguage(string)

وظيفة لتعيين اللغة المنطوقة

function setSpokenLanguage(language: string): Promise<void>

المعلمات

language: string

اللغة المنطوقة

المرتجعات

Promise<void>

setTogetherModeSceneSize(number, number)

أعد حساب أوضاع الجلوس للوضع معا.

function setTogetherModeSceneSize(width: number, height: number)

المعلمات

width: number

عرض الحاوية

height: number

ارتفاع الحاوية

الملاحظات

يتم تنفيذ هذا الأسلوب للمركب

startCall((CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)

بدء المكالمة.

function startCall(participants: (CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], options?: StartCallOptions): undefined | Call

المعلمات

participants: (CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]

مصفوفة من <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> أن تسمى

options: StartCallOptions

المرتجعات

undefined | Call

startCall(string[], StartCallOptions)

بدء المكالمة.

function startCall(participants: string[], options?: StartCallOptions): undefined | Call

المعلمات

participants: string[]

صفيف من معرفات المشاركين للانضمام

options: StartCallOptions

المرتجعات

undefined | Call

startCamera(VideoStreamOptions)

بدء تشغيل الكاميرا.

سيبدأ هذا الأسلوب في عرض طريقة عرض الكاميرا المحلية عندما لا تكون المكالمة نشطة.

function startCamera(options?: VideoStreamOptions): Promise<void>

المعلمات

options: VideoStreamOptions

خيارات للتحكم في كيفية عرض تدفقات الفيديو <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

المرتجعات

Promise<void>

startCaptions(StartCaptionsAdapterOptions)

وظيفة لبدء التسميات التوضيحية

function startCaptions(options?: StartCaptionsAdapterOptions): Promise<void>

المعلمات

options: StartCaptionsAdapterOptions

خيارات بدء التسميات التوضيحية

المرتجعات

Promise<void>

startNoiseSuppressionEffect()

ابدأ تأثير قمع الضوضاء.

function startNoiseSuppressionEffect(): Promise<void>

المرتجعات

Promise<void>

startScreenShare()

ابدأ بمشاركة الشاشة أثناء إجراء مكالمة.

function startScreenShare(): Promise<void>

المرتجعات

Promise<void>

startSpotlight(string[])

بدء تسليط الضوء

function startSpotlight(userIds?: string[]): Promise<void>

المعلمات

userIds: string[]

المرتجعات

Promise<void>

startTogetherMode()

وضع البدء معا.

function startTogetherMode(): Promise<void>

المرتجعات

Promise<void>

الملاحظات

يتم تنفيذ هذا الأسلوب للمركب

startVideoBackgroundEffect(VideoBackgroundEffect)

ابدأ تأثير خلفية الفيديو.

function startVideoBackgroundEffect(videoBackgroundEffect: VideoBackgroundEffect): Promise<void>

المعلمات

videoBackgroundEffect: VideoBackgroundEffect

المرتجعات

Promise<void>

stopAllSpotlight()

أوقف جميع الأضواء الكاشفة

function stopAllSpotlight(): Promise<void>

المرتجعات

Promise<void>

stopCamera()

أوقف الكاميرا.

سيتوقف هذا الأسلوب عن عرض طريقة عرض الكاميرا المحلية عندما لا تكون المكالمة نشطة.

function stopCamera(): Promise<void>

المرتجعات

Promise<void>

stopCaptions(StopCaptionsAdapterOptions)

وظيفة لإيقاف التسميات التوضيحية

function stopCaptions(options?: StopCaptionsAdapterOptions): Promise<void>

المعلمات

options: StopCaptionsAdapterOptions

المرتجعات

Promise<void>

stopNoiseSuppressionEffect()

ابدأ تأثير قمع الضوضاء.

function stopNoiseSuppressionEffect(): Promise<void>

المرتجعات

Promise<void>

stopScreenShare()

إيقاف مشاركة الشاشة.

function stopScreenShare(): Promise<void>

المرتجعات

Promise<void>

stopSpotlight(string[])

إيقاف الأضواء

function stopSpotlight(userIds?: string[]): Promise<void>

المعلمات

userIds: string[]

المرتجعات

Promise<void>

stopVideoBackgroundEffects()

أوقف تأثير خلفية الفيديو.

function stopVideoBackgroundEffects(): Promise<void>

المرتجعات

Promise<void>

submitSurvey(CallSurvey)

إرسال نتيجة استطلاع نهاية المكالمة

function submitSurvey(survey: CallSurvey): Promise<undefined | CallSurveyResponse>

المعلمات

survey: CallSurvey

المرتجعات

Promise<undefined | CallSurveyResponse>

unmute()

إلغاء كتم صوت المستخدم الحالي أثناء المكالمة أو تمكين الميكروفون محليا.

function unmute(): Promise<void>

المرتجعات

Promise<void>

updateBackgroundPickerImages(VideoBackgroundImage[])

تجاوز صور منتقي الخلفية للحصول على تأثير استبدال الخلفية.

function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])

المعلمات

backgroundImages: VideoBackgroundImage[]

مجموعة من صور الخلفية المخصصة.

updateMessage(string, string, Record<string, string>)

تحديث محتوى رسالة.

function updateMessage(messageId: string, content: string, options?: Record<string, string>): Promise<void>

المعلمات

messageId: string

content: string

options: Record<string, string>

المرتجعات

Promise<void>

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

تحديث تأثير خلفية الفيديو المحدد

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

المعلمات

selectedVideoBackground: VideoBackgroundEffect

مشاركة عبر

CallWithChatAdapterManagement interface

الخصائص

الأساليب

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

forbidAudio

قيمة الخاصية

forbidOthersAudio

قيمة الخاصية

forbidOthersVideo

قيمة الخاصية

forbidVideo

قيمة الخاصية

permitAudio

قيمة الخاصية

permitOthersAudio

قيمة الخاصية

permitOthersVideo

قيمة الخاصية

permitVideo

قيمة الخاصية

sendDtmfTone

قيمة الخاصية

sendRealTimeText

قيمة الخاصية

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

addParticipant(CommunicationUserIdentifier)

المعلمات

المرتجعات

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

المعلمات

المرتجعات

askDevicePermission(PermissionConstraints)

المعلمات

المرتجعات

الملاحظات

createStreamView(string, VideoStreamOptions)

المعلمات

المرتجعات

الملاحظات

createTogetherModeStreamView(TogetherModeStreamOptions)

المعلمات

المرتجعات

الملاحظات

deleteMessage(string)

المعلمات

المرتجعات

disposeLocalVideoStreamView()

المرتجعات

disposeRemoteVideoStreamView(string)

المعلمات

المرتجعات

disposeScreenShareStreamView(string)

المعلمات

المرتجعات

الملاحظات

disposeStreamView(string, VideoStreamOptions)

المعلمات

المرتجعات

الملاحظات

disposeTogetherModeStreamView()

المرتجعات

الملاحظات

downloadResourceToCache(ResourceDetails)

المعلمات

المرتجعات

fetchInitialData()

المرتجعات

holdCall()

المرتجعات

joinCall(boolean)

المعلمات

المرتجعات

joinCall(JoinCallOptions)

المعلمات

المرتجعات

leaveCall(boolean)

المعلمات

المرتجعات

loadPreviousChatMessages(number)