CallAdapterCallOperations interface

الحزمة:

@azure/communication-react

وظيفة لإدارة المكالمة الحالية.

الخصائص

sendRealTimeText

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

الأساليب

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)	إضافة مشارك إلى المكالمة.
createStreamView(string, VideoStreamOptions)	إنشاء طريقة عرض html لدفق.
createTogetherModeStreamView(TogetherModeStreamOptions)	إنشاء طريقة عرض html لدفق.
disposeLocalVideoStreamView()	التخلص من طريقة عرض html لدفق فيديو محلي
disposeRemoteVideoStreamView(string)	التخلص من طريقة عرض html لدفق فيديو بعيد
disposeScreenShareStreamView(string)	التخلص من طريقة عرض html لتدفق مشاركة الشاشة
disposeStreamView(string, VideoStreamOptions)	التخلص من طريقة عرض html للدفق.
disposeTogetherModeStreamView()	التخلص من طريقة عرض html للدفق.
forbidAudio(string[])	منع صوت الحاضرين في اجتماع Teams من خلال معرفات المستخدمين الخاصة بهم.
forbidOthersAudio()	حظر صوت اجتماع Teams.
forbidOthersVideo()	فيديو اجتماع حظر الفرق.
forbidVideo(string[])	منع فيديو الحاضرين في اجتماع Teams من خلال معرفات المستخدمين الخاصة بهم.
holdCall()	يحمل المكالمة.
leaveCall(boolean)	مغادرة المكالمة
lowerHand()	اليد الدنيا للمستخدم الحالي
mute()	كتم صوت المستخدم الحالي أثناء المكالمة أو تعطيل الميكروفون محليا
muteAllRemoteParticipants()	كتم صوت جميع المشاركين
muteParticipant(string)	كتم صوت مشارك
onReactionClick(Reaction)	إرسال رموز تعبيرية للرد الفعل
permitAudio(string[])	السماح للحاضرين في اجتماع Teams بالصوت من خلال معرفات المستخدمين الخاصة بهم.
permitOthersAudio()	السماح بصوت اجتماع Teams.
permitOthersVideo()	فيديو اجتماع فرق التسميح.
permitVideo(string[])	السماح للحاضرين في اجتماع Teams بالصوت من خلال معرفات المستخدمين الخاصة بهم.
raiseHand()	ارفع اليد للمستخدم الحالي
removeParticipant(CommunicationIdentifier)	إزالة مشارك من المكالمة.
removeParticipant(string)	إزالة مشارك من المكالمة.
resumeCall()	استئناف المكالمة من ولاية LocalHold .
returnFromBreakoutRoom()	العودة إلى مكالمة المنشأ لغرفة الاختراق
sendDtmfTone(DtmfTone)	إرسال نغمة DTMF إلى مشارك آخر في مكالمة PSTN 1: 1
setCaptionLanguage(string)	وظيفة لتعيين لغة التسمية التوضيحية
setSpokenLanguage(string)	وظيفة لتعيين اللغة المنطوقة
setTogetherModeSceneSize(number, number)	أعد حساب أوضاع الجلوس للوضع معا.
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[])	تجاوز صور منتقي الخلفية للحصول على تأثير استبدال الخلفية.
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)	قم بتحديث تأثير خلفية الفيديو المحدد.

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

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>

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 لدفق.

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

المعلمات

options

TogetherModeStreamOptions

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

المرتجعات

Promise<void | TogetherModeStreamViewResult>

الملاحظات

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

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)

تحذير

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

Use disposeRemoteVideoStreamView, disposeLocalVideoStreamView and disposeRemoteVideoStreamView instead.

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

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

المعلمات

remoteUserId

string

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

options

VideoStreamOptions

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

المرتجعات

Promise<void>

الملاحظات

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

disposeTogetherModeStreamView()

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

function disposeTogetherModeStreamView(): Promise<void>

المرتجعات

Promise<void>

الملاحظات

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

forbidAudio(string[])

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

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

المعلمات

userIds

string[]

المرتجعات

Promise<void>

forbidOthersAudio()

حظر صوت اجتماع Teams.

function forbidOthersAudio(): Promise<void>

المرتجعات

Promise<void>

forbidOthersVideo()

فيديو اجتماع حظر الفرق.

function forbidOthersVideo(): Promise<void>

المرتجعات

Promise<void>

forbidVideo(string[])

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

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

المعلمات

userIds

string[]

المرتجعات

Promise<void>

holdCall()

يحمل المكالمة.

function holdCall(): Promise<void>

المرتجعات

Promise<void>

leaveCall(boolean)

مغادرة المكالمة

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

المعلمات

forEveryone

boolean

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

المرتجعات

Promise<void>

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

المرتجعات

Promise<void>

permitAudio(string[])

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

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

المعلمات

userIds

string[]

المرتجعات

Promise<void>

permitOthersAudio()

السماح بصوت اجتماع Teams.

function permitOthersAudio(): Promise<void>

المرتجعات

Promise<void>

permitOthersVideo()

فيديو اجتماع فرق التسميح.

function permitOthersVideo(): Promise<void>

المرتجعات

Promise<void>

permitVideo(string[])

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

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

المعلمات

userIds

string[]

المرتجعات

Promise<void>

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>

resumeCall()

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

function resumeCall(): Promise<void>

المرتجعات

Promise<void>

returnFromBreakoutRoom()

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

function returnFromBreakoutRoom(): Promise<void>

المرتجعات

Promise<void>

sendDtmfTone(DtmfTone)

إرسال نغمة DTMF إلى مشارك آخر في مكالمة PSTN 1: 1

function sendDtmfTone(dtmfTone: DtmfTone): Promise<void>

المعلمات

dtmfTone

DtmfTone

المرتجعات

Promise<void>

setCaptionLanguage(string)

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

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

المعلمات

language

string

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

المرتجعات

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

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

الملاحظات

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

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[]

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

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

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

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

المعلمات

selectedVideoBackground

VideoBackgroundEffect