VisioForge (c) 2025

Search Results for

    Class SRTSourceSettings

    Configuration settings for an SRT connection.

    Inheritance
    object
    SRTSourceSettings
    Implements
    IMediaPlayerBaseSourceSettings
    IVideoCaptureBaseVideoSourceSettings
    IVideoMixerSource
    IVideoSourceSettings
    IMediaBlockSettings
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: VisioForge.Core.Types.X.Sources
    Assembly: VisioForge.Core.dll
    Syntax
    public class SRTSourceSettings : IMediaPlayerBaseSourceSettings, IVideoCaptureBaseVideoSourceSettings, IVideoMixerSource, IVideoSourceSettings, IMediaBlockSettings

    Properties

    Authentication

    Authenticate a connection. Defaults to true.

    Declaration
    public bool Authentication { get; set; }
    Property Value
    Type Description
    bool

    AutoReconnect

    Automatically reconnect when connection fails. Defaults to true.

    Declaration
    public bool AutoReconnect { get; set; }
    Property Value
    Type Description
    bool

    KeepListening

    If false, the element will return GST_FLOW_EOS when the remote client disconnects. If true, the element will keep waiting for the client to reconnect. Defaults to false.

    Declaration
    public bool KeepListening { get; set; }
    Property Value
    Type Description
    bool

    Latency

    Gets or sets the maximum accepted transmission latency. Defaults to 125 milliseconds.

    Declaration
    public TimeSpan Latency { get; set; }
    Property Value
    Type Description
    TimeSpan

    LocalAddress

    The address to bind when mode is listener or rendezvous. Defaults to null.

    Declaration
    public string LocalAddress { get; set; }
    Property Value
    Type Description
    string

    LocalPort

    The local port to bind when mode is listener or rendezvous. Defaults to 7001.

    Declaration
    public uint LocalPort { get; set; }
    Property Value
    Type Description
    uint

    Mode

    The SRT connection mode. Defaults to GstSRTConnectionMode.GST_SRT_CONNECTION_MODE_CALLER.

    Declaration
    public SRTConnectionMode Mode { get; set; }
    Property Value
    Type Description
    SRTConnectionMode

    Passphrase

    The password for the encrypted transmission.

    Declaration
    public string Passphrase { get; set; }
    Property Value
    Type Description
    string

    PbKeyLen

    The crypto key length. Defaults to GstSRTKeyLength.GST_SRT_KEY_LENGTH_NO_KEY.

    Declaration
    public SRTKeyLength PbKeyLen { get; set; }
    Property Value
    Type Description
    SRTKeyLength

    PollTimeout

    The polling timeout used when SRT poll is started. Defaults to 1000 milliseconds.

    Declaration
    public TimeSpan PollTimeout { get; set; }
    Property Value
    Type Description
    TimeSpan

    StreamId

    The stream ID for the SRT access control.

    Declaration
    public string StreamId { get; set; }
    Property Value
    Type Description
    string

    Uri

    The URI used by SRT connection. Defaults to "srt://127.0.0.1:7001".

    Declaration
    public string Uri { get; set; }
    Property Value
    Type Description
    string

    WaitForConnection

    Block the stream until a client connects. Defaults to true.

    Declaration
    public bool WaitForConnection { get; set; }
    Property Value
    Type Description
    bool

    Methods

    CreateAsync(string, bool)

    Create as an asynchronous operation.

    Declaration
    public static Task<SRTSourceSettings> CreateAsync(string uri, bool ignoreMediaInfoReader = false)
    Parameters
    Type Name Description
    string uri

    The URI.

    bool ignoreMediaInfoReader

    if set to true [ignore media information reader].

    Returns
    Type Description
    Task<SRTSourceSettings>

    A Task<SRTSourceSettings> representing the asynchronous operation.

    Exceptions
    Type Condition
    Exception

    Unable to read file info.

    CreateBlock()

    Creates the block.

    Declaration
    public MediaBlock CreateBlock()
    Returns
    Type Description
    MediaBlock

    MediaBlock.

    GetInfo()

    Gets the file information.

    Declaration
    public MediaFileInfo GetInfo()
    Returns
    Type Description
    MediaFileInfo

    MediaFileInfo.

    Remarks

    If VideoCustomFrameRate is set you'll have this value as a frame rate.

    ReadInfoAsync()

    Read information as an asynchronous operation.

    Declaration
    public Task<MediaFileInfo> ReadInfoAsync()
    Returns
    Type Description
    Task<MediaFileInfo>

    A Task<MediaFileInfo> representing the asynchronous operation.

    Implements

    IMediaPlayerBaseSourceSettings
    IVideoCaptureBaseVideoSourceSettings
    IVideoMixerSource
    IVideoSourceSettings
    IMediaBlockSettings