Class AudioSampleProvider

Namespace: ValveResourceFormat.Renderer.Audio.SampleProviders
Assembly: Renderer.dll

Base sample provider with a perceptual volume control and an end-of-sound notification.

public abstract class AudioSampleProvider : IAudioSampleProvider

Inheritance

object ← AudioSampleProvider

Derived

CachedSoundSampleProvider, SampleProvider2D, SampleProviderMulti

Implements

IAudioSampleProvider

Properties

Volume

Gets or sets the volume (0..1), mapped onto an exponential curve to approximate perceptual loudness.

public float Volume { get; set; }

Property Value

float

VolumeMultiplier

Gets the linear gain computed from .

protected float VolumeMultiplier { get; }

Property Value

float

Methods

Over()

Raises .

protected void Over()

Read(float[], int, int)

Fills buffer with up to count samples starting at offset. Returns the number of samples written. A return value smaller than count signals the end of the sound.

public abstract int Read(float[] buffer, int offset, int count)

Parameters

buffer float[]

offset int

count int

Returns

int

OnOver

Raised when this provider has run out of samples.

public event Action? OnOver

Event Type

Action?