Table of Contents

Class UDPRAWSourceSettings

Namespace
VisioForge.Core.Types.X.Sources
Assembly
VisioForge.Core.dll

Settings for VisioForge.Core.MediaBlocks.Sources.UDPRAWSourceBlock. Receives a live UDP stream and exposes parsed but still-encoded H264/H265 video (and optional audio) without decoding, suitable for passthrough recording (for example, splitting into MP4 files without re-encoding).

public class UDPRAWSourceSettings

Inheritance

Inherited Members

Remarks

The source is addressed by a single udp://host:port URI, where the port is the local port the receiver listens on (a udpsrc binds a local socket — it does not connect to a remote sender):

  • udp://0.0.0.0:1234 (or an empty host) — listen for unicast on the given port on all local interfaces.
  • udp://239.1.1.1:1234 — join the multicast group 239.1.1.1 on the given port (any address in 224.0.0.0–239.255.255.255 is treated as multicast and joined automatically).
  • udp://192.168.1.10:1234 — bind to that specific local interface.

Constructors

UDPRAWSourceSettings(Uri)

Initializes a new instance of the VisioForge.Core.Types.X.Sources.UDPRAWSourceSettings class.

public UDPRAWSourceSettings(Uri uri)

Parameters

uri Uri

The source URI, for example udp://0.0.0.0:1234 or udp://239.1.1.1:1234.

UDPRAWSourceSettings(string)

Initializes a new instance of the VisioForge.Core.Types.X.Sources.UDPRAWSourceSettings class.

public UDPRAWSourceSettings(string uri)

Parameters

uri string

The source URI string, for example udp://0.0.0.0:1234.

Properties

AudioChannels

Gets or sets the audio channel count. Used only for the VisioForge.Core.Types.X.Sources.UDPRAWAudioCodec.PCM (L16) RTP payload, whose caps require an explicit channel count. Defaults to 2.

public int AudioChannels { get; set; }

Property Value

int

AudioCodec

Gets or sets the RTP audio codec. Used only in VisioForge.Core.Types.X.Sources.UDPRAWSourceMode.RTP mode when VisioForge.Core.Types.X.Sources.UDPRAWSourceSettings.AudioPort is set. Defaults to VisioForge.Core.Types.X.Sources.UDPRAWAudioCodec.AAC.

public UDPRAWAudioCodec AudioCodec { get; set; }

Property Value

UDPRAWAudioCodec

AudioEnabled

Gets or sets a value indicating whether to expose an audio output. Defaults to false (most UDP video feeds are video-only). For Auto/MPEGTS containers the audio stream is taken from the container automatically. For VisioForge.Core.Types.X.Sources.UDPRAWSourceMode.RTP an audio output is exposed only when this is set AND VisioForge.Core.Types.X.Sources.UDPRAWSourceSettings.AudioPort is greater than zero (RTP audio is a separate session on its own UDP port). The Raw mode is video-only.

public bool AudioEnabled { get; set; }

Property Value

bool

AudioPort

Gets or sets the UDP port of the RTP audio session. Used only in VisioForge.Core.Types.X.Sources.UDPRAWSourceMode.RTP mode together with VisioForge.Core.Types.X.Sources.UDPRAWSourceSettings.AudioEnabled. RTP carries audio and video as separate sessions on separate ports, so the audio port is distinct from the video port in VisioForge.Core.Types.X.Sources.UDPRAWSourceSettings.Uri. Defaults to 0 (no RTP audio).

public int AudioPort { get; set; }

Property Value

int

AudioRTPClockRate

Gets or sets the RTP audio clock rate in Hz. Used only in VisioForge.Core.Types.X.Sources.UDPRAWSourceMode.RTP mode. Defaults to 48000 (typical for Opus/AAC).

public int AudioRTPClockRate { get; set; }

Property Value

int

AudioRTPPayloadType

Gets or sets the RTP audio payload type. Used only in VisioForge.Core.Types.X.Sources.UDPRAWSourceMode.RTP mode. Defaults to 97.

public int AudioRTPPayloadType { get; set; }

Property Value

int

BufferSize

Gets or sets the udpsrc receive buffer size in bytes. Defaults to 524288 (512 KB).

public int BufferSize { get; set; }

Property Value

int

Mode

Gets or sets the transport mode. Defaults to VisioForge.Core.Types.X.Sources.UDPRAWSourceMode.Auto.

public UDPRAWSourceMode Mode { get; set; }

Property Value

UDPRAWSourceMode

RTPClockRate

Gets or sets the RTP clock rate in Hz. Used only in VisioForge.Core.Types.X.Sources.UDPRAWSourceMode.RTP mode. Defaults to 90000 (standard for video).

public int RTPClockRate { get; set; }

Property Value

int

RTPPayloadType

Gets or sets the RTP payload type. Used only in VisioForge.Core.Types.X.Sources.UDPRAWSourceMode.RTP mode. Defaults to 96 (first dynamic payload type).

public int RTPPayloadType { get; set; }

Property Value

int

Uri

Gets or sets the source URI in the form udp://host:port. The port is mandatory.

public Uri Uri { get; set; }

Property Value

Uri

VideoCodec

Gets or sets the elementary video codec. Required for VisioForge.Core.Types.X.Sources.UDPRAWSourceMode.RTP and VisioForge.Core.Types.X.Sources.UDPRAWSourceMode.Raw; ignored for Auto/MPEGTS (detected automatically).

public UDPRAWVideoCodec VideoCodec { get; set; }

Property Value

UDPRAWVideoCodec

Methods

CreateBlock()

Creates the block.

public MediaBlock CreateBlock()

Returns

MediaBlock

MediaBlock.