play3dScheduled method

SoundHandle play3dScheduled(
  1. AudioSource sound,
  2. Duration atTime,
  3. double posX,
  4. double posY,
  5. double posZ, {
  6. Duration? duration,
  7. double velX = 0,
  8. double velY = 0,
  9. double velZ = 0,
  10. double volume = 1,
  11. double scale = 1,
  12. bool looping = false,
  13. Duration loopingStartAt = Duration.zero,
  14. Duration? loopingEndAt,
  15. int? loopingStartOffsetAt,
  16. int? loopingEndOffsetAt,
})

Start playing sound through this bus in 3D space at an absolute engine time (see SoLoud.getEngineTime), with sample accuracy.

This is a convenience method that calls SoLoud.play3dScheduled with the busId set to this bus.

Please see SoLoud.play3dScheduled for more information on the parameters.

Throws SoLoudBusDisposedDartException if the bus has already been disposed.

Implementation

SoundHandle play3dScheduled(
  AudioSource sound,
  Duration atTime,
  double posX,
  double posY,
  double posZ, {
  Duration? duration,
  double velX = 0,
  double velY = 0,
  double velZ = 0,
  double volume = 1,
  double scale = 1,
  bool looping = false,
  Duration loopingStartAt = Duration.zero,
  Duration? loopingEndAt,
  int? loopingStartOffsetAt,
  int? loopingEndOffsetAt,
}) {
  if (!_isValid) {
    _log.warning('bus $busId is already disposed');
    throw const SoLoudBusDisposedDartException();
  }
  return SoLoud.instance.play3dScheduled(
    sound,
    atTime,
    posX,
    posY,
    posZ,
    duration: duration,
    velX: velX,
    velY: velY,
    velZ: velZ,
    busId: busId,
    volume: volume,
    scale: scale,
    looping: looping,
    loopingStartAt: loopingStartAt,
    loopingEndAt: loopingEndAt,
    loopingStartOffsetAt: loopingStartOffsetAt,
    loopingEndOffsetAt: loopingEndOffsetAt,
  );
}