1. Home
  2. .Transcode~ToAnimatedAction

new ToAnimatedAction()

Description

Converts a video to an animated webp or gif. The resulting transformation includes format (f_format) and the animated flag (fl_animated). The flag fl_awebp is added only when an animated webp is requested.

Details

SDK.Action

actions/transcode/ToAnimatedAction.ts, line 15

Visit Transcode for an example

Methods

getActionTag() → {string}

Description

Returns the custom name tag that was given to this action

Returns
Details

SDK.Action#getActionTag

SDK.Action#getActionTag

internal/Action.ts, line 29

delay( delayValue )

Description

Sets the time between frames.

Parameters
Name Type Description
delayValue

The time in milliseconds.
Details

actions/transcode/ToAnimatedAction.ts, line 31

setActionTag() → {this}

Description

Sets the custom name tag for this action

Returns
Details

SDK.Action#setActionTag

SDK.Action#setActionTag

internal/Action.ts, line 36

sampling( sampling )

Description

Sets the frequency at which the video is sampled.

Parameters
Name Type Description
sampling

As a string (e.g. '2.3s'), samples one frame every 2.3 seconds.
As a number (e.g. 20), samples that many equally spaced frames over the duration of the video.
Details

actions/transcode/ToAnimatedAction.ts, line 41

toString() → {string}

Description

Calls toString() on all child qualifiers (implicitly by using .join()).

Returns
Details

SDK.Action#toString

SDK.Action#toString

internal/Action.ts, line 44

addQualifier( qualifier ) → {this}

Description

Adds the parameter to the action.

Parameters
Name Type Description
qualifier SDK.Qualifier
Returns
Details

SDK.Action#addQualifier

SDK.Action#addQualifier

internal/Action.ts, line 53

addFlag( flag ) → {this}

Description

Adds a flag to the current action.

Parameters
Name Type Description
flag Qualifiers.Flag
Returns
Details

SDK.Action#addFlag

SDK.Action#addFlag

internal/Action.ts, line 77