CaptionsBannerProps interface

Pakket:

@azure/communication-react

BijschriftenBanner Component Props.

Eigenschappen

captions	Array van bijschriften die moeten worden weergegeven
captionsOptions	Optionele opties voor het onderdeel.
formFactor	Optionele vormfactor voor het onderdeel.
isCaptionsOn	Vlag om aan te geven of ondertiteling is ingeschakeld
isRealTimeTextOn	Vlag om aan te geven of real-time tekst is ingeschakeld
latestLocalRealTimeText	Laatste lokale real-time tekst
onRenderAvatar	Optionele callback om de render van de avatar te overschrijven.
onSendRealTimeText	Optioneel terugbellen om realtime sms te verzenden.
realTimeTexts	Array van voltooide en gedeeltelijke real-time tekstberichten
startCaptionsInProgress	Vlag om aan te geven of ondertiteling wordt gestart Dit wordt gebruikt om de spinner weer te geven terwijl de ondertiteling wordt gestart
strings	Optionele strings voor het onderdeel

Eigenschapdetails

captions

Array van bijschriften die moeten worden weergegeven

captions: CaptionsInformation[]

Waarde van eigenschap

CaptionsInformation[]

captionsOptions

Optionele opties voor het onderdeel.

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

Waarde van eigenschap

{ height: "default" | "full" }

formFactor

Optionele vormfactor voor het onderdeel.

formFactor?: "default" | "compact"

Waarde van eigenschap

"default" | "compact"

isCaptionsOn

Vlag om aan te geven of ondertiteling is ingeschakeld

isCaptionsOn?: boolean

Waarde van eigenschap

boolean

isRealTimeTextOn

Vlag om aan te geven of real-time tekst is ingeschakeld

isRealTimeTextOn?: boolean

Waarde van eigenschap

boolean

latestLocalRealTimeText

Laatste lokale real-time tekst

latestLocalRealTimeText?: RealTimeTextInformation

Waarde van eigenschap

RealTimeTextInformation

onRenderAvatar

Optionele callback om de render van de avatar te overschrijven.

onRenderAvatar?: OnRenderAvatarCallback

Waarde van eigenschap

OnRenderAvatarCallback

onSendRealTimeText

Optioneel terugbellen om realtime sms te verzenden.

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

Waarde van eigenschap

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

realTimeTexts

Array van voltooide en gedeeltelijke real-time tekstberichten

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

Waarde van eigenschap

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

startCaptionsInProgress

Vlag om aan te geven of ondertiteling wordt gestart Dit wordt gebruikt om de spinner weer te geven terwijl de ondertiteling wordt gestart

startCaptionsInProgress?: boolean

Waarde van eigenschap

boolean

strings

Optionele strings voor het onderdeel

strings?: CaptionsBannerStrings

Waarde van eigenschap

CaptionsBannerStrings