Class PAGFile

constructor

• new PAGFile(wasmIns): PAGFile

• Parameters

  • wasmIns: any

  Returns PAGFile

wasmIns

isDestroyed

Static loadFromBuffer

• loadFromBuffer(buffer): PAGFile

• Load pag file from arrayBuffer

  Parameters

  • buffer: ArrayBuffer

  Returns PAGFile

Static maxSupportedTagLevel

• maxSupportedTagLevel(): number

• The maximum tag level current SDK supports.

  Returns number

Static make

• make(width, height): PAGComposition

• Make a empty PAGComposition with specified size.

  Parameters

  • width: number

  • height: number

  Returns PAGComposition

tagLevel

• tagLevel(): number

• The tag level this pag file requires.

  Returns number

numTexts

• numTexts(): number

• The number of replaceable texts.

  Returns number

numImages

• numImages(): number

• The number of replaceable images.

  Returns number

numVideos

• numVideos(): number

• The number of video compositions.

  Returns number

getTextData

• getTextData(editableTextIndex): 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

replaceText

• replaceText(editableTextIndex, textData): 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

replaceImage

• replaceImage(editableImageIndex, 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

getLayersByEditableIndex

• getLayersByEditableIndex(editableIndex, 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>

getEditableIndices

• getEditableIndices(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[]

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

setTimeStretchMode

• setTimeStretchMode(value): void

• Set the timeStretchMode of this file.

  Parameters

  • value: PAGTimeStretchMode

  Returns void

setDuration

• setDuration(duration): 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

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

width

• width(): number

• Returns the width of the Composition.

  Returns number

height

• height(): number

• Returns the height of the Composition.

  Returns number

setContentSize

• setContentSize(width, height): void

• Set the width and height of the Composition.

  Parameters

  • width: number

  • height: number

  Returns void

numChildren

• numChildren(): number

• Returns the number of child layers of this composition.

  Returns number

getLayerAt

• getLayerAt(index): PAGImageLayer | PAGLayer | PAGSolidLayer | PAGTextLayer

• Returns the child layer that exists at the specified index.

  Parameters

  • index: number

    The index position of the child layer.

  Returns PAGImageLayer | PAGLayer | PAGSolidLayer | PAGTextLayer

  The child layer at the specified index position.

getLayerIndex

• getLayerIndex(pagLayer): number

• Returns the index position of a child layer.

  Parameters

  • pagLayer: PAGLayer

    The layer instance to identify.

  Returns number

  The index position of the child layer to identify.

setLayerIndex

• setLayerIndex(pagLayer, index): 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

addLayer

• addLayer(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

addLayerAt

• addLayerAt(pagLayer, index): 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

contains

• contains(pagLayer): boolean

• Check whether current PAGComposition contains the specified pagLayer.

  Parameters

  • pagLayer: PAGLayer

  Returns boolean

removeLayer

• removeLayer(pagLayer): PAGImageLayer | PAGLayer | PAGSolidLayer | PAGTextLayer

• Remove the specified PAGLayer from current PAGComposition.

  Parameters

  • pagLayer: PAGLayer

  Returns PAGImageLayer | PAGLayer | PAGSolidLayer | PAGTextLayer

removeLayerAt

• removeLayerAt(index): PAGImageLayer | PAGLayer | PAGSolidLayer | PAGTextLayer

• Remove the specified PAGLayer from current PAGComposition.

  Parameters

  • index: number

  Returns PAGImageLayer | PAGLayer | PAGSolidLayer | PAGTextLayer

removeAllLayers

• removeAllLayers(): void

• Remove all PAGLayers from current PAGComposition.

  Returns void

swapLayer

• swapLayer(pagLayer1, pagLayer2): void

• Swap the layers at the specified index.

  Parameters

  • pagLayer1: PAGLayer

  • pagLayer2: PAGLayer

  Returns void

swapLayerAt

• swapLayerAt(index1, index2): void

• Swap the layers at the specified index.

  Parameters

  • index1: number

  • index2: number

  Returns void

audioBytes

• audioBytes(): null | Uint8Array

• The audio data of this composition, which is an AAC audio in an MPEG-4 container.

  Returns null | Uint8Array

audioMarkers

• audioMarkers(): Vector<Marker>

• Returns the audio markers of this composition.

  Returns Vector<Marker>

audioStartTime

• audioStartTime(): number

• Indicates when the first frame of the audio plays in the composition's timeline.

  Returns number

getLayersByName

• getLayersByName(layerName): 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>

getLayersUnderPoint

• getLayersUnderPoint(localX, localY): 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>

uniqueID

• uniqueID(): number

• Returns a globally unique id for this object.

  Returns number

layerType

• layerType(): LayerType

• Returns the type of layer.

  Returns LayerType

layerName

• layerName(): string

• Returns the name of the layer.

  Returns string

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

setMatrix

• setMatrix(matrix): void

• Parameters

  • matrix: Matrix

  Returns void

resetMatrix

• resetMatrix(): void

• Resets the matrix to its default value.

  Returns void

getTotalMatrix

• getTotalMatrix(): Matrix

• Returns the layer's display matrix by combining its matrix) property with the current animation matrix from the AE timeline. This does not include the parent layer's matrix. To calculate the final bounds relative to the PAGSurface, use the PAGPlayer::getBounds(PAGLayer layer) method directly.

  Returns Matrix

alpha

• alpha(): number

• Returns the current alpha of the layer if previously set.

  Returns number

setAlpha

• setAlpha(opacity): void

• Set the alpha of the layer, which will be concatenated to the current animation opacity for displaying.

  Parameters

  • opacity: Number

  Returns void

visible

• visible(): boolean

• Whether or not the layer is visible.

  Returns boolean

setVisible

• setVisible(visible): void

• Set the visible of the layer.

  Parameters

  • visible: boolean

  Returns void

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

parent

• parent(): PAGComposition

• Returns the parent PAGComposition of current PAGLayer.

  Returns PAGComposition

markers

• markers(): Vector<Marker>

• Returns the markers of this layer.

  Returns Vector<Marker>

localTimeToGlobal

• localTimeToGlobal(localTime): 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

globalToLocalTime

• globalToLocalTime(globalTime): 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

duration

• duration(): number

• The duration of the layer in microseconds, indicates the length of the visible range.

  Returns number

frameRate

• frameRate(): number

• Returns the frame rate of this layer.

  Returns number

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

setStartTime

• setStartTime(time): void

• Set the start time of the layer, in microseconds.

  Parameters

  • time: number

  Returns void

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

setCurrentTime

• setCurrentTime(time): void

• Set the current time of the layer, in microseconds.

  Parameters

  • time: number

  Returns void

getProgress

• getProgress(): number

• Returns the current progress of play position, the value ranges from 0.0 to 1.0.

  Returns number

setProgress

• setProgress(percent): 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

preFrame

• preFrame(): void

• Set the progress of play position to the previous frame.

  Returns void

nextFrame

• nextFrame(): void

• Set the progress of play position to the next frame.

  Returns void

getBounds

• getBounds(): Rect

• Returns a rectangle that defines the original area of the layer, which is not transformed by the matrix.

  Returns Rect

trackMatteLayer

• trackMatteLayer(): PAGLayer

• Returns trackMatte layer of this layer.

  Returns PAGLayer

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

setExcludedFromTimeline

• setExcludedFromTimeline(value): void

• Set the excludedFromTimeline flag of this layer.

  Parameters

  • value: boolean

  Returns void

isPAGFile

• isPAGFile(): boolean

• Returns true if this layer is a PAGFile.

  Returns boolean

asTypeLayer

• asTypeLayer(): PAGImageLayer | PAGLayer | PAGSolidLayer | PAGTextLayer

• Returns this layer as a type layer.

  Returns PAGImageLayer | PAGLayer | PAGSolidLayer | PAGTextLayer

isDelete

• isDelete(): boolean

• Returns boolean

destroy

• destroy(): void

• Returns void