From 92f34b815c0e6506d72e888b33f5d6ae66eed8cd Mon Sep 17 00:00:00 2001 From: Juju Adams Date: Tue, 2 Nov 2021 21:01:25 +0000 Subject: [PATCH] Create Functions-(Loading-Sound-Assets).md --- .../Functions-(Loading-Sound-Assets).md | 41 +++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 docs/latest/Functions-(Loading-Sound-Assets).md diff --git a/docs/latest/Functions-(Loading-Sound-Assets).md b/docs/latest/Functions-(Loading-Sound-Assets).md new file mode 100644 index 0000000..b6cd286 --- /dev/null +++ b/docs/latest/Functions-(Loading-Sound-Assets).md @@ -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. \ No newline at end of file