quickAction

This class contains the APIs used for opening quick actions.

Image quick actions

convertToJPEG

quickAction.convertToJPEG: (docConfig?: DocConfig, appConfig?: AppConfig, exportConfig?: ExportOptions, containerConfig?: ContainerConfig): void

convertToPNG

quickAction.convertToPNG: (docConfig?: DocConfig, appConfig?: AppConfig, exportConfig?: ExportOptions, containerConfig?: ContainerConfig): void

convertToSVG

quickAction.convertToSVG: (docConfig?: DocConfig, appConfig?: AppConfig, exportConfig?: ExportOptions, containerConfig?: ContainerConfig): void

cropImage

quickAction.cropImage: (docConfig?: DocConfig, appConfig?: AppConfig, exportConfig?: ExportOptions, containerConfig?: ContainerConfig): void

resizeImage

quickAction.resizeImage: (docConfig?: DocConfig, appConfig?: AppConfig, exportConfig?: ExportOptions, containerConfig?: ContainerConfigs): void

removeBackground

quickAction.removeBackground: (docConfig?: DocConfig, appConfig?: AppConfig, exportConfig?: ExportOptions, containerConfig?: ContainerConfig): void

generateQRCode

quickAction.generateQRCode: (docConfig?: DocConfig, appConfig?: AppConfig, exportConfig?: ExportOptions, containerConfig?: ContainerConfig): void

Video quick actions

convertToGIF

quickAction.convertToGIF: (docConfig?: DocConfig, appConfig?: AppConfig, exportConfig?: ExportOptions, containerConfig?: ContainerConfig): void

convertToMP4

quickAction.convertToMP4: (docConfig?: DocConfig, appConfig?: AppConfig, exportConfig?: ExportOptions, containerConfig?: ContainerConfig): void

cropVideo

quickAction.cropVideo: (docConfig?: DocConfig, appConfig?: AppConfig, exportConfig?: ExportOptions, containerConfig?: ContainerConfig): void

mergeVideo

quickAction.mergeVideo: (docConfig?: DocConfig, appConfig?: AppConfig, exportConfig?: ExportOptions, containerConfig?: ContainerConfig): void

resizeVideo

quickAction.resizeVideo: (docConfig?: DocConfig, appConfig?: AppConfig, exportConfig?: ExportOptions, containerConfig?: ContainerConfig): void

trimVideo

quickAction.trimVideo: (docConfig?: DocConfig, appConfig?: AppConfig, exportConfig?: ExportOptions, containerConfig?: ContainerConfig): void

animateFromAudio

quickAction.animateFromAudio: (docConfig?: DocConfig, appConfig?: AppConfig, exportConfig?: ExportOptions, containerConfig?: ContainerConfig): void

captionVideo

quickAction.captionVideo: (docConfig?: DocConfig, appConfig?: AppConfig, exportConfig?: ExportOptions, containerConfig?: ContainerConfig): void

Parameters

All the properties are optional.

Property
Type
Description
docConfig
DocConfig
Pass a starting asset to the quick action editor
appConfig
AppConfig
Properties to configure the editor
exportConfig
ExportOptions[]
Configure export options. If no export options are specified, the editor falls back to the default layout options.
containerConfig
ContainerConfig
Properties to configure the SDK container

DocConfig

Property
Type
Description
asset
Asset or Asset[]
Asset from the host application to start editing with. Array of assets only accepted for merge videos quick action.

AppConfig

Property
Type
Description
colorTheme
string
Sets color theme of editor ("darkest", "dark", "lightest", "light")
scale
string
Set the text scale for the quick actions editor ("medium" or "large")
callbacks
Callbacks
Callback functions