composable

Index

composable/executors Enumerations

FFmpegErrorDetector

composable Classes

composable/composites Classes

composable/executors Classes

composable Interfaces

composable/executors Interfaces

composable Type aliases

composable/executors Variables

BlackScenePattern

composable Functions

composable/composites Functions

composable Type aliases

FilterParams

FilterParams: Record<string, string | number>

category: composable

FragmentLike

FragmentLike: IFragment

Stream

Stream: string | StreamRef | ISource

composable/executors Variables

BlackScenePattern

BlackScenePattern: RegExp = /black_start:\s*(?<start>[0-9]+(\.[0-9]+)?)\s+black_end:\s*(?<end>[0-9]+(\.[0-9]+)?)/i

composable Functions

command

command(...fragments: FragmentLike[]): CommandOptions

- Defined in src/Compiler.ts:347
Parameters
- Rest ...fragments: FragmentLike[]
Returns CommandOptions

composite

composite<T>(compose: (...args: T) => Stream | Stream[]): (...args: T) => Composite

- Defined in src/Filter.ts:299
Type parameters
- T: any[]
Parameters
- compose: (...args: T) => Stream | Stream[]
  - - (...args: T): Stream | Stream[]
    - Parameters
      - Rest ...args: T
      Returns Stream | Stream[]
Returns (...args: T) => Composite
- - (...args: T): Composite
  - Parameters
    - Rest ...args: T
    Returns Composite

filter

filter(inputs: Stream | Stream[], name: string, parameters?: FilterParams): Filter
filter(inputs: Stream | Stream[], name: string, parameters: FilterParams, outputs: number): Filter

- Defined in src/Filter.ts:190
Parameters
- inputs: Stream | Stream[]
- name: string
- Optional parameters: FilterParams
Returns Filter
- Defined in src/Filter.ts:191
Parameters
- inputs: Stream | Stream[]
- name: string
- parameters: FilterParams
- outputs: number
Returns Filter

isPlaceholder

isPlaceholder(obj: any): obj is IPlaceholder<any>

- Defined in src/Compiler.ts:22
Parameters
- obj: any
Returns obj is IPlaceholder<any>

composable/composites Functions

audioSkip

audioSkip(input: Stream, start: number, end: number): AudioSkipComposite

- Defined in src/Composites/AudioSkip.ts:37
Parameters
- input: Stream
- start: number
- end: number
Returns AudioSkipComposite

blackout

blackout(input: Stream, width: number, height: number, start: number, end: number): BlackoutComposite

- Defined in src/Composites/Blackout.ts:48
Parameters
- input: Stream
- width: number
- height: number
- start: number
- end: number
Returns BlackoutComposite

checkDimensions

checkDimensions(videos: Stream[][], audios: Stream[][]): void

- Defined in src/Composites/Concat.ts:8
Parameters
- videos: Stream[][]
- audios: Stream[][]
Returns void

concat

concat(videos: Stream[][], audios: Stream[][]): ConcatComposite

- Defined in src/Composites/Concat.ts:64
Parameters
- videos: Stream[][]
- audios: Stream[][]
Returns ConcatComposite

separator

separator<T>(items: T[], separator: (index: number, item: T) => T): T[]

- Defined in src/Composites/Concat.ts:71
Type parameters
- T
Parameters
- items: T[]
- separator: (index: number, item: T) => T
  - - (index: number, item: T): T
    - Parameters
      - index: number
      - item: T
      Returns T
Returns T[]

silence

silence(duration: number, options?: AudioEvalSrcParameters): SilenceComposite

- Defined in src/Composites/Silence.ts:36
Parameters
- duration: number
- Default value options: AudioEvalSrcParameters = {}
Returns SilenceComposite

skip

skip(video: Stream, audio: Stream, start: number, end: number): SkipComposite

- Defined in src/Composites/Skip.ts:42
Parameters
- video: Stream
- audio: Stream
- start: number
- end: number
Returns SkipComposite

trim

trim(video: Stream, audio: Stream, start: number, end: number): TrimComposite

- Defined in src/Composites/Trim.ts:46
Parameters
- video: Stream
- audio: Stream
- start: number
- end: number
Returns TrimComposite

videoSkip

videoSkip(input: Stream, start: number, end: number): VideoSkipComposite

- Defined in src/Composites/VideoSkip.ts:37
Parameters
- input: Stream
- start: number
- end: number
Returns VideoSkipComposite

Generated using TypeDoc