Skip to content

Commit

Permalink
Update documentation about iXML and _PMX
Browse files Browse the repository at this point in the history
  • Loading branch information
rochars committed Jan 3, 2020
1 parent 90916a9 commit f014e98
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -359,15 +359,15 @@ let iXMLValue = wav.getiXML();
let _PMXValue = wav.get_PMX();
```

To Set the value of iXML or \_PMX chunks:
To set the value of iXML or \_PMX chunks:
```javascript
wav.setiXML(iXMLValue);
wav.set_PMX(_PMXValue);
```

The value for XML chunks must always be a string.

the *chunkSize* of the chunks will be adjusted according to their new values when *toBuffer()* is called.
the *chunkSize* of the XML chunks will be adjusted when *toBuffer()* is called.

## API
To create a WaveFile object:
Expand Down
4 changes: 2 additions & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -347,12 +347,12 @@ <h3>XML Chunks</h3>
/** @type {string} */
let _PMXValue = wav.get_PMX();
</code></pre>
<p>To Set the value of iXML or _PMX chunks:</p>
<p>To set the value of iXML or _PMX chunks:</p>
<pre class="prettyprint source lang-javascript"><code>wav.setiXML(iXMLValue);
wav.set_PMX(_PMXValue);
</code></pre>
<p>The value for XML chunks must always be a string.</p>
<p>the <em>chunkSize</em> of the chunks will be adjusted according to their new values when <em>toBuffer()</em> is called.</p>
<p>the <em>chunkSize</em> of the XML chunks will be adjusted when <em>toBuffer()</em> is called.</p>
<h2>API</h2>
<p>To create a WaveFile object:</p>
<pre class="prettyprint source lang-javascript"><code>/**
Expand Down
4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,9 @@
"encode",
"decode",
"A-Law",
"mu-Law"
"mu-Law",
"_PMX",
"iXML"
],
"repository": {
"type": "git",
Expand Down

0 comments on commit f014e98

Please sign in to comment.