VisioForge (c) 2025

Search Results for

    Class PushAudioSourceSettings

    Push audio source settings. Implements the IPushSourceSettings

    Inheritance
    object
    PushAudioSourceSettings
    Implements
    IPushSourceSettings
    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 PushAudioSourceSettings : IPushSourceSettings

    Constructors

    PushAudioSourceSettings(bool, int, int, AudioFormatX)

    Initializes a new instance of the PushAudioSourceSettings class.

    Declaration
    public PushAudioSourceSettings(bool isLive = true, int sampleRate = 48000, int channels = 2, AudioFormatX format = AudioFormatX.S16)
    Parameters
    Type Name Description
    bool isLive

    if set to true source is live.

    int sampleRate

    The sample rate.

    int channels

    The channels.

    AudioFormatX format

    The format.

    Properties

    BlockPushData

    Gets or sets a value indicating whether to block pushing data until it's read.

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

    true if block pushing data; otherwise, false.

    Channels

    Gets or sets the channels.

    Declaration
    public int Channels { get; set; }
    Property Value
    Type Description
    int

    The channels.

    DoTimestamp

    Gets or sets a value indicating whether to add timestamp.

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

    true if add timestamp; otherwise, false.

    Format

    Gets or sets the format.

    Declaration
    public AudioFormatX Format { get; set; }
    Property Value
    Type Description
    AudioFormatX

    The format.

    IsLive

    Gets a value indicating whether this instance is live.

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

    true if this instance is live; otherwise, false.

    PushFormat

    Gets or sets the format.

    Declaration
    public PushSourceFormat PushFormat { get; set; }
    Property Value
    Type Description
    PushSourceFormat

    The format.

    SampleRate

    Gets or sets the sample rate.

    Declaration
    public int SampleRate { get; set; }
    Property Value
    Type Description
    int

    The sample rate.

    StreamType

    Gets or sets the type of the stream.

    Declaration
    public PushSourceStreamType StreamType { get; set; }
    Property Value
    Type Description
    PushSourceStreamType

    The type of the stream.

    Methods

    GetSourceType()

    Gets the type of the source.

    Declaration
    public PushSourceType GetSourceType()
    Returns
    Type Description
    PushSourceType

    PushSourceType.

    Implements

    IPushSourceSettings

    See Also

    IPushSourceSettings