Switcher

Switcher input properties for Script Engine. A virtual input that switches between two video/audio sources — a foreground (PGM, what's "on air") and a background (Preview, what's coming next) — using either a hard cut or a timed crossfade, with an optional fade-to-black. When multiview is turned on, it also produces a separate multiviewer image showing Preview, PGM, and up to 13 input thumbnails in a 4-, 8-, or 13-cell grid, with tally borders, labels, VU meters, and up to 4 overlay layers that can be faded in and out independently.

Property	Type	Access	Description
`ShowAdvancedOptions`	`bool`	`get/set`	Show or hide the input's advanced settings in the editor UI. [default=false].
`Resolution`	`CompositionResolution`	`get/set`	Output resolution of the switcher. [default=HD 1080]. Pick a standard preset (720, HD 1080, UHD 4K, DCI 4K, 8K) and `Width` / `Height` follow automatically. Choose `Custom` to set `Width` and `Height` to any values you like.
`Width`	`int`	`get/set`	Output width in pixels. [min=32, max=8192, default=1920]. Set automatically when `Resolution` is one of the standard presets. Only freely editable when `Resolution` is `Custom`.
`Height`	`int`	`get/set`	Output height in pixels. [min=32, max=8192, default=1080]. Set automatically when `Resolution` is one of the standard presets. Only freely editable when `Resolution` is `Custom`.
`ForegroundInputName`	`string`	`get/set`	Name of the input or scene used as the foreground (PGM, "on-air") layer. Set this to swap the live source. Use the input/scene's name as it appears in the project. Combined with `BackgroundInputName`, these two are the sources the switcher transitions between.
`BackgroundInputName`	`string`	`get/set`	Name of the input or scene used as the background (Preview, "next") layer. This is the source that will be cut or faded to when `CutCommand` or `CrossfadeCommand` runs. A typical workflow is to point Preview at the next clip, then trigger a transition to bring it on air.
`BlendPercentage`	`float`	`get/set`	How much of the foreground vs. background is shown, as a percentage. [min=0, max=100, default=100]. 100% shows the foreground (PGM) only; 0% shows the background (Preview) only; values in between fade between the two. The transition commands animate this value automatically, but you can also drive it directly from a script for a manual mix.
`CrossfadeTransitionDuration`	`int`	`get/set`	Length of a crossfade transition, in milliseconds. [min=0, max=5000, default=1000]. Used by `CrossfadeCommand`. 0 ms is essentially the same as a hard cut; 1000 ms (one second) is a typical TV-style mix. Longer values produce a slower, more cinematic dissolve.
`CutCommand`	`Command`	`get`	Cut instantly between foreground and background.
`CrossfadeCommand`	`Command`	`get`	Crossfade between foreground and background over `CrossfadeTransitionDuration`.
`FTBTransitionDurationMs`	`int`	`get/set`	Length of a fade-to-black transition, in milliseconds. [min=0, max=5000, default=1000]. Used by `FadeToBlackCommand`. Each invocation animates the fade either down to black or back up, taking this long either way.
`FadeToBlackPercentage`	`float`	`get/set`	How much black is currently mixed over the output, as a percentage. [min=0, max=100, default=0]. 0% is a normal picture; 100% is fully black. The fade-to-black command animates this value, but you can also drive it directly from a script for a manual fade.
`FadeToBlackCommand`	`Command`	`get`	Fade the output to or from black over `FTBTransitionDurationMs`.
`CreateMultiView`	`bool`	`get/set`	Whether to also produce a multiviewer image. [default=true]. When true, the switcher composites a separate output showing Preview, PGM, and the `MvInput*` thumbnails in the layout chosen by `MultiViewLayout`. Disable to skip the multiviewer entirely when you only need the main PGM output.
`MultiViewLayout`	`MultiViewLayout`	`get/set`	Grid layout used for the multiviewer image. [default=EightInputs]. `FourInputs` is a compact 1×4 strip below Preview/PGM, `EightInputs` is a 2×4 grid, and `ThirteenInputs` is a denser 5+4+(2×2) layout for very busy productions. Pick the layout that matches how many sources you actually want to monitor.
`UseTally`	`bool`	`get/set`	Whether the multiviewer draws coloured tally borders and labels. [default=true]. When enabled, the cell that's currently on PGM gets a red border and the cell that's queued in Preview gets a green border, with the source name shown as a label. Useful for operators monitoring the multiview image.
`UseVuMeters`	`bool`	`get/set`	Whether the multiviewer draws audio level meters per cell. [default=true]. When enabled, each cell shows a small VU-style level meter so operators can see audio activity at a glance. Disable to keep the multiview cleaner or to save a bit of processing time.
`PgmVuMeterSourceName`	`string`	`get/set`	Source name for the PGM VU meter. Leave blank to use the switcher's PGM output. By default the meter shows the audio levels of whatever is currently on air. Set this to the name of another input or scene if you'd rather meter that source instead — handy when the on-air audio comes from a separate audio mix.
`TextEdgeRendering`	`TextEdgeRendering`	`get/set`	How tally label text is drawn — smooth, sharp, or pixelated. Choose between anti-aliased (smooth, the usual choice), aliased (sharper but jagged), or other rendering styles. Mostly a cosmetic preference; the readable defaults work for most projects.
`MvInput1`	`string`	`get/set`	Name of the input or scene shown in multiviewer cell 1. Cells with no name are left empty in the layout. Only the cells used by the chosen `MultiViewLayout` are visible (4 in `FourInputs`, 8 in `EightInputs`, 13 in `ThirteenInputs`).
`MvInput2`	`string`	`get/set`	Name of the input or scene shown in multiviewer cell 2.
`MvInput3`	`string`	`get/set`	Name of the input or scene shown in multiviewer cell 3.
`MvInput4`	`string`	`get/set`	Name of the input or scene shown in multiviewer cell 4.
`MvInput5`	`string`	`get/set`	Name of the input or scene shown in multiviewer cell 5.
`MvInput6`	`string`	`get/set`	Name of the input or scene shown in multiviewer cell 6.
`MvInput7`	`string`	`get/set`	Name of the input or scene shown in multiviewer cell 7.
`MvInput8`	`string`	`get/set`	Name of the input or scene shown in multiviewer cell 8.
`MvInput9`	`string`	`get/set`	Name of the input or scene shown in multiviewer cell 9.
`MvInput10`	`string`	`get/set`	Name of the input or scene shown in multiviewer cell 10. Only used by `ThirteenInputs` layout.
`MvInput11`	`string`	`get/set`	Name of the input or scene shown in multiviewer cell 11. Only used by `ThirteenInputs` layout.
`MvInput12`	`string`	`get/set`	Name of the input or scene shown in multiviewer cell 12. Only used by `ThirteenInputs` layout.
`MvInput13`	`string`	`get/set`	Name of the input or scene shown in multiviewer cell 13. Only used by `ThirteenInputs` layout.
`OverlaysCrossfadeTransitionDurationMs`	`int`	`get/set`	Length of an overlay fade in or fade out, in milliseconds. [min=0, max=5000, default=1000]. Applies to every `OverlayN` fade-in/out command. 0 ms is essentially instant; 1000 ms is a typical one-second fade.
`MvOverlay1`	`string`	`get/set`	Name of the input or scene used as overlay 1. Overlays sit on top of the PGM output and can be faded in and out with the matching `Overlay1*Command`. Use for lower thirds, logos, score graphics, or any other element that needs to come and go independently of the main switching.
`MvOverlay2`	`string`	`get/set`	Name of the input or scene used as overlay 2.
`MvOverlay3`	`string`	`get/set`	Name of the input or scene used as overlay 3.
`MvOverlay4`	`string`	`get/set`	Name of the input or scene used as overlay 4.
`Overlay1CrossFadeInOutCommand`	`Command`	`get`	Toggle overlay 1 — fade it in if it's hidden, fade it out if it's visible.
`Overlay1ShowCommand`	`Command`	`get`	Fade overlay 1 in.
`Overlay1HideCommand`	`Command`	`get`	Fade overlay 1 out.
`Overlay2CrossFadeInOutCommand`	`Command`	`get`	Toggle overlay 2 — fade it in if it's hidden, fade it out if it's visible.
`Overlay2ShowCommand`	`Command`	`get`	Fade overlay 2 in.
`Overlay2HideCommand`	`Command`	`get`	Fade overlay 2 out.
`Overlay3CrossFadeInOutCommand`	`Command`	`get`	Toggle overlay 3 — fade it in if it's hidden, fade it out if it's visible.
`Overlay3ShowCommand`	`Command`	`get`	Fade overlay 3 in.
`Overlay3HideCommand`	`Command`	`get`	Fade overlay 3 out.
`Overlay4CrossFadeInOutCommand`	`Command`	`get`	Toggle overlay 4 — fade it in if it's hidden, fade it out if it's visible.
`Overlay4ShowCommand`	`Command`	`get`	Fade overlay 4 in.
`Overlay4HideCommand`	`Command`	`get`	Fade overlay 4 out.
`TallyRenderTimeMs`	`float`	`get`	Time taken to draw the tally borders and labels on the most recent frame, in milliseconds (read-only, debug).
`VUMeterRenderTimeMs`	`float`	`get`	Time taken to draw the multiviewer VU meters on the most recent frame, in milliseconds (read-only, debug).

Inherits from: AbstractInput, AbstractAudioProcessing, AbstractAudioMetering.

See also: Switcher in Inputs — user-facing introduction, screenshots, and section summaries.