Call interface

الحزمة:

@azure/communication-calling

يمثل مكالمة.

يمتد

CallCommon

الخصائص

info	احصل على معلومات حول هذه المكالمة.

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

callEndReason	يحتوي على رمز/رمز فرعي يشير إلى كيفية انتهاء هذه المكالمة.
callerInfo	معلومات المتصل إذا كانت هذه المكالمة واردة.
direction	احصل على اتجاه المكالمة، سواء كان واردا أو صادرا.
id	احصل على المعرف الفريد لهذه المكالمة.
isIncomingAudioMuted	ما إذا كان المستخدم المحلي قد كتم الصوت الوارد.
isLocalVideoStarted	ما إذا كان الفيديو المحلي قيد التشغيل.
isMuted	سواء تم كتم صوت المستخدم المحلي، محليا أو عن بعد.
isScreenSharingOn	ما إذا كانت مشاركة الشاشة قيد التشغيل.
kind	الحصول على نوع كائن الاستدعاء.
lobby	احصل على ساحة انتظار اجتماع Teams.
localAudioStreams	مجموعة من تدفقات الصوت المحلية التي يتم إرسالها إلى مشاركين آخرين في مكالمة.
localVideoStreams	مجموعة من تدفقات الفيديو المحلية التي يتم إرسالها إلى مشاركين آخرين في مكالمة.
remoteAudioStreams	مجموعة من تدفقات الصوت عن بعد التي يتم تلقيها من المكالمة.
remoteParticipants	مجموعة من المشاركين عن بعد في هذه المكالمة. في حالة المكالمات مع مشاركين من مائة أو أكثر، يكون المشاركون النشطون في وسائل الإعلام فقط موجودين في هذه المجموعة.
role	احصل على دور المستخدم المحلي في المكالمة.
state	احصل على حالة هذه المكالمة.
totalParticipantCount	عدد إجمالي عدد المشاركين في هذه المكالمة.

الأساليب

addParticipant(CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier)	إضافة مشارك إلى هذه المكالمة.
addParticipant(CommunicationUserIdentifier, AddCommunicationUserOptions)	إضافة مشارك إلى هذه المكالمة.
addParticipant(MicrosoftTeamsAppIdentifier | UnknownIdentifier)	أضف تطبيق Teams إلى هذه المكالمة.
addParticipant(MicrosoftTeamsUserIdentifier, AddMicrosoftTeamsUserOptions)	إضافة مشارك إلى هذه المكالمة.
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)	إضافة مشارك إلى هذه المكالمة.
removeParticipant(CommunicationIdentifier)	إزالة مشارك من هذه المكالمة.

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

dispose()
feature<TFeature>(CallFeatureFactory<TFeature>)	استرداد كائن ميزة تمت تهيئته ومذكرته باستخدام واجهة برمجة تطبيقات موسعة. تحقق من ميزات الكائن.* لكافة ميزات الاتصال الموسعة المتوفرة في هذه الحزمة، على سبيل المثال: const call: Call = ...; call.feature(Features.Recording).isRecordingActive; call.feature(Features.Captions).startCaptions('en-us')
hangUp(HangUpOptions)	قطع المكالمة.
hold()	ضع هذه المكالمة قيد الانتظار.
mute()	كتم الميكروفون المحلي.
muteAllRemoteParticipants()	كتم صوت جميع المشاركين عن بعد.
muteIncomingAudio()	كتم الصوت الوارد.
off("idChanged", PropertyChangedEvent)	دالة إلغاء الاشتراك لحدث idChanged.
off("isIncomingAudioMutedChanged", PropertyChangedEvent)	قم بالاشتراك في دالة حدث isIncomingAudioMutedChanged.
off("isLocalVideoStartedChanged", PropertyChangedEvent)	دالة إلغاء الاشتراك لحدث isLocalVideoStartedChanged.
off("isMutedChanged", PropertyChangedEvent)	قم بالاشتراك في دالة حدث isMutedChanged.
off("isScreenSharingOnChanged", PropertyChangedEvent)	دالة إلغاء الاشتراك ل هي حدثScreenSharingChanged.
off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)	دالة إلغاء الاشتراك لحدث localAudioStreamsUpdated.
off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)	دالة إلغاء الاشتراك لحدث LocalVideoStreamsUpdated.
off("mutedByOthers", PropertyChangedEvent)	دالة إلغاء الاشتراك لحدث mutedByOthers.
off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)	دالة إلغاء الاشتراك لحدث remoteAudioStreamsUpdated.
off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	دالة إلغاء الاشتراك لحدث remoteParticipantsUpdated.
off("roleChanged", PropertyChangedEvent)	دالة إلغاء الاشتراك لحدث roleChanged.
off("stateChanged", PropertyChangedEvent)	دالة إلغاء الاشتراك لحدث stateChanged.
off("totalParticipantCountChanged", PropertyChangedEvent)	دالة إلغاء الاشتراك لحدث totalParticipantCountChanged.
on("idChanged", PropertyChangedEvent)	قم بالاشتراك في دالة حدث idChanged.
on("isIncomingAudioMutedChanged", PropertyChangedEvent)	قم بالاشتراك في دالة حدث isIncomingAudioMutedChanged.
on("isLocalVideoStartedChanged", PropertyChangedEvent)	قم بالاشتراك في دالة حدث isLocalVideoStartedChanged.
on("isMutedChanged", PropertyChangedEvent)	قم بالاشتراك في دالة حدث isMutedChanged.
on("isScreenSharingOnChanged", PropertyChangedEvent)	وظيفة الاشتراك ل هي حدثScreenSharingChanged.
on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)	قم بالاشتراك في دالة لحدث localAudioStreamsUpdated.
on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)	قم بالاشتراك في دالة حدث LocalVideoStreamsUpdated.
on("mutedByOthers", PropertyChangedEvent)	قم بالاشتراك في دالة لحدث mutedByOthers.
on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)	قم بالاشتراك في دالة لحدث remoteAudioStreamsUpdated.
on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	قم بالاشتراك في الدالة لحدث remoteParticipantsUpdated.
on("roleChanged", PropertyChangedEvent)	قم بالاشتراك في دالة حدث roleChanged.
on("stateChanged", PropertyChangedEvent)	قم بالاشتراك في دالة حدث stateChanged.
on("totalParticipantCountChanged", PropertyChangedEvent)	قم بالاشتراك في دالة حدث totalParticipantCountChanged.
resume()	استأنف هذه المكالمة إذا كانت في حالة "LocalHold".
sendDtmf(DtmfTone)	إرسال نغمة DTMF.
setConstraints(CallConstraints)	تعيين قيود الاتصال. يعين هذا الأسلوب الحد الأقصى للقيود استنادا إلى القيم المتوفرة. ستكون القيود المطبقة النهائية أقل من أو مساوية للقيم المتوفرة هنا لهذا الأسلوب. إذا تم توفير قيمة 0، فلن يتم تطبيق أي قيد على هذا القيد. إذا تم توفير قيمة غير معرفة، استخدام القيمة السابقة المستخدمة لهذا القيد.
startAudio(LocalAudioStream)	ابدأ تشغيل الصوت في المكالمة باستخدام صوت مخصص. يجب أن يكون مصدر LocalAudioStream MediaStream.
startScreenSharing()	ابدأ في إرسال دفق مشاركة الشاشة في مكالمة. سيطالب المستعرض بتحديد علامة تبويب الشاشة أو التطبيق أو المستعرض. إرسال دفق مشاركة الشاشة غير مدعوم على iOS أو Android. يتم دعم دفق مشاركة الشاشة الواردة على iOS وAndroid.
startScreenSharing(LocalVideoStream)	ابدأ في إرسال دفق مشاركة الشاشة الخام في مكالمة. إرسال مشاركة الشاشة الأولية غير مدعوم على iOS أو Android. يتم دعم مشاركة الشاشة الأولية الواردة على iOS وAndroid.
startVideo(LocalVideoStream)	ابدأ في إرسال دفق الفيديو في المكالمة. سيتلقى المشاركون عن بعد في المكالمة دفق الفيديو الخاص بك حتى يتمكنوا من عرضه في واجهات المستخدم الخاصة بهم.
stopAudio()	أوقف الصوت المخصص في المكالمة وقم بالتبديل إلى جهاز الصوت الافتراضي لإدارة الأجهزة.
stopScreenSharing()	إيقاف مشاركة الشاشة المحلية.
stopScreenSharing(LocalVideoStream)	إيقاف مشاركة الشاشة المحلية.
stopVideo(LocalVideoStream)	إيقاف إرسال دفق الفيديو في المكالمة. يجب تمرير نفس كائن LocalVideoStream الذي تم استخدامه لبدء الفيديو في واجهة برمجة تطبيقات CallAgent.startCall() أو CallAgent.join() API أو IncomingCall.accept() API أو Call.startVideo() API.
unmute()	إلغاء كتم الميكروفون المحلي.
unmuteIncomingAudio()	إلغاء كتم الصوت الوارد.

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

info

احصل على معلومات حول هذه المكالمة.

info: CallInfo

قيمة الخاصية

CallInfo

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

callEndReason

يحتوي على رمز/رمز فرعي يشير إلى كيفية انتهاء هذه المكالمة.

callEndReason?: CallEndReason

قيمة الخاصية

CallEndReason

موروث منCallCommon.callEndReason

callerInfo

معلومات المتصل إذا كانت هذه المكالمة واردة.

callerInfo: CallerInfo

قيمة الخاصية

CallerInfo

موروث منCallCommon.callerInfo

direction

احصل على اتجاه المكالمة، سواء كان واردا أو صادرا.

direction: CallDirection

قيمة الخاصية

CallDirection

موروث منCallCommon.direction

id

احصل على المعرف الفريد لهذه المكالمة.

id: string

قيمة الخاصية

string

موروث منCallCommon.id

isIncomingAudioMuted

ما إذا كان المستخدم المحلي قد كتم الصوت الوارد.

isIncomingAudioMuted: boolean

قيمة الخاصية

boolean

موروث منCallCommon.isIncomingAudioMuted

isLocalVideoStarted

ما إذا كان الفيديو المحلي قيد التشغيل.

isLocalVideoStarted: boolean

قيمة الخاصية

boolean

موروث منCallCommon.isLocalVideoStarted

isMuted

سواء تم كتم صوت المستخدم المحلي، محليا أو عن بعد.

isMuted: boolean

قيمة الخاصية

boolean

موروث منCallCommon.isMuted

isScreenSharingOn

ما إذا كانت مشاركة الشاشة قيد التشغيل.

isScreenSharingOn: boolean

قيمة الخاصية

boolean

موروث منCallCommon.isScreenSharingOn

kind

الحصول على نوع كائن الاستدعاء.

kind: CallKind

قيمة الخاصية

CallKind

موروث منCallCommon.kind

lobby

احصل على ساحة انتظار اجتماع Teams.

lobby: Lobby

قيمة الخاصية

Lobby

موروث منCallCommon.lobby

localAudioStreams

مجموعة من تدفقات الصوت المحلية التي يتم إرسالها إلى مشاركين آخرين في مكالمة.

localAudioStreams: readonly LocalAudioStream[]

قيمة الخاصية

readonly LocalAudioStream[]

موروث منCallCommon.localAudioStreams

localVideoStreams

مجموعة من تدفقات الفيديو المحلية التي يتم إرسالها إلى مشاركين آخرين في مكالمة.

localVideoStreams: readonly LocalVideoStream[]

قيمة الخاصية

readonly LocalVideoStream[]

موروث منCallCommon.localVideoStreams

remoteAudioStreams

مجموعة من تدفقات الصوت عن بعد التي يتم تلقيها من المكالمة.

remoteAudioStreams: readonly RemoteAudioStream[]

قيمة الخاصية

readonly RemoteAudioStream[]

موروث منCallCommon.remoteAudioStreams

remoteParticipants

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

remoteParticipants: readonly RemoteParticipant[]

قيمة الخاصية

readonly RemoteParticipant[]

موروث منCallCommon.remoteParticipants

role

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

role: ParticipantRole

قيمة الخاصية

ParticipantRole

موروث منCallCommon.role

state

احصل على حالة هذه المكالمة.

state: CallState

قيمة الخاصية

CallState

موروث من CallCommon.state

totalParticipantCount

ملاحظة

واجهة برمجة التطبيقات (API) هذا موجود في الإصدار بيتا ويتوفر كمعاينة للمطورين وقد يتغير بناءً على الملاحظات التي نستلمها. تجنب استخدام API هذه في بيئة الإنتاج.

عدد إجمالي عدد المشاركين في هذه المكالمة.

totalParticipantCount: number

قيمة الخاصية

number

موروث منCallCommon.totalParticipantCount

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

addParticipant(CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier)

إضافة مشارك إلى هذه المكالمة.

function addParticipant(identifier: CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier): RemoteParticipant

المعلمات

identifier

CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier

معرف المشارك المراد إضافته.

المرتجعات

RemoteParticipant

الكائن RemoteParticipant المقترن بالمشارك الذي تمت إضافته بنجاح.

addParticipant(CommunicationUserIdentifier, AddCommunicationUserOptions)

ملاحظة

واجهة برمجة التطبيقات (API) هذا موجود في الإصدار بيتا ويتوفر كمعاينة للمطورين وقد يتغير بناءً على الملاحظات التي نستلمها. تجنب استخدام API هذه في بيئة الإنتاج.

إضافة مشارك إلى هذه المكالمة.

function addParticipant(identifier: CommunicationUserIdentifier, options?: AddCommunicationUserOptions): RemoteParticipant

المعلمات

identifier

CommunicationUserIdentifier

معرف المشارك المراد إضافته.

options

AddCommunicationUserOptions

خيارات إضافية لإدارة المكالمة.

المرتجعات

RemoteParticipant

الكائن RemoteParticipant المقترن بالمشارك الذي تمت إضافته بنجاح.

addParticipant(MicrosoftTeamsAppIdentifier | UnknownIdentifier)

ملاحظة

واجهة برمجة التطبيقات (API) هذا موجود في الإصدار بيتا ويتوفر كمعاينة للمطورين وقد يتغير بناءً على الملاحظات التي نستلمها. تجنب استخدام API هذه في بيئة الإنتاج.

أضف تطبيق Teams إلى هذه المكالمة.

function addParticipant(identifier: MicrosoftTeamsAppIdentifier | UnknownIdentifier): RemoteParticipant

المعلمات

identifier

MicrosoftTeamsAppIdentifier | UnknownIdentifier

معرف تطبيق Teams المراد إضافته.

المرتجعات

RemoteParticipant

الكائن RemoteParticipant المقترن بتطبيق Teams الذي تمت إضافته بنجاح.

addParticipant(MicrosoftTeamsUserIdentifier, AddMicrosoftTeamsUserOptions)

ملاحظة

واجهة برمجة التطبيقات (API) هذا موجود في الإصدار بيتا ويتوفر كمعاينة للمطورين وقد يتغير بناءً على الملاحظات التي نستلمها. تجنب استخدام API هذه في بيئة الإنتاج.

إضافة مشارك إلى هذه المكالمة.

function addParticipant(identifier: MicrosoftTeamsUserIdentifier, options: AddMicrosoftTeamsUserOptions): RemoteParticipant

المعلمات

identifier

MicrosoftTeamsUserIdentifier

معرف المشارك المراد إضافته.

options

AddMicrosoftTeamsUserOptions

خيارات إضافية لإدارة المكالمة.

المرتجعات

RemoteParticipant

الكائن RemoteParticipant المقترن بالمشارك الذي تمت إضافته بنجاح.

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

إضافة مشارك إلى هذه المكالمة.

function addParticipant(identifier: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): RemoteParticipant

المعلمات

identifier

PhoneNumberIdentifier

معرف المشارك المراد إضافته.

options

AddPhoneNumberOptions

خيارات إضافية لإدارة مكالمة PSTN. على سبيل المثال، تعيين رقم هاتف معرف المتصل في مكالمة PSTN.

المرتجعات

RemoteParticipant

الكائن RemoteParticipant المقترن بالمشارك الذي تمت إضافته بنجاح.

removeParticipant(CommunicationIdentifier)

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

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

المعلمات

identifier

CommunicationIdentifier

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

المرتجعات

Promise<void>

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

dispose()

function dispose()

موروث منCallCommon.dispose

feature<TFeature>(CallFeatureFactory<TFeature>)

استرداد كائن ميزة تمت تهيئته ومذكرته باستخدام واجهة برمجة تطبيقات موسعة. تحقق من ميزات الكائن.* لكافة ميزات الاتصال الموسعة المتوفرة في هذه الحزمة، على سبيل المثال:

const call: Call = ...;
call.feature(Features.Recording).isRecordingActive;
call.feature(Features.Captions).startCaptions('en-us')

function feature<TFeature>(factory: CallFeatureFactory<TFeature>): TFeature

المعلمات

factory

CallFeatureFactory<TFeature>

مصنع منشئ ميزة الاستدعاء الذي يوفر واجهة برمجة تطبيقات موسعة.

المرتجعات

TFeature

موروث منCallCommon.feature

hangUp(HangUpOptions)

قطع المكالمة.

function hangUp(options?: HangUpOptions): Promise<void>

المعلمات

options

HangUpOptions

خيارات HangUp.

المرتجعات

Promise<void>

موروث منCallCommon.hangUp

hold()

ضع هذه المكالمة قيد الانتظار.

function hold(): Promise<void>

المرتجعات

Promise<void>

موروث منCallCommon.hold

mute()

كتم الميكروفون المحلي.

function mute(): Promise<void>

المرتجعات

Promise<void>

موروث منCallCommon.mute

muteAllRemoteParticipants()

كتم صوت جميع المشاركين عن بعد.

function muteAllRemoteParticipants(): Promise<void>

المرتجعات

Promise<void>

موروث منCallCommon.muteAllRemoteParticipants

muteIncomingAudio()

كتم الصوت الوارد.

function muteIncomingAudio(): Promise<void>

المرتجعات

Promise<void>

موروث منCallCommon.muteIncomingAudio

off("idChanged", PropertyChangedEvent)

دالة إلغاء الاشتراك لحدث idChanged.

function off(event: "idChanged", listener: PropertyChangedEvent)

المعلمات

event

"idChanged"

اسم الحدث.

listener

PropertyChangedEvent

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

موروث منCallCommon.off

off("isIncomingAudioMutedChanged", PropertyChangedEvent)

قم بالاشتراك في دالة حدث isIncomingAudioMutedChanged.

function off(event: "isIncomingAudioMutedChanged", listener: PropertyChangedEvent)

المعلمات

event

"isIncomingAudioMutedChanged"

اسم الحدث.

listener

PropertyChangedEvent

fn رد الاتصال الذي سيتم استدعاؤه عند تغيير قيمة هذه الخاصية.

موروث منCallCommon.off

off("isLocalVideoStartedChanged", PropertyChangedEvent)

دالة إلغاء الاشتراك لحدث isLocalVideoStartedChanged.

function off(event: "isLocalVideoStartedChanged", listener: PropertyChangedEvent)

المعلمات

event

"isLocalVideoStartedChanged"

اسم الحدث.

listener

PropertyChangedEvent

fn رد الاتصال الذي سيتم استدعاؤه عند تغيير قيمة هذه الخاصية.

موروث منCallCommon.off

off("isMutedChanged", PropertyChangedEvent)

قم بالاشتراك في دالة حدث isMutedChanged.

function off(event: "isMutedChanged", listener: PropertyChangedEvent)

المعلمات

event

"isMutedChanged"

اسم الحدث.

listener

PropertyChangedEvent

fn رد الاتصال الذي سيتم استدعاؤه عند تغيير قيمة هذه الخاصية.

موروث منCallCommon.off

off("isScreenSharingOnChanged", PropertyChangedEvent)

دالة إلغاء الاشتراك ل هي حدثScreenSharingChanged.

function off(event: "isScreenSharingOnChanged", listener: PropertyChangedEvent)

المعلمات

event

"isScreenSharingOnChanged"

اسم الحدث.

listener

PropertyChangedEvent

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

موروث منCallCommon.off

off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

دالة إلغاء الاشتراك لحدث localAudioStreamsUpdated.

function off(event: "localAudioStreamsUpdated", listener: CollectionUpdatedEvent<LocalAudioStream>)

المعلمات

event

"localAudioStreamsUpdated"

اسم الحدث.

listener

CollectionUpdatedEvent<LocalAudioStream>

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

موروث منCallCommon.off

off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

دالة إلغاء الاشتراك لحدث LocalVideoStreamsUpdated.

function off(event: "localVideoStreamsUpdated", listener: CollectionUpdatedEvent<LocalVideoStream>)

المعلمات

event

"localVideoStreamsUpdated"

اسم الحدث.

listener

CollectionUpdatedEvent<LocalVideoStream>

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

موروث منCallCommon.off

off("mutedByOthers", PropertyChangedEvent)

دالة إلغاء الاشتراك لحدث mutedByOthers.

function off(event: "mutedByOthers", listener: PropertyChangedEvent)

المعلمات

event

"mutedByOthers"

اسم الحدث.

listener

PropertyChangedEvent

fn رد الاتصال الذي تم استخدامه لإلغاء الاشتراك في هذا الحدث.

موروث منCallCommon.off

off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

دالة إلغاء الاشتراك لحدث remoteAudioStreamsUpdated.

function off(event: "remoteAudioStreamsUpdated", listener: CollectionUpdatedEvent<RemoteAudioStream>)

المعلمات

event

"remoteAudioStreamsUpdated"

اسم الحدث.

listener

CollectionUpdatedEvent<RemoteAudioStream>

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

موروث منCallCommon.off

off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

دالة إلغاء الاشتراك لحدث remoteParticipantsUpdated.

function off(event: "remoteParticipantsUpdated", listener: CollectionUpdatedEvent<RemoteParticipant>)

المعلمات

event

"remoteParticipantsUpdated"

اسم الحدث.

listener

CollectionUpdatedEvent<RemoteParticipant>

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

موروث منCallCommon.off

off("roleChanged", PropertyChangedEvent)

دالة إلغاء الاشتراك لحدث roleChanged.

function off(event: "roleChanged", listener: PropertyChangedEvent)

المعلمات

event

"roleChanged"

اسم الحدث.

listener

PropertyChangedEvent

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

موروث منCallCommon.off

off("stateChanged", PropertyChangedEvent)

دالة إلغاء الاشتراك لحدث stateChanged.

function off(event: "stateChanged", listener: PropertyChangedEvent)

المعلمات

event

"stateChanged"

اسم الحدث.

listener

PropertyChangedEvent

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

موروث منCallCommon.off

off("totalParticipantCountChanged", PropertyChangedEvent)

ملاحظة

واجهة برمجة التطبيقات (API) هذا موجود في الإصدار بيتا ويتوفر كمعاينة للمطورين وقد يتغير بناءً على الملاحظات التي نستلمها. تجنب استخدام API هذه في بيئة الإنتاج.

دالة إلغاء الاشتراك لحدث totalParticipantCountChanged.

function off(event: "totalParticipantCountChanged", listener: PropertyChangedEvent)

المعلمات

event

"totalParticipantCountChanged"

اسم الحدث.

listener

PropertyChangedEvent

fn رد الاتصال الذي سيتم استدعاؤه عند تغيير عدد المشاركين.

موروث منCallCommon.off

on("idChanged", PropertyChangedEvent)

قم بالاشتراك في دالة حدث idChanged.

function on(event: "idChanged", listener: PropertyChangedEvent)

المعلمات

event

"idChanged"

اسم الحدث.

listener

PropertyChangedEvent

fn رد الاتصال الذي سيتم استدعاؤه عند تغيير قيمة هذه الخاصية.

موروث منCallCommon.on

on("isIncomingAudioMutedChanged", PropertyChangedEvent)

قم بالاشتراك في دالة حدث isIncomingAudioMutedChanged.

function on(event: "isIncomingAudioMutedChanged", listener: PropertyChangedEvent)

المعلمات

event

"isIncomingAudioMutedChanged"

اسم الحدث.

listener

PropertyChangedEvent

fn رد الاتصال الذي سيتم استدعاؤه عند تغيير قيمة هذه الخاصية.

موروث منCallCommon.on

on("isLocalVideoStartedChanged", PropertyChangedEvent)

قم بالاشتراك في دالة حدث isLocalVideoStartedChanged.

function on(event: "isLocalVideoStartedChanged", listener: PropertyChangedEvent)

المعلمات

event

"isLocalVideoStartedChanged"

اسم الحدث.

listener

PropertyChangedEvent

fn رد الاتصال الذي سيتم استدعاؤه عند تغيير قيمة هذه الخاصية.

موروث منCallCommon.on

on("isMutedChanged", PropertyChangedEvent)

قم بالاشتراك في دالة حدث isMutedChanged.

function on(event: "isMutedChanged", listener: PropertyChangedEvent)

المعلمات

event

"isMutedChanged"

اسم الحدث.

listener

PropertyChangedEvent

fn رد الاتصال الذي سيتم استدعاؤه عند تغيير قيمة هذه الخاصية.

موروث منCallCommon.on

on("isScreenSharingOnChanged", PropertyChangedEvent)

وظيفة الاشتراك ل هي حدثScreenSharingChanged.

function on(event: "isScreenSharingOnChanged", listener: PropertyChangedEvent)

المعلمات

event

"isScreenSharingOnChanged"

اسم الحدث.

listener

PropertyChangedEvent

fn رد الاتصال الذي سيتم استدعاؤه عند تغيير قيمة هذه الخاصية.

موروث منCallCommon.on

on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

قم بالاشتراك في دالة لحدث localAudioStreamsUpdated.

function on(event: "localAudioStreamsUpdated", listener: CollectionUpdatedEvent<LocalAudioStream>)

المعلمات

event

"localAudioStreamsUpdated"

اسم الحدث.

listener

CollectionUpdatedEvent<LocalAudioStream>

fn رد الاتصال الذي سيتم استدعاؤه عند تغيير هذه المجموعة، سيمرر صفائف من العناصر المضافة والمزالة.

موروث منCallCommon.on

on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

قم بالاشتراك في دالة حدث LocalVideoStreamsUpdated.

function on(event: "localVideoStreamsUpdated", listener: CollectionUpdatedEvent<LocalVideoStream>)

المعلمات

event

"localVideoStreamsUpdated"

اسم الحدث.

listener

CollectionUpdatedEvent<LocalVideoStream>

fn رد الاتصال الذي سيتم استدعاؤه عند تغيير هذه المجموعة، سيمرر صفائف من العناصر المضافة والمزالة.

موروث منCallCommon.on

on("mutedByOthers", PropertyChangedEvent)

قم بالاشتراك في دالة لحدث mutedByOthers.

function on(event: "mutedByOthers", listener: PropertyChangedEvent)

المعلمات

event

"mutedByOthers"

اسم الحدث.

listener

PropertyChangedEvent

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

موروث منCallCommon.on

on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

قم بالاشتراك في دالة لحدث remoteAudioStreamsUpdated.

function on(event: "remoteAudioStreamsUpdated", listener: CollectionUpdatedEvent<RemoteAudioStream>)

المعلمات

event

"remoteAudioStreamsUpdated"

اسم الحدث.

listener

CollectionUpdatedEvent<RemoteAudioStream>

fn رد الاتصال الذي سيتم استدعاؤه عند تغيير هذه المجموعة، سيمرر صفائف من العناصر المضافة والمزالة.

موروث منCallCommon.on

on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

قم بالاشتراك في الدالة لحدث remoteParticipantsUpdated.

function on(event: "remoteParticipantsUpdated", listener: CollectionUpdatedEvent<RemoteParticipant>)

المعلمات

event

"remoteParticipantsUpdated"

اسم الحدث.

listener

CollectionUpdatedEvent<RemoteParticipant>

fn رد الاتصال الذي سيتم استدعاؤه عند تغيير هذه المجموعة، سيمرر صفائف من العناصر المضافة والمزالة.

موروث منCallCommon.on

on("roleChanged", PropertyChangedEvent)

قم بالاشتراك في دالة حدث roleChanged.

function on(event: "roleChanged", listener: PropertyChangedEvent)

المعلمات

event

"roleChanged"

اسم الحدث.

listener

PropertyChangedEvent

fn رد الاتصال الذي سيتم استدعاؤه عند تغيير قيمة هذه الخاصية.

موروث منCallCommon.on

on("stateChanged", PropertyChangedEvent)

قم بالاشتراك في دالة حدث stateChanged.

function on(event: "stateChanged", listener: PropertyChangedEvent)

المعلمات

event

"stateChanged"

اسم الحدث.

listener

PropertyChangedEvent

fn رد الاتصال الذي سيتم استدعاؤه عند تغيير قيمة هذه الخاصية.

موروث منCallCommon.on

on("totalParticipantCountChanged", PropertyChangedEvent)

ملاحظة

واجهة برمجة التطبيقات (API) هذا موجود في الإصدار بيتا ويتوفر كمعاينة للمطورين وقد يتغير بناءً على الملاحظات التي نستلمها. تجنب استخدام API هذه في بيئة الإنتاج.

قم بالاشتراك في دالة حدث totalParticipantCountChanged.

function on(event: "totalParticipantCountChanged", listener: PropertyChangedEvent)

المعلمات

event

"totalParticipantCountChanged"

اسم الحدث.

listener

PropertyChangedEvent

fn رد الاتصال الذي سيتم استدعاؤه عند تغيير عدد المشاركين.

موروث منCallCommon.on

resume()

استأنف هذه المكالمة إذا كانت في حالة "LocalHold".

function resume(): Promise<void>

المرتجعات

Promise<void>

موروث منCallCommon.resume

sendDtmf(DtmfTone)

إرسال نغمة DTMF.

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

المعلمات

dtmfTone

DtmfTone

المرتجعات

Promise<void>

موروث منCallCommon.sendDtmf

setConstraints(CallConstraints)

تعيين قيود الاتصال. يعين هذا الأسلوب الحد الأقصى للقيود استنادا إلى القيم المتوفرة. ستكون القيود المطبقة النهائية أقل من أو مساوية للقيم المتوفرة هنا لهذا الأسلوب. إذا تم توفير قيمة 0، فلن يتم تطبيق أي قيد على هذا القيد. إذا تم توفير قيمة غير معرفة، استخدام القيمة السابقة المستخدمة لهذا القيد.

function setConstraints(constraints: CallConstraints): Promise<void>

المعلمات

constraints

CallConstraints

كائن يمثل قيود الاستدعاء لتعيينها

المرتجعات

Promise<void>

موروثة منCallCommon.setConstraints

startAudio(LocalAudioStream)

ابدأ تشغيل الصوت في المكالمة باستخدام صوت مخصص. يجب أن يكون مصدر LocalAudioStream MediaStream.

function startAudio(localAudioStream: LocalAudioStream): Promise<void>

المعلمات

localAudioStream

LocalAudioStream

المرتجعات

Promise<void>

موروث منCallCommon.startAudio

startScreenSharing()

• ابدأ في إرسال دفق مشاركة الشاشة في مكالمة. سيطالب المستعرض بتحديد علامة تبويب الشاشة أو التطبيق أو المستعرض.
• إرسال دفق مشاركة الشاشة غير مدعوم على iOS أو Android.
• يتم دعم دفق مشاركة الشاشة الواردة على iOS وAndroid.

function startScreenSharing(): Promise<void>

المرتجعات

Promise<void>

موروث منCallCommon.startScreenSharing

startScreenSharing(LocalVideoStream)

ملاحظة

واجهة برمجة التطبيقات (API) هذا موجود في الإصدار بيتا ويتوفر كمعاينة للمطورين وقد يتغير بناءً على الملاحظات التي نستلمها. تجنب استخدام API هذه في بيئة الإنتاج.

• ابدأ في إرسال دفق مشاركة الشاشة الخام في مكالمة.
• إرسال مشاركة الشاشة الأولية غير مدعوم على iOS أو Android.
• يتم دعم مشاركة الشاشة الأولية الواردة على iOS وAndroid.

function startScreenSharing(localVideoStream: LocalVideoStream): Promise<void>

المعلمات

localVideoStream

LocalVideoStream

يمثل دفق مشاركة الشاشة الخام المحلي الذي يأخذ MediaStream في الدالة الإنشائية.

المرتجعات

Promise<void>

موروث منCallCommon.startScreenSharing

startVideo(LocalVideoStream)

ابدأ في إرسال دفق الفيديو في المكالمة. سيتلقى المشاركون عن بعد في المكالمة دفق الفيديو الخاص بك حتى يتمكنوا من عرضه في واجهات المستخدم الخاصة بهم.

function startVideo(localVideoStream: LocalVideoStream): Promise<void>

المعلمات

localVideoStream

LocalVideoStream

يمثل دفق فيديو محليا يأخذ مصدر كاميرا في الدالة الإنشائية.

المرتجعات

Promise<void>

موروث منCallCommon.startVideo

stopAudio()

أوقف الصوت المخصص في المكالمة وقم بالتبديل إلى جهاز الصوت الافتراضي لإدارة الأجهزة.

function stopAudio()

موروث منCallCommon.stopAudio

stopScreenSharing()

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

function stopScreenSharing(): Promise<void>

المرتجعات

Promise<void>

موروث منCallCommon.stopScreenSharing

stopScreenSharing(LocalVideoStream)

ملاحظة

واجهة برمجة التطبيقات (API) هذا موجود في الإصدار بيتا ويتوفر كمعاينة للمطورين وقد يتغير بناءً على الملاحظات التي نستلمها. تجنب استخدام API هذه في بيئة الإنتاج.

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

function stopScreenSharing(localVideoStream: LocalVideoStream): Promise<void>

المعلمات

localVideoStream

LocalVideoStream

دفق مشاركة الشاشة المحلية لإيقاف البث.

المرتجعات

Promise<void>

موروث منCallCommon.stopScreenSharing

stopVideo(LocalVideoStream)

إيقاف إرسال دفق الفيديو في المكالمة. يجب تمرير نفس كائن LocalVideoStream الذي تم استخدامه لبدء الفيديو في واجهة برمجة تطبيقات CallAgent.startCall() أو CallAgent.join() API أو IncomingCall.accept() API أو Call.startVideo() API.

function stopVideo(localVideoStream: LocalVideoStream): Promise<void>

المعلمات

localVideoStream

LocalVideoStream

دفق الفيديو المحلي لإيقاف البث.

المرتجعات

Promise<void>

موروث منCallCommon.stopVideo

unmute()

إلغاء كتم الميكروفون المحلي.

function unmute(): Promise<void>

المرتجعات

Promise<void>

موروث منCallCommon.unmute

unmuteIncomingAudio()

إلغاء كتم الصوت الوارد.

function unmuteIncomingAudio(): Promise<void>

المرتجعات

Promise<void>

موروث منCallCommon.unmuteIncomingAudio