This wiki is out of date, use the continuation of this wiki instead

Play wav

(Difference between revisions)

Current revision

INT play_wav ( <INT waveID> , <INT repeats> , [<INT channel>] )

Plays a sound effect previously loaded with load_wav().

INT waveID	- The WaveID of the sound effect to be played.
INT repeats	- Number of times to repeat the sound effect. Use -1 for an infinite loop.
[INT channel]	- The sound channel the sound effect is to be played on (-1 for any, default).

INT : The sound channel the sound effect is now playing on.

-1	- Error: sound inactive; invalid waveID
>=0	- The sound channel the sound effect is now playing on.

Program
Private
    int wave;
Begin
    wave = load_wav("my_wav.wav");
    play_wav(wave,0);
    Loop
        frame;
    End
End

Used in example: load_wav()

Sound Functions
• Is_playing_song() • Load_song() • Load_wav() • Pause_song() • Play_song() • Play_wav() • Resume_song() • Set_song_volume() • Unload_song() •

 [[Category:sound]]
-'''INT''' play_wav ( <'''INT''' sound> , <'''INT''' repeats> )
+== Definition ==
+'''INT''' play_wav ( <'''INT''' waveID> , <'''INT''' repeats> , [<'''INT''' channel>] )
-Plays a WAV sound effect previously loaded with [[load_wav]]. Use -1 in repeats for an infinite loop if you swing that way.
+Plays a [[sound effect]] previously loaded with [[load_wav]]().
+== Parameters ==
+{|
+| '''INT''' waveID || - The [[WaveID]] of the sound effect to be played.
+|-
+| '''INT''' repeats || - Number of times to ''repeat'' the sound effect. Use -1 for an infinite loop.
+|-
+| ['''INT''' channel] || - The [[sound channel]] the [[sound effect]] is to be played on (-1 for any, default).
+|}
+== Returns ==
+'''INT''' : The [[sound channel]] the [[sound effect]] is now playing on.
+{|
+| -1 || - Error: sound inactive; invalid [[waveID]]
+|-
+| >=0 || - The [[sound channel]] the [[sound effect]] is now playing on.
+|}
+== Example ==
+<pre>
+Program
+Private
+    int wave;
+Begin
+    wave = load_wav("my_wav.wav");
+    play_wav(wave,0);
+    Loop
+        frame;
+    End
+End
+</pre>
+Used in example: [[load_wav]]()
+{{Funcbox
+  | category=Sound
+}}