Skip to content

VyonicaClient

Defined in: js/src/client.ts:17

Constructors

Constructor

new VyonicaClient(options): VyonicaClient

Defined in: js/src/client.ts:21

Parameters

options

VyonicaClientOptions

Returns

VyonicaClient

Methods

clone()

clone(refWav, options, pollOptions?): Promise<Buffer<ArrayBufferLike>>

Defined in: js/src/client.ts:166

Parameters

refWav

Blob | Buffer<ArrayBufferLike>

options

CloneOptions

pollOptions?

PollOptions

Returns

Promise<Buffer<ArrayBufferLike>>


createCloneJob()

createCloneJob(refWav, options): Promise<CreateJobResult>

Defined in: js/src/client.ts:56

Parameters

refWav

Blob | Buffer<ArrayBufferLike>

options

CloneOptions

Returns

Promise<CreateJobResult>


downloadOutput()

downloadOutput(jobId): Promise<Buffer<ArrayBufferLike>>

Defined in: js/src/client.ts:133

Parameters

jobId

string

Returns

Promise<Buffer<ArrayBufferLike>>


getJob()

getJob(jobId): Promise<VoiceCloneJob>

Defined in: js/src/client.ts:101

Parameters

jobId

string

Returns

Promise<VoiceCloneJob>


getUsage()

getUsage(): Promise<Usage>

Defined in: js/src/client.ts:149

Return current usage and remaining quota for this API key.

Useful for surfacing how many voice-minutes are left before the server starts rejecting requests with QuotaExceededError.

Returns

Promise<Usage>