Voice

Index

Properties

• activationKey
• activationLevel
• inputDevice
• muteInput
• noiseSuppressionEnabled
• voiceControlsEnabled

Accessors

• activityInputEnabled

Methods

• getAvailableInputDevices
• toggleInput

Properties

publicstaticreadonlyactivationKey

activationKey: KeyCode

Returns the keycode of the voice activation key.

publicstaticactivationLevel

activationLevel: number

Remarks

This property requires Extended Voice API permission from the user.

publicstaticinputDevice

inputDevice: null | string

Remarks

This property requires Extended Voice API permission from the user.

publicstaticmuteInput

muteInput: boolean

Determines whether the microphone input is currently disabled.

publicstaticnoiseSuppressionEnabled

noiseSuppressionEnabled: boolean

Remarks

This property requires Extended Voice API permission from the user.

publicstaticreadonlyvoiceControlsEnabled

voiceControlsEnabled: boolean

Accessors

publicstaticactivityInputEnabled

• get activityInputEnabled(): boolean
• set activityInputEnabled(enabled: boolean): void

Getter

• Determines if the voice activation is enabled.

Setter

• Determines if the voice activation is enabled.

  Remarks

  This setter requires Extended Voice API permission from the user.

Methods

publicstaticgetAvailableInputDevices

• getAvailableInputDevices(): readonly IInputDevice[]

• Remarks

  This function requires Extended Voice API permission from the user.

publicstatictoggleInput

• toggleInput(enabled: boolean): void

• Remarks

  This function requires Extended Voice API permission from the user.