CaptionsBannerProps interface

Package:

@azure/communication-react

CaptionsBanner Component Props.

Properties

captions	Array of captions to be displayed
captionsOptions	Optional options for the component.
formFactor	Optional form factor for the component.
isCaptionsOn	Flag to indicate if captions are on
isRealTimeTextOn	Flag to indicate if real time text is on
latestLocalRealTimeText	Latest local real time text
onRenderAvatar	Optional callback to override render of the avatar.
onSendRealTimeText	Optional callback to send real time text.
realTimeTexts	Array of finalized and partial real time text messages
startCaptionsInProgress	Flag to indicate if captions are being started This is used to show spinner while captions are being started
strings	Optional strings for the component

Property Details

captions

Array of captions to be displayed

captions: CaptionsInformation[]

Property Value

CaptionsInformation[]

captionsOptions

Optional options for the component.

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

Property Value

{ height: "default" | "full" }

formFactor

Optional form factor for the component.

formFactor?: "default" | "compact"

Property Value

"default" | "compact"

isCaptionsOn

Flag to indicate if captions are on

isCaptionsOn?: boolean

Property Value

boolean

isRealTimeTextOn

Flag to indicate if real time text is on

isRealTimeTextOn?: boolean

Property Value

boolean

latestLocalRealTimeText

Latest local real time text

latestLocalRealTimeText?: RealTimeTextInformation

Property Value

RealTimeTextInformation

onRenderAvatar

Optional callback to override render of the avatar.

onRenderAvatar?: OnRenderAvatarCallback

Property Value

OnRenderAvatarCallback

onSendRealTimeText

Optional callback to send real time text.

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

Property Value

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

realTimeTexts

Array of finalized and partial real time text messages

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

Property Value

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

startCaptionsInProgress

Flag to indicate if captions are being started This is used to show spinner while captions are being started

startCaptionsInProgress?: boolean

Property Value

boolean

strings

Optional strings for the component

strings?: CaptionsBannerStrings

Property Value

CaptionsBannerStrings