MoQ input

MoQ Input. Receives streams through the packager native library. The UI is intentionally MoQ-first, while advanced project-file overrides can still set the hidden SourceType.

Property Type Access Description
ShowAdvancedOptions bool get/set Show or hide the input's advanced settings in the editor UI. [default=false].
SourceType MoQSourceType get/set Source type (RTMP, SRT, or MoQ)
ConnectionUrl string get/set Source URL to connect to — the MoQ relay endpoint to receive the stream from. Point this at a specific MoQ relay (for example a privately hosted relay or a non-default Vindral region). Treat the URL as sensitive — it can encode connection credentials and shouldn't be committed to public project files. Macros like @@LocalIP() and @@HostName() may be used inside the URL.
ChannelId string get/set Vindral CDN channel ID (also called the namespace) the stream is published under. Required for the MoQ source. Set this to match the channel registered with the CDN — the same Channel ID the publisher streams to. The input tunes to the stream by referencing this Channel ID.
UseHardwareDecoding bool get/set Use GPU-accelerated (NVDEC) video decoding when available. [default=false]. Hardware decoding offloads decode from the CPU and is recommended for high-resolution or high-framerate streams.
AutoConnect bool get/set When true, the input connects automatically as soon as the project loads. [default=false]. Convenient for return feeds and contribution inputs that should come up the moment Composer is running.
AutoReconnect bool get/set When true, the input automatically reconnects if the connection is lost. [default=false]. Each reconnect attempt increments NumAutoReconnectsPerformed; the wait between attempts is set by ReconnectInterval.
ReconnectInterval ReconnectInterval get/set How long to wait between reconnect attempts after a connection failure. [default=OneSecond]. Shorter intervals recover faster from transient network blips but hammer the relay if the issue is persistent. Longer intervals are gentler on the network but mean more frozen/black time on screen. Only used when AutoReconnect is enabled.
FreezeFrameOptions FreezeFrameOptions get/set How long to keep showing the last decoded frame after the connection is lost. Holds the final good frame on screen instead of cutting to black while the input reconnects, smoothing over short drops. Once the configured hold elapses the rendered image is cleared. Audio is always silenced immediately on disconnect regardless of this setting.
ConnectionStatus ConnectionStatus get Current connection status of the MoQ session (read-only). Disconnected — not currently connected. Connecting — handshake/track discovery in progress. Connected — actively receiving and decoding. Reconnecting — connection dropped, retrying. Useful from a script for driving UI indicators, alerts, or fallback routes when the source goes off-air.
ConnectCommand Command get Connect to the source and begin receiving the stream from the configured Channel ID. Disabled while the input is already connecting or connected.
DisconnectCommand Command get Cleanly close the MoQ session and stop receiving. Disabled while the input is already disconnected.
HardwareDecodingUsed string get Description of the decoder in use for the current connection (read-only). Reports the actual decode path (e.g. hardware NVDEC vs software) chosen after track discovery, which may differ from the requested UseHardwareDecoding when the codec or hardware doesn't support it.
NumAutoReconnectsPerformed int get Number of automatic reconnection attempts performed since the input was started (read-only).
StreamTime TimeCode get Elapsed playback time of the received stream as a timecode (read-only).
ComponentLog ComponentLog get Rolling buffer of recent connection events, warnings, and errors surfaced on this input (read-only).
VideoFramesDecoded long get Video frames decoded (read-only)
AudioFramesDecoded long get Audio frames decoded (read-only)
VideoBufferFrames int get Video buffer frame count (read-only)
VideoBufferSizeMs int get Video buffer size in milliseconds (read-only)
AudioBufferMs int get Audio buffer size in milliseconds (read-only)
RenderedFramesCounter int get Rendered frames counter (read-only)
RenderedImageWidth int get Rendered image width (read-only)
RenderedImageHeight int get Rendered image height (read-only)
AudioTrackCount int get Audio track count (read-only)
HwDecodeActive bool get Hardware decode active (read-only)
LastFrameFormat string get Last frame pixel format (read-only)
NumPacketsReceived long get Packets received (read-only)
NumVideoDecodeErrors int get Video decode errors (read-only)
NumBufferUnderRuns int get Buffer under-runs (read-only)
IncomingVideoBitRate string get Incoming video bitrate (read-only)
VideoAudioSync double get Video/Audio sync in milliseconds (read-only)
SourceState string get Source state (read-only)
IncomingAudioBitRate string get Incoming audio bitrate (read-only)
MaxVideoBitrate string get Max video bitrate observed this connection (read-only)
MinVideoBitrate string get Min video bitrate observed this connection (read-only)
AvgVideoBitrate string get Average video bitrate over 30 seconds (read-only)
MaxAudioBitrate string get Max audio bitrate observed this connection (read-only)
MinAudioBitrate string get Min audio bitrate observed this connection (read-only)
AvgAudioBitrate string get Average audio bitrate over 30 seconds (read-only)
ConnectLatencyMs double get Connect latency in milliseconds (read-only)
AvgDecodeTime double get Average video decode time in milliseconds (read-only)
PeakDecodeTime double get Peak video decode time in milliseconds (read-only)
StatusMessage string get Status message for validation (read-only)

Inherits from: AbstractInput, AbstractAudioProcessing, AbstractAudioMetering.

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