Vixen
02b45cc4
csharp
public record class AudioEventSpatialAsset

How an event's plays sit in the world, as a file declares it.

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

Remarks

A flattened SpatialSettings without the three fields a caller supplies — position, velocity and facing — because those are the frame's and never the asset's. Writing them into a file would produce a sound that always plays at the origin.

Fields and properties (11)

  • public float MinDistance

    The distance at which it plays at full volume.

  • public float MaxDistance

    Where it stops getting quieter.

  • public AttenuationModel Attenuation

    Which curve it follows.

  • public float RolloffFactor

    How hard that curve bites.

  • public float ConeInnerAngle

    The full angle, in degrees, inside which it is at full volume. 360 means no cone.

  • public float ConeOuterAngle

    The full angle, in degrees, outside which it 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.

  • public float AirAbsorption

    How much distance muffles it, from 0 for none to 1 for as much as the model allows.

  • public float AirAbsorptionCutoff

    Where the muffling ends up, in hertz, at maximum distance and full absorption.

Methods (1)

  • public SpatialSettings ToSettings()

    These settings, as the mixer wants them. The position is filled in per play.

Used by (6)

  • AudioEventAssetVixen.Audio
  • AudioEventAssetTestsVixen.Audio.Tests
  • AudioEventBuilderVixen.Audio
  • TypeRegistrationVixen.Audio
  • Vixen_Audio_Assets_AudioEventAssetSerializerVixen.Audio
  • Vixen_Audio_Assets_AudioEventSpatialAssetSerializerVixen.Audio