PlaybackSettings

Remarks

A value with defaults that describe the ordinary case — full volume, unaltered pitch, on the master bus, in the room rather than in the world — so engine.Play(clip) means something sensible and every field is an override of a stated default rather than a thing that must be filled in.

Fields and properties (12)

• public int Bus

  Which bus to route into. Zero is the master.

• public int SendBus

  An extra bus a copy of this sound also goes to, or −1 for none.

• public float SendLevel

  How much goes to SendBus, as a linear gain.

• public float Gain

  A linear gain. One is unaltered.

• public float Pitch

  A playback rate multiplier. Two is an octave up and half the length.

• public float Pan

  Where it sits between the speakers when it is not spatialised. −1 left, +1 right.

• public bool Loop

  Whether the clip wraps round instead of ending.

• public bool IsSpatial

  Whether it is a thing in the world rather than a sound in the room.

• public SpatialSettings Spatial

  Where in the world, and how it behaves there. Read only when IsSpatial.

• public bool StartPaused

  Whether it starts paused, so a caller can position it before a single frame is heard.

• public int Priority

  How hard this sound is to displace when the voice pool is full. Higher survives.

• public long StartFrame

  The device frame at which it should begin. Zero is "as soon as the mixer sees it".

Methods (1)

• public PlaybackSettings()

  How a sound should be played.

Used by (34)

• GameSoundsThirdPersonShooter
• PeerVoiceChat
• VideoGameVideoPlayback
• AudioEffectTestsVixen.Audio.Tests
• AudioEngineVixen.Audio
• AudioEventVixen.Audio
• AudioMixerTestsVixen.Audio.Tests
• AudioRoutingTestsVixen.Audio.Tests
• AudioSystemVixen.Audio
• BuiltinParameterTestsVixen.Audio.Tests
• CaptureTestsVixen.Audio.Tests
• ConvolutionTestsVixen.Audio.Tests
• DynamicsTestsVixen.Audio.Tests
• FadeTestsVixen.Audio.Tests
• HrtfTestsVixen.Audio.Tests
• LayeredEventTestsVixen.Audio.Tests
• LiveSampleProviderTestsVixen.Audio.Tests
• MixControlServerTestsVixen.Audio.Tests
• MixerAssetTestsVixen.Audio.Tests
• MixerParameterTestsVixen.Audio.Tests
• MultipleListenerTestsVixen.Audio.Tests
• MusicPlayerVixen.Audio
• MusicPlayerTestsVixen.Audio.Tests
• OcclusionTestsVixen.Audio.Tests
• OpenALBackendTestsVixen.Audio.Backend.OpenAL.Tests
• PerVoiceSendTestsVixen.Audio.Tests
• ResamplerTestsVixen.Audio.Tests
• ReverbZoneTestsVixen.Audio.Tests
• SpatializerTestsVixen.Audio.Tests
• SpectrumAnalyzerTestsVixen.Audio.Tests
• StreamingTestsVixen.Audio.Tests
• VirtualVoiceTestsVixen.Audio.Tests
• VoiceParameterTestsVixen.Audio.Tests
• VoiceStealingTestsVixen.Audio.Tests