@musallam/audio-video-client
    Preparing search index...

    Interface AvatarEntity

    Details of the avatar entity.

    interface AvatarEntity {
        ageGroup?: AudioVideoApiClient.AvatarEntityAgeGroup;
        avatarId?: string;
        clothingStyle?: AudioVideoApiClient.AvatarEntityClothingStyle;
        displayName?: string;
        ethnicity?: string;
        extendedPropertyMap?: AvatarEntityExtendedPropertyMap;
        gender?: string;
        sampleVideo?: AvatarEntitySampleVideo;
        status?: AudioVideoApiClient.AvatarEntityStatus;
        style?: string;
        thumbnailUrls?: AvatarEntityThumbnailUrls;
        voiceId?: string;
    }
    Index

    Properties

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

    Properties

    ageGroup?: AudioVideoApiClient.AvatarEntityAgeGroup

    The intended age bracket of the avatar.

    avatarId?: string

    The unique ID for the avatar.

    clothingStyle?: AudioVideoApiClient.AvatarEntityClothingStyle

    The clothing style worn by the avatar.

    displayName?: string

    The displayed name for the avatar.

    ethnicity?: string

    The ethnicity of the avatar.

    extendedPropertyMap?: AvatarEntityExtendedPropertyMap

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

    gender?: string

    The gender of the avatar.

    sampleVideo?: AvatarEntitySampleVideo
    status?: AudioVideoApiClient.AvatarEntityStatus

    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?: AvatarEntityThumbnailUrls
    voiceId?: string

    The unique ID for the voice.

    Settings

    Member Visibility

    On This Page

    Properties