CaptionsCommon interface
بنية البيانات لكائن CaptionsCommon
الخصائص
active |
الإشارة إلى اللغة المنطوقة النشطة الحالية في المكالمة بتنسيق BCP 47 |
is |
يشير إلى ما إذا كانت التسميات التوضيحية نشطة في المكالمة الحالية |
kind | يشير إلى نوع التسميات التوضيحية لكائن التسميات التوضيحية النشطة |
supported |
قائمة اللغات المنطوقة المدعومة لاستخدامها مع خدمة التسمية التوضيحية بتنسيق BCP 47 |
الأساليب
set |
تحديث لغة النسخ / التسميات التوضيحية المستمرة |
start |
بدء معالجة التسميات التوضيحية في هذا الاستدعاء باستخدام المعالج المتوفر لهذا العميل |
stop |
إيقاف استرداد بيانات التسميات التوضيحية في استدعاء المستخدم الذي بدأ stopCaptions |
تفاصيل الخاصية
activeSpokenLanguage
الإشارة إلى اللغة المنطوقة النشطة الحالية في المكالمة بتنسيق BCP 47
activeSpokenLanguage: string
قيمة الخاصية
string
isCaptionsFeatureActive
يشير إلى ما إذا كانت التسميات التوضيحية نشطة في المكالمة الحالية
isCaptionsFeatureActive: boolean
قيمة الخاصية
boolean
kind
يشير إلى نوع التسميات التوضيحية لكائن التسميات التوضيحية النشطة
kind: CaptionsKind
قيمة الخاصية
supportedSpokenLanguages
قائمة اللغات المنطوقة المدعومة لاستخدامها مع خدمة التسمية التوضيحية بتنسيق BCP 47
supportedSpokenLanguages: string[]
قيمة الخاصية
string[]
تفاصيل الأسلوب
setSpokenLanguage(string)
تحديث لغة النسخ / التسميات التوضيحية المستمرة
function setSpokenLanguage(language: string): Promise<void>
المعلمات
- language
-
string
لغة الكلام التوضيحي ك. يجب أن يكون تنسيق BCP 47 (على سبيل المثال"en-us")
المرتجعات
Promise<void>
وعد يمثل إكمال عملية تعيين اللغة. لا يشير إكمال هذا الوعد إلى أن اللغة قد تغيرت. سيتم إصدار حدث "SpokenLanguageChanged" عندما تتغير اللغة بنجاح.
startCaptions(StartCaptionsOptions)
بدء معالجة التسميات التوضيحية في هذا الاستدعاء باستخدام المعالج المتوفر لهذا العميل
function startCaptions(startCaptionsOptions?: StartCaptionsOptions): Promise<void>
المعلمات
- startCaptionsOptions
- StartCaptionsOptions
خيارات إضافية لبدء التسميات التوضيحية.
المرتجعات
Promise<void>
وعد يمثل إكمال عملية التعريف لعملية بدء التسمية التوضيحية لا يشير إكمال هذا الوعد إلى بدء التسميات التوضيحية. سيتم إصدار حدث "CaptionsActiveChanged" عند بدء تشغيل التسميات التوضيحية بنجاح.
stopCaptions()
إيقاف استرداد بيانات التسميات التوضيحية في استدعاء المستخدم الذي بدأ stopCaptions
function stopCaptions(): Promise<void>
المرتجعات
Promise<void>
وعد يمثل إكمال عملية إيقاف التسمية التوضيحية لا يشير إكمال هذا الوعد إلى أن روبوت التسميات التوضيحية قد ترك المكالمة. سيقوم المشارك بإلغاء الاشتراك من تلقي بيانات التسميات التوضيحية عند إيقافها بنجاح.