Captions interface

الحزمة:

@azure/communication-calling

ملاحظة

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

بنية البيانات لكائن التسميات التوضيحية

Extends

CaptionsCommon

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

activeSpokenLanguage	يشير إلى اللغة المنطوقة النشطة الحالية في المكالمة بتنسيق BCP 47
isCaptionsFeatureActive	يشير إلى ما إذا كانت التسميات التوضيحية نشطة في المكالمة الحالية
kind	يشير إلى نوع التسميات التوضيحية لكائن التسميات التوضيحية النشطة
supportedSpokenLanguages	قائمة باللغات المنطوقة المدعومة لاستخدامها مع خدمة التسمية التوضيحية بتنسيق BCP 47

الأساليب

off("CaptionsActiveChanged", PropertyChangedEvent)	إلغاء الاشتراك في أي من أحداث CaptionsPropertyChangedEventType
off("CaptionsReceived", CaptionsHandler)	إلغاء الاشتراك في أي من أحداث CaptionsPropertyChangedEventType
off("SpokenLanguageChanged", PropertyChangedEvent)	إلغاء الاشتراك في أي من أحداث SpokenLanguageChangedEventType
on("CaptionsActiveChanged", PropertyChangedEvent)	وظيفة الاشتراك لأي من أحداث CaptionsPropertyChangedEventType
on("CaptionsReceived", CaptionsHandler)	وظيفة الاشتراك لحدث CaptionsReceivedEventType
on("SpokenLanguageChanged", PropertyChangedEvent)	وظيفة الاشتراك لأي من أحداث SpokenLanguageChangedEventType

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

setSpokenLanguage(string)	التحديثات لغة النسخ / التسميات التوضيحية المستمرة
startCaptions(StartCaptionsOptions)	بدء معالجة التسميات التوضيحية في هذا الاستدعاء باستخدام المعالج المتوفر لهذا العميل
stopCaptions()	إيقاف استرداد بيانات التسميات التوضيحية في استدعاء المستخدم الذي بدأ stopCaptions

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

activeSpokenLanguage

يشير إلى اللغة المنطوقة النشطة الحالية في المكالمة بتنسيق BCP 47

activeSpokenLanguage: string

قيمة الخاصية

string

موروث منCaptionsCommon.activeSpokenLanguage

isCaptionsFeatureActive

يشير إلى ما إذا كانت التسميات التوضيحية نشطة في المكالمة الحالية

isCaptionsFeatureActive: boolean

قيمة الخاصية

boolean

موروث منCaptionsCommon.isCaptionsFeatureActive

kind

يشير إلى نوع التسميات التوضيحية لكائن التسميات التوضيحية النشطة

kind: CaptionsKind

قيمة الخاصية

CaptionsKind

موروث منCaptionsCommon.kind

supportedSpokenLanguages

قائمة باللغات المنطوقة المدعومة لاستخدامها مع خدمة التسمية التوضيحية بتنسيق BCP 47

supportedSpokenLanguages: string[]

قيمة الخاصية

string[]

موروث منCaptionsCommon.supportedSpokenLanguages

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

off("CaptionsActiveChanged", PropertyChangedEvent)

إلغاء الاشتراك في أي من أحداث CaptionsPropertyChangedEventType

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

المعلمات

event

"CaptionsActiveChanged"

اسم الحدث

listener

PropertyChangedEvent

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

off("CaptionsReceived", CaptionsHandler)

إلغاء الاشتراك في أي من أحداث CaptionsPropertyChangedEventType

function off(event: "CaptionsReceived", listener: CaptionsHandler)

المعلمات

event

"CaptionsReceived"

اسم الحدث

listener

CaptionsHandler

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

off("SpokenLanguageChanged", PropertyChangedEvent)

إلغاء الاشتراك في أي من أحداث SpokenLanguageChangedEventType

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

المعلمات

event

"SpokenLanguageChanged"

اسم الحدث

listener

PropertyChangedEvent

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

on("CaptionsActiveChanged", PropertyChangedEvent)

وظيفة الاشتراك لأي من أحداث CaptionsPropertyChangedEventType

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

المعلمات

event

"CaptionsActiveChanged"

اسم الحدث

listener

PropertyChangedEvent

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

on("CaptionsReceived", CaptionsHandler)

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

function on(event: "CaptionsReceived", listener: CaptionsHandler)

المعلمات

event

"CaptionsReceived"

اسم الحدث

listener

CaptionsHandler

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

on("SpokenLanguageChanged", PropertyChangedEvent)

وظيفة الاشتراك لأي من أحداث SpokenLanguageChangedEventType

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

المعلمات

event

"SpokenLanguageChanged"

اسم الحدث

listener

PropertyChangedEvent

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

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

setSpokenLanguage(string)

التحديثات لغة النسخ / التسميات التوضيحية المستمرة

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

المعلمات

language

string

لغة الكلام التوضيحي ك. يجب أن يكون تنسيق BCP 47 (مثل "en-us")

المرتجعات

Promise<void>

وعد يمثل إكمال عملية تعيين اللغة. لا يشير إكمال هذا الوعد إلى أن اللغة قد تغيرت. سيتم إصدار حدث "SpokenLanguageChanged" عندما تتغير اللغة بنجاح.

موروث منCaptionsCommon.setSpokenLanguage

startCaptions(StartCaptionsOptions)

بدء معالجة التسميات التوضيحية في هذا الاستدعاء باستخدام المعالج المتوفر لهذا العميل

function startCaptions(startCaptionsOptions?: StartCaptionsOptions): Promise<void>

المعلمات

startCaptionsOptions

StartCaptionsOptions

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

المرتجعات

Promise<void>

وعد يمثل إكمال عملية التعريف لعملية بدء التسمية التوضيحية لا يشير إكمال هذا الوعد إلى بدء التسميات التوضيحية. سيتم إصدار حدث "CaptionsActiveChanged" عند بدء التسميات التوضيحية بنجاح بالفعل.

موروث منCaptionsCommon.startCaptions

stopCaptions()

إيقاف استرداد بيانات التسميات التوضيحية في استدعاء المستخدم الذي بدأ stopCaptions

function stopCaptions(): Promise<void>

المرتجعات

Promise<void>

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

موروث منCaptionsCommon.stopCaptions