-
Notifications
You must be signed in to change notification settings - Fork 116
Documentation clarifications #410
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
mcclure
wants to merge
1
commit into
bastibe:master
Choose a base branch
from
mcclure:doc-fixes
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -307,12 +307,18 @@ def write(file, data, samplerate, subtype=None, endian=None, format=None, | |
|
||
.. note:: The data type of *data* does **not** select the data | ||
type of the written file. Audio data will be | ||
converted to the given *subtype*. Writing int values | ||
to a float file will *not* scale the values to | ||
[-1.0, 1.0). If you write the value ``np.array([42], | ||
dtype='int32')``, to a ``subtype='FLOAT'`` file, the | ||
file will then contain ``np.array([42.], | ||
dtype='float32')``. | ||
converted to the given *subtype*, with these caveats: | ||
|
||
* Writing int values to a float file will *not* scale the | ||
values to [-1.0, 1.0). If you write the value | ||
``np.array([42], dtype='int32')``, to a ``subtype='FLOAT'`` | ||
file, the file will then contain ``np.array([42.], | ||
dtype='float32')``. | ||
* For pure Python (non-Numpy) input values, floats will | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this wording could be misunderstood. I would rephrase it as "floats are expected in in the range ... and integers in the range ...". |
||
be scaled from the range [-1.0, 1.0) and integers will | ||
be scaled from the int64 range, [``-2**63``, ``2**63``). | ||
Since the int64 range is probably not what you want, using | ||
floats is recommended. | ||
|
||
samplerate : int | ||
The sample rate of the audio data. | ||
|
@@ -1033,7 +1039,8 @@ def buffer_write(self, data, dtype): | |
---------- | ||
data : buffer or bytes | ||
A buffer or bytes object containing the audio data to be | ||
written. | ||
written. For bytes the data will be interpreted according to the | ||
system endianness, ``sys.byteorder``. | ||
dtype : {'float64', 'float32', 'int32', 'int16'} | ||
The data type of the audio data stored in *data*. | ||
|
||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.