[Home](./index.md) > [server](./server.md) > [Audio](./server.audio.md) ## Audio class Represents a audio playback in a world. **Signature:** ```typescript export default class Audio extends EventRouter implements protocol.Serializable ``` **Extends:** [EventRouter](./server.eventrouter.md) **Implements:** protocol.Serializable ## Remarks Audio instances are created directly as instances. They support a variety of configuration options through the [AudioOptions](./server.audiooptions.md) constructor argument.

Events

This class is an EventRouter, and instances of it emit events with payloads listed under [AudioEventPayloads](./server.audioeventpayloads.md) ## Example ```typescript (new Audio({ uri: 'music/song.mp3', // relative to the server's assets directory in the project root, resolves to assets/music/song.mp3 loop: true, volume: 0.5, })).play(world); ``` ## Constructors
Constructor Modifiers Description
[(constructor)(options)](./server.audio._constructor_.md) Constructs a new instance of the `Audio` class
## Properties
Property Modifiers Type Description
[attachedToEntity](./server.audio.attachedtoentity.md) `readonly` [Entity](./server.entity.md) \| undefined The entity to which the audio is attached if explicitly set.
[detune](./server.audio.detune.md) `readonly` number \| undefined The detune of the audio in cents if explicitly set.
[distortion](./server.audio.distortion.md) `readonly` number \| undefined The amount of distortion to apply to the audio if explicitly set.
[duration](./server.audio.duration.md) `readonly` number \| undefined The duration of the audio in seconds if explicitly set.
[id](./server.audio.id.md) `readonly` number \| undefined The unique identifier for the audio.
[isLoaded](./server.audio.isloaded.md) `readonly` boolean Whether the audio has loaded into the world. Audio is loaded the first time play() is called.
[isPlaying](./server.audio.isplaying.md) `readonly` boolean Whether the audio is currently playing.
[isPositional](./server.audio.ispositional.md) `readonly` boolean Whether the audio is positional (Entity or position attached).
[loop](./server.audio.loop.md) `readonly` boolean Whether the audio is looped.
[offset](./server.audio.offset.md) `readonly` number \| undefined The offset time in seconds from which the audio should start playing if explicitly set.
[playbackRate](./server.audio.playbackrate.md) `readonly` number \| undefined The playback rate of the audio if explicitly set.
[position](./server.audio.position.md) `readonly` [Vector3Like](./server.vector3like.md) \| undefined The position of the audio in the world if explicitly set.
[referenceDistance](./server.audio.referencedistance.md) `readonly` number \| undefined The reference distance of the audio if explicitly set.
[startTick](./server.audio.starttick.md) `readonly` number \| undefined The server tick at which the audio started playing.
[uri](./server.audio.uri.md) `readonly` string The URI of the audio asset.
[volume](./server.audio.volume.md) `readonly` number \| undefined The volume of the audio if explicitly set.
[world](./server.audio.world.md) `readonly` [World](./server.world.md) \| undefined The world the audio is in if already loaded.
## Methods
Method Modifiers Description
[pause()](./server.audio.pause.md) Pauses the audio.
[play(world, restart)](./server.audio.play.md) Plays or resumes the audio.
[setAttachedToEntity(entity)](./server.audio.setattachedtoentity.md) Sets the entity to which the audio is attached, following its position.
[setDetune(detune)](./server.audio.setdetune.md) Sets the detune of the audio.
[setDistortion(distortion)](./server.audio.setdistortion.md) Sets the distortion of the audio.
[setPlaybackRate(playbackRate)](./server.audio.setplaybackrate.md) Sets the playback rate of the audio.
[setPosition(position)](./server.audio.setposition.md) Sets the position of the audio. Will detach from entity if attached.
[setReferenceDistance(referenceDistance)](./server.audio.setreferencedistance.md) Sets the reference distance of the audio.
[setVolume(volume)](./server.audio.setvolume.md) Sets the volume of the audio.