@firebolt-js/provider-sdk
Version:
The Firebolt Provider JS SDK
175 lines (104 loc) • 2.24 kB
Markdown
title: Accessibility
# Accessibility
Version Accessibility 0.0.0-unknown.0
## Table of Contents
- [Table of Contents](#table-of-contents)
- [Overview](#overview)
- [Types](#types)
- [FontFamily](#fontfamily)
- [VoiceSpeed](#voicespeed)
- [VoiceGuidanceSettings](#voiceguidancesettings)
- [FontSize](#fontsize)
- [Color](#color)
- [FontEdge](#fontedge)
- [Opacity](#opacity)
- [HorizontalAlignment](#horizontalalignment)
- [VerticalAlignment](#verticalalignment)
- [ClosedCaptionsStyles](#closedcaptionsstyles)
- [ClosedCaptionsSettings](#closedcaptionssettings)
## Overview
undefined
## Types
### FontFamily
```typescript
type FontFamily = string
```
### VoiceSpeed
```typescript
type VoiceSpeed = number
```
### VoiceGuidanceSettings
```typescript
type VoiceGuidanceSettings = {
enabled: boolean // Whether or not voice guidance should be enabled by default
speed: VoiceSpeed
}
```
See also:
number
### FontSize
```typescript
type FontSize = number
```
### Color
```typescript
type Color = string
```
### FontEdge
```typescript
type FontEdge = string
```
### Opacity
```typescript
type Opacity = number
```
### HorizontalAlignment
```typescript
type HorizontalAlignment = string
```
### VerticalAlignment
```typescript
type VerticalAlignment = string
```
### ClosedCaptionsStyles
The default styles to use when displaying closed-captions
```typescript
type ClosedCaptionsStyles = {
fontFamily?: string
fontSize?: number
fontColor?: string
fontEdge?: string
fontEdgeColor?: string
fontOpacity?: number
backgroundColor?: string
backgroundOpacity?: number
textAlign?: string
textAlignVertical?: string
windowColor?: string
windowOpacity?: number
}
```
### ClosedCaptionsSettings
```typescript
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
preferredLanguages?: string[]
}
```
See also:
[ClosedCaptionsStyles](#closedcaptionsstyles)