Vixen
02b45cc4
csharp
public readonly record struct AudioStatistics

What the audio subsystem was doing, as of the last AudioEngine.Update.

No guide page documents this yet — the page shows what the code says about itself.

Remarks

The numbers behind docs/plan/13's audio overlay — active voices and mixer levels — plus the two that say whether audio is keeping up at all. Taken as one value rather than read a property at a time, so an overlay never shows a voice count from this frame beside a load from the last one.

Fields and properties (12)

  • public int ActiveVoices

    How many voices were producing sound in the last block.

  • public int VoiceCapacity

    How many there are in total.

  • public int VirtualVoices

    How many of the active voices are advancing without being heard.

  • public float MasterPeak

    The loudest sample the master bus produced. Above one is clipping.

  • public long RenderedFrames

    How many frames have been rendered since the engine started.

  • public TimeSpan LastRenderTime

    How long the last block took to render.

  • public double Load

    What fraction of the time it had the last block took. Above one means the device did not get its samples in time.

  • public long DeviceUnderruns

    How many times the device wanted frames that were not ready.

  • public long StreamUnderruns

    How many times a streaming voice was starved by its decoder.

  • public int StreamCount

    How many streams the pump is servicing.

  • public long DroppedRequests

    How many play requests found every voice busy and nothing worth displacing.

  • public long StolenVoices

    How many sounds have been displaced to make room for a newer one.

Used by (8)

  • AudioEngineVixen.Audio
  • AudioMixerTestsVixen.Audio.Tests
  • AudioOverlayVixen.Audio
  • AudioSystemTestsVixen.Audio.Tests
  • MusicPlayerTestsVixen.Audio.Tests
  • OpenALBackendTestsVixen.Audio.Backend.OpenAL.Tests
  • VirtualVoiceTestsVixen.Audio.Tests
  • VoiceStealingTestsVixen.Audio.Tests