adobe-firefly-sdk
    Preparing search index...

    Type Alias Restv1ComposeSceneRequestWritable

    type Restv1ComposeSceneRequestWritable = {
        cameraName?: string | null;
        contentClass?: "art" | "photo";
        enableGroundPlane?: boolean;
        environment?: TypesComposeEnvironment;
        environmentExposure?: number;
        heroAsset: string;
        lightingSeeds?: number[];
        modelVersion?: "image3_fast" | "image4_standard" | "image4_ultra";
        numVariations?: number;
        prompt: string;
        scene?: TypesComposeSceneSceneDetails;
        sceneFile?: string;
        seeds?: number[];
        size?: TypesOutputSize;
        sources: RestBaseMountedSource[] | null;
        styleImage?: string;
    }
    Index

    Properties

    cameraName? contentClass? enableGroundPlane? environment? environmentExposure? heroAsset lightingSeeds? modelVersion? numVariations? prompt scene? sceneFile? seeds? size? sources styleImage?

    Properties

    cameraName?: string | null

    Name of an existing camera in the source 3D scene. The camera has to be defined in the scene.

    contentClass?: "art" | "photo"

    Class of content to generate.

    enableGroundPlane?: boolean

    Enable the auto-generated ground plane under the hero asset. This is useful if the 3D scene contains only a hero asset, without additional elements.

    environment?: TypesComposeEnvironment

    Optional environment settings used for all variations. If omitted, an environment will be generated based on the background. If set, the lightingSeeds parameter will be ignored.

    environmentExposure?: number

    Exposure, in EV (0=neutral).

    heroAsset: string

    Name of an existing 'hero asset' in the source 3D scene. The asset has to be defined in the scene.

    lightingSeeds?: number[]

    Optional seeds to be used to generate the lighting for the scene. The first seed will be used with the first seed of the background, the second one with the second seed of the background and so on. Background seeds must be defined and the number of lighting seeds should equal the number of background seeds. If not set, random seeds will be used. You will be able to retrieve the seeds used for the generation in the output details of the job.

    modelVersion?: "image3_fast" | "image4_standard" | "image4_ultra"

    Model version to be used to generate the background image with Adobe Firefly.

    numVariations?: number

    The number of variations to generate. numVariations will default to the number of seeds, or to 1 if seeds is not specified.

    prompt: string

    Prompt to be used to generate the background image with Adobe Firefly.

    scene?: TypesComposeSceneSceneDetails
    sceneFile?: string

    The path of the scene file in sources. If value is null, the first found scene file will be used.

    seeds?: number[]

    Optional seed value to be used to generate the background image with Adobe Firefly. A seed ensures consistent background image generation. If seed is not set, a random seed will be used. Retrieve the seed used for the generation in the output details of the job. If specified with numVariations, the number of seeds must be the equal to numVariations.

    size?: TypesOutputSize

    The size of the image generations. The supported dimensions for image generations are:

    Dimensions Description
    { "width": 2048, "height": 2048} Square (1:1)
    { "width": 2304, "height": 1792 } Landscape (4:3)
    { "width": 1792, "height": 2304 } Portrait (3:4)
    { "width": 2688, "height": 1536 } Widescreen (16:9)
    { "width": 1344, "height": 768 } (7:4)
    { "width": 1152, "height": 896 } (9:7)
    { "width": 896, "height": 1152 } (7:9)
    { "width": 1024, "height": 1024} Square (1:1)
    sources: RestBaseMountedSource[] | null

    List of sources to aggregate and run the job against.

    styleImage?: string

    Optional 'style image' to be used to generate the background. The style image has to be present in sources.

    Settings

    Member Visibility

    On This Page

    Properties