CallWithChatAdapter interface
واجهة محول CallWithChatComposite.
- يمتد
الخصائص الموروثة
| forbid |
يحظر الصوت لمعرفات المستخدم المحددة. |
| forbid |
يحظر الصوت للحاضرين في اجتماع Teams باستثناء المستخدم المحلي. |
| forbid |
يحظر الفيديو لحضور اجتماعات Teams باستثناء المستخدم المحلي. |
| forbid |
يحظر الفيديو لمعرفات المستخدمين المحددة. |
| permit |
يسمح بالصوت لمعرفات المستخدم المحددة. |
| permit |
يسمح بالصوت لحضور اجتماعات Teams باستثناء المستخدم المحلي. |
| permit |
يسمح بالفيديو للحاضرين في اجتماع Teams باستثناء المستخدم المحلي. |
| permit |
يسمح بالفيديو لمعرفات المستخدم المحددة. |
| send |
إرسال DTMF Tone إلى مشارك آخر في المكالمة في مكالمات 1: 1 |
| send |
إرسال نص في الوقت الحقيقي |
الأساليب المتوارثة
تفاصيل الخاصية الموروثة
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>
الملاحظات
يتم تنفيذ هذا الأسلوب للمركب
موروثة منCallWithChatAdapterManagement.createTogetherModeStreamView
deleteMessage(string)
حذف رسالة في مؤشر الترابط.
function deleteMessage(messageId: string): Promise<void>
المعلمات
- messageId
-
string
المرتجعات
Promise<void>
dispose()
disposeLocalVideoStreamView()
التخلص من طريقة عرض html لدفق فيديو محلي
function disposeLocalVideoStreamView(): Promise<void>
المرتجعات
Promise<void>
موروثة منCallWithChatAdapterManagement.disposeLocalVideoStreamView
disposeRemoteVideoStreamView(string)
التخلص من طريقة عرض html لدفق فيديو بعيد
function disposeRemoteVideoStreamView(remoteUserId: string): Promise<void>
المعلمات
- remoteUserId
-
string
هوية المشارك المراد التخلص منه
المرتجعات
Promise<void>
موروثة منCallWithChatAdapterManagement.disposeRemoteVideoStreamView
disposeScreenShareStreamView(string)
التخلص من طريقة عرض html لتدفق مشاركة الشاشة
function disposeScreenShareStreamView(remoteUserId: string): Promise<void>
المعلمات
- remoteUserId
-
string
معرف المشارك للتخلص من عرض دفق مشاركة الشاشة له.
المرتجعات
Promise<void>
الملاحظات
يتم تنفيذ هذه الطريقة للمركب
موروثة منCallWithChatAdapterManagement.disposeScreenShareStreamView
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>
الملاحظات
يتم تنفيذ هذا الأسلوب للمركب
موروثة منCallWithChatAdapterManagement.disposeTogetherModeStreamView
downloadResourceToCache(ResourceDetails)
function downloadResourceToCache(resourceDetails: ResourceDetails): Promise<void>
المعلمات
- resourceDetails
- ResourceDetails
المرتجعات
Promise<void>
موروثة منCallWithChatAdapterManagement.downloadResourceToCache
fetchInitialData()
إحضار الحالة الأولية لمحول الدردشة.
ينفذ الحد الأدنى من الجلب الضروري لأساليب ChatComposite وواجهة برمجة التطبيقات.
function fetchInitialData(): Promise<void>
المرتجعات
Promise<void>
getState()
الحصول على الحالة الحالية
function getState(): CallWithChatAdapterState
المرتجعات
موروث منAdapterState.getState
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>
الملاحظات
عادة ما يتم استخدام هذا الأسلوب للتحكم في الجلب التزايدي/ التمرير اللانهائي.
موروث منCallWithChatAdapterManagement.loadPreviousChatMessages
lowerHand()
اليد الدنيا للمستخدم المحلي.
function lowerHand(): Promise<void>
المرتجعات
Promise<void>
mute()
كتم صوت المستخدم الحالي أثناء المكالمة أو تعطيل الميكروفون محليا.
function mute(): Promise<void>
المرتجعات
Promise<void>
muteAllRemoteParticipants()
كتم صوت مشارك
function muteAllRemoteParticipants(): Promise<void>
المرتجعات
Promise<void>
موروثة منCallWithChatAdapterManagement.muteAllRemoteParticipants
muteParticipant(string)
كتم صوت مشارك
function muteParticipant(userId: string): Promise<void>
المعلمات
- userId
-
string
المرتجعات
Promise<void>
off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
function off(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)
المعلمات
- event
-
"breakoutRoomsUpdated"
- listener
- BreakoutRoomsUpdatedListener
off("callEnded", CallEndedListener)
function off(event: "callEnded", listener: CallEndedListener)
المعلمات
- event
-
"callEnded"
- listener
- CallEndedListener
off("callError", (e: AdapterError) => void)
function off(event: "callError", listener: (e: AdapterError) => void)
المعلمات
- event
-
"callError"
- listener
-
(e: AdapterError) => void
off("callIdChanged", CallIdChangedListener)
function off(event: "callIdChanged", listener: CallIdChangedListener)
المعلمات
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
off("callParticipantsJoined", ParticipantsJoinedListener)
function off(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)
المعلمات
- event
-
"callParticipantsJoined"
- listener
- ParticipantsJoinedListener
off("callParticipantsLeft", ParticipantsLeftListener)
function off(event: "callParticipantsLeft", listener: ParticipantsLeftListener)
المعلمات
- event
-
"callParticipantsLeft"
- listener
- ParticipantsLeftListener
off("capabilitiesChanged", CapabilitiesChangedListener)
function off(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)
المعلمات
- event
-
"capabilitiesChanged"
- listener
- CapabilitiesChangedListener
off("captionsReceived", CaptionsReceivedListener)
function off(event: "captionsReceived", listener: CaptionsReceivedListener)
المعلمات
- event
-
"captionsReceived"
- listener
- CaptionsReceivedListener
off("chatError", (e: AdapterError) => void)
function off(event: "chatError", listener: (e: AdapterError) => void)
المعلمات
- event
-
"chatError"
- listener
-
(e: AdapterError) => void
off("chatInitialized", ChatInitializedListener)
function off(event: "chatInitialized", listener: ChatInitializedListener)
المعلمات
- event
-
"chatInitialized"
- listener
- ChatInitializedListener
off("chatParticipantsAdded", ParticipantsAddedListener)
function off(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)
المعلمات
- event
-
"chatParticipantsAdded"
- listener
- ParticipantsAddedListener
off("chatParticipantsRemoved", ParticipantsRemovedListener)
function off(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)
المعلمات
- event
-
"chatParticipantsRemoved"
- listener
- ParticipantsRemovedListener
off("displayNameChanged", DisplayNameChangedListener)
function off(event: "displayNameChanged", listener: DisplayNameChangedListener)
المعلمات
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
function off(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)
المعلمات
- event
-
"isCaptionLanguageChanged"
- listener
- IsCaptionLanguageChangedListener
off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
function off(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)
المعلمات
- event
-
"isCaptionsActiveChanged"
- listener
- IsCaptionsActiveChangedListener
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)
المعلمات
- event
-
"isLocalScreenSharingActiveChanged"
off("isMutedChanged", IsMutedChangedListener)
function off(event: "isMutedChanged", listener: IsMutedChangedListener)
المعلمات
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
off("isSpeakingChanged", IsSpeakingChangedListener)
function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)
المعلمات
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
function off(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)
المعلمات
- event
-
"isSpokenLanguageChanged"
- listener
- IsSpokenLanguageChangedListener
off("messageDeleted", MessageReceivedListener)
function off(event: "messageDeleted", listener: MessageReceivedListener)
المعلمات
- event
-
"messageDeleted"
- listener
- MessageReceivedListener
off("messageEdited", MessageReceivedListener)
function off(event: "messageEdited", listener: MessageReceivedListener)
المعلمات
- event
-
"messageEdited"
- listener
- MessageReceivedListener
off("messageRead", MessageReadListener)
function off(event: "messageRead", listener: MessageReadListener)
المعلمات
- event
-
"messageRead"
- listener
- MessageReadListener
off("messageReceived", MessageReceivedListener)
function off(event: "messageReceived", listener: MessageReceivedListener)
المعلمات
- event
-
"messageReceived"
- listener
- MessageReceivedListener
off("messageSent", MessageReceivedListener)
function off(event: "messageSent", listener: MessageReceivedListener)
المعلمات
- event
-
"messageSent"
- listener
- MessageReceivedListener
off("realTimeTextReceived", RealTimeTextReceivedListener)
function off(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)
المعلمات
- event
-
"realTimeTextReceived"
- listener
- RealTimeTextReceivedListener
off("selectedMicrophoneChanged", PropertyChangedEvent)
function off(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)
المعلمات
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
off("selectedSpeakerChanged", PropertyChangedEvent)
function off(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)
المعلمات
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
off("spotlightChanged", SpotlightChangedListener)
function off(event: "spotlightChanged", listener: SpotlightChangedListener)
المعلمات
- event
-
"spotlightChanged"
- listener
- SpotlightChangedListener
offStateChange((state: CallWithChatAdapterState) => void)
إلغاء اشتراك المعالج في أحداث stateChanged.
function offStateChange(handler: (state: CallWithChatAdapterState) => void)
المعلمات
- handler
-
(state: CallWithChatAdapterState) => void
موروث منAdapterState.offStateChange
on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
function on(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)
المعلمات
- event
-
"breakoutRoomsUpdated"
- listener
- BreakoutRoomsUpdatedListener
on("callEnded", CallEndedListener)
function on(event: "callEnded", listener: CallEndedListener)
المعلمات
- event
-
"callEnded"
- listener
- CallEndedListener
on("callError", (e: AdapterError) => void)
function on(event: "callError", listener: (e: AdapterError) => void)
المعلمات
- event
-
"callError"
- listener
-
(e: AdapterError) => void
on("callIdChanged", CallIdChangedListener)
function on(event: "callIdChanged", listener: CallIdChangedListener)
المعلمات
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
on("callParticipantsJoined", ParticipantsJoinedListener)
function on(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)
المعلمات
- event
-
"callParticipantsJoined"
- listener
- ParticipantsJoinedListener
on("callParticipantsLeft", ParticipantsLeftListener)
function on(event: "callParticipantsLeft", listener: ParticipantsLeftListener)
المعلمات
- event
-
"callParticipantsLeft"
- listener
- ParticipantsLeftListener
on("capabilitiesChanged", CapabilitiesChangedListener)
function on(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)
المعلمات
- event
-
"capabilitiesChanged"
- listener
- CapabilitiesChangedListener
on("captionsReceived", CaptionsReceivedListener)
function on(event: "captionsReceived", listener: CaptionsReceivedListener)
المعلمات
- event
-
"captionsReceived"
- listener
- CaptionsReceivedListener
on("chatError", (e: AdapterError) => void)
function on(event: "chatError", listener: (e: AdapterError) => void)
المعلمات
- event
-
"chatError"
- listener
-
(e: AdapterError) => void
on("chatInitialized", ChatInitializedListener)
function on(event: "chatInitialized", listener: ChatInitializedListener)
المعلمات
- event
-
"chatInitialized"
- listener
- ChatInitializedListener
on("chatParticipantsAdded", ParticipantsAddedListener)
function on(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)
المعلمات
- event
-
"chatParticipantsAdded"
- listener
- ParticipantsAddedListener
on("chatParticipantsRemoved", ParticipantsRemovedListener)
function on(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)
المعلمات
- event
-
"chatParticipantsRemoved"
- listener
- ParticipantsRemovedListener
on("displayNameChanged", DisplayNameChangedListener)
function on(event: "displayNameChanged", listener: DisplayNameChangedListener)
المعلمات
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
function on(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)
المعلمات
- event
-
"isCaptionLanguageChanged"
- listener
- IsCaptionLanguageChangedListener
on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
function on(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)
المعلمات
- event
-
"isCaptionsActiveChanged"
- listener
- IsCaptionsActiveChangedListener
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)
المعلمات
- event
-
"isLocalScreenSharingActiveChanged"
on("isMutedChanged", IsMutedChangedListener)
function on(event: "isMutedChanged", listener: IsMutedChangedListener)
المعلمات
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
on("isSpeakingChanged", IsSpeakingChangedListener)
function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)
المعلمات
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
function on(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)
المعلمات
- event
-
"isSpokenLanguageChanged"
- listener
- IsSpokenLanguageChangedListener
on("messageDeleted", MessageReceivedListener)
function on(event: "messageDeleted", listener: MessageReceivedListener)
المعلمات
- event
-
"messageDeleted"
- listener
- MessageReceivedListener
on("messageEdited", MessageReceivedListener)
function on(event: "messageEdited", listener: MessageReceivedListener)
المعلمات
- event
-
"messageEdited"
- listener
- MessageReceivedListener
on("messageRead", MessageReadListener)
function on(event: "messageRead", listener: MessageReadListener)
المعلمات
- event
-
"messageRead"
- listener
- MessageReadListener
on("messageReceived", MessageReceivedListener)
function on(event: "messageReceived", listener: MessageReceivedListener)
المعلمات
- event
-
"messageReceived"
- listener
- MessageReceivedListener
on("messageSent", MessageReceivedListener)
function on(event: "messageSent", listener: MessageReceivedListener)
المعلمات
- event
-
"messageSent"
- listener
- MessageReceivedListener
on("realTimeTextReceived", RealTimeTextReceivedListener)
function on(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)
المعلمات
- event
-
"realTimeTextReceived"
- listener
- RealTimeTextReceivedListener
on("selectedMicrophoneChanged", PropertyChangedEvent)
function on(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)
المعلمات
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
on("selectedSpeakerChanged", PropertyChangedEvent)
function on(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)
المعلمات
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
on("spotlightChanged", SpotlightChangedListener)
function on(event: "spotlightChanged", listener: SpotlightChangedListener)
المعلمات
- event
-
"spotlightChanged"
- listener
- SpotlightChangedListener
onReactionClick(Reaction)
إرسال رد فعل على الاجتماع الجاري.
function onReactionClick(reaction: Reaction): Promise<void>
المعلمات
- reaction
- Reaction
قيمة النوع <xref:%40azure%2Fcommunication-calling%23Reaction>
المرتجعات
Promise<void>
onStateChange((state: CallWithChatAdapterState) => void)
يشترك في المعالج في أحداث stateChanged.
function onStateChange(handler: (state: CallWithChatAdapterState) => void)
المعلمات
- handler
-
(state: CallWithChatAdapterState) => void
موروث منAdapterState.onStateChange
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
موروثة منCallWithChatAdapterManagement.removeResourceFromCache
resumeCall()
استئناف المكالمة من حالة LocalHold.
function resumeCall(): Promise<void>
المرتجعات
Promise<void>
returnFromBreakoutRoom()
العودة إلى مكالمة المنشأ لغرفة الاختراق
function returnFromBreakoutRoom(): Promise<void>
المرتجعات
Promise<void>
موروثة منCallWithChatAdapterManagement.returnFromBreakoutRoom
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
ارتفاع الحاوية
الملاحظات
يتم تنفيذ هذا الأسلوب للمركب
موروثة منCallWithChatAdapterManagement.setTogetherModeSceneSize
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>
موروثة منCallWithChatAdapterManagement.startNoiseSuppressionEffect
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>
موروثة منCallWithChatAdapterManagement.startVideoBackgroundEffect
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>
موروثة منCallWithChatAdapterManagement.stopNoiseSuppressionEffect
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>
موروثة منCallWithChatAdapterManagement.stopVideoBackgroundEffects
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
مجموعة من صور الخلفية المخصصة.
موروثة منCallWithChatAdapterManagement.updateBackgroundPickerImages
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.updateSelectedVideoBackgroundEffect