Skip to content

REVO / API version 0.0.10

Audio

Created stopped, with a shared playback timeline. The default audience is all players. Spatial audio follows distance and dimension limits, plus entity streaming when attached. Attached audio inherits the entity’s dimension. Detach before changing it. Frontend audio ignores dimensions. Loading, buffering, errors and completion are local to each listener and emit no server events.

new Audio(source, options?): Audio

Parameter Type
source IAudioSource
options? IAudioOptions

Audio

WorldBase.constructor

Property Type Details
attachedTo
readonly
Entity | null —
category
readonly
string —
dimension number Dimension: 0..4294967294, default 0. globalDimension shows entities and spatial audio in every dimension. Players cannot use globalDimension. Global entities share movement, damage and seats across dimensions. A vehicle’s trailer follows its dimension. Occupants follow unless the new dimension is global.

Inherited from WorldBase.dimension
everyone
readonly
boolean —
id
readonly
number Inherited from WorldBase.id
loop boolean —
networkId
readonly
number | null —
playbackPosition
readonly
number Seconds on the server’s playback timeline. Keeps increasing across loops. Always 0 for live URLs.
source
readonly
Readonly<IAudioSource> —
spatial
readonly
boolean —
state
readonly
AudioPlaybackState Server playback state. Unchanged when a recording finishes on a client.
streamDistance number —
type
readonly
BaseType Inherited from WorldBase.type
valid
readonly
boolean Inherited from WorldBase.valid
volume number —
all
static readonly
readonly Audio[] Overrides WorldBase.all
count
static readonly
number Overrides WorldBase.count
Accessor Type Details
pos Read: Vector3
Write: IVector3
Inherited from WorldBase.pos
quaternion Read: Quaternion
Write: IQuaternion
Inherited from WorldBase.quaternion
rot Read: Vector3
Write: IVector3
Euler angles in radians, applied X, then Y, then Z.

Inherited from WorldBase.rot

addPlayer(player): boolean

Switches to an explicit player list, adding this player.

Parameter Type
player Player

boolean


attachTo(entity): boolean

Attaches spatial audio without seeking. Destroying the entity stops playback and clears the attachment.

Parameter Type
entity Entity

boolean


clearPlayers(): void

Switches to an empty explicit audience.

void


deleteSyncedMeta(key): void

Parameter Type
key string

void

WorldBase.deleteSyncedMeta


destroy(): void

Stops replication and deletes the audio object.

void


detach(): boolean

Continues at the last attached position. Assigning pos/rot also detaches spatial audio. Only spatial audio can be moved or attached. The spatial mode is fixed at creation.

boolean


getSyncedMeta<K>(key): ICustomBaseSyncedMeta[K] | undefined

Type Parameter
K extends never
Parameter Type
key K

ICustomBaseSyncedMeta[K] | undefined

WorldBase.getSyncedMeta

getSyncedMeta<T>(key): T | undefined

Type Parameter Default type
T TransportValue
Parameter Type
key string

T | undefined

WorldBase.getSyncedMeta


getSyncedMetaKeys(): string[]

string[]

WorldBase.getSyncedMetaKeys


hasPlayer(player): boolean

Whether the player belongs to the audience. Playback also depends on streaming and listener settings.

Parameter Type
player Player

boolean


hasSyncedMeta(key): boolean

Parameter Type
key string

boolean

WorldBase.hasSyncedMeta


pause(): boolean

boolean


play(): void

Restarts at zero. Late listeners join the current point. Live URLs join the broadcast.

void


removePlayer(player): void

Removes a player from the explicit list. Has no effect in everyone mode.

Parameter Type
player Player

void


resume(): boolean

Resumes a paused recording. Live URLs reconnect to the broadcast.

boolean


seek(seconds): boolean

0..1e9 seconds. Returns false for live URLs. Does not change playing/paused/stopped state.

Parameter Type
seconds number

boolean


setEveryone(): void

Restores the default audience and clears the explicit player list.

void


setSyncedMeta<K>(key, value): void

Copies and replicates the value to the object’s audience. Player metadata also goes to that player.

Type Parameter
K extends string
Parameter Type
key K
value K extends never ? ICustomBaseSyncedMeta[K] : TransportValue

void

WorldBase.setSyncedMeta

setSyncedMeta(values): void

Atomically merges own enumerable fields. Unsupported values reject the entire batch.

Parameter Type
values Partial<ICustomBaseSyncedMeta> & Record<string, TransportValue>

void

WorldBase.setSyncedMeta


stop(): void

Stops playback but retains this object.

void


static getById(id): Audio | null

Parameter Type
id number

Audio | null

WorldBase.getById


static getByNetworkId(networkId): Audio | null

Parameter Type
networkId number

Audio | null

Server playback and audiences