nativescript-sound - npm Package Compare versions

Comparing version 1.0.3 to 1.0.4

package.json

 {
   "name": "nativescript-sound",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Play a sound in your NativeScript app",
@@ -5,0 +5,0 @@ "main": "sound.js",

README.md

@@ -23,3 +23,3 @@ # NativeScript Sound
 
-It's important to preload the audio file into the **sound** module before playing it; there is a delay during creation due to the audio being processed.
+It's important to preload the audio file into the **sound** module before playing it; there is a delay during creation due to the audio being processed:
 
@@ -33,2 +33,25 @@ ```js
 
+A good way to do this is to create a sound collection:
+
+```js
+sounds = {
+	"Tada": sound.create("~/sounds/tada.mp3"),
+	"Boo": sound.create("~/sounds/boo.mp3"),
+	// ...
+};
+```
+
+If you wish to play a sound due to a button being tapped, leverage the following code (where `name` refers to the name of the audio file to be played):
+
+```js
+this.playButtonPressed = function(name) {
+	if (app.android) {
+		sounds[name].play();
+	} else {
+		var soundFile = sound.create("~/sounds/" + name + ".mp3");
+		soundFile.play();
+	}
+}
+```
+
 ### stop
@@ -35,0 +58,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5125

increased by11.29%

Number of lines in readme file

65

increased by54.76%

No dependency changes