Skip to content
Type

InputOptions

The options for creating an Input object.

ts
type InputOptions<S extends Source = Source> = {
	formats: InputFormat[];
	source: S | SourceRef<S>;
	initInput?: Input;
	formatOptions?: InputFormatOptions;
};

See InputFormat, SourceRef, Input, InputFormatOptions, and Source.

Used by

Properties

formats

ts
formats: InputFormat[];

A list of supported formats. If the source file is not of one of these formats, then it cannot be read.

See InputFormat.

source

ts
source: S | SourceRef<S>;

The source from which data will be read.

See SourceRef.

initInput

ts
initInput?: Input;

An optional, second Input instance that contains the necessary metadata to initialize the tracks of this input. This is necessary in cases where track initialization info and media data are carried in separate files, like is the case with segmented MP4 (CMAF) files.

The use of this field depends on the input format.

See Input.

formatOptions

ts
formatOptions?: InputFormatOptions;

Can be used to specify additional per-format configuration.

See InputFormatOptions.

Released under the Mozilla Public License 2.0.