Engine

AudioPlayer

Show Deprecated
not browsable

AudioPlayer is used to play audio assets. It provides a single Output pin which can be connected to other pins via Wires.

Summary

Properties

Methods

Properties

AssetId

read parallel

The asset to be loaded into the AudioPlayer. If AutoLoad is true, the asset loads immediately once this property is assigned. When loading is complete, IsReady becomes true.

AutoLoad

read parallel

Controls whether AssetId loads automatically once assigned. If false, the asset will load upon the first attempt to play.

IsPlaying

read parallel

Denotes whether this AudioPlayer is currently playing. This property is read-only, but replicates. To play and stop an AudioPlayer at runtime, use the Play() and Stop() methods.

IsReady

read only
not replicated
read parallel

Denotes whether this AudioPlayer is loaded, buffered, and ready to play. Although uncommon, AudioPlayers may have their assets unloaded at runtime if there is extreme memory pressure, in which case IsReady will become false.

LoopRegion

read parallel

A range, in seconds, denoting a desired loop start and loop end within the PlaybackRegion of this AudioPlayer.

If the LoopRegion minimum is greater than the PlaybackRegion minimum, the loop starts from the LoopRegion minimum.

If the LoopRegion minimum is less than the PlaybackRegion minimum, the loop starts from the PlaybackRegion minimum.

If the LoopRegion maximum is greater than the PlaybackRegion maximum, the loop ends at the PlaybackRegion maximum.

If the LoopRegion maximum is less than the PlaybackRegion maximum, the loop ends at exactly the LoopRegion maximum.

If the LoopRegion minimum equals the LoopRegion maximum, the AudioPlayer uses the PlaybackRegion property instead.

Looping

read parallel

Controls whether this AudioPlayer loops when exceeding the end of its TimeLength, LoopRegion, or PlaybackRegion.

PlaybackRegion

read parallel

Range in seconds denoting a desired start time (minimum) and stop time (maximum) within the TimeLength.

If the PlaybackRegion minimum is greater than 0, the sound begins playing from the PlaybackRegion minimum time.

If the PlaybackRegion minimum is less than 0, the sound begins playing from 0.

If the PlaybackRegion maximum is greater than the TimeLength, the sound stops at TimeLength.

If the PlaybackRegion maximum is less than the TimeLength, the sound stops at exactly the PlaybackRegion maximum.

If the PlaybackRegion minimum equals the PlaybackRegion maximum, the sound plays in its entirety.

PlaybackSpeed

read parallel

Multiplier controlling how quickly the asset will be played, directly controlling its perceived pitch. Ranges from 0 to 20.

TimeLength

read only
not replicated
read parallel

Denotes the length of the loaded AssetId in seconds.

TimePosition

read parallel

Tracks and controls the current position of the playhead within the AssetId, in seconds.

Methods

GetConnectedWires

Parameters

pin: string

Returns

Play

void

Plays the AudioPlayer from wherever its TimePosition is. Replicates from server to client.


Returns

void

Stop

void

Stops the AudioPlayer wherever its TimePosition is. Replicates from server to client.


Returns

void

Events