Skip to content

@seydx/rtsp / FfmpegSinkOptions

Interface: FfmpegSinkOptions

Defined in: sinks/ffmpeg.ts:23

Options for creating an FfmpegSink.

Configures where the remuxed stream is written and how the container is formatted. Only output is required; the container format is inferred from a path or URL when not given explicitly.

Properties

format?

optional format?: string

Defined in: sinks/ffmpeg.ts:39

The container/muxer format to produce.

Forwarded to node-av to select the output muxer (e.g. mp4, flv, mpegts). When omitted, the format is inferred from the file extension or URL scheme of output.


logger?

optional logger?: Logger

Defined in: sinks/ffmpeg.ts:56

Optional logger for diagnostics.

Receives errors raised while tearing down the muxer. When omitted, such errors are swallowed silently during FfmpegSink.close.


options?

optional options?: Record<string, string | number>

Defined in: sinks/ffmpeg.ts:48

Extra format-specific muxer options.

Key-value pairs passed straight through to the underlying libav muxer (e.g. { movflags: 'frag_keyframe+empty_moov' }). Values may be strings or numbers; their meaning depends on the selected format.


output

output: FfmpegOutput

Defined in: sinks/ffmpeg.ts:30

The destination the remuxed stream is written to.

Accepts a file path or URL (e.g. out.mp4, rtmp://...), a Node.js writable stream, or a set of node-av IO callbacks for custom transports.