adobe-firefly-sdk
    Preparing search index...

    Type Alias JobStatus

    type JobStatus = {
        errors?: {
            error: { error_code: string; message: string };
            presetIndex: number;
            variationIndex: number;
        }[];
        jobId: string;
        message?: string;
        output?: {
            elements?: {
                controls: {
                    data?: { [key: string]: unknown };
                    defaultData?: { [key: string]: unknown };
                    durationInSeconds?: number;
                    id?: string;
                    label?: string;
                    options?: unknown;
                    possibleAudioPreferences?: string[];
                    possibleScaleValues?: string[];
                    range?: { maximum?: number; minimum?: number };
                    size?: { height?: number; width?: number };
                    text?: string;
                    type?:
                        | "text"
                        | "media"
                        | "dropdown"
                        | "checkbox"
                        | "slider"
                        | "audio"
                        | "comment";
                    variableId?: string;
                }[];
                id?: string;
                type: "mogrt";
            }[];
            fonts?: { name: string; uploadRequired?: boolean }[];
        };
        outputs?: {
            destination: { url: string };
            presetIndex: number;
            variationIndex: number;
        }[];
        percentCompleted?: string;
        status: | "not_started"
        | "running"
        | "succeeded"
        | "failed"
        | "partially_succeeded";
    }
    Index

    Properties

    errors? jobId message? output? outputs? percentCompleted? status

    Properties

    errors?: {
        error: { error_code: string; message: string };
        presetIndex: number;
        variationIndex: number;
    }[]

    Array of errors for failed variations (only present when status is partially_succeeded).

    Type Declaration

    • error: { error_code: string; message: string }
      • error_code: string

        Error code for the failure.

      • message: string

        Error message describing the failure.

    • presetIndex: number

      Zero-based index of the preset that was used for the failed variation.

    • variationIndex: number

      Zero-based index of the variation that failed.

    jobId: string

    ID of the render job.

    message?: string

    Error message when job status is failed.

    output?: {
        elements?: {
            controls: {
                data?: { [key: string]: unknown };
                defaultData?: { [key: string]: unknown };
                durationInSeconds?: number;
                id?: string;
                label?: string;
                options?: unknown;
                possibleAudioPreferences?: string[];
                possibleScaleValues?: string[];
                range?: { maximum?: number; minimum?: number };
                size?: { height?: number; width?: number };
                text?: string;
                type?:
                    | "text"
                    | "media"
                    | "dropdown"
                    | "checkbox"
                    | "slider"
                    | "audio"
                    | "comment";
                variableId?: string;
            }[];
            id?: string;
            type: "mogrt";
        }[];
        fonts?: { name: string; uploadRequired?: boolean }[];
    }

    Output for describe API jobs.

    Type Declaration

    • Optionalelements?: {
          controls: {
              data?: { [key: string]: unknown };
              defaultData?: { [key: string]: unknown };
              durationInSeconds?: number;
              id?: string;
              label?: string;
              options?: unknown;
              possibleAudioPreferences?: string[];
              possibleScaleValues?: string[];
              range?: { maximum?: number; minimum?: number };
              size?: { height?: number; width?: number };
              text?: string;
              type?:
                  | "text"
                  | "media"
                  | "dropdown"
                  | "checkbox"
                  | "slider"
                  | "audio"
                  | "comment";
              variableId?: string;
          }[];
          id?: string;
          type: "mogrt";
      }[]

      Array of elements from the template.

    • Optionalfonts?: { name: string; uploadRequired?: boolean }[]

      Array of fonts from the template.

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

    Array of output files with destination URLs, keyed by variation and preset indices.

    Type Declaration

    • destination: { url: string }
      • url: string

        URL from which the rendered video can be downloaded.

    • presetIndex: number

      Zero-based index of the preset that was used for rendering.

    • variationIndex: number

      Zero-based index of the variation that was rendered.

    percentCompleted?: string

    Percentage of job completed, as a string.

    status:
        | "not_started"
        | "running"
        | "succeeded"
        | "failed"
        | "partially_succeeded"

    Current status of the job.

    Settings

    Member Visibility

    On This Page

    Properties