Home Manual Reference Source
public class | source

SpeechChallenge

Constructor Summary

Public Constructor
public

constructor(id: string, topic: string, referenceAudioUrl: string, srtUrl: string, imageUrl: string, metadata: string)

Create a speech SpeechChallenge domain model.

Member Summary

Public Members
public

The speech challenge identifier.

public

URL of a possible image file to accompany this challenge.

public

Metadata string.

public

The reference audio fragment as streaming audio link.

public

URL of a possible .srt file to accompany this challenge.

public

A question or topic serving as guidance.

Public Constructors

public constructor(id: string, topic: string, referenceAudioUrl: string, srtUrl: string, imageUrl: string, metadata: string) source

Create a speech SpeechChallenge domain model.

Params:

NameTypeAttributeDescription
id string
  • nullable: true

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

topic string
  • nullable: true

A question or topic serving as guidance.

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'.

srtUrl string
  • nullable: true

URL of a possible .srt file to accompany this challenge.

imageUrl string
  • nullable: true

URL of a possible image file to accompany this challenge.

metadata string
  • nullable: true

Metadata string. Can contain any kind of information that helps.

Throw:

Error

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

Error

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

Error

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

Public Members

public id: string source

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

public imageUrl: string source

URL of a possible image file to accompany this challenge.

public metadata: string source

Metadata string. Can contain any kind of information that helps.

public referenceAudioUrl: string source

The reference audio fragment as streaming audio link.

public srtUrl: string source

URL of a possible .srt file to accompany this challenge.

public topic: string source

A question or topic serving as guidance.