CaptionsSettingsModalProps interface

Package:

@azure/communication-react

CaptionsSettingsModal Component Props.

Properties

captionLanguageStrings	1 to 1 mapping between language code and language string for caption languages
changeCaptionLanguage	Flag to show the caption language dropdown
currentCaptionLanguage	Current caption language
currentSpokenLanguage	Current spoken language
isCaptionsFeatureActive	Flag to indicate if captions feature is active
onDismissCaptionsSettings	Callback that is triggered when the modal is dismissed
onSetCaptionLanguage	Callback to set caption language
onSetSpokenLanguage	Callback to set spoken language
onStartCaptions	Callback to start captions
showModal	Flag to show the modal
spokenLanguageStrings	1 to 1 mapping between language code and language string for spoken languages
strings	Strings for the captions settings modal
supportedCaptionLanguages	List of supported caption languages
supportedSpokenLanguages	List of supported spoken languages

Property Details

captionLanguageStrings

1 to 1 mapping between language code and language string for caption languages

captionLanguageStrings?: CaptionLanguageStrings

Property Value

CaptionLanguageStrings

changeCaptionLanguage

Flag to show the caption language dropdown

changeCaptionLanguage?: boolean

Property Value

boolean

currentCaptionLanguage

Current caption language

currentCaptionLanguage?: keyof CaptionLanguageStrings

Property Value

keyof CaptionLanguageStrings

currentSpokenLanguage

Current spoken language

currentSpokenLanguage: keyof SpokenLanguageStrings

Property Value

keyof SpokenLanguageStrings

isCaptionsFeatureActive

Flag to indicate if captions feature is active

isCaptionsFeatureActive?: boolean

Property Value

boolean

onDismissCaptionsSettings

Callback that is triggered when the modal is dismissed

onDismissCaptionsSettings?: () => void

Property Value

() => void

onSetCaptionLanguage

Callback to set caption language

onSetCaptionLanguage?: (language: keyof CaptionLanguageStrings) => Promise<void>

Property Value

(language: keyof CaptionLanguageStrings) => Promise<void>

onSetSpokenLanguage

Callback to set spoken language

onSetSpokenLanguage: (language: keyof SpokenLanguageStrings) => Promise<void>

Property Value

(language: keyof SpokenLanguageStrings) => Promise<void>

onStartCaptions

Callback to start captions

onStartCaptions: (options?: CaptionsOptions) => Promise<void>

Property Value

(options?: CaptionsOptions) => Promise<void>

showModal

Flag to show the modal

showModal?: boolean

Property Value

boolean

spokenLanguageStrings

1 to 1 mapping between language code and language string for spoken languages

spokenLanguageStrings?: SpokenLanguageStrings

Property Value

SpokenLanguageStrings

strings

Strings for the captions settings modal

strings?: CaptionsSettingsModalStrings

Property Value

CaptionsSettingsModalStrings

supportedCaptionLanguages

List of supported caption languages

supportedCaptionLanguages?: (keyof CaptionLanguageStrings)[]

Property Value

(keyof CaptionLanguageStrings)[]

supportedSpokenLanguages

List of supported spoken languages

supportedSpokenLanguages: (keyof SpokenLanguageStrings)[]

Property Value

(keyof SpokenLanguageStrings)[]