Skip to content

Audio player

This Audio player community component allows an object to make a specific sound when triggered. Attach this component to an object in the scene.

This component includes:

Property Description
Audio The audio clip to add and play
Loop Determines whether to loop the audio clip
Volume The volume of the sound. Ranges from 0 to 150%. Default: 100%.
Pitch The amount of pitch change caused by slowing/accelerating the audio clip. Ranges from -3 to 3. Default: 1.
Type Specifies the sound type:
  • 3D, the sound is played with spatialization. It will have volume attenuation based on the distance from the event distance and the listener, as well as panning based on the location of the event distance to the direction the listener is facing.
  • Uniform, the sound is played without spatialization.
Min Distance The distance beyond which the sound starts to attenuate. Ranges from 1 to 100. Default: 5.
Max Distance The distance at which the sound stops attenuating. Ranges from 1 to 100. Default: 50.
Volume Rolloff Determines how fast the sound fades. The higher the value, the closer the audio listener has to be to make the sound audible.
  • Logarithmic, the sound is loud when you are close to the audio source, but it quickly fades when you move away from it.
  • Linear, the sound becomes less audible as you move away from the audio source.
DopplerLevel Determines how much Doppler effect will be applied to the audio source. Ranges from 0 to 5
Condition Determines the trigger of the audio clip:
  • Auto play, the audio clip plays automatically
  • Event, the audio clip plays when a specific event occurs
Event name Specifies the trigger event name for playing the audio clip. For example, it can be entered as registered in the AiGameEventRelay component. This field is only visible for the Condition is set to Event.

Audio player