Edgewise API
    Preparing search index...

    Interface CloneVoiceOptions

    Options shared by every verb.

    interface CloneVoiceOptions {
        allowPreview?: boolean;
        consent: { attested: true; by?: string };
        device?: DeviceOption;
        dtype?: Dtype | Record<string, Dtype>;
        model?: ModelRef;
        onProgress?: (event: LoadEvent) => void;
        reference: AudioLike;
        sampleRate?: number;
        saveAs?: string;
        signal?: AbortSignal;
    }

    Hierarchy (View Summary)

    Index
    allowPreview? consent device? dtype? model? onProgress? reference sampleRate? saveAs? signal?
    allowPreview?: boolean

    Allow preview and experimental models.

    consent: { attested: true; by?: string }

    You confirm the speaker agreed to have their voice cloned. Required.

    device?: DeviceOption

    Force a device. Default 'auto'.

    dtype?: Dtype | Record<string, Dtype>

    Force a dtype, such as 'q4'.

    model?: ModelRef

    A cloning model. Default 'voice:clone'.

    onProgress?: (event: LoadEvent) => void

    Receives load events while the model downloads and compiles.

    reference: AudioLike

    3 to 10 seconds of clear speech from one speaker.

    sampleRate?: number

    Sample rate of reference when it is raw samples.

    saveAs?: string

    Keep the voice for later as voice: 'saved:<name>'.

    signal?: AbortSignal

    Abort download or inference.

    Settings
    Member Visibility

    On This Page
    Properties