Class AudioDelaySettings

Namespace

VisioForge.Core.Types.X.AudioEffects

Assembly

VisioForge.Core.dll

Settings for delaying an audio stream by shifting its buffer timestamps.

public class AudioDelaySettings

Inheritance

object

AudioDelaySettings

Inherited Members

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object?, object?)

object.ToString()

Constructors

AudioDelaySettings()

Initializes a new instance of the VisioForge.Core.Types.X.AudioEffects.AudioDelaySettings class.

public AudioDelaySettings()

AudioDelaySettings(TimeSpan)

Initializes a new instance of the VisioForge.Core.Types.X.AudioEffects.AudioDelaySettings class.

public AudioDelaySettings(TimeSpan delay)

Parameters

delay TimeSpan

The non-negative delay to apply to the audio stream.

Properties

Delay

Gets or sets the audio delay.

public TimeSpan Delay { get; set; }

Property Value

TimeSpan

Exceptions

ArgumentOutOfRangeException

Thrown when the delay is negative or too large for a signed 64-bit nanosecond timestamp offset.

Silent

Gets or sets a value indicating whether the underlying identity element should suppress handoff messages.

public bool Silent { get; set; }

Property Value

bool

Sync

Gets or sets a value indicating whether the underlying identity element should synchronize to the pipeline clock.

public bool Sync { get; set; }

Property Value

bool

TimestampOffsetNanoseconds

Gets the delay represented as a GStreamer timestamp offset in nanoseconds.

public long TimestampOffsetNanoseconds { get; }

Property Value

long

Methods

ToNanoseconds(TimeSpan)

Converts a TimeSpan value to nanoseconds.

public static long ToNanoseconds(TimeSpan delay)

Parameters

delay TimeSpan

The delay to convert.

Returns

long

The delay in nanoseconds.

Exceptions

ArgumentOutOfRangeException

Thrown when the delay is negative or too large for a signed 64-bit nanosecond timestamp offset.