Home Manual Reference Source
public class | source

PronunciationChallenge

Constructor Summary

Public Constructor
public

constructor(id: string, transcription: string, referenceAudioUrl: string)

Create a pronunciation challenge domain model.

Member Summary

Public Members
public

The pronunciation challenge identifier.

public

The reference audio fragment as streaming audio link.

public

The status of the challenge's preparation. Either 'unprepared', 'preparing' or 'prepared'.

public

The spoken word or sentence as plain text.

Public Constructors

public constructor(id: string, transcription: string, referenceAudioUrl: string) source

Create a pronunciation challenge domain model.

Params:

NameTypeAttributeDescription
id string
  • nullable: true

The pronunciation challenge identifier. If none is given, one is generated.

transcription string

The spoken word or sentence as plain text.

referenceAudioUrl string
  • nullable: true

The reference audio fragment URL. If one is not yet available or audio is not yet registered to the challenge it can be set to 'null'.

Throw:

Error

id parameter of type "string|null" is required.

Error

transcription parameter of type "string" is required.

Error

referenceAudioUrl parameter of type "string|null" is required.

Public Members

public id: string source

The pronunciation challenge identifier. If none is given, one is generated.

public referenceAudioUrl: string source

The reference audio fragment as streaming audio link.

public status: string source

The status of the challenge's preparation. Either 'unprepared', 'preparing' or 'prepared'.

public transcription: string source

The spoken word or sentence as plain text.