CaptionsBannerProps interface

包:

@azure/communication-react

CaptionsBanner 组件 props。

属性

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