adobe-firefly-sdk
    Preparing search index...

    Type Alias TemplateRenderRequest

    type TemplateRenderRequest = {
        assets?: { source: { url: string } }[];
        config?: { handleMissingFonts?: "fail" | "use_default" };
        fonts?: { name: string; source: { url: string } }[];
        outputs?: {
            fileName?: string;
            presetIndex: number;
            variationIndex: number;
        }[];
        presets?: { source: { presetId?: string; url?: string } }[];
        source: { url: string };
        variations: {
            variables: {
                assetIndex?: number;
                audioPreference?: "replace" | "mix";
                fontName?: string;
                scale?: "no_scale" | "fit_to_frame" | "stretch_to_fill" | "fill_frame";
                selectedCheckboxValue?: boolean;
                selectedDropdownValue?: string;
                selectedSliderValue?: number;
                text?: string;
                variableId: string;
            }[];
        }[];
    }
    Index

    Properties

    assets? config? fonts? outputs? presets? source variations

    Properties

    assets?: { source: { url: string } }[]

    Array of image, video, or audio assets referenced by variations via assetIndex.

    config?: { handleMissingFonts?: "fail" | "use_default" }

    Configuration options for the render request.

    Type Declaration

    • OptionalhandleMissingFonts?: "fail" | "use_default"

      How to handle missing fonts. 'fail' will cause the render to fail; 'use_default' will use Premiere Pro fallback behavior.

    fonts?: { name: string; source: { url: string } }[]

    Array of fonts to be used in the template.

    Type Declaration

    • name: string

      PostScript name of the font.

    • source: { url: string }
      • url: string

        Pre-signed URL for the font file (.ttf/.otf).

    outputs?: { fileName?: string; presetIndex: number; variationIndex: number }[]

    Defines which variation and preset combinations to render and optional output file names.

    Type Declaration

    • OptionalfileName?: string

      Optional custom file name for the output.

    • presetIndex: number

      Zero-based index of the preset in the presets array.

    • variationIndex: number

      Zero-based index of the variation to render.

    presets?: { source: { presetId?: string; url?: string } }[]

    Array of export presets. Each item is either a built-in preset (by presetId) or a custom preset (by URL). Outputs reference presets by presetIndex.

    source: { url: string }

    Contains metadata about the source of the input template.

    Type Declaration

    • url: string

      A pre-signed URL pointing to the input template file.

    variations: {
        variables: {
            assetIndex?: number;
            audioPreference?: "replace" | "mix";
            fontName?: string;
            scale?: "no_scale" | "fit_to_frame" | "stretch_to_fill" | "fill_frame";
            selectedCheckboxValue?: boolean;
            selectedDropdownValue?: string;
            selectedSliderValue?: number;
            text?: string;
            variableId: string;
        }[];
    }[]

    List of variations. Each variation contains variable overrides applied to the template.

    Type Declaration

    • variables: {
          assetIndex?: number;
          audioPreference?: "replace" | "mix";
          fontName?: string;
          scale?: "no_scale" | "fit_to_frame" | "stretch_to_fill" | "fill_frame";
          selectedCheckboxValue?: boolean;
          selectedDropdownValue?: string;
          selectedSliderValue?: number;
          text?: string;
          variableId: string;
      }[]

      Variable overrides for this variation. Each object targets one template variable by variableId and supplies the override value.

    Settings

    Member Visibility

    On This Page

    Properties