CaptionsBannerProps interface

Paket:

@azure/communication-react

CaptionsBanner-Komponenten-Requisiten.

Eigenschaften

captions	Array der anzuzeigenden Untertitel
captionsOptions	Optionale Optionen für die Komponente.
formFactor	Optionaler Formfaktor für die Komponente.
isCaptionsOn	Flagge, um anzuzeigen, ob Untertitel aktiviert sind
isRealTimeTextOn	Flag, um anzuzeigen, ob Echtzeittext aktiviert ist
latestLocalRealTimeText	Aktueller lokaler Echtzeittext
onRenderAvatar	Optionaler Callback zum Überschreiben des Renderns des Avatars.
onSendRealTimeText	Optionaler Callback zum Senden von Text in Echtzeit.
realTimeTexts	Array von abgeschlossenen und partiellen Echtzeit-Textnachrichten
startCaptionsInProgress	Flag, um anzuzeigen, ob Untertitel gestartet werden Dies wird verwendet, um den Spinner anzuzeigen, während Untertitel gestartet werden
strings	Optionale Zeichenfolgen für die Komponente

Details zur Eigenschaft

captions

Array der anzuzeigenden Untertitel

captions: CaptionsInformation[]

Eigenschaftswert

CaptionsInformation[]

captionsOptions

Optionale Optionen für die Komponente.

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

Eigenschaftswert

{ height: "default" | "full" }

formFactor

Optionaler Formfaktor für die Komponente.

formFactor?: "default" | "compact"

Eigenschaftswert

"default" | "compact"

isCaptionsOn

Flagge, um anzuzeigen, ob Untertitel aktiviert sind

isCaptionsOn?: boolean

Eigenschaftswert

boolean

isRealTimeTextOn

Flag, um anzuzeigen, ob Echtzeittext aktiviert ist

isRealTimeTextOn?: boolean

Eigenschaftswert

boolean

latestLocalRealTimeText

Aktueller lokaler Echtzeittext

latestLocalRealTimeText?: RealTimeTextInformation

Eigenschaftswert

RealTimeTextInformation

onRenderAvatar

Optionaler Callback zum Überschreiben des Renderns des Avatars.

onRenderAvatar?: OnRenderAvatarCallback

Eigenschaftswert

OnRenderAvatarCallback

onSendRealTimeText

Optionaler Callback zum Senden von Text in Echtzeit.

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

Eigenschaftswert

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

realTimeTexts

Array von abgeschlossenen und partiellen Echtzeit-Textnachrichten

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

Eigenschaftswert

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

startCaptionsInProgress

Flag, um anzuzeigen, ob Untertitel gestartet werden Dies wird verwendet, um den Spinner anzuzeigen, während Untertitel gestartet werden

startCaptionsInProgress?: boolean

Eigenschaftswert

boolean

strings

Optionale Zeichenfolgen für die Komponente

strings?: CaptionsBannerStrings

Eigenschaftswert

CaptionsBannerStrings