title: Accessibilty

# Accessibilty Schema

Version 0.10.0

JSON-Schema

This document was generated from a JSON-Schema, and is intended to provide a human readable overview and examples of the methods contained in the module.

For the full schema, see the link below.

Table of Contents

• Schemas
  • FontFamily
  • FontSize
  • FontEdge
  • Color
  • Opacity
  • HorizontalAlignment
  • VerticalAlignment
  • ClosedCaptionsStyles
  • ClosedCaptionsSettings
  • VoiceSpeed
  • VoiceGuidanceSettings

Schemas

FontFamily

type FontFamily = string

FontSize

type FontSize = number

FontEdge

type FontEdge = string

Color

type Color = string

Opacity

type Opacity = number

HorizontalAlignment

type HorizontalAlignment = string

VerticalAlignment

type VerticalAlignment = string

ClosedCaptionsStyles

type ClosedCaptionsStyles = {
  fontFamily?: string
  fontSize?: number
  fontColor?: string
  fontEdge?: string
  fontEdgeColor?: string
  fontOpacity?: number
  backgroundColor?: string
  backgroundOpacity?: number
  textAlign?: string
  textAlignVertical?: string
}

Details

The default styles to use when displaying closed-captions

ClosedCaptionsSettings

type ClosedCaptionsSettings = {
  enabled: boolean               // Whether or not closed-captions should be enabled by default
  styles: ClosedCaptionsStyles   // The default styles to use when displaying closed-captions
}

{
  "enabled": true,
  "styles": {
    "fontFamily": "Monospace sans-serif",
    "fontSize": 1,
    "fontColor": "#ffffff",
    "fontEdge": "none",
    "fontEdgeColor": "#7F7F7F",
    "fontOpacity": 100,
    "backgroundColor": "#000000",
    "backgroundOpacity": 100,
    "textAlign": "center",
    "textAlignVertical": "middle"
  }
}

VoiceSpeed

type VoiceSpeed = number

VoiceGuidanceSettings

type VoiceGuidanceSettings = {
  enabled: boolean              // Whether or not voice guidance should be enabled by default
  speed: number                 // The speed at which voice guidance speech will be read back to the user
}

{
  "enabled": true,
  "speed": 2
}