Share via

MicrophoneButtonStrings interface

Package:
@azure/communication-react

Strings of MicrophoneButton that can be overridden.

Properties

deepNoiseSuppressionOffAnnouncement

Noise Suppression turned off string for announcer
deepNoiseSuppressionOnAnnouncement

Noise Suppression turned on string for announcer
deepNoiseSuppressionTitle

Title for deep noise suppression button
microphoneActionTurnedOffAnnouncement

Microphone action turned off string for announcer
microphoneActionTurnedOnAnnouncement

Microphone action turned on string for announcer
microphoneAriaDescription

Aria description for the microphone button
microphoneButtonSplitRoleDescription

Description of microphone button split button role
microphoneMenuTitle

Title of microphone menu
microphoneMenuTooltip

Tooltip of microphone menu
microphonePrimaryActionSplitButtonTitle

Title for primary action section of split button
offLabel

Label when button is off.
offSplitButtonAriaLabel

Microphone split button aria label when mic is disabled.
offSplitButtonMicrophonePrimaryAction

Primary action for the microphone when the microphone is muted.
onLabel

Label when button is on.
onSplitButtonAriaLabel

Microphone split button aria label when mic is enabled.
onSplitButtonMicrophonePrimaryAction

Primary action for the microphone when microphone is live.
speakerMenuTitle

Title of speaker menu
speakerMenuTooltip

Tooltip of speaker menu
tooltipDisabledContent
  • Tooltip content when the button is disabled.
tooltipOffContent

Tooltip content when the button is off.
tooltipOnContent

Tooltip content when the button is on.

Property Details

deepNoiseSuppressionOffAnnouncement

Noise Suppression turned off string for announcer

deepNoiseSuppressionOffAnnouncement?: string

Property Value

string

deepNoiseSuppressionOnAnnouncement

Noise Suppression turned on string for announcer

deepNoiseSuppressionOnAnnouncement?: string

Property Value

string

deepNoiseSuppressionTitle

Title for deep noise suppression button

deepNoiseSuppressionTitle?: string

Property Value

string

microphoneActionTurnedOffAnnouncement

Microphone action turned off string for announcer

microphoneActionTurnedOffAnnouncement?: string

Property Value

string

microphoneActionTurnedOnAnnouncement

Microphone action turned on string for announcer

microphoneActionTurnedOnAnnouncement?: string

Property Value

string

microphoneAriaDescription

Aria description for the microphone button

microphoneAriaDescription?: string

Property Value

string

microphoneButtonSplitRoleDescription

Description of microphone button split button role

microphoneButtonSplitRoleDescription?: string

Property Value

string

microphoneMenuTitle

Title of microphone menu

microphoneMenuTitle?: string

Property Value

string

microphoneMenuTooltip

Tooltip of microphone menu

microphoneMenuTooltip?: string

Property Value

string

microphonePrimaryActionSplitButtonTitle

Title for primary action section of split button

microphonePrimaryActionSplitButtonTitle?: string

Property Value

string

offLabel

Label when button is off.

offLabel: string

Property Value

string

offSplitButtonAriaLabel

Microphone split button aria label when mic is disabled.

offSplitButtonAriaLabel?: string

Property Value

string

offSplitButtonMicrophonePrimaryAction

Primary action for the microphone when the microphone is muted.

offSplitButtonMicrophonePrimaryAction?: string

Property Value

string

onLabel

Label when button is on.

onLabel: string

Property Value

string

onSplitButtonAriaLabel

Microphone split button aria label when mic is enabled.

onSplitButtonAriaLabel?: string

Property Value

string

onSplitButtonMicrophonePrimaryAction

Primary action for the microphone when microphone is live.

onSplitButtonMicrophonePrimaryAction?: string

Property Value

string

speakerMenuTitle

Title of speaker menu

speakerMenuTitle?: string

Property Value

string

speakerMenuTooltip

Tooltip of speaker menu

speakerMenuTooltip?: string

Property Value

string

tooltipDisabledContent

  • Tooltip content when the button is disabled.
tooltipDisabledContent?: string

Property Value

string

tooltipOffContent

Tooltip content when the button is off.

tooltipOffContent?: string

Property Value

string

tooltipOnContent

Tooltip content when the button is on.

tooltipOnContent?: string

Property Value

string