adobe-firefly-sdk
    Preparing search index...

    Type Alias AvatarEntity

    Details of the avatar entity.

    type AvatarEntity = {
        ageGroup?: "Young Adult" | "Middle Aged" | "Senior";
        avatarId?: string;
        clothingStyle?: "Casual" | "Formal" | "Professional";
        displayName?: string;
        ethnicity?: string;
        extendedPropertyMap?: {
            aspectRatio?: { x?: number; y?: number };
            resolution?: { height?: number; width?: number };
        };
        gender?: string;
        sampleVideo?: { mp4?: string; webm?: string };
        status?: "Active" | "Inactive";
        style?: string;
        thumbnailUrls?: { hd?: string; lowRes?: string };
        voiceId?: string;
    }
    Index

    Properties

    ageGroup? avatarId? clothingStyle? displayName? ethnicity? extendedPropertyMap? gender? sampleVideo? status? style? thumbnailUrls? voiceId?

    Properties

    ageGroup?: "Young Adult" | "Middle Aged" | "Senior"

    The intended age bracket of the avatar.

    avatarId?: string

    The unique ID for the avatar.

    clothingStyle?: "Casual" | "Formal" | "Professional"

    The clothing style worn by the avatar.

    displayName?: string

    The displayed name for the avatar.

    ethnicity?: string

    The ethnicity of the avatar.

    extendedPropertyMap?: {
        aspectRatio?: { x?: number; y?: number };
        resolution?: { height?: number; width?: number };
    }

    This is a field for any additional properties for the avatar.

    gender?: string

    The gender of the avatar.

    sampleVideo?: { mp4?: string; webm?: string }

    Type Declaration

    • Optionalmp4?: string

      A pre-signed URL for downloading avatar sample video in MP4 format.

    • Optionalwebm?: string

      A pre-signed URL for downloading avatar sample video in WEBM format.

    status?: "Active" | "Inactive"

    This determines if the specific avatar ID is available for use. Deprecated avatars will have an Inactive status.

    style?: string

    This property is used when the avatar wears a professional or region-specific costume (like Nurse, Doctor, Emergency Worker, Retail Worker, etc.).

    thumbnailUrls?: { hd?: string; lowRes?: string }

    Type Declaration

    • Optionalhd?: string

      A pre-signed URL for downloading the high-resolution avatar thumbnail.

    • OptionallowRes?: string

      A pre-signed URL for downloading the low-resolution avatar thumbnail.

    voiceId?: string

    The unique ID for the voice.

    Settings

    Member Visibility

    On This Page

    Properties