Type alias InitParams

InitParams: {
    defaultAssets?: DefaultAssets;
    disableUi?: boolean;
    iframeClassName?: string;
    url?: string;
}

Type declaration

  • Optional defaultAssets?: DefaultAssets

    Default assets to set for the avatar

  • Optional disableUi?: boolean

    Disables UI in avatar editor. See https://docs.avaturn.me/docs/integration/sdk/custom-ui/

    Default

    false

  • Optional iframeClassName?: string

    CSS class name for the iframe element created by SDK to embed Avaturn.

  • Optional url?: string

    URL to open. Typically created with /v1/sessions/new API request.