Vixen
02b45cc4
csharp
public readonly record struct SpatialSettings

What makes one voice a thing in the world rather than a sound in the room.

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

Remarks

The defaults describe a point source with an inverse rolloff from one metre, no cone, and doppler on — which is what somebody who attaches a sound to a moving object means, and means that new SpatialSettings { Position = p } is a complete answer.

Fields and properties (15)

  • public Vector3 Position

    Where the sound is, in world space.

  • public Vector3 Velocity

    How fast it is moving, in units a second.

  • public Vector3 ConeDirection

    Which way its cone points, if it has one.

  • public float MinDistance

    The distance at which it plays at full volume, and the reference for every model.

  • public float MaxDistance

    Where it stops getting quieter — and, for Linear, silent.

  • public AttenuationModel Attenuation

    Which curve it follows.

  • public float RolloffFactor

    How hard that curve bites. One is the model as written; zero disables the rolloff.

  • public float ConeInnerAngle

    The full angle, in degrees, inside which the sound is at full volume.

  • public float ConeOuterAngle

    The full angle, in degrees, outside which the sound is at ConeOuterGain.

  • public float ConeOuterGain

    How loud it is outside the cone.

  • public float DopplerFactor

    How much pitch shift movement causes. Zero switches doppler off.

  • public float Spread

    How big the source is, from a point at 0 to everywhere at 1. A spread source stops being localisable and sits evenly across the speakers.

  • public float SpeedOfSound

    How fast sound travels, in world units a second. Only doppler reads it.

  • public float AirAbsorption

    How much distance dulls the sound, from none at 0 to fully at 1.

  • public float AirAbsorptionCutoff

    Where the low-pass ends up, in hertz, at MaxDistance and full absorption.

Methods (1)

  • public SpatialSettings()

    What makes one voice a thing in the world rather than a sound in the room.

Used by (22)

  • AudioEngineVixen.Audio
  • AudioEventVixen.Audio
  • AudioEventAssetTestsVixen.Audio.Tests
  • AudioEventDescriptionVixen.Audio
  • AudioEventSpatialAssetVixen.Audio
  • AudioEventSystemTestsVixen.Audio.Tests
  • AudioEventTestsVixen.Audio.Tests
  • AudioOcclusionVixen.Audio
  • AudioSpatialVixen.Audio
  • AudioSystemVixen.Audio
  • BuiltinParameterTestsVixen.Audio.Tests
  • HrtfTestsVixen.Audio.Tests
  • MultipleListenerTestsVixen.Audio.Tests
  • OcclusionTestsVixen.Audio.Tests
  • PlaybackSettingsVixen.Audio
  • ReverbZoneTestsVixen.Audio.Tests
  • ScattererTestsVixen.Audio.Tests
  • SpatializerVixen.Audio
  • SpatializerTestsVixen.Audio.Tests
  • SurroundTestsVixen.Audio.Tests
  • VoiceVixen.Audio
  • VoiceStealingTestsVixen.Audio.Tests