hytopia
Version:
The HYTOPIA SDK makes it easy for developers to create massively multiplayer games using JavaScript or TypeScript.
64 lines (31 loc) • 1.15 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [server](./server.md) > [AudioManager](./server.audiomanager.md) > [unregisterAudio](./server.audiomanager.unregisteraudio.md)
## AudioManager.unregisterAudio() method
Unregisters and stops an audio instance from the audio manager.
Use for: explicit cleanup of one-shot or temporary sounds. Do NOT use for: pausing/resuming; use `Audio.pause` or `Audio.play` instead.
**Signature:**
```typescript
unregisterAudio(audio: Audio): void;
```
## Parameters
<table><thead><tr><th>
Parameter
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
audio
</td><td>
[Audio](./server.audio.md)
</td><td>
The audio instance to pause and unregister.
\*\*Requires:\*\* Audio must be loaded (have an id) or an error is logged.
\*\*Side effects:\*\* Pauses the audio and removes it from manager tracking.
</td></tr>
</tbody></table>
**Returns:**
void
## Remarks
\*\*Pauses audio:\*\* Calls `audio.pause()` before removing from the manager.