PlaySound: Difference between revisions

From NSB App Studio
Jump to navigation Jump to search
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
PlaySound ''filename''
PlaySound ''filename''[,''volume'']
 
== Description ==
== Description ==
[[File:PlaySound.png]]
[[File:PlaySound.png]]
Line 6: Line 5:
PlaySound plays .mp3 and .wav sound files. Playback is immediate, with no on screen controls, making it excellent for user interactions and gaming.
PlaySound plays .mp3 and .wav sound files. Playback is immediate, with no on screen controls, making it excellent for user interactions and gaming.


The files need to be included in the project by adding them to the Project Explorer.
''volume'' is optional. It's value is from 0 to 1. The default is 1.
 
The files need to be included in the project by adding them to the Project Explorer. This can be done dragging them from the Finder into the Project Explorer panel. Filenames should not have spaces in them.


PlaySound returns a reference to the sound. You can use this reference to control the sound.
PlaySound returns a reference to the sound. You can use this reference to control the sound.


PlaySound is supported starting with iOS Safari 6 and Chrome 31, so it will work on all current and recent iOS and Android devices. It is not supported in the Android browser or Internet Explorer. Since PhoneGap uses the Android browser, it will not work with PhoneGap.
PlaySound is supported starting with iOS Safari 6 and Chrome 31, so it will work on all current and recent iOS and Android devices. It is not supported in the Android browser or Internet Explorer.  
 
Here's a good site with lots of free sound files: http://opengameart.org/art-search-advanced?keys=&field_art_type_tid%5B%5D=13


== Properties and Methods ==
== Properties and Methods ==
Line 23: Line 26:
|}
|}


== Example (Basic) ==
== Example ==
<pre>
 
<tabber>
JavaScript=
<syntaxhighlight lang="JavaScript">
NSB.PlaySound("BellToll.wav");
 
// Make sound loop
  bell = NSB.PlaySound("BellToll.wav");
  bell.loop=true;
 
// Stop playing sound
  bell.stop()
</syntaxhighlight>
|-|
BASIC=
<syntaxhighlight lang="vb.net">
   PlaySound "BellToll.wav"
   PlaySound "BellToll.wav"
</pre>


Make sound loop
' Make sound loop
<pre>
   bell = PlaySound("BellToll.wav")
   bell = PlaySound("BellToll.wav")
   bell.loop=True
   bell.loop=True
</pre>
Stop playing sound
<pre>
  bell.stop()
</pre>
== Example (JavaScript) ==
<pre>
NSB.PlaySound("BellToll.wav");
</pre>
Make sound loop
<pre>
  bell = NSB.PlaySound("BellToll.wav");
  bell.loop=true;
</pre>


Stop playing sound
'Stop playing sound
<pre>
   bell.stop()
   bell.stop()
</pre>
</syntaxhighlight>
</tabber>


== Output ==
== Output ==

Latest revision as of 14:14, 4 September 2023

PlaySound filename[,volume]

Description

PlaySound plays .mp3 and .wav sound files. Playback is immediate, with no on screen controls, making it excellent for user interactions and gaming.

volume is optional. It's value is from 0 to 1. The default is 1.

The files need to be included in the project by adding them to the Project Explorer. This can be done dragging them from the Finder into the Project Explorer panel. Filenames should not have spaces in them.

PlaySound returns a reference to the sound. You can use this reference to control the sound.

PlaySound is supported starting with iOS Safari 6 and Chrome 31, so it will work on all current and recent iOS and Android devices. It is not supported in the Android browser or Internet Explorer.

Here's a good site with lots of free sound files: http://opengameart.org/art-search-advanced?keys=&field_art_type_tid%5B%5D=13

Properties and Methods

soundRef.start(0) Start playing the sound. PlaySound auto plays, so this is not normally needed.
soundRef.stop(0) Stop playing the sound.
soundRef.loop Make the sound loop endlessly

Example

NSB.PlaySound("BellToll.wav");

// Make sound loop
  bell = NSB.PlaySound("BellToll.wav");
  bell.loop=true;

// Stop playing sound
  bell.stop()

  PlaySound "BellToll.wav"

' Make sound loop
  bell = PlaySound("BellToll.wav")
  bell.loop=True

'Stop playing sound
  bell.stop()

Output

(sound of a bell tolling)