Class TtsResult

The complete data for a TTS result. This contains extras like the spectrogram and other metadata like what worker generated the file, is a debug request, etc.

Implements

Audio

Constructors

constructor

new TtsResult(client, data): TtsResult
Parameters
- client: Client
  The main client.
- data: {
      created_at: Date;
      creator_set_visibility: "public" | "hidden";
      duration_millis: number;
      file_size_bytes: number;
      generated_by_worker: string;
      is_debug_request: boolean;
      maybe_creator_display_name: null | string;
      maybe_creator_gravatar_hash: null | string;
      maybe_creator_user_token: null | string;
      maybe_creator_username: null | string;
      maybe_model_creator_display_name: null | string;
      maybe_model_creator_gravatar_hash: null | string;
      maybe_model_creator_user_token: null | string;
      maybe_model_creator_username: null | string;
      maybe_pretrained_vocoder_used: null | string;
      public_bucket_spectrogram_path: string;
      public_bucket_wav_audio_path: string;
      raw_inference_text: string;
      tts_model_title: string;
      tts_model_token: string;
      tts_result_token: string;
      updated_at: Date;
  }
  The raw TTS result data from the FakeYou API.
  - created_at: Date
  - creator_set_visibility: "public" | "hidden"
  - duration_millis: number
  - file_size_bytes: number
  - generated_by_worker: string
  - is_debug_request: boolean
  - maybe_creator_display_name: null | string
  - maybe_creator_gravatar_hash: null | string
  - maybe_creator_user_token: null | string
  - maybe_creator_username: null | string
  - maybe_model_creator_display_name: null | string
  - maybe_model_creator_gravatar_hash: null | string
  - maybe_model_creator_user_token: null | string
  - maybe_model_creator_username: null | string
  - maybe_pretrained_vocoder_used: null | string
  - public_bucket_spectrogram_path: string
  - public_bucket_wav_audio_path: string
  - raw_inference_text: string
  - tts_model_title: string
  - tts_model_token: string
  - tts_result_token: string
  - updated_at: Date
Returns TtsResult
- Defined in src/api/ttsResult/TtsResult.ts:17

Properties

`Readonly` client

client: Client

`Readonly` createdAt

createdAt: Date

`Readonly` creatorSetVisibility

creatorSetVisibility: string

`Readonly` durationMillis

durationMillis: number

`Readonly` fileSizeBytes

fileSizeBytes: number

`Readonly` generatedByWorker

generatedByWorker: string

`Readonly` isDebugRequest

isDebugRequest: boolean

`Readonly` maybeCreatorDisplayName

maybeCreatorDisplayName: null | string

`Readonly` maybeCreatorGravatarHash

maybeCreatorGravatarHash: null | string

`Readonly` maybeCreatorUserToken

maybeCreatorUserToken: null | string

`Readonly` maybeCreatorUsername

maybeCreatorUsername: null | string

`Readonly` maybeModelCreatorDisplayName

maybeModelCreatorDisplayName: null | string

`Readonly` maybeModelCreatorGravatarHash

maybeModelCreatorGravatarHash: null | string

`Readonly` maybeModelCreatorUserToken

maybeModelCreatorUserToken: null | string

`Readonly` maybeModelCreatorUsername

maybeModelCreatorUsername: null | string

`Readonly` maybePretrainedVocoderUsed

maybePretrainedVocoderUsed: null | string

`Readonly` publicBucketSpectrogramPath

publicBucketSpectrogramPath: string

`Readonly` publicBucketWavAudioPath

publicBucketWavAudioPath: string

`Readonly` rawInferenceText

rawInferenceText: string

`Readonly` resourceUrl

resourceUrl: string

The external URL to the audio file. Expects a WAV file.

`Readonly` spectrogramUrl

spectrogramUrl: string

Raw spectrogram data, it is not an image.

toBase64

toBase64: ((this) => Promise<string | undefined>) = implToBase64

Convert the audio file to a base64 string.

Type declaration

- (this): Promise<string | undefined>
- Convert the audio file to a base64 string.
  Parameters
  - this: Audio
  Returns Promise<string | undefined>

toBuffer

toBuffer: ((this) => Promise<Buffer | undefined>) = implToBuffer

Fetch the audio file as a buffer.

Type declaration

- (this): Promise<Buffer | undefined>
- Fetch the audio file as a buffer.
  Parameters
  - this: Audio
  Returns Promise<Buffer | undefined>

toDisk

toDisk: ((this, location) => Promise<void>) = implToDisk

Write the audio file to disk.

Type declaration

- (this, location): Promise<void>
- Write the audio file to disk.
  Parameters
  - this: Audio
  - location: `${string}.wav`
  Returns Promise<void>

`Readonly` ttsModelTitle

ttsModelTitle: string

`Readonly` ttsModelToken

ttsModelToken: string

`Readonly` ttsResultToken

ttsResultToken: string

`Readonly` updatedAt

updatedAt: Date

`Readonly` webUrl

webUrl: string

The URL to the page of this result in the browser.

Methods

fetchSpectrogram

fetchSpectrogram(): Promise<undefined | Spectrogram>
Returns Promise<undefined | Spectrogram>
- Defined in src/api/ttsResult/TtsResult.ts:96

Class TtsResult

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: Client

created_at: Date

creator_set_visibility: "public" | "hidden"

duration_millis: number

file_size_bytes: number

generated_by_worker: string

is_debug_request: boolean

maybe_creator_display_name: null | string

maybe_creator_gravatar_hash: null | string

maybe_creator_user_token: null | string

maybe_creator_username: null | string

maybe_model_creator_display_name: null | string

maybe_model_creator_gravatar_hash: null | string

maybe_model_creator_user_token: null | string

maybe_model_creator_username: null | string

maybe_pretrained_vocoder_used: null | string

public_bucket_spectrogram_path: string

public_bucket_wav_audio_path: string

raw_inference_text: string

tts_model_title: string

tts_model_token: string

tts_result_token: string

updated_at: Date

Returns TtsResult

Properties

Readonly client

Readonly createdAt

Readonly creatorSetVisibility

Readonly durationMillis

Readonly fileSizeBytes

Readonly generatedByWorker

Readonly isDebugRequest

Readonly maybeCreatorDisplayName

Readonly maybeCreatorGravatarHash

Readonly maybeCreatorUserToken

Readonly maybeCreatorUsername

Readonly maybeModelCreatorDisplayName

Readonly maybeModelCreatorGravatarHash

Readonly maybeModelCreatorUserToken

Readonly maybeModelCreatorUsername

Readonly maybePretrainedVocoderUsed

Readonly publicBucketSpectrogramPath

Readonly publicBucketWavAudioPath

Readonly rawInferenceText

Readonly resourceUrl

Readonly spectrogramUrl

toBase64

Type declaration

Parameters

this: Audio

Returns Promise<string | undefined>

toBuffer

Type declaration

Parameters

this: Audio

Returns Promise<Buffer | undefined>

toDisk

Type declaration

Parameters

this: Audio

location: `${string}.wav`

Returns Promise<void>

Readonly ttsModelTitle

Readonly ttsModelToken

Readonly ttsResultToken

Readonly updatedAt

Readonly webUrl

Methods

fetchSpectrogram

Returns Promise<undefined | Spectrogram>

Settings

`Readonly` client

`Readonly` createdAt

`Readonly` creatorSetVisibility

`Readonly` durationMillis

`Readonly` fileSizeBytes

`Readonly` generatedByWorker

`Readonly` isDebugRequest

`Readonly` maybeCreatorDisplayName

`Readonly` maybeCreatorGravatarHash

`Readonly` maybeCreatorUserToken

`Readonly` maybeCreatorUsername

`Readonly` maybeModelCreatorDisplayName

`Readonly` maybeModelCreatorGravatarHash

`Readonly` maybeModelCreatorUserToken

`Readonly` maybeModelCreatorUsername

`Readonly` maybePretrainedVocoderUsed

`Readonly` publicBucketSpectrogramPath

`Readonly` publicBucketWavAudioPath

`Readonly` rawInferenceText

`Readonly` resourceUrl

`Readonly` spectrogramUrl

`Readonly` ttsModelTitle

`Readonly` ttsModelToken

`Readonly` ttsResultToken

`Readonly` updatedAt

`Readonly` webUrl