VisioForge (c) 2025

Search Results for

    Class VorbisEncoderSettings

    Vorbis encoder settings.

    Inheritance
    object
    VorbisEncoderSettings
    Implements
    IAudioEncoder
    IMediaBlockSettings
    IEncoderTextInfo
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: VisioForge.Core.Types.X.AudioEncoders
    Assembly: VisioForge.Core.dll
    Syntax
    public class VorbisEncoderSettings : IAudioEncoder, IMediaBlockSettings, IEncoderTextInfo
    Remarks

    Supported formats: F32LE. Supported sample rates: [1..200000]. Supported channels: [1..9].

    Fields

    Name

    The name.

    Declaration
    public static string Name
    Field Value
    Type Description
    string

    Properties

    Bitrate

    Gets or sets the bitrate. Attempt to encode at a bitrate averaging this (in Kbps). This uses the bitrate management engine, and is not recommended for most users. Quality is a better alternative. (-1 = disabled). Range is [16..240].

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

    The bitrate.

    MaxBitrate

    Gets or sets the maximum bitrate (in Kbps). Useful for streaming applications. (-1 == disabled). Range is [16..240].

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

    The maximum bitrate.

    MinBitrate

    Gets or sets the minimum bitrate(in Kbps). Useful for encoding for a fixed-size channel. (-1 = disabled). Range is [16..240].

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

    The minimum bitrate.

    Quality

    Gets or sets the quality instead of specifying a particular bitrate. -1 = lowest, 10 = highest.

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

    The quality.

    RateControl

    Gets or sets the rate control.

    Declaration
    public VorbisEncoderRateControl RateControl { get; set; }
    Property Value
    Type Description
    VorbisEncoderRateControl

    The rate control.

    Methods

    CreateBlock()

    Creates the block.

    Declaration
    public MediaBlock CreateBlock()
    Returns
    Type Description
    MediaBlock

    MediaBlock.

    GetCaps()

    Gets the caps.

    Declaration
    public string GetCaps()
    Returns
    Type Description
    string

    System.String.

    GetParameters()

    Gets the parameters as string.

    Declaration
    public string GetParameters()
    Returns
    Type Description
    string

    System.String.

    GetSupportedBitrates()

    Gets the supported bitrates.

    Declaration
    public int[] GetSupportedBitrates()
    Returns
    Type Description
    int[]

    System.Int32[].

    GetSupportedChannelCounts()

    Gets the supported channel counts.

    Declaration
    public int[] GetSupportedChannelCounts()
    Returns
    Type Description
    int[]

    System.Int32[].

    GetSupportedSampleRates()

    Gets the supported sample rates.

    Declaration
    public int[] GetSupportedSampleRates()
    Returns
    Type Description
    int[]

    System.Int32[].

    IsAvailable()

    Determines whether this encoder is available.

    Declaration
    public static bool IsAvailable()
    Returns
    Type Description
    bool

    true if this encoder is available; otherwise, false.

    ToString()

    Returns a string that represents this instance.

    Declaration
    public override string ToString()
    Returns
    Type Description
    string

    A string that represents this instance.

    Overrides
    object.ToString()

    Implements

    IAudioEncoder
    IMediaBlockSettings
    IEncoderTextInfo