Vixen
02b45cc4

AudioEngineOptions

struct Core/Vixen.Audio/AudioEngine.cs:25
csharp
public readonly record struct AudioEngineOptions

How to build an AudioEngine.

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

Remarks

Written new AudioEngineOptions() and never default: the defaults live in the parameterless constructor, and a default would ask for a mixer with no voices.

Fields and properties (6)

  • public int VoiceCapacity

    How many sounds can play at once.

  • public AudioDeviceOptions Device

    What to ask the device for.

  • public bool StreamOnOwnThread

    Whether the engine runs the streaming decoder on its own thread.

  • public bool AutoStart

    Whether the device starts pulling as soon as the engine is built.

  • public int AudibleVoices

    How many voices may actually be heard at once. Zero means all of them.

  • public bool MasterLimiter

    Whether a LimiterEffect is put on the master bus.

Methods (1)

  • public AudioEngineOptions()

    How to build an AudioEngine.

Used by (8)

  • GameSoundsThirdPersonShooter
  • PeerVoiceChat
  • VideoGameVideoPlayback
  • AudioEngineVixen.Audio
  • AudioTestDataVixen.Audio.Tests
  • MusicPlayerTestsVixen.Audio.Tests
  • OpenALBackendTestsVixen.Audio.Backend.OpenAL.Tests
  • VirtualVoiceTestsVixen.Audio.Tests