AudioEventPlayback

struct

Core/Vixen.Audio/Events/AudioEvent.cs:18

csharp

public readonly record struct AudioEventPlayback

Where a play of an event is, and any trim on top of what the event says.

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

Remarks

Everything here is the caller's business and none of it is the sound's: a position changes every frame, a rolloff does not. The event owns the second kind, so this is small.

Fields and properties (6)

public Vector3 Position
Where in the world. Read only when the event is spatial.
public Vector3 Velocity
How fast it is moving, for doppler.
public Vector3 ConeDirection
Which way it faces, for a cone. Zero keeps the event's own direction.
public float Gain
A linear gain multiplied into the event's, for a trim the event should not remember.
public float Pitch
A pitch ratio multiplied into the event's.
public bool StartPaused
Whether it starts paused, so the caller can position it before a block is heard.

Methods (1)

public AudioEventPlayback()
Where a play of an event is, and any trim on top of what the event says.

Used by (7)

AudioEngineVixen.Audio
AudioEventVixen.Audio
AudioEventTestsVixen.Audio.Tests
AudioSystemVixen.Audio
DeferredSpawnsVixen.Audio
LayeredEventTestsVixen.Audio.Tests
PendingVixen.Audio