Interface TransformOptions

Hierarchy

  • TransformOptions

Properties

ascii?: true | {
    background?: string;
    colored?: boolean;
    foreground?: string;
    reverse?: boolean;
    size?: number;
}
blackwhite?: true | {
    threshold: number;
}
blur?: true | {
    amount: number;
}
blur_faces?: {
    amount?: number;
    blur?: number;
    buffer?: number;
    faces?: string | number;
    maxsize?: number;
    minsize?: number;
    type?: EShapeType;
}

Type declaration

  • Optional amount?: number
  • Optional blur?: number
  • Optional buffer?: number
  • Optional faces?: string | number
  • Optional maxsize?: number
  • Optional minsize?: number
  • Optional type?: EShapeType
border?: true | {
    background?: string;
    color?: string;
    width?: number;
}
cache?: {
    cache?: boolean;
    expiry: number;
}

Type declaration

  • Optional cache?: boolean
  • expiry: number
circle?: true | {
    background?: string;
}
collage?: {
    color?: string;
    files: [string];
    fit?: EFitOptions;
    height?: number;
    margin?: number;
    width?: number;
}

Type declaration

  • Optional color?: string
  • files: [string]
  • Optional fit?: EFitOptions
  • Optional height?: number
  • Optional margin?: number
  • Optional width?: number
compress?: boolean
crop?: {
    dim: [number, number, number, number];
}

Type declaration

  • dim: [number, number, number, number]
crop_faces?: {
    buffer?: number;
    faces?: string | number;
    height?: number;
    mode?: ECropfacesType;
    width?: number;
}

Type declaration

  • Optional buffer?: number
  • Optional faces?: string | number
  • Optional height?: number
  • Optional mode?: ECropfacesType
  • Optional width?: number
detect_faces?: true | {
    color?: string;
    export?: boolean;
    maxsize?: number;
    minsize?: number;
}
enchance?: boolean
flip?: boolean
flop?: boolean
imagesize?: boolean
modulate?: true | {
    brightness?: number;
    hue?: number;
    saturation?: number;
}
monochrome?: boolean
negative?: boolean
no_metadata?: boolean
oil_paint?: true | {
    amount: number;
}
output?: {
    background?: string;
    colorspace?: string;
    compress?: boolean;
    density?: number;
    docinfo?: boolean;
    format: string;
    page?: number;
    pageformat?: string;
    pageorientation?: string;
    quality?: number;
    secure?: boolean;
    strip?: boolean;
}

Type declaration

  • Optional background?: string
  • Optional colorspace?: string
  • Optional compress?: boolean
  • Optional density?: number
  • Optional docinfo?: boolean
  • format: string
  • Optional page?: number
  • Optional pageformat?: string
  • Optional pageorientation?: string
  • Optional quality?: number
  • Optional secure?: boolean
  • Optional strip?: boolean
partial_blur?: {
    amount: number;
    blur?: number;
    objects?: [[number, number, number, number]];
    type?: EShapeType;
}

Type declaration

  • amount: number
  • Optional blur?: number
  • Optional objects?: [[number, number, number, number]]
  • Optional type?: EShapeType
partial_pixelate?: {
    amount?: number;
    blur?: number;
    objects?: [[number, number, number, number]];
    type?: EShapeType;
}

Type declaration

  • Optional amount?: number
  • Optional blur?: number
  • Optional objects?: [[number, number, number, number]]
  • Optional type?: EShapeType
pdfconvert?: {
    pageformat?: string;
    pageorientation?: string;
    pages?: (string | number)[];
}

Type declaration

  • Optional pageformat?: string
  • Optional pageorientation?: string
  • Optional pages?: (string | number)[]
pdfinfo?: true | {
    colorinfo?: boolean;
}
pixelate?: true | {
    amount: number;
}
pixelate_faces?: {
    amount?: number;
    blur?: number;
    buffer?: number;
    faces?: string | number;
    maxsize?: number;
    minsize?: number;
    type?: EShapeType;
}

Type declaration

  • Optional amount?: number
  • Optional blur?: number
  • Optional buffer?: number
  • Optional faces?: string | number
  • Optional maxsize?: number
  • Optional minsize?: number
  • Optional type?: EShapeType
pjpg?: {
    metadata: boolean;
    quality: number;
}

Type declaration

  • metadata: boolean
  • quality: number
polaroid?: true | {
    background?: string;
    color?: string;
    rotate?: number;
}
quality?: {
    value: number;
}

Type declaration

  • value: number
redeye?: boolean
resize?: {
    align?: EAlignFacesOptions;
    fit?: EFitOptions;
    height?: number;
    width?: number;
}

Type declaration

rotate?: {
    background?: string;
    color?: string;
    deg: string | number;
}

Type declaration

  • Optional background?: string
  • Optional color?: string
  • deg: string | number
rounded_corners?: true | {
    background?: string;
    blur?: number;
    radius?: number;
}
security?: {
    policy: string;
    signature?: string;
}

Type declaration

  • policy: string
  • Optional signature?: string
sepia?: true | {
    tone: number;
}
sfw?: boolean
shadow?: true | {
    background?: string;
    blur?: number;
    color?: string;
    opacity?: number;
    vector?: [number, number];
}
sharpen?: true | {
    amount: number;
}
smart_crop?: {
    height: number;
    mode?: ESmartCropMode;
    width: number;
}

Type declaration

store?: {
    access?: string;
    base64decode?: boolean;
    container?: string;
    filename?: string;
    location?: string;
    path?: string;
    region?: string;
}

Type declaration

  • Optional access?: string
  • Optional base64decode?: boolean
  • Optional container?: string
  • Optional filename?: string
  • Optional location?: string
  • Optional path?: string
  • Optional region?: string
tags?: boolean
torn_edges?: true | {
    background?: string;
    spread?: [number, number];
}
upscale?: true | {
    noise?: ENoiseType;
    style?: EStyleType;
    upscale?: boolean;
}
urlscreenshot?: true | {
    agent?: EUrlscreenshotAgent;
    delay?: number;
    device?: string;
    height?: number;
    mode?: EUrlscreenshotMode;
    orientation?: EUrlscreenshotOrientation;
    width?: number;
}
video_convert?: {
    access?: EVideoAccess;
    aspect_mode: EVideoAccessMode;
    audio_bitrate?: number;
    audio_channels?: number;
    audio_codec?: EAudioTypes;
    audio_sample_rate?: number;
    clip_length?: string;
    clip_offset?: string;
    container?: string;
    extname?: string;
    filename?: string;
    force?: boolean;
    fps?: number;
    height?: number;
    keyframe_interval?: number;
    location?: EVideoLocations;
    path?: string;
    preset?: EVideoTypes;
    title?: string;
    two_pass?: boolean;
    upscale: boolean;
    video_bitrate?: number;
    watermark_bottom?: number;
    watermark_height?: number;
    watermark_left?: number;
    watermark_right?: number;
    watermark_top?: number;
    watermark_url?: string;
    watermark_width?: number;
    width?: number;
}

Type declaration

  • Optional access?: EVideoAccess
  • aspect_mode: EVideoAccessMode
  • Optional audio_bitrate?: number
  • Optional audio_channels?: number
  • Optional audio_codec?: EAudioTypes
  • Optional audio_sample_rate?: number
  • Optional clip_length?: string
  • Optional clip_offset?: string
  • Optional container?: string
  • Optional extname?: string
  • Optional filename?: string
  • Optional force?: boolean
  • Optional fps?: number
  • Optional height?: number
  • Optional keyframe_interval?: number
  • Optional location?: EVideoLocations
  • Optional path?: string
  • Optional preset?: EVideoTypes
  • Optional title?: string
  • Optional two_pass?: boolean
  • upscale: boolean
  • Optional video_bitrate?: number
  • Optional watermark_bottom?: number
  • Optional watermark_height?: number
  • Optional watermark_left?: number
  • Optional watermark_right?: number
  • Optional watermark_top?: number
  • Optional watermark_url?: string
  • Optional watermark_width?: number
  • Optional width?: number
vignette?: {
    amount?: number;
    background?: string;
    blurmode?: EBlurMode;
}

Type declaration

  • Optional amount?: number
  • Optional background?: string
  • Optional blurmode?: EBlurMode
watermark?: {
    files: string;
    position?: EImageWatermarkPosition | EImageWatermarkPosition[];
    size?: number;
}

Type declaration