Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Input

Represents an input (like a video file or a lavfi filter).

const input = new Input( 'path/to/file.mp4' );

Optionally can also receive an array of arguments to include before the input (for example, for seeking the media).

// Starts the input at the 1-minute mark.
const input = new Input( 'path/to/file.mp4', [ '-ss', 60 ] );

Hierarchy

  • Input

Implements

Index

Constructors

constructor

  • new Input(url: string, options?: (string | number | IPlaceholder<string | number>)[]): Input
  • Parameters

    • url: string
    • Default value options: (string | number | IPlaceholder<string | number>)[] = []

    Returns Input

Properties

index

index: number

options

options: (string | number | IPlaceholder<string | number>)[]

outputs

outputs: InputStreamRef[] = []

url

url: string

Accessors

dependencies

  • Returns IFragment[]

Methods

[Symbol.iterator]

clone

compile

Protected compileOptions

  • compileOptions(): string[]
  • Returns string[]

materialize

  • materialize(): string

named

  • named(...names: string[]): this
  • Parameters

    • Rest ...names: string[]

    Returns this

select

  • Parameters

    • selector: string

    Returns SelectStreamRef

Static isStream

  • isStream(obj: any): obj is Input | InputStreamRef
  • Parameters

    • obj: any

    Returns obj is Input | InputStreamRef

Static isStreamLike

  • isStreamLike(obj: any): obj is Input | InputStreamRef | string
  • Parameters

    • obj: any

    Returns obj is Input | InputStreamRef | string

Generated using TypeDoc