MxlOutputFlow interface

Configuration for a single MXL output flow (becomes an input pin on the node).

Signature:

export interface MxlOutputFlow<Pins extends string>

Properties

Property Type Description

Property	Type	Description
fabricsTargets?	string[]	(Optional) Serialized fabrics TargetInfo strings of remote targets to push this flow to over the network (obtained out-of-band from the receiving MXL input’s onFabricsTargetInfos). More targets can be added or removed at runtime with addFabricsTarget / removeFabricsTarget.
groupHint	string	NMOS grouphint tag for flow discovery by downstream consumers
label	Pins	Pin name — used with subscribeToPins / videoToPin / audioToPin
mediaType	"video" \| "audio" \| "ancillary" \| "subtitle"	Media type: determines format conversion (v210 for video, float32 for audio). "ancillary" and "subtitle" pins both write a video/smpte291 MXL data flow — subscribe SCTE-35 streams to an "ancillary" pin and teletext / CTA-708 / CTA-608 subtitle streams to a "subtitle" pin (they are separate pin kinds because each pin accepts one payload type).
timecode?	{ utcOffsetMinutes?: number; }	(Optional) On an "ancillary" flow: carry SMPTE ST 12-2 ancillary timecode (ATC) for every video frame of this output. The timecode is the frame’s own when it carries one (VITC, SEI, a received ST 2110 or MXL ATC), otherwise its UTC time of day shifted by `utcOffsetMinutes`. A timecode flow needs no ancillary input; an MXL input reading the domain labels its video frames with the timecode, which a `st2110_vitc` time domain aligns on.

fabricsTargets?

string[]

(Optional) Serialized fabrics TargetInfo strings of remote targets to push this flow to over the network (obtained out-of-band from the receiving MXL input’s onFabricsTargetInfos). More targets can be added or removed at runtime with addFabricsTarget / removeFabricsTarget.

groupHint

string

NMOS grouphint tag for flow discovery by downstream consumers

label

Pins

Pin name — used with subscribeToPins / videoToPin / audioToPin

mediaType

"video" | "audio" | "ancillary" | "subtitle"

Media type: determines format conversion (v210 for video, float32 for audio). "ancillary" and "subtitle" pins both write a video/smpte291 MXL data flow — subscribe SCTE-35 streams to an "ancillary" pin and teletext / CTA-708 / CTA-608 subtitle streams to a "subtitle" pin (they are separate pin kinds because each pin accepts one payload type).

timecode?

{ utcOffsetMinutes?: number; }

(Optional) On an "ancillary" flow: carry SMPTE ST 12-2 ancillary timecode (ATC) for every video frame of this output. The timecode is the frame’s own when it carries one (VITC, SEI, a received ST 2110 or MXL ATC), otherwise its UTC time of day shifted by utcOffsetMinutes. A timecode flow needs no ancillary input; an MXL input reading the domain labels its video frames with the timecode, which a st2110_vitc time domain aligns on.