@rendley/sdk - v1.15.5
    Preparing search index...

    Class Transition

    Represents a transition between two neighboring clips on a layer.

    Index

    Constructors

    Methods

    • Releases all render resources and detaches this transition from its clips.

      Returns void

      Nothing.

    • Returns the incoming clip ID.

      Returns string

      The end clip ID.

    • Returns the unique instance ID of this transition.

      Returns string

      The transition instance ID.

    • Returns the overlap duration contributed by the start clip.

      Returns number

      The in duration, in seconds.

    • Returns the display name of this transition.

      Returns string

      The transition name.

    • Returns the overlap duration contributed by the end clip.

      Returns number

      The out duration, in seconds.

    • Returns a transition property value.

      Parameters

      • propertyName: string

        Name of the transition property to read.

      Returns any

      The property value, or undefined if the property is unavailable.

    • Returns the provider identifier of the transition definition.

      Returns string

      The provider ID.

    • Returns the sprite used to display the rendered transition.

      Returns Sprite

      The transition sprite.

    • Returns the outgoing clip ID.

      Returns string

      The start clip ID.

    • Returns the library transition ID used to create this instance.

      Returns string

      The transition definition ID.

    • Computes normalized transition progress for the specified timeline time.

      Parameters

      • currentTime: number

        Timeline time, in seconds.

      Returns number

      Transition progress clamped to the [0, 1] range.

    • Resolves clip references, transition data, textures, and render resources for this transition.

      Parameters

      • layerId: string

        ID of the layer that owns the transition.

      Returns void

      Nothing.

    • Lifecycle hook called when playback pauses.

      Parameters

      • currentTime: number

        Current timeline time, in seconds.

      Returns void

      Nothing.

    • Lifecycle hook called when playback starts.

      Parameters

      • currentTime: number

        Current timeline time, in seconds.

      Returns Promise<void>

      A promise that resolves after the hook completes.

    • Recreates transition render textures for a new render size.

      Parameters

      • width: number

        New render width, in pixels.

      • height: number

        New render height, in pixels.

      Returns void

      Nothing.

    • Lifecycle hook called after transition rendering completes for a frame.

      Parameters

      • currentTime: number

        Timeline time, in seconds.

      Returns void

      Nothing.

    • Renders the two source clips into the transition textures for the specified frame.

      Parameters

      • currentTime: number

        Timeline time, in seconds.

      Returns void

      Nothing.

    • Serializes this transition instance.

      Returns {
          endClipId: string;
          id: string;
          inDuration: number;
          outDuration: number;
          properties: [string, any][];
          provider: string;
          startClipId: string;
          transitionId: string;
      }

      The serialized transition payload.

    • Rebinds the transition to a different incoming clip.

      Parameters

      • endClipId: string

        Clip ID that should become the end clip.

      Returns void

      Nothing.

    • Sets the portion of the transition that overlaps the outgoing clip.

      Parameters

      • inDuration: number

        Duration, in seconds, contributed by the start clip.

      Returns void

      Nothing.

    • Overrides the display name of the transition instance.

      Parameters

      • name: string

        Name to assign.

      Returns void

      Nothing.

    • Sets the portion of the transition that overlaps the incoming clip.

      Parameters

      • outDuration: number

        Duration, in seconds, contributed by the end clip.

      Returns void

      Nothing.

    • Updates a transition property value.

      Parameters

      • propertyName: string

        Name of the transition property to update.

      • value: any

        New property value.

      Returns void

      Nothing.

    • Rebinds the transition to a different outgoing clip.

      Parameters

      • startClipId: string

        Clip ID that should become the start clip.

      Returns void

      Nothing.

    • Updates transition uniforms for the specified timeline time.

      Parameters

      • currentTime: number

        Timeline time, in seconds.

      Returns void

      Nothing.

    • Recalculates in and out durations so they remain valid for the surrounding clips and nearby transitions.

      Returns void

      Nothing.

    • Creates a transition instance from serialized data.

      Parameters

      • data: object

        Serialized transition payload.

      Returns Transition

      The deserialized transition instance.