Difference between revisions of "SoundData:getSample"
(→Arguments: Added notice to input parameters not being interpolated, to thwart any assumptions.) |
m (0.11.0 -> 11.0) |
||
| (5 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| − | Gets the sample at the specified position. | + | Gets the value of the sample-point at the specified position. For stereo SoundData objects, the data from the left and right channels are interleaved in that order. |
== Function == | == Function == | ||
=== Synopsis === | === Synopsis === | ||
| Line 6: | Line 6: | ||
</source> | </source> | ||
=== Arguments === | === Arguments === | ||
| − | {{param|number|i| | + | {{param|number|i|An integer value specifying the position of the sample (starting at 0).}} |
| + | === Returns === | ||
| + | {{param|number|sample|The normalized samplepoint (range -1.0 to 1.0).}} | ||
| + | == Function == | ||
| + | {{newin|[[11.0]]|110|type=variant}} | ||
| + | Gets the value of a sample using an explicit sample index instead of interleaving them in the sample position parameter. | ||
| + | === Synopsis === | ||
| + | <source lang="lua"> | ||
| + | sample = SoundData:getSample( i, channel ) | ||
| + | </source> | ||
| + | === Arguments === | ||
| + | {{param|number|i|An integer value specifying the position of the sample (starting at 0).}} | ||
| + | {{param|number|channel|The index of the channel to get within the given sample.}} | ||
=== Returns === | === Returns === | ||
| − | {{param|number|sample|The normalized | + | {{param|number|sample|The normalized samplepoint (range -1.0 to 1.0).}} |
| + | |||
| + | |||
== See Also == | == See Also == | ||
* [[parent::SoundData]] | * [[parent::SoundData]] | ||
| + | * [[SoundData:setSample]] | ||
* [[SoundData:getSampleCount]] | * [[SoundData:getSampleCount]] | ||
[[Category:Functions]] | [[Category:Functions]] | ||
| − | {{#set:Description=Gets the | + | {{#set:Description=Gets the value of the samplepoint at the specified position.}} |
{{#set:Since=000}} | {{#set:Since=000}} | ||
== Other Languages == | == Other Languages == | ||
{{i18n|SoundData:getSample}} | {{i18n|SoundData:getSample}} | ||
Latest revision as of 14:16, 22 December 2018
Gets the value of the sample-point at the specified position. For stereo SoundData objects, the data from the left and right channels are interleaved in that order.
Contents
Function
Synopsis
sample = SoundData:getSample( i )
Arguments
number i- An integer value specifying the position of the sample (starting at 0).
Returns
number sample- The normalized samplepoint (range -1.0 to 1.0).
Function
| Available since LÖVE 11.0 |
| This variant is not supported in earlier versions. |
Gets the value of a sample using an explicit sample index instead of interleaving them in the sample position parameter.
Synopsis
sample = SoundData:getSample( i, channel )
Arguments
number i- An integer value specifying the position of the sample (starting at 0).
number channel- The index of the channel to get within the given sample.
Returns
number sample- The normalized samplepoint (range -1.0 to 1.0).
See Also
Other Languages
Dansk –
Deutsch –
English –
Español –
Français –
Indonesia –
Italiano –
Lietuviškai –
Magyar –
Nederlands –
Polski –
Português –
Română –
Slovenský –
Suomi –
Svenska –
Türkçe –
Česky –
Ελληνικά –
Български –
Русский –
Српски –
Українська –
עברית –
ไทย –
日本語 –
正體中文 –
简体中文 –
Tiếng Việt –
한국어
More info
