Interface ScreenReaderConfig

Default: false

True when the screen reader should automatically proceed to the next non interactive readable element.

Default: true

True when the screenReader should react to the system focus.

Default: false

True when the screen reader should select the element under the mouse position when it detects a click.

Default: false

True when the screen reader should speak out pressed keyboard keys.

Default: true

True when the screen reader should speak out loud.

Default: true

True when the screen reader should allow the selection of virtual keyboard keys as current element when invoking an edit control.

Default: false

True when the screen reader should automatically jump to the next speakable element when the focus changes to a non speakable element.

Default: false

True when the screen reader should move the system focus to the current screen reader focus.

Default:

{
  "enabled": true,
  "color": "red",
  "borderColor": "black",
  "backgroundColor": "transparent",
  "fadeDurationInSeconds": 0.1,
  "borderSize": 1,
  "innerSize": 2,
  "margin": 4,
  "style": "Normal"
}

Settings for the current screen reader focus highlighter.

Default:

{
  "enabled": false
}

Settings for the current screen reader focus highlighter when the system focus is the current screen reader focus.

Default:

"ScreenReaderPlaybackDevice"

The regular expression to match the default playback device to use once the screen reader has been started. When this is an empty string, the default playback device will not be changed.

Default:

{
  "enabled": false
}

Settings for the system focus highlighter.

Default:

{
  "enabled": true,
  "color": "blue",
  "borderColor": "black",
  "backgroundColor": "transparent",
  "fadeDurationInSeconds": 0.1,
  "borderSize": 1,
  "innerSize": 2,
  "margin": 0,
  "style": "Normal"
}

Settings for the system focus highlighter when the system focus is the current screen reader focus.

Default: false

True when the screen reader should use the SiteKiosk language instead of the detected language of the element which it should speak.

Default:

{
  "enabled": true,
  "setSiteKioskLanguageOnTextSelection": true,
  "texts": []
}

Configuration for the screen reader activated/introduction dialog.

Default:

[
  {
    "keys": [
      "Up"
    ],
    "needsScreenReaderKey": true,
    "eatAllKeys": false,
    "actions": [
      {
        "name": "toggleScreenReader",
        "toggleScreenReader": {
          "enabled": true
        }
      }
    ]
  },
  {
    "keys": [
      "Down"
    ],
    "needsScreenReaderKey": true,
    "eatAllKeys": false,
    "actions": [
      {
        "name": "toggleScreenReader",
        "toggleScreenReader": {
          "enabled": false
        }
      }
    ]
  },
  {
    "keys": [
      "Right"
    ],
    "needsScreenReaderKey": true,
    "eatAllKeys": false,
    "actions": [
      {
        "name": "selectScreenReaderElement",
        "selectScreenReaderElement": {
          "direction": "Next",
          "target": "Default"
        }
      }
    ]
  },
  {
    "keys": [
      "Left"
    ],
    "needsScreenReaderKey": true,
    "eatAllKeys": false,
    "actions": [
      {
        "name": "selectScreenReaderElement",
        "selectScreenReaderElement": {
          "direction": "Previous",
          "target": "Default"
        }
      }
    ]
  },
  {
    "keys": [
      "OemMinus"
    ],
    "needsScreenReaderKey": true,
    "eatAllKeys": false,
    "actions": [
      {
        "name": "changeVolume",
        "changeVolume": {
          "valueIsAbsolute": false,
          "value": -0.1
        }
      }
    ]
  },
  {
    "keys": [
      "OemPlus"
    ],
    "needsScreenReaderKey": true,
    "eatAllKeys": false,
    "actions": [
      {
        "name": "changeVolume",
        "changeVolume": {
          "valueIsAbsolute": false,
          "value": 0.1
        }
      }
    ]
  },
  {
    "keys": [
      "Return"
    ],
    "needsScreenReaderKey": true,
    "eatAllKeys": false,
    "actions": [
      {
        "name": "invokeScreenReaderElement",
        "invokeScreenReaderElement": {}
      }
    ]
  }
]

List of keyboard shortcuts for the screen reader.

Default: 0.5

The duration in seconds the screen reader pauses until it will proceed to the next element to auto read.

Default: true

Moves the magnifier when the screen reader focus changes.

Default: false

True when the default addon should play a default audio instead of pausing when handling a SpeakCommand.Pause command.

Default: 0.25

The time in seconds the screen reader waits before it will re-read the current element.

Default: true

True when changes on the system focused element should be reported to the screen reader when the current screen reader focus is not on the system focused element.

Default: "Capital"

The default screen reader key, when the user presses the screen reader key, all keyboard inputs will be directed to the screen reader until the user releases this key.

Default:

"$(SiteKioskAssetsPath)\ScreenReader\Sounds\start.flac"

The path to the sound file to play when the screen reader starts. Leave empty or null when no sound should be played.

Default:

"$(SiteKioskAssetsPath)\ScreenReader\Sounds\stop.flac"

The path to the sound file to play when the screen reader stops. Leave empty or null when no sound should be played.

Default:

{
  "enabled": true,
  "color": "orange",
  "borderColor": "black",
  "backgroundColor": "transparent",
  "fadeDurationInSeconds": 0,
  "borderSize": 0,
  "innerSize": 2,
  "margin": 0,
  "style": "Normal"
}

Settings for the currently speaking text elements.

Default: []

List of replacement commands when speaking text.

Default: "SiteKiosk"

The type of screen reader to use.

Default: false

True when the screen reader should use a very detailed view when searching elements. This is not recommended but may help in situations in which the screen reader misses certain UI elements.

Default: true

True when SiteKiosk registers listeners to the provided keyboard shortcuts.