hytopia/docs/server.audioevent.md

The HYTOPIA SDK makes it easy for developers to create massively multiplayer games using JavaScript or TypeScript.

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [server](./server.md) &gt; [AudioEvent](./server.audioevent.md)

## AudioEvent enum

Event types an Audio instance can emit. See [AudioEventPayloads](./server.audioeventpayloads.md) for the payloads.

**Signature:**

```typescript
export declare enum AudioEvent 
```

## Enumeration Members

<table><thead><tr><th>

Member


</th><th>

Value


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

PAUSE


</td><td>

`"AUDIO.PAUSE"`


</td><td>


</td></tr>
<tr><td>

PLAY


</td><td>

`"AUDIO.PLAY"`


</td><td>


</td></tr>
<tr><td>

PLAY\_RESTART


</td><td>

`"AUDIO.PLAY_RESTART"`


</td><td>


</td></tr>
<tr><td>

SET\_ATTACHED\_TO\_ENTITY


</td><td>

`"AUDIO.SET_ATTACHED_TO_ENTITY"`


</td><td>


</td></tr>
<tr><td>

SET\_CUTOFF\_DISTANCE


</td><td>

`"AUDIO.SET_CUTOFF_DISTANCE"`


</td><td>


</td></tr>
<tr><td>

SET\_DETUNE


</td><td>

`"AUDIO.SET_DETUNE"`


</td><td>


</td></tr>
<tr><td>

SET\_DISTORTION


</td><td>

`"AUDIO.SET_DISTORTION"`


</td><td>


</td></tr>
<tr><td>

SET\_PLAYBACK\_RATE


</td><td>

`"AUDIO.SET_PLAYBACK_RATE"`


</td><td>


</td></tr>
<tr><td>

SET\_POSITION


</td><td>

`"AUDIO.SET_POSITION"`


</td><td>


</td></tr>
<tr><td>

SET\_REFERENCE\_DISTANCE


</td><td>

`"AUDIO.SET_REFERENCE_DISTANCE"`


</td><td>


</td></tr>
<tr><td>

SET\_VOLUME


</td><td>

`"AUDIO.SET_VOLUME"`


</td><td>


</td></tr>
</tbody></table>