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