Class PAGFile

Hierarchy

PAGComposition
- PAGFile
  - PAGFile

Index

Methods

`Static` load

load(data: ArrayBuffer | File | Blob): Promise<PAGFile>
Load pag file from file.
Parameters
- data: ArrayBuffer | File | Blob
Returns Promise<PAGFile>
- Defined in src/pag-file.ts:17

`Static` loadFromBuffer

loadFromBuffer(buffer: ArrayBuffer): PAGFile
Load pag file from arrayBuffer
Parameters
- buffer: ArrayBuffer
Returns PAGFile
- Defined in src/pag-file.ts:29

`Static` maxSupportedTagLevel

maxSupportedTagLevel(): number
The maximum tag level current SDK supports.

Returns number
- Defined in src/pag-file.ts:41

`Static` make

make(width: number, height: number): PAGComposition
Make a empty PAGComposition with specified size.
Parameters
- width: number
- height: number
Returns PAGComposition
Inherited from PAGComposition.make
- Defined in src/pag-composition.ts:14

tagLevel

tagLevel(): number
The tag level this pag file requires.

Returns number
- Defined in src/pag-file.ts:48

numTexts

numTexts(): number
The number of replaceable texts.

Returns number
- Defined in src/pag-file.ts:54

numImages

numImages(): number
The number of replaceable images.

Returns number
- Defined in src/pag-file.ts:60

numVideos

numVideos(): number
The number of video compositions.

Returns number
- Defined in src/pag-file.ts:66

getTextData

getTextData(editableTextIndex: number): TextDocument
Get a text data of the specified index. The index ranges from 0 to numTexts - 1. Note: It always returns the default text data.
Parameters
- editableTextIndex: number
Returns TextDocument
- Defined in src/pag-file.ts:73

replaceText

replaceText(editableTextIndex: number, textData: TextDocument): void
Replace the text data of the specified index. The index ranges from 0 to PAGFile.numTexts - 1. Passing in null for the textData parameter will reset it to default text data.
Parameters
- editableTextIndex: number
- textData: TextDocument
Returns void
- Defined in src/pag-file.ts:80

replaceImage

replaceImage(editableImageIndex: number, pagImage: PAGImage): void
Replace the image content of the specified index with a PAGImage object. The index ranges from 0 to PAGFile.numImages - 1. Passing in null for the image parameter will reset it to default image content.
Parameters
- editableImageIndex: number
- pagImage: PAGImage
Returns void
- Defined in src/pag-file.ts:88

getLayersByEditableIndex

getLayersByEditableIndex(editableIndex: Number, layerType: LayerType): Vector<PAGImageLayer | PAGLayer | PAGSolidLayer | PAGTextLayer>
Return an array of layers by specified editable index and layer type.
Parameters
- editableIndex: Number
- layerType: LayerType
Returns Vector<PAGImageLayer | PAGLayer | PAGSolidLayer | PAGTextLayer>
- Defined in src/pag-file.ts:94

getEditableIndices

getEditableIndices(layerType: LayerType): number[]
Returns the indices of the editable layers in this PAGFile. If the editableIndex of a PAGLayer is not present in the returned indices, the PAGLayer should not be treated as editable.
Parameters
- layerType: LayerType
Returns number[]
- Defined in src/pag-file.ts:104

timeStretchMode

timeStretchMode(): PAGTimeStretchMode
Indicate how to stretch the original duration to fit target duration when file's duration is changed. The default value is PAGTimeStretchMode::Repeat.

Returns PAGTimeStretchMode
- Defined in src/pag-file.ts:111

setTimeStretchMode

setTimeStretchMode(value: PAGTimeStretchMode): void
Set the timeStretchMode of this file.
Parameters
- value: PAGTimeStretchMode
Returns void
- Defined in src/pag-file.ts:117

setDuration

setDuration(duration: number): void
Set the duration of this PAGFile. Passing a value less than or equal to 0 resets the duration to its default value.
Parameters
- duration: number
Returns void
- Defined in src/pag-file.ts:124

copyOriginal

copyOriginal(): PAGFile
Set the duration of this PAGFile. Passing a value less than or equal to 0 resets the duration to its default value.

Returns PAGFile
- Defined in src/pag-file.ts:131

width

width(): number
Returns the width of the Composition.

Returns number
Inherited from PAGComposition.width
- Defined in src/pag-composition.ts:22

height

height(): number
Returns the height of the Composition.

Returns number
Inherited from PAGComposition.height
- Defined in src/pag-composition.ts:28

setContentSize

setContentSize(width: number, height: number): void
Set the width and height of the Composition.
Parameters
- width: number
- height: number
Returns void
Inherited from PAGComposition.setContentSize
- Defined in src/pag-composition.ts:34

numChildren

numChildren(): number
Returns the number of child layers of this composition.

Returns number
Inherited from PAGComposition.numChildren
- Defined in src/pag-composition.ts:40

getLayerAt

getLayerAt(index: number): PAGImageLayer | PAGLayer | PAGSolidLayer | PAGTextLayer
Returns the child layer that exists at the specified index.

Returns
The child layer at the specified index position.
Parameters
- index: number
  
  The index position of the child layer.
Returns PAGImageLayer | PAGLayer | PAGSolidLayer | PAGTextLayer
Inherited from PAGComposition.getLayerAt
- Defined in src/pag-composition.ts:48

getLayerIndex

getLayerIndex(pagLayer: PAGLayer): number
Returns the index position of a child layer.

Returns
The index position of the child layer to identify.
Parameters
- pagLayer: PAGLayer
  
  The layer instance to identify.
Returns number
Inherited from PAGComposition.getLayerIndex
- Defined in src/pag-composition.ts:58

setLayerIndex

setLayerIndex(pagLayer: PAGLayer, index: number): number
Changes the position of an existing child layer in the composition. This affects the layering of child layers.
Parameters
- pagLayer: PAGLayer
  
  The child layer for which you want to change the index number.
- index: number
  
  The resulting index number for the child layer.
Returns number
Inherited from PAGComposition.setLayerIndex
- Defined in src/pag-composition.ts:67

addLayer

addLayer(pagLayer: PAGLayer): boolean
Add a PAGLayer to current PAGComposition at the top. If you add a layer that already has a different PAGComposition object as a parent, the layer is removed from the other PAGComposition object.
Parameters
- pagLayer: PAGLayer
Returns boolean
Inherited from PAGComposition.addLayer
- Defined in src/pag-composition.ts:75

addLayerAt

addLayerAt(pagLayer: PAGLayer, index: number): boolean
Add a PAGLayer to current PAGComposition at the top. If you add a layer that already has a different PAGComposition object as a parent, the layer is removed from the other PAGComposition object.
Parameters
- pagLayer: PAGLayer
- index: number
Returns boolean
Inherited from PAGComposition.addLayerAt
- Defined in src/pag-composition.ts:83

contains

contains(pagLayer: PAGLayer): boolean
Check whether current PAGComposition contains the specified pagLayer.
Parameters
- pagLayer: PAGLayer
Returns boolean
Inherited from PAGComposition.contains
- Defined in src/pag-composition.ts:89

removeLayer

removeLayer(pagLayer: PAGLayer): PAGImageLayer | PAGLayer | PAGSolidLayer | PAGTextLayer
Remove the specified PAGLayer from current PAGComposition.
Parameters
- pagLayer: PAGLayer
Returns PAGImageLayer | PAGLayer | PAGSolidLayer | PAGTextLayer
Inherited from PAGComposition.removeLayer
- Defined in src/pag-composition.ts:95

removeLayerAt

removeLayerAt(index: number): PAGImageLayer | PAGLayer | PAGSolidLayer | PAGTextLayer
Remove the specified PAGLayer from current PAGComposition.
Parameters
- index: number
Returns PAGImageLayer | PAGLayer | PAGSolidLayer | PAGTextLayer
Inherited from PAGComposition.removeLayerAt
- Defined in src/pag-composition.ts:103

removeAllLayers

removeAllLayers(): void
Remove all PAGLayers from current PAGComposition.

Returns void
Inherited from PAGComposition.removeAllLayers
- Defined in src/pag-composition.ts:111

swapLayer

swapLayer(pagLayer1: PAGLayer, pagLayer2: PAGLayer): void
Swap the layers at the specified index.
Parameters
- pagLayer1: PAGLayer
- pagLayer2: PAGLayer
Returns void
Inherited from PAGComposition.swapLayer
- Defined in src/pag-composition.ts:117

swapLayerAt

swapLayerAt(index1: number, index2: number): void
Swap the layers at the specified index.
Parameters
- index1: number
- index2: number
Returns void
Inherited from PAGComposition.swapLayerAt
- Defined in src/pag-composition.ts:123

audioBytes

audioBytes(): null | Uint8Array
The audio data of this composition, which is an AAC audio in an MPEG-4 container.

Returns null | Uint8Array
Inherited from PAGComposition.audioBytes
- Defined in src/pag-composition.ts:129

audioMarkers

audioMarkers(): Vector<Marker>
Returns the audio markers of this composition.

Returns Vector<Marker>
Inherited from PAGComposition.audioMarkers
- Defined in src/pag-composition.ts:135

audioStartTime

audioStartTime(): number
Indicates when the first frame of the audio plays in the composition's timeline.

Returns number
Inherited from PAGComposition.audioStartTime
- Defined in src/pag-composition.ts:143

getLayersByName

getLayersByName(layerName: string): Vector<PAGImageLayer | PAGLayer | PAGSolidLayer | PAGTextLayer>
Returns an array of layers that match the specified layer name.
Parameters
- layerName: string
Returns Vector<PAGImageLayer | PAGLayer | PAGSolidLayer | PAGTextLayer>
Inherited from PAGComposition.getLayersByName
- Defined in src/pag-composition.ts:149

getLayersUnderPoint

getLayersUnderPoint(localX: number, localY: number): Vector<PAGImageLayer | PAGLayer | PAGSolidLayer | PAGTextLayer>
Returns an array of layers that lie under the specified point. The point is in pixels and from this PAGComposition's local coordinates.
Parameters
- localX: number
- localY: number
Returns Vector<PAGImageLayer | PAGLayer | PAGSolidLayer | PAGTextLayer>
Inherited from PAGComposition.getLayersUnderPoint
- Defined in src/pag-composition.ts:158

uniqueID

uniqueID(): number
Returns a globally unique id for this object.

Returns number
Inherited from PAGComposition.uniqueID
- Defined in src/pag-layer.ts:20

layerType

layerType(): LayerType
Returns the type of layer.

Returns LayerType
Inherited from PAGComposition.layerType
- Defined in src/pag-layer.ts:26

layerName

layerName(): string
Returns the name of the layer.

Returns string
Inherited from PAGComposition.layerName
- Defined in src/pag-layer.ts:32

matrix

matrix(): Matrix
A matrix object containing values that alter the scaling, rotation, and translation of the layer. Altering it does not change the animation matrix, and it will be concatenated to current animation matrix for displaying.

Returns Matrix
Inherited from PAGComposition.matrix
- Defined in src/pag-layer.ts:40

setMatrix

setMatrix(matrix: Matrix): void
Parameters
- matrix: Matrix
Returns void
Inherited from PAGComposition.setMatrix
- Defined in src/pag-layer.ts:46

resetMatrix

resetMatrix(): void
Resets the matrix to its default value.

Returns void
Inherited from PAGComposition.resetMatrix
- Defined in src/pag-layer.ts:52

getTotalMatrix

getTotalMatrix(): Matrix
The final matrix for displaying, it is the combination of the matrix property and current matrix from animation.

Returns Matrix
Inherited from PAGComposition.getTotalMatrix
- Defined in src/pag-layer.ts:59

alpha

alpha(): number
Returns the current alpha of the layer if previously set.

Returns number
Inherited from PAGComposition.alpha
- Defined in src/pag-layer.ts:67

setAlpha

setAlpha(opacity: Number): void
Set the alpha of the layer, which will be concatenated to the current animation opacity for displaying.
Parameters
- opacity: Number
Returns void
Inherited from PAGComposition.setAlpha
- Defined in src/pag-layer.ts:74

visible

visible(): boolean
Whether or not the layer is visible.

Returns boolean
Inherited from PAGComposition.visible
- Defined in src/pag-layer.ts:81

setVisible

setVisible(visible: boolean): void
Set the visible of the layer.
Parameters
- visible: boolean
Returns void
Inherited from PAGComposition.setVisible
- Defined in src/pag-layer.ts:87

editableIndex

editableIndex(): number
Ranges from 0 to PAGFile.numTexts - 1 if the layer type is text, or from 0 to PAGFile.numImages -1 if the layer type is image, otherwise returns -1.

Returns number
Inherited from PAGComposition.editableIndex
- Defined in src/pag-layer.ts:94

parent

parent(): PAGComposition
Returns the parent PAGComposition of current PAGLayer.

Returns PAGComposition
Inherited from PAGComposition.parent
- Defined in src/pag-layer.ts:100

markers

markers(): Vector<Marker>
Returns the markers of this layer.

Returns Vector<Marker>
Inherited from PAGComposition.markers
- Defined in src/pag-layer.ts:108

localTimeToGlobal

localTimeToGlobal(localTime: number): number
Converts the time from the PAGLayer's (local) timeline to the PAGSurface (global) timeline. The time is in microseconds.
Parameters
- localTime: number
Returns number
Inherited from PAGComposition.localTimeToGlobal
- Defined in src/pag-layer.ts:117

globalToLocalTime

globalToLocalTime(globalTime: number): number
Converts the time from the PAGSurface (global) to the PAGLayer's (local) timeline timeline. The time is in microseconds.
Parameters
- globalTime: number
Returns number
Inherited from PAGComposition.globalToLocalTime
- Defined in src/pag-layer.ts:124

duration

duration(): number
The duration of the layer in microseconds, indicates the length of the visible range.

Returns number
Inherited from PAGComposition.duration
- Defined in src/pag-layer.ts:130

frameRate

frameRate(): number
Returns the frame rate of this layer.

Returns number
Inherited from PAGComposition.frameRate
- Defined in src/pag-layer.ts:136

startTime

startTime(): number
The start time of the layer in microseconds, indicates the start position of the visible range in parent composition. It could be negative value.

Returns number
Inherited from PAGComposition.startTime
- Defined in src/pag-layer.ts:143

setStartTime

setStartTime(time: number): void
Set the start time of the layer, in microseconds.
Parameters
- time: number
Returns void
Inherited from PAGComposition.setStartTime
- Defined in src/pag-layer.ts:149

currentTime

currentTime(): number
The current time of the layer in microseconds, the layer is invisible if currentTime is not in the visible range (startTime <= currentTime < startTime + duration).

Returns number
Inherited from PAGComposition.currentTime
- Defined in src/pag-layer.ts:156

setCurrentTime

setCurrentTime(time: number): void
Set the current time of the layer, in microseconds.
Parameters
- time: number
Returns void
Inherited from PAGComposition.setCurrentTime
- Defined in src/pag-layer.ts:162

getProgress

getProgress(): number
Returns the current progress of play position, the value ranges from 0.0 to 1.0.

Returns number
Inherited from PAGComposition.getProgress
- Defined in src/pag-layer.ts:168

setProgress

setProgress(percent: number): void
Set the progress of play position, the value ranges from 0.0 to 1.0. A value of 0.0 represents the frame at startTime. A value of 1.0 represents the frame at the end of duration.
Parameters
- percent: number
Returns void
Inherited from PAGComposition.setProgress
- Defined in src/pag-layer.ts:175

preFrame

preFrame(): void
Set the progress of play position to the previous frame.

Returns void
Inherited from PAGComposition.preFrame
- Defined in src/pag-layer.ts:181

nextFrame

nextFrame(): void
Set the progress of play position to the next frame.

Returns void
Inherited from PAGComposition.nextFrame
- Defined in src/pag-layer.ts:187

getBounds

getBounds(): Rect
Returns a rectangle that defines the original area of the layer, which is not transformed by the matrix.

Returns Rect
Inherited from PAGComposition.getBounds
- Defined in src/pag-layer.ts:194

trackMatteLayer

trackMatteLayer(): PAGLayer
Returns trackMatte layer of this layer.

Returns PAGLayer
Inherited from PAGComposition.trackMatteLayer
- Defined in src/pag-layer.ts:200

excludedFromTimeline

excludedFromTimeline(): boolean
Indicate whether this layer is excluded from parent's timeline. If set to true, this layer's current time will not change when parent's current time changes.

Returns boolean
Inherited from PAGComposition.excludedFromTimeline
- Defined in src/pag-layer.ts:209

setExcludedFromTimeline

setExcludedFromTimeline(value: boolean): void
Set the excludedFromTimeline flag of this layer.
Parameters
- value: boolean
Returns void
Inherited from PAGComposition.setExcludedFromTimeline
- Defined in src/pag-layer.ts:215

isPAGFile

isPAGFile(): boolean
Returns true if this layer is a PAGFile.

Returns boolean
Inherited from PAGComposition.isPAGFile
- Defined in src/pag-layer.ts:221

asTypeLayer

asTypeLayer(): PAGImageLayer | PAGLayer | PAGSolidLayer | PAGTextLayer
Returns this layer as a type layer.

Returns PAGImageLayer | PAGLayer | PAGSolidLayer | PAGTextLayer
Inherited from PAGComposition.asTypeLayer
- Defined in src/pag-layer.ts:227

isDelete

isDelete(): boolean
Returns boolean
Inherited from PAGComposition.isDelete
- Defined in src/pag-layer.ts:231

destroy

destroy(): void
Returns void
Inherited from PAGComposition.destroy
- Defined in src/pag-layer.ts:235

Constructors

constructor

new PAGFile(wasmIns: any): PAGFile
Parameters
- wasmIns: any
Returns PAGFile
Inherited from PAGComposition.constructor
- Defined in src/pag-layer.ts:14

Class PAGFile

Hierarchy

Index

Methods

Constructors

Properties

Methods

Static load

Parameters

data: ArrayBuffer | File | Blob

Returns Promise<PAGFile>

Static loadFromBuffer

Parameters

buffer: ArrayBuffer

Returns PAGFile

Static maxSupportedTagLevel

Returns number

Static make

Parameters

width: number

height: number

Returns PAGComposition

tagLevel

Returns number

numTexts

Returns number

numImages

Returns number

numVideos

Returns number

getTextData

Parameters

editableTextIndex: number

Returns TextDocument

replaceText

Parameters

editableTextIndex: number

textData: TextDocument

Returns void

replaceImage

Parameters

editableImageIndex: number

pagImage: PAGImage

Returns void

getLayersByEditableIndex

Parameters

editableIndex: Number

layerType: LayerType

Returns Vector<PAGImageLayer | PAGLayer | PAGSolidLayer | PAGTextLayer>

getEditableIndices

Parameters

layerType: LayerType

Returns number[]

timeStretchMode

Returns PAGTimeStretchMode

setTimeStretchMode

Parameters

value: PAGTimeStretchMode

Returns void

setDuration

Parameters

duration: number

Returns void

copyOriginal

Returns PAGFile

width

Returns number

height

Returns number

setContentSize

Parameters

width: number

height: number

Returns void

numChildren

Returns number

getLayerAt

Returns

Parameters

index: number

`Static` load

`Static` loadFromBuffer

`Static` maxSupportedTagLevel

`Static` make