Sound Module - LostShadowGD/lpp-3ds-docs GitHub Wiki

Sound.init

void Sound.init(void)

Initialize sound system.

Sample usage:

Sound.init()

---

Sound.term

void Sound.term(void)

Terminate sound system.

Sample usage:

Sound.term()

---

Sound.openWav

wav_id Sound.openWav(string filename, [bool use_streaming])

Open a WAV file.

Sample usage:

wav = Sound.openWav("/file.wav", false)

---

Sound.openAiff

wav_id Sound.openAiff(string filename, [bool use_streaming])

Open an AIFF/AIF file.

Sample usage:

aiff = Sound.openAiff("/file.aiff", true)

---

Sound.openOgg

wav_id Sound.openOgg(string filename, [bool use_streaming])

Open an OGG file.

Sample usage:

wav = Sound.openOgg("/file.ogg", true)

---

Sound.updateStream

void Sound.updateStream()

Update buffer for a sound stream.

Sample usage:

Sound.updateStream()

---

Sound.isPlaying

bool Sound.isPlaying(wav_id wav_file)

Get sound playing state.

Sample usage:

if Sound.isPlaying(wav) then
  -- ...
end

---

Sound.play

void Sound.play(wav_id wav_file, int loop)

Play a loaded sound.

Sample usage:

Sound.play(wav, NO_LOOP)

---

Sound.close

void Sound.close(wav_id wav_file)

Close and free a loaded sound.

Sample usage:

Sound.close(wav)

---

Sound.pause

void Sound.pause(wav_id wav_file)

Pause a sound.

Sample usage:

Sound.pause(wav)

---

Sound.resume

void Sound.resume(wav_id wav_file)

Resume a sound.

Sample usage:

Sound.resume(wav)

---

Sound.saveWav

void Sound.saveWav(wav_id wav_file, string filename)

Save a sound as WAV file.

Sample usage:

Sound.saveWav(sound, "/test.wav")

---

Sound.getTotalTime

int Sound.getTotalTime(wav_id wav_file)

Get total time of a sound.

Sample usage:

time = Sound.getTotalTime(wav_file)

---

Sound.getTime

int Sound.getTime(wav_id wav_file)

Get current time of a sound.

Sample usage:

time = Sound.getTime(wav_file)

---

Sound.getSrate

int Sound.getSrate(wav_id wav_file)

Get samplerate of a sound.

Sample usage:

samplerate = Sound.getSrate(wav_file)

---

Sound.getTitle

string Sound.getTitle(wav_id wav_file)

Get title of a sound.

Sample usage:

title = Sound.getTitle(wav_file)

---

Sound.getAuthor

string Sound.getAuthor(wav_id wav_file)

Get author of a sound.

Sample usage:

author = Sound.getAuthor(wav_file)

---

Sound.getType

int Sound.getType(wav_id wav_file)

Get audiotype of a sound. (1 = Mono, 2 = Stereo)

Sample usage:

atype = Sound.getType(wav_file)

---

Sound.getService

string Sound.getService(void)

Returns used audio service.

Sample usage:

srv = Sound.getService()