@companion-module/base
    Preparing search index...

    Interface CompanionPresetAlternatives<TManifest>

    A group of alternative variants of a single logical preset.

    A module can offer several variants of "the same" preset (for example a rich layered variant and a simple fallback) so that hosts with differing capabilities can each surface the best one they support. This library does not decide or perform that selection: it simply forwards the group, and the host application picks which variant to show based on its own capabilities.

    The whole group is referenced by a single id in the preset structure, exactly like a plain preset.

    interface CompanionPresetAlternatives<
        TManifest extends InstanceTypes = InstanceTypes,
    > {
        type: "alternatives";
        variants: CompanionPresetDefinition<TManifest>[];
    }

    Type Parameters

    Index

    Properties

    Properties

    type: "alternatives"

    The type of the entry

    The variants of this preset, ordered most-preferred first. The host application surfaces the first variant it is able to render.