Cloudinary\Transformation\AnimatedEdit

class AnimatedEdit extends BaseAction

Action for editing an animated image.

Learn more: Animated images

Methods

__construct(mixed ...$qualifiers)

Action constructor.

addQualifier(BaseComponent $qualifier = null)

Adds the qualifier to the action.

addQualifiers(array ...$qualifiers)

Adds qualifiers to the action.

setGenericAction(string $action)

Adds (sets) generic (raw) action.

setFlag(FlagQualifier $flag, bool $set = true)

Sets the flag.

unsetFlag(FlagQualifier $flag)

Removes the flag.

importAction(BaseAction|null $action)

Imports (merges) qualifiers and flags from another action.

jsonSerialize()

Serializes to json.

__toString()

Serializes to Cloudinary URL format

delay(int $delay)

Controls the time delay between the frames of an animated image, in milliseconds.

loop(int $additionalIterations = null)

Delivers an animated GIF that contains additional loops of the GIF.

Details

`__construct(mixed ...$qualifiers)`

Action constructor.

Parameters

Name	Type	Description
...$qualifiers	mixed

`$this addQualifier(BaseComponent $qualifier = null)`

Adds the qualifier to the action.

Parameters

Name	Type	Description
$qualifier	BaseComponent	The qualifier to add.

Return Value

$this

`$this addQualifiers(array ...$qualifiers)`

Adds qualifiers to the action.

Parameters

Name	Type	Description
...$qualifiers	array	The qualifiers to add.

Return Value

$this

`BaseAction setGenericAction(string $action)`

Adds (sets) generic (raw) action.

Parameters

Name	Type	Description
$action	string	The generic action string.

Return Value

BaseAction

`$this setFlag(FlagQualifier $flag, bool $set = true)`

Sets the flag.

Parameters

Name	Type	Description
$flag	FlagQualifier	The flag to set.
$set	bool	Indicates whether to set(true) or unset(false) the flag instead. (Used for avoiding if conditions all over the code)

Return Value

$this

`$this unsetFlag(FlagQualifier $flag)`

Removes the flag.

Parameters

Name	Type	Description
$flag	FlagQualifier	The flag to unset.

Return Value

$this

`$this importAction(BaseAction|null $action)`

Imports (merges) qualifiers and flags from another action.

Parameters

Name	Type	Description
$action	BaseAction\|null	The action to import.

Return Value

$this

`mixed jsonSerialize()`

Serializes to json.

Return Value

mixed

`string __toString()`

Serializes to Cloudinary URL format

Return Value

string

`AnimatedEdit delay(int $delay)`

Controls the time delay between the frames of an animated image, in milliseconds.

Parameters

Name	Type	Description
$delay	int	The delay in milliseconds

Return Value

AnimatedEdit

`AnimatedEdit loop(int $additionalIterations = null)`

Delivers an animated GIF that contains additional loops of the GIF.

The total number of iterations is the number of additional loops plus one.

You can also specify the loop effect without a numeric value to instruct it to loop the GIF infinitely.

Parameters

Name	Type	Description
$additionalIterations	int	The additional number of times to play the animated GIF.

Return Value

AnimatedEdit

Constants

MAIN_QUALIFIER