Format
class Format extends BaseAction implements FormatInterface
Defines the format of the delivered asset.
Learn more: Image formats | Video formats
Methods
Format constructor.
Adds the qualifier to the action.
Adds qualifiers to the action.
Adds (sets) generic (raw) action.
Sets the flag.
Removes the flag.
Serializes to json.
Serializes to Cloudinary URL format
Audio format mp3.
Audio format aac.
Audio format m4a.
Audio format ogg.
Audio format wav.
Audio format aiff.
Audio format flac.
Audio format amr.
Audio format midi.
Image format jpg.
Image format jpc.
Image format jp2.
Image format wdp.
Image format png.
Image format gif.
Image format webp.
Image format bmp.
Image format tiff.
Image format ico.
Image format pdf.
Image format eps.
Image format psd.
Image format svg.
Image format ai.
Image format djvu.
Image format avif.
Image format flif.
Image format glb.
Image format usdz.
Video format mp4.
Video format ts.
Video format mov.
Video format flv.
Video format webm.
Video format ogv.
Video format m3u8.
Video format mpd.
Video format mkv.
Video format avi.
Video format 3gp.
Video format 3g2.
Video format wmv.
Video format mpeg.
Auto format.
Sets file format.
Automatically use lossy compression when delivering animated GIF files.
Applicable only for JPG file format
Ensures that images with a transparency channel will be delivered in PNG format.
Ensures that an alpha channel is not applied to a TIFF image if it is a mask channel.
Details
__construct(array ...$value)
Format constructor.
$this
addQualifier(BaseComponent $qualifier = null)
Adds the qualifier to the action.
$this
addQualifiers(array ...$qualifiers)
Adds qualifiers to the action.
BaseAction
setGenericAction(string $action)
Adds (sets) generic (raw) action.
$this
setFlag(FlagQualifier $flag, bool $set = true)
Sets the flag.
$this
unsetFlag(FlagQualifier $flag)
Removes the flag.
$this
importAction(BaseAction|null $action)
Imports (merges) qualifiers and flags from another action.
mixed
jsonSerialize()
Serializes to json.
string
__toString()
Serializes to Cloudinary URL format
static AudioFormatTrait
audioMp3()
Audio format mp3.
static AudioFormatTrait
audioAac()
Audio format aac.
static AudioFormatTrait
audioM4a()
Audio format m4a.
static AudioFormatTrait
audioOgg()
Audio format ogg.
static AudioFormatTrait
audioWav()
Audio format wav.
static AudioFormatTrait
audioAiff()
Audio format aiff.
static AudioFormatTrait
audioFlac()
Audio format flac.
static AudioFormatTrait
audioAmr()
Audio format amr.
static AudioFormatTrait
audioMidi()
Audio format midi.
static ImageFormatTrait
jpg()
Image format jpg.
static ImageFormatTrait
jpc()
Image format jpc.
static ImageFormatTrait
jp2()
Image format jp2.
static ImageFormatTrait
wdp()
Image format wdp.
static ImageFormatTrait
png()
Image format png.
static ImageFormatTrait
gif()
Image format gif.
static ImageFormatTrait
webp()
Image format webp.
static ImageFormatTrait
bmp()
Image format bmp.
static ImageFormatTrait
tiff()
Image format tiff.
static ImageFormatTrait
ico()
Image format ico.
static ImageFormatTrait
pdf()
Image format pdf.
static ImageFormatTrait
eps()
Image format eps.
static ImageFormatTrait
psd()
Image format psd.
static ImageFormatTrait
svg()
Image format svg.
static ImageFormatTrait
ai()
Image format ai.
static ImageFormatTrait
djvu()
Image format djvu.
static ImageFormatTrait
avif()
Image format avif.
static ImageFormatTrait
flif()
Image format flif.
static ImageFormatTrait
glb()
Image format glb.
static ImageFormatTrait
usdz()
Image format usdz.
static VideoFormatTrait
videoMp4()
Video format mp4.
static VideoFormatTrait
videoTs()
Video format ts.
static VideoFormatTrait
videoMov()
Video format mov.
static VideoFormatTrait
videoFlv()
Video format flv.
static VideoFormatTrait
videoWebm()
Video format webm.
static VideoFormatTrait
videoOgv()
Video format ogv.
static VideoFormatTrait
videoM3u8()
Video format m3u8.
static VideoFormatTrait
videoMpd()
Video format mpd.
static VideoFormatTrait
videoMkv()
Video format mkv.
static VideoFormatTrait
videoAvi()
Video format avi.
static VideoFormatTrait
video3gp()
Video format 3gp.
static VideoFormatTrait
video3g2()
Video format 3g2.
static VideoFormatTrait
videoWmv()
Video format wmv.
static VideoFormatTrait
videoMpeg()
Video format mpeg.
static FormatTrait
auto()
Auto format.
Format
format(string $format)
Sets file format.
Format
lossy(bool $useLossy = true)
Automatically use lossy compression when delivering animated GIF files.
Format
progressive(string $mode = null)
Applicable only for JPG file format
Format
preserveTransparency()
Ensures that images with a transparency channel will be delivered in PNG format.
Format
ignoreMaskChannels()
Ensures that an alpha channel is not applied to a TIFF image if it is a mask channel.
Constants
| MAIN_QUALIFIER |
|