FAudioGMS-Docs/docs/latest/Functions-(Sound-Instances).md

## `~_SoundInstance_Play(soundInstanceID, loop)`

**Returns:** N/A (`undefined`)

|Argument         |Datatype|Description                                           |
|-----------------|--------|------------------------------------------------------|
|`soundInstanceID`|number  |                                                      |
|`loop`           |boolean |                                                      |

&nbsp;

## `~_SoundInstance_Pause(soundInstanceID)`

**Returns:** N/A (`undefined`)

|Argument         |Datatype|Description                                           |
|-----------------|--------|------------------------------------------------------|
|`soundInstanceID`|number  |                                                      |

&nbsp;

## `~_SoundInstance_Stop(soundInstanceID)`

**Returns:** N/A (`undefined`)

|Argument         |Datatype|Description                                           |
|-----------------|--------|------------------------------------------------------|
|`soundInstanceID`|number  |                                                      |

&nbsp;

## `~_SoundInstance_Destroy(soundInstanceID)`

**Returns:** N/A (`undefined`)

|Argument         |Datatype|Description                                           |
|-----------------|--------|------------------------------------------------------|
|`soundInstanceID`|number  |                                                      |

&nbsp;

## `~_SoundInstance_DestroyWhenFinished(soundInstanceID)`

**Returns:** N/A (`undefined`)

|Argument         |Datatype|Description                                           |
|-----------------|--------|------------------------------------------------------|
|`soundInstanceID`|number  |                                                      |

&nbsp;

## `~_SoundInstance_SetPan(soundInstanceID, pan)`

**Returns:** N/A (`undefined`)

|Argument         |Datatype|Description                                                                |
|-----------------|--------|---------------------------------------------------------------------------|
|`soundInstanceID`|number  |                                                                           |
|`pan`            |number  |Should be from `-1` (100% left) to `+1` (100% right) with `0` being central|

&nbsp;

## `~_SoundInstance_SetPitch(soundInstanceID, pitch)`

**Returns:** N/A (`undefined`)

|Argument         |Datatype|Description                                                                                                                                                 |
|-----------------|--------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
|`soundInstanceID`|number  |                                                                                                                                                            |
|`pitch`          |number  |Frequency multiplier. A value of `2` will double the frequency and make the pitch higher, a value of `0.5` will halve the frequency and make the pitch lower|

&nbsp;

## `~_SoundInstance_SetVolume(soundInstanceID, volume)`

**Returns:** N/A (`undefined`)

|Argument         |Datatype|Description                                             |
|-----------------|--------|--------------------------------------------------------|
|`soundInstanceID`|number  |                                                        |
|`volume`         |number  |                                                        |

&nbsp;

## `~_SoundInstance_Set3DPosition(soundInstanceID, x, y, z)`

**Returns:** N/A (`undefined`)

|Argument         |Datatype|Description                                             |
|-----------------|--------|--------------------------------------------------------|
|`soundInstanceID`|number  |                                                        |
|`x`              |number  |                                                        |
|`y`              |number  |                                                        |
|`z`              |number  |                                                        |

&nbsp;

## `~_SoundInstance_Set3DVelocity(soundInstanceID, xVelocity, yVelocity, zVelocity)`

**Returns:** N/A (`undefined`)

|Argument         |Datatype|Description                                             |
|-----------------|--------|--------------------------------------------------------|
|`soundInstanceID`|number  |                                                        |
|`xVelocity`      |number  |                                                        |
|`yVelocity`      |number  |                                                        |
|`zVelocity`      |number  |                                                        |

&nbsp;

## `~_SoundInstance_SetTrackPositionInSeconds(soundInstanceID, trackPositionInSeconds)`

**Returns:** N/A (`undefined`)

|Argument                |Datatype|Description                                             |
|------------------------|--------|--------------------------------------------------------|
|`soundInstanceID`       |number  |                                                        |
|`trackPositionInSeconds`|number  |                                                        |

&nbsp;

## `~_SoundInstance_SetVolumeOverTime(soundInstanceID, volume, milliseconds)`

**Returns:** N/A (`undefined`)

|Argument         |Datatype|Description                                             |
|-----------------|--------|--------------------------------------------------------|
|`soundInstanceID`|number  |                                                        |
|`volume`         |number  |                                                        |
|`milliseconds`   |number  |                                                        |

&nbsp;

## `~_SoundInstance_SetLowPassFilter(soundInstanceID, lowPassFilter, Q)`

**Returns:** N/A (`undefined`)

|Argument         |Datatype|Description                                             |
|-----------------|--------|--------------------------------------------------------|
|`soundInstanceID`|number  |                                                        |
|`lowPassFilter`  |number  |                                                        |
|`Q`              |number  |                                                        |

&nbsp;

## `~_SoundInstance_SetHighPassFilter(soundInstanceID, lowPassFilter, Q)`

**Returns:** N/A (`undefined`)

|Argument         |Datatype|Description                                             |
|-----------------|--------|--------------------------------------------------------|
|`soundInstanceID`|number  |                                                        |
|`lowPassFilter`  |number  |                                                        |
|`Q`              |number  |                                                        |

&nbsp;

## `~_SoundInstance_SetHighPassFilter(soundInstanceID, highPassFilter, Q)`

**Returns:** N/A (`undefined`)

|Argument         |Datatype|Description                                             |
|-----------------|--------|--------------------------------------------------------|
|`soundInstanceID`|number  |                                                        |
|`highPassFilter` |number  |                                                        |
|`Q`              |number  |                                                        |

&nbsp;

## `~_SoundInstance_SetBandPassFilter(soundInstanceID, bandPassFilter, Q)`

**Returns:** N/A (`undefined`)

|Argument         |Datatype|Description                                             |
|-----------------|--------|--------------------------------------------------------|
|`soundInstanceID`|number  |                                                        |
|`bandPassFilter` |number  |                                                        |
|`Q`              |number  |                                                        |

&nbsp;

## `~_SoundInstance_GetPitch(soundInstanceID)`

**Returns:** Number, the pitch of the sound instance, with `1` being no pitch shift

|Argument         |Datatype|Description                                             |
|-----------------|--------|--------------------------------------------------------|
|`soundInstanceID`|number  |                                                        |

&nbsp;

## `~_SoundInstance_GetVolume(soundInstanceID)`

**Returns:** Number, the volume of the sound instance, from `0` (inaudible) to `1` (full volume)

|Argument         |Datatype|Description                                             |
|-----------------|--------|--------------------------------------------------------|
|`soundInstanceID`|number  |                                                        |

&nbsp;

## `~_SoundInstance_GetTrackLengthInSeconds(soundInstanceID)`

**Returns:** Number, the track length (in seconds)

|Argument         |Datatype|Description                                             |
|-----------------|--------|--------------------------------------------------------|
|`soundInstanceID`|number  |                                                        |

&nbsp;

## `~_SoundInstance_GetTrackPositionInSeconds(soundInstanceID)`

**Returns:** Number, the track position (in seconds)

|Argument         |Datatype|Description                                             |
|-----------------|--------|--------------------------------------------------------|
|`soundInstanceID`|number  |                                                        |
Update Functions-(Sound-Instances).md 2021-11-02 21:45:21 +00:00			## `~_SoundInstance_Play(soundInstanceID, loop)`
Create Functions-(Sound-Instances).md 2021-11-02 21:13:56 +00:00
			Returns: N/A (`undefined`)

			`\|Argument \|Datatype\|Description \|`
			`\|-----------------\|--------\|------------------------------------------------------\|`
			\|`soundInstanceID`\|number \| \|
			\|`loop` \|boolean \| \|

			` `

Update Functions-(Sound-Instances).md 2021-11-02 21:45:21 +00:00			## `~_SoundInstance_Pause(soundInstanceID)`
Create Functions-(Sound-Instances).md 2021-11-02 21:13:56 +00:00
			Returns: N/A (`undefined`)

			`\|Argument \|Datatype\|Description \|`
			`\|-----------------\|--------\|------------------------------------------------------\|`
			\|`soundInstanceID`\|number \| \|

			` `

Update Functions-(Sound-Instances).md 2021-11-02 21:45:21 +00:00			## `~_SoundInstance_Stop(soundInstanceID)`
Create Functions-(Sound-Instances).md 2021-11-02 21:13:56 +00:00
			Returns: N/A (`undefined`)

			`\|Argument \|Datatype\|Description \|`
			`\|-----------------\|--------\|------------------------------------------------------\|`
			\|`soundInstanceID`\|number \| \|

			` `

Update Functions-(Sound-Instances).md 2021-11-02 21:45:21 +00:00			## `~_SoundInstance_Destroy(soundInstanceID)`
Create Functions-(Sound-Instances).md 2021-11-02 21:13:56 +00:00
			Returns: N/A (`undefined`)

			`\|Argument \|Datatype\|Description \|`
			`\|-----------------\|--------\|------------------------------------------------------\|`
			\|`soundInstanceID`\|number \| \|

			` `

Update Functions-(Sound-Instances).md 2021-11-02 21:45:21 +00:00			## `~_SoundInstance_DestroyWhenFinished(soundInstanceID)`
Create Functions-(Sound-Instances).md 2021-11-02 21:13:56 +00:00
			Returns: N/A (`undefined`)

			`\|Argument \|Datatype\|Description \|`
			`\|-----------------\|--------\|------------------------------------------------------\|`
			\|`soundInstanceID`\|number \| \|

			` `

Update Functions-(Sound-Instances).md 2021-11-02 21:45:21 +00:00			## `~_SoundInstance_SetPan(soundInstanceID, pan)`
Create Functions-(Sound-Instances).md 2021-11-02 21:13:56 +00:00
			Returns: N/A (`undefined`)

			`\|Argument \|Datatype\|Description \|`
			`\|-----------------\|--------\|---------------------------------------------------------------------------\|`
			\|`soundInstanceID`\|number \| \|
			\|`pan` \|number \|Should be from `-1` (100% left) to `+1` (100% right) with `0` being central\|

			` `

Update Functions-(Sound-Instances).md 2021-11-02 21:45:21 +00:00			## `~_SoundInstance_SetPitch(soundInstanceID, pitch)`
Create Functions-(Sound-Instances).md 2021-11-02 21:13:56 +00:00
			Returns: N/A (`undefined`)

			`\|Argument \|Datatype\|Description \|`
			`\|-----------------\|--------\|------------------------------------------------------------------------------------------------------------------------------------------------------------\|`
			\|`soundInstanceID`\|number \| \|
			\|`pitch` \|number \|Frequency multiplier. A value of `2` will double the frequency and make the pitch higher, a value of `0.5` will halve the frequency and make the pitch lower\|

			` `

Update Functions-(Sound-Instances).md 2021-11-02 21:45:21 +00:00			## `~_SoundInstance_SetVolume(soundInstanceID, volume)`
Create Functions-(Sound-Instances).md 2021-11-02 21:13:56 +00:00
			Returns: N/A (`undefined`)

			`\|Argument \|Datatype\|Description \|`
			`\|-----------------\|--------\|--------------------------------------------------------\|`
			\|`soundInstanceID`\|number \| \|
			\|`volume` \|number \| \|

			` `

Update Functions-(Sound-Instances).md 2021-11-02 21:45:21 +00:00			## `~_SoundInstance_Set3DPosition(soundInstanceID, x, y, z)`
Create Functions-(Sound-Instances).md 2021-11-02 21:13:56 +00:00
			Returns: N/A (`undefined`)

			`\|Argument \|Datatype\|Description \|`
			`\|-----------------\|--------\|--------------------------------------------------------\|`
			\|`soundInstanceID`\|number \| \|
			\|`x` \|number \| \|
			\|`y` \|number \| \|
			\|`z` \|number \| \|

			` `

Update Functions-(Sound-Instances).md 2021-11-02 21:45:21 +00:00			## `~_SoundInstance_Set3DVelocity(soundInstanceID, xVelocity, yVelocity, zVelocity)`
Create Functions-(Sound-Instances).md 2021-11-02 21:13:56 +00:00
			Returns: N/A (`undefined`)

			`\|Argument \|Datatype\|Description \|`
			`\|-----------------\|--------\|--------------------------------------------------------\|`
			\|`soundInstanceID`\|number \| \|
			\|`xVelocity` \|number \| \|
			\|`yVelocity` \|number \| \|
			\|`zVelocity` \|number \| \|

			` `

Update Functions-(Sound-Instances).md 2021-11-02 21:45:21 +00:00			## `~_SoundInstance_SetTrackPositionInSeconds(soundInstanceID, trackPositionInSeconds)`
Create Functions-(Sound-Instances).md 2021-11-02 21:13:56 +00:00
			Returns: N/A (`undefined`)

			`\|Argument \|Datatype\|Description \|`
			`\|------------------------\|--------\|--------------------------------------------------------\|`
			\|`soundInstanceID` \|number \| \|
			\|`trackPositionInSeconds`\|number \| \|

			` `

Update Functions-(Sound-Instances).md 2021-11-02 21:45:21 +00:00			## `~_SoundInstance_SetVolumeOverTime(soundInstanceID, volume, milliseconds)`
Create Functions-(Sound-Instances).md 2021-11-02 21:13:56 +00:00
			Returns: N/A (`undefined`)

			`\|Argument \|Datatype\|Description \|`
			`\|-----------------\|--------\|--------------------------------------------------------\|`
			\|`soundInstanceID`\|number \| \|
			\|`volume` \|number \| \|
			\|`milliseconds` \|number \| \|

			` `

Update Functions-(Sound-Instances).md 2021-11-02 21:45:21 +00:00			## `~_SoundInstance_SetLowPassFilter(soundInstanceID, lowPassFilter, Q)`
Create Functions-(Sound-Instances).md 2021-11-02 21:13:56 +00:00
			Returns: N/A (`undefined`)

			`\|Argument \|Datatype\|Description \|`
			`\|-----------------\|--------\|--------------------------------------------------------\|`
			\|`soundInstanceID`\|number \| \|
			\|`lowPassFilter` \|number \| \|
			\|`Q` \|number \| \|

			` `

Update Functions-(Sound-Instances).md 2021-11-02 21:45:21 +00:00			## `~_SoundInstance_SetHighPassFilter(soundInstanceID, lowPassFilter, Q)`
Create Functions-(Sound-Instances).md 2021-11-02 21:13:56 +00:00
			Returns: N/A (`undefined`)

			`\|Argument \|Datatype\|Description \|`
			`\|-----------------\|--------\|--------------------------------------------------------\|`
			\|`soundInstanceID`\|number \| \|
			\|`lowPassFilter` \|number \| \|
			\|`Q` \|number \| \|

			` `

Update Functions-(Sound-Instances).md 2021-11-02 21:45:21 +00:00			## `~_SoundInstance_SetHighPassFilter(soundInstanceID, highPassFilter, Q)`
Create Functions-(Sound-Instances).md 2021-11-02 21:13:56 +00:00
			Returns: N/A (`undefined`)

			`\|Argument \|Datatype\|Description \|`
			`\|-----------------\|--------\|--------------------------------------------------------\|`
			\|`soundInstanceID`\|number \| \|
			\|`highPassFilter` \|number \| \|
			\|`Q` \|number \| \|

			` `

Update Functions-(Sound-Instances).md 2021-11-02 21:45:21 +00:00			## `~_SoundInstance_SetBandPassFilter(soundInstanceID, bandPassFilter, Q)`
Create Functions-(Sound-Instances).md 2021-11-02 21:13:56 +00:00
			Returns: N/A (`undefined`)

			`\|Argument \|Datatype\|Description \|`
			`\|-----------------\|--------\|--------------------------------------------------------\|`
			\|`soundInstanceID`\|number \| \|
			\|`bandPassFilter` \|number \| \|
			\|`Q` \|number \| \|

Update Functions-(Sound-Instances).md 2021-11-02 21:20:20 +00:00			` `

Update Functions-(Sound-Instances).md 2021-11-02 21:45:21 +00:00			## `~_SoundInstance_GetPitch(soundInstanceID)`
Update Functions-(Sound-Instances).md 2021-11-02 21:20:20 +00:00
			Returns: Number, the pitch of the sound instance, with `1` being no pitch shift

			`\|Argument \|Datatype\|Description \|`
			`\|-----------------\|--------\|--------------------------------------------------------\|`
			\|`soundInstanceID`\|number \| \|

			` `

Update Functions-(Sound-Instances).md 2021-11-02 21:45:21 +00:00			## `~_SoundInstance_GetVolume(soundInstanceID)`
Update Functions-(Sound-Instances).md 2021-11-02 21:20:20 +00:00
			Returns: Number, the volume of the sound instance, from `0` (inaudible) to `1` (full volume)

			`\|Argument \|Datatype\|Description \|`
			`\|-----------------\|--------\|--------------------------------------------------------\|`
			\|`soundInstanceID`\|number \| \|

			` `

Update Functions-(Sound-Instances).md 2021-11-02 21:45:21 +00:00			## `~_SoundInstance_GetTrackLengthInSeconds(soundInstanceID)`
Update Functions-(Sound-Instances).md 2021-11-02 21:20:20 +00:00
			`Returns: Number, the track length (in seconds)`

			`\|Argument \|Datatype\|Description \|`
			`\|-----------------\|--------\|--------------------------------------------------------\|`
			\|`soundInstanceID`\|number \| \|

			` `

Update Functions-(Sound-Instances).md 2021-11-02 21:45:21 +00:00			## `~_SoundInstance_GetTrackPositionInSeconds(soundInstanceID)`
Update Functions-(Sound-Instances).md 2021-11-02 21:20:20 +00:00
			`Returns: Number, the track position (in seconds)`

			`\|Argument \|Datatype\|Description \|`
			`\|-----------------\|--------\|--------------------------------------------------------\|`
Update Functions-(Sound-Instances).md 2021-11-02 21:32:46 +00:00			\|`soundInstanceID`\|number \| \|