API reference
API reference
Select your platform
No SDKs available
No versions available

SceneAudioPlayer Class

Modifiers: final
Controls playback of spatial audio in a 3D scene with dynamic control capabilities.
Unlike the direct playSound methods in Scene, SceneAudioPlayer provides ongoing control over audio playback, allowing you to start, stop, and update properties like volume and position while the sound is playing.
Example usage: 
// Load an audio asset
val audioAsset = SceneAudioAsset.loadLocalFile("data/common/audio/ambient.ogg")
// Create an audio player for the asset
val audioPlayer = SceneAudioPlayer(scene, audioAsset)
// Play the sound at a specific position with looping enabled
audioPlayer.play(
    position = Vector3(0f, 1.7f, -2f),
    volume = 0.8f,
    looping = true
)
// Later, update the volume
audioPlayer.setVolume(0.5f)
// Move the sound to follow an object
audioPlayer.setPosition(objectPosition)
// Stop playback when no longer needed
audioPlayer.stop()
Each SceneAudioPlayer instance is assigned a unique channel name, allowing multiple sounds to be controlled independently.

Signature

class SceneAudioPlayer

Constructors

SceneAudioPlayer ( scene , soundAsset )
Creates a new audio player for the specified audio asset.
Signature 
constructor(scene: Scene, soundAsset: SceneAudioAsset)
Parameters
scene: Scene
  The scene in which to play the audio
soundAsset: SceneAudioAsset
  The audio asset to play
Returns

Functions

play ( position , volume , looping )
Starts playing the audio at the specified position.
Signature 
fun play(position: Vector3, volume: Float = 1.0f, looping: Boolean = false)
Parameters
position: Vector3
  The 3D position where the sound should originate from
volume: Float
  The volume level from 0.0 (silent) to 1.0 (full volume)
looping: Boolean
  Whether the audio should loop continuously
setPosition ( position )
Updates the position of the currently playing audio.
This can be used to move the sound source while it's playing, for example to follow a moving object in the scene.
Signature 
fun setPosition(position: Vector3)
Parameters
position: Vector3
  The new 3D position for the sound source
setVolume ( volume )
Adjusts the volume of the currently playing audio.
Signature 
fun setVolume(volume: Float)
Parameters
volume: Float
  The new volume level from 0.0 (silent) to 1.0 (full volume)
stop ()
Stops the audio playback.
Once stopped, the audio can be played again by calling SceneAudioPlayer.play.
Signature 
fun stop()

Companion Object

Companion Object Properties

playerCount : Int
[Get]
Signature 
var playerCount: Int
Did you find this page helpful?
Thumbs up icon
Thumbs down icon
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta