MoonsideGames
/
FAudioGMS-Docs
1
0
Fork 1
Code Issues Pull Requests Projects Releases Wiki Activity
FAudioGMS-Docs/docs/latest/Function-Index.md

63 lines
4.7 KiB
Markdown
Raw Normal View History

Adds "Essentials" function page
2021-11-02 20:39:21 +00:00
## [Essentials](Functions-(Essentials))
!> `FAudioGMS_Init()` and `FAudioGMS_Destroy()` are absolutely essential to FAudio playback. You should run `FAudioGMS_Init()` at the start of your game (usually on boot) and `FAudioGMS_Update()` should be run once every frame, usually in the Step event of a persistent instance.
Tidies up Functions (Essentials)
2021-11-02 20:54:14 +00:00
- [`FAudioGMS_Init(spatialDistanceScale, timestep)`](Functions-(Essentials)?id=faudiogms_initspatialdistancescale-timestep)
- [`FAudioGMS_Update()`](Functions-(Essentials)?id=faudiogms_update)
- [`FAudioGMS_Destroy()`](Functions-(Essentials)?id=faudiogms_destroy)
Adds "Essentials" function page
2021-11-02 20:39:21 +00:00
 
## [Loading Sound Assets](Functions-(Loading-Sound-Assets))
Update Function-Index.md
2021-11-02 21:20:17 +00:00
- [`FAudioGMS_StaticSound_LoadWAV(filePath)`](Functions-(Loading-Sound-Assets)?id=faudiogms_staticsound_loadwavfilepath)
- [`FAudioGMS_StaticSound_CreateSoundInstance(staticSoundID)`](Functions-(Loading-Sound-Assets)?id=faudiogms_staticsound_createsoundinstance)
- [`FAudioGMS_StaticSound_Destroy(staticSoundID)`](Functions-(Loading-Sound-Assets)?id=faudiogms_staticsound_destroystaticsoundid)
- [`FAudioGMS_StreamingSound_LoadOGG(filepath)`](Functions-(Loading-Sound-Assets)?id=faudiogms_streamingsound_loadoggfilepath)
Adds "Essentials" function page
2021-11-02 20:39:21 +00:00
 
## [Sound Instances](Functions-(Sound-Instances))
Update Function-Index.md
2021-11-02 21:20:17 +00:00
- [`FAudioGMS_SoundInstance_Play(soundInstanceID, loop)`](Functions-(Sound-Instances)?id=faudiogms_soundinstance_playsoundinstanceid-loop)
- [`FAudioGMS_SoundInstance_Pause(soundInstanceID)`](Functions-(Sound-Instances)?id=faudiogms_soundinstance_pausesoundinstanceid)
- [`FAudioGMS_SoundInstance_Stop(soundInstanceID)`](Functions-(Sound-Instances)?id=faudiogms_soundinstance_stopsoundinstanceid)
- [`FAudioGMS_SoundInstance_Destroy(soundInstanceID)`](Functions-(Sound-Instances)?id=faudiogms_soundinstance_destroysoundinstanceid)
- [`FAudioGMS_SoundInstance_DestroyWhenFinished(soundInstanceID)`](Functions-(Sound-Instances)?id=faudiogms_soundinstance_destroywhenfinishedsoundinstanceid)
- [`FAudioGMS_SoundInstance_SetPan(soundInstanceID, pan)`](Functions-(Sound-Instances)?id=faudiogms_soundinstance_setpansoundinstanceid-pan)
- [`FAudioGMS_SoundInstance_SetPitch(soundInstanceID, pitch)`](Functions-(Sound-Instances)?id=faudiogms_soundinstance_setpitchsoundinstanceid-pitch)
- [`FAudioGMS_SoundInstance_SetVolume(soundInstanceID, volume)`](Functions-(Sound-Instances)?id=faudiogms_soundinstance_setvolumesoundinstanceid-volume)
- [`FAudioGMS_SoundInstance_Set3DPosition(soundInstanceID, x, y, z)`](Functions-(Sound-Instances)?id=faudiogms_soundinstance_set3dpositionsoundinstanceid-x-y-z)
- [`FAudioGMS_SoundInstance_Set3DVelocity(soundInstanceID, xVelocity, yVelocity, zVelocity)`](Functions-(Sound-Instances)?id=faudiogms_soundinstance_set3dvelocitysoundinstanceid-xvelocity-yvelocity-zvelocity)
- [`FAudioGMS_SoundInstance_SetTrackPositionInSeconds(soundInstanceID, trackPositionInSeconds)`](Functions-(Sound-Instances)?id=faudiogms_soundinstance_settrackpositioninsecondssoundinstanceid-trackpositioninseconds)
- [`FAudioGMS_SoundInstance_SetVolumeOverTime(soundInstanceID, volume, milliseconds)`](Functions-(Sound-Instances)?id=faudiogms_soundinstance_setvolumeovertimesoundinstanceid-volume-milliseconds)
- [`FAudioGMS_SoundInstance_SetLowPassFilter(soundInstanceID, lowPassFilter, Q)`](Functions-(Sound-Instances)?id=faudiogms_soundinstance_setlowpassfiltersoundinstanceid-lowpassfilter-q)
- [`FAudioGMS_SoundInstance_SetHighPassFilter(soundInstanceID, highPassFilter, Q)`](Functions-(Sound-Instances)?id=faudiogms_soundinstance_sethighpassfiltersoundinstanceid-lowpassfilter-q)
- [`FAudioGMS_SoundInstance_SetBandPassFilter(soundInstanceID, bandPassFilter, Q)`](Functions-(Sound-Instances)?id=faudiogms_soundinstance_sethighpassfiltersoundinstanceid-highpassfilter-q)
Update Function-Index.md
2021-11-02 20:57:19 +00:00
- [`FAudioGMS_SoundInstance_GetPitch(soundInstanceID)`]()
- [`FAudioGMS_SoundInstance_GetVolume(soundInstanceID)`]()
- [`FAudioGMS_SoundInstance_GetTrackLengthInSeconds(soundInstanceID)`]()
- [`FAudioGMS_SoundInstance_GetTrackPositionInSeconds(soundInstanceID)`]()
Adds "Essentials" function page
2021-11-02 20:39:21 +00:00
 
## [Effect Chains](Functions-(Effect-Chains))
Update Function-Index.md
2021-11-02 20:57:19 +00:00
- [`FAudioGMS_EffectChain_Create()`]()
- [`FAudioGMS_EffectChain_AddDefaultReverb(effectChainID)`]()
- [`FAudioGMS_EffectChain_AddReverb(...)`]()
- [`FAudioGMS_EffectChain_Destroy(effectChainID)`]()
- [`FAudioGMS_SoundInstance_SetEffectChain(soundInstanceID, effectChainID, effectGain)`]()
- [`FAudioGMS_SoundInstance_SetEffectGain(soundInstanceID, effectGain)`]()
- [`FAudioGMS_SetMasteringEffectChain(effectChainID, effectGain)`]()
- [`FAudioGMS_SetMasteringEffectGain(effectGain)`]()
Adds "Essentials" function page
2021-11-02 20:39:21 +00:00
 
Update Function-Index.md
2021-11-02 20:57:19 +00:00
## [Global Behaviours](Functions-(Global-Behaviours))
Adds "Essentials" function page
2021-11-02 20:39:21 +00:00
Update Function-Index.md
2021-11-02 20:57:19 +00:00
- [`FAudioGMS_SetListenerPosition(x, y, z)`]()
- [`FAudioGMS_SetListenerVelocity(xVelocity, yVelocity, zVelocity)`]()
- [`FAudioGMS_PauseAll()`]()
- [`FAudioGMS_ResumeAll()`]()
- [`FAudioGMS_StopAll`]()