Class UpdateListener

Namespace

Bonsai.Audio

Assembly

Bonsai.Audio.dll

Represents an operator that updates the properties of the audio listener.

public class UpdateListener : Sink

Inheritance

object

Combinator

Sink

UpdateListener

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

Gain

Gets or sets the amount of amplification applied to the listener. Each multiplication by 2 increases gain by +6dB. If this property is not set, the gain of the audio listener will not be updated.

public float? Gain { get; set; }

Property Value

float?

Orientation

Gets or sets the current orientation of the listener, in the world coordinate frame. If this property is not set, the orientation of the audio listener will not be updated.

[TypeConverter(typeof(NumericRecordConverter))]
public Quaternion? Orientation { get; set; }

Property Value

Quaternion?

Position

Gets or sets the current location of the listener, in the world coordinate frame. If this property is not set, the location of the audio listener will not be updated.

[TypeConverter(typeof(NumericRecordConverter))]
public Vector3? Position { get; set; }

Property Value

Vector3?

Velocity

Gets or sets the current velocity of the listener, in the world coordinate frame. If this property is not set, the velocity of the audio listener will not be updated.

[TypeConverter(typeof(NumericRecordConverter))]
public Vector3? Velocity { get; set; }

Property Value

Vector3?

Methods

Process<TSource>(IObservable<TSource>)

Updates the properties of the audio listener whenever the source sequence emits a notification.

public override IObservable<TSource> Process<TSource>(IObservable<TSource> source)

Parameters

source IObservable<TSource>

The sequence containing the notifications used to trigger the update of the audio listener.

Returns

IObservable<TSource>

An observable sequence that is identical to the source sequence but where there is an additional side effect of updating the properties of the audio listener whenever the sequence emits a notification.

Type Parameters

TSource

The type of the elements in the source sequence.