Skip to content

Latest commit

 

History

History
177 lines (105 loc) · 4 KB

manipulating-sounds.rst

File metadata and controls

177 lines (105 loc) · 4 KB
Raw

Manipulating Sounds

Looping a Sound

To cause a sound to loop (i.e., cause it to repeat once it is finished playing) do the following:

python

mySound.setLoop(True)
mySound.play()

cpp

mySound->set_loop(true);
mySound->play();

To stop a sound from looping pass False in the ~.AudioSound.set_loop() function.

python

mySound.setLoop(False)

cpp

mySound->set_loop(false);

Sounds can also be looped for a certain number of times:

python

mySound.setLoopCount(n)

cpp

mySound->set_loop_count(n);

Where 'n' can be any positive integer. 0 will cause a sound to loop forever. 1 will cause a sound to play only once. >1 will cause a sound to loop that many times.

Note

Setting a sound's loop count to 0 or >1 will automatically set a sound's loop flag to true.

Notes on Looping Sounds Seamlessly

Looping a sound seamlessly should be as simple as loading the sound, then calling ~.AudioSound.set_loop() and ~.AudioSound.play(). However, occasionally Panda users have had difficulty getting sounds to loop seamlessly. The problems have been traced to three(!) different causes:

  1. Some MP3 encoders contain a bug where they add blank space at the end of the sound. This causes a skip during looping. Try using a wav instead.
  2. Some have tried using Sound Intervals to create a loop. Unfortunately, sound intervals depend on Panda's Thread to restart the sound, and if the CPU is is busy, there's a skip. This is not a seamless method, in general. Use ~.AudioSound.set_loop() instead.
  3. There is a bug in Miles sound system, which requires a workaround in Panda3D. At one time, the workaround was causing problems with FMOD, until we devised a new workaround. This bug no longer exists, you can ignore it.

So the easiest way to get a reliable looping sound is to use wav files, and to use ~.AudioSound.set_loop(), not sound intervals. Of course, when it comes time to ship your game, you can convert your sounds to mp3, but before you do, test your mp3 encoder to see if it contains the blank-space bug.

Cueing Time

There are ~.AudioSound.get_time(), ~.AudioSound.set_time() and ~.AudioSound.length() functions for sounds. These will respectively, report the current time position, set the current time position and report the length. All these are in seconds.

python

mySound.length()

cpp

mySound->length();

will return the length of a sound file in seconds.

python

mySound.getTime()

cpp

mySound->get_time();

will get the current time the 'playback head' of a sound is at in seconds.

python

mySound.setTime(n)

cpp

mySound->set_time(n);

will set the 'playhead head' of a sound to n (where is seconds).

Caution

When using the default OpenAL back-end, setting the time will not take effect immediately. You will need to call ~.AudioSound.play() to restart the sound at the configured position.

Changing Playback Speed

To change a sound's playback speed, use:

python

mySound.setPlayRate(n)

cpp

mySound->set_play_rate(n);

Where n is any float.

Negative numbers will play a sound backwards. Passing the value 0 will pause the sound.

You can also get a sound's play rate with:

python

mySound.getPlayRate()

cpp

mySound->get_play_rate();