forked from MoonsideGames/FAudioGMS-Docs
				
			Create Functions-(Effect-Chains).md
							parent
							
								
									34ce4c82fb
								
							
						
					
					
						commit
						8a3e3e8260
					
				| 
						 | 
					@ -0,0 +1,81 @@
 | 
				
			||||||
 | 
					## `FAudioGMS_EffectChain_Create()`
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					**Returns:** Number, an **effect chain ID**
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					|Argument|Datatype|Description                                           |
 | 
				
			||||||
 | 
					|--------|--------|------------------------------------------------------|
 | 
				
			||||||
 | 
					|None    |number  |                                                      |
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					 
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## `FAudioGMS_EffectChain_Destroy(effectChainID)`
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					**Returns:** N/A (`undefined`)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					|Argument       |Datatype|Description                                           |
 | 
				
			||||||
 | 
					|---------------|--------|------------------------------------------------------|
 | 
				
			||||||
 | 
					|`effectChainID`|number  |                                                      |
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					 
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## `FAudioGMS_EffectChain_AddDefaultReverb(effectChainID)`
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					**Returns:** N/A (`undefined`)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					|Argument|Datatype|Description                                           |
 | 
				
			||||||
 | 
					|--------|--------|------------------------------------------------------|
 | 
				
			||||||
 | 
					|None    |number  |                                                      |
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					 
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## `FAudioGMS_EffectChain_AddReverb(...)`
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					**Returns:** N/A (`undefined`)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					|Argument       |Datatype|Description                                           |
 | 
				
			||||||
 | 
					|---------------|--------|------------------------------------------------------|
 | 
				
			||||||
 | 
					|`effectChainID`|number  |                                                      |
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					 
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## `FAudioGMS_SoundInstance_SetEffectChain(soundInstanceID, effectChainID, effectGain)`
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					**Returns:** N/A (`undefined`)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					|Argument         |Datatype|Description                                           |
 | 
				
			||||||
 | 
					|-----------------|--------|------------------------------------------------------|
 | 
				
			||||||
 | 
					|`soundInstanceID`|number  |                                                      |
 | 
				
			||||||
 | 
					|`effectChainID`  |number  |                                                      |
 | 
				
			||||||
 | 
					|`effectGain`     |number  |                                                      |
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					 
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## `FAudioGMS_SoundInstance_SetEffectGain(soundInstanceID, effectGain)`
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					**Returns:** N/A (`undefined`)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					|Argument         |Datatype|Description                                           |
 | 
				
			||||||
 | 
					|-----------------|--------|------------------------------------------------------|
 | 
				
			||||||
 | 
					|`soundInstanceID`|number  |                                                      |
 | 
				
			||||||
 | 
					|`effectGain`     |number  |                                                      |
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					 
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## `FAudioGMS_SetMasteringEffectChain(effectChainID, effectGain)`
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					**Returns:** N/A (`undefined`)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					|Argument       |Datatype|Description                                           |
 | 
				
			||||||
 | 
					|---------------|--------|------------------------------------------------------|
 | 
				
			||||||
 | 
					|`effectChainID`|number  |                                                      |
 | 
				
			||||||
 | 
					|`effectGain`   |number  |                                                      |
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					 
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## `FAudioGMS_SetMasteringEffectGain(effectGain)`
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					**Returns:** N/A (`undefined`)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					|Argument    |Datatype|Description                                           |
 | 
				
			||||||
 | 
					|------------|--------|------------------------------------------------------|
 | 
				
			||||||
 | 
					|`effectGain`|number  |                                                      |
 | 
				
			||||||
		Loading…
	
		Reference in New Issue