IAudioPlayer.PlaySound(ISoundEffect, float, int, float, float, int, string) Method

Definition

Plays a sound effect and returns the track handle for lifecycle tracking.

C#

nint PlaySound(Brine2D.Audio.ISoundEffect sound, float volume=1f, int loops=0, float pan=0f, float pitch=1f, int priority=0, string? bus=null);

The sound effect to play.

Per-sound volume multiplier \(0\.0 to 1\.0, default 1\.0\). The final gain applied to the track is volume × SoundVolume.

Number of times to loop \(0 = play once, \-1 = infinite\).

Stereo pan \(\-1\.0 left to 1\.0 right\).

Playback speed multiplier \(0\.25 to 4\.0, default 1\.0\).

Track priority for eviction. When all tracks are in use the lowest-priority track is evicted if the new sound's priority is equal or higher.

Optional bus name to tag the track with atomically at creation time. When non-null, the track is tagged before playback begins, eliminating the window between PlaySound\(ISoundEffect, float, int, float, float, int, string\) and Brine2D.Audio.IAudioPlayer.TagTrack\(System\.IntPtr,System\.String\) where a PauseBus\(string\) or StopBus\(string, float\) call could miss the track.