Classes
Methods
-
<static> animated() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
Used when delivering a video file as an image format that supports animation, such as animated WebP. Plays all frames rather than just delivering the first one as a static image. Use this flag in addition to the flag or parameter controlling the delivery format, for example f_auto or fl_awebp. Note: When delivering a video in GIF format, it is delivered as an animated GIF by default and this flag is not necessary. To deliver a single frame of a video in GIF format, use the page parameter.
Returns
Details
-
<static> animatedWebP() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
When converting animated images to WebP format, generate an animated WebP from all the frames in the original animated file instead of only from the first still frame.
Note that animated WebPs are not supported in all browsers and versions.
Returns
Details
-
<static> anyFormat() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
When used together with automatic quality (q_auto): allow switching to PNG8 encoding if the quality algorithm decides that it's more efficient.
Returns
Details
-
<static> animatedPng() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
When converting animated images to PNG format, generates an animated PNG from all the frames in the original animated file instead of only from the first still frame.
Note that animated PNGs are not supported in all browsers and versions.
Returns
Details
-
<static> clip() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
Trims pixels according to a clipping path included in the original image (e.g., manually created using PhotoShop).
Returns
Details
-
<static> clipEvenOdd() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
Trims pixels according to a clipping path included in the original image (e.g., manually created using PhotoShop) using an evenodd clipping rule.
Returns
Details
-
<static> forceStrip() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
Instructs Cloudinary to clear all image meta-data (IPTC, Exif and XMP) while applying an incoming transformation.
Returns
Details
-
<static> custom() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
Allows custom flag
Returns
Details
-
<static> forceIcc() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
Adds ICC color space metadata to the image, even when the original image doesn't contain any ICC data.
Returns
Details
-
<static> attachment( filename ) → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
Delivers the image as an attachment.
Parameters
Name Type Description filenamestring The attachment's filename
Returns
Details
-
<static> getInfo() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
Returns metadata of the input asset and of the transformed output asset in JSON instead of the transformed image.
Returns
Details
-
<static> hlsv3() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
Deliver an HLS adaptive bitrate streaming file as HLS v3 instead of the default version (HLS v4). Delivering in this format requires a private CDN configuration.
Returns
Details
-
<static> immutableCache() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
Sets the cache-control to immutable for the asset.
Returns
Details
-
<static> ignoreInitialAspectRatio() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
- Allows specifying only either width or height so the value of the second axis remains as is, and is not recalculated to maintain the aspect ratio of the original image.
Returns
Details
-
<static> keepAttribution() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
Keeps the copyright related fields when stripping meta-data.
Returns
Details
-
<static> keepIptc() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
Keeps all meta-data.
Returns
Details
-
<static> layerApply() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
Applies all chained transformations, until a transformation component that includes this flag, on the last added overlay or underlay instead of applying on the containing image.
Returns
Details
-
<static> lossy() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
Automatically use lossy compression when delivering animated GIF files.
This flag can also be used as a conditional flag for delivering PNG files: it tells Cloudinary to deliver the image in PNG format (as requested) unless there is no transparency channel - in which case deliver in JPEG format.
Returns
Details
-
<static> mono() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
Convert the audio channel to mono
Returns
Details
-
<static> noOverflow() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
Used internally by Position within an Overlay, this flag will tile the overlay across your image.
Learn more: Overflow in overlays
Returns
Details
-
<static> noStream() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
Don't stream a video that is currently being generated on the fly. Wait until the video is fully generated.
Returns
Details
-
<static> png24() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
Generate PNG images in the png24 format.
Returns
Details
-
<static> png32() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
Generate PNG images in the png32 format.
Returns
Details
-
<static> png8() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
Generate PNG images in the PNG8 format.
Returns
Details
-
<static> preserveTransparency() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
When used with automatic fetch_format (f_auto): ensures that images with a transparency channel will be delivered in PNG format.
Returns
Details
-
<static> progressive( mode? ) → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
Generates a JPG image using the progressive (interlaced) JPG format.
This format allows the browser to quickly show a low-quality rendering of the image until the full-quality image is loaded.
Parameters
Name Type Description mode?string The mode to determine a specific progressive outcome as follows:
- semi - A smart optimization of the decoding time, compression level and progressive rendering (less iterations). This is the default mode when using q_auto.
- steep - Delivers a preview very quickly, and in a single later phase improves the image to the required resolution.
- none - Use this to deliver a non-progressive image. This is the default mode when setting a specific value for quality.
Returns
Details
-
<static> regionRelative() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
Modifies percentage-based width & height parameters of overlays and underlays (e.g., 1.0) to be relative to the overlaid region
Returns
Details
-
<static> rasterize() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
Reduces the image to one flat pixelated layer (as opposed to the default vector based graphic) in order to enable PDF resizing and overlay manipulations.
Returns
Details
-
<static> relative() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
Modifies percentage-based width & height parameters of overlays and underlays (e.g., 1.0) to be relative to the containing image instead of the added layer.
Returns
Details
-
<static> sanitize() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
Instructs Cloudinary to run a sanitizer on the image (relevant only for the SVG format).
Returns
Details
-
<static> splice() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
Splices the video stipulated as an overlay on to the end of the container video instead of adding it as an overlay.
Returns
Details
-
<static> stripProfile() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
Instructs Cloudinary to clear all ICC color profile data included with the image.
Returns
Details
-
<static> streamingAttachment( filename ) → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
If the requested video transformation has already been generated, this flag works identically to Flag::attachment.
However, if the video transformation is being requested for the first time, this flag causes the video download to begin immediately, streaming it as a fragmented video file.
In contrast, if the regular fl_attachment flag is used when a user requests a new video transformation, the download will begin only after the complete transformed video has been generated.
Most standard video players successfully play fragmented video files without issue.
Parameters
Name Type Description filenamestring The attachment's filename
Returns
Details
-
<static> tiff8Lzw() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
Generates TIFF images using LZW compression and in the TIFF8 format.
Returns
Details
-
<static> tiled() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
Used internally by Position within an Overlay, this flag will tile the overlay across your image.
Learn more: Tiling overlay
Returns
Details
-
<static> truncateTS() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
Truncate (trim) a video file based on the start time defined in the metadata (relevant only where the metadata includes a directive to play only a section of the video).
Returns
Details
-
<static> waveform() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
Create a waveform image (in the format specified by the file extension) from the audio or video file.
Returns
Details
-
<static> ignoreMaskChannels() → {Qualifiers.Flag.FlagQualifier}
qualifier
-
Description
A qualifier that ensures that an alpha channel is not applied to a TIFF image if it is a mask channel.
Returns
Details