@blockchaincommons/multipart-ur - v1.0.0-beta.3
    Preparing search index...

    Interface AnimateArgs

    mur animate arguments.

    interface AnimateArgs {
        format?: string;
        urString: string;
        size?: number;
        fg?: string;
        bg?: string;
        logo?: string;
        logoFraction?: number;
        logoBorder?: number;
        logoShape?: string;
        correction?: string;
        quietZone?: number;
        dark?: boolean;
        maxModules?: number;
        densityCheck?: boolean;
        output: string;
        maxFragmentLen?: number;
        fps?: number;
        cycles?: number;
        frameCount?: number;
    }

    Hierarchy (View Summary)

    Index
    format? urString size? fg? bg? logo? logoFraction? logoBorder? logoShape? correction? quietZone? dark? maxModules? densityCheck? output maxFragmentLen? fps? cycles? frameCount?
    format?: string

    gif or prores (default gif).

    urString: string

    The UR string, or - to read it from stdin.

    size?: number

    Image size in pixels (default 512).

    fg?: string

    Foreground colour, hex (default #000000).

    bg?: string

    Background colour, hex (default #FFFFFF).

    logo?: string

    Path to an SVG logo.

    logoFraction?: number

    Logo fraction of the QR width, 0.01–0.99 (default 0.25).

    logoBorder?: number

    Logo clear border in modules, 0–5 (default 1).

    logoShape?: string

    Logo clear shape, square or circle (default square).

    correction?: string

    Error-correction level by name or first letter (default low, high with a logo).

    quietZone?: number

    Quiet-zone modules (default 1).

    dark?: boolean

    Swap foreground and background (default false).

    maxModules?: number

    Maximum module count for the density check (default 117).

    densityCheck?: boolean

    Whether to run the density check (default true).

    output: string

    Output path.

    maxFragmentLen?: number

    Maximum fragment length for fountain coding (default 100).

    fps?: number

    Frames per second (default 8).

    cycles?: number

    Complete cycles through all fragments (default 3).

    frameCount?: number

    Exact number of frames (overrides cycles).

    Settings
    Member Visibility

    On This Page
    Properties