ISoundOptions

Interface used to define options for Sound class

Hierarchy

  • ISoundOptions

Index

Properties

Optional autoplay

Find examples in Playground
autoplay: boolean

Does the sound autoplay once loaded.

Optional distanceModel

Find examples in Playground
distanceModel: string

Define the distance attenuation model the sound will follow.

see

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

Optional length

Find examples in Playground
length: number

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

Optional loop

Find examples in Playground
loop: boolean

Does the sound loop after it finishes playing once.

Optional maxDistance

Find examples in Playground
maxDistance: number

Maximum distance to hear that sound

Optional offset

Find examples in Playground
offset: number

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

Optional playbackRate

Find examples in Playground
playbackRate: number

Defines the playback speed (1 by default)

Optional refDistance

Find examples in Playground
refDistance: number

Define the reference distance the sound should be heard perfectly.

see

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

Optional rolloffFactor

Find examples in Playground
rolloffFactor: number

Optional skipCodecCheck

Find examples in Playground
skipCodecCheck: boolean

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

Optional spatialSound

Find examples in Playground
spatialSound: boolean

Is it a spatial sound?

Optional streaming

Find examples in Playground
streaming: boolean

Defines if the sound is from a streaming source

Optional useCustomAttenuation

Find examples in Playground
useCustomAttenuation: boolean

Uses user defined attenuation function

Optional volume

Find examples in Playground
volume: number

Sound's volume

Generated using TypeDoc