View source

typedef SoundPlayOptions

package defold

import defold.Sound

Fields

@:optional@:native("start_time")optionalstartTime:Null<Float>

  • Start offset in seconds where playback should begin.

@:optional@:native("start_frame")optionalstartFrame:Null<Int>

  • Start offset in audio frames where playback should begin. Mutually exclusive with start_time.

@:optionaloptionalspeed:Null<Float>

  • Sound speed where 1.0 is normal speed, 0.5 is half speed and 2.0 is double speed. The final speed of the sound will be a multiplication of this speed and the sound speed.

@:optionaloptionalpan:Null<Float>

  • Sound pan between -1 and 1, default is 0. The final pan of the sound will be an addition of this pan and the sound pan.

@:optionaloptionalgain:Null<Float>

  • Sound gain between 0 and 1, default is 1.

The final gain of the sound will be a combination of this gain, the group gain and the master gain.

@:optionaloptionaldelay:Null<Float>

  • Delay in seconds before the sound starts playing, default is 0.