> For the complete documentation index, see [llms.txt](https://docs.moxha.dev/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.moxha.dev/documentation/paid-scripts/surround-spatial-audio/api/client/get.md).

# Get

### Check Sound Is Exists

```lua
local soundExists = exports['mx-surround']:soundExists(soundId)
```

#### Parameters

* > **soundId:** `string`

#### Returns

* > `boolean`

***

### Streamer Mode Is Enabled

```lua
local enabledStreamerMode = exports['mx-surround']:isStreamerModeEnabled()
```

#### Returns

* > `boolean`

***

### Get TimeStamp

```lua
local timeStamp = exports['mx-surround']:getTimeStamp(soundId)
```

{% hint style="warning" %}
If the nil or empty returns. It means the song is not loaded yet!
{% endhint %}

#### Parameters

* > **soundId:** `string`

#### Returns

* > `number | boolean | nil`
  >
  > * Returns sound' timestamp in seconds

***

### Get Type

```lua
local soundType = exports['mx-surround']:getSoundType(soundId)
```

#### Parameters

* > **soundId:** `string`

#### Returns

* > `"stereo" | "spatial" | false`

***

### Get Link

```lua
local link = exports['mx-surround']:getLink(soundId)
```

#### Parameters

* > **soundId:** `string`

#### Returns

* > `string | false`

***

### Get Coords

```lua
local coords = exports['mx-surround']:getCoords(soundId)
```

#### Parameters

* > **soundId:** `string`

#### Returns

* > `vector3 | false`

***

### Is Looped

```lua
local looped = exports['mx-surround']:isLooped(soundId)
```

#### Parameters

* > **soundId:** `string`

#### Returns

* > `boolean`

***

### Get Info

```lua
local info = exports['mx-surround']:getInfo(soundId)
```

#### Parameters

* > **soundId:** `string`

#### Returns

* > `table | false`

***

### Get Max Duration

```lua
local maxDuration = exports['mx-surround']:getMaxDuration(soundId)
```

#### Parameters

* > **soundId:** `string`

#### Returns

* > `number | false`
  >
  > * Returns sound' max duration in seconds

***

### Get Volume

```lua
local volume = exports['mx-surround']:getVolume(soundId)
```

#### Parameters

* > **soundId:** `string`

#### Returns

* > `number | false`
  >
  > * If sound is the dynamic returns maxVolume or is not returns volume

***

### Check Is Playing

```lua
local playing = exports['mx-surround']:isPlaying(soundId)
```

#### Parameters

* > **soundId:** `string`

#### Returns

* > `boolean`

***

### Check Is Dynamic

```lua
local dynamic = exports['mx-surround']:isDynamic(soundId)
```

#### Parameters

* > **soundId:** `string`

#### Returns

* > `boolean`

***

### Check Is Stopped

```lua
local stopped = exports['mx-surround']:isStopped(soundId)
```

#### Parameters

* > **soundId:** `string`

#### Returns

* > `boolean`

***

### Check Is Paused

```lua
local paused = exports['mx-surround']:isPaused(soundId)
```

#### Parameters

* > **soundId:** `string`

#### Returns

* > `boolean`

***

### Get Panner

```lua
local panner = exports['mx-surround']:getPanner(soundId)
```

#### Parameters

* > **soundId:** `string`

#### Returns

* > `PannerNode | false` 

***

### Is Hearing Any Sound

```lua
local isHearing = exports['mx-surround']:hearingAnySound()
```

#### Returns

* > `boolean`

***

### Sound Is Loaded

```lua
local isLoaded = exports['mx-surround']:soundIsLoaded()
```

{% hint style="info" %}
This function waits until a song is created, if not loaded succesfully then returns false
{% endhint %}

#### Returns

* > `boolean`