PrepareOptions

Options for prepare. Everything is optional.

Extends

• PrepareRequest

Indexable

[property: string]: unknown

Properties

allowDownload?

optional allowDownload?: boolean

Lets this call start a platform’s own download, whatever autoDownload says at registration. Call it from a user’s decision. Absent follows autoDownload.

Inherited from

PrepareRequest.allowDownload

---

locale?

optional locale?: string

BCP 47 tag of the language to prepare. Absent lets a speech provider use the device’s own language.

Inherited from

PrepareRequest.locale

---

localeMatch?

optional localeMatch?: LocaleMatch

How locale compares: ‘language’ (default) or ‘exact’.

Inherited from

PrepareRequest.localeMatch

---

onProgress?

optional onProgress?: (progress) => void

Called as an item advances, with a fraction from 0 to 1 when the platform has one.

Parameters

progress

fractionCompleted?

number

providerId

string

task

string

Returns

void

---

privacy?

optional privacy?: Privacy

The privacy policy of the runs this precedes.

Inherited from

PrepareRequest.privacy

---

requestId?

optional requestId?: string

Fixes the run id, for correlation.

Inherited from

PrepareRequest.requestId

---

tasks?

optional tasks?: string[]

Task kinds to prepare. Absent means every task a registered provider can prepare.

Inherited from

PrepareRequest.tasks

---

voice?

optional voice?: PrepareVoice

A voice to prepare, as for a speech request.

Inherited from

PrepareRequest.voice