Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface used to define options for Sound class

Hierarchy

  • ISoundOptions

Index

Properties

autoplay?: boolean

Does the sound autoplay once loaded.

distanceModel?: string

Define the distance attenuation model the sound will follow.

see

https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound

length?: number

Defines an optional length (in seconds) inside the sound file

loop?: boolean

Does the sound loop after it finishes playing once.

maxDistance?: number

Maximum distance to hear that sound

offset?: number

Defines an optional offset (in seconds) inside the sound file

playbackRate?: number

Defines the playback speed (1 by default)

refDistance?: number

Define the reference distance the sound should be heard perfectly.

see

https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound

rolloffFactor?: number
skipCodecCheck?: boolean

If true, URLs will not be required to state the audio file codec to use.

spatialSound?: boolean

Is it a spatial sound?

streaming?: boolean

Defines if the sound is from a streaming source

useCustomAttenuation?: boolean

Uses user defined attenuation function

volume?: number

Sound's volume

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited constructor
  • Static method

Settings

Theme