@audiotool/nexus - v0.0.12
    Preparing search index...

    Type Alias PresetUtil

    A wrapper for the presets API that's more convenient to use than the raw presets API.

    To get a preset id, you can right click the preset in the preset browser in the DAW and select "Copy Preset ID". Apply the preset as follows:

    // assuming we copied a gakki preset id
    const gakkiPreset = await client.api.presets.get("presets/e7cbee0e-1499-4356-a3e5-f788e58ef910")
    await nexus.modify(t => {
      const gakki = t.create("gakki", {})
      t.applyPresetTo(gakki, gakkiPreset)
    })

    See API for more information.

    type PresetUtil = {
        get: (nameOrId: string) => Promise<NexusPreset>;
        list: <T extends DevicePresetEntityType>(
            deviceType: T,
            textSearch?: string,
        ) => Promise<NexusPreset<T>[]>;
    }
    Index

    Properties

    get list

    Properties

    get: (nameOrId: string) => Promise<NexusPreset>

    Retrieves a specific preset by its name or id. Pass in a uuid or presets/{uuid}.

    Type declaration

      • (nameOrId: string): Promise<NexusPreset>

      • Parameters

        • nameOrId: string

          The identifier of the preset, either an uuid or presets/{uuid}

        Returns Promise<NexusPreset>

        Promise resolving to the requested preset

    list: <T extends DevicePresetEntityType>(
        deviceType: T,
        textSearch?: string,
    ) => Promise<NexusPreset<T>[]>

    Lists presets with optional filtering by device type and text search

    Type declaration

      • <T extends DevicePresetEntityType>(
            deviceType: T,
            textSearch?: string,
        ): Promise<NexusPreset<T>[]>

      • Type Parameters

        Parameters

        • deviceType: T

          The entity type of the device for which to list presets

        • OptionaltextSearch: string

          Optional text to filter presets by name or description

        Returns Promise<NexusPreset<T>[]>

        Promise resolving to an array of matching presets

    Settings

    Member Visibility

    On This Page

    Properties