Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Voice

Hierarchy

  • Voice

Index

Constructors

Properties

Accessors

Methods

Constructors

Protected constructor

  • Returns Voice

Properties

Static Readonly activationKey

activationKey: KeyCode

Returns the keycode of the voice activation key.

Static activationLevel

activationLevel: number
remarks

This property requires Extended Voice API permission from the user.

Static inputDevice

inputDevice: string | null
remarks

This property requires Extended Voice API permission from the user.

Static muteInput

muteInput: boolean

Determines whether the microphone input is currently disabled.

Static noiseSuppressionEnabled

noiseSuppressionEnabled: boolean
remarks

This property requires Extended Voice API permission from the user.

Static Readonly voiceControlsEnabled

voiceControlsEnabled: boolean

Accessors

Static activityInputEnabled

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

  • Determines if the voice activation is enabled.

    remarks

    This setter requires Extended Voice API permission from the user.

    Returns boolean

  • Determines if the voice activation is enabled.

    remarks

    This setter requires Extended Voice API permission from the user.

    Parameters

    • enabled: boolean

    Returns any

Methods

Static getAvailableInputDevices

Static toggleInput

  • toggleInput(enabled: boolean): void
  • remarks

    This function requires Extended Voice API permission from the user.

    Parameters

    • enabled: boolean

    Returns void