TeamsCaptions interface
بنية البيانات لكائن TeamsCaptions
- يمتد
الخصائص
active |
الإشارة إلى لغة التسمية التوضيحية النشطة الحالية بتنسيق ISO 639-1 |
supported |
قائمة لغات التسمية التوضيحية المعتمدة لاستخدامها مع خدمة التسمية التوضيحية بتنسيق ISO 639-1 |
الخصائص الموروثة
active |
الإشارة إلى اللغة المنطوقة النشطة الحالية في المكالمة بتنسيق BCP 47 |
is |
يشير إلى ما إذا كانت التسميات التوضيحية نشطة في المكالمة الحالية |
kind | يشير إلى نوع التسميات التوضيحية لكائن التسميات التوضيحية النشطة |
supported |
قائمة اللغات المنطوقة المدعومة لاستخدامها مع خدمة التسمية التوضيحية بتنسيق BCP 47 |
الأساليب
off("Caption |
إلغاء اشتراك الدالة لأي من أحداث CaptionLanguageChangedEventType |
off("Captions |
دالة إلغاء الاشتراك لأي من أحداث CaptionsPropertyChangedEventType |
off("Captions |
دالة إلغاء الاشتراك لأي من أحداث CaptionsPropertyChangedEventType |
off("Spoken |
إلغاء الاشتراك في أي من أحداث SpokenLanguageChangedEventType |
on("Caption |
قم بالاشتراك في الدالة لأي من أحداث CaptionLanguageChangedEventType |
on("Captions |
قم بالاشتراك في الدالة لأي من أحداث CaptionsPropertyChangedEventType |
on("Captions |
وظيفة الاشتراك للحدث CaptionsReceivedEventType |
on("Spoken |
قم بالاشتراك في الدالة لأي من أحداث SpokenLanguageChangedEventType |
set |
تحديث لغة النسخ / التسميات التوضيحية المستمرة |
الأساليب المتوارثة
set |
تحديث لغة النسخ / التسميات التوضيحية المستمرة |
start |
بدء معالجة التسميات التوضيحية في هذا الاستدعاء باستخدام المعالج المتوفر لهذا العميل |
stop |
إيقاف استرداد بيانات التسميات التوضيحية في استدعاء المستخدم الذي بدأ stopCaptions |
تفاصيل الخاصية
activeCaptionLanguage
الإشارة إلى لغة التسمية التوضيحية النشطة الحالية بتنسيق ISO 639-1
activeCaptionLanguage: string
قيمة الخاصية
string
supportedCaptionLanguages
قائمة لغات التسمية التوضيحية المعتمدة لاستخدامها مع خدمة التسمية التوضيحية بتنسيق ISO 639-1
supportedCaptionLanguages: string[]
قيمة الخاصية
string[]
تفاصيل الخاصية الموروثة
activeSpokenLanguage
الإشارة إلى اللغة المنطوقة النشطة الحالية في المكالمة بتنسيق BCP 47
activeSpokenLanguage: string
قيمة الخاصية
string
isCaptionsFeatureActive
يشير إلى ما إذا كانت التسميات التوضيحية نشطة في المكالمة الحالية
isCaptionsFeatureActive: boolean
قيمة الخاصية
boolean
kind
يشير إلى نوع التسميات التوضيحية لكائن التسميات التوضيحية النشطة
kind: CaptionsKind
قيمة الخاصية
موروث منCaptionsCommon.kind
supportedSpokenLanguages
قائمة اللغات المنطوقة المدعومة لاستخدامها مع خدمة التسمية التوضيحية بتنسيق BCP 47
supportedSpokenLanguages: string[]
قيمة الخاصية
string[]
تفاصيل الأسلوب
off("CaptionLanguageChanged", PropertyChangedEvent)
إلغاء اشتراك الدالة لأي من أحداث CaptionLanguageChangedEventType
function off(event: "CaptionLanguageChanged", listener: PropertyChangedEvent)
المعلمات
- event
-
"CaptionLanguageChanged"
اسم الحدث
- listener
- PropertyChangedEvent
fn رد الاتصال الذي تم استخدامه للاشتراك في هذا الحدث
off("CaptionsActiveChanged", PropertyChangedEvent)
دالة إلغاء الاشتراك لأي من أحداث CaptionsPropertyChangedEventType
function off(event: "CaptionsActiveChanged", listener: PropertyChangedEvent)
المعلمات
- event
-
"CaptionsActiveChanged"
اسم الحدث
- listener
- PropertyChangedEvent
fn رد الاتصال الذي تم استخدامه للاشتراك في هذا الحدث
off("CaptionsReceived", TeamsCaptionsHandler)
دالة إلغاء الاشتراك لأي من أحداث CaptionsPropertyChangedEventType
function off(event: "CaptionsReceived", listener: TeamsCaptionsHandler)
المعلمات
- event
-
"CaptionsReceived"
اسم الحدث
- listener
- TeamsCaptionsHandler
fn رد الاتصال الذي تم استخدامه للاشتراك في هذا الحدث
off("SpokenLanguageChanged", PropertyChangedEvent)
إلغاء الاشتراك في أي من أحداث SpokenLanguageChangedEventType
function off(event: "SpokenLanguageChanged", listener: PropertyChangedEvent)
المعلمات
- event
-
"SpokenLanguageChanged"
اسم الحدث
- listener
- PropertyChangedEvent
fn رد الاتصال الذي تم استخدامه للاشتراك في هذا الحدث
on("CaptionLanguageChanged", PropertyChangedEvent)
قم بالاشتراك في الدالة لأي من أحداث CaptionLanguageChangedEventType
function on(event: "CaptionLanguageChanged", listener: PropertyChangedEvent)
المعلمات
- event
-
"CaptionLanguageChanged"
اسم الحدث
- listener
- PropertyChangedEvent
fn رد الاتصال الذي تم استخدامه للاشتراك في هذا الحدث
on("CaptionsActiveChanged", PropertyChangedEvent)
قم بالاشتراك في الدالة لأي من أحداث CaptionsPropertyChangedEventType
function on(event: "CaptionsActiveChanged", listener: PropertyChangedEvent)
المعلمات
- event
-
"CaptionsActiveChanged"
اسم الحدث
- listener
- PropertyChangedEvent
fn رد الاتصال الذي تم استخدامه للاشتراك في هذا الحدث
on("CaptionsReceived", TeamsCaptionsHandler)
وظيفة الاشتراك للحدث CaptionsReceivedEventType
function on(event: "CaptionsReceived", listener: TeamsCaptionsHandler)
المعلمات
- event
-
"CaptionsReceived"
اسم الحدث
- listener
- TeamsCaptionsHandler
fn رد الاتصال الذي تم استخدامه للاشتراك في هذا الحدث
on("SpokenLanguageChanged", PropertyChangedEvent)
قم بالاشتراك في الدالة لأي من أحداث SpokenLanguageChangedEventType
function on(event: "SpokenLanguageChanged", listener: PropertyChangedEvent)
المعلمات
- event
-
"SpokenLanguageChanged"
اسم الحدث
- listener
- PropertyChangedEvent
fn رد الاتصال الذي تم استخدامه للاشتراك في هذا الحدث
setCaptionLanguage(string)
تحديث لغة النسخ / التسميات التوضيحية المستمرة
function setCaptionLanguage(language: string): Promise<void>
المعلمات
- language
-
string
لغة الكلام التوضيحي ك. يجب أن يكون تنسيق ISO 639-1 (على سبيل المثال، "en")
المرتجعات
Promise<void>
وعد يمثل إكمال عملية تعيين اللغة لا يشير إكمال هذا الوعد إلى أن اللغة قد تغيرت. سيتم إصدار حدث "CaptionLanguageChanged" عند تغيير اللغة بنجاح.
تفاصيل الأساليب المتوارثة
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" عند بدء تشغيل التسميات التوضيحية بنجاح.
الموروثة منالتسميات التوضيحيةCommon.startCaptions
stopCaptions()
إيقاف استرداد بيانات التسميات التوضيحية في استدعاء المستخدم الذي بدأ stopCaptions
function stopCaptions(): Promise<void>
المرتجعات
Promise<void>
وعد يمثل إكمال عملية إيقاف التسمية التوضيحية لا يشير إكمال هذا الوعد إلى أن روبوت التسميات التوضيحية قد ترك المكالمة. سيقوم المشارك بإلغاء الاشتراك من تلقي بيانات التسميات التوضيحية عند إيقافها بنجاح.
موروث منCaptionsCommon.stopCaptions