Class UpdateSourceState

Namespace

Bonsai.Audio

Assembly

Bonsai.Audio.dll

Provides an abstract base class for operators that update the state of specified audio sources.

public abstract class UpdateSourceState : Sink

Inheritance

object

Combinator

Sink

UpdateSourceState

Derived

PauseSource

PlaySource

RewindSource

StopSource

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

SourceName

Gets or sets the name of the audio source, or a comma-separated list of names if specifying multiple sources.

[TypeConverter(typeof(SourceNameArrayConverter))]
public string[] SourceName { get; set; }

Property Value

string[]

Methods

Process(IObservable<AudioSource[]>)

Updates the state of all the audio sources in an observable sequence.

public IObservable<AudioSource[]> Process(IObservable<AudioSource[]> source)

Parameters

source IObservable<AudioSource[]>

A sequence of AudioSource arrays containing all the audio sources whose state should be updated.

Returns

IObservable<AudioSource[]>

An observable sequence that is identical to the source sequence but where there is an additional side effect of updating the state of all the audio sources.

Remarks

If SourceName is not null or empty, this method behaves as Process<TSource>(IObservable<TSource>).

Process(IObservable<AudioSource>)

Updates the state of all the audio sources in an observable sequence.

public IObservable<AudioSource> Process(IObservable<AudioSource> source)

Parameters

source IObservable<AudioSource>

A sequence of AudioSource objects whose state should be updated.

Returns

IObservable<AudioSource>

An observable sequence that is identical to the source sequence but where there is an additional side effect of updating the state of each of the audio sources in the sequence.

Remarks

If SourceName is not null or empty, this method behaves as Process<TSource>(IObservable<TSource>).

Process<TSource>(IObservable<TSource>)

Updates the state of the specified audio source 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 source.

Returns

IObservable<TSource>

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

Type Parameters

TSource

The type of the elements in the source sequence.