Class CreateAudioContext

Namespace

Bonsai.Audio

Assembly

Bonsai.Audio.dll

Represents an operator that creates an audio context using the specified device and listener properties.

[TypeConverter(typeof(CreateAudioContext.AudioContextConverter))]
public class CreateAudioContext : Source<AudioContextManager>

Inheritance

object

Source<AudioContextManager>

CreateAudioContext

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

DeviceName

Gets or sets the name of the audio device used for playback.

[TypeConverter(typeof(PlaybackDeviceNameConverter))]
public string DeviceName { get; set; }

Property Value

string

Direction

Gets or sets the direction vector of the listener, in the world coordinate frame.

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

Property Value

Vector3

Gain

Gets or sets the amount of amplification applied to the listener. Each multiplication by 2 increases gain by +6dB.

public float Gain { get; set; }

Property Value

float

Position

Gets or sets the location of the listener, in the world coordinate frame.

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

Property Value

Vector3

Refresh

Gets or sets the refresh frequency, in Hz, used by the audio device. Zero represents the driver default.

public int Refresh { get; set; }

Property Value

int

SampleRate

Gets or sets the sample rate, in Hz, used by the audio device. Zero represents the driver default.

public int SampleRate { get; set; }

Property Value

int

Up

Gets or sets the up vector of the listener, in the world coordinate frame.

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

Property Value

Vector3

Velocity

Gets or sets the velocity of the listener, in the world coordinate frame.

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

Property Value

Vector3

Methods

Generate()

Generates an observable sequence that contains the audio context manager object.

public override IObservable<AudioContextManager> Generate()

Returns

IObservable<AudioContextManager>

A sequence containing a single instance of the AudioContextManager class which will manage the lifetime of the audio context.