s&box docs
API Referenceglobal

LoadOptionsclass

Options for creating a sound from WAV or MP3 data via `Sandbox.SoundFile.FromWav(System.String,System.Span,Sandbox.SoundFile.LoadOptions)` or `Sandbox.SoundFile.FromMp3(System.String,System.Span,Sandbox.SoundFile.LoadOptions)`.

object→LoadOptions
Namespace
global
Assembly
Sandbox.Engine
Declaration
public sealed struct Sandbox.SoundFile.LoadOptions

Constructors1

Showing 1 constructors

public LoadOptions()PUBLICCONSTRUCTOR

Options for creating a sound from WAV or MP3 data via `Sandbox.SoundFile.FromWav(System.String,System.Span,Sandbox.SoundFile.LoadOptions)` or `Sandbox.SoundFile.FromMp3(System.String,System.Span,Sandbox.SoundFile.LoadOptions)`.

Properties3

Showing 3 properties

public bool Sandbox.SoundFile.LoadOptions.Loop { get; set; }PUBLICGETSET

Whether the sound should loop. Overridden by `Sandbox.SoundFile.LoadOptions.LoopStart`/`Sandbox.SoundFile.LoadOptions.LoopEnd` if set.

Returns:bool—

public int Sandbox.SoundFile.LoadOptions.LoopEnd { get; set; }PUBLICGETSET

End sample of the loop region. 0 means end of sound.

Returns:int—

public int Sandbox.SoundFile.LoadOptions.LoopStart { get; set; }PUBLICGETSET

Start sample of the loop region. -1 means no loop.

Returns:int—

SoundSelectionMode

Previous Page

Loop

Next Page

On this page

Constructorspublic LoadOptions()Propertiespublic System.Boolean Sandbox.SoundFile.LoadOptions.Loop { get; set; }public System.Int32 Sandbox.SoundFile.LoadOptions.LoopEnd { get; set; }public System.Int32 Sandbox.SoundFile.LoadOptions.LoopStart { get; set; }Metadata