nik
/
FAudioGMS-Docs
forked from MoonsideGames/FAudioGMS-Docs
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Create Functions-(Loading-Sound-Assets).md

main
Juju Adams 2021-11-02 21:01:25 +00:00
parent d31a013e54
commit 92f34b815c
1 changed files with 41 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
docs/latest/Functions-(Loading-Sound-Assets).md Normal file
View File

@ -0,0 +1,41 @@
## `FAudioGMS_StaticSound_LoadWAV(filePath)`
**Returns:** Number, a **static sound ID**
|Argument |Datatype|Description |
|----------|--------|------------------------------------------------------|
|`filePath`|string | |
 
## `FAudioGMS_StaticSound_CreateSoundInstance()`
**Returns:** Number, a **sound instance ID**
|Argument |Datatype|Description |
|---------------|--------|------------------------------------------------------|
|`staticSoundID`|number | |
 
## `FAudioGMS_StaticSound_Destroy(staticSoundID)`
**Returns:** N/A (`undefined`)
|Argument |Datatype|Description |
|---------------|--------|------------------------------------------------------|
|`staticSoundID`|number | |
 
## `FAudioGMS_StreamingSound_LoadOGG(filePath)`
**Returns:** Number, a **sound instance ID**
|Argument |Datatype|Description |
|----------|--------|------------------------------------------------------|
|`filePath`|string | |
?> Please note that this function returns a sound instance ID rather than a static sound ID.
!> It is not recommended to try to stream the same .ogg file twice.