Skip to content

TranscodeOptions.md

Latest commit

 

History

History
134 lines (74 loc) · 3.41 KB

TranscodeOptions.md

File metadata and controls

134 lines (74 loc) · 3.41 KB

downflux

downflux / TranscodeOptions

Interface: TranscodeOptions

Defined in: packages/contracts/StorageContracts.ts:30

Properties

inputPath?

optional inputPath?: string

Defined in: packages/contracts/StorageContracts.ts:35

Internal path of the downloaded media file that should be finalized. DownFlux sets this automatically when a streamed file needs ffmpeg.

ffmpegPath?

optional ffmpegPath?: string

Defined in: packages/contracts/StorageContracts.ts:45

Explicit ffmpeg executable path.

Use this when the consuming project cannot use the bundled ffmpeg-static binary, for example when pnpm build scripts are disabled.

Example

'/opt/homebrew/bin/ffmpeg'

deleteInput?

optional deleteInput?: boolean

Defined in: packages/contracts/StorageContracts.ts:51

Deletes the intermediate input file after successful finalization.

Default Value

true

ffmpegArgs?

optional ffmpegArgs?: string[]

Defined in: packages/contracts/StorageContracts.ts:57

Complete custom ffmpeg arguments. When provided, these replace DownFlux's default remux/transcode arguments.

outputExtension?

optional outputExtension?: string

Defined in: packages/contracts/StorageContracts.ts:63

Final media container extension.

Default Value

'mp4'

preset?

optional preset?: "medium" | "ultrafast" | "superfast" | "veryfast" | "faster" | "fast" | "slow"

Defined in: packages/contracts/StorageContracts.ts:68

ffmpeg encoder preset used when transcoding with an encoder such as libx264.

crf?

optional crf?: number

Defined in: packages/contracts/StorageContracts.ts:73

Constant Rate Factor used when transcoding with an encoder such as libx264.

videoCodec?

optional videoCodec?: string

Defined in: packages/contracts/StorageContracts.ts:79

ffmpeg video codec.

Default Value

'copy'

audioCodec?

optional audioCodec?: string

Defined in: packages/contracts/StorageContracts.ts:85

ffmpeg audio codec.

Default Value

'copy'