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

Update Functions-(Sound-Instances).md

remotes/1735848800119076263/main
Juju Adams 2021-11-02 21:42:40 +00:00
parent 5614071252
commit 36852509d0
1 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
docs/latest/Functions-(Sound-Instances).md
View File

@ -1,4 +1,4 @@
## `_SoundInstance_Play(soundInstanceID, loop)`
## `..._SoundInstance_Play(soundInstanceID, loop)`
**Returns:** N/A (`undefined`)
@ -9,7 +9,7 @@
 
## `_SoundInstance_Pause(soundInstanceID)`
## `..._SoundInstance_Pause(soundInstanceID)`
**Returns:** N/A (`undefined`)
@ -19,7 +19,7 @@
 
## `_SoundInstance_Stop(soundInstanceID)`
## `..._SoundInstance_Stop(soundInstanceID)`
**Returns:** N/A (`undefined`)
@ -29,7 +29,7 @@
 
## `_SoundInstance_Destroy(soundInstanceID)`
## `..._SoundInstance_Destroy(soundInstanceID)`
**Returns:** N/A (`undefined`)
@ -39,7 +39,7 @@
 
## `_SoundInstance_DestroyWhenFinished(soundInstanceID)`
## `..._SoundInstance_DestroyWhenFinished(soundInstanceID)`
**Returns:** N/A (`undefined`)
@ -49,7 +49,7 @@
 
## `_SoundInstance_SetPan(soundInstanceID, pan)`
## `..._SoundInstance_SetPan(soundInstanceID, pan)`
**Returns:** N/A (`undefined`)
@ -60,7 +60,7 @@
 
## `_SoundInstance_SetPitch(soundInstanceID, pitch)`
## `..._SoundInstance_SetPitch(soundInstanceID, pitch)`
**Returns:** N/A (`undefined`)
@ -71,7 +71,7 @@
 
## `_SoundInstance_SetVolume(soundInstanceID, volume)`
## `..._SoundInstance_SetVolume(soundInstanceID, volume)`
**Returns:** N/A (`undefined`)
@ -82,7 +82,7 @@
 
## `_SoundInstance_Set3DPosition(soundInstanceID, x, y, z)`
## `..._SoundInstance_Set3DPosition(soundInstanceID, x, y, z)`
**Returns:** N/A (`undefined`)
@ -95,7 +95,7 @@
 
## `_SoundInstance_Set3DVelocity(soundInstanceID, xVelocity, yVelocity, zVelocity)`
## `..._SoundInstance_Set3DVelocity(soundInstanceID, xVelocity, yVelocity, zVelocity)`
**Returns:** N/A (`undefined`)
@ -108,7 +108,7 @@
 
## `_SoundInstance_SetTrackPositionInSeconds(soundInstanceID, trackPositionInSeconds)`
## `..._SoundInstance_SetTrackPositionInSeconds(soundInstanceID, trackPositionInSeconds)`
**Returns:** N/A (`undefined`)
@ -119,7 +119,7 @@
 
## `_SoundInstance_SetVolumeOverTime(soundInstanceID, volume, milliseconds)`
## `..._SoundInstance_SetVolumeOverTime(soundInstanceID, volume, milliseconds)`
**Returns:** N/A (`undefined`)
@ -131,7 +131,7 @@
 
## `_SoundInstance_SetLowPassFilter(soundInstanceID, lowPassFilter, Q)`
## `..._SoundInstance_SetLowPassFilter(soundInstanceID, lowPassFilter, Q)`
**Returns:** N/A (`undefined`)
@ -143,7 +143,7 @@
 
## `_SoundInstance_SetHighPassFilter(soundInstanceID, lowPassFilter, Q)`
## `..._SoundInstance_SetHighPassFilter(soundInstanceID, lowPassFilter, Q)`
**Returns:** N/A (`undefined`)
@ -155,7 +155,7 @@
 
## `_SoundInstance_SetHighPassFilter(soundInstanceID, highPassFilter, Q)`
## `..._SoundInstance_SetHighPassFilter(soundInstanceID, highPassFilter, Q)`
**Returns:** N/A (`undefined`)
@ -167,7 +167,7 @@
 
## `_SoundInstance_SetBandPassFilter(soundInstanceID, bandPassFilter, Q)`
## `..._SoundInstance_SetBandPassFilter(soundInstanceID, bandPassFilter, Q)`
**Returns:** N/A (`undefined`)
@ -179,7 +179,7 @@
 
## `_SoundInstance_GetPitch(soundInstanceID)`
## `..._SoundInstance_GetPitch(soundInstanceID)`
**Returns:** Number, the pitch of the sound instance, with `1` being no pitch shift
@ -189,7 +189,7 @@
 
## `_SoundInstance_GetVolume(soundInstanceID)`
## `..._SoundInstance_GetVolume(soundInstanceID)`
**Returns:** Number, the volume of the sound instance, from `0` (inaudible) to `1` (full volume)
@ -199,7 +199,7 @@
 
## `_SoundInstance_GetTrackLengthInSeconds(soundInstanceID)`
## `..._SoundInstance_GetTrackLengthInSeconds(soundInstanceID)`
**Returns:** Number, the track length (in seconds)
@ -209,7 +209,7 @@
 
## `_SoundInstance_GetTrackPositionInSeconds(soundInstanceID)`
## `..._SoundInstance_GetTrackPositionInSeconds(soundInstanceID)`
**Returns:** Number, the track position (in seconds)