Skip to main content

Playback & Effects

Playing audio, audio tracks and providers, the microphone, spatial audio, and audio effects.

Commonly used

Guides

All APIs in this topic

Add components to a scene object and reference assets and other modules with a script input.

Components, assets, and modules

APIDescription
AudioComponentUsed to play audio in a Lens.
AudioEffectAssetConfigures an audio effect for AudioEffectComponent.
AudioEffectComponentUsed to add effects to audio recorded by the device, such as Robot, Alien, etc.
AudioListenerComponentProcesses input from AudioComponents that use Spatial Audio.
AudioTrackAssetRepresents an audio file asset.

Objects and data

APIDescription
Audio
AudioEffectProviderProvider for AudioEffectAsset.
AudioOutputProviderProvider of the Audio Output Audio Track asset.
AudioTrackProviderBase class for Audio Track providers.
DirectivityEffectAn Audio Component effect that simulates sound attenuation based on the orientation of the transform relative to the AudioListenerComponent.
DistanceEffectAn audio effect that simulates sound attenuation based on the distance between the Audio and the AudioListenerComponent.
FileAudioTrackProviderProvider for file based Audio Tracks.
MicrophoneAudioProviderThe Audio Track Provider of the audio from microphone.
PositionEffectAn Audio Component effect that allows the Lens to simulate sound based on the direction of the Audio Listener relative to the Audio Component.
SpatialAudioBase class for objects representing Script data.