s&
newspaper
About
info
About s&box
newspaper
Latest News
published_with_changes
Changes
map
Roadmap
monitoring
Metrics
games
Games
sports_esports
Browse Games
rocket
Discover Games
business_center
Workshop
sports_esports
Games
landscape
Maps
chair
Models
texture
Materials
apparel
Clothing
construction
More..
forum
Forum
docs
Docs
docs
Documentation
dashboard
Api Reference
school
Tutorials
input
Log in with Steam
chevron_left
Change Language
简体中文
English
Русский
Español
Português-Brasil
Deutsch
日本語
Français
Polski
Türkçe
한국어
Pirate
Italiano
ไทย
繁體中文
Українська
Čeština
Nederlands
Magyar
Dansk
Suomi
Svenska
Norsk
Ελληνικά
Română
Български
Tiếng Việt
Bahasa Indonesia
Español-Latinoamérica
العربية
Api
Classes
SoundFile
chevron_left
Classes
class
SoundFile
search
Properties
data_object
BitsPerSample
data_object
BytesPerSample
data_object
Channels
data_object
Duration
data_object
Format
data_object
IsLoaded
data_object
IsValid
data_object
IsValidForPlayback
data_object
OnSoundReloaded
data_object
Rate
data_object
SampleFrameSize
Methods
lock
Finalize
functions
GetSamplesAsync
functions
LoadAsync
functions
Preload
Static Methods
functions
FromMp3
functions
FromOgg
functions
FromPcm
functions
FromWav
functions
Load
SoundFile
A sound resource.
class
Sandbox
.
account_tree
extends
Resource
Sandbox.Engine
data_object
Properties
11
BitsPerSample
int
Bits per each sample of this sound file.
BytesPerSample
int
Bytes per each sample of this sound file.
Channels
int
Number of channels this audio file has.
Duration
float
Duration of the sound this sound file contains, in seconds.
Format
SoundFormat
Format of the audio file.
IsLoaded
bool
true if sound is loaded
IsValid
bool
IsValidForPlayback
bool
OnSoundReloaded
Action
Ran when the file is reloaded/recompiled, etc.
Rate
int
Sample rate of this sound file, per second.
SampleFrameSize
int
Size of one sample, typically this would be "sample size * channel count", but can vary on audio format.
functions
Methods
4
Finalize
(
)
GetSamplesAsync
(
)
Task`1
Request decompressed audio samples.
LoadAsync
(
)
Task`1
Preload
(
)
functions
Static Methods
5
FromMp3
(
filename
,
data
,
options
)
SoundFile
FromOgg
(
filename
,
data
,
options
)
SoundFile
FromPcm
(
filename
,
data
,
options
)
SoundFile
FromWav
(
filename
,
data
,
options
)
SoundFile
Load
(
filename
)
SoundFile
Load a new sound from disk. Includes automatic caching.
Inheritance
Resource
SoundFile
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.