Skip to content
API referenceDevelopmentRuntime scriptingEngine ccf7d03f
Synced
  • Creates playback parameters.

API: scripting
Project: Inno.Audio
Scope: Runtime

public InnoEngine.Audio.AudioPlayOptions.AudioPlayOptions(float volume = 1, float pitch = 1, float pan = 0, bool loop = false, int priority = 0, InnoEngine.Audio.AudioBusId? bus = null, InnoEngine.Audio.AudioClipLoadMode loadMode = InnoEngine.Audio.AudioClipLoadMode.Automatic, InnoEngine.Audio.AudioSpatialOptions? spatial = null)

Parameter volume: Linear gain applied to the voice.

Parameter pitch: Playback-rate multiplier.

Parameter pan: Stereo pan from negative one to positive one.

Parameter loop: Whether playback restarts after reaching the clip end.

Parameter priority: Voice retention priority; larger values are retained first.

Parameter bus: Destination mixer bus.

Parameter loadMode: Clip preparation override.

Parameter spatial: Optional spatial playback parameters.

Exception T:System.ArgumentOutOfRangeException: Gain, pitch, or pan is non-finite or outside its valid range, or the load mode is undefined.

Exception T:System.ArgumentException: The supplied destination bus is uninitialized.