Class Effect

Represents an effect instance resolved from the library and applied to a clip.

Index

Constructors

Methods

destroy getClipId getEffectId getId getIsBuiltIn getPixiFilter getProperties getProperty getProvider init serialize setClipId setId setProperty update deserialize

Constructors

constructor

new Effect(effectId: string, properties?: Record<string, any>): Effect
Creates an effect wrapper for a library effect definition.
Parameters
- effectId: string
  Library effect ID to instantiate.
- Optionalproperties: Record<string, any>
  Optional initial property values applied during initialization.
Returns Effect

Methods

destroy

destroy(): void
Releases textures and destroys the underlying effect implementation.

Returns void
Nothing.

getClipId

getClipId(): undefined | string
Returns the owning clip ID, if one has been assigned.

Returns undefined | string
The owning clip ID, or undefined if the effect is not attached to a clip.

getEffectId

getEffectId(): string
Returns the library effect ID used to create this instance.

Returns string
The effect definition ID.

getId

getId(): string
Returns the unique instance ID of this effect.

Returns string
The effect instance ID.

getIsBuiltIn

getIsBuiltIn(): boolean
Indicates whether the underlying library effect is built into the SDK.

Returns boolean
true if the effect definition is built in; otherwise false.

getPixiFilter

getPixiFilter(): null | Pixi.Filter
Returns the underlying PIXI filter exposed by the effect implementation.

Returns null | Pixi.Filter
The PIXI filter, or null if the effect has not been initialized.

getProperties

getProperties(): Map<string, any>
Returns the live property map used by this effect instance.

Returns Map<string, any>
The effect property map.

getProperty

getProperty(propertyName: string): any
Returns the current value of an effect property.
Parameters
- propertyName: string
  Name of the effect property to read.
Returns any
A cloned copy of the property value, or undefined if the property is unknown.

getProvider

getProvider(): string
Returns the provider identifier of the library effect definition.

Returns string
The provider ID.

init

init(): void
Resolves the effect definition from the library and creates the underlying effect implementation.

Returns void
Nothing.

serialize

serialize(): {
    clipId?: string;
    effectId: string;
    id: string;
    properties: [string, any][];
    provider: string;
}
Serializes this effect instance.

Returns {
    clipId?: string;
    effectId: string;
    id: string;
    properties: [string, any][];
    provider: string;
}
The serialized effect payload.

setClipId

setClipId(clipId: string): void
Associates the effect with a clip.
Parameters
- clipId: string
  Clip ID that owns the effect.
Returns void
Nothing.

setId

setId(id: string): void
Overrides the effect instance ID.
Parameters
- id: string
  Effect instance ID to assign.
Returns void
Nothing.

setProperty

setProperty(propertyName: string, value: any): void
Updates an effect property value.
Parameters
- propertyName: string
  Name of the effect property to update.
- value: any
  New property value.
Returns void
Nothing.

update

update(clipTime: number): void
Updates the effect for the specified clip-local time.
Parameters
- clipTime: number
  Clip-local playback time, in seconds.
Returns void
Nothing.

`Static`deserialize

deserialize(data: object): Effect
Creates an effect instance from serialized data.
Parameters
- data: object
  Serialized effect payload.
Returns Effect
The deserialized effect instance.