Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Clip

Clip A media clip.

Hierarchy

  • Clip

Index

Constructors

constructor

  • new Clip(duration: number): Clip
  • new Clip(startTime: number, duration: number): Clip
  • new Clip(startTime: number, duration: number, inputName: string): Clip
  • new Clip(startTime: number, duration: number, inputName: string, inputType: string): Clip
  • new Clip(startTime: number, duration: number, input: Input): Clip
  • new Clip(startTime: number, duration: number, input: Input, inputType: string): Clip
  • Creates an empty Clip with a specified duration.

    Parameters

    • duration: number

    Returns Clip

  • Creates a Clip with a specified start time and duration.

    Parameters

    • startTime: number

      The start time of a source input.

    • duration: number

    Returns Clip

  • Creates a Clip with a specified start time, duration and inputName.

    Parameters

    • startTime: number

      The start time of a source input.

    • duration: number
    • inputName: string

      The name of the "input" (video, audio) to use. The input name is the file name including the extension. example: watermark.mp4

    Returns Clip

  • Creates a Clip with a specified start time, duration, inputName and inputType

    Parameters

    • startTime: number

      The start time of a source input.

    • duration: number
    • inputName: string

      The name of the "input" (video, audio) to use. The input name is the file name including the extension. example: watermark.mp4

    • inputType: string

      The type of the "input" (video, audio) to use. Currently supported types: "video", "audio". If this is null the default "video" type will be used.

    Returns Clip

  • Creates a Clip with a specified start time, duration and input.

    Parameters

    • startTime: number

      The start time of a source input.

    • duration: number
    • input: Input

      The "input" (video, audio) object to use.

    Returns Clip

  • Creates a Clip with a specified start time, duration, input and inputType

    Parameters

    • startTime: number

      The start time of a source input.

    • duration: number
    • input: Input

      The "input" (video, audio) object to use.

    • inputType: string

      The type of the "input" (video, audio) to use. Currently supported types: "video", "audio". If this is null the default "video" type will be used.

    Returns Clip

Properties

duration

duration: number

The duration of this clip (read-only)

type

double

endTime

endTime: number

The end time of this clip after it is added to a track (read-only). This property is only valid after this clip is added to a track.

type

double

inputName

inputName: string

The input name of this clip (read-only)

type

double

inputType

inputType: string

The input type of this clip (read-only)

type

double

insertTime

insertTime: number

The insert time of this clip (read-only). This property is only valid after this clip is added to a track.

type

double

startTime

startTime: number

The start time of this clip (read-only)

type

double

Methods

scaleToDuration

  • scaleToDuration(duration: number): void
  • Scales this clip to the specified duration.

    see

    Clip#duration

    Parameters

    • duration: number

    Returns void

Generated using TypeDoc