Removed the mention of wav in the function signature since logically …

…it is not required
imulilla · Feb 15, 2015 · 0242fe6 · 0242fe6
1 parent eaa33a4
commit 0242fe6
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,6 @@
 
 [![Build Status](https://travis-ci.org/kmp1/tzx.js.svg)](https://travis-ci.org/kmp1/tzx.js)
 
-A javascript .tzx (and .tap) data file API (for converting ZX Spectrum games to wav files)
+A javascript .tzx (and .tap) data file API (for converting ZX Spectrum games to audio files)
 
 Some further information is available [here](http://kmp1.github.io/tzx.js/).
diff --git a/src/tzx b/src/tzx
@@ -100,9 +100,9 @@ var inputConvert = {
 
 var details;
 if (isTzx) {
-	details = tzx_js.convertTzxToWave(tzx_js.MachineSettings.ZXSpectrum48, inputConvert, wave);
+	details = tzx_js.convertTzxToAudio(tzx_js.MachineSettings.ZXSpectrum48, inputConvert, wave);
 } else {
-	details = tzx_js.convertTapToWave(tzx_js.MachineSettings.ZXSpectrum48, inputConvert, wave);
+	details = tzx_js.convertTapToAudio(tzx_js.MachineSettings.ZXSpectrum48, inputConvert, wave);
 }
 
 fs.writeFileSync(output, new Buffer(wave.toByteArray()));

diff --git a/src/tzx.js b/src/tzx.js
@@ -253,7 +253,7 @@ var tzx_js = (function () {
         return dataStart + blockDetails.blockLength;
     }
 
-    function convertTzxToWave(machineSettings, input, output) {
+    function convertTzxToAudio(machineSettings, input, output) {
         var i = 0, version = { major: -1, minor: -1}, blockDetails, retBlockDetails = [];
 
         while (i < input.length) {
@@ -325,7 +325,7 @@ var tzx_js = (function () {
         return dataStart + blockDetails.blockLength;
     }
 
-    function convertTapToWave(machineSettings, input, output) {
+    function convertTapToAudio(machineSettings, input, output) {
         var i = 0, blockDetails, retBlockDetails = [];
 
         while (i < input.length) {
@@ -349,7 +349,7 @@ var tzx_js = (function () {
     return {
 
         /**
-         * Converts a TZX to a wave file and returns some details about
+         * Converts a TZX to an audio file and returns some details about
          * what it has read.
          *
          * @param {Number} machineSettings The machine specific settings to use
@@ -361,10 +361,10 @@ var tzx_js = (function () {
          * example).
          * @return {Object} details about the TZX file that was converted
          */
-        convertTzxToWave: convertTzxToWave,
+        convertTzxToAudio: convertTzxToAudio,
 
         /**
-         * Converts a TZX to a wave file and returns some details about
+         * Converts a TZX to an audio file and returns some details about
          * what it has read.
          *
          * @param {Number} machineSettings The machine specific settings to use
@@ -376,7 +376,7 @@ var tzx_js = (function () {
          * example).
          * @return {Object} details about the TAP file that was converted
          */
-        convertTapToWave: convertTapToWave,
+        convertTapToAudio: convertTapToAudio,
 
         MachineSettings: {
             ZXSpectrum48: {
@@ -412,7 +412,7 @@ var tzx_js = (function () {
 }());
 
 if (typeof exports !== "undefined") {
-    exports.convertTzxToWave = tzx_js.convertTzxToWave;
-    exports.convertTapToWave = tzx_js.convertTapToWave;
+    exports.convertTzxToAudio = tzx_js.convertTzxToAudio;
+    exports.convertTapToAudio = tzx_js.convertTapToAudio;
     exports.MachineSettings = tzx_js.MachineSettings;
 }
diff --git a/test/main_test.js b/test/main_test.js
@@ -27,7 +27,7 @@ exports.testTzxWithOnlyBlock10Data = function(test) {
 	// passing in the type of computer to generate the wave file for
 	// An object that gives access to the TZX file and the output
 	// file
-	var details = tzx_js.convertTzxToWave(tzx_js.MachineSettings.ZXSpectrum48, {
+	var details = tzx_js.convertTzxToAudio(tzx_js.MachineSettings.ZXSpectrum48, {
 		length: tzxFile.length,
 		getByte: function(index) {
 			return tzxFile[index];
@@ -50,7 +50,7 @@ exports.testBasicTap = function(test) {
 
 	var wave = wav_js.create(1, 44100, wav_js.BitSize.EIGHT);
 
-	var details = tzx_js.convertTapToWave(tzx_js.MachineSettings.ZXSpectrum48, {
+	var details = tzx_js.convertTapToAudio(tzx_js.MachineSettings.ZXSpectrum48, {
 		length: tapFile.length,
 		getByte: function(index) {
 			return tapFile[index];