class SoundFile : Resource

robot_2Generated
code_blocksInput

Description

A sound resource.

Members

Static Methods

Member NameSummary
LoadLoads a sound file from the specified filename.
FromWavCreates a sound file from WAV data with optional looping.

Instance Methods

Member NameSummary
LoadAsyncAsynchronously loads the sound file.
PreloadPreloads the sound file for faster access.
GetSamplesAsyncRequest decompressed audio samples.

Properties

Member NameSummary
OnSoundReloadedRan when the file is reloaded/recompiled, etc.
IsLoadedtrue if sound is loaded
FormatFormat of the audio file.
BitsPerSampleBits per each sample of this sound file.
ChannelsNumber of channels this audio file has.
BytesPerSampleBytes per each sample of this sound file.
SampleFrameSizeSize of one sample, typically this would be "sample size * channel count", but can vary on audio format.
RateSample rate of this sound file, per second.
DurationDuration of the sound this sound file contains, in seconds.
IsValidIndicates if the sound file is valid.
IsValidForPlaybackIndicates if the sound file is valid for playback.