CaptionsBannerProps interface

الحزمة:

@azure/communication-react

التسميات التوضيحيةدعائم مكون البانر.

الخصائص

captions	مجموعة من التسميات التوضيحية المراد عرضها
captionsOptions	خيارات اختيارية للمكون.
formFactor	عامل الشكل الاختياري للمكون.
isCaptionsOn	وضع علامة للإشارة إلى ما إذا كانت التسميات التوضيحية قيد التشغيل
isRealTimeTextOn	وضع علامة للإشارة إلى ما إذا كان النص في الوقت الفعلي قيد التشغيل
latestLocalRealTimeText	أحدث نص محلي في الوقت الفعلي
onRenderAvatar	معاودة اتصال اختيارية لتجاوز عرض الصورة الرمزية.
onSendRealTimeText	معاودة الاتصال الاختيارية لإرسال نص في الوقت الفعلي.
realTimeTexts	مجموعة من الرسائل النصية النهائية والجزئية في الوقت الحقيقي
startCaptionsInProgress	وضع علامة للإشارة إلى ما إذا كان يتم بدء التسميات التوضيحية يستخدم هذا لإظهار الدوار أثناء بدء التسميات التوضيحية
strings	سلاسل اختيارية للمكون

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

captions

مجموعة من التسميات التوضيحية المراد عرضها

captions: CaptionsInformation[]

قيمة الخاصية

CaptionsInformation[]

captionsOptions

خيارات اختيارية للمكون.

captionsOptions?: { height: "default" | "full" }

قيمة الخاصية

{ height: "default" | "full" }

formFactor

عامل الشكل الاختياري للمكون.

formFactor?: "default" | "compact"

قيمة الخاصية

"default" | "compact"

isCaptionsOn

وضع علامة للإشارة إلى ما إذا كانت التسميات التوضيحية قيد التشغيل

isCaptionsOn?: boolean

قيمة الخاصية

boolean

isRealTimeTextOn

وضع علامة للإشارة إلى ما إذا كان النص في الوقت الفعلي قيد التشغيل

isRealTimeTextOn?: boolean

قيمة الخاصية

boolean

latestLocalRealTimeText

أحدث نص محلي في الوقت الفعلي

latestLocalRealTimeText?: RealTimeTextInformation

قيمة الخاصية

RealTimeTextInformation

onRenderAvatar

معاودة اتصال اختيارية لتجاوز عرض الصورة الرمزية.

onRenderAvatar?: OnRenderAvatarCallback

قيمة الخاصية

OnRenderAvatarCallback

onSendRealTimeText

معاودة الاتصال الاختيارية لإرسال نص في الوقت الفعلي.

onSendRealTimeText?: (text: string, isFinalized: boolean) => Promise<void>

قيمة الخاصية

(text: string, isFinalized: boolean) => Promise<void>

realTimeTexts

مجموعة من الرسائل النصية النهائية والجزئية في الوقت الحقيقي

realTimeTexts?: { completedMessages?: RealTimeTextInformation[], currentInProgress?: RealTimeTextInformation[], myInProgress?: RealTimeTextInformation }

قيمة الخاصية

{ completedMessages?: RealTimeTextInformation[], currentInProgress?: RealTimeTextInformation[], myInProgress?: RealTimeTextInformation }

startCaptionsInProgress

وضع علامة للإشارة إلى ما إذا كان يتم بدء التسميات التوضيحية يستخدم هذا لإظهار الدوار أثناء بدء التسميات التوضيحية

startCaptionsInProgress?: boolean

قيمة الخاصية

boolean

strings

سلاسل اختيارية للمكون

strings?: CaptionsBannerStrings

قيمة الخاصية

CaptionsBannerStrings