Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Instruction

Instruction

Video Instruction performed by a compositor.

Hierarchy

  • Instruction

Index

Properties

index

index: number

The index (read-only) of this instruction.

type

int

time

time: number

The "tween" time (read-only) for this instruction. This is a normalized value between 0.0 and 1.0.

type

float

trackIds

trackIds: Array<string>

The track IDs (read-only) associated with this instruction.

type

Array

see

Instruction#trackLayerIds

trackLayerIds

trackLayerIds: Array<string>

The track layer IDs (read/write) associated with this instruction. The tracks can be reordered per instruction.

type

Array

see

Instruction#trackIds

Methods

addFilter

  • addFilter(filter: Filter, trackId: string): void
  • Adds a filter that should be used for the specified trackId.

    see

    Instruction#getFilters, Filter

    Parameters

    • filter: Filter
    • trackId: string

    Returns void

addGraph

  • Adds a graph that should be used for the specified trackId.

    see

    Graph

    Parameters

    Returns void

addKernel

  • addKernel(kernel: Kernel, trackId: string): void
  • Adds a shader that should be used for the specified trackId.

    see

    Instruction#getKernels, Kernel

    Parameters

    • kernel: Kernel
    • trackId: string

    Returns void

addShader

  • addShader(shader: Shader, trackId: string): void
  • Adds a shader that should be used for the specified trackId.

    see

    Instruction#getShaders, Shader

    Parameters

    • shader: Shader
    • trackId: string

    Returns void

crop

  • crop(x: number, y: number, width: number, height: number, trackId: string): void
  • Sets a crop that should be used for the specified trackId.

    see

    Instruction#getTransform, Instruction#setTransform, Transform

    Parameters

    • x: number
    • y: number
    • width: number
    • height: number
    • trackId: string

    Returns void

getImage

  • getImage(trackId: string): Image
  • getImage(trackId: string, loadImage?: boolean): Image
  • Gets the image "frame" associated with this instruction for the specified trackId.

    Parameters

    • trackId: string

    Returns Image

  • Gets the image "frame" associated with this instruction for the specified trackId.

    Parameters

    • trackId: string
    • Optional loadImage: boolean

      Needs doc

    Returns Image

getImageSize

  • getImageSize(trackId: string): object
  • Gets the image "frame" size associated with this instruction for the specified trackId.

    Parameters

    • trackId: string

    Returns object

setAlpha

  • setAlpha(alpha: number, trackId: string): void
  • Sets the alpha value that should be used for the specified trackId.

    see

    Instruction#getAlpha

    Parameters

    • alpha: number
    • trackId: string

    Returns void

setBlendMode

  • setBlendMode(blendMode: string, trackId: string): void
  • Sets the blend mode value that should be used for the specified trackId.

    see

    Instruction#getAlpha

    Parameters

    • blendMode: string
    • trackId: string

      Available Values:

      componentAdd; componentMultiply; componentMin; componentMax; clear; source; destination; sourceOver; destinationOver; sourceIn; destinationIn; sourceOut; destinationOut; sourceAtop; destinationAtop; exclusiveOr; multiply; screen; overlay; darken; lighten; colorDodge; colorBurn; hardLight; softLight; difference; exclusion; hue; saturation; color; luminosity; subtract; divide; linearBurn; linearDodge; vividLight; linearLight; pinLight; hardMix; darkerColor; lighterColor;

    Returns void

setImage

  • setImage(image: Image, trackId: string): void
  • Sets an image that should be used for the specified trackId.

    see

    Instruction#getAlpha

    Parameters

    • image: Image
    • trackId: string

    Returns void

setTransform

  • Sets the Transform that should be used for the specified trackId.

    see

    Instruction#getTransform, Transform

    Parameters

    Returns void

Generated using TypeDoc