@battle-racing/br-common-lib/src/types/hardware/sound/PlaySoundOptions.ts

Common library for all Battle Racing Repositorios

import type { SoundName } from '../../sounds';

export interface PlaySoundOptions {
  soundName: SoundName;
  /**
   * The amount of time in milliseconds to play the sound for.
   * If not provided, the sound will play for the duration of the sound file.
   * If the time is longer than the duration of the sound file, the sound will play in a loop.
   * If the time is shorter than the duration of the sound file, the sound will stop playing after the duration.
   */
  durationMs?: number | 'infinite';
}